remap 2.1.12 → 2.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a7b64e11ae09304377105e5dcfbd8414a26cf8b321ff5c49dad106151fd5cd4
-  data.tar.gz: 47112866b73268437edd2b5e6039394f05c251a666861c05bc48779f88f8c3a8
+  metadata.gz: 526ddded05ad56900a9f6d1276069c48297adc6f5cb32ef08b955949bf9ee426
+  data.tar.gz: 239295549c9f0365453d19254fe21ff046755b6066f86a81596abaf102a98bbb
 SHA512:
-  metadata.gz: a08f53a8d37c1edae16df7490e31a8318021e8cb29320ba34b538587c9d9bc9caa62ac075e9d5e34846d130f31cfacfd5322c6b432c3f85d0f0719d3371d3607
-  data.tar.gz: 17f6c2ed9e9f5782ac7b0b9cd802da2798b12ba0bd78e48945d952d06ee1da335b745bcf1fb78ca9635b13d39b4df1e2c4c8a0824acd0b5a0343f2c185d6e6c6
+  metadata.gz: 1c8d02457838ffe470359e5b9ff97cd2a31288928d238362eb38d85c190160b430242d2cfb401e9f7dbb418be4838dd6cbb1c282b68a7eababf5ad2d48030440
+  data.tar.gz: 191f1570f40e582c31e724e788882b54f83ff82e6d37931519451975355ceab5fb708260352523ddc10c849daa86d31c915221e9d539f2c069288462ca5dc45b

data/lib/remap/rule/map/optional.rb

@@ -9,6 +9,24 @@ module Remap
         # Represents an optional mapping rule
         # When the mapping fails, the value is ignored
         #
+        # @example Map [:name] to [:nickname]
+        #   map = Map::Optional.call({
+        #     path: {
+        #       input: [:name],
+        #       output: [:nickname]
+        #     }
+        #   })
+        #
+        #   state = Remap::State.call({
+        #     name: "John"
+        #   })
+        #
+        #   output = map.call(state) do |failure|
+        #     raise failure.exeception
+        #   end
+        #
+        #   output.fetch(:value) # => { nickname: "John" }
+        #
         # @param state [State]
         #
         # @return [State]

data/lib/remap/rule/map/required.rb

@@ -11,6 +11,25 @@ module Remap
         # Represents a required mapping rule
         # When it fails, the entire mapping is marked as failed
         #
+        # @example Map [:name] to [:nickname]
+        #   map = Map::Required.call({
+        #     backtrace: caller,
+        #     path: {
+        #       input: [:name],
+        #       output: [:nickname]
+        #     }
+        #   })
+        #
+        #   state = Remap::State.call({
+        #     name: "John"
+        #   })
+        #
+        #   output = map.call(state) do |failure|
+        #     raise failure.exeception
+        #   end
+        #
+        #   output.fetch(:value) # => { nickname: "John" }
+        #
         # @param state [State]
         #
         # @return [State]

data/lib/remap/rule/map.rb

@@ -28,7 +28,7 @@ module Remap
       attribute? :path, Path.default { Path.call(EMPTY_HASH) }
 
       # @return [Rule]
-      attribute :rule, Rule.default { Void.call(EMPTY_HASH) }
+      attribute? :rule, Rule.default { Void.call(EMPTY_HASH) }
 
       # @return [Array<String>]
       attribute? :backtrace, Types::Backtrace, default: EMPTY_ARRAY

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remap
 version: !ruby/object:Gem::Version
-  version: 2.1.12
+  version: 2.1.13
 platform: ruby
 authors:
 - Linus Oleander