remap 2.2.41 → 2.2.45

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a8ee7751985c548b272cb12bb0b08b655f52de3143075afafd8578f9e604eba
-  data.tar.gz: f333d2922e7d5ef7a6bd050eb2fc0261446097fdd17f2745eef1a3bc35eb96ee
+  metadata.gz: dd36dff737c5c3965b1a7bc5dd643bc83098a908c7dac7426a13e6c40a76af95
+  data.tar.gz: 958e0d19bc7d57a72697af4c1dea86f47810f87025a99ab1e13824f82822ce53
 SHA512:
-  metadata.gz: 69b98a323c17562a06d4b83f3455c2b1c7e6a482280f5afe283f0d9570411391bb2d0de353d96250436d8aa51ad8443f1a3e25805dde0d6baebbc5286d019a9e
-  data.tar.gz: 86f03041d4cf3ef2ebd1c597269645ae83c55e5d3326077a9d55f51f3f0a47aea131523e9e314d635f34d60487dbba20350a28ffa3eca9b032f0aecd01bf006f
+  metadata.gz: 62e4ad82b773e57a113f190ab5cb3d238e9e0059aa4f692475c8372c91ed25dc9c564782a0522cb1902c2d5f408f0109136487ceb6176bfd5e0e4dd3b92cba23
+  data.tar.gz: 647d4ee1c543073752b92d4e04a7deadde0dd4522ae793cf475544f58a88986d9077bf44fcb2b3cf0acf2b9ee7d5400ff4c95d246f05b78f9e9ce62c800e0c2f

data/lib/remap/base.rb

@@ -106,13 +106,13 @@ module Remap
   class Base < Mapper
     include ActiveSupport::Configurable
     include Dry::Core::Constants
-
     include Catchable
-
+    extend Mapper::API
     using State::Extension
 
     with_options instance_accessor: true do |scope|
       scope.config_accessor(:contract) { Dry::Schema.define {} }
+      scope.config_accessor(:config_options) { Config.new }
       scope.config_accessor(:constructor) { IDENTITY }
       scope.config_accessor(:options) { EMPTY_ARRAY }
       scope.config_accessor(:option) { EMPTY_HASH }
@@ -122,31 +122,6 @@ module Remap
 
     schema schema.strict(false)
 
-    # extend Operation
-
-    def self.call(input, backtrace: caller, **options, &error)
-      unless block_given?
-        return call(input, **options) do |failure|
-          raise failure.exception(backtrace)
-        end
-      end
-
-      s0 = State.call(input, options: options, mapper: self)._
-
-      s1 = call!(s0) do |failure|
-        return error[failure]
-      end
-
-      case s1
-      in { value: value }
-        value
-      in { notices: [] }
-        error[s1.failure("No data could be mapped")]
-      in { notices: }
-        error[Failure.new(failures: notices)]
-      end
-    end
-
     # Defines a schema for the mapper
     # If the schema fail, the mapper will fail
     #
@@ -289,6 +264,25 @@ module Remap
       new(state.options).call(state, &error)
     end
 
+    # Configuration options for the mapper
+    #
+    # @yield [Config]
+    # @yieldreturn [void]
+    #
+    # @return [void]
+    def self.configuration(&block)
+      config = Config.new
+      block[config]
+      self.config_options = config
+    end
+
+    # @see Mapper::API
+    #
+    # @private
+    def self.validate?
+      config_options.validation
+    end
+
     # Mappers state according to the mapper rules
     #
     # @param state [State]

data/lib/remap/config.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Remap
+  class Config < OpenStruct
+    def initialize
+      super(validation: false)
+    end
+  end
+end

data/lib/remap/extensions/array.rb

@@ -4,6 +4,8 @@ module Remap
   module Extensions
     module Array
       refine ::Array do
+        using Object
+
         # @return [Array<Hash>]
         def to_hash
           map(&:to_hash)

data/lib/remap/extensions/hash.rb

@@ -5,7 +5,7 @@ module Remap
     module Hash
       refine ::Hash do
         def formatted
