callable_tree 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cdb3e4595a6233e401511b3a1cb371cacc3bcf6aa38aa78779928a532124103
-  data.tar.gz: abfb837062826d1c3ad644b127eac6b54241106b6feb29f4750add2104676750
+  metadata.gz: 83716fbdef2881db33e8f046f056a17d8a8866423951493902088bf1af53218f
+  data.tar.gz: 8906217b71482e1717798329d172640a50f7cc73613a2187beba0702bf8b8d74
 SHA512:
-  metadata.gz: a44400b690e3b04f9f1abef9eacc7ddd648121015c3d0e919cf4a0bfab8f4ffa30ffa55dc71b9eb8a4eb174be64ab83a46f1c71457107169f32271182998fceb
-  data.tar.gz: 52ece74206ae1cb94cd53e9920a8cdc29aa00874dee0f4a4c214dcf679d1d0d2374217585828eebf642374ca4676a503e819b4a16fbf5c26fa7004b81da971ff
+  metadata.gz: 5e5ece858eb3347c41ea5f573e37c972d1a127d9fa234cd2512b18ef9e882b33d0da900b46c8f8e539fcee36fccb6643d21bb0945169019e7734232907c412c1
+  data.tar.gz: ce58af4b926c9201f4133f02da848dcfff7962f9fa08588c1d4b4b61765b9c5ffaf03f2cfb4367da7d14a80bc1dcd55ea4b53de39d4075be25ef6e2abaf9ae7e

data/CHANGELOG.md

@@ -1,10 +1,24 @@
 ## [Unreleased]
 
+## [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.5)
 
 GEM
   remote: https://rubygems.org/

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
@@ -621,7 +621,7 @@ 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/{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-seek.rb → internal-seekable.rb}

@@ -18,7 +18,7 @@ module JSONParser
           block.call(json, **options)
         end
       end
-      .terminater do
+      .terminator do
         true
       end
       .build
@@ -38,7 +38,7 @@ module XMLParser
           block.call(REXML::Document.new(file), **options)
         end
       end
-      .terminater do
+      .terminator do
         true
       end
       .build
@@ -79,12 +79,12 @@ module XMLScraper
   end
 end
 
-tree = CallableTree::Node::Root.new.append(
-  JSONParser.build.new.append(
+tree = CallableTree::Node::Root.new.seekable.append(
+  JSONParser.build.new.seekable.append(
     JSONScraper.build(:animals).new,
     JSONScraper.build(:fruits).new
   ),
-  XMLParser.build.new.append(
+  XMLParser.build.new.seekable.append(
     XMLScraper.build(:animals).new,
     XMLScraper.build(:fruits).new
   )

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)
   )

data/lib/callable_tree/node/builder.rb

@@ -14,7 +14,13 @@ module CallableTree
       end
 
       def terminater(&block)
-        @terminater = block
+        warn 'Use CallableTree::Node::Internal::Builder#terminator instead.'
+        @terminator = block
+        self
+      end
+
+      def terminator(&block)
+        @terminator = block
         self
       end
 
@@ -26,13 +32,13 @@ module CallableTree
       def build(node_type:)
         matcher = @matcher
         caller = @caller
-        terminater = @terminater
+        terminator = @terminator
         hookable = @hookable
 
         validate(
           matcher: matcher,
           caller: caller,
-          terminater: terminater
+          terminator: terminator
         )
 
         ::Class
@@ -56,9 +62,9 @@ module CallableTree
               end
             end
 
-            if terminater
+            if terminator
               define_method(:terminate?) do |output, *inputs, **options|
-                terminater.call(output, *inputs, **options) do |output, *inputs, **options|
+                terminator.call(output, *inputs, **options) do |output, *inputs, **options|
                   super(output, *inputs, **options)
                 end
               end
@@ -68,7 +74,7 @@ module CallableTree
 
       private
 
-      def validate(matcher:, caller:, terminater:)
+      def validate(matcher:, caller:, terminator:)
         raise ::CallableTree::Error, 'Not implemented'
       end
     end

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

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

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

@@ -12,7 +12,7 @@ module CallableTree
 
         private
 
-        def validate(matcher:, caller:, terminater:)
+        def validate(matcher:, caller:, terminator:)
           # noop
         end
       end

data/lib/callable_tree/node/internal.rb

@@ -98,6 +98,10 @@ module CallableTree
         end
       end
 
+      alias_method :seekable?, :seek?
+      alias_method :seekable, :seek
+      alias_method :seekable!, :seek!
+
       def broadcast?
         strategy.is_a?(Strategy::Broadcast)
       end
@@ -118,6 +122,10 @@ module CallableTree
         end
       end
 
+      alias_method :broadcastable?, :broadcast?
+      alias_method :broadcastable, :broadcast
+      alias_method :broadcastable!, :broadcast!
+
       def compose?
         strategy.is_a?(Strategy::Compose)
       end
@@ -138,6 +146,10 @@ module CallableTree
         end
       end
 
+      alias_method :composable?, :compose?
+      alias_method :composable, :compose
+      alias_method :composable!, :compose!
+
       def outline(&block)
         key = block ? block.call(self) : identity
         value = child_nodes.reduce({}) { |memo, node| memo.merge!(node.outline(&block)) }

data/lib/callable_tree/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callable_tree
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - jsmmr
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2022-03-20 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
@@ -34,9 +34,9 @@ files:
 - bin/setup
 - callable_tree.gemspec
 - examples/builder/hooks-call.rb
-- examples/builder/internal-broadcast.rb
-- examples/builder/internal-compose.rb
-- examples/builder/internal-seek.rb
+- examples/builder/internal-broadcastable.rb
+- examples/builder/internal-composable.rb
+- examples/builder/internal-seekable.rb
 - examples/docs/animals.json
 - examples/docs/animals.xml
 - examples/docs/fruits.json
@@ -44,9 +44,9 @@ files:
 - examples/external-verbosify.rb
 - examples/hooks-call.rb
 - examples/identity.rb
-- examples/internal-broadcast.rb
-- examples/internal-compose.rb
-- examples/internal-seek.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
@@ -69,7 +69,7 @@ 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.4/CHANGELOG.md
+  changelog_uri: https://github.com/jsmmr/ruby_callable_tree/blob/v0.3.5/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: