callable_tree 0.3.3 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3feea9db6a3844729a1644e56d60cc0cf8961e95e5ae5d58fcf4eb10eab6c80d
-  data.tar.gz: 6de275fcb284556be10c22cea0e310adecadebab11bd5b884b736b809543120c
+  metadata.gz: 2a83d353d4049c06aa0a0d5f18f56c5c6d0d909cd4a54f6bbcba7faf4e835c0f
+  data.tar.gz: ab803f4e8b613a0ceb5e4d3ca21d38e1a5cf2a238db61384c0ec85b437fd7d73
 SHA512:
-  metadata.gz: 14883eaed6a4655f62908ae53dabadd007e56befb50cb8d5b02790d91441afe3749ecf00019709a5ba39b8bfaafeaa8e475a318e62d1a93f21511ef3611d4238
-  data.tar.gz: b58152e34c1e7b7c3f9941715d7f512f71d40b1abbacbb7481e965ceb34969117c56b4a9ee218ed62f087dedc7d85ffdde1d9f43ab6beb25aa6da8b89b9dfde1
+  metadata.gz: 27dd59b36d4ebc99395df901a900d72510928f5f4a9603405b83f54d0566652fda2253bcda7bf6efee1ad0363919c5ec7bb63a1ec1e0efc488e656d6ff1bce3a
+  data.tar.gz: 3029f92901053688715cffce367d0e44f01402743413dfd38dc52c6c63221094fe2d3774cf2b1b98d66b84dd6837c8d6e6430c228ce3f196e60f9222286a3a56

data/.github/workflows/build.yml

@@ -11,7 +11,7 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - run: gem install bundler:2.3.3
+      - run: gem install bundler:2.3.7
       - uses: actions/cache@v2
         with:
           path: vendor/bundle

data/.ruby-version

@@ -1 +1 @@
-3.1.0
+3.1.1

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 ## [Unreleased]
 
+## [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
+
+- (Experimental) Add `CallableTree::Node::Internal::Builder`.
+  See `examples/builder/*.rb` for details.
+- (Experimental) Add `CallableTree::Node::External::Builder`.
+  See `examples/builder/*.rb` for details.
+
 ## [0.3.3] - 2022-02-19
 
 - Add `recursive` option to `CallableTree::Node::Internal#reject` and `CallableTree::Node::Internal#reject!`.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    callable_tree (0.3.3)
+    callable_tree (0.3.6)
 
 GEM
   remote: https://rubygems.org/
@@ -23,8 +23,7 @@ GEM
     rspec-support (3.11.0)
 
 PLATFORMS
-  x86_64-darwin-19
-  x86_64-darwin-20
+  x86_64-darwin-21
 
 DEPENDENCIES
   callable_tree!
@@ -32,4 +31,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.3.3
+   2.3.7

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-caller.rb

@@ -0,0 +1,38 @@
+# 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

data/examples/builder/internal-broadcastable.rb

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

data/examples/builder/internal-composable.rb

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

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