-          JSON.neat_generate(self, sort: true, wrap: 40, aligned: true, around_colon: 1)
+          JSON.neat_generate(compact_blank, sort: true, wrap: 40, aligned: true, around_colon: 1)
         end
       end
     end

data/lib/remap/mapper/and.rb

@@ -46,6 +46,12 @@ module Remap
 
         state1.combine(state2)
       end
+
+      # @return [String]
+      def inspect
+        "%s & %s" % [left, right]
+      end
+      alias to_s inspect
     end
   end
 end

data/lib/remap/mapper/binary.rb

@@ -4,10 +4,15 @@ module Remap
   class Mapper
     # @abstract
     class Binary < self
-      include Operation
+      include API
 
       attribute :left, Types::Mapper
       attribute :right, Types::Mapper
+
+      # @return [Bool]
+      def validate?
+        left.validate? && right.validate?
+      end
     end
   end
 end

data/lib/remap/mapper/or.rb

@@ -39,6 +39,12 @@ module Remap
           end
         end
       end
+
+      # @return [String]
+      def inspect
+        "%s | %s" % [left, right]
+      end
+      alias to_s inspect
     end
   end
 end

data/lib/remap/mapper/support/api.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Remap
+  class Mapper
+    using State::Extension
+
+    module API
+      # @return [Boolean]
+      #
+      # @abstract
+      # @private
+      def validate?
+        raise NotImplementedError, "`validate?` is not implemented for #{self}"
+      end
+
+      # @param input [Any]
+      # @param backtrace [Array<String>]
+      # @param options [Hash]
+      #
+      # @yieldparam [Failure]
+      # @yieldreturn [T]
+      #
+      # @return [Any, T]
+      def call(input, backtrace: caller, **options, &error)
+        unless block_given?
+          return call(input, **options) do |failure|
+            raise failure.exception(backtrace)
+          end
+        end
+
+        s0 = State.call(input, options: options, mapper: self)._
+
+        s1 = call!(s0) do |failure|
+          return error[failure]
+        end
+
+        case s1
+        in { value: value }
+          value
+        in { notices: [] }
+          error[s1.failure("No data could be mapped")]
+        in { notices: }
+          error[Failure.new(failures: notices)]
+        end
+      end
+    end
+  end
+end

data/lib/remap/mapper/xor.rb

@@ -44,6 +44,12 @@ module Remap
 
         state1.combine(state2).failure("Both left and right passed xor operation").then(&error)
       end
+
+      # @return [String]
+      def inspect
+        "%s ^ %s" % [left, right]
+      end
+      alias to_s inspect
     end
   end
 end

data/lib/remap/notice/error.rb

@@ -11,27 +11,6 @@ module Remap
       delegate_missing_to :notice
       delegate :inspect, :to_s, to: :notice
       option :notice, type: Types.Instance(Notice)
-
-      def inspect
-        "#<%s %s>" % [self.class, to_hash.formatted]
-      end
-
-      def undefined(state)
-        state.set(notice: notice).except(:value)
-      end
-
-      def failure(state)
-        Failure.new(failures: [notice], notices: state.fetch(:notices))
-      end
-
-      def traced(backtrace)
-        e = Traced.new(notice: notice)
-        e.set_backtrace(backtrace)
-        e
-      end
-    end
-
-    class Traced < Error
     end
   end
 end

data/lib/remap/notice.rb

@@ -20,19 +20,5 @@ module Remap
     def to_hash
       super.except(:backtrace).compact_blank
     end
-
-    # Used by State to skip mapping rules
-    #
-    # @raise [Notice::Ignore]
-    def ignore!
-      raise Ignore.new(notice: self)
-    end
-
-    # Used by the state to halt mappers
-    #
-    # @raise [Notice::Fatal]
-    def fatal!
-      raise Fatal.new(notice: self)
-    end
   end
 end

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

@@ -31,7 +31,7 @@ module Remap
         #
         # @return [State]
         def call(state)
-          catch { super(state.set(id: _1)).except(:id) }
+          catch_ignored { super(state.set(id: _1)).remove_id }
         end
       end
     end

