callable_tree 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 822f8080ff2652895cd3cb7255d856eea72290564dbe7054d93c2fca01ac6149
-  data.tar.gz: 783496e58325e0d5be2595b3c33b0acd1095c61400b89addc0ce9d8fc8e845db
+  metadata.gz: 8fa06f3d5119313cc62468deec9349bb902f92ff6267f9b0051d5625eea8a866
+  data.tar.gz: 8679ef5bd22e419d6379b18fdc0a509074938073c9edaff37b4a7bee6029cda8
 SHA512:
-  metadata.gz: '0381d33a9f1a82b524aa176574d24961e7585ebb4ea76185759be2d17d739b9c84612b0ed9f7f2323083a71515acbf6fa622b65528c5a903dd911147bebfb7c7'
-  data.tar.gz: 9b715d2b2fd6ca25c1bf8c446574a2097271525facc306198695d01fbadffd2e7823866e16c58c83cb8a7f08dc8047909023ecc8256d083f07854b9c714a57ac
+  metadata.gz: 6ccdf3baffda301532c51510b84d066cec428961f773618ddc8d344917c9af26ca3da3d6186d6748585a8eceb0eabac0d7e652bcbcafb28b3a4a9e74622eb98f
+  data.tar.gz: e1aa253c87040bebc9f03080ad25f704c1cbde0410355b4ffb70bbe969338d3ec7a88804abe856d582b9e351a182db43a7abe4b2f0b89c3f7d97fc6bb64bf1eb

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.1.3] - 2021-06-12
+- Minor improvements
+
 ## [0.1.2] - 2021-05-29
 
 - Add `CallableTree::Node::Internal#compose` (experimental)

data/Gemfile.lock

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

data/README.md

@@ -18,19 +18,22 @@ Or install it yourself as:
 
 ## Usage
 
+Builds a tree by linking instances of the nodes. The `call` method of the node where the `match?` method returns a truthy value is called in a chain from the root node to the leaf node.
+
 - `CallableTree::Node::Internal`
-  - This `module` is used to define a node that can have child nodes.
+  - This `module` is used to define a node that can have child nodes. An instance of this node has several strategies. The strategy can be changed by calling the method of the instance.
 - `CallableTree::Node::External`
   - This `module` is used to define a leaf node that cannot have child nodes.
 - `CallableTree::Node::Root`
   - This `class` includes `CallableTree::Node::Internal`. When there is no need to customize the internal node, use this `class`.
 
-Builds a tree by linking instances of the nodes. The `call` method of the node where the `match?` method returns a truthy value is called in a chain from the root node to the leaf node.
-If the `call` method returns a value other than `nil`, the next sibling node does not be called. This behavior is changeable by overriding the `terminate?` method.
-
 ### Basic
 
-`examples/example1.rb`:
+#### `CallableTree::Node::Internal#seek` (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`:
 ```ruby
 module Node
   module JSON
@@ -123,16 +126,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(
     Node::JSON::Scraper.new(type: :animals),
     Node::JSON::Scraper.new(type: :fruits)
-  ),
+  ),#.seek,
   Node::XML::Parser.new.append(
     Node::XML::Scraper.new(type: :animals),
     Node::XML::Scraper.new(type: :fruits)
-  )
-)
+  )#.seek
+)#.seek
 
 Dir.glob(__dir__ + '/docs/*') do |file|
   options = { foo: :bar }
@@ -141,9 +145,9 @@ Dir.glob(__dir__ + '/docs/*') do |file|
 end
 ```
 
-Run `examples/example1.rb`:
+Run `examples/internal-seek.rb`:
 ```sh
-% ruby examples/example1.rb
+% ruby examples/internal-seek.rb
 {"Dog"=>"🐶", "Cat"=>"🐱"}
 ---
 {"Dog"=>"🐶", "Cat"=>"🐱"}
@@ -154,13 +158,121 @@ Run `examples/example1.rb`:
 ---
 ```
 
+#### `CallableTree::Node::Internal#broadcast` (experimental)
+
+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`:
+```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(
+    lambda { |input, **| input * 2 }, # anonymous external node
+    lambda { |input, **| input + 1 }  # anonymous external node
+  ).broadcast,
+  Node::LessThan.new(10).append(
+    lambda { |input, **| input * 3 }, # anonymous external node
+    lambda { |input, **| input - 1 }  # anonymous external node
+  ).broadcast
+).broadcast
+
+(0..10).each do |input|
+  output = tree.call(input)
+  puts "#{input} -> #{output}"
+end
+
+```
+
+Run `examples/internal-broadcast.rb`:
+```sh
+% ruby examples/internal-broadcast.rb
+0 -> [[0, 1], [0, -1]]
+1 -> [[2, 2], [3, 0]]
+2 -> [[4, 3], [6, 1]]
+3 -> [[6, 4], [9, 2]]
+4 -> [[8, 5], [12, 3]]
+5 -> [nil, [15, 4]]
+6 -> [nil, [18, 5]]
+7 -> [nil, [21, 6]]
+8 -> [nil, [24, 7]]
+9 -> [nil, [27, 8]]
+10 -> [nil, nil]
+```
+
+#### `CallableTree::Node::Internal#compose` (experimental)
+
+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`:
+```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/internal-compose.rb`:
+```sh
+% ruby examples/internal-compose.rb
+0 -> 2
+1 -> 8
+2 -> 14
+3 -> 20
+4 -> 26
+5 -> 14
+6 -> 17
+7 -> 20
+8 -> 23
+9 -> 26
+10 -> 10
+```
+
 ### Advanced
 
 #### `CallableTree::Node::External#verbosify`
 
