callable_tree 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea52457dd99aca79ec45ac97716f53824b14dde4d479486b9d9fa6571a714c76
-  data.tar.gz: 4fa5ee37a4a061b7c92f3373131b588bd30f12a351f344646dab2ec2d1089718
+  metadata.gz: 822f8080ff2652895cd3cb7255d856eea72290564dbe7054d93c2fca01ac6149
+  data.tar.gz: 783496e58325e0d5be2595b3c33b0acd1095c61400b89addc0ce9d8fc8e845db
 SHA512:
-  metadata.gz: 5f6e91b80e81f89d0e8f1c15ac5043de2b100245232de6b3584e900d1378952ad91442e4a55f80c59cfe8a01e5a9b34cf277b3a213290cf0b5aa8e0985edc7ca
-  data.tar.gz: 2a89b0e60761fa826c1e083b34f24138693c9f44743c0c3c018f6dcbf330a6471481421dc9c99b4f4d5ae2f410aaeec293bed4ed46f10f28482280ea582f895a
+  metadata.gz: '0381d33a9f1a82b524aa176574d24961e7585ebb4ea76185759be2d17d739b9c84612b0ed9f7f2323083a71515acbf6fa622b65528c5a903dd911147bebfb7c7'
+  data.tar.gz: 9b715d2b2fd6ca25c1bf8c446574a2097271525facc306198695d01fbadffd2e7823866e16c58c83cb8a7f08dc8047909023ecc8256d083f07854b9c714a57ac

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.1.2] - 2021-05-29
+
+- Add `CallableTree::Node::Internal#compose` (experimental)
+
 ## [0.1.1] - 2021-05-27
 
 - Add `CallableTree::Node::Internal#broadcast` (experimental)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    callable_tree (0.1.1)