data/lib/remap/state/extension.rb

@@ -92,6 +92,8 @@ module Remap
         #
         # @return [self]
         def _(&block)
+          return self unless mapper.validate?
+
           unless block
             return _ do |reason|
               raise ArgumentError, "[BUG] State: #{formatted} reason: #{reason.formatted}"
@@ -320,6 +322,11 @@ module Remap
           fetch(:id)
         end
 
+        # @return [Mapper::API]
+        def mapper
+          fetch(:mapper)
+        end
+
         # @return [Array<Symbol>]
         def ids
           fetch(:ids)

data/lib/remap/state/schema.rb

@@ -9,8 +9,12 @@ module Remap
       required(:notices).array(Types.Instance(Notice))
       required(:options).value(:hash)
       required(:path).array(Types::Key)
-      required(:ids).value(:array)
-      required(:fatal_ids).value(:array)
+
+      required(:ids).array(Types::ID)
+      optional(:id).filled(Types::ID)
+
+      required(:fatal_ids).array(Types::ID)
+      optional(:fatal_id).filled(Types::ID)
 
       optional(:index).filled(:integer)
       optional(:element).filled

data/lib/remap/types.rb

@@ -18,6 +18,7 @@ module Remap
     Rule       = Interface(:call) | Instance(Proc)
     Key        = Interface(:hash)
     Notice     = Instance(Remap::Notice)
+    ID         = String | Symbol
 
     # Validates a state according to State::Schema
     State = Hash.constructor do |input, type, &error|

data/lib/remap.rb

@@ -19,6 +19,7 @@ module Remap
   loader = Zeitwerk::Loader.for_gem
   loader.collapse("#{__dir__}/remap/mapper/support")
   loader.setup
+  loader.inflector.inflect "api" => "API"
   loader.eager_load
 
   include ClassInterface

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remap
 version: !ruby/object:Gem::Version
-  version: 2.2.41
+  version: 2.2.45
 platform: ruby
 authors:
 - Linus Oleander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -251,6 +251,7 @@ files:
 - lib/remap/catchable.rb
 - lib/remap/class_interface.rb
 - lib/remap/compiler.rb
+- lib/remap/config.rb
 - lib/remap/constructor.rb
 - lib/remap/constructor/argument.rb
 - lib/remap/constructor/keyword.rb
@@ -271,6 +272,7 @@ files:
 - lib/remap/mapper/and.rb
 - lib/remap/mapper/binary.rb
 - lib/remap/mapper/or.rb
+- lib/remap/mapper/support/api.rb
 - lib/remap/mapper/support/operations.rb
 - lib/remap/mapper/xor.rb
 - lib/remap/nothing.rb
@@ -278,7 +280,6 @@ files:
 - lib/remap/notice/error.rb
 - lib/remap/notice/fatal.rb
 - lib/remap/notice/ignore.rb
-- lib/remap/operation.rb
 - lib/remap/path.rb
 - lib/remap/path/input.rb
 - lib/remap/path/output.rb

data/lib/remap/operation.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Remap
-  using State::Extension
-
-  # Class interface for {Remap::Base} and instance interface for {Mapper}
-  module Operation
-    # Public interface for mappers
-    #
-    # @param input [Any] data to be mapped
-    # @param options [Hash] mapper options
-    #
-    # @yield [Failure]
-    #   when a non-critical error occurs
-    # @yieldreturn T
-    #
-    # @return [Any, T]
-    #   when request is a success
-    # @raise [Remap::Error]
-    #   when a fatal error occurs
-    def call(input, backtrace: caller, **options, &error)
-      unless block_given?
-        return call(input, **options) do |failure|
-          raise failure.exception(backtrace)
-        end
-      end
-
-      s0 = State.call(input, options: options, mapper: self)._
-
-      s1 = call!(s0) do |failure|
-        return error[failure]
-      end
-
-      case s1
-      in { value: value }
-        value
-      in { notices: [] }
-        error[s1.failure("No data could be mapped")]
-      in { notices: }
-        error[Failure.new(failures: notices)]
-      end
-    end
-  end
-end