Merge pull request #10 from corka149/8-allow-atoms-as-key-via-option

8 allow atoms as key via option

.credo.exs

@@ -0,0 +1,189 @@
+# This file contains the configuration for Credo and you are probably reading
+# this after creating it with `mix credo.gen.config`.
+#
+# If you find anything wrong or unclear in this file, please report an
+# issue on GitHub: https://github.com/rrrene/credo/issues
+#
+%{
+  #
+  # You can have as many configs as you like in the `configs:` field.
+  configs: [
+    %{
+      #
+      # Run any config using `mix credo -C <name>`. If no config name is given
+      # "default" is used.
+      #
+      name: "default",
+      #
+      # These are the files included in the analysis:
+      files: %{
+        #
+        # You can give explicit globs or simply directories.
+        # In the latter case `**/*.{ex,exs}` will be used.
+        #
+        included: [
+          "lib/",
+          "src/",
+          "test/",
+          "web/",
+          "apps/*/lib/",
+          "apps/*/src/",
+          "apps/*/test/",
+          "apps/*/web/"
+        ],
+        excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/"]
+      },
+      #
+      # Load and configure plugins here:
+      #
+      plugins: [],
+      #
+      # If you create your own checks, you must specify the source files for
+      # them here, so they can be loaded by Credo before running the analysis.
+      #
+      requires: [],
+      #
+      # If you want to enforce a style guide and need a more traditional linting
+      # experience, you can change `strict` to `true` below:
+      #
+      strict: false,
+      #
+      # To modify the timeout for parsing files, change this value:
+      #
+      parse_timeout: 5000,
+      #
+      # If you want to use uncolored output by default, you can change `color`
+      # to `false` below:
+      #
+      color: true,
+      #
+      # You can customize the parameters of any check by adding a second element
+      # to the tuple.
+      #
+      # To disable a check put `false` as second element:
+      #
+      #     {Credo.Check.Design.DuplicatedCode, false}
+      #
+      checks: [
+        #
+        ## Consistency Checks
+        #
+        {Credo.Check.Consistency.ExceptionNames, []},
+        {Credo.Check.Consistency.LineEndings, []},
+        {Credo.Check.Consistency.ParameterPatternMatching, []},
+        {Credo.Check.Consistency.SpaceAroundOperators, []},
+        {Credo.Check.Consistency.SpaceInParentheses, []},
+        {Credo.Check.Consistency.TabsOrSpaces, []},
+
+        #
+        ## Design Checks
+        #
+        # You can customize the priority of any check
+        # Priority values are: `low, normal, high, higher`
+        #
+        {Credo.Check.Design.AliasUsage,
+         [priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 0]},
+        # You can also customize the exit_status of each check.
+        # If you don't want TODO comments to cause `mix credo` to fail, just
+        # set this value to 0 (zero).
+        #
+        {Credo.Check.Design.TagTODO, [exit_status: 2]},
+        {Credo.Check.Design.TagFIXME, []},
+
+        #
+        ## Readability Checks
+        #
+        {Credo.Check.Readability.AliasOrder, []},
+        {Credo.Check.Readability.FunctionNames, []},
+        {Credo.Check.Readability.LargeNumbers, []},
+        {Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 120]},
+        {Credo.Check.Readability.ModuleAttributeNames, []},
+        {Credo.Check.Readability.ModuleDoc, []},
+        {Credo.Check.Readability.ModuleNames, []},
+        {Credo.Check.Readability.ParenthesesInCondition, []},
+        {Credo.Check.Readability.ParenthesesOnZeroArityDefs, []},
+        {Credo.Check.Readability.PredicateFunctionNames, []},
+        {Credo.Check.Readability.PreferImplicitTry, []},
+        {Credo.Check.Readability.RedundantBlankLines, []},
+        {Credo.Check.Readability.Semicolons, []},
+        {Credo.Check.Readability.SpaceAfterCommas, []},
+        {Credo.Check.Readability.StringSigils, []},
+        {Credo.Check.Readability.TrailingBlankLine, []},
+        {Credo.Check.Readability.TrailingWhiteSpace, []},
+        {Credo.Check.Readability.UnnecessaryAliasExpansion, []},
+        {Credo.Check.Readability.VariableNames, []},
+
+        #
+        ## Refactoring Opportunities
+        #
+        {Credo.Check.Refactor.CondStatements, []},
+        {Credo.Check.Refactor.CyclomaticComplexity, []},
+        {Credo.Check.Refactor.FunctionArity, []},
+        {Credo.Check.Refactor.LongQuoteBlocks, []},
+        # {Credo.Check.Refactor.MapInto, []},
+        {Credo.Check.Refactor.MatchInCondition, []},
+        {Credo.Check.Refactor.NegatedConditionsInUnless, []},
+        {Credo.Check.Refactor.NegatedConditionsWithElse, []},
+        {Credo.Check.Refactor.Nesting, []},
+        {Credo.Check.Refactor.UnlessWithElse, []},
+        {Credo.Check.Refactor.WithClauses, []},
+
+        #
+        ## Warnings
+        #
+        {Credo.Check.Warning.ApplicationConfigInModuleAttribute, []},
+        {Credo.Check.Warning.BoolOperationOnSameValues, []},
+        {Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
+        {Credo.Check.Warning.IExPry, []},
+        {Credo.Check.Warning.IoInspect, []},
+        # {Credo.Check.Warning.LazyLogging, []},
+        {Credo.Check.Warning.MixEnv, false},
+        {Credo.Check.Warning.OperationOnSameValues, []},
+        {Credo.Check.Warning.OperationWithConstantResult, []},
+        {Credo.Check.Warning.RaiseInsideRescue, []},
+        {Credo.Check.Warning.UnusedEnumOperation, []},
+        {Credo.Check.Warning.UnusedFileOperation, []},
+        {Credo.Check.Warning.UnusedKeywordOperation, []},
+        {Credo.Check.Warning.UnusedListOperation, []},
+        {Credo.Check.Warning.UnusedPathOperation, []},
+        {Credo.Check.Warning.UnusedRegexOperation, []},
+        {Credo.Check.Warning.UnusedStringOperation, []},
+        {Credo.Check.Warning.UnusedTupleOperation, []},
+        {Credo.Check.Warning.UnsafeExec, []},
+
+        #
+        # Checks scheduled for next check update (opt-in for now, just replace `false` with `[]`)
+
+        #
+        # Controversial and experimental checks (opt-in, just replace `false` with `[]`)
+        #
+        {Credo.Check.Consistency.MultiAliasImportRequireUse, false},
+        {Credo.Check.Consistency.UnusedVariableNames, false},
+        {Credo.Check.Design.DuplicatedCode, false},
+        {Credo.Check.Readability.AliasAs, false},
+        {Credo.Check.Readability.BlockPipe, false},
+        {Credo.Check.Readability.ImplTrue, false},
+        {Credo.Check.Readability.MultiAlias, false},
+        {Credo.Check.Readability.SeparateAliasRequire, false},
+        {Credo.Check.Readability.SinglePipe, false},
+        {Credo.Check.Readability.Specs, false},
+        {Credo.Check.Readability.StrictModuleLayout, false},
+        {Credo.Check.Readability.WithCustomTaggedTuple, false},
+        {Credo.Check.Refactor.ABCSize, false},
+        {Credo.Check.Refactor.AppendSingleItem, false},
+        {Credo.Check.Refactor.DoubleBooleanNegation, false},
+        {Credo.Check.Refactor.ModuleDependencies, false},
+        {Credo.Check.Refactor.NegatedIsNil, false},
+        {Credo.Check.Refactor.PipeChainStart, false},
+        {Credo.Check.Refactor.VariableRebinding, false},
+        {Credo.Check.Warning.LeakyEnvironment, false},
+        {Credo.Check.Warning.MapGetUnsafePass, false},
+        {Credo.Check.Warning.UnsafeToAtom, false}
+
+        #
+        # Custom checks can be created using `mix credo.gen.check`.
+        #
+      ]
+    }
+  ]
+}

