callable_tree 0.3.7 → 0.3.9

data/callable_tree.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/examples/builder/external-verbosify.rb

@@ -0,0 +1,87 @@
+# 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 }
+  .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 }
+  .build
+
+def build_json_scraper(type)
+  CallableTree::Node::External::Builder
+    .new
+    .matcher do |input, **_options|
+      !input[type.to_s].nil?
+    end
+    .caller do |input, **_options|
+      input[type.to_s]
+        .to_h { |element| [element['name'], element['emoji']] }
+    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
+        .to_h { |element| [element['name'], element['emoji']] }
+    end
+    .build
+end
+
+AnimalsXMLScraper = build_xml_scraper(:animals)
+FruitsXMLScraper = build_xml_scraper(:fruits)
+
+tree = CallableTree::Node::Root.new.seekable.append(
+  JSONParser.new.seekable.append(
+    AnimalsJSONScraper.new.verbosify,
+    FruitsJSONScraper.new.verbosify
+  ),
+  XMLParser.new.seekable.append(
+    AnimalsXMLScraper.new.verbosify,
+    FruitsXMLScraper.new.verbosify
+  )
+)
+
+Dir.glob("#{__dir__}/../docs/*") do |file|
+  options = { foo: :bar }
+  pp tree.call(file, **options)
+  puts '---'
+end

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/identity.rb

@@ -0,0 +1,91 @@
+# 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_:| _node_.object_id }
+  .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_:| _node_.object_id }
+  .build
+
+def build_json_scraper(type)
+  CallableTree::Node::External::Builder
+    .new
+    .matcher do |input, **_options|
+      !input[type.to_s].nil?
+    end
+    .caller do |input, **_options|
+      input[type.to_s]
+        .to_h { |element| [element['name'], element['emoji']] }
+    end
+    .identifier { |_node_:| _node_.object_id }
+    .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
+        .to_h { |element| [element['name'], element['emoji']] }
+    end
+    .identifier { |_node_:| _node_.object_id }
+    .build
+end
+
+AnimalsXMLScraper = build_xml_scraper(:animals)
+FruitsXMLScraper = build_xml_scraper(:fruits)
+
+tree = CallableTree::Node::Root.new.seekable.append(
+  JSONParser.new.seekable.append(
+    AnimalsJSONScraper.new.verbosify,
+    FruitsJSONScraper.new.verbosify
+  ),
+  XMLParser.new.seekable.append(
+    AnimalsXMLScraper.new.verbosify,
+    FruitsXMLScraper.new.verbosify
+  )
+)
+
+Dir.glob("#{__dir__}/../docs/*") do |file|
+  options = { foo: :bar }
+  pp tree.call(file, **options)
+  puts '---'
+end

data/examples/builder/internal-broadcastable.rb

@@ -2,57 +2,57 @@
 
 require 'callable_tree'
 
-less_than = proc do |num|
+def less_than(num)
   # The following block call is equivalent to calling `super` in the class style.
-  proc { |input, &block| block.call(input) && input < num }
+  proc { |input, &original| original.call(input) && input < num }
 end
 
 LessThan5 =
   CallableTree::Node::Internal::Builder
   .new
-  .matcher(&less_than.call(5))
+  .matcher(&method(:less_than).call(5))
   .build
 
 LessThan10 =
   CallableTree::Node::Internal::Builder
   .new
-  .matcher(&less_than.call(10))
+  .matcher(&method(:less_than).call(10))
   .build
 
-add = proc do |num|
+def add(num)
   proc { |input| input + num }
 end
 
 Add1 =
   CallableTree::Node::External::Builder
   .new
-  .caller(&add.call(1))
+  .caller(&method(:add).call(1))
   .build
 
-subtract = proc do |num|
+def subtract(num)
   proc { |input| input - num }
 end
 
 Subtract1 =
   CallableTree::Node::External::Builder
   .new
-  .caller(&subtract.call(1))
+  .caller(&method(:subtract).call(1))
   .build
 
-multiply = proc do |num|
+def multiply(num)
   proc { |input| input * num }
 end
 
 Multiply2 =
   CallableTree::Node::External::Builder
   .new
-  .caller(&multiply.call(2))
+  .caller(&method(:multiply).call(2))
   .build
 
 Multiply3 =
   CallableTree::Node::External::Builder
   .new
