remap 2.1.8 → 2.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bfb874debe63d7c683fb4c029046d16e8165a3eacbedd249a0503f8294ce490
-  data.tar.gz: e534d0362da7a9239ee105a3ca6ba433ff604785b36468b045d08e51ea48bb86
+  metadata.gz: 526ddded05ad56900a9f6d1276069c48297adc6f5cb32ef08b955949bf9ee426
+  data.tar.gz: 239295549c9f0365453d19254fe21ff046755b6066f86a81596abaf102a98bbb
 SHA512:
-  metadata.gz: c71d9adde466f2b5d625679962872e4066147ebd1d6b37a5aa5707a57d4e835dd97ccc49406b46e5152fc78f9ce38f4b71f3a0fc85442e3c2893ba390047592d
-  data.tar.gz: 0dab17896fb4ad8c745d458b58a17e95c9c383e95ec4aa98bcb5817e563b26021d3f113894446dde377eabb2b17bdb6e253484206a666be48e12a1b17698197f
+  metadata.gz: 1c8d02457838ffe470359e5b9ff97cd2a31288928d238362eb38d85c190160b430242d2cfb401e9f7dbb418be4838dd6cbb1c282b68a7eababf5ad2d48030440
+  data.tar.gz: 191f1570f40e582c31e724e788882b54f83ff82e6d37931519451975355ceab5fb708260352523ddc10c849daa86d31c915221e9d539f2c069288462ca5dc45b

data/lib/remap/compiler.rb

@@ -524,6 +524,8 @@ module Remap
     # The final rule
     #
     # @return [Rule]
+    #
+    # @private
     def rule
       Rule::Collection.call(rules: rules)
     end

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.8
+  version: 2.1.13
 platform: ruby
 authors:
 - Linus Oleander
@@ -307,6 +307,9 @@ homepage: https://github.com/oleander/remap
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/oleander/remap/issues
+  homepage_uri: https://github.com/oleander/remap
+  documentation_uri: http://oleander.io/remap/
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []