behavior_tree 0.1.7 → 1.0.0

data/lib/behavior_tree/control_nodes/control_node_base.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require_relative '../node_base'
-require_relative '../concerns/node_iterators/prioritize_running'
-require_relative '../concerns/node_iterators/all_nodes'
 
 module BehaviorTree
   # A node that has children (abstract class).

data/lib/behavior_tree/decorator_nodes/condition.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative './decorator_base'
-require_relative '../concerns/validations/proc_or_block'
 
 module BehaviorTree
   module Decorators

data/lib/behavior_tree/decorator_nodes/inverter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative './decorator_base'
-
 module BehaviorTree
   module Decorators
     # Returns the inverted child status.

data/lib/behavior_tree/decorator_nodes/repeat_times_base.rb

@@ -29,10 +29,6 @@ module BehaviorTree
         end
       end
 
-      def ensure_after_tick
-        status_map
-      end
-
       protected
 
       def repeat_while

data/lib/behavior_tree/decorator_nodes/repeater.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative './repeat_times_base'
-
 module BehaviorTree
   module Decorators
     # Repeat N times while child has success status.

data/lib/behavior_tree/errors.rb

@@ -62,4 +62,12 @@ module BehaviorTree
       super "Cannot register node '#{node_type}', it already exists."
     end
   end
+
+  # Exception for when the returned value in should_tick? is not a boolean.
+  class ShouldTickNotBooleanError < StandardError
+    def initialize(returned_value)
+      err = "Return of 'should_tick?' must be a boolean value. It returned #{returned_value} (#{returned_value.class})."
+      super err
+    end
+  end
 end

data/lib/behavior_tree/node_base.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-require_relative './concerns/tree_structure/algorithms'
-
 module BehaviorTree
   # A node (abstract class).
   class NodeBase
     include TreeStructure::Algorithms
-    attr_reader :status, :tick_count, :ticks_running, :arbitrary_storage
+    attr_reader :status, :prev_status, :tick_count, :ticks_running, :arbitrary_storage
 
     def initialize
       @status = NodeStatus.new NodeStatus::SUCCESS
+      @prev_status = NodeStatus.new NodeStatus::SUCCESS
+
       @tick_count = 0
       @ticks_running = 0
       @context = nil
 
-      @status.subscribe { |prev, curr| on_status_change(prev, curr) }
+      @status.subscribe { |prev| __on_status_change__(prev) }
 
       @arbitrary_storage = {}
     end
@@ -34,9 +34,10 @@ module BehaviorTree
 
     def tick!
       @tick_count += 1
-      @tick_prevented = !should_tick?
+      should_tick = should_tick?
+      raise ShouldTickNotBooleanError, should_tick unless [true, false].include? should_tick
 
-      unless @tick_prevented
+      unless (@tick_prevented = !should_tick)
         status.running!
         on_tick
         @ticks_running += 1
@@ -49,6 +50,9 @@ module BehaviorTree
       #
       #       This error can be replicated by pasting a valid status object in IRB, such as by doing:
       #       BehaviorTree.const_get(:NodeStatus).new(:__running__) # Valid, but IRB crashes.
+      #
+      #       Ruby 3.0.0 -> Crash
+      #       Ruby 2.7.0 -> OK
       nil
     end
 
@@ -100,18 +104,26 @@ module BehaviorTree
 
     def on_finished_running; end
 
+    def on_status_change; end
+
     private
 
-    # Always prev != curr (states that are set to the same aren't notified).
+    # Always prev != current (states that are set to the same aren't notified).
     # The fact that it's set to 0 means that setting to running must be done before
     # increasing the counts (so that @ticks_running becomes 1 after the whole tick lifecycle).
-    def on_status_change(prev, curr)
-      if prev == NodeStatus::RUNNING
+    # This is the non custom on_status_change. Users are expected to override the one without
+    # double underscore if they want to execute custom logic.
+    def __on_status_change__(prev)
+      prev_status.set(prev)
+
+      if prev_status.running?
         on_finished_running
-      elsif curr == NodeStatus::RUNNING
+      elsif status.running?
         @ticks_running = 0
         on_started_running
       end
+
+      on_status_change
     end
   end
 

data/lib/behavior_tree/node_status.rb

@@ -20,7 +20,7 @@ module BehaviorTree
       @value = value
 
       # NOTE: Make sure to notify after having set the @value above, so that the new status is already set.
-      @subscriber&.(prev, value)
+      @subscriber&.(prev)
     end
 
     def subscribe(&subscriber)

data/lib/behavior_tree/single_child_node.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative './node_base'
-require_relative './concerns/validations/single_child'
-
 module BehaviorTree
   # A node that has a single child (abstract class).
   class SingleChildNodeBase < NodeBase

data/lib/behavior_tree/tasks/task_base.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../node_base'
-require_relative '../concerns/validations/proc_or_block'
-
 module BehaviorTree
   # A task (leaf) node.
   class TaskBase < NodeBase

data/lib/behavior_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BehaviorTree
-  VERSION = '0.1.7'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: behavior_tree
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Felo Vilches
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
-description: 
+description:
 email:
 - felovilches@gmail.com
 executables: []
@@ -48,7 +48,10 @@ files:
 - lib/behavior_tree/builder.rb
 - lib/behavior_tree/concerns/dsl/dsl.yml
 - lib/behavior_tree/concerns/dsl/initial_config.rb
+- lib/behavior_tree/concerns/dsl/randomizer.rb
+- lib/behavior_tree/concerns/dsl/registration.rb
 - lib/behavior_tree/concerns/dsl/spell_checker.rb
+- lib/behavior_tree/concerns/dsl/utils.rb
 - lib/behavior_tree/concerns/node_iterators/all_nodes.rb
 - lib/behavior_tree/concerns/node_iterators/prioritize_running.rb
 - lib/behavior_tree/concerns/tree_structure/algorithms.rb
@@ -79,7 +82,7 @@ homepage: https://github.com/FeloVilches/Ruby-Behavior-Tree
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,8 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: Behavior Tree (AI) library for Ruby.
+summary: A robust and customizable Ruby gem for creating Behavior Trees.
 test_files: []