callable_tree 0.3.7 → 0.3.8

data/examples/builder/hooks.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'callable_tree'
+
+HooksSample =
+  CallableTree::Node::Internal::Builder
+  .new
+  .hookable
+  .build
+
+CallableTree::Node::Root.new.append(
+  HooksSample
+  .new
+  .append(
+    # anonymous external node
+    lambda do |input, **_options|
+      puts "external input: #{input}"
+      input * 2
+    end
+  )
+  .before_matcher do |input, **_options|
+    puts "before_matcher input: #{input}"
+    input + 1
+  end
+  .around_matcher do |input, **_options, &block|
+    puts "around_matcher input: #{input}"
+    matched = block.call
+    puts "around_matcher matched: #{matched}"
+    !matched
+  end
+  .after_matcher do |matched, **_options|
+    puts "after_matcher matched: #{matched}"
+    !matched
+  end
+  .before_caller do |input, **_options|
+    puts "before_caller input: #{input}"
+    input + 1
+  end
+  .around_caller do |input, **_options, &block|
+    puts "around_caller input: #{input}"
+    output = block.call
+    puts "around_caller output: #{output}"
+    output * input
+  end
+  .after_caller do |output, **_options|
+    puts "after_caller output: #{output}"
+    output * 2
+  end
+  .before_terminator do |output, *_inputs, **_options|
+    puts "before_terminator output: #{output}"
+    output + 1
+  end
+  .around_terminator do |output, *_inputs, **_options, &block|
+    puts "around_terminator output: #{output}"
+    terminated = block.call
+    puts "around_terminator terminated: #{terminated}"
+    !terminated
+  end
+  .after_terminator do |terminated, **_options|
+    puts "after_terminator terminated: #{terminated}"
+    !terminated
+  end
+).tap do |tree|
+  options = { foo: :bar }
+  output = tree.call(1, **options)
+  puts "result: #{output}"
+end

data/examples/builder/logging.rb

@@ -17,9 +17,8 @@ JSONParser =
       block.call(json, **options)
     end
   end
-  .terminator do
-    true
-  end
+  .terminator { true }
+  # .identifier { |_node_:| :as_you_like } # optional
   .hookable
   .build
 
@@ -35,9 +34,8 @@ XMLParser =
       block.call(REXML::Document.new(file), **options)
     end
   end
-  .terminator do
-    true
-  end
+  .terminator { true }
+  # .identifier { |_node_:| :as_you_like } # optional
   .hookable
   .build
 
@@ -52,6 +50,7 @@ def build_json_scraper(type)
         .map { |element| [element['name'], element['emoji']] }
         .to_h
     end
+    # .identifier { |_node_:| :as_you_like } # optional
     .hookable
     .build
 end
@@ -72,6 +71,7 @@ def build_xml_scraper(type)
         .map { |element| [element['name'], element['emoji']] }
         .to_h
     end
+    # .identifier { |_node_:| :as_you_like } # optional
     .hookable
     .build
 end
@@ -79,35 +79,38 @@ end
 AnimalsXMLScraper = build_xml_scraper(:animals)
 FruitsXMLScraper = build_xml_scraper(:fruits)
 
-loggable = proc do |node|
-  indent_size = 2
-  blank = ' '
-  list_style = '*'
-
-  node.after_matcher! do |matched, _node_:, **|
-    prefix = list_style.rjust(_node_.depth * indent_size - indent_size + list_style.length, blank)
-    puts "#{prefix} #{_node_.identity}: [matched: #{matched}]"
-    matched
-  end
+module Logging
+  INDENT_SIZE = 2
+  BLANK = ' '
+  LIST_STYLE = '*'
+  INPUT_LABEL  = 'Input :'
+  OUTPUT_LABEL = 'Output:'
 
-  if node.external?
-    input_label  = 'Input :'
-    output_label = 'Output:'
+  def self.loggable(node)
+    node.after_matcher! do |matched, _node_:, **|
+      prefix = LIST_STYLE.rjust((_node_.depth * INDENT_SIZE) - INDENT_SIZE + LIST_STYLE.length, BLANK)
+      puts "#{prefix} #{_node_.identity}: [matched: #{matched}]"
+      matched
+    end
 
-    node
-      .before_caller! do |input, *, _node_:, **|
-        input_prefix = input_label.rjust(_node_.depth * indent_size + input_label.length, blank)
-        puts "#{input_prefix} #{input}"
-        input
-      end
-      .after_caller! do |output, _node_:, **|
-        output_prefix = output_label.rjust(_node_.depth * indent_size + output_label.length, blank)
-        puts "#{output_prefix} #{output}"
-        output
-      end
+    if node.external?
+      node
+        .before_caller! do |input, *, _node_:, **|
+          input_prefix = INPUT_LABEL.rjust((_node_.depth * INDENT_SIZE) + INPUT_LABEL.length, BLANK)
+          puts "#{input_prefix} #{input}"
+          input
+        end
+        .after_caller! do |output, _node_:, **|
+          output_prefix = OUTPUT_LABEL.rjust((_node_.depth * INDENT_SIZE) + OUTPUT_LABEL.length, BLANK)
+          puts "#{output_prefix} #{output}"
+          output
+        end
+    end
   end
 end
 
+loggable = Logging.method(:loggable)
+
 tree = CallableTree::Node::Root.new.seekable.append(
   JSONParser.new.tap(&loggable).seekable.append(
     AnimalsJSONScraper.new.tap(&loggable).verbosify,

data/examples/{external-verbosify.rb → class/external-verbosify.rb}

@@ -96,7 +96,7 @@ tree = CallableTree::Node::Root.new.append(
   )
 )
 
-Dir.glob("#{__dir__}/docs/*") do |file|
+Dir.glob("#{__dir__}/../docs/*") do |file|
   options = { foo: :bar }
   pp tree.call(file, **options)
   puts '---'

data/examples/class/hooks.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'callable_tree'
+
+module Node
+  class HooksSample
+    include CallableTree::Node::Internal
+    prepend CallableTree::Node::Hooks::Matcher
+    prepend CallableTree::Node::Hooks::Caller
+    prepend CallableTree::Node::Hooks::Terminator
+  end
+end
+
+CallableTree::Node::Root.new.append(
+  Node::HooksSample
+    .new
+    .append(
+      # anonymous external node
+      lambda do |input, **_options|
+        puts "external input: #{input}"
+        input * 2
+      end
+    )
+    .before_matcher do |input, **_options|
+      puts "before_matcher input: #{input}"
+      input + 1
+    end
+    .around_matcher do |input, **_options, &block|
+      puts "around_matcher input: #{input}"
+      matched = block.call
+      puts "around_matcher matched: #{matched}"
+      !matched
+    end
+    .after_matcher do |matched, **_options|
+      puts "after_matcher matched: #{matched}"
+      !matched
+    end
+    .before_caller do |input, **_options|
+      puts "before_caller input: #{input}"
+      input + 1
+    end
+    .around_caller do |input, **_options, &block|
+      puts "around_caller input: #{input}"
+      output = block.call
+      puts "around_caller output: #{output}"
+      output * input
+    end
+    .after_caller do |output, **_options|
+      puts "after_caller output: #{output}"
+      output * 2
+    end
+    .before_terminator do |output, *_inputs, **_options|
+      puts "before_terminator output: #{output}"
+      output + 1
+    end
+    .around_terminator do |output, *_inputs, **_options, &block|
+      puts "around_terminator output: #{output}"
+      terminated = block.call
+      puts "around_terminator terminated: #{terminated}"
+      !terminated
+    end
+    .after_terminator do |terminated, **_options|
+      puts "after_terminator terminated: #{terminated}"
+      !terminated
+    end
+).tap do |tree|
+  options = { foo: :bar }
+  output = tree.call(1, **options)
+  puts "result: #{output}"
+end

data/examples/{identity.rb → class/identity.rb}

@@ -117,7 +117,7 @@ tree = CallableTree::Node::Root.new.append(
   )
 )
 
-Dir.glob("#{__dir__}/docs/*") do |file|
+Dir.glob("#{__dir__}/../docs/*") do |file|
   options = { foo: :bar }
   pp tree.call(file, **options)
   puts '---'

data/examples/{internal-seekable.rb → class/internal-seekable.rb}

@@ -96,7 +96,7 @@ tree = CallableTree::Node::Root.new.seekable.append(
   )
 )
 
-Dir.glob("#{__dir__}/docs/*") do |file|
+Dir.glob("#{__dir__}/../docs/*") do |file|
   options = { foo: :bar }
   pp tree.call(file, **options)
   puts '---'

data/examples/{logging.rb → class/logging.rb}

@@ -5,36 +5,6 @@ require 'json'
 require 'rexml/document'
 
 module Node
-  module Logging
-    INDENT_SIZE = 2
-    BLANK = ' '
-
-    module Match
-      LIST_STYLE = '*'
-
-      def match?(_input, **_options)
-        super.tap do |matched|
-          prefix = LIST_STYLE.rjust(depth * INDENT_SIZE - INDENT_SIZE + LIST_STYLE.length, BLANK)
-          puts "#{prefix} #{identity}: [matched: #{matched}]"
-        end
-      end
-    end
-
-    module Call
-      INPUT_LABEL  = 'Input :'
-      OUTPUT_LABEL = 'Output:'
-
-      def call(input, **_options)
-        super.tap do |output|
-          input_prefix = INPUT_LABEL.rjust(depth * INDENT_SIZE + INPUT_LABEL.length, BLANK)
-          puts "#{input_prefix} #{input}"
-          output_prefix = OUTPUT_LABEL.rjust(depth * INDENT_SIZE + OUTPUT_LABEL.length, BLANK)
-          puts "#{output_prefix} #{output}"
-        end
-      end
-    end
-  end
-
   class Identity
     attr_reader :klass, :type
 
@@ -51,7 +21,7 @@ module Node
   module JSON
     class Parser
       include CallableTree::Node::Internal
-      prepend Logging::Match
+      prepend CallableTree::Node::Hooks::Matcher
 
       def match?(input, **_options)
         File.extname(input) == '.json'
@@ -71,8 +41,8 @@ module Node
 
     class Scraper
       include CallableTree::Node::External
-      prepend Logging::Match
-      prepend Logging::Call
+      prepend CallableTree::Node::Hooks::Matcher
+      prepend CallableTree::Node::Hooks::Caller
 
       def initialize(type:)
         @type = type
@@ -97,7 +67,7 @@ module Node
   module XML
     class Parser
       include CallableTree::Node::Internal
-      prepend Logging::Match
+      prepend CallableTree::Node::Hooks::Matcher
 
       def match?(input, **_options)
         File.extname(input) == '.xml'
@@ -116,8 +86,8 @@ module Node
 
     class Scraper
       include CallableTree::Node::External
-      prepend Logging::Match
-      prepend Logging::Call
+      prepend CallableTree::Node::Hooks::Matcher
+      prepend CallableTree::Node::Hooks::Caller
 
       def initialize(type:)
         @type = type
@@ -142,18 +112,50 @@ module Node
   end
 end
 
