Merge pull request #18 from athonet-open/athonet

Library review and improvements
corka149 · May 26, 2023 · f0a41e2 · f0a41e2
2 parents 7927e3b + 06cc796
commit f0a41e2
Show file tree

Hide file tree

Showing 34 changed files with 1,026 additions and 1,675 deletions.
diff --git a/.credo.exs b/.credo.exs
@@ -1,188 +1,14 @@
-# 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/"]
+        included: ["lib", "test"]
       },
-      #
-      # 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`.
-        #
+        {Credo.Check.Refactor.RedundantWithClauseResult, false},
+        {Credo.Check.Readability.ParenthesesOnZeroArityDefs, false},
+        {Credo.Check.Design.AliasUsage, false}
       ]
     }
   ]

diff --git a/.formatter.exs b/.formatter.exs
@@ -1,4 +1,3 @@
-# Used by "mix format"
 [
   inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
 ]
diff --git a/.github/workflows/elixir.yml b/.github/workflows/elixir.yml
@@ -43,7 +43,6 @@ jobs:
           otp-version: "25.2"
           elixir-version: "1.14.3"
       - run: mix deps.get
-      - run: mix muzak --min-coverage 95.0
 
   # Linit and type checking
   analyze:

diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,18 @@
+# 2.0.0
+- Bugfix - ADD behaviour is now compliant with RFC (insert or update)
+- Bugfix - allow usage of nil values, previous implementation used `Map.get` with default `nil` to detect if a key was not present
+- Change - COPY operation to be based on ADD operation (as per RFC)
+- Change - MOVE operation to be based on COPY+REMOVE operation (as per RFC)
+- Change - REPLACE operation to be based on REMOVE+ADD operation (as per RFC)
+- Change - `Jsonpatch.apply_patch()` signature changes:
+  - patches can be defined as `Jsonpatch.Operation.Add/Copy/Remove/...` structs or with plain map conforming to the jsonpatch schema
+  - error reason is now defined with a `{:error, %Jsonpatch.Error{}}` tuple.
+    %Jsonpatch.Error{patch_index: _, path: _, reason: _} reports the patch index, the path and the reason that caused the error.
+- Removed - `Jsonpatch.Mapper` module, in favour of new Jsonpatch.apply_patch signature
+- Removed - `Jsonpatch.Operation` protocol
+- Feature - introduced new `Jsonpatch.apply_patch()` option `keys: {:custom, convert_fn}` to convert path fragments with a user specific logic
+- Improvements - increased test coverage
+
 # 1.0.1
 - Escape remaining keys before comparing them to the (already escaped) keys from earlier in the diffing process when determining Remove operations
 

diff --git a/Makefile b/Makefile
@@ -6,5 +6,4 @@ check:
 	mix test
 	mix dialyzer
 	mix credo --strict
-	MIX_ENV=mutation mix muzak --min-coverage 95.0
 	MIX_ENV=test mix coveralls
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 # Jsonpatch
+
 ![Elixir CI](https://github.com/corka149/jsonpatch/workflows/Elixir%20CI/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/corka149/jsonpatch/badge.svg?branch=master)](https://coveralls.io/github/corka149/jsonpatch?branch=master)
 [![Generic badge](https://img.shields.io/badge/Mutation-Tested-success.svg)](https://shields.io/)
@@ -7,21 +8,18 @@
 
 An implementation of [RFC 6902](https://tools.ietf.org/html/rfc6902) in pure Elixir.
 
-
 Features:
 
-1. Creating a patch by comparing to maps and structs
-2. Apply patches to maps and structs - supports operations:
+- Creating a patch by comparing to maps and lists
+- Apply patches to maps and lists - supports operations:
     - add
     - replace
     - remove
     - copy
     - move
     - test
-3. De/Encoding and mapping
-4. Escaping of "`/`" (by "`~1`") and "`~`" (by "`~0`")
-5. Allow usage of `-` for appending things to list (Add and Copy operation)
-
+- Escaping of "`/`" (by "`~1`") and "`~`" (by "`~0`")
+- Allow usage of `-` for appending things to list (Add and Copy operation)
 
 ## Getting started
 
@@ -54,24 +52,6 @@ iex> Jsonpatch.diff(source, destination)
 ]}
 ```
 
-### Mapping for de- and encoding
-
-Map a JSON patch struct to a regular map.
-
-```elixir
-iex> add_patch_map = %Jsonpatch.Operation.Add{path: "/name", value: "Alice"}
-iex> Jsonpatch.Mapper.to_map(add_patch_map)
-%{op: "add", path: "/name", value: "Alice"}
-```
-
-Map a regular map to a JSON patch struct.
-
-```elixir
-iex> add_patch_map = %{"op" => "add", "path" => "/name", "value" => "Alice"}
-iex> Jsonpatch.Mapper.from_map(add_patch_map)
-%Jsonpatch.Operation.Add{path: "/name", value: "Alice"}
-```
-
 ### Apply patches
 
 ```elixir
@@ -87,28 +67,6 @@ iex> Jsonpatch.apply_patch(patch, target)
 {:ok, %{"name" => "Bob", "married" => true, "hobbies" => ["Elixir!"], "age" => 33}}
 ```
 
-### In an `exs` script
-
-With `Mix.install` small scripts can be written to create JSON patches.
-```elixir
-Mix.install([:jsonpatch, :poison])
-
-source =
-  File.read!("foo.json")
-  |> Poison.Parser.parse!(%{})
-
-destination =
-  File.read!("bar.json")
-  |> Poison.Parser.parse!(%{})
-
-patch =
-  source
-  |> Jsonpatch.diff(destination)
-  |> Jsonpatch.Mapper.to_map()
-
-IO.inspect(patch, label: :patch)
-```
-
 ## Important sources
 - [Official RFC 6902](https://tools.ietf.org/html/rfc6902)
 - [Inspiration: python-json-patch](https://github.com/stefankoegl/python-json-patch) 
diff --git a/coveralls.json b/coveralls.json
@@ -1,16 +1,8 @@
 {
     "skip_files": ["test/support/"],
-    "default_stop_words": [
-      "defdelegate",
-      "defmodule",
-      "defevent",
-      "defrecord",
-      "defstruct",
-      "defimpl",
-      "def.+(.+//.+).+do"
-    ],
     "coverage_options": {
+      "html_filter_full_covered": true,
       "treat_no_relevant_lines_as_covered": true,
-      "minimum_coverage": 85
+      "minimum_coverage": 100
     }
   }