-If you want verbose result, call it.
+If you want verbose output results, call this method.
 
-`examples/example2.rb`:
+`examples/external-verbosify.rb`:
 ```ruby
 ...
 
@@ -178,9 +290,9 @@ tree = CallableTree::Node::Root.new.append(
 ...
 ```
 
-Run `examples/example2.rb`:
+Run `examples/external-verbosify.rb`:
 ```sh
-% ruby examples/example2.rb
+% ruby examples/external-verbosify.rb
 #<struct CallableTree::Node::External::Output
  value={"Dog"=>"🐶", "Cat"=>"🐱"},
  options={:foo=>:bar},
@@ -208,9 +320,9 @@ You can work around it by overriding the `identity` method of the node.
 
 #### `CallableTree::Node#identity`
 
-If you want to customize the node identity, override it.
+If you want to customize the node identity, override this method.
 
-`examples/example3.rb`:
+`examples/identity.rb`:
 ```ruby
 module Node
   class Identity
@@ -266,9 +378,9 @@ end
 ...
 ```
 
-Run `examples/example3.rb`:
+Run `examples/identity.rb`:
 ```sh
-% ruby examples/example3.rb
+% ruby examples/identity.rb
 #<struct CallableTree::Node::External::Output
  value={"Dog"=>"🐶", "Cat"=>"🐱"},
  options={:foo=>:bar},
@@ -315,7 +427,7 @@ Run `examples/example3.rb`:
 
 This is an example of logging.
 
-`examples/example4.rb`:
+`examples/logging.rb`:
 ```ruby
 module Node
   module Logging
@@ -388,9 +500,9 @@ end
 ...
 ```
 
-Run `examples/example4.rb`:
+Run `examples/logging.rb`:
 ```sh
-% ruby examples/example4.rb
+% ruby examples/logging.rb
 * Node::JSON::Parser: [matched: true]
   * Node::JSON::Scraper(animals): [matched: true]
     Input : {"animals"=>[{"name"=>"Dog", "emoji"=>"🐶"}, {"name"=>"Cat", "emoji"=>"🐱"}]}
@@ -455,7 +567,7 @@ Run `examples/example4.rb`:
 
 #### `CallableTree::Node::Hooks::Call` (experimental)
 
-`examples/example5.rb`:
+`examples/hooks-call.rb`:
 ```ruby
 module Node
   class HooksSample
@@ -493,9 +605,9 @@ Node::HooksSample.new
   end
 ```
 
-Run `examples/example5.rb`:
+Run `examples/hooks-call.rb`:
 ```sh
-% ruby examples/example5.rb
+% ruby examples/hooks-call.rb
 before_call input: 1
 external input: 2
 around_call input: 2
@@ -504,95 +616,6 @@ after_call output: 8
 result: 16
 ```
 