+module Logging
+  INDENT_SIZE = 2
+  BLANK = ' '
+  LIST_STYLE = '*'
+  INPUT_LABEL  = 'Input :'
+  OUTPUT_LABEL = 'Output:'
+
+  def self.loggable(node)
+    node.after_matcher! do |matched, _node_:, **|
+      prefix = LIST_STYLE.rjust((_node_.depth * INDENT_SIZE) - INDENT_SIZE + LIST_STYLE.length, BLANK)
+      puts "#{prefix} #{_node_.identity}: [matched: #{matched}]"
+      matched
+    end
+
+    if node.external?
+      node
+        .before_caller! do |input, *, _node_:, **|
+          input_prefix = INPUT_LABEL.rjust((_node_.depth * INDENT_SIZE) + INPUT_LABEL.length, BLANK)
+          puts "#{input_prefix} #{input}"
+          input
+        end
+        .after_caller! do |output, _node_:, **|
+          output_prefix = OUTPUT_LABEL.rjust((_node_.depth * INDENT_SIZE) + OUTPUT_LABEL.length, BLANK)
+          puts "#{output_prefix} #{output}"
+          output
+        end
+    end
+  end
+end
+
+loggable = Logging.method(:loggable)
+
 tree = CallableTree::Node::Root.new.append(
-  Node::JSON::Parser.new.append(
-    Node::JSON::Scraper.new(type: :animals).verbosify,
-    Node::JSON::Scraper.new(type: :fruits).verbosify
+  Node::JSON::Parser.new.tap(&loggable).append(
+    Node::JSON::Scraper.new(type: :animals).tap(&loggable).verbosify,
+    Node::JSON::Scraper.new(type: :fruits).tap(&loggable).verbosify
   ),
-  Node::XML::Parser.new.append(
-    Node::XML::Scraper.new(type: :animals).verbosify,
-    Node::XML::Scraper.new(type: :fruits).verbosify
+  Node::XML::Parser.new.tap(&loggable).append(
+    Node::XML::Scraper.new(type: :animals).tap(&loggable).verbosify,
+    Node::XML::Scraper.new(type: :fruits).tap(&loggable).verbosify
   )
 )
 
-Dir.glob("#{__dir__}/docs/*") do |file|
+Dir.glob("#{__dir__}/../docs/*") do |file|
   options = { foo: :bar }
   pp tree.call(file, **options)
   puts '---'

data/lib/callable_tree/node/builder.rb

@@ -24,6 +24,11 @@ module CallableTree
         self
       end
 
+      def identifier(&block)
+        @identifier = block
+        self
+      end
+
       def hookable(hookable = true)
         @hookable = hookable
         self
@@ -33,6 +38,7 @@ module CallableTree
         matcher = @matcher
         caller = @caller
         terminator = @terminator
+        identifier = @identifier
         hookable = @hookable
 
         validate(
@@ -47,6 +53,7 @@ module CallableTree
             if hookable
               prepend Hooks::Matcher
               prepend Hooks::Caller
+              prepend Hooks::Terminator
             end
 
             if matcher
@@ -72,6 +79,12 @@ module CallableTree
                 end
               end
             end
+
+            if identifier
+              define_method(:identity) do
+                identifier.call(_node_: self) { super() }
+              end
+            end
           end
       end
 

data/lib/callable_tree/node/hooks/terminator.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module CallableTree
+  module Node
+    module Hooks
+      module Terminator
+        def self.included(_subclass)
+          raise ::CallableTree::Error, "#{self} must be prepended"
+        end
+
+        def before_terminator(&block)
+          clone.before_terminator!(&block)
+        end
+
+        def before_terminator!(&block)
+          before_terminator_callbacks << block
+          self
+        end
+
+        def around_terminator(&block)
+          clone.around_terminator!(&block)
+        end
+
+        def around_terminator!(&block)
+          around_terminator_callbacks << block
+          self
+        end
+
+        def after_terminator(&block)
+          clone.after_terminator!(&block)
+        end
+
+        def after_terminator!(&block)
+          after_terminator_callbacks << block
+          self
+        end
+
+        def terminate?(output, *inputs, **options)
+          output = before_terminator_callbacks.reduce(output) do |output, callable|
+            callable.call(output, *inputs, **options, _node_: self)
+          end
+
+          terminated =
+            if around_terminator_callbacks.empty?
+              super(output, *inputs, **options)
+            else
+              around_terminator_callbacks_head, *around_terminator_callbacks_tail = around_terminator_callbacks
+              terminator = proc { super(output, *inputs, **options) }
+
+              terminated =
+                around_terminator_callbacks_head
+                .call(
+                  output,
+                  *inputs,
+                  **options,
+                  _node_: self
+                ) { terminator.call }
+
+              around_terminator_callbacks_tail.reduce(terminated) do |terminated, callable|
+                callable.call(
+                  output,
+                  *inputs,
+                  **options,
+                  _node_: self
+                ) { terminated }
+              end
+            end
+
+          after_terminator_callbacks.reduce(terminated) do |terminated, callable|
+            callable.call(terminated, **options, _node_: self)
+          end
+        end
+
+        def before_terminator_callbacks
+          @before_terminator_callbacks ||= []
+        end
+
+        def around_terminator_callbacks
+          @around_terminator_callbacks ||= []
+        end
+
+        def after_terminator_callbacks
+          @after_terminator_callbacks ||= []
+        end
+
+        private
+
+        attr_writer :before_terminator_callbacks, :around_terminator_callbacks, :after_terminator_callbacks
+
+        def initialize_copy(_node)
+          super
+          self.before_terminator_callbacks = before_terminator_callbacks.map(&:itself)
+          self.around_terminator_callbacks = around_terminator_callbacks.map(&:itself)
+          self.after_terminator_callbacks = after_terminator_callbacks.map(&:itself)
+        end
+      end
+    end
+  end
+end

data/lib/callable_tree/node/root.rb

@@ -6,6 +6,7 @@ module CallableTree
       include Internal
       prepend Hooks::Matcher
       prepend Hooks::Caller
+      prepend Hooks::Terminator
 
       def self.inherited(subclass)
         raise ::CallableTree::Error, "#{subclass} cannot inherit #{self}"

data/lib/callable_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CallableTree
-  VERSION = '0.3.7'
+  VERSION = '0.3.8'
 end

data/lib/callable_tree.rb

@@ -9,6 +9,7 @@ require_relative 'callable_tree/version'
 require_relative 'callable_tree/node'
 require_relative 'callable_tree/node/hooks/matcher'
 require_relative 'callable_tree/node/hooks/caller'
+require_relative 'callable_tree/node/hooks/terminator'
 require_relative 'callable_tree/node/internal/strategy'
 require_relative 'callable_tree/node/internal/strategy/broadcast'
 require_relative 'callable_tree/node/internal/strategy/seek'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callable_tree
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - jsmmr
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-09 00:00:00.000000000 Z
+date: 2022-05-05 00:00:00.000000000 Z
 dependencies: []
 description: Builds a tree by linking callable nodes. The nodes that match the conditions
   are called in a chain from the root node to the leaf node. These are like nested
@@ -23,6 +23,7 @@ files:
 - ".github/workflows/codeql-analysis.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
@@ -33,22 +34,22 @@ files:
 - bin/console
 - bin/setup
 - callable_tree.gemspec
-- examples/builder/hooks-caller.rb
+- examples/builder/hooks.rb
 - examples/builder/internal-broadcastable.rb
 - examples/builder/internal-composable.rb
 - examples/builder/internal-seekable.rb
 - examples/builder/logging.rb
+- examples/class/external-verbosify.rb
+- examples/class/hooks.rb
+- examples/class/identity.rb
+- examples/class/internal-broadcastable.rb
+- examples/class/internal-composable.rb
+- examples/class/internal-seekable.rb
+- examples/class/logging.rb
 - examples/docs/animals.json
 - examples/docs/animals.xml
 - examples/docs/fruits.json
 - examples/docs/fruits.xml
-- examples/external-verbosify.rb
-- examples/hooks-caller.rb
-- examples/identity.rb
-- examples/internal-broadcastable.rb
-- examples/internal-composable.rb
-- examples/internal-seekable.rb
-- examples/logging.rb
 - lib/callable_tree.rb
 - lib/callable_tree/node.rb
 - lib/callable_tree/node/builder.rb
@@ -57,6 +58,7 @@ files:
 - lib/callable_tree/node/external/verbose.rb
 - lib/callable_tree/node/hooks/caller.rb
 - lib/callable_tree/node/hooks/matcher.rb
+- lib/callable_tree/node/hooks/terminator.rb
 - lib/callable_tree/node/internal.rb
 - lib/callable_tree/node/internal/builder.rb
 - lib/callable_tree/node/internal/strategy.rb
@@ -71,7 +73,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/jsmmr/ruby_callable_tree
   source_code_uri: https://github.com/jsmmr/ruby_callable_tree
-  changelog_uri: https://github.com/jsmmr/ruby_callable_tree/blob/v0.3.7/CHANGELOG.md
+  changelog_uri: https://github.com/jsmmr/ruby_callable_tree/blob/v0.3.8/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/examples/builder/hooks-caller.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'callable_tree'
-
-Root =
-  CallableTree::Node::Internal::Builder
-  .new
-  .hookable
-  .build
-
-Root
-  .new
-  .before_caller do |input, **_options|
-    puts "before_caller input: #{input}"
-    input + 1
-  end
-  .append(
-    # anonymous external node
-    lambda do |input, **_options|
-      puts "external input: #{input}"
-      input * 2
-    end
-  )
-  .around_caller do |input, **_options, &block|
-    puts "around_caller input: #{input}"
-    output = block.call
-    puts "around_caller output: #{output}"
-    output * input
-  end
-  .after_caller do |output, **_options|
-    puts "after_caller output: #{output}"
-    output * 2
-  end
-  .tap do |tree|
-    options = { foo: :bar }
-    output = tree.call(1, **options)
-    puts "result: #{output}"
-  end