draco 0.3.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24b415a62db03c702026f0187df6c129b943019202a4177203e99394b5b6fad4
-  data.tar.gz: 6d89ccb9181612137bdc204236868b302da02b97bcf3326f3344dfce20414610
+  metadata.gz: 9c330a2195d1f7b17f0bb1be16914cef57ccfcf5094ed034cf50a64a3abae52a
+  data.tar.gz: efa72ad0c7facd4c3143f858a07adc5be8e6b225635d54b4b60fc983343f33be
 SHA512:
-  metadata.gz: c706c0c1fdc2dd4597f325832897525d4af62d20bc359043b98dd83690155dad2f8f0f1c4b49d634eafb9a99e462407d2718e4bfe64684c42417c83b91e38f32
-  data.tar.gz: 67b097a938524b0d065876c85dd66083c31d8b2c835b8329113950c29930a7ac82ddea396e7eaa6b6b583a601ec2e7d20885afe8e8e4841215a635b72b3292d6
+  metadata.gz: b5223959feeb20099bca35233f704b91270757ed33d1f59cd3091e6ea8793bb28a3cc4467670ac305931f85c5bb12fe036ac2ae2655aa8c597e5d02ff3d19993
+  data.tar.gz: cb182bfbcbe2b69fc5a84adf2aceabc1dddc7d75c2159cb4b13fcfb4f3f3ead4659dd1d6e114152c8ba61c8d8100672fa2672b65b267feb413ff0aece91caf42

data/.github/workflows/ruby.yml

@@ -22,8 +22,7 @@ jobs:
       - name: Set up Ruby
         # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
         # change this to (see https://github.com/ruby/setup-ruby#versioning):
-        # uses: ruby/setup-ruby@v1
-        uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
       - name: Install dependencies

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.vscode/

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
   NewCops: enable
   Exclude:
     - "benchmark.rb"
+    - "samples/**/*.rb"
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+## 0.6.0
+
+Features:
+
+  - `#serialize` now includes the class name for Entities, Components, and Systems.
+  - Added callbacks to Entities, Components, Systems and Worlds to better enable plugins.
+  - Added a sample plugin to `lib/draco/benchmark.rb` to benchmark your systems.
+
+    How to use:
+
+    ```ruby
+    class World < Draco::World
+      include Draco::Benchmark
+    end
+
+    world.system_timers
+    # => { :system => 0.001 }
+    ```
+
+## 0.5.1 (December 31, 2020)
+
+Features:
+
+  - Add an alias to `Draco::Tag` in Entities and Systems.
+
+## 0.5.0 (December 31, 2020)
+
+Features:
+
+  - Add `Draco::Tag` to easily define tag components [#6](https://github.com/guitsaru/draco/pull/6)

data/Gemfile.lock

@@ -3,43 +3,45 @@ GEM
   specs:
     ast (2.4.1)
     diff-lcs (1.4.4)
-    docile (1.3.2)
-    parallel (1.19.2)
-    parser (2.7.2.0)
+    docile (1.3.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (12.3.3)
-    regexp_parser (1.8.2)
+    regexp_parser (2.0.3)
     rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
+    rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rubocop (1.2.0)
+    rspec-support (3.10.1)
+    rubocop (1.7.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.0.1)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.1.1)
+    rubocop-ast (1.4.0)
       parser (>= 2.7.1.5)
-    ruby-progressbar (1.10.1)
-    simplecov (0.19.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -52,4 +54,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/README.md

@@ -6,12 +6,39 @@ An Entity Component System is an architectural framework that decouples game obj
 build game objects through composition. This allows you to easily share small logic components between different game
 objects.
 
+## Sample Application
+
+This repository includes sample applications in the `samples/` directory.
+
+* teeny-tiny - A 20 second space shooter created during the DragonRuby TeenyTiny Game Jam
+* gorillas-basic - A recreation of the gorillas_basic sample game that comes with DragonRuby
+
+### Running the sample application
+
+1. Download the [latest release](https://github.com/guitsaru/draco/archive/main.zip) of this repository.
+2. Create a copy of DragonRuby GTK in a new folder.
+3. Copy the teeny-tiny directory from draco into your new DragonRuby GTK folder. `cp -r draco/samples/ dragonruby/`.
+4. Run them using `./dragonruby teeny-tiny` or `./dragonruby gorillas-basic`.
+
 ## Installation
 
 1. Create a `lib` directory inside your game's `app` directory.
 2. Copy `lib/draco.rb` into your new `lib` directory.
 3. In your `main.rb` file, require `app/lib/draco.rb`.
 
+## Support
+
+- Find a bug? [Open an issue](https://github.com/guitsaru/draco/issues).
+- Need help? [Start a Discussion](https://github.com/guitsaru/draco/discussions) or [Join us in Discord: Channel #oss-draco](https://discord.gg/vPUNtwfm).
+
+## Versioning
+
+Draco uses [https://semver.org/].
+
+* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
 ## Usage
 
 ### Components
@@ -23,7 +50,7 @@ These can be shared across many different types of game objects.
 class Visible < Draco::Component; end
 ```
 
-`Visible` is an example of a label component. An entity either has it, or it doesn't. We can also associate data with our
+`Visible` is an example of a tag component. An entity either has it, or it doesn't. We can also associate data with our
 components.
 
 ```ruby
@@ -44,6 +71,16 @@ component.x
 # => 110
 ```
 
+#### Tag Components
+
+The `Visible` class above is an example of a tag component. These are common enough that we don't necessarily want to
+define a bunch of empty component classes. Draco provides a way to generate these classes at runtime.
+
+```ruby
+Draco::Tag(:visible)
+# => Visible
+```
+
 ### Entities
 
 Entities are independant game objects. They consist of a unique id and a list of components.
@@ -58,7 +95,7 @@ Often we have types of entities that are reused throughout the game. We can defi
 ```ruby
 class Goblin < Draco::Entity
   component Position, x: 50, y: 50
-  component Visible
+  component Tag(:visible)
 end
 
 goblin = Goblin.new
@@ -89,7 +126,7 @@ entities that include all of the given components.
 
 ```ruby
 class RenderSpriteSystem < Draco::System
-  filter Visible, Position, Sprite
+  filter Tag(:visible), Position, Sprite
 
   def tick(args)
     # You can also access the world that called the system.
@@ -150,6 +187,19 @@ player entity has been given the name `player`. We can now access this directly
 world.player
 ```
 
+### Fetching entities by id
+
+In some cases you'll want to keep track of entities by their id, such as when you want to keep track of another entity in a component.
+
+```ruby
+entity = Player.new
+entity.id
+# => 12
+
+world.entities[12] == entity
+# => true
+```
+
 ## Learn More
 
 Here are some good resources to learn about Entity Component Systems
@@ -161,6 +211,8 @@ Here are some good resources to learn about Entity Component Systems
 
 Draco is licensed under AGPL. You can purchase the right to use Draco under the [commercial license](https://github.com/guitsaru/draco/blob/master/COMM-LICENSE).
 
+Each purchase comes with free upgrades for the current major version of Draco.
+
 <a class="gumroad-button" href="https://guitsaru.itch.io/draco" target="_blank">Purchase Commercial License</a>
 
 ## Development

data/draco.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|samples)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/draco.rb

@@ -4,8 +4,10 @@
 #
 # An Entity Component System is an architectural pattern used in game development to decouple behavior from objects.
 module Draco
+  class NotAComponentError < StandardError; end
+
   # Public: The version of the library. Draco uses semver to version releases.
-  VERSION = "0.3.2"
+  VERSION = "0.6.0"
 
   # Public: A general purpose game object that consists of a unique id and a collection of Components.
   class Entity
@@ -39,6 +41,15 @@ module Draco
       @default_components[component] = defaults
     end
 
+    # Public: Creates a tag Component. If the tag already exists, return it.
+    #
+    # name - The string or symbol name of the component.
+    #
+    # Returns a class with subclass Draco::Component.
+    def self.Tag(name) # rubocop:disable Naming/MethodName
+      Draco::Tag(name)
+    end
+
     class << self
       # Internal: Returns the default components for the class.
       attr_reader :default_components
@@ -64,15 +75,33 @@ module Draco
     def initialize(args = {})
       @id = args.fetch(:id, @@next_id)
       @@next_id = [@id + 1, @@next_id].max
-      @components = ComponentStore.new(self)
       @subscriptions = []
 
+      setup_components(args)
+      after_initialize
+    end
+
+    # Internal: Sets up the default components for the class.
+    #
+    # args - A hash of arguments to pass into the generated components.
+    #
+    # Returns nothing.
+    def setup_components(args)
+      @components = ComponentStore.new(self)
+
       self.class.default_components.each do |component, default_args|
         arguments = default_args.merge(args[Draco.underscore(component.name.to_s).to_sym] || {})
         @components << component.new(arguments)
       end
     end
 
+    # Public: Callback run after the entity is initialized.
+    #
+    # This is empty by default but is present to allow plugins to tie into.
+    #
+    # Returns nothing.
+    def after_initialize; end
+
     # Public: Subscribe to an Entity's Component updates.
     #
     # subscriber - The object to notify when Components change.
@@ -82,18 +111,49 @@ module Draco
       @subscriptions << subscriber
     end
 
-    # Internal: Notifies subscribers that components have been updated.
+    # Public: Callback run before a component is added.
     #
-    # Returns nothing.
-    def components_updated
-      @subscriptions.each { |sub| sub.entity_updated(self) }
+    # component - The component that will be added.
+    #
+    # Returns the component to add.
+    def before_component_added(component)
+      component
+    end
+
+    # Public: Callback run after a component is added.
+    #
+    # component - The component that was added.
+    #
+    # Returns the added component.
+    def after_component_added(component)
+      @subscriptions.each { |sub| sub.component_added(self, component) }
+      component
+    end
+
+    # Public: Callback run before a component is deleted.
+    #
+    # component - The component that will be removed.
+    #
+    # Returns the component to remove.
+    def before_component_removed(component)
+      component
+    end
+
+    # Public: Callback run after a component is deleted.
+    #
+    # component - The component that was removed.
+    #
+    # Returns the removed component.
+    def after_component_removed(component)
+      @subscriptions.each { |sub| sub.component_removed(self, component) }
+      component
     end
 
     # Public: Serializes the Entity to save the current state.
     #
     # Returns a Hash representing the Entity.
     def serialize
-      serialized = { id: id }
+      serialized = { class: self.class.name.to_s, id: id }
 
       components.each do |component|
         serialized[Draco.underscore(component.class.name.to_s).to_sym] = component.serialize
@@ -165,7 +225,6 @@ module Draco
       def <<(*components)
         components.flatten.each { |component| add(component) }
 
-        @parent.components_updated
         self
       end
 
@@ -186,10 +245,16 @@ module Draco
       #
       # Returns the ComponentStore.
       def add(component)
+        unless component.is_a?(Draco::Component)
+          message = component.is_a?(Class) ? " You might need to initialize the component before you add it." : ""
+          raise Draco::NotAComponentError, "The given value is not a component.#{message}"
+        end
+
+        component = @parent.before_component_added(component)
         name = Draco.underscore(component.class.name.to_s).to_sym
         @components[name] = component
+        @parent.after_component_added(component)
 
-        @parent.components_updated
         self
       end
 
@@ -201,10 +266,11 @@ module Draco
       #
       # Returns the ComponentStore.
       def delete(component)
+        component = @parent.before_component_removed(component)
         name = Draco.underscore(component.class.name.to_s).to_sym
         @components.delete(name)
+        @parent.after_component_removed(component)
 
-        @parent.components_updated
         self
       end
 
@@ -255,6 +321,15 @@ module Draco
       attr_reader :attribute_options
     end
 
+    # Public: Creates a tag Component. If the tag already exists, return it.
+    #
+    # name - The string or symbol name of the component.
+    #
+    # Returns a class with subclass Draco::Component.
+    def self.Tag(name) # rubocop:disable Naming/MethodName
+      Draco::Tag(name)
+    end
+
     # Public: Initializes a new Component.
     #
     # values - The Hash of values to set for the Component instance (default: {}).
@@ -273,13 +348,21 @@ module Draco
         value = values.fetch(name.to_sym, options[:default])
         instance_variable_set("@#{name}", value)
       end
+      after_initialize
     end
 
+    # Public: Callback run after the component is initialized.
+    #
+    # This is empty by default but is present to allow plugins to tie into.
+    #
+    # Returns nothing.
+    def after_initialize; end
+
     # Public: Serializes the Component to save the current state.
     #
     # Returns a Hash representing the Component.
     def serialize
-      attrs = {}
+      attrs = { class: self.class.name.to_s }
 
       instance_variables.each do |attr|
         name = attr.to_s.gsub("@", "").to_sym
@@ -300,6 +383,20 @@ module Draco
     end
   end
 
+  # Public: Creates a new empty component at runtime. If the given Class already exists, it reuses the existing Class.
+  #
+  # name - The symbol or string name of the component. It can be either camelcase or underscored.
+  #
+  # Returns a Class with superclass of Draco::Component.
+  def self.Tag(name) # rubocop:disable Naming/MethodName
+    klass_name = camelize(name)
+
+    return Object.const_get(klass_name) if Object.const_defined?(klass_name)
+
+    klass = Class.new(Component)
+    Object.const_set(klass_name, klass)
+  end
+
   # Public: Systems contain the logic of the game.
   # The System runs on each tick and manipulates the Entities in the World.
   class System
@@ -332,6 +429,15 @@ module Draco
       sub.instance_variable_set(:@filter, [])
     end
 
+    # Public: Creates a tag Component. If the tag already exists, return it.
+    #
+    # name - The string or symbol name of the component.
+    #
+    # Returns a class with subclass Draco::Component.
+    def self.Tag(name) # rubocop:disable Naming/MethodName
+      Draco::Tag(name)
+    end
+
     # Public: Initializes a new System.
     #
     # entities - The Entities to operate on (default: []).
@@ -339,8 +445,37 @@ module Draco
     def initialize(entities: [], world: nil)
       @entities = entities
       @world = world
+      after_initialize
+    end
+
+    # Public: Callback run after the system is initialized.
+    #
+    # This is empty by default but is present to allow plugins to tie into.
+    #
+    # Returns nothing.
+    def after_initialize; end
+
+    # Public: Runs the system tick function.
+    #
+    # context - The context object of the current tick from the game engine. In DragonRuby this is `args`.
+    #
+    # Returns nothing.
+    def call(context)
+      before_tick(context)
+      tick(context)
+      after_tick(context)
+      self
     end
 
+    # Public: Callback run before #tick is called.
+    #
+    # This is empty by default but is present to allow plugins to tie into.
+    #
+    # context - The context object of the current tick from the game engine. In DragonRuby this is `args`.
+    #
+    # Returns nothing.
+    def before_tick(context); end
+
     # Public: Runs the System logic for the current game engine tick.
     #
     # This is where the logic is implemented and it should be overriden for each System.
@@ -350,11 +485,19 @@ module Draco
     # Returns nothing
     def tick(context); end
 
+    # Public: Callback run after #tick is called.
+    #
+    # This is empty by default but is present to allow plugins to tie into.
+    #
+    # Returns nothing.
+    def after_tick(context); end
+
     # Public: Serializes the System to save the current state.
     #
     # Returns a Hash representing the System.
     def serialize
       {
+        class: self.class.name.to_s,
         entities: entities.map(&:serialize),
         world: world ? world.serialize : nil
       }
@@ -373,7 +516,7 @@ module Draco
 
   # Public: The container for current Entities and Systems.
   class World
-    @default_entities = {}
+    @default_entities = []
     @default_systems = []
 
     # Internal: Resets the default components for each class that inherites Entity.
@@ -383,7 +526,7 @@ module Draco
     # Returns nothing.
     def self.inherited(sub)
       super
-      sub.instance_variable_set(:@default_entities, {})
+      sub.instance_variable_set(:@default_entities, [])
       sub.instance_variable_set(:@default_systems, [])
     end
 
@@ -401,7 +544,7 @@ module Draco
     # Returns nothing.
     def self.entity(entity, defaults = {})
       name = defaults[:as]
-      @default_entities[entity] = defaults
+      @default_entities.push([entity, defaults])
 
       attr_reader(name.to_sym) if name
     end
@@ -440,7 +583,8 @@ module Draco
     # entities - The Array of Entities for the World (default: []).
     # systems - The Array of System Classes for the World (default: []).
     def initialize(entities: [], systems: [])
-      default_entities = self.class.default_entities.map do |klass, attributes|
+      default_entities = self.class.default_entities.map do |default|
+        klass, attributes = default
         name = attributes[:as]
         entity = klass.new(attributes)
         instance_variable_set("@#{name}", entity) if name
@@ -448,8 +592,29 @@ module Draco
         entity
       end
 
-      @entities = EntityStore.new(default_entities + entities)
+      @entities = EntityStore.new(self, default_entities + entities)
       @systems = self.class.default_systems + systems
+      after_initialize
+    end
+
+    # Public: Callback run after the world is initialized.
+    #
+    # This is empty by default but is present to allow plugins to tie into.
+    #
+    # Returns nothing.
+    def after_initialize; end
+
+    # Public: Callback run before #tick is called.
+    #
+    # context - The context object of the current tick from the game engine. In DragonRuby this is `args`.
+    #
+    # Returns the systems to run during this tick.
+    def before_tick(_context)
+      systems.map do |system|
+        entities = filter(system.filter)
+
+        system.new(entities: entities, world: self)
+      end
     end
 
     # Public: Runs all of the Systems every tick.
@@ -458,13 +623,39 @@ module Draco
     #
     # Returns nothing
     def tick(context)
-      systems.each do |system|
-        entities = filter(system.filter)
-
-        system.new(entities: entities, world: self).tick(context)
+      results = before_tick(context).map do |system|
+        system.call(context)
       end
+
+      after_tick(context, results)
     end
 
+    # Public: Callback run after #tick is called.
+    #
+    # This is empty by default but is present to allow plugins to tie into.
+    #
+    # context - The context object of the current tick from the game engine. In DragonRuby this is `args`.
+    # results - The System instances that were run.
+    #
+    # Returns nothing.
+    def after_tick(context, results); end
+
+    # Public: Callback to run when a component is added to an existing Entity.
+    #
+    # entity - The Entity the Component was added to.
+    # component - The Component that was added to the Entity.
+    #
+    # Returns nothing.
+    def component_added(entity, component); end
+
+    # Public: Callback to run when a component is added to an existing Entity.
+    #
+    # entity - The Entity the Component was removed from.
+    # component - The Component that was removed from the Entity.
+    #
+    # Returns nothing.
+    def component_removed(entity, component); end
+
     # Public: Finds all Entities that contain all of the given Components.
     #
     # components - An Array of Component classes to match.
@@ -479,6 +670,7 @@ module Draco
     # Returns a Hash representing the World.
     def serialize
       {
+        class: self.class.name.to_s,
         entities: @entities.map(&:serialize),
         systems: @systems.map { |system| system.name.to_s }
       }
@@ -498,28 +690,45 @@ module Draco
     class EntityStore
       include Enumerable
 
+      attr_reader :parent
+
       # Internal: Initializes a new EntityStore
       #
       # entities - The Entities to add to the EntityStore
-      def initialize(*entities)
+      def initialize(parent, *entities)
+        @parent = parent
         @entity_to_components = Hash.new { |hash, key| hash[key] = Set.new }
         @component_to_entities = Hash.new { |hash, key| hash[key] = Set.new }
+        @entity_ids = {}
 
         self << entities
       end
 
-      # Internal: Gets all Entities that implement all of the given Components
+      # Internal: Gets all Entities that implement all of the given Components or that match the given entity ids.
       #
-      # components - The Component Classes to filter by
+      # components_or_ids - The Component Classes to filter by
       #
       # Returns a Set list of Entities
-      def [](*components)
-        components
+      def [](*components_or_ids)
+        components_or_ids
           .flatten
-          .map { |component| @component_to_entities[component] }
+          .map { |component_or_id| select_entities(component_or_id) }
           .reduce { |acc, i| i & acc }
       end
 
+      # Internal: Gets entities by component or id.
+      #
+      # component_or_id - The Component Class or entity id to select.
+      #
+      # Returns an Array of Entities.
+      def select_entities(component_or_id)
+        if component_or_id.is_a?(Numeric)
+          Array(@entity_ids[component_or_id])
+        else
+          @component_to_entities[component_or_id]
+        end
+      end
+
       # Internal: Adds Entities to the EntityStore
       #
       # entities - The Entity or Array list of Entities to add to the EntityStore.
@@ -538,12 +747,12 @@ module Draco
       def add(entity)
         entity.subscribe(self)
 
+        @entity_ids[entity.id] = entity
         components = entity.components.map(&:class)
         @entity_to_components[entity].merge(components)
 
-        components.each do |component|
-          @component_to_entities[component].add(entity)
-        end
+        components.each { |component| @component_to_entities[component].add(entity) }
+        entity.components.each { |component| @parent.component_added(entity, component) }
 
         self
       end
@@ -554,6 +763,7 @@ module Draco
       #
       # Returns the EntityStore
       def delete(entity)
+        @entity_ids.delete(entity.id)
         components = Array(@entity_to_components.delete(entity))
 
         components.each do |component|
@@ -571,21 +781,26 @@ module Draco
         @entity_to_components.keys.each(&block)
       end
 
-      # Internal: Updates the EntityStore when an Entity's Components are modified.
+      # Internal: Updates the EntityStore when an Entity's Components are added.
       #
-      # entity - The Entity whose Components were updated.
+      # entity - The Entity the Component was added to.
+      # component - The Component that was added to the Entity.
       #
       # Returns nothing.
-      def entity_updated(entity)
-        old = @entity_to_components[entity].to_a
-        components = entity.components.map(&:class)
-        @entity_to_components[entity] = components
-
-        added = components - old
-        deleted = old - components
+      def component_added(entity, component)
+        @component_to_entities[component.class].add(entity)
+        @parent.component_added(entity, component)
+      end
 
-        added.each { |component| @component_to_entities[component].add(entity) }
-        deleted.each { |component| @component_to_entities[component].delete(entity) }
+      # Internal: Updates the EntityStore when an Entity's Components are removed.
+      #
+      # entity - The Entity the Component was removed from.
+      # component - The Component that was removed from the Entity.
+      #
+      # Returns nothing.
+      def component_removed(entity, component)
+        @component_to_entities[component.class].delete(entity)
+        @parent.component_removed(entity, component)
       end
     end
   end
@@ -706,13 +921,36 @@ module Draco
   #
   # Returns a String.
   def self.underscore(string)
-    string.split("::").last.bytes.map.with_index do |byte, i|
+    string.to_s.split("::").last.bytes.map.with_index do |byte, i|
       if byte > 64 && byte < 97
-        downcased = byte + 32 # gemspec
+        downcased = byte + 32
         i.zero? ? downcased.chr : "_#{downcased.chr}"
       else
         byte.chr
       end
     end.join
   end
+
+  # Internal: Converts an underscored string into a camel case string.
+  #
+  # Examples
+  #
+  #   camlize("camel_case")
+  #   # => "CamelCase"
+  #
+  # Returns a string.
+  def self.camelize(string) # rubocop:disable Metrics/MethodLength
+    modifier = -32
+
+    string.to_s.bytes.map do |byte|
+      if byte == 95
+        modifier = -32
+        nil
+      else
+        char = (byte + modifier).chr
+        modifier = 0
+        char
+      end
+    end.compact.join
+  end
 end

data/lib/draco/benchmark.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Draco
+  # Public: Calculates the average time of
+  module Benchmark
+    def self.included(mod)
+      mod.prepend(World)
+    end
+
+    # Internal: Plugin implementation for World.
+    module World
+      def before_tick(context)
+        super
+        @system_timer_data = Hash.new { |h, k| h[k] = [] }
+        @systems.each { |system| system.prepend(System) }
+      end
+
+      def after_tick(context, results)
+        super
+        results.each do |system|
+          name = Draco.underscore(system.class.name.to_s).to_sym
+          @system_timer_data[name] = (system.timer * 1000.0).round(5)
+        end
+      end
+
+      def system_timers
+        @system_timer_data.sort_by { |_k, v| -v }.to_h
+      end
+    end
+
+    # Internal: Plugin implementation for System.
+    module System
+      def after_initialize
+        super
+        @timer = 0
+      end
+
+      def before_tick(context)
+        super
+        @start_time = Time.now
+      end
+
+      def after_tick(context)
+        super
+        @timer = Time.now - @start_time
+      end
+
+      def timer
+        @timer
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: draco
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Matt Pruitt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-22 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies: []
 description: A library for Entities, Components, and Systems in games.
 email:
@@ -22,6 +22,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - COMM-LICENSE
 - Gemfile
@@ -34,6 +35,7 @@ files:
 - bin/setup
 - draco.gemspec
 - lib/draco.rb
+- lib/draco/benchmark.rb
 homepage: https://github.com/guitsaru/draco
 licenses: []
 metadata:
@@ -54,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: An ECS library.