callable_tree 0.3.5 → 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/internal-seekable.rb

@@ -4,89 +4,85 @@ require 'callable_tree'
 require 'json'
 require 'rexml/document'
 
-module JSONParser
-  def self.build
-    CallableTree::Node::Internal::Builder
-      .new
-      .matcher do |input, **_options|
-        File.extname(input) == '.json'
-      end
-      .caller do |input, **options, &block|
-        File.open(input) do |file|
-          json = ::JSON.load(file)
-          # The following block call is equivalent to calling `super` in the class style.
-          block.call(json, **options)
-        end
-      end
-      .terminator do
-        true
-      end
-      .build
+JSONParser =
+  CallableTree::Node::Internal::Builder
+  .new
+  .matcher do |input, **_options|
+    File.extname(input) == '.json'
   end
-end
-
-module XMLParser
-  def self.build
-    CallableTree::Node::Internal::Builder
-      .new
-      .matcher do |input, **_options|
-        File.extname(input) == '.xml'
-      end
-      .caller do |input, **options, &block|
-        File.open(input) do |file|
-          # The following block call is equivalent to calling `super` in the class style.
-          block.call(REXML::Document.new(file), **options)
-        end
-      end
-      .terminator do
-        true
-      end
-      .build
+  .caller do |input, **options, &block|
+    File.open(input) do |file|
+      json = ::JSON.load(file)
+      # The following block call is equivalent to calling `super` in the class style.
+      block.call(json, **options)
+    end
   end
-end
+  .terminator do
+    true
+  end
+  .build
 
-module JSONScraper
-  def self.build(type)
-    CallableTree::Node::External::Builder
-      .new
-      .matcher do |input, **_options|
-        !!input[type.to_s]
-      end
-      .caller do |input, **_options|
-        input[type.to_s]
-          .map { |element| [element['name'], element['emoji']] }
-          .to_h
-      end
-      .build
+XMLParser =
+  CallableTree::Node::Internal::Builder
+  .new
+  .matcher do |input, **_options|
+    File.extname(input) == '.xml'
+  end
+  .caller do |input, **options, &block|
+    File.open(input) do |file|
+      # The following block call is equivalent to calling `super` in the class style.
+      block.call(REXML::Document.new(file), **options)
+    end
   end
+  .terminator do
+    true
+  end
+  .build
+
+def build_json_scraper(type)
+  CallableTree::Node::External::Builder
+    .new
+    .matcher do |input, **_options|
+      !!input[type.to_s]
+    end
+    .caller do |input, **_options|
+      input[type.to_s]
+        .map { |element| [element['name'], element['emoji']] }
+        .to_h
+    end
+    .build
 end
 
-module XMLScraper
-  def self.build(type)
-    CallableTree::Node::External::Builder
-      .new
-      .matcher do |input, **_options|
-        !input.get_elements("//#{type}").empty?
-      end
-      .caller do |input, **_options|
-        input
-          .get_elements("//#{type}")
-          .first
-          .map { |element| [element['name'], element['emoji']] }
-          .to_h
-      end
-      .build
-  end
+AnimalsJSONScraper = build_json_scraper(:animals)
+FruitsJSONScraper = build_json_scraper(:fruits)
+
+def build_xml_scraper(type)
+  CallableTree::Node::External::Builder
+    .new
+    .matcher do |input, **_options|
+      !input.get_elements("//#{type}").empty?
+    end
+    .caller do |input, **_options|
+      input
+        .get_elements("//#{type}")
+        .first
+        .map { |element| [element['name'], element['emoji']] }
+        .to_h
+    end
+    .build
 end
 
