callable_tree 0.3.4 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cdb3e4595a6233e401511b3a1cb371cacc3bcf6aa38aa78779928a532124103
-  data.tar.gz: abfb837062826d1c3ad644b127eac6b54241106b6feb29f4750add2104676750
+  metadata.gz: 0ebaae495d65a776fa0eea8c4aa5e23a1dca39245f05531b1d79bb7384c27228
+  data.tar.gz: af843950714bc7302b3fab17fc23a775e5f436f97923aad80783998794d110ab
 SHA512:
-  metadata.gz: a44400b690e3b04f9f1abef9eacc7ddd648121015c3d0e919cf4a0bfab8f4ffa30ffa55dc71b9eb8a4eb174be64ab83a46f1c71457107169f32271182998fceb
-  data.tar.gz: 52ece74206ae1cb94cd53e9920a8cdc29aa00874dee0f4a4c214dcf679d1d0d2374217585828eebf642374ca4676a503e819b4a16fbf5c26fa7004b81da971ff
+  metadata.gz: 5311c4a2ad2436815362a8349e278b73c8c568a4bf4721c990d7a5b5c8c74d876267dc5729c67f0e6e9a4c540e99cffa3d9ece8b9046acf057ca2f48e20a97ab
+  data.tar.gz: baa36b79d0ad3ba777fcad27c8b04c7ff1b1da7d665c1f74dbadf49e6d36828ed0fc3d0eaa1cc45c54107e24806a8ec66e4b719095e055260fec8a3ec16669c2

data/CHANGELOG.md

@@ -1,10 +1,35 @@
 ## [Unreleased]
 
+## [0.3.7] - 2022-04-09
+
+- Add `CallableTree::Node#internal?`
+- Add `CallableTree::Node#external?`
+- (Experimental) Change the callables (matcher, caller, terminator) specified in the builder style to receive the current node instance as the `_node_` keyword argument.
+
+## [0.3.6] - 2022-03-29
+
+- (Experimental) Add `CallableTree::Node::Hooks::Matcher`.
+  Using this together with `CallableTree::Node::Hooks::Caller` helps to output logs. See `examples/builder/logging.rb` for details.
+
+## [0.3.5] - 2022-03-20
+
+- Add `CallableTree::Node::Internal#seekable?` as an alias for `CallableTree::Node::Internal#seek?`.
+- Add `CallableTree::Node::Internal#seekable` as an alias for `CallableTree::Node::Internal#seek`.
+- Add `CallableTree::Node::Internal#seekable!` as an alias for `CallableTree::Node::Internal#seek!`.
+- Add `CallableTree::Node::Internal#broadcastable?` as an alias for `CallableTree::Node::Internal#broadcast?`.
+- Add `CallableTree::Node::Internal#broadcastable` as an alias for `CallableTree::Node::Internal#broadcast`.
+- Add `CallableTree::Node::Internal#broadcastable!` as an alias for `CallableTree::Node::Internal#broadcast!`.
+- Add `CallableTree::Node::Internal#composable?` as an alias for `CallableTree::Node::Internal#compose?`.
+- Add `CallableTree::Node::Internal#composable` as an alias for `CallableTree::Node::Internal#compose`.
+- Add `CallableTree::Node::Internal#composable!` as an alias for `CallableTree::Node::Internal#compose!`.
+- (Experimental) Add `CallableTree::Node::Internal::Builder#terminator` to use instead of `CallableTree::Node::Internal::Builder#terminater`.
+  See `examples/builder/*.rb` for details.
+
 ## [0.3.4] - 2022-03-13
 
-- Add `CallableTree::Node::Internal::Builder`. (experimental)
+- (Experimental) Add `CallableTree::Node::Internal::Builder`.
   See `examples/builder/*.rb` for details.
-- Add `CallableTree::Node::External::Builder`. (experimental)
+- (Experimental) Add `CallableTree::Node::External::Builder`.
   See `examples/builder/*.rb` for details.
 
 ## [0.3.3] - 2022-02-19

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    callable_tree (0.3.4)
+    callable_tree (0.3.7)
 
 GEM
   remote: https://rubygems.org/
@@ -17,7 +17,7 @@ GEM
     rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)

data/README.md

@@ -32,11 +32,11 @@ Builds a tree by linking instances of the nodes. The `call` method of the node w
 
 ### Basic
 