CHANGELOG

@@ -1,3 +1,6 @@
+# 0.13.0
+- Allow usage of atoms for keys via `keys` option
+
 # 0.12.1
 - Generate diffs with correct order (thanks https://github.com/smartepsh)
 

Makefile

@@ -2,7 +2,7 @@
 
 
 check:
-	mix format
+	mix format --check-formatted
 	mix test
 	mix dialyzer
 	mix credo --strict

lib/jsonpatch.ex

@@ -32,6 +32,15 @@ defmodule Jsonpatch do
   when any path is invalid or any other error occured. When a list is provided, the operations are
   applied in the order as they appear in the list.
 
+  Atoms are never garbage collected. Therefore, `Jsonpatch` works by default only with maps
+  which used binary strings as key. This behaviour can be controlled via the `:keys` option.
+
+  ## Options
+    * `:keys` - controls how parts of paths are decoded. Possible values:
+      * `:strings` (default) - decodes parts of paths as binary strings,
+      * `:atoms` - parts of paths are converted to atoms using `String.to_atom/1`,
+      * `:atoms!` - parts of paths are converted to atoms using `String.to_existing_atom/1`
+
   ## Examples
       iex> patch = [
       ...> %Jsonpatch.Operation.Add{path: "/age", value: 33},
@@ -56,16 +65,16 @@ defmodule Jsonpatch do
       iex> Jsonpatch.apply_patch(patch, target)
       {:error, :test_failed, "Expected value 'Alice' at '/name'"}
   """
-  @spec apply_patch(Jsonpatch.t() | list(Jsonpatch.t()), map()) ::
+  @spec apply_patch(Jsonpatch.t() | list(Jsonpatch.t()), map(), keyword()) ::
           {:ok, map()} | Jsonpatch.error()
-  def apply_patch(json_patch, target)
+  def apply_patch(json_patch, target, opts \\ [])
 
-  def apply_patch(json_patch, %{} = target) when is_list(json_patch) do
+  def apply_patch(json_patch, %{} = target, opts) when is_list(json_patch) do
     # https://datatracker.ietf.org/doc/html/rfc6902#section-3
     # > Operations are applied sequentially in the order they appear in the array.
     result =
       Enum.reduce_while(json_patch, target, fn patch, acc ->
-        case Jsonpatch.Operation.apply_op(patch, acc) do
+        case Jsonpatch.Operation.apply_op(patch, acc, opts) do
           {:error, _, _} = error -> {:halt, error}
           result -> {:cont, result}
         end
@@ -77,8 +86,8 @@ defmodule Jsonpatch do
     end
   end
 
-  def apply_patch(json_patch, %{} = target) do
-    apply_patch([json_patch], target)
+  def apply_patch(json_patch, %{} = target, opts) do
+    apply_patch([json_patch], target, opts)
   end
 
   @doc """
@@ -88,11 +97,11 @@ defmodule Jsonpatch do
 
   (See Jsonpatch.apply_patch/2 for more details)
   """
-  @spec apply_patch!(Jsonpatch.t() | list(Jsonpatch.t()), map()) :: map()
-  def apply_patch!(json_patch, target)
+  @spec apply_patch!(Jsonpatch.t() | list(Jsonpatch.t()), map(), keyword()) :: map()
+  def apply_patch!(json_patch, target, opts \\ [])
 
-  def apply_patch!(json_patch, target) do
-    case apply_patch(json_patch, target) do
+  def apply_patch!(json_patch, target, opts) do
+    case apply_patch(json_patch, target, opts) do
       {:ok, patched} -> patched
       {:error, _, _} = error -> raise JsonpatchException, error
     end

lib/jsonpatch/operation.ex

@@ -13,8 +13,8 @@ defprotocol Jsonpatch.Operation do
   """
 
   @doc """
-  Executes the given patch to map/struct.
+  Executes the given patch to map/struct. Possible options are defined in `Jsonpatch`.
   """
-  @spec apply_op(Jsonpatch.t(), map() | Jsonpatch.error()) :: map() | Jsonpatch.error()
-  def apply_op(patch, target)
+  @spec apply_op(Jsonpatch.t(), map() | Jsonpatch.error(), keyword()) :: map() | Jsonpatch.error()
+  def apply_op(patch, target, opts \\ [])
 end