chore: updated README and added missing decode option flags to yecc

backend

Author: thomas9911

.gitignore

@@ -24,3 +24,7 @@ json5-*.tar
 
 # Temporary files, for example, from tests.
 /tmp/
+
+# auto generated files
+src/lexer.erl
+src/parser.erl

lib/json5.ex

@@ -18,6 +18,10 @@ defmodule Json5 do
     - if none of the above options are set return the key as a binary (String.t())
   - object_new_function: ({any, any}) -> any
     - function to create a map from the list of parsed tuples, by default uses `Map.new/1`
+  - backend: [`Json5.Decode.Backend.Combine`, `Json5.Decode.Backend.Yecc`]
+    - select the backend to be used (Defaults to Combine). 
+    - The Combine backend is coded with the json5 spec (with unicode) in mind, but a lot slower (about 2000x slower than `Jason`)
+    - The Yecc backend is a lot faster (about 6x slower than `Jason`) but not that rigorous based on the json5 spec. It is just written to make the existing tests work.
 
   ```elixir
   iex> Json5.decode("{array: [1, 2, 3], map: {'null': null, test: 1, }, }")

lib/json5/decode/backend/yecc.ex

@@ -38,9 +38,13 @@ defmodule Json5.Decode.Backend.Yecc do
   end
 
   defp to_term({:map, _, key_value_list}, config) do
-    Map.new(key_value_list, fn {key, value} ->
+    func = Map.get(config, :object_new_function, &Map.new/1)
+
+    key_value_list
+    |> Enum.map(fn {key, value} ->
       {to_term(key, config), to_term(value, config)}
     end)
+    |> func.()
   end
 
   defp to_term({:list, _, list}, config) do
@@ -64,6 +68,10 @@ defmodule Json5.Decode.Backend.Yecc do
     String.to_existing_atom(key)
   end
 
+  def do_key_term(key, %{object_key_atom: true}) do
+    String.to_existing_atom(key)
+  end
+
   def do_key_term(key, %{object_key_function: object_key_function}) do
     object_key_function.(key)
   end

mix.exs

@@ -4,7 +4,7 @@ defmodule Json5.MixProject do
   def project do
     [
       app: :json5,
-      version: "0.1.0",
+      version: "0.2.0",
       elixir: "~> 1.10",
       description: "Json5 in Elixir",
       start_permanent: Mix.env() == :prod,
@@ -14,14 +14,12 @@ defmodule Json5.MixProject do
     ]
   end
 
-  # Run "mix help compile.app" to learn about applications.
   def application do
     [
       extra_applications: [:logger]
     ]
   end
 
-  # Run "mix help deps" to learn about dependencies.
   defp deps do
     [
       {:ex_doc, "~> 0.24", only: :dev, runtime: false},

src/lexer.xrl

@@ -1,4 +1,5 @@
 Definitions.
+
 Digit = [0-9]
 HexDigit = [0-9a-fA-F]
 Float = (\+|-)?{Digit}+\.?{Digit}+?((E|e)(\+|-)?{Digit}+)?
@@ -38,9 +39,8 @@ false : {token, {boolean, TokenLine, false}}.
 %% multiline comment
 /\*[^(*/)]*\*/         : skip_token.
 
-
-
 Erlang code.
+
 strip_quotes(Str) ->
     tl(lists:droplast(Str)).
 

test/json5/decode_test.exs

@@ -204,7 +204,7 @@ defmodule Json5.DecodeTest do
         assert {:error, _} = Json5.decode(input, backend: @backend)
       end
 
-      test "decode atom object" do
+      test "decode existing atom object" do
         input = """
         {
           test: 1,
@@ -224,6 +224,46 @@ defmodule Json5.DecodeTest do
                  )
       end
 
+      test "decode atom object" do
+        input = """
+        {
+          test: 1,
+          other: null,
+        }
+        """
+
+        expected = %{
+          test: Decimal.new(1),
+          other: nil
+        }
+
+        assert {:ok, expected} ==
+                 Json5.decode(input,
+                   object_key_atom: true,
+                   backend: @backend
+                 )
+      end
+
+      test "decode object with object new function" do
+        input = """
+        {
+          test: 1,
+          other: null,
+        }
+        """
+
+        expected = [
+          {"test", Decimal.new(1)},
+          {"other", nil}
+        ]
+
+        assert {:ok, expected} ==
+                 Json5.decode(input,
+                   object_new_function: &Enum.to_list/1,
+                   backend: @backend
+                 )
+      end
+
       test "decode object with key function" do
         input = """
         {