-#### `CallableTree::Node::Internal#seek` (default)
+#### `CallableTree::Node::Internal#seekable` (default)
 
 This strategy does not call the next sibling node if the `call` method of the current node returns a value other than `nil`. This behavior is changeable by overriding the `terminate?` method.
 
-`examples/internal-seek.rb`:
+`examples/internal-seekable.rb`:
 ```ruby
 module Node
   module JSON
@@ -129,17 +129,17 @@ module Node
   end
 end
 
-# The `seek` method call can be omitted since it is the default strategy.
-tree = CallableTree::Node::Root.new.append(
-  Node::JSON::Parser.new.append(
+# The `seekable` method call can be omitted since it is the default strategy.
+tree = CallableTree::Node::Root.new.seekable.append(
+  Node::JSON::Parser.new.seekable.append(
     Node::JSON::Scraper.new(type: :animals),
     Node::JSON::Scraper.new(type: :fruits)
-  ),#.seek,
-  Node::XML::Parser.new.append(
+  ),
+  Node::XML::Parser.new.seekable.append(
     Node::XML::Scraper.new(type: :animals),
     Node::XML::Scraper.new(type: :fruits)
-  )#.seek
-)#.seek
+  )
+)
 
 Dir.glob("#{__dir__}/docs/*") do |file|
   options = { foo: :bar }
@@ -148,9 +148,9 @@ Dir.glob("#{__dir__}/docs/*") do |file|
 end
 ```
 
-Run `examples/internal-seek.rb`:
+Run `examples/internal-seekable.rb`:
 ```sh
-% ruby examples/internal-seek.rb
+% ruby examples/internal-seekable.rb
 {"Dog"=>"🐶", "Cat"=>"🐱"}
 ---
 {"Dog"=>"🐶", "Cat"=>"🐱"}
@@ -161,11 +161,11 @@ Run `examples/internal-seek.rb`:
 ---
 ```
 
-#### `CallableTree::Node::Internal#broadcast`
+#### `CallableTree::Node::Internal#broadcastable`
 
 This strategy calls all child nodes of the internal node and ignores their `terminate?` methods, and then outputs their results as array.
 
-`examples/internal-broadcast.rb`:
+`examples/internal-broadcastable.rb`:
 ```ruby
 module Node
   class LessThan
@@ -181,16 +181,16 @@ module Node
   end
 end
 
-tree = CallableTree::Node::Root.new.append(
-  Node::LessThan.new(5).append(
+tree = CallableTree::Node::Root.new.broadcastable.append(
+  Node::LessThan.new(5).broadcastable.append(
     ->(input) { input * 2 }, # anonymous external node
     ->(input) { input + 1 }  # anonymous external node
-  ).broadcast,
-  Node::LessThan.new(10).append(
+  ),
+  Node::LessThan.new(10).broadcastable.append(
     ->(input) { input * 3 }, # anonymous external node
     ->(input) { input - 1 }  # anonymous external node
-  ).broadcast
-).broadcast
+  )
+)
 
 (0..10).each do |input|
   output = tree.call(input)
@@ -199,9 +199,9 @@ end
 
 ```
 
-Run `examples/internal-broadcast.rb`:
+Run `examples/internal-broadcastable.rb`:
 ```sh
-% ruby examples/internal-broadcast.rb
+% ruby examples/internal-broadcastable.rb
 0 -> [[0, 1], [0, -1]]
 1 -> [[2, 2], [3, 0]]
 2 -> [[4, 3], [6, 1]]
@@ -215,11 +215,11 @@ Run `examples/internal-broadcast.rb`:
 10 -> [nil, nil]
 ```
 
-#### `CallableTree::Node::Internal#compose`
+#### `CallableTree::Node::Internal#composable`
 
 This strategy calls all child nodes of the internal node in order to input the output of the previous node to the next node and ignores their `terminate?` methods, and then outputs a single result.
 
-`examples/internal-compose.rb`:
+`examples/internal-composable.rb`:
 ```ruby
 module Node
   class LessThan
@@ -235,16 +235,16 @@ module Node
   end
 end
 
-tree = CallableTree::Node::Root.new.append(
-  Node::LessThan.new(5).append(
+tree = CallableTree::Node::Root.new.composable.append(
+  Node::LessThan.new(5).composable.append(
     proc { |input| input * 2 }, # anonymous external node
     proc { |input| input + 1 }  # anonymous external node
-  ).compose,
-  Node::LessThan.new(10).append(
+  ),
+  Node::LessThan.new(10).composable.append(
     proc { |input| input * 3 }, # anonymous external node
     proc { |input| input - 1 }  # anonymous external node
-  ).compose
-).compose
+  )
+)
 
 (0..10).each do |input|
   output = tree.call(input)
@@ -253,9 +253,9 @@ end
 
 ```
 
