core-pipeline 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a40a0de02118c468488220555a57d531b738170f51bd61bbe165f71f5851ddb6
-  data.tar.gz: bd1d8c14350961d2011fad408748095c315d04b8e7d067332e259f0b9f644656
+  metadata.gz: 12857259602df10fd3cb27322098ba04c9f3b7706fbd982939ba162e97f4dbcb
+  data.tar.gz: fbb77341b33a2cb8195dd6431fd23efeb99499fd6bf3b175a1cadc831feae135
 SHA512:
-  metadata.gz: 4b87d1a60bad4f85bbaedddcd956222c03380d957dcac7663c63ce56bda9c876f4a230907285982438ea33fc396b3c8de4497168c9eaa6eb451351a02444dbc9
-  data.tar.gz: f9c54d75eb9f2803326d422ab7efed3f27bec648bdccaf9222633c16e1078bf4b01bb2a9086b7eb9954d3c76e17cef4c6ff4bdb4f65a521b6d5d0dd25235ee15
+  metadata.gz: 8383cd41dc3db75a6b8329baff6f7af529b4fcb2f82464fa3be3c5afbb3fdfe44a8666aa2815ef115a191316066cb1a49c11a48747dd1b8755d9b89233329762
+  data.tar.gz: 254a3bc8e99465394dd6f7b2bbe3dc8e90a73d655d037e3c1b44580c0de172f19360fe696683940aaf7d22c72950b91ef59ab7bd209bd30e09afdbc3929aaeb6

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [v0.1.0](https://github.com/metabahn/corerb/releases/tag/2021-07-15)
+
+*released on 2021-07-15*
+
+  * `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))
+  * `chg` [#61](https://github.com/metabahn/corerb/pull/61) Refactor pipelines to be more performant for new instances ([bryanp](https://github.com/bryanp))
+  * `fix` [#59](https://github.com/metabahn/corerb/pull/59) Prevent collisions in auto-defined action names ([bryanp](https://github.com/bryanp))
+  * `chg` [#58](https://github.com/metabahn/corerb/pull/58) Define pipeline actions with context ([bryanp](https://github.com/bryanp))
+  * `chg` [#57](https://github.com/metabahn/corerb/pull/57) Avoid cache lookups for action calls when the action is just a method ([bryanp](https://github.com/bryanp))
+  * `add` [#54](https://github.com/metabahn/corerb/pull/54) Make all pipeline objects inspectable ([bryanp](https://github.com/bryanp))
+
 ## [v0.0.0](https://github.com/metabahn/corerb/releases/tag/2021-07-07)
 
 *released on 2021-07-07*

data/lib/core/pipeline/action.rb

@@ -1,28 +1,35 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
+require "is/stateful"
+require "securerandom"
+
 module Core
   module Pipeline
     # [public] A pipeline action.
     #
     class Action
+      include Is::Stateful
+      state :__used_random_suffixes, default: []
+
       class << self
         # [public] Builds an action for a given target.
         #
-        def build(target = nil, *args, context:, before:, after:, &block)
+        def build(target = nil, *args, before: nil, after: nil, context: nil, &block)
           if block
-            Actions::Block.new(target, before: before, after: after, &block)
+            Actions::Block.new(target, before: before, after: after, context: context, &block)
           else
-            build_target(target, *args, before: before, after: after)
+            build_target(target, *args, before: before, after: after, context: context)
           end
         end
 
-        private def build_target(first, *args, before:, after:)
+        private def build_target(first, *args, before:, after:, context:)
           case first
           when String, Symbol
-            if (target = build_target(args[0], *args[1..], before: before, after: after))
+            if (target = build_target(args[0], *args[1..], before: before, after: after, context: context))
               target
             else
-              Actions::Method.new(first, before: before, after: after)
+              Actions::Method.new(first, before: before, after: after, context: context)
             end
           when NilClass
             nil
@@ -30,11 +37,29 @@ module Core
             raise ArgumentError, "unsupported action type"
           end
         end
+
+        def build_name
+          suffix = generate_random_suffix
+          if __used_random_suffixes.include?(suffix)
+            build_name
+          else
+            __used_random_suffixes << suffix
+            "action_#{suffix}"
+          end
+        end
+
+        def generate_random_suffix
+          SecureRandom.hex(8)
+        end
       end
 
-      def initialize(before:, after:)
+      include Is::Inspectable
+
+      def initialize(name, before: nil, after: nil, context: nil)
+        @name = (name || self.class.build_name).to_sym
         @before = before
         @after = after
+        @context = context
       end
 
       # [public] The action name.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "securerandom"
+require "is/inspectable"
 
 module Core
   module Pipeline
@@ -8,24 +8,29 @@ module Core
       # [public] A pipeline action defined as a block.
       #
       class Block < Action
-        class << self
-          def build_name
-            "action_#{SecureRandom.hex(8)}"
-          end
-        end
+        include Is::Inspectable
 
-        def initialize(name = nil, before:, after:, &block)
-          @name = name || self.class.build_name
+        def initialize(name = nil, before: nil, after: nil, context: nil, &block)
           @block = block
 
-          super(before: before, after: after)
+          super(name, before: before, after: after, context: context)
         end
 
         # [public]
         #
         def finalize(context)
-          context.define_singleton_method(@name, &@block)
-          context.method(@name).to_proc
+          case @context
+          when NilClass
+            context.define_method(@name, &@block)
+            @name
+          else
+            if @block.binding.receiver.equal?(@context)
+              @block
+            else
+              @context.define_singleton_method(@name, &@block)
+              @context.method(@name).to_proc
+            end
+          end
         end
       end
     end

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

@@ -1,22 +1,31 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
+
 module Core
   module Pipeline
     module Actions
       # [public] A pipeline action defined as a method.
       #
       class Method < Action
-        def initialize(name = nil, before:, after:)
-          @name = name
+        include Is::Inspectable
+
+        def initialize(name = nil, before: nil, after: nil, context: nil)
           @method = nil
 
-          super(before: before, after: after)
+          super(name, before: before, after: after, context: context)
         end
 
         # [public]
         #
         def finalize(context)
-          context.method(@name).to_proc
+          case @context
+          when NilClass
+            context.instance_method(@name)
+            @name
+          else
+            @context.method(@name).to_proc
+          end
         end
       end
     end

data/lib/core/pipeline/callable.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "is/inspectable"
+
+require_relative "action"
+require_relative "compiler"
+
+module Core
+  module Pipeline
+    include Is::Inspectable
+    inspects without: [:@object, :@mutex]
+
+    # [public] Calls a pipeline on a pipelined object.
+    #
+    class Callable
+      def initialize(object)
+        @object = object
+        @mutex = Mutex.new
+        @actions = []
+        @skipped = []
+      end
+
+      attr_reader :actions
+      attr_reader :skipped
+
+      # [public] Returns true if the pipeline will call any actions.
+      #
+      def any?
+        (@actions.map(&:name) - @skipped).any?
+      end
+
+      # [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)
+      end
+
+      # [public] Skips the given action.
+      #
+      def skip(name)
+        @skipped << name.to_sym
+      end
+
+      # [public] Replaces existing actions with actions from the given pipeline.
+      #
+      def use(pipeline)
+        if (pipeline.is_a?(Class) || pipeline.is_a?(Module)) && pipeline.ancestors.include?(Is::Pipeline)
+          @mutex.synchronize do
+            @actions.clear
+            @actions.concat(pipeline.pipeline.actions)
+          end
+        else
+          raise ArgumentError, "expected a pipeline"
+        end
+      end
+
+      # [public] Includes actions from the given pipeline.
+      #
+      def include(pipeline)
+        if (pipeline.is_a?(Class) || pipeline.is_a?(Module)) && pipeline.ancestors.include?(Is::Pipeline)
+          @actions.concat(pipeline.pipeline.actions)
+        else
+          raise ArgumentError, "expected a pipeline"
+        end
+      end
+
+      # [public] Excludes actions from the given pipeline.
+      #
+      def exclude(pipeline)
+        if (pipeline.is_a?(Class) || pipeline.is_a?(Module)) && pipeline.ancestors.include?(Is::Pipeline)
+          pipeline.pipeline.actions.each do |action|
+            @actions.delete(action)
+          end
+        else
+          raise ArgumentError, "expected a pipeline"
+        end
+      end
+
+      # [public] Calls the pipeline in context of an object with the given arguments.
+      #
+      def call(object, ...)
+        compile.call(object, ...)
+      end
+
+      private def compile
+        instance_eval(Compiler.compile(self, @object), __FILE__, __LINE__ - 1)
+
+        self
+      end
+    end
+  end
+end

data/lib/core/pipeline/compiler.rb

@@ -5,69 +5,72 @@ require_relative "signals/rejected"
 
 module Core
   module Pipeline
-    # [public] Compiles a pipeline instance into a callable object.
+    # [public] Compiles a pipeline into evalable code.
     #
     class Compiler
       class << self
-        # [public] Compiles a pipeline instance.
+        # [public] Compiles a callable pipeline in context of an object.
         #
-        def compile(pipeline)
-          compiled = <<~CODE
-            def call(...)
-            #{compile_pipeline(pipeline)}
+        def compile(callable, object)
+          <<~CODE
+            def call(object, ...)
+            #{compile_call(callable, object)}
             rescue Core::Pipeline::Signals::Halted => error
               error.value
             end
           CODE
-
-          pipeline.instance_eval(compiled, __FILE__, __LINE__ - 1)
         end
 
-        private def compile_pipeline(pipeline)
+        private def compile_call(callable, object)
           compiled = +""
+          finalized_actions(callable, object).each_pair do |object_id, action|
+            compiled << "begin; "
+
+            compiled << case action
+            when Symbol
+              "object.#{action}(...); "
+            else
+              "@__finalized_actions[#{object_id}].call(...); "
+            end
 
-          finalized_actions(pipeline).each_key do |object_id|
-            compiled << "begin\n"
-            compiled << "  @__finalized_actions[#{object_id}].call(...)\n"
-            compiled << "rescue Core::Pipeline::Signals::Rejected\n"
-            compiled << "end\n"
+            compiled << "rescue Core::Pipeline::Signals::Rejected; end\n"
           end
 
           compiled
         end
 
-        private def finalized_actions(pipeline)
-          validate_skipped_actions(pipeline)
-          finalized_actions = build_finalized_actions(pipeline)
-          pipeline.instance_variable_set(:@__finalized_actions, finalized_actions)
+        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)
         end
 
-        private def validate_skipped_actions(pipeline)
-          pipeline.__skipped_actions.each do |skipped_action|
-            unless pipeline.__actions.any? { |action| action.name == skipped_action }
-              raise "cannot skip unknown action `#{skipped_action}`"
+        private def validate_skipped_actions(callable)
+          callable.skipped.each do |skipped|
+            unless callable.actions.any? { |action| action.name == skipped }
+              raise "cannot skip unknown action `#{skipped}`"
             end
           end
         end
 
-        private def build_finalized_actions(pipeline)
-          ordered_actions(pipeline).reject { |action|
-            pipeline.__skipped_actions.include?(action.name)
+        private def build_finalized_actions(callable, object)
+          ordered_actions(callable).reject { |action|
+            callable.skipped.include?(action.name)
           }.map { |action|
-            action.finalize(pipeline)
+            action.finalize(object)
           }.each_with_object({}) { |action, lookup|
             lookup[action.object_id] = action
           }
         end
 
-        private def ordered_actions(pipeline)
-          return pipeline.__actions if pipeline.__actions.empty?
+        private def ordered_actions(callable)
+          return callable.actions if callable.actions.empty?
 
           marked = []
           ordered = []
-          working = pipeline.__actions.dup
+          working = callable.actions.dup
 
-          pipeline.__actions.each do |action|
+          callable.actions.each do |action|
             unless action.before || action.after
               ordered << action
               working.delete(action)

data/lib/core/pipeline/signals/halted.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
+
 module Core
   module Pipeline
     module Signals
       class Halted < Exception
+        include Is::Inspectable
+
         def initialize(value)
           @value = value
         end

data/lib/core/pipeline/signals/rejected.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
+
 module Core
   module Pipeline
     module Signals
       class Rejected < Exception
+        include Is::Inspectable
       end
     end
   end

data/lib/core/pipeline/version.rb

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

data/lib/is/pipeline.rb

@@ -4,7 +4,7 @@ require "is/async"
 require "is/extension"
 require "is/stateful"
 
-require_relative "../core/pipeline/action"
+require_relative "../core/pipeline/callable"
 require_relative "../core/pipeline/compiler"
 require_relative "../core/pipeline/signals/halted"
 require_relative "../core/pipeline/signals/rejected"
@@ -15,70 +15,57 @@ module Is
   module Pipeline
     extend Is::Extension
 
+    applies do |extended:|
+      # [public] The current callable pipeline.
+      #
+      state :pipeline, default: Core::Pipeline::Callable.new(extended ? singleton_class : self)
+    end
+
     extends dependencies: [
       Is::Stateful
     ]
 
-    extends :class do
+    extends :definition do
       # [public] Defines a pipeline action.
       #
-      def action(*args, before: nil, after: nil, &block)
-        @__actions << Core::Pipeline::Action.build(*args, context: self, before: before, after: after, &block)
+      def action(*args, before: nil, after: nil, context: nil, &block)
+        pipeline.action(*args, before: before, after: after, context: context, &block)
       end
 
       # [public] Skips the given action.
       #
       def skip_action(name)
-        @__skipped_actions << name.to_sym
+        pipeline.skip(name)
       end
 
       # [public] Replaces existing actions with actions from the given pipeline.
       #
-      def use_pipeline(pipeline)
-        if (pipeline.is_a?(Class) || pipeline.is_a?(Module)) && pipeline.ancestors.include?(Is::Pipeline)
-          @__actions.clear
-          @__actions.concat(pipeline.__actions)
-        else
-          raise ArgumentError, "expected a pipeline"
-        end
+      def use_pipeline(other_pipeline)
+        pipeline.use(other_pipeline)
       end
 
       # [public] Includes actions from the given pipeline.
       #
-      def include_pipeline(pipeline)
-        if (pipeline.is_a?(Class) || pipeline.is_a?(Module)) && pipeline.ancestors.include?(Is::Pipeline)
-          @__actions.concat(pipeline.__actions)
-        else
-          raise ArgumentError, "expected a pipeline"
-        end
+      def include_pipeline(other_pipeline)
+        pipeline.include(other_pipeline)
       end
 
       # [public] Excludes actions from the given pipeline.
       #
-      def exclude_pipeline(pipeline)
-        if (pipeline.is_a?(Class) || pipeline.is_a?(Module)) && pipeline.ancestors.include?(Is::Pipeline)
-          pipeline.__actions.each do |action|
-            @__actions.delete(action)
-          end
-        else
-          raise ArgumentError, "expected a pipeline"
-        end
+      def exclude_pipeline(other_pipeline)
+        pipeline.exclude(other_pipeline)
       end
     end
 
-    extends :instance do
+    extends :implementation do
       # [public] Calls a pipeline with arguments.
       #
       def call(...)
-        # Compiles the pipeline then redefines `call` to call the compiled pipeline.
-        #
-        Core::Pipeline::Compiler.compile(self)
-
-        call(...)
+        @pipeline.call(self, ...)
       end
     end
 
-    extends :instance, prepend: true do
+    extends :implementation, prepend: true do
       # [public] Halts the execution of the pipeline, setting the pipeline's current value to the given object.
       #
       private def halt(value = nil)
@@ -91,10 +78,5 @@ module Is
         raise Core::Pipeline::Signals::Rejected
       end
     end
-
-    applied do
-      state :__actions, default: []
-      state :__skipped_actions, default: []
-    end
   end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: core-pipeline
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Bryan Powell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: core-async
+  name: core-extension
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: core-extension
+  name: core-inspect
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: core-state
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +64,7 @@ files:
 - lib/core/pipeline/action.rb
 - lib/core/pipeline/actions/block.rb
 - lib/core/pipeline/actions/method.rb
+- lib/core/pipeline/callable.rb
 - lib/core/pipeline/compiler.rb
 - lib/core/pipeline/signals/halted.rb
 - lib/core/pipeline/signals/rejected.rb