behave_fun 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b98bf7be91dd32a369c4d44b7b24fa889a795eecce544e2f9ff1e061dcd9d1b9
-  data.tar.gz: 79a1c994205b9161b1ca79529740a465e189dbab64d5819617dd42541753698b
+  metadata.gz: fa6285d17ba7200bca3e11fb9cdb7c6fb538a7461f8cb2d9c4496e5a1f885a90
+  data.tar.gz: 196808930dec23a365d3825da90c20e85e3a4f780a3857b67f768f718595a4fb
 SHA512:
-  metadata.gz: 8d9b5140ad575eff28249a80b3ef03ed56b5d21fabce0a2c941122697832d5f323de817b4176de3a7d9896ac5dfbf450ef39742e5e5f6ac925c1fa2d3a76ffac
-  data.tar.gz: 948a0acfc738d0536eb3c8ea6414a421f4d9faa86539e0d7e02b9991b8594ea5477fa33dcb04799ef9dec8118c017117852b714ce2a4d367bf1d38529282d100
+  metadata.gz: f1cd5d323dfd2db92b4d9ac41b12cabf14ac9a56a14a317db64f32b23513f92ce0ce31285881d3e2feb0560603627891d392534ffec63ba378303eae244738fc
+  data.tar.gz: '01139c43255bb5130e327d2152b42964266adac83752314de0923898f2eb543b438e306a0027321b0139b120c2ac06fb6f0aa17138e8f2957df0b70fc36001f8'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    behave_fun (0.1.0)
+    behave_fun (0.1.1)
       activesupport (~> 6.0.0)
       zeitwerk (~> 2.3.0)
 

data/README.md

@@ -2,6 +2,8 @@
 
 BehaveFun is a behavior tree library for Ruby.
 
+Inspired by [gdx-ai's behavior trees](https://github.com/libgdx/gdx-ai/wiki/Behavior-Trees).
+
 Main features:
 
 * Build behavior tree from Ruby and JSON.
@@ -17,80 +19,80 @@ gem 'behave_fun'
 
 And then execute:
 
-    $ bundle install
+$ bundle install
 
 Or install it yourself as:
 
-    $ gem install behave_fun
+$ gem install behave_fun
 
 ## Usage
 
 To build a behavior tree:
 
 ``` ruby
-    # ruby dsl
-    tree = BehaveFun.build_tree { success }
-    # from hash
-    tree = BehaveFun.build_tree_from_hash(type: :success)
-    # from json
-    tree = BehaveFun.build_tree_from_json(json_string)
+# ruby dsl
+tree = BehaveFun.build_tree { success }
+# from hash
+tree = BehaveFun.build_tree_from_hash(type: :success)
+# from json
+tree = BehaveFun.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 {
+# write_spec, write_code, run_spec, git_push and release_gem are customized tasks
+tree = BehaveFun.build_tree {
+  sequence {
+    until_success {
       sequence {
-        until_success {
-          sequence {
-            write_spec
-            write_code
-            run_spec
-          }
-        }
-        git_push
-        release_gem
+        write_spec
+        write_code
+        run_spec
       }
     }
+    git_push
+    release_gem
+  }
+}
 ```
 
 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.
 
 ``` ruby
-    # a task that increase data by 1, always success
-    class Counter < BehaveFun::Task
-      def execute
-        tree.data += 1
-        success
-      end
-
-      add_to_task_builder
-    end
-
-    # a task that detect tree data is even or not
-    class IsCounterEven < BehaveFun::Task
-      def execute
-        tree.data.even? ? success : fail
-      end
-
-      add_to_task_builder
-    end
+# a task that increase data by 1, always success
+class Counter < BehaveFun::Task
+  def execute
+    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
+
+  add_to_task_builder
+end
 ```
 
 To run a tree:
 
 ``` ruby
-    tree.data = { ... } # provide your data (context) for the tree
-    tree.run
-    tree.status # :running, :succeeded or :failed
+tree.context = { ... } # provide your context (data) for the tree
+tree.run
+tree.status # :running, :succeeded or :failed
 ```
 
 To dump and restore status:
 
 ``` ruby
-    status = tree.dump_status 
-    tree.restore_status(status)
+status = tree.dump_status # a hash that contains entire tree's status
+tree.restore_status(status)
 ```
 
 For more detail, see spec examples.

data/lib/behave_fun/task.rb

@@ -2,8 +2,8 @@ module BehaveFun
   class Task
     include TaskSerializer
 
-    attr_accessor :guard
-    attr_reader :tree, :control, :children, :params, :status
+    attr_accessor :control, :guard
+    attr_reader :context, :children, :params, :status
 
     def initialize(**params)
       @params = params
@@ -19,9 +19,9 @@ module BehaveFun
       BehaveFun::TaskBuilder.add_task_type(self, name: name)
     end
 
-    def control=(control)
-      @control = control
-      @tree = control.tree
+    def context=(context)
+      @context = context
+      children.each { _1.context = context }
     end
 
     def running
@@ -71,7 +71,7 @@ module BehaveFun
     def guard_passed?
       return true unless guard
 
-      guard.data = tree.data
+      guard.context = context
       guard.reset
       guard.run
 

data/lib/behave_fun/tree.rb

@@ -1,6 +1,6 @@
 module BehaveFun
   class Tree < Task
-    attr_accessor :root, :data
+    attr_accessor :root
 
     def root=(root)
       @root = root
@@ -11,6 +11,11 @@ module BehaveFun
       self
     end
 
+    def context=(context)
+      @context = context
+      @root.context = context
+    end
+
     def execute
       root.run
     end

data/lib/behave_fun/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: behave_fun
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - ayaya zhao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk