callable_tree 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d3a8425d7d4634140f8ae67d37b00212909bfefb2055fd75d98e8d6f851b5be
-  data.tar.gz: 0103f8cda6b99b7f122b79f95f6b70bfdd8c8b5aecc01791e870941b0d5d2f36
+  metadata.gz: ea52457dd99aca79ec45ac97716f53824b14dde4d479486b9d9fa6571a714c76
+  data.tar.gz: 4fa5ee37a4a061b7c92f3373131b588bd30f12a351f344646dab2ec2d1089718
 SHA512:
-  metadata.gz: 6722db751a4b784f8983aa9164371bf9f933c3ea7a1e00b3e0595970a3842f93fd86357da48fc6958babdb7add5d0018d5ace986049ae286961bf328ddcc36ab
-  data.tar.gz: 74fd411e58ef8b04d810504f2003809f50488e6fabcc8ff9ff4b596e509b750eaeb4e333698d259dd6a39ce3293f84f2755bcaa3d296a5364d17bbb315128ff9
+  metadata.gz: 5f6e91b80e81f89d0e8f1c15ac5043de2b100245232de6b3584e900d1378952ad91442e4a55f80c59cfe8a01e5a9b34cf277b3a213290cf0b5aa8e0985edc7ca
+  data.tar.gz: 2a89b0e60761fa826c1e083b34f24138693c9f44743c0c3c018f6dcbf330a6471481421dc9c99b4f4d5ae2f410aaeec293bed4ed46f10f28482280ea582f895a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.1.1] - 2021-05-27
+
+- Add `CallableTree::Node::Internal#broadcast` (experimental)
+
 ## [0.1.0] - 2021-05-19
 
 - Initial release

data/Gemfile.lock

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

data/README.md