-Run `examples/internal-compose.rb`:
+Run `examples/internal-composable.rb`:
 ```sh
-% ruby examples/internal-compose.rb
+% ruby examples/internal-composable.rb
 0 -> 2
 1 -> 8
 2 -> 14
@@ -568,20 +568,20 @@ Run `examples/logging.rb`:
 ---
 ```
 
-#### `CallableTree::Node::Hooks::Call` (experimental)
+#### `CallableTree::Node::Hooks::Caller` (experimental)
 
 `examples/hooks-call.rb`:
 ```ruby
 module Node
   class HooksSample
     include CallableTree::Node::Internal
-    prepend CallableTree::Node::Hooks::Call
+    prepend CallableTree::Node::Hooks::Caller
   end
 end
 
 Node::HooksSample.new
-  .before_call do |input, **_options|
-    puts "before_call input: #{input}";
+  .before_caller do |input, **_options|
+    puts "before_caller input: #{input}";
     input + 1
   end
   .append(
@@ -591,14 +591,14 @@ Node::HooksSample.new
       input * 2
     end
   )
-  .around_call do |input, **_options, &block|
-    puts "around_call input: #{input}"
+  .around_caller do |input, **_options, &block|
+    puts "around_caller input: #{input}"
     output = block.call
-    puts "around_call output: #{output}"
+    puts "around_caller output: #{output}"
     output * input
   end
-  .after_call do |output, **_options|
-    puts "after_call output: #{output}"
+  .after_caller do |output, **_options|
+    puts "after_caller output: #{output}"
     output * 2
   end
   .tap do |tree|
@@ -608,20 +608,20 @@ Node::HooksSample.new
   end
 ```
 