+    callable_tree (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -470,6 +470,7 @@ Node::HooksSample.new
     input + 1
   end
   .append(
+    # anonymous external node
     lambda do |input, **options|
       puts "external input: #{input}"
       input * 2
@@ -505,7 +506,7 @@ result: 16
 
 #### `CallableTree::Node::Internal#broadcast` (experimental)
 
-If you want to call and output all child nodes of the internal node, call it. Broadcast strategy ignores the `terminate?` method of the child node.
+If you want to call all child nodes of the internal node in order to output their results as array, call it. The `broadcast` strategy ignores the `terminate?` method of the nodes.
 
 `examples/example6.rb`:
 ```ruby
@@ -538,6 +539,60 @@ Run `examples/example6.rb`:
 ---
 ```
 
+#### `CallableTree::Node::Internal#compose` (experimental)
+
+If you want to call all child nodes of the internal node in order to input the output of the previous node to the next node and output a single result , call it. The `compose` strategy ignores the `terminate?` method of the nodes.
+
+`examples/example7.rb`:
+```ruby
+module Node
+  class LessThan
+    include CallableTree::Node::Internal
+
+    def initialize(num)
+      @num = num
+    end
+
+    def match?(input)
+      super && input < @num
+    end
+  end
+end
+
+tree = CallableTree::Node::Root.new.append(
+  Node::LessThan.new(5).append(
+    proc { |input| input * 2 }, # anonymous external node
+    proc { |input| input + 1 }  # anonymous external node
+  ).compose,
+  Node::LessThan.new(10).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)
+  puts "#{input} -> #{output}"
+end
+
+```
+
+Run `examples/example7.rb`:
+```sh
+% ruby examples/example7.rb
+0 -> 2
+1 -> 8
+2 -> 14
+3 -> 20
+4 -> 26
+5 -> 14
+6 -> 17
+7 -> 20
+8 -> 23
+9 -> 26
+10 -> 10
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jsmmr/callable_tree.

data/callable_tree.gemspec

@@ -8,15 +8,15 @@ Gem::Specification.new do |spec|
   spec.authors       = ['jsmmr']
   spec.email         = ['jsmmr@icloud.com']
 
-  spec.summary       = 'Builds a tree by linking callable nodes. The nodes that match the calling condition are called in a chain from the root node to the leaf node. These are like nested case statements.'
-  spec.description   = 'Builds a tree by linking callable nodes. The nodes that match the calling condition are called in a chain from the root node to the leaf node. These are like nested case statements.'
+  spec.summary       = 'Builds a tree by linking callable nodes. The nodes that match the calling condition are called in a chain from the root node to the leaf node. These are like nested `if` or `case` expressions.'
+  spec.description   = 'Builds a tree by linking callable nodes. The nodes that match the calling condition are called in a chain from the root node to the leaf node. These are like nested `if` or `case` expressions.'
   spec.homepage      = 'https://github.com/jsmmr/ruby_callable_tree'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/jsmmr/ruby_callable_tree'
-  spec.metadata['changelog_uri'] = 'https://github.com/jsmmr/ruby_callable_tree/blob/v#{version}/CHANGELOG.md'
+  spec.metadata['changelog_uri'] = "https://github.com/jsmmr/ruby_callable_tree/blob/v#{spec.version}/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/examples/example5.rb

@@ -13,6 +13,7 @@ Node::HooksSample.new
     input + 1
   end
   .append(
+    # anonymous external node
     lambda do |input, **options|
       puts "external input: #{input}"
       input * 2

data/examples/example7.rb

@@ -0,0 +1,31 @@
+require 'callable_tree'
+
+module Node
+  class LessThan
+    include CallableTree::Node::Internal
+
+    def initialize(num)
+      @num = num
+    end
+
+    def match?(input)
+      super && input < @num
+    end
+  end
+end
+
+tree = CallableTree::Node::Root.new.append(
+  Node::LessThan.new(5).append(
+    proc { |input| input * 2 }, # anonymous external node
+    proc { |input| input + 1 }  # anonymous external node
+  ).compose,
+  Node::LessThan.new(10).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)
+  puts "#{input} -> #{output}"
+end

data/lib/callable_tree.rb

@@ -10,6 +10,7 @@ require_relative 'callable_tree/node'
 require_relative 'callable_tree/node/hooks/call'
 require_relative 'callable_tree/node/internal/broadcast'
 require_relative 'callable_tree/node/internal/seek'
+require_relative 'callable_tree/node/internal/compose'
 require_relative 'callable_tree/node/external/verbose'
 require_relative 'callable_tree/node/external'
 require_relative 'callable_tree/node/internal'

data/lib/callable_tree/node/internal.rb

@@ -54,6 +54,16 @@ module CallableTree
         end
       end
 
+      def compose
+        if strategy.is_a?(Compose)
+          self
+        else
+          clone.tap do |node|
+            node.send(:strategy=, Compose.new)
+          end
+        end
+      end
+
       private
 
       attr_writer :children, :strategy

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

@@ -6,11 +6,7 @@ module CallableTree
       class Broadcast
         def call(nodes, input:, options:)
           nodes.map do |node|
-            if node.match?(input, **options)
-              node.call(input, **options)
-            else
-              nil
-            end
+            node.call(input, **options) if node.match?(input, **options)
           end
         end
       end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CallableTree
+  module Node
+    module Internal
+      class Compose
+        def call(nodes, input:, options:)
+          nodes.reduce(input) do |input, node|
+            if node.match?(input, **options)
+              node.call(input, **options)
+            else
+              input
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/callable_tree/version.rb

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

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: callable_tree
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - jsmmr
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2021-05-29 00:00:00.000000000 Z
 dependencies: []
 description: Builds a tree by linking callable nodes. The nodes that match the calling
   condition are called in a chain from the root node to the leaf node. These are like
-  nested case statements.
+  nested `if` or `case` expressions.
 email:
 - jsmmr@icloud.com
 executables: []
@@ -42,6 +42,7 @@ files:
 - examples/example4.rb
 - examples/example5.rb
 - examples/example6.rb
+- examples/example7.rb
 - lib/callable_tree.rb
 - lib/callable_tree/node.rb
 - lib/callable_tree/node/external.rb
@@ -49,6 +50,7 @@ files:
 - lib/callable_tree/node/hooks/call.rb
 - lib/callable_tree/node/internal.rb
 - lib/callable_tree/node/internal/broadcast.rb
+- lib/callable_tree/node/internal/compose.rb
 - lib/callable_tree/node/internal/seek.rb
 - lib/callable_tree/node/root.rb
 - lib/callable_tree/version.rb
@@ -58,7 +60,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/v#{version}/CHANGELOG.md
+  changelog_uri: https://github.com/jsmmr/ruby_callable_tree/blob/v0.1.2/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -79,5 +81,5 @@ signing_key:
 specification_version: 4
 summary: Builds a tree by linking callable nodes. The nodes that match the calling
   condition are called in a chain from the root node to the leaf node. These are like
-  nested case statements.
+  nested `if` or `case` expressions.
 test_files: []