-  .caller(&multiply.call(3))
+  .caller(&method(:multiply).call(3))
   .build
 
 tree = CallableTree::Node::Root.new.broadcastable.append(

data/examples/builder/internal-composable.rb

@@ -2,57 +2,57 @@
 
 require 'callable_tree'
 
-less_than = proc do |num|
+def less_than(num)
   # The following block call is equivalent to calling `super` in the class style.
-  proc { |input, &block| block.call(input) && input < num }
+  proc { |input, &original| original.call(input) && input < num }
 end
 
 LessThan5 =
   CallableTree::Node::Internal::Builder
   .new
-  .matcher(&less_than.call(5))
+  .matcher(&method(:less_than).call(5))
   .build
 
 LessThan10 =
   CallableTree::Node::Internal::Builder
   .new
-  .matcher(&less_than.call(10))
+  .matcher(&method(:less_than).call(10))
   .build
 
-add = proc do |num|
+def add(num)
   proc { |input| input + num }
 end
 
 Add1 =
   CallableTree::Node::External::Builder
   .new
-  .caller(&add.call(1))
+  .caller(&method(:add).call(1))
   .build
 
-subtract = proc do |num|
+def subtract(num)
   proc { |input| input - num }
 end
 
 Subtract1 =
   CallableTree::Node::External::Builder
   .new
-  .caller(&subtract.call(1))
+  .caller(&method(:subtract).call(1))
   .build
 
-multiply = proc do |num|
+def multiply(num)
   proc { |input| input * num }
 end
 
 Multiply2 =
   CallableTree::Node::External::Builder
   .new
-  .caller(&multiply.call(2))
+  .caller(&method(:multiply).call(2))
   .build
 
 Multiply3 =
   CallableTree::Node::External::Builder
   .new
-  .caller(&multiply.call(3))
+  .caller(&method(:multiply).call(3))
   .build
 
 tree = CallableTree::Node::Root.new.composable.append(

data/examples/builder/internal-seekable.rb

@@ -10,16 +10,14 @@ JSONParser =
   .matcher do |input, **_options|
     File.extname(input) == '.json'
   end
-  .caller do |input, **options, &block|
+  .caller do |input, **options, &original|
     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)
+      original.call(json, **options)
     end
   end
-  .terminator do
-    true
-  end
+  .terminator { true }
   .build
 
 XMLParser =
@@ -28,27 +26,24 @@ XMLParser =
   .matcher do |input, **_options|
     File.extname(input) == '.xml'
   end
-  .caller do |input, **options, &block|
+  .caller do |input, **options, &original|
     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)
+      original.call(REXML::Document.new(file), **options)
     end
   end
-  .terminator do
-    true
-  end
+  .terminator { true }
   .build
 
 def build_json_scraper(type)
   CallableTree::Node::External::Builder
     .new
     .matcher do |input, **_options|
-      !!input[type.to_s]
+      !input[type.to_s].nil?
     end
     .caller do |input, **_options|
       input[type.to_s]
-        .map { |element| [element['name'], element['emoji']] }
-        .to_h
+        .to_h { |element| [element['name'], element['emoji']] }
     end
     .build
 end
@@ -66,8 +61,7 @@ def build_xml_scraper(type)
       input
         .get_elements("//#{type}")
         .first
-        .map { |element| [element['name'], element['emoji']] }
-        .to_h
+        .to_h { |element| [element['name'], element['emoji']] }
     end
     .build
 end

data/examples/builder/logging.rb

@@ -10,16 +10,14 @@ JSONParser =
   .matcher do |input, **_options|
     File.extname(input) == '.json'
   end
-  .caller do |input, **options, &block|
+  .caller do |input, **options, &original|
     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)
+      original.call(json, **options)
     end
   end
-  .terminator do
-    true
-  end
+  .terminator { true }
   .hookable
   .build
 
@@ -29,15 +27,13 @@ XMLParser =
   .matcher do |input, **_options|
     File.extname(input) == '.xml'
   end
-  .caller do |input, **options, &block|
+  .caller do |input, **options, &original|
     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)
+      original.call(REXML::Document.new(file), **options)
     end
   end
-  .terminator do
-    true
-  end
+  .terminator { true }
   .hookable
   .build
 
@@ -45,12 +41,11 @@ def build_json_scraper(type)
   CallableTree::Node::External::Builder
     .new
     .matcher do |input, **_options|
-      !!input[type.to_s]
+      !input[type.to_s].nil?
     end
     .caller do |input, **_options|
       input[type.to_s]
-        .map { |element| [element['name'], element['emoji']] }
-        .to_h
+        .to_h { |element| [element['name'], element['emoji']] }
     end
     .hookable
     .build
@@ -69,8 +64,7 @@ def build_xml_scraper(type)
       input
         .get_elements("//#{type}")
         .first
-        .map { |element| [element['name'], element['emoji']] }
-        .to_h
+        .to_h { |element| [element['name'], element['emoji']] }
     end
     .hookable
     .build
@@ -79,35 +73,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}

@@ -38,8 +38,7 @@ module Node
 
       def call(input, **_options)
         input[@type.to_s]
-          .map { |element| [element['name'], element['emoji']] }
-          .to_h
+          .to_h { |element| [element['name'], element['emoji']] }
       end
     end
   end
@@ -78,8 +77,7 @@ module Node
         input
           .get_elements("//#{@type}")
           .first
-          .map { |element| [element['name'], element['emoji']] }
-          .to_h
+          .to_h { |element| [element['name'], element['emoji']] }
       end
     end
   end
@@ -96,7 +94,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