behavior_tree 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97c05c7c3c6b0316fe40d4bd20acd66189b3dc34265b45061ac87e7daabd1f15
-  data.tar.gz: 6a5ef7dfca3096d744a005aa9e6a60c9c932b69c77c05e63d18be882d010ee44
+  metadata.gz: 6eb178547f7b18faf513a60dc91f785a977e5fe7e2884d77ec8f365dd37e55da
+  data.tar.gz: 64e1f312b7028ec33749389e8ee13329c33712d35dc85afc9a0ebe84a5edf8a2
 SHA512:
-  metadata.gz: d1367b71529a3257493aa12ed119bb05901c5094b24042e9ee86a9ff8a1d422cd97649a7c226e6b88ad32efce17fd1d348864bd328907f0f7ecdb44279da30c8
-  data.tar.gz: 5cdc8673bb4927e399ac6a79938114cc26bd178e7fcef71d2b04bd4986728be735c5d3f08f5e5b97557ffd85ae02e24270612e754d61e652ef573cac7e917b82
+  metadata.gz: 2f553d35fc13a331543cd1df25a169f20c1bbf0cf8fef526b081e5243411087cd7a0f0cdc797e59e78e83cb070a228c98cbf21fe32cd3206162f9dda1ab8b0c2
+  data.tar.gz: 43e2ec00bf7cc6f860dc35852853fbb7e6ae879267ca2848acd7c7c8428c7fefbf6e60ec18f4f79db53cc3bf3623528a413224324cba8f57b1b027397af471c5

data/CODE_OF_CONDUCT.md

@@ -59,7 +59,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at felovilches@gmail.com.
+reported to the community leaders responsible for enforcement at developer@chrisvilches.com.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    behavior_tree (1.0.0)
+    behavior_tree (1.1.0)
       colorize (~> 0.8.1)
 
 GEM

data/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Felo Vilches
+Copyright (c) 2021 Chris Vilches
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -5,7 +5,11 @@
 A robust and customizable Ruby gem for creating Behavior Trees, used in games, AI, robotics, and more.
 
 <p align="center">
-  <img src="https://github.com/FeloVilches/ruby-behavior-tree/blob/main/assets/logo.png?raw=true" />
+  <img src="https://github.com/ChrisVilches/ruby-behavior-tree/blob/main/assets/logo.png?raw=true" />
+</p>
+
+<p align="center">
+  <img src="https://github.com/ChrisVilches/ruby-behavior-tree/blob/main/assets/tree_animation.gif?raw=true" />
 </p>
 
 ## Quick start
@@ -157,8 +161,8 @@ another_tree.print
   * [Custom condition](#custom-condition)
 - [Node API](#node-api)
   * [Status](#status)
-  * [tick!](#tick-)
-  * [halt!](#halt-)
+  * [tick!](#tick)
+  * [halt!](#halt)
   * [Status related callbacks and hooks](#status-related-callbacks-and-hooks)
 - [Add custom nodes to the DSL](#add-custom-nodes-to-the-dsl)
 - [Troubleshoot and debug your trees](#troubleshoot-and-debug-your-trees)
@@ -279,7 +283,7 @@ By default, there are two types of control nodes, and custom ones can be easily
   d. If child returns `failure`, then continue with the next child.
   e. If no node ever returned `success`, then return `failure`.
 
-[Learn about "halting nodes" and what it means.](#halt-)
+[Learn about "halting nodes" and what it means.](#halt)
 
 When a control node is ticked, by default it traverses children and ticks them using this logic:
 
@@ -796,7 +800,7 @@ my_tree.print
 The above code generates the following output:
 
 <p align="center">
-  <img src="https://github.com/FeloVilches/ruby-behavior-tree/blob/main/assets/printed_tree.jpg?raw=true" width="400"/>
+  <img src="https://github.com/ChrisVilches/ruby-behavior-tree/blob/main/assets/printed_tree.jpg?raw=true" width="400"/>
 </p>
 
 In the example above, you can see that the bottom nodes haven't been ticked at all. Node starvation might occur for various reasons, such as having a `force_failure` node as one of the children of a `sequence` (the nodes after the `force_failure` would all be prevented from executing).
@@ -836,7 +840,7 @@ Keep in mind this is only for development purposes, and the generated trees don'
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/FeloVilches/ruby-behavior-tree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/FeloVilches/ruby-behavior-tree/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/ChrisVilches/ruby-behavior-tree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ChrisVilches/ruby-behavior-tree/blob/main/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -845,4 +849,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Behavior Tree project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/FeloVilches/ruby-behavior-tree/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Behavior Tree project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ChrisVilches/ruby-behavior-tree/blob/main/CODE_OF_CONDUCT.md).

data/lib/behavior_tree/concerns/tree_structure/printer.rb

@@ -7,6 +7,10 @@ module BehaviorTree
     # Algorithm to print tree.
     module Printer
       def print
+        puts to_s
+      end
+
+      def to_s
         lines = []
         lines << '∅' # Style for the root node.
         lines += tree_lines
@@ -15,8 +19,7 @@ module BehaviorTree
         lines << uniq_nodes_string
         lines << size_string
         lines << tree_tick_count_string
-
-        puts lines.join "\n"
+        lines.join "\n"
       end
 
       private
@@ -34,7 +37,7 @@ module BehaviorTree
           space = (0...depth).map { |d| vertical_lines_continues.include?(d) ? '│     ' : '      ' }.join
           connector = last_child ? '└─' : '├─'
 
-          "#{space}#{connector}#{class_simple_name(node)} #{status_string(node)} #{tick_count_string(node)}"
+          "#{space}#{connector}#{resolve_display_name(node)} #{status_string(node)} #{tick_count_string(node)}"
         end
       end
 
@@ -83,22 +86,11 @@ module BehaviorTree
            .downcase
       end
 
-      def class_simple_name(node)
-        pretty_name snake_case(node.class.name.split('::').last)
-      end
-
-      # Changes the name of some classes (maps it to a better name).
-      # Mapping is simply based on taste.
-      def pretty_name(name)
-        case name
-        when 'task_base'
-          'task'
-        when 'force_success'
-          'forcesuccess'
-        when 'force_failure'
-          'forcefailure'
+      def resolve_display_name(node)
+        if node.respond_to?(:display_name)
+          node.display_name
         else
-          name
+          snake_case(node.class.name.split('::').last)
         end
       end
     end

data/lib/behavior_tree/decorator_nodes/force_failure.rb

@@ -4,6 +4,10 @@ module BehaviorTree
   module Decorators
     # Returns always failure when the child is not running.
     class ForceFailure < DecoratorBase
+      def display_name
+        'forcefailure'
+      end
+
       protected
 
       def status_map

data/lib/behavior_tree/decorator_nodes/force_success.rb

@@ -4,6 +4,10 @@ module BehaviorTree
   module Decorators
     # Returns always success when the child is not running.
     class ForceSuccess < DecoratorBase
+      def display_name
+        'forcesuccess'
+      end
+
       protected
 
       def status_map

data/lib/behavior_tree/tasks/task_base.rb

@@ -25,6 +25,10 @@ module BehaviorTree
       end
     end
 
+    def display_name
+      'task'
+    end
+
     private
 
     attr_reader :context

data/lib/behavior_tree/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: behavior_tree
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Felo Vilches
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-18 00:00:00.000000000 Z
+date: 2023-06-09 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: []
@@ -82,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
@@ -97,8 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: A robust and customizable Ruby gem for creating Behavior Trees.
 test_files: []