callable_tree 0.3.1 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c16eb0b2fd83ffd98d61bca938bd449dac9c004e8240c4f1a3b61242bf841163
-  data.tar.gz: 9919ffcda275a5a5bcf81b0bfae40087cae1f701fc0b7b915fece81c21a79d6b
+  metadata.gz: 8cdb3e4595a6233e401511b3a1cb371cacc3bcf6aa38aa78779928a532124103
+  data.tar.gz: abfb837062826d1c3ad644b127eac6b54241106b6feb29f4750add2104676750
 SHA512:
-  metadata.gz: 98c022cc2b12dccf2333f1a1fc079febe80f597bbbfbd4565384b88987c92c2426d7986ee80c11e1361139b95d495fdff9237e4f986d57dbb7eb355ce8244a0b
-  data.tar.gz: bcee44379ab11292a5c3bba4b0d37f2bdc2a6f587f9a2a757c11c6093d29fdbd1fe20bd9e0ee6561d98785121222ae1959b412ca8b4ecb5ddf579504f5a704c4
+  metadata.gz: a44400b690e3b04f9f1abef9eacc7ddd648121015c3d0e919cf4a0bfab8f4ffa30ffa55dc71b9eb8a4eb174be64ab83a46f1c71457107169f32271182998fceb
+  data.tar.gz: 52ece74206ae1cb94cd53e9920a8cdc29aa00874dee0f4a4c214dcf679d1d0d2374217585828eebf642374ca4676a503e819b4a16fbf5c26fa7004b81da971ff

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,26 @@
 ## [Unreleased]
 
+## [0.3.4] - 2022-03-13
+
+- Add `CallableTree::Node::Internal::Builder`. (experimental)
+  See `examples/builder/*.rb` for details.
+- Add `CallableTree::Node::External::Builder`. (experimental)
+  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!`.
+- Add `CallableTree::Node::Internal#find` to return the first node evaluated as `true` by block.
+
+## [0.3.2] - 2022-02-05
+
+- Change `CallableTree::Node::Hooks::Call#before_call` to return a new instance.
+  To keep the same behavior as the older version, use `CallableTree::Node::Hooks::Call#before_call!` that makes destructive change.
+- Change `CallableTree::Node::Hooks::Call#around_call` to return a new instance.
+  To keep the same behavior as the older version, use `CallableTree::Node::Hooks::Call#around_call!` that makes destructive change.
+- Change `CallableTree::Node::Hooks::Call#after_call` to return a new instance.
+  To keep the same behavior as the older version, use `CallableTree::Node::Hooks::Call#after_call!` that makes destructive change.
+
 ## [0.3.1] - 2022-01-10
 
 - Add `CallableTree::Node::Internal#seek?` to check whether the node's strategy is `seek` or not.

data/Gemfile.lock

@@ -1,30 +1,29 @@
 PATH
   remote: .
   specs:
-    callable_tree (0.3.1)
+    callable_tree (0.3.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.5.0)
     rake (13.0.6)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
+      rspec-support (~> 3.11.0)
+    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/examples/builder/hooks-call.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'callable_tree'
+
+Root =
+  CallableTree::Node::Internal::Builder
+  .new
+  .hookable
+  .build
+
+Root
+  .new
+  .before_call do |input, **_options|
+    puts "before_call input: #{input}"
+    input + 1
+  end
+  .append(
+    # anonymous external node
+    lambda do |input, **_options|
+      puts "external input: #{input}"
+      input * 2
+    end
+  )
+  .around_call do |input, **_options, &block|
+    puts "around_call input: #{input}"
+    output = block.call
+    puts "around_call output: #{output}"
+    output * input
+  end
+  .after_call do |output, **_options|
+    puts "after_call output: #{output}"
+    output * 2
+  end
+  .tap do |tree|
+    options = { foo: :bar }
+    output = tree.call(1, **options)
+    puts "result: #{output}"
+  end