+AnimalsXMLScraper = build_xml_scraper(:animals)
+FruitsXMLScraper = build_xml_scraper(:fruits)
+
 tree = CallableTree::Node::Root.new.seekable.append(
-  JSONParser.build.new.seekable.append(
-    JSONScraper.build(:animals).new,
-    JSONScraper.build(:fruits).new
+  JSONParser.new.seekable.append(
+    AnimalsJSONScraper.new,
+    FruitsJSONScraper.new
   ),
-  XMLParser.build.new.seekable.append(
-    XMLScraper.build(:animals).new,
-    XMLScraper.build(:fruits).new
+  XMLParser.new.seekable.append(
+    AnimalsXMLScraper.new,
+    FruitsXMLScraper.new
   )
 )
 

data/examples/builder/logging.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'callable_tree'
+require 'json'
+require 'rexml/document'
+
+JSONParser =
+  CallableTree::Node::Internal::Builder
+  .new
+  .matcher do |input, **_options|
+    File.extname(input) == '.json'
+  end
+  .caller do |input, **options, &block|
+    File.open(input) do |file|
+      json = ::JSON.load(file)
+      # The following block call is equivalent to calling `super` in the class style.
+      block.call(json, **options)
+    end
+  end
+  .terminator { true }
+  # .identifier { |_node_:| :as_you_like } # optional
+  .hookable
+  .build
+
+XMLParser =
+  CallableTree::Node::Internal::Builder
+  .new
+  .matcher do |input, **_options|
+    File.extname(input) == '.xml'
+  end
+  .caller do |input, **options, &block|
+    File.open(input) do |file|
+      # The following block call is equivalent to calling `super` in the class style.
+      block.call(REXML::Document.new(file), **options)
+    end
+  end
+  .terminator { true }
+  # .identifier { |_node_:| :as_you_like } # optional
+  .hookable
+  .build
+
+def build_json_scraper(type)
+  CallableTree::Node::External::Builder
+    .new
+    .matcher do |input, **_options|
+      !!input[type.to_s]
+    end
+    .caller do |input, **_options|
+      input[type.to_s]
+        .map { |element| [element['name'], element['emoji']] }
+        .to_h
+    end
+    # .identifier { |_node_:| :as_you_like } # optional
+    .hookable
+    .build
+end
+
+AnimalsJSONScraper = build_json_scraper(:animals)
+FruitsJSONScraper = build_json_scraper(:fruits)
+
+def build_xml_scraper(type)
+  CallableTree::Node::External::Builder
+    .new
+    .matcher do |input, **_options|
+      !input.get_elements("//#{type}").empty?
+    end
+    .caller do |input, **_options|
+      input
+        .get_elements("//#{type}")
+        .first
+        .map { |element| [element['name'], element['emoji']] }
+        .to_h
+    end
+    # .identifier { |_node_:| :as_you_like } # optional
+    .hookable
+    .build
+end
+
+AnimalsXMLScraper = build_xml_scraper(:animals)
+FruitsXMLScraper = build_xml_scraper(:fruits)
+
+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.seekable.append(
+  JSONParser.new.tap(&loggable).seekable.append(
+    AnimalsJSONScraper.new.tap(&loggable).verbosify,
+    FruitsJSONScraper.new.tap(&loggable).verbosify
+  ),
+  XMLParser.new.tap(&loggable).seekable.append(
+    AnimalsXMLScraper.new.tap(&loggable).verbosify,
+    FruitsXMLScraper.new.tap(&loggable).verbosify
+  )
+)
+
+Dir.glob("#{__dir__}/../docs/*") do |file|
+  options = { foo: :bar }
+  pp tree.call(file, **options)
+  puts '---'
+end

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(
@@ -44,11 +50,15 @@ module CallableTree
         ::Class
           .new do
             include node_type
-            prepend Hooks::Call if hookable
+            if hookable
+              prepend Hooks::Matcher
+              prepend Hooks::Caller
+              prepend Hooks::Terminator
+            end
 
             if matcher
               define_method(:match?) do |*inputs, **options|
-                matcher.call(*inputs, **options) do |*inputs, **options|
+                matcher.call(*inputs, **options, _node_: self) do |*inputs, **options|
                   super(*inputs, **options)
                 end
               end
@@ -56,7 +66,7 @@ module CallableTree
 
             if caller
               define_method(:call) do |*inputs, **options|
-                caller.call(*inputs, **options) do |*inputs, **options|
+                caller.call(*inputs, **options, _node_: self) do |*inputs, **options|
                   super(*inputs, **options)
                 end
               end
@@ -64,11 +74,17 @@ module CallableTree
 
             if terminator
               define_method(:terminate?) do |output, *inputs, **options|
-                terminator.call(output, *inputs, **options) do |output, *inputs, **options|
+                terminator.call(output, *inputs, **options, _node_: self) do |output, *inputs, **options|
                   super(output, *inputs, **options)
                 end
               end
             end
+
+            if identifier
+              define_method(:identity) do
+                identifier.call(_node_: self) { super() }
+              end
+            end
           end
       end
 

data/lib/callable_tree/node/external/builder.rb

@@ -15,7 +15,7 @@ module CallableTree
         private
 
         def validate(matcher:, caller:, terminator:)
-          raise Error 'caller is required' unless caller
+          raise Error, 'caller is required' unless caller
         end
       end
     end

data/lib/callable_tree/node/external/verbose.rb

@@ -3,7 +3,6 @@
 module CallableTree
   module Node
     module External
-      # TODO: Add :inputs
       Output = Struct.new(:value, :options, :routes)
 
       module Verbose
@@ -13,6 +12,7 @@ module CallableTree
 
         def call(*inputs, **options)
           output = super(*inputs, **options)
+          options.delete(:_node_)
           routes = self.routes
 
           Output.new(output, options, routes)