-#### `CallableTree::Node::Internal#broadcast` (experimental)
-
-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
-...
-
-tree = CallableTree::Node::Root.new.append(
-  Node::JSON::Parser.new.append(
-    Node::JSON::Scraper.new(type: :animals),
-    Node::JSON::Scraper.new(type: :fruits)
-  ).broadcast,
-  Node::XML::Parser.new.append(
-    Node::XML::Scraper.new(type: :animals),
-    Node::XML::Scraper.new(type: :fruits)
-  ).broadcast
-)
-
-...
-```
-
-Run `examples/example6.rb`:
-```sh
-% ruby examples/example6.rb
-[{"Dog"=>"🐶", "Cat"=>"🐱"}, nil]
----
-[{"Dog"=>"🐶", "Cat"=>"🐱"}, nil]
----
-[nil, {"Red Apple"=>"🍎", "Green Apple"=>"🍏"}]
----
-[nil, {"Red Apple"=>"🍎", "Green Apple"=>"🍏"}]
----
-```
-
-#### `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,8 +8,8 @@ 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 `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.summary       = '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 `if` or `case` expressions.'
+  spec.description   = 'Builds a tree by linking callable nodes. The nodes that match the conditiosn 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')

data/examples/internal-broadcast.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(
+    lambda { |input, **| input * 2 }, # anonymous external node
+    lambda { |input, **| input + 1 }  # anonymous external node
+  ).broadcast,
+  Node::LessThan.new(10).append(
+    lambda { |input, **| input * 3 }, # anonymous external node
+    lambda { |input, **| input - 1 }  # anonymous external node
+  ).broadcast
+).broadcast
+
+(0..10).each do |input|
+  output = tree.call(input)
+  puts "#{input} -> #{output}"
+end

data/lib/callable_tree/node/external.rb

@@ -9,12 +9,12 @@ module CallableTree
         Proxy.new(callable)
       end
 
-      def self.proxified?(node)
-        node.is_a?(Proxy)
+      def proxified?
+        false
       end
 
-      def self.unproxify(node)
-        node.callable
+      def verbosified?
+        false
       end
 
       def verbosify
@@ -23,8 +23,8 @@ module CallableTree
       end
 
       def identity
-        if External.proxified?(self)
-          External.unproxify(self)
+        if proxified?
+          unproxify
         else
           self
         end
@@ -36,11 +36,18 @@ module CallableTree
         include External
 
         def_delegators :@callable, :call
-        attr_reader :callable
 
         def initialize(callable)
           @callable = callable
         end
+
+        def proxified?
+          true
+        end
+
+        def unproxify
+          @callable
+        end
       end
 
       private_constant :Proxy

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

@@ -6,6 +6,10 @@ module CallableTree
       Output = Struct.new(:value, :options, :routes)
 
       module Verbose
+        def verbosified?
+          true
+        end
+
         def call(input = nil, **options)
           output = super(input, **options)
           routes = self.routes

data/lib/callable_tree/version.rb

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

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: callable_tree
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - jsmmr
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-29 00:00:00.000000000 Z
+date: 2021-06-12 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 `if` or `case` expressions.
+description: Builds a tree by linking callable nodes. The nodes that match the conditiosn
+  are called in a chain from the root node to the leaf node. These are like nested
+  `if` or `case` expressions.
 email:
 - jsmmr@icloud.com
 executables: []
@@ -36,13 +36,13 @@ files:
 - examples/docs/animals.xml
 - examples/docs/fruits.json
 - examples/docs/fruits.xml
-- examples/example1.rb
-- examples/example2.rb
-- examples/example3.rb
-- examples/example4.rb
-- examples/example5.rb
-- examples/example6.rb
-- examples/example7.rb
+- examples/external-verbosify.rb
+- examples/hooks-call.rb
+- examples/identity.rb
+- examples/internal-broadcast.rb
+- examples/internal-compose.rb
+- examples/internal-seek.rb
+- examples/logging.rb
 - lib/callable_tree.rb
 - lib/callable_tree/node.rb
 - lib/callable_tree/node/external.rb
@@ -60,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/v0.1.2/CHANGELOG.md
+  changelog_uri: https://github.com/jsmmr/ruby_callable_tree/blob/v0.1.3/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -79,7 +79,7 @@ requirements: []
 rubygems_version: 3.2.16
 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 `if` or `case` expressions.
+summary: 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
+  `if` or `case` expressions.
 test_files: []

data/examples/example6.rb

@@ -1,101 +0,0 @@
-require 'callable_tree'
-require 'json'
-require 'rexml/document'
-
-module Node
-  module JSON
-    class Parser
-      include CallableTree::Node::Internal
-
-      def match?(input, **options)
-        File.extname(input) == '.json'
-      end
-
-      def call(input, **options)
-        File.open(input) do |file|
-          json = ::JSON.load(file)
-          super(json, **options)
-        end
-      end
-
-      def terminate?(_output, **)
-        true
-      end
-    end
-
-    class Scraper
-      include CallableTree::Node::External
-
-      def initialize(type:)
-        @type = type
-      end
-
-      def match?(input, **options)
-        !!input[@type.to_s]
-      end
-
-      def call(input, **options)
-        input[@type.to_s]
-          .map { |element| [element['name'], element['emoji']] }
-          .to_h
-      end
-    end
-  end
-
-  module XML
-    class Parser
-      include CallableTree::Node::Internal
-
-      def match?(input, **options)
-        File.extname(input) == '.xml'
-      end
-
-      def call(input, **options)
-        File.open(input) do |file|
-          super(REXML::Document.new(file), **options)
-        end
-      end
-
-      def terminate?(_output, **)
-        true
-      end
-    end
-
-    class Scraper
-      include CallableTree::Node::External
-
-      def initialize(type:)
-        @type = type
-      end
-
-      def match?(input, **options)
-        !input.get_elements("//#{@type}").empty?
-      end
-
-      def call(input, **options)
-        input
-          .get_elements("//#{@type}")
-          .first
-          .map { |element| [element['name'], element['emoji']] }
-          .to_h
-      end
-    end
-  end
-end
-
-tree = CallableTree::Node::Root.new.append(
-  Node::JSON::Parser.new.append(
-    Node::JSON::Scraper.new(type: :animals),
-    Node::JSON::Scraper.new(type: :fruits)
-  ).broadcast,
-  Node::XML::Parser.new.append(
-    Node::XML::Scraper.new(type: :animals),
-    Node::XML::Scraper.new(type: :fruits)
-  ).broadcast
-)
-
-Dir.glob(__dir__ + '/docs/*') do |file|
-  options = { foo: :bar }
-  pp tree.call(file, **options)
-  puts '---'
-end