core-pipeline 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12857259602df10fd3cb27322098ba04c9f3b7706fbd982939ba162e97f4dbcb
-  data.tar.gz: fbb77341b33a2cb8195dd6431fd23efeb99499fd6bf3b175a1cadc831feae135
+  metadata.gz: 28a2f0e27827605918442c956cb6e4236cb146ba16c180f9418569dd09711da9
+  data.tar.gz: f7927e0c5657dfaa13e1bc03a48bfe0fb75ff5cb2b47d5417545c89a6cf41f78
 SHA512:
-  metadata.gz: 8383cd41dc3db75a6b8329baff6f7af529b4fcb2f82464fa3be3c5afbb3fdfe44a8666aa2815ef115a191316066cb1a49c11a48747dd1b8755d9b89233329762
-  data.tar.gz: 254a3bc8e99465394dd6f7b2bbe3dc8e90a73d655d037e3c1b44580c0de172f19360fe696683940aaf7d22c72950b91ef59ab7bd209bd30e09afdbc3929aaeb6
+  metadata.gz: 379641bc184684af5be9e35b02a926b5f85a52f63c83723afa95722136184a05c2474f64a8c8f67b5261989b098051eec20d5920901356dbaadc4063ee276dfa
+  data.tar.gz: 5bf61a391a6aac27d282eb7cb7fa8d1d973e50496316dc405760e9ef9510c7299cb46920993db62ed80b190a677342c80f4afcfd707526e14132e90621fbacc2

data/CHANGELOG.md

@@ -1,7 +1,28 @@
+## [v0.4.0](https://github.com/metabahn/corerb/releases/tag/2021-11-02.1)
+
+*released on 2021-11-02*
+
+  * `add` [#98](https://github.com/metabahn/corerb/pull/98) Add a finalizer to pipelines ([bryanp](https://github.com/bryanp))
+
+## [v0.3.0](https://github.com/metabahn/corerb/releases/tag/2021-11-02)
+
+*released on 2021-11-02*
+
+  * `chg` [#97](https://github.com/metabahn/corerb/pull/97) Designate internal state with leading and trailing double underscores ([bryanp](https://github.com/bryanp))
+  * `chg` [#89](https://github.com/metabahn/corerb/pull/89) Allow the pipeline compiler to be extended ([bryanp](https://github.com/bryanp))
+
+## [v0.2.0](https://github.com/metabahn/corerb/releases/tag/2021-10-24)
+
+*released on 2021-10-24*
+
+  * `chg` [#77](https://github.com/metabahn/corerb/pull/77) Add recompile support to pipelines ([bryanp](https://github.com/bryanp))
+
 ## [v0.1.0](https://github.com/metabahn/corerb/releases/tag/2021-07-15)
 
 *released on 2021-07-15*
 
+  * `fix` [#81](https://github.com/metabahn/corerb/pull/81) Tie up loose ends around curried pipeline actions ([bryanp](https://github.com/bryanp))
+  * `add` [#80](https://github.com/metabahn/corerb/pull/80) Define curried pipeline actions ([bryanp](https://github.com/bryanp))
   * `fix` [#69](https://github.com/metabahn/corerb/pull/69) Allow pipelines to be called at the class level ([bryanp](https://github.com/bryanp))
   * `add` [#64](https://github.com/metabahn/corerb/pull/64) Add a method for checking if a callable pipeline will call any actions ([bryanp](https://github.com/bryanp))
   * `chg` [#63](https://github.com/metabahn/corerb/pull/63) Improve inspect output for callable pipelines ([bryanp](https://github.com/bryanp))

data/lib/core/pipeline/action.rb

@@ -10,26 +10,26 @@ module Core
     #
     class Action
       include Is::Stateful
-      state :__used_random_suffixes, default: []
+      state :__used_random_suffixes__, default: []
 
       class << self
         # [public] Builds an action for a given target.
         #
-        def build(target = nil, *args, before: nil, after: nil, context: nil, &block)
+        def build(target = nil, *args, before: nil, after: nil, context: nil, curry: false, &block)
           if block
-            Actions::Block.new(target, before: before, after: after, context: context, &block)
+            Actions::Block.new(target, before: before, after: after, context: context, curry: curry, &block)
           else
-            build_target(target, *args, before: before, after: after, context: context)
+            build_target(target, *args, before: before, after: after, context: context, curry: curry)
           end
         end
 
-        private def build_target(first, *args, before:, after:, context:)
+        private def build_target(first, *args, before:, after:, context:, curry:)
           case first
           when String, Symbol
-            if (target = build_target(args[0], *args[1..], before: before, after: after, context: context))
+            if (target = build_target(args[0], *args[1..], before: before, after: after, context: context, curry: curry))
               target
             else
-              Actions::Method.new(first, before: before, after: after, context: context)
+              Actions::Method.new(first, before: before, after: after, context: context, curry: curry)
             end
           when NilClass
             nil
@@ -40,10 +40,10 @@ module Core
 
         def build_name
           suffix = generate_random_suffix
-          if __used_random_suffixes.include?(suffix)
+          if __used_random_suffixes__.include?(suffix)
             build_name
           else
-            __used_random_suffixes << suffix
+            __used_random_suffixes__ << suffix
             "action_#{suffix}"
           end
         end
@@ -55,11 +55,12 @@ module Core
 
       include Is::Inspectable
 
-      def initialize(name, before: nil, after: nil, context: nil)
+      def initialize(name, before: nil, after: nil, context: nil, curry: false)
         @name = (name || self.class.build_name).to_sym
         @before = before
         @after = after
         @context = context
+        @curry = curry
       end
 
       # [public] The action name.
@@ -74,6 +75,16 @@ module Core
       #
       attr_reader :after
 
+      # [public] The context this action should be called in.
+      #
+      attr_reader :context
+
+      # [public] Returns `true` if the action should be curried.
+      #
+      def curried?
+        @curry == true
+      end
+
       # [public] Finalizes the action for the given context.
       #
       def finalize(context)

data/lib/core/pipeline/actions/block.rb

@@ -10,10 +10,10 @@ module Core
       class Block < Action
         include Is::Inspectable
 
-        def initialize(name = nil, before: nil, after: nil, context: nil, &block)
+        def initialize(name = nil, before: nil, after: nil, context: nil, curry: false, &block)
           @block = block
 
-          super(name, before: before, after: after, context: context)
+          super(name, before: before, after: after, context: context, curry: curry)
         end
 
         # [public]
@@ -21,13 +21,19 @@ module Core
         def finalize(context)
           case @context
           when NilClass
-            context.define_method(@name, &@block)
+            unless context.method_defined?(@name)
+              context.define_method(@name, &@block)
+            end
+
             @name
           else
             if @block.binding.receiver.equal?(@context)
               @block
             else
-              @context.define_singleton_method(@name, &@block)
+              unless context.singleton_class.method_defined?(@name)
+                @context.define_singleton_method(@name, &@block)
+              end
+
               @context.method(@name).to_proc
             end
           end

data/lib/core/pipeline/actions/method.rb

@@ -10,10 +10,10 @@ module Core
       class Method < Action
         include Is::Inspectable
 
-        def initialize(name = nil, before: nil, after: nil, context: nil)
+        def initialize(name = nil, before: nil, after: nil, context: nil, curry: false)
           @method = nil
 
-          super(name, before: before, after: after, context: context)
+          super(name, before: before, after: after, context: context, curry: curry)
         end
 
         # [public]

data/lib/core/pipeline/callable.rb

@@ -18,11 +18,29 @@ module Core
         @mutex = Mutex.new
         @actions = []
         @skipped = []
+        @compiled = false
+        @compiler = Compiler
+      end
+
+      def initialize_copy(...)
+        @actions = @actions.clone
+        @skipped = @skipped.clone
+        super
       end
 
       attr_reader :actions
       attr_reader :skipped
 
+      # [public]
+      #
+      attr_writer :compiler
+
+      # [public] Relocates to another object context.
+      #
+      def relocate(object)
+        @object = object
+      end
+
       # [public] Returns true if the pipeline will call any actions.
       #
       def any?
@@ -31,14 +49,16 @@ module Core
 
       # [public] Defines a pipeline action.
       #
-      def action(*args, before: nil, after: nil, context: nil, &block)
-        @actions << Action.build(*args, before: before, after: after, context: context, &block)
+      def action(*args, before: nil, after: nil, context: nil, curry: false, &block)
+        @actions << Action.build(*args, before: before, after: after, context: context, curry: curry, &block)
+        recompile if compiled?
       end
 
       # [public] Skips the given action.
       #
       def skip(name)
         @skipped << name.to_sym
+        recompile if compiled?
       end
 
       # [public] Replaces existing actions with actions from the given pipeline.
@@ -48,6 +68,7 @@ module Core
           @mutex.synchronize do
             @actions.clear
             @actions.concat(pipeline.pipeline.actions)
+            recompile if compiled?
           end
         else
           raise ArgumentError, "expected a pipeline"
@@ -59,6 +80,7 @@ module Core
       def include(pipeline)
         if (pipeline.is_a?(Class) || pipeline.is_a?(Module)) && pipeline.ancestors.include?(Is::Pipeline)
           @actions.concat(pipeline.pipeline.actions)
+          recompile if compiled?
         else
           raise ArgumentError, "expected a pipeline"
         end
@@ -70,6 +92,7 @@ module Core
         if (pipeline.is_a?(Class) || pipeline.is_a?(Module)) && pipeline.ancestors.include?(Is::Pipeline)
           pipeline.pipeline.actions.each do |action|
             @actions.delete(action)
+            recompile if compiled?
           end
         else
           raise ArgumentError, "expected a pipeline"
@@ -79,14 +102,30 @@ module Core
       # [public] Calls the pipeline in context of an object with the given arguments.
       #
       def call(object, ...)
-        compile.call(object, ...)
+        finalize.call(object, ...)
       end
 
-      private def compile
-        instance_eval(Compiler.compile(self, @object), __FILE__, __LINE__ - 1)
+      # [public] Finalizes the pipeline.
+      #
+      def finalize
+        compile
 
         self
       end
+
+      private def compile
+        instance_eval(@compiler.compile(self, @object), __FILE__, __LINE__ - 1)
+        @compiled = true
+      end
+
+      private def recompile
+        singleton_class.remove_method(:call)
+        compile
+      end
+
+      private def compiled?
+        @compiled == true
+      end
     end
   end
 end

data/lib/core/pipeline/compiler.rb

@@ -21,28 +21,39 @@ module Core
           CODE
         end
 
+        # [public]
+        #
         private def compile_call(callable, object)
           compiled = +""
-          finalized_actions(callable, object).each_pair do |object_id, action|
-            compiled << "begin; "
+          finalized_actions(callable, object).each_value do |action|
+            compiled << "begin\n"
+            compiled << compile_action(action, object)
+            compiled << "rescue Core::Pipeline::Signals::Rejected\n"
+            compiled << "end\n"
+          end
+
+          compiled
+        end
 
-            compiled << case action
-            when Symbol
-              "object.#{action}(...); "
+        # [public]
+        #
+        private def compile_action(action, object)
+          case action[:finalized]
+          when Symbol
+            if object.private_method_defined?(action[:finalized])
+              "object.send(#{action[:finalized].inspect}, ...)\n"
             else
-              "@__finalized_actions[#{object_id}].call(...); "
+              "object.#{action[:finalized]}(...)\n"
             end
-
-            compiled << "rescue Core::Pipeline::Signals::Rejected; end\n"
+          else
+            "@__finalized_actions__[#{action[:object_id]}][:finalized].call(...)\n"
           end
-
-          compiled
         end
 
         private def finalized_actions(callable, object)
           validate_skipped_actions(callable)
           finalized_actions = build_finalized_actions(callable, object)
-          callable.instance_variable_set(:@__finalized_actions, finalized_actions)
+          callable.instance_variable_set(:@__finalized_actions__, finalized_actions)
         end
 
         private def validate_skipped_actions(callable)
@@ -57,9 +68,17 @@ module Core
           ordered_actions(callable).reject { |action|
             callable.skipped.include?(action.name)
           }.map { |action|
-            action.finalize(object)
+            finalized = action.finalize(object)
+
+            finalized = if action.curried?
+              wrap_finalized_action_for_context(finalized, action.context || object)
+            else
+              finalized
+            end
+
+            {object: action, finalized: finalized, object_id: finalized.object_id}
           }.each_with_object({}) { |action, lookup|
-            lookup[action.object_id] = action
+            lookup[action[:object_id]] = action
           }
         end
 
@@ -113,6 +132,205 @@ module Core
 
           ordered
         end
+
+        private def wrap_finalized_action_for_context(finalized, context)
+          case finalized
+          when Symbol
+            wrapped_name = :"curried_#{finalized}"
+            method = context.instance_method(finalized)
+            signature = [
+              build_method_arguments_signature(method),
+              build_method_keywords_signature(method),
+              "&block"
+            ].compact.join(", ")
+
+            code = <<~CODE
+              def #{wrapped_name}(*args, **kwargs, &block)
+                self.#{finalized}(#{signature})
+              end
+            CODE
+
+            context.class_eval(code, __FILE__, __LINE__ - 1)
+
+            wrapped_name
+          else
+            if callable_accepts_keyword_arguments?(finalized)
+              finalized_keywords = callable_keywords(finalized)
+
+              if callable_accepts_arguments?(finalized)
+                argument_count = callable_arguments(finalized).count
+
+                if callable_accepts_keyword_arguments_splat?(finalized)
+                  if callable_accepts_arguments_splat?(finalized)
+                    if RbConfig::CONFIG["RUBY_PROGRAM_VERSION"] < "3"
+                      proc { |*args, **kwargs, &block|
+                        finalized.call(*args.take(argument_count), *args[argument_count..], **kwargs.slice(*finalized_keywords), **kwargs.reject { |kwarg, _| finalized_keywords.include?(kwarg) }, &block)
+                      }
+                    else
+                      proc { |*args, **kwargs, &block|
+                        finalized.call(*args.take(argument_count), *args[argument_count..], **kwargs.slice(*finalized_keywords), **kwargs.except(*finalized_keywords), &block)
+                      }
+                    end
+                  elsif RbConfig::CONFIG["RUBY_PROGRAM_VERSION"] < "3"
+                    proc { |*args, **kwargs, &block|
+                      finalized.call(*args.take(argument_count), **kwargs.slice(*finalized_keywords), **kwargs.reject { |kwarg, _| finalized_keywords.include?(kwarg) }, &block)
+                    }
+                  else
+                    proc { |*args, **kwargs, &block|
+                      finalized.call(*args.take(argument_count), **kwargs.slice(*finalized_keywords), **kwargs.except(*finalized_keywords), &block)
+                    }
+                  end
+                elsif callable_accepts_arguments_splat?(finalized)
+                  proc { |*args, **kwargs, &block|
+                    finalized.call(*args.take(argument_count), *args[argument_count..], **kwargs.slice(*finalized_keywords), &block)
+                  }
+                else
+                  proc { |*args, **kwargs, &block|
+                    finalized.call(*args.take(argument_count), **kwargs.slice(*finalized_keywords), &block)
+                  }
+                end
+              elsif callable_accepts_keyword_arguments_splat?(finalized)
+                if callable_accepts_arguments_splat?(finalized)
+                  if RbConfig::CONFIG["RUBY_PROGRAM_VERSION"] < "3"
+                    proc { |*args, **kwargs, &block|
+                      finalized.call(*args, **kwargs.slice(*finalized_keywords), **kwargs.reject { |kwarg, _| finalized_keywords.include?(kwarg) }, &block)
+                    }
+                  else
+                    proc { |*args, **kwargs, &block|
+                      finalized.call(*args, **kwargs.slice(*finalized_keywords), **kwargs.except(*finalized_keywords), &block)
+                    }
+                  end
+                elsif RbConfig::CONFIG["RUBY_PROGRAM_VERSION"] < "3"
+                  proc { |*, **kwargs, &block|
+                    finalized.call(**kwargs.slice(*finalized_keywords), **kwargs.reject { |kwarg, _| finalized_keywords.include?(kwarg) }, &block)
+                  }
+                else
+                  proc { |*, **kwargs, &block|
+                    finalized.call(**kwargs.slice(*finalized_keywords), **kwargs.except(*finalized_keywords), &block)
+                  }
+                end
+              elsif callable_accepts_arguments_splat?(finalized)
+                proc { |*args, **kwargs, &block|
+                  finalized.call(*args, **kwargs.slice(*finalized_keywords), &block)
+                }
+              else
+                proc { |*, **kwargs, &block|
+                  finalized.call(**kwargs.slice(*finalized_keywords), &block)
+                }
+              end
+            elsif callable_accepts_arguments?(finalized)
+              argument_count = callable_arguments(finalized).count
+
+              if callable_accepts_keyword_arguments_splat?(finalized)
+                if callable_accepts_arguments_splat?(finalized)
+                  proc { |*args, **kwargs, &block|
+                    finalized.call(*args.take(argument_count), *args[argument_count..], **kwargs, &block)
+                  }
+                else
+                  proc { |*args, **kwargs, &block|
+                    finalized.call(*args.take(argument_count), **kwargs, &block)
+                  }
+                end
+              elsif callable_accepts_arguments_splat?(finalized)
+                proc { |*args, **, &block|
+                  finalized.call(*args.take(argument_count), *args[argument_count..], &block)
+                }
+              else
+                proc { |*args, **, &block|
+                  finalized.call(*args.take(argument_count), &block)
+                }
+              end
+            elsif callable_accepts_keyword_arguments_splat?(finalized)
+              if callable_accepts_arguments_splat?(finalized)
+                proc { |*args, **kwargs, &block|
+                  finalized.call(*args, **kwargs, &block)
+                }
+              else
+                proc { |*, **kwargs, &block|
+                  finalized.call(**kwargs, &block)
+                }
+              end
+            elsif callable_accepts_arguments_splat?(finalized)
+              proc { |*args, **, &block|
+                finalized.call(*args, &block)
+              }
+            else
+              proc { |*, **, &block|
+                finalized.call(&block)
+              }
+            end
+          end
+        end
+
+        private def build_method_arguments_signature(method)
+          return if method.arity == 0
+
+          arguments = callable_arguments(method)
+
+          if arguments.any?
+            if callable_accepts_arguments_splat?(method)
+              "*args.take(#{arguments.count}), *args[#{arguments.count}..]"
+            else
+              "*args.take(#{arguments.count})"
+            end
+          elsif callable_accepts_arguments_splat?(method)
+            "*args"
+          end
+        end
+
+        private def build_method_keywords_signature(method)
+          return if method.arity == 0
+
+          keywords = callable_keywords(method)
+
+          if keywords.any?
+            keywords_string = keywords.map { |keyword| ":#{keyword}" }.join(", ")
+
+            if callable_accepts_keyword_arguments_splat?(method)
+              if RbConfig::CONFIG["RUBY_PROGRAM_VERSION"] < "3"
+                "**kwargs.slice(#{keywords_string}), **kwargs.reject { |kwarg, _| [#{keywords_string}].include?(kwarg) }"
+              else
+                "**kwargs.slice(#{keywords_string}), **kwargs.except(*#{keywords_string})"
+              end
+            else
+              "**kwargs.slice(#{keywords_string})"
+            end
+          elsif callable_accepts_keyword_arguments_splat?(method)
+            "**kwargs"
+          end
+        end
+
+        private def callable_accepts_arguments_splat?(callable)
+          callable.parameters.any? { |type, _| type == :rest }
+        end
+
+        private def callable_accepts_keyword_arguments_splat?(callable)
+          callable.parameters.any? { |type, _| type == :keyrest }
+        end
+
+        private def callable_accepts_arguments?(callable)
+          callable.parameters.any? { |type, _| type == :req || type == :opt }
+        end
+
+        private def callable_accepts_keyword_arguments?(callable)
+          callable.parameters.any? { |type, _| type == :keyreq || type == :key }
+        end
+
+        private def callable_arguments(callable)
+          callable.parameters.select { |type, _|
+            type == :req || type == :opt
+          }.map { |_, name|
+            name
+          }
+        end
+
+        private def callable_keywords(callable)
+          callable.parameters.select { |type, _|
+            type == :keyreq || type == :key
+          }.map { |_, name|
+            name
+          }
+        end
       end
     end
   end

data/lib/core/pipeline/version.rb

@@ -2,7 +2,7 @@
 
 module Core
   module Pipeline
-    VERSION = "0.1.0"
+    VERSION = "0.4.0"
 
     def self.version
       VERSION

data/lib/is/pipeline.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "is/async"
 require "is/extension"
 require "is/stateful"
 
@@ -28,8 +27,8 @@ module Is
     extends :definition do
       # [public] Defines a pipeline action.
       #
-      def action(*args, before: nil, after: nil, context: nil, &block)
-        pipeline.action(*args, before: before, after: after, context: context, &block)
+      def action(*args, before: nil, after: nil, context: nil, curry: false, &block)
+        pipeline.action(*args, before: before, after: after, context: context, curry: curry, &block)
       end
 
       # [public] Skips the given action.
@@ -63,9 +62,50 @@ module Is
       def call(...)
         @pipeline.call(self, ...)
       end
+
+      # [public] Defines a pipeline action, isolated to the instance.
+      #
+      def action(*args, before: nil, after: nil, context: nil, curry: false, &block)
+        pipeline.relocate(singleton_class)
+        pipeline.action(*args, before: before, after: after, context: context, curry: curry, &block)
+      end
+
+      # [public] Skips the given action, isolated to the instance.
+      #
+      def skip_action(name)
+        pipeline.relocate(singleton_class)
+        pipeline.skip(name)
+      end
+
+      # [public] Replaces existing actions with actions from the given pipeline, isolated to the instance.
+      #
+      def use_pipeline(other_pipeline)
+        pipeline.relocate(singleton_class)
+        pipeline.use(other_pipeline)
+      end
+
+      # [public] Includes actions from the given pipeline, isolated to the instance.
+      #
+      def include_pipeline(other_pipeline)
+        pipeline.relocate(singleton_class)
+        pipeline.include(other_pipeline)
+      end
+
+      # [public] Excludes actions from the given pipeline, isolated to the instance.
+      #
+      def exclude_pipeline(other_pipeline)
+        pipeline.relocate(singleton_class)
+        pipeline.exclude(other_pipeline)
+      end
     end
 
     extends :implementation, prepend: true do
+      def finalize
+        super if defined?(super)
+        pipeline.finalize
+        self
+      end
+
       # [public] Halts the execution of the pipeline, setting the pipeline's current value to the given object.
       #
       private def halt(value = nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: core-pipeline
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Bryan Powell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: core-extension
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Turns Ruby objects into pipelines.