behave_fun 0.1.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa6285d17ba7200bca3e11fb9cdb7c6fb538a7461f8cb2d9c4496e5a1f885a90
-  data.tar.gz: 196808930dec23a365d3825da90c20e85e3a4f780a3857b67f768f718595a4fb
+  metadata.gz: e526abe95ba12a46398d54816db835b06d7fd637fa12d8532717de73d859b706
+  data.tar.gz: 4b8de5a4c3f9614e432c0e4a975f96a7b461e6b4be726f817b6a44ac2188e75e
 SHA512:
-  metadata.gz: f1cd5d323dfd2db92b4d9ac41b12cabf14ac9a56a14a317db64f32b23513f92ce0ce31285881d3e2feb0560603627891d392534ffec63ba378303eae244738fc
-  data.tar.gz: '01139c43255bb5130e327d2152b42964266adac83752314de0923898f2eb543b438e306a0027321b0139b120c2ac06fb6f0aa17138e8f2957df0b70fc36001f8'
+  metadata.gz: ce0fb474121dd2a64da415a002a0d02f20cba724def89a3cac06dd05cc1601cb4eb467da4293f748e4bd4985ef25a50b79d864633ec7834e348e33107a69bfb3
+  data.tar.gz: 89c72baf8266aad35d239ea8f56e8aff7a2b71ff22533440b771cf98ed90c5c3dd351f5967c560c0a69514d422d0a0ad00f3a5972fb4fdf67578e8d1dfb7c53d

data/Gemfile.lock

@@ -1,14 +1,15 @@
 PATH
   remote: .
   specs:
-    behave_fun (0.1.1)
+    behave_fun (0.2.3)
       activesupport (~> 6.0.0)
+      dry-types (~> 1.4.0)
       zeitwerk (~> 2.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3)
+    activesupport (6.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -16,9 +17,31 @@ GEM
       zeitwerk (~> 2.2, >= 2.2.2)
     concurrent-ruby (1.1.6)
     diff-lcs (1.3)
+    dry-configurable (0.11.5)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.0.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-types (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.0)
+    minitest (5.14.1)
     rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)

data/README.md

@@ -13,36 +13,43 @@ Main features:
 
 Add this line to your application's Gemfile:
 
-```ruby
+``` ruby
 gem 'behave_fun'
 ```
 
 And then execute:
 
+```
 $ bundle install
+```
 
 Or install it yourself as:
 
+```
 $ gem install behave_fun
+```
 
 ## Usage
 
 To build a behavior tree:
 
 ``` ruby
+builder = BehaveFun.build_builder {
+  # add_task_type YourCustomTask
+}
 # ruby dsl
-tree = BehaveFun.build_tree { success }
+tree = builder.build_tree { success }
 # from hash
-tree = BehaveFun.build_tree_from_hash(type: :success)
+tree = builder.build_tree_from_hash(type: :success)
 # from json
-tree = BehaveFun.build_tree_from_json(json_string)
+tree = builder.build_tree_from_json(json_string)
 ```
 
 To build a complex behavior tree:
 
 ``` ruby
 # write_spec, write_code, run_spec, git_push and release_gem are customized tasks
-tree = BehaveFun.build_tree {
+tree = builder.build_tree {
   sequence {
     until_success {
       sequence {
@@ -57,7 +64,7 @@ tree = BehaveFun.build_tree {
 }
 ```
 
-To create customized task, create a class that extends `BehaveFun::Task`. Don't forget call `running` `success` or `fail` in `#execute` method at the end.
+To create customized task, create a class that extends `BehaveFun::Task` (or use a lambda if only need to overwrite `#execute` method). Don't forget call `running` `success` or `fail` in `#execute` method at the end.
 
 ``` ruby
 # a task that increase data by 1, always success
@@ -66,18 +73,17 @@ class Counter < BehaveFun::Task
     context[:counter] += 1
     success
   end
-
-  add_to_task_builder
 end
 
 # a task that detect tree data is even or not
-class IsCounterEven < BehaveFun::Task
-  def execute
-    context[:counter].even? ? success : fail
-  end
+is_counter_even = -> { context[:counter].even? ? success : fail }
 
-  add_to_task_builder
-end
+# add these tasks to your builder
+builder = BehaveFun.build_builder {
+  add_task_type Counter
+  add_lambda_task_type :is_counter_even, &is_counter_even
+}
+builder.build_tree { counter }
 ```
 
 To run a tree:

data/behave_fun.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'zeitwerk', '~> 2.3.0'
   spec.add_dependency 'activesupport', '~> 6.0.0'
+  spec.add_dependency 'dry-types', '~> 1.4.0'
 end

data/lib/behave_fun.rb

@@ -9,29 +9,8 @@ loader.setup
 module BehaveFun
   module_function
 
-  def build_tree(&block)
-    builder = TaskBuilder.new(Tree.new)
-    builder.instance_eval(&block)
-    builder.control
-  end
-
-  def build_tree_from_hash(hash)
-    build_tree do
-      build_from_hash(hash[:root])
-    end
-  end
-
-  def build_tree_from_json(json)
-    hash = ActiveSupport::JSON.decode(json).deep_symbolize_keys
-    build_tree_from_hash(hash)
-  end
-
-  def as_json(tree)
-    tree.as_json
-  end
-
-  def to_json(tree)
-    ActiveSupport::JSON.encode(as_json(tree))
+  def build_builder(&block)
+    BehaveFun::TaskBuilderFactory.new(&block)
   end
 
   class Error < StandardError; end

data/lib/behave_fun/branch_tasks/dynamic_guard_selector.rb

@@ -10,6 +10,11 @@ module BehaveFun
       @current_child.run
     end
 
+    def start
+      super
+      @current_child = nil
+    end
+
     def child_running
       running
     end
@@ -21,7 +26,5 @@ module BehaveFun
     def child_fail
       fail
     end
-
-    add_to_task_builder
   end
 end

data/lib/behave_fun/branch_tasks/random_selector.rb

@@ -16,7 +16,5 @@ module BehaveFun
     def serializable_status_fields
       [:current_child_idx, :order]
     end
-
-    add_to_task_builder
   end
 end

data/lib/behave_fun/branch_tasks/random_sequence.rb

@@ -16,7 +16,5 @@ module BehaveFun
     def serializable_status_fields
       [:current_child_idx, :order]
     end
-
-    add_to_task_builder
   end
 end

data/lib/behave_fun/branch_tasks/selector.rb

@@ -31,7 +31,5 @@ module BehaveFun
     def serializable_status_fields
       [:current_child_idx]
     end
-
-    add_to_task_builder
   end
 end

data/lib/behave_fun/branch_tasks/sequence.rb

@@ -31,7 +31,5 @@ module BehaveFun
     def serializable_status_fields
       [:current_child_idx]
     end
-
-    add_to_task_builder
   end
 end

data/lib/behave_fun/decorators/always_fail.rb

@@ -3,7 +3,5 @@ module BehaveFun
     def child_success
       fail
     end
-
-    add_to_task_builder
   end
 end

data/lib/behave_fun/decorators/always_succeed.rb

@@ -3,7 +3,5 @@ module BehaveFun
     def child_fail
       success
     end
-
-    add_to_task_builder
   end
 end

data/lib/behave_fun/decorators/invert.rb

@@ -7,7 +7,5 @@ module BehaveFun
     def child_success
       fail
     end
-
-    add_to_task_builder
   end
 end

data/lib/behave_fun/decorators/repeat.rb

@@ -2,19 +2,16 @@ module BehaveFun
   class Decorators::Repeat < Decorator
     attr_accessor :counter
 
-    def initialize(times: )
-      super
-      @times = times
-    end
-
     def start
       super
       @counter = 0
     end
 
     def child_success
+      return @children[0].reset unless params[:times]
+
       @counter += 1
-      if @counter < @times
+      if @counter < params[:times]
         @children[0].reset
       else
         success
@@ -29,6 +26,12 @@ module BehaveFun
       [:counter]
     end
 
-    add_to_task_builder
+    def params=(params)
+      @params = ParamsSchema[params]
+    end
+
+    ParamsSchema = Types::Hash.schema(
+      times: Types::Coercible::Integer.optional.default(nil)
+    )
   end
 end

data/lib/behave_fun/decorators/until_fail.rb

@@ -3,7 +3,5 @@ module BehaveFun
     def child_fail
       success
     end
-
-    add_to_task_builder
   end
 end

data/lib/behave_fun/decorators/until_success.rb

@@ -3,7 +3,5 @@ module BehaveFun
     def child_success
       success
     end
-
-    add_to_task_builder
   end
 end

data/lib/behave_fun/leaf_tasks/failure.rb

@@ -3,7 +3,5 @@ module BehaveFun
     def execute
       fail
     end
-
-    add_to_task_builder
   end
 end

data/lib/behave_fun/leaf_tasks/success.rb

@@ -3,7 +3,5 @@ module BehaveFun
     def execute
       success
     end
-
-    add_to_task_builder
   end
 end

data/lib/behave_fun/leaf_tasks/wait.rb

@@ -2,18 +2,13 @@ module BehaveFun
   class LeafTasks::Wait < Task
     attr_accessor :counter
 
-    def initialize(duration: )
-      super
-      @duration = duration
-    end
-
     def start
       super
       @counter = 0
     end
 
     def execute
-      if @counter < @duration
+      if @counter < params[:duration]
         @counter += 1
         running
       else
@@ -25,6 +20,12 @@ module BehaveFun
       [:counter]
     end
 
-    add_to_task_builder
+    def params=(params)
+      @params = ParamsSchema[params]
+    end
+
+    ParamsSchema = Types::Hash.schema(
+      duration: Types::Coercible::Integer
+    )
   end
 end

data/lib/behave_fun/task.rb

@@ -2,11 +2,11 @@ module BehaveFun
   class Task
     include TaskSerializer
 
-    attr_accessor :control, :guard
-    attr_reader :context, :children, :params, :status
+    attr_accessor :control, :guard, :params
+    attr_reader :context, :children, :status
 
-    def initialize(**params)
-      @params = params
+    def initialize(params = {})
+      self.params = params
       @children = []
       @status = :fresh
     end
@@ -15,10 +15,6 @@ module BehaveFun
       name.demodulize.underscore
     end
 
-    def self.add_to_task_builder(name = task_name)
-      BehaveFun::TaskBuilder.add_task_type(self, name: name)
-    end
-
     def context=(context)
       @context = context
       children.each { _1.context = context }
@@ -119,5 +115,11 @@ module BehaveFun
       @status = :fresh
       children.each { |child| child.reset }
     end
+
+    def dup
+      cloned = self.class.new(params)
+      children.each { cloned.add_child(_1.dup) }
+      cloned
+    end
   end
 end

data/lib/behave_fun/task_builder_factory.rb

@@ -0,0 +1,132 @@
+module BehaveFun
+  class TaskBuilderFactory
+    attr_reader :tasks
+
+    def initialize(&block)
+      @tasks = {}
+
+      add_task_type BehaveFun::LeafTasks::Success
+      add_task_type BehaveFun::LeafTasks::Failure
+      add_task_type BehaveFun::LeafTasks::Wait
+      add_task_type BehaveFun::Decorators::AlwaysSucceed
+      add_task_type BehaveFun::Decorators::AlwaysFail
+      add_task_type BehaveFun::Decorators::UntilSuccess
+      add_task_type BehaveFun::Decorators::UntilFail
+      add_task_type BehaveFun::Decorators::Invert
+      add_task_type BehaveFun::Decorators::Repeat
+      add_task_type BehaveFun::BranchTasks::Sequence
+      add_task_type BehaveFun::BranchTasks::Selector
+      add_task_type BehaveFun::BranchTasks::RandomSequence
+      add_task_type BehaveFun::BranchTasks::RandomSelector
+      add_task_type BehaveFun::BranchTasks::DynamicGuardSelector
+
+      instance_eval(&block) if block_given?
+    end
+
+    def add_task_type(type, name: type.task_name)
+      tasks[name.to_sym] = type
+    end
+
+    def add_lambda_task_type(task_name, &block)
+      type = Class.new(Task) do
+        def name
+          task_name
+        end
+
+        define_method(:execute, &block)
+      end
+      tasks[task_name.to_sym] = type
+    end
+
+    def build_task(&block)
+      task = build_tree(&block).root
+      task.control = nil
+      task
+    end
+
+    def build_tree(&block)
+      builder = Builder.new(self, Tree.new)
+      builder.instance_eval(&block)
+      builder.control
+    end
+
+    def build_task_from_hash(hash)
+      hash = hash.deep_symbolize_keys
+      tree = build_tree do
+        build_from_hash(hash)
+      end
+      tree.root
+    end
+
+    def build_tree_from_hash(hash)
+      hash = hash.deep_symbolize_keys
+      build_tree do
+        build_from_hash(hash[:root])
+      end
+    end
+
+    def build_tree_from_json(json)
+      hash = ActiveSupport::JSON.decode(json).deep_symbolize_keys
+      build_tree_from_hash(hash)
+    end
+
+    def as_json(tree)
+      tree.as_json
+    end
+
+    def to_json(tree)
+      ActiveSupport::JSON.encode(as_json(tree))
+    end
+
+    class Builder
+      attr_reader :factory, :control
+
+      def initialize(factory, control)
+        @factory = factory
+        @control = control
+      end
+
+      def add_task(type, params = {}, &block)
+        task = type.new(params)
+        @control.add_child(task)
+
+        if block
+          builder = Builder.new(factory, task)
+          builder.instance_eval(&block)
+        end
+      end
+
+      def guard_with(&block)
+        builder = Builder.new(factory, Tree.new)
+        builder.instance_eval(&block)
+        control.guard = builder.control.root
+      end
+
+      def include(task)
+        cloned_task = task.dup
+        @control.add_child(cloned_task)
+      end
+
+      def build_from_hash(task_hash)
+        type_name, params, guard_with, children =
+          task_hash.values_at(:type, :params, :guard_with, :children)
+        params ||= {}
+        children ||= []
+        type = factory.tasks[type_name.to_sym]
+        add_task type, **params do
+          guard_with { build_from_hash(guard_with) } if guard_with
+          children.each { build_from_hash(_1) }
+        end
+      end
+
+      def method_missing(name, *args, &block)
+        type = factory.tasks[name.to_sym]
+        if type
+          add_task(type, *args, &block)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/behave_fun/tree.rb

@@ -1,6 +1,6 @@
 module BehaveFun
   class Tree < Task
-    attr_accessor :root
+    attr_reader :root
 
     def root=(root)
       @root = root
@@ -56,5 +56,11 @@ module BehaveFun
     def restore_status(data)
       root.restore_status(data)
     end
+
+    def dup
+      cloned = self.class.new(params)
+      cloned.root = root.dup
+      cloned
+    end
   end
 end

data/lib/behave_fun/types.rb

@@ -0,0 +1,7 @@
+require 'dry-types'
+
+module BehaveFun
+  module Types
+    include Dry.Types()
+  end
+end

data/lib/behave_fun/version.rb

@@ -1,3 +1,3 @@
 module BehaveFun
-  VERSION = '0.1.1'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: behave_fun
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.3
 platform: ruby
 authors:
 - ayaya zhao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-17 00:00:00.000000000 Z
+date: 2020-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 description: A behavior tree library for ruby.
 email:
 - ayaya.zhao@gmail.com
@@ -74,9 +88,10 @@ files:
 - lib/behave_fun/leaf_tasks/success.rb
 - lib/behave_fun/leaf_tasks/wait.rb
 - lib/behave_fun/task.rb
-- lib/behave_fun/task_builder.rb
+- lib/behave_fun/task_builder_factory.rb
 - lib/behave_fun/task_serializer.rb
 - lib/behave_fun/tree.rb
+- lib/behave_fun/types.rb
 - lib/behave_fun/version.rb
 homepage: https://github.com/ayamomiji/behave_fun
 licenses:

data/lib/behave_fun/task_builder.rb

@@ -1,48 +0,0 @@
-module BehaveFun
-  class TaskBuilder
-    attr_reader :control
-
-    def initialize(control)
-      @control = control
-    end
-
-    def add_task(type, **params, &block)
-      task = type.new(**params)
-      @control.add_child(task)
-
-      if block
-        builder = TaskBuilder.new(task)
-        builder.instance_eval(&block)
-      end
-    end
-
-    def guard_with(&block)
-      builder = TaskBuilder.new(Tree.new)
-      builder.instance_eval(&block)
-      control.guard = builder.control.root
-    end
-
-    def build_from_hash(task_hash)
-      type_name, params, guard_with, children =
-        task_hash.values_at(:type, :params, :guard_with, :children)
-      params ||= {}
-      children ||= []
-      type = self.class.tasks[type_name.to_sym]
-      add_task type, **params do
-        guard_with { build_from_hash(guard_with) } if guard_with
-        children.each { build_from_hash(_1) }
-      end
-    end
-
-    def self.tasks
-      @tasks ||= {}
-    end
-
-    def self.add_task_type(type, name: type.task_name)
-      tasks[name.to_sym] = type
-      define_method name do |params = {}, &block|
-        add_task(type, **params, &block)
-      end
-    end
-  end
-end