data/examples/builder/internal-broadcast.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.broadcast.append(
+  LessThan5.new.broadcast.append(
+    Multiply2.new,
+    Add1.new
+  ),
+  LessThan10.new.broadcast.append(
+    Multiply3.new,
+    Subtract1.new
+  )
+)
+
+(0..10).each do |input|
+  output = tree.call(input)
+  puts "#{input} -> #{output}"
+end

data/examples/builder/internal-compose.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.compose.append(
+  LessThan5.new.compose.append(
+    Multiply2.new,
+    Add1.new
+  ),
+  LessThan10.new.compose.append(
+    Multiply3.new,
+    Subtract1.new
+  )
+)
+
+(0..10).each do |input|
+  output = tree.call(input)
+  puts "#{input} -> #{output}"
+end

data/examples/builder/internal-seek.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'callable_tree'
+require 'json'
+require 'rexml/document'
+
+module JSONParser
+  def self.build
+    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
+      .terminater do
+        true
+      end
+      .build
+  end
+end
+
+module XMLParser
+  def self.build
+    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
+      .terminater do
+        true
+      end
+      .build
+  end
+end
+
+module JSONScraper
+  def self.build(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
+end
+
+module XMLScraper
+  def self.build(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
+end
+
+tree = CallableTree::Node::Root.new.append(
+  JSONParser.build.new.append(
+    JSONScraper.build(:animals).new,
+    JSONScraper.build(:fruits).new
+  ),
+  XMLParser.build.new.append(
+    XMLScraper.build(:animals).new,
+    XMLScraper.build(:fruits).new
+  )
+)
+
+Dir.glob("#{__dir__}/../docs/*") do |file|
+  options = { foo: :bar }
+  pp tree.call(file, **options)
+  puts '---'
+end

data/examples/hooks-call.rb

@@ -9,9 +9,10 @@ module Node
   end
 end
 
-Node::HooksSample.new
+Node::HooksSample
+  .new
   .before_call do |input, **_options|
-    puts "before_call input: #{input}";
+    puts "before_call input: #{input}"
     input + 1
   end
   .append(

data/lib/callable_tree/node/builder.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module CallableTree
+  module Node
+    module Builder
+      def matcher(&block)
+        @matcher = block
+        self
+      end
+
+      def caller(&block)
+        @caller = block
+        self
+      end
+
+      def terminater(&block)
+        @terminater = block
+        self
+      end
+
+      def hookable(hookable = true)
+        @hookable = hookable
+        self
+      end
+
+      def build(node_type:)
+        matcher = @matcher
+        caller = @caller
+        terminater = @terminater
+        hookable = @hookable
+
+        validate(
+          matcher: matcher,
+          caller: caller,
+          terminater: terminater
+        )
+
+        ::Class
+          .new do
+            include node_type
+            prepend Hooks::Call if hookable
+
+            if matcher
+              define_method(:match?) do |*inputs, **options|
+                matcher.call(*inputs, **options) do |*inputs, **options|
+                  super(*inputs, **options)
+                end
+              end
+            end
+
+            if caller
+              define_method(:call) do |*inputs, **options|
+                caller.call(*inputs, **options) do |*inputs, **options|
+                  super(*inputs, **options)
+                end
+              end
+            end
+
+            if terminater
+              define_method(:terminate?) do |output, *inputs, **options|
+                terminater.call(output, *inputs, **options) do |output, *inputs, **options|
+                  super(output, *inputs, **options)
+                end
+              end
+            end
+          end
+      end
+
+      private
+
+      def validate(matcher:, caller:, terminater:)
+        raise ::CallableTree::Error, 'Not implemented'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CallableTree
+  module Node
+    module External
+      class Builder
+        include Node::Builder
+
+        class Error < StandardError; end
+
+        def build
+          super(node_type: External)
+        end
+
+        private
+
+        def validate(matcher:, caller:, terminater:)
+          raise Error 'caller is required' unless caller
+        end
+      end
+    end
+  end
+end

data/lib/callable_tree/node/hooks/call.rb

@@ -9,16 +9,28 @@ module CallableTree
         end
 
         def before_call(&block)
+          clone.before_call!(&block)
+        end
+
+        def before_call!(&block)
           before_callbacks << block
           self
         end
 
         def around_call(&block)
+          clone.around_call!(&block)
+        end
+
+        def around_call!(&block)
           around_callbacks << block
           self
         end
 
         def after_call(&block)
+          clone.after_call!(&block)
+        end
+
+        def after_call!(&block)
           after_callbacks << block
           self
         end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CallableTree
+  module Node
+    module Internal
+      class Builder
+        include Node::Builder
+
+        def build
+          super(node_type: Internal)
+        end
+
+        private
+
+        def validate(matcher:, caller:, terminater:)
+          # noop
+        end
+      end
+    end
+  end
+end

data/lib/callable_tree/node/internal.rb

@@ -17,9 +17,7 @@ module CallableTree
       end
 
       def append(*callables)
-        clone.tap do |node|
-          node.append!(*callables)
-        end
+        clone.append!(*callables)
       end
 
       def append!(*callables)
@@ -30,21 +28,38 @@ module CallableTree
         self
       end
 
-      def reject(&block)
-        clone.tap do |node|
-          node.reject!(&block)
+      def find(recursive: false, &block)
+        node = child_nodes.find(&block)
+        return node if node
+
+        if recursive
+          child_nodes
+            .lazy
+            .select { |node| node.is_a?(Internal) }
+            .map { |node| node.find(recursive: true, &block) }
+            .reject(&:nil?)
+            .first
         end
       end
 
-      def reject!(&block)
+      def reject(recursive: false, &block)
+        clone.reject!(recursive: recursive, &block)
+      end
+
+      def reject!(recursive: false, &block)
         child_nodes.reject!(&block)
+
+        if recursive
+          child_nodes.each do |node|
+            node.reject!(recursive: true, &block) if node.is_a?(Internal)
+          end
+        end
+
         self
       end
 
       def shake(&block)
-        clone.tap do |node|
-          node.shake!(&block)
-        end
+        clone.shake!(&block)
       end
 
       def shake!(&block)

data/lib/callable_tree/version.rb

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

data/lib/callable_tree.rb

@@ -15,4 +15,7 @@ require_relative 'callable_tree/node/internal/strategy/compose'
 require_relative 'callable_tree/node/external/verbose'
 require_relative 'callable_tree/node/external'
 require_relative 'callable_tree/node/internal'
+require_relative 'callable_tree/node/builder'
+require_relative 'callable_tree/node/internal/builder'
+require_relative 'callable_tree/node/external/builder'
 require_relative 'callable_tree/node/root'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callable_tree
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.4
 platform: ruby
 authors:
 - jsmmr
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2022-03-13 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
@@ -33,6 +33,10 @@ files:
 - bin/console
 - 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/docs/animals.json
 - examples/docs/animals.xml
 - examples/docs/fruits.json
@@ -46,10 +50,13 @@ files:
 - examples/logging.rb
 - lib/callable_tree.rb
 - lib/callable_tree/node.rb
+- lib/callable_tree/node/builder.rb
 - lib/callable_tree/node/external.rb
+- lib/callable_tree/node/external/builder.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/builder.rb
 - lib/callable_tree/node/internal/strategy.rb
 - lib/callable_tree/node/internal/strategy/broadcast.rb
 - lib/callable_tree/node/internal/strategy/compose.rb
@@ -62,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.1/CHANGELOG.md
+  changelog_uri: https://github.com/jsmmr/ruby_callable_tree/blob/v0.3.4/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -78,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Builds a tree by linking callable nodes. The nodes that match the conditions