@@ -136,7 +136,7 @@ tree = CallableTree::Node::Root.new.append(
 
 Dir.glob(__dir__ + '/docs/*') do |file|
   options = { foo: :bar }
-  puts tree.call(file, **options)
+  pp tree.call(file, **options)
   puts '---'
 end
 ```
@@ -181,13 +181,25 @@ tree = CallableTree::Node::Root.new.append(
 Run `examples/example2.rb`:
 ```sh
 % ruby examples/example2.rb
-#<struct CallableTree::Node::External::Output value={"Dog"=>"🐶", "Cat"=>"🐱"}, options={:foo=>:bar}, routes=[Node::JSON::Scraper, Node::JSON::Parser, CallableTree::Node::Root]>
+#<struct CallableTree::Node::External::Output
+ value={"Dog"=>"🐶", "Cat"=>"🐱"},
+ options={:foo=>:bar},
+ routes=[Node::JSON::Scraper, Node::JSON::Parser, CallableTree::Node::Root]>
 ---
-#<struct CallableTree::Node::External::Output value={"Dog"=>"🐶", "Cat"=>"🐱"}, options={:foo=>:bar}, routes=[Node::XML::Scraper, Node::XML::Parser, CallableTree::Node::Root]>
+#<struct CallableTree::Node::External::Output
+ value={"Dog"=>"🐶", "Cat"=>"🐱"},
+ options={:foo=>:bar},
+ routes=[Node::XML::Scraper, Node::XML::Parser, CallableTree::Node::Root]>
 ---
-#<struct CallableTree::Node::External::Output value={"Red Apple"=>"🍎", "Green Apple"=>"🍏"}, options={:foo=>:bar}, routes=[Node::JSON::Scraper, Node::JSON::Parser, CallableTree::Node::Root]>
+#<struct CallableTree::Node::External::Output
+ value={"Red Apple"=>"🍎", "Green Apple"=>"🍏"},
+ options={:foo=>:bar},
+ routes=[Node::JSON::Scraper, Node::JSON::Parser, CallableTree::Node::Root]>
 ---
-#<struct CallableTree::Node::External::Output value={"Red Apple"=>"🍎", "Green Apple"=>"🍏"}, options={:foo=>:bar}, routes=[Node::XML::Scraper, Node::XML::Parser, CallableTree::Node::Root]>
+#<struct CallableTree::Node::External::Output
+ value={"Red Apple"=>"🍎", "Green Apple"=>"🍏"},
+ options={:foo=>:bar},
+ routes=[Node::XML::Scraper, Node::XML::Parser, CallableTree::Node::Root]>
 ---
 ```
 
@@ -257,13 +269,45 @@ end
 Run `examples/example3.rb`:
 ```sh
 % ruby examples/example3.rb
-#<struct CallableTree::Node::External::Output value={"Dog"=>"🐶", "Cat"=>"🐱"}, options={:foo=>:bar}, routes=[#<Node::Identity:0x00007ff1f78e09e0 @klass=Node::JSON::Scraper, @type=:animals>, Node::JSON::Parser, CallableTree::Node::Root]>
+#<struct CallableTree::Node::External::Output
+ value={"Dog"=>"🐶", "Cat"=>"🐱"},
+ options={:foo=>:bar},
+ routes=
+  [#<Node::Identity:0x00007fb4378a9718
+    @klass=Node::JSON::Scraper,
+    @type=:animals>,
+   Node::JSON::Parser,
+   CallableTree::Node::Root]>
 ---
-#<struct CallableTree::Node::External::Output value={"Dog"=>"🐶", "Cat"=>"🐱"}, options={:foo=>:bar}, routes=[#<Node::Identity:0x00007ff1e7885208 @klass=Node::XML::Scraper, @type=:animals>, Node::XML::Parser, CallableTree::Node::Root]>
+#<struct CallableTree::Node::External::Output
+ value={"Dog"=>"🐶", "Cat"=>"🐱"},
+ options={:foo=>:bar},
+ routes=
+  [#<Node::Identity:0x00007fb41002b6d0
+    @klass=Node::XML::Scraper,
+    @type=:animals>,
+   Node::XML::Parser,
+   CallableTree::Node::Root]>
 ---
-#<struct CallableTree::Node::External::Output value={"Red Apple"=>"🍎", "Green Apple"=>"🍏"}, options={:foo=>:bar}, routes=[#<Node::Identity:0x00007ff1e78771a8 @klass=Node::JSON::Scraper, @type=:fruits>, Node::JSON::Parser, CallableTree::Node::Root]>
+#<struct CallableTree::Node::External::Output
+ value={"Red Apple"=>"🍎", "Green Apple"=>"🍏"},
+ options={:foo=>:bar},
+ routes=
+  [#<Node::Identity:0x00007fb41001b3e8
+    @klass=Node::JSON::Scraper,
+    @type=:fruits>,
+   Node::JSON::Parser,
+   CallableTree::Node::Root]>
 ---
-#<struct CallableTree::Node::External::Output value={"Red Apple"=>"🍎", "Green Apple"=>"🍏"}, options={:foo=>:bar}, routes=[#<Node::Identity:0x00007ff1f20d7f50 @klass=Node::XML::Scraper, @type=:fruits>, Node::XML::Parser, CallableTree::Node::Root]>
+#<struct CallableTree::Node::External::Output
+ value={"Red Apple"=>"🍎", "Green Apple"=>"🍏"},
+ options={:foo=>:bar},
+ routes=
+  [#<Node::Identity:0x00007fb410049d38
+    @klass=Node::XML::Scraper,
+    @type=:fruits>,
+   Node::XML::Parser,
+   CallableTree::Node::Root]>
 ---
 ```
 
@@ -351,21 +395,45 @@ Run `examples/example4.rb`:
   * Node::JSON::Scraper(animals): [matched: true]
     Input : {"animals"=>[{"name"=>"Dog", "emoji"=>"🐶"}, {"name"=>"Cat", "emoji"=>"🐱"}]}
     Output: {"Dog"=>"🐶", "Cat"=>"🐱"}
-#<struct CallableTree::Node::External::Output value={"Dog"=>"🐶", "Cat"=>"🐱"}, options={:foo=>:bar}, routes=[#<Node::Identity:0x00007f9737074060 @klass=Node::JSON::Scraper, @type=:animals>, Node::JSON::Parser, CallableTree::Node::Root]>
+#<struct CallableTree::Node::External::Output
+ value={"Dog"=>"🐶", "Cat"=>"🐱"},
+ options={:foo=>:bar},
+ routes=
+  [#<Node::Identity:0x00007ffd840347b8
+    @klass=Node::JSON::Scraper,
+    @type=:animals>,
+   Node::JSON::Parser,
+   CallableTree::Node::Root]>
 ---
 * Node::JSON::Parser: [matched: false]
 * Node::XML::Parser: [matched: true]
   * Node::XML::Scraper(animals): [matched: true]
     Input : <root><animals><animal emoji='🐶' name='Dog'/><animal emoji='🐱' name='Cat'/></animals></root>
     Output: {"Dog"=>"🐶", "Cat"=>"🐱"}
-#<struct CallableTree::Node::External::Output value={"Dog"=>"🐶", "Cat"=>"🐱"}, options={:foo=>:bar}, routes=[#<Node::Identity:0x00007f973710d0f8 @klass=Node::XML::Scraper, @type=:animals>, Node::XML::Parser, CallableTree::Node::Root]>
+#<struct CallableTree::Node::External::Output
+ value={"Dog"=>"🐶", "Cat"=>"🐱"},
+ options={:foo=>:bar},
+ routes=
+  [#<Node::Identity:0x00007ffd7403f1f0
+    @klass=Node::XML::Scraper,
+    @type=:animals>,
+   Node::XML::Parser,
+   CallableTree::Node::Root]>
 ---
 * Node::JSON::Parser: [matched: true]
   * Node::JSON::Scraper(animals): [matched: false]
   * Node::JSON::Scraper(fruits): [matched: true]
     Input : {"fruits"=>[{"name"=>"Red Apple", "emoji"=>"🍎"}, {"name"=>"Green Apple", "emoji"=>"🍏"}]}
     Output: {"Red Apple"=>"🍎", "Green Apple"=>"🍏"}
-#<struct CallableTree::Node::External::Output value={"Red Apple"=>"🍎", "Green Apple"=>"🍏"}, options={:foo=>:bar}, routes=[#<Node::Identity:0x00007f97370ffed0 @klass=Node::JSON::Scraper, @type=:fruits>, Node::JSON::Parser, CallableTree::Node::Root]>
+#<struct CallableTree::Node::External::Output
+ value={"Red Apple"=>"🍎", "Green Apple"=>"🍏"},
+ options={:foo=>:bar},
+ routes=
+  [#<Node::Identity:0x00007ffd8512bdf0
+    @klass=Node::JSON::Scraper,
+    @type=:fruits>,
+   Node::JSON::Parser,
+   CallableTree::Node::Root]>
 ---
 * Node::JSON::Parser: [matched: false]
 * Node::XML::Parser: [matched: true]
@@ -373,7 +441,15 @@ Run `examples/example4.rb`:
   * Node::XML::Scraper(fruits): [matched: true]
     Input : <root><fruits><fruit emoji='🍎' name='Red Apple'/><fruit emoji='🍏' name='Green Apple'/></fruits></root>
     Output: {"Red Apple"=>"🍎", "Green Apple"=>"🍏"}
-#<struct CallableTree::Node::External::Output value={"Red Apple"=>"🍎", "Green Apple"=>"🍏"}, options={:foo=>:bar}, routes=[#<Node::Identity:0x00007f97370cceb8 @klass=Node::XML::Scraper, @type=:fruits>, Node::XML::Parser, CallableTree::Node::Root]>
+#<struct CallableTree::Node::External::Output
+ value={"Red Apple"=>"🍎", "Green Apple"=>"🍏"},
+ options={:foo=>:bar},
+ routes=
+  [#<Node::Identity:0x00007ffd8407a740
+    @klass=Node::XML::Scraper,
+    @type=:fruits>,
+   Node::XML::Parser,
+   CallableTree::Node::Root]>
 ---
 ```
 
@@ -427,6 +503,41 @@ after_call output: 8
 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.
+
+`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"=>"🍏"}]
+---
+```
+
 ## 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. This is 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. This is 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 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.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/CHANGELOG.md'
+  spec.metadata['changelog_uri'] = 'https://github.com/jsmmr/ruby_callable_tree/blob/v#{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/example1.rb

@@ -96,6 +96,6 @@ tree = CallableTree::Node::Root.new.append(
 
 Dir.glob(__dir__ + '/docs/*') do |file|
   options = { foo: :bar }
-  puts tree.call(file, **options)
+  pp tree.call(file, **options)
   puts '---'
 end

data/examples/example2.rb

@@ -96,6 +96,6 @@ tree = CallableTree::Node::Root.new.append(
 
 Dir.glob(__dir__ + '/docs/*') do |file|
   options = { foo: :bar }
-  puts tree.call(file, **options)
+  pp tree.call(file, **options)
   puts '---'
 end

data/examples/example3.rb

@@ -117,6 +117,6 @@ tree = CallableTree::Node::Root.new.append(
 
 Dir.glob(__dir__ + '/docs/*') do |file|
   options = { foo: :bar }
-  puts tree.call(file, **options)
+  pp tree.call(file, **options)
   puts '---'
 end

data/examples/example4.rb

@@ -153,6 +153,6 @@ tree = CallableTree::Node::Root.new.append(
 
 Dir.glob(__dir__ + '/docs/*') do |file|
   options = { foo: :bar }
-  puts tree.call(file, **options)
+  pp tree.call(file, **options)
   puts '---'
 end

data/examples/example6.rb

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

data/lib/callable_tree.rb

@@ -7,8 +7,10 @@ end
 require 'forwardable'
 require_relative 'callable_tree/version'
 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/external/verbose'
 require_relative 'callable_tree/node/external'
-require_relative 'callable_tree/node/hooks/call'
 require_relative 'callable_tree/node/internal'
 require_relative 'callable_tree/node/root'

data/lib/callable_tree/node/internal.rb

@@ -31,54 +31,36 @@ module CallableTree
       end
 
       def call(input = nil, **options)
-        children
-          .lazy
-          .map { |node| Input.new(input, options, node) }
-          .select { |input| input.valid? }
-          .map { |input| input.call }
-          .select { |output| output.valid? }
-          .map { |output| output.call }
-          .first
+        strategy.call(children, input: input, options: options)
       end
 
-      class Input < BasicObject
-        def initialize(value, options, node)
-          @value = value
-          @options = options
-          @node = node
-        end
-
-        def valid?
-          @node.match?(@value, **@options)
-        end
-
-        def call
-          value = @node.call(@value, **@options)
-          Output.new(value, @options, @node)
+      def seek
+        if strategy.is_a?(Seek)
+          self
+        else
+          clone.tap do |node|
+            node.send(:strategy=, Seek.new)
+          end
         end
       end
 
-      class Output < BasicObject
-        def initialize(value, options, node)
-          @value = value
-          @options = options
-          @node = node
-        end
-
-        def valid?
-          @node.terminate?(@value, **@options)
-        end
-
-        def call
-          @value
+      def broadcast
+        if strategy.is_a?(Broadcast)
+          self
+        else
+          clone.tap do |node|
+            node.send(:strategy=, Broadcast.new)
+          end
         end
       end
 
-      private_constant :Input, :Output
-
       private
 
-      attr_writer :children
+      attr_writer :children, :strategy
+
+      def strategy
+        @strategy ||= Seek.new
+      end
 
       def initialize_copy(_node)
         super

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

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

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CallableTree
+  module Node
+    module Internal
+      class Seek
+        def call(nodes, input:, options:)
+          nodes
+            .lazy
+            .select { |node| node.match?(input, **options) }
+            .map do |node|
+              output = node.call(input, **options)
+              terminated = node.terminate?(output, **options)
+              [output, terminated]
+            end
+            .select { |_output, terminated| terminated }
+            .map { |output, _terminated| output }
+            .first
+        end
+      end
+    end
+  end
+end

data/lib/callable_tree/version.rb

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

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: callable_tree
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - jsmmr
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-19 00:00:00.000000000 Z
+date: 2021-05-27 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. This is like
+  condition are called in a chain from the root node to the leaf node. These are like
   nested case statements.
 email:
 - jsmmr@icloud.com
@@ -41,13 +41,15 @@ files:
 - examples/example3.rb
 - examples/example4.rb
 - examples/example5.rb
+- examples/example6.rb
 - lib/callable_tree.rb
 - lib/callable_tree/node.rb
-- lib/callable_tree/node/branch.rb
 - lib/callable_tree/node/external.rb
 - lib/callable_tree/node/external/verbose.rb
 - 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/seek.rb
 - lib/callable_tree/node/root.rb
 - lib/callable_tree/version.rb
 homepage: https://github.com/jsmmr/ruby_callable_tree
@@ -56,7 +58,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/CHANGELOG.md
+  changelog_uri: https://github.com/jsmmr/ruby_callable_tree/blob/v#{version}/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -76,6 +78,6 @@ 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. This is like
+  condition are called in a chain from the root node to the leaf node. These are like
   nested case statements.
 test_files: []

data/lib/callable_tree/node/branch.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module CallableTree
-  module Node
-    module Branch
-      attr_reader :parent
-
-      def ancestors
-        ::Enumerator.new do |y|
-          node = self
-          while node = node&.parent
-            y << node
-          end
-        end
-      end
-
-      def routes
-        ::Enumerator.new do |y|
-          y << self.class
-          ancestors.each { |node| y << node.class }
-        end
-      end
-
-      def depth
-        parent.nil? ? 0 : parent.depth + 1
-      end
-
-      private
-
-      attr_writer :parent
-    end
-
-    private_constant :Branch
-  end
-end