-Run `examples/hooks-call.rb`:
+Run `examples/hooks-caller.rb`:
 ```sh
-% ruby examples/hooks-call.rb
-before_call input: 1
+% ruby examples/hooks-caller.rb
+before_caller input: 1
 external input: 2
-around_call input: 2
-around_call output: 4
-after_call output: 8
+around_caller input: 2
+around_caller output: 4
+after_caller output: 8
 result: 16
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jsmmr/callable_tree.
+Bug reports and pull requests are welcome on GitHub at https://github.com/jsmmr/ruby_callable_tree.
 
 ## License
 

data/examples/builder/{hooks-call.rb → hooks-caller.rb}

@@ -10,8 +10,8 @@ Root =
 
 Root
   .new
-  .before_call do |input, **_options|
-    puts "before_call input: #{input}"
+  .before_caller do |input, **_options|
+    puts "before_caller input: #{input}"
     input + 1
   end
   .append(
@@ -21,14 +21,14 @@ Root
       input * 2
     end
   )
-  .around_call do |input, **_options, &block|
-    puts "around_call input: #{input}"
+  .around_caller do |input, **_options, &block|
+    puts "around_caller input: #{input}"
     output = block.call
-    puts "around_call output: #{output}"
+    puts "around_caller output: #{output}"
     output * input
   end
-  .after_call do |output, **_options|
-    puts "after_call output: #{output}"
+  .after_caller do |output, **_options|
+    puts "after_caller output: #{output}"
     output * 2
   end
   .tap do |tree|

data/examples/builder/{internal-compose.rb → internal-broadcastable.rb}

@@ -55,12 +55,12 @@ Multiply3 =
   .caller(&multiply.call(3))
   .build
 
-tree = CallableTree::Node::Root.new.compose.append(
-  LessThan5.new.compose.append(
+tree = CallableTree::Node::Root.new.broadcastable.append(
+  LessThan5.new.broadcastable.append(
     Multiply2.new,
     Add1.new
   ),
-  LessThan10.new.compose.append(
+  LessThan10.new.broadcastable.append(
     Multiply3.new,
     Subtract1.new
   )

data/examples/builder/{internal-broadcast.rb → internal-composable.rb}

@@ -55,12 +55,12 @@ Multiply3 =
   .caller(&multiply.call(3))
   .build
 
-tree = CallableTree::Node::Root.new.broadcast.append(
-  LessThan5.new.broadcast.append(
+tree = CallableTree::Node::Root.new.composable.append(
+  LessThan5.new.composable.append(
     Multiply2.new,
     Add1.new
   ),
-  LessThan10.new.broadcast.append(
+  LessThan10.new.composable.append(
     Multiply3.new,
     Subtract1.new
   )

data/examples/builder/internal-seekable.rb

@@ -0,0 +1,93 @@
+# 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 do
+    true
+  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
+
+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.new.seekable.append(
+    AnimalsJSONScraper.new,
+    FruitsJSONScraper.new
+  ),
+  XMLParser.new.seekable.append(
+    AnimalsXMLScraper.new,
+    FruitsXMLScraper.new
+  )
+)
+
+Dir.glob("#{__dir__}/../docs/*") do |file|
+  options = { foo: :bar }
+  pp tree.call(file, **options)
+  puts '---'
+end

data/examples/builder/logging.rb

@@ -0,0 +1,126 @@
+# 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 do
+    true
+  end
+  .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 do
+    true
+  end
+  .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
+    .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
+    .hookable
+    .build
+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
+
+  if node.external?
+    input_label  = 'Input :'
+    output_label = 'Output:'
+
+    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
+
+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/{hooks-call.rb → hooks-caller.rb}

@@ -5,14 +5,14 @@ require 'callable_tree'
 module Node
   class HooksSample
     include CallableTree::Node::Internal
-    prepend CallableTree::Node::Hooks::Call
+    prepend CallableTree::Node::Hooks::Caller
   end
 end
 
 Node::HooksSample
   .new
-  .before_call do |input, **_options|
-    puts "before_call input: #{input}"
+  .before_caller do |input, **_options|
+    puts "before_caller input: #{input}"
     input + 1
   end
   .append(
@@ -22,14 +22,14 @@ Node::HooksSample
       input * 2
     end
   )
-  .around_call do |input, **_options, &block|
-    puts "around_call input: #{input}"
+  .around_caller do |input, **_options, &block|
+    puts "around_caller input: #{input}"
     output = block.call
-    puts "around_call output: #{output}"
+    puts "around_caller output: #{output}"
     output * input
   end
-  .after_call do |output, **_options|
-    puts "after_call output: #{output}"
+  .after_caller do |output, **_options|
+    puts "after_caller output: #{output}"
     output * 2
   end
   .tap do |tree|

data/examples/{internal-broadcast.rb → internal-broadcastable.rb}

@@ -16,16 +16,16 @@ module Node
   end
 end
 
-tree = CallableTree::Node::Root.new.append(
-  Node::LessThan.new(5).append(
+tree = CallableTree::Node::Root.new.broadcastable.append(
+  Node::LessThan.new(5).broadcastable.append(
     ->(input) { input * 2 }, # anonymous external node
     ->(input) { input + 1 }  # anonymous external node
-  ).broadcast,
-  Node::LessThan.new(10).append(
+  ),
+  Node::LessThan.new(10).broadcastable.append(
     ->(input) { input * 3 }, # anonymous external node
     ->(input) { input - 1 }  # anonymous external node
-  ).broadcast
-).broadcast
+  )
+)
 
 (0..10).each do |input|
   output = tree.call(input)

data/examples/{internal-compose.rb → internal-composable.rb}

@@ -16,16 +16,16 @@ module Node
   end
 end
 
-tree = CallableTree::Node::Root.new.append(
-  Node::LessThan.new(5).append(
+tree = CallableTree::Node::Root.new.composable.append(
+  Node::LessThan.new(5).composable.append(
     proc { |input| input * 2 }, # anonymous external node
     proc { |input| input + 1 }  # anonymous external node
-  ).compose,
-  Node::LessThan.new(10).append(
+  ),
+  Node::LessThan.new(10).composable.append(
     proc { |input| input * 3 }, # anonymous external node
     proc { |input| input - 1 }  # anonymous external node
-  ).compose
-).compose
+  )
+)
 
 (0..10).each do |input|
   output = tree.call(input)

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

@@ -85,12 +85,12 @@ module Node
   end
 end
 
-tree = CallableTree::Node::Root.new.append(
-  Node::JSON::Parser.new.append(
+tree = CallableTree::Node::Root.new.seekable.append(
+  Node::JSON::Parser.new.seekable.append(
     Node::JSON::Scraper.new(type: :animals),
     Node::JSON::Scraper.new(type: :fruits)
   ),
-  Node::XML::Parser.new.append(
+  Node::XML::Parser.new.seekable.append(
     Node::XML::Scraper.new(type: :animals),
     Node::XML::Scraper.new(type: :fruits)
   )