baku 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28ac783aa88b25f6c40da785a9455b8ceffc57ce
-  data.tar.gz: e1352417ee1b095d41da14d033fa84bdadb57097
+  metadata.gz: 1653036472420b349cb3e013e0d55a589ebe29cb
+  data.tar.gz: 4ce15a89513b81e4803b800a3083b7e5d51ce45a
 SHA512:
-  metadata.gz: 5c68d176ad7eda25d66ec1674c3cf5a739c7eea941a3edcbe0133c8aa14242af7fd7277e95e20198e8fc9fd6b06bbead8e04ff5210ac270bb40a0a7472e3255f
-  data.tar.gz: 0fb615ce7c1b69ed0aad6147c96e9f02b5da16e62e8daf6c77dcd37194c0316ac5c75aef5c08135c3a06279f4249596500bcff3bca0b93d291af26d68249a234
+  metadata.gz: cc818103da055af5358e1dfeab535945c31be1b847f931b54febebbe407e6ab3a3427660de8abeb5063d24ed2bf01ad958ce32af3b89bed1338061dd71ef6b35
+  data.tar.gz: 497c1f10325f892d97dbe9a48ef30052b4d03edc26e6cf20453e9ca52b32f7cee10d3a7bf7c5215fb85f4f74f1f4d2cf86eafda98b346bd926801dcb1445b487

data/.gitignore

@@ -10,3 +10,6 @@
 
 # rspec failure tracking
 .rspec_status
+.byebug_history
+.ruby-version
+.ruby-gemset

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 0.2.0
+
+* Add ability to remove components from an entity.
+* Extract component mask logic into its own class.
+* Remove a few instances of unnecessary coupling.
+* Write remaining tests.
+
+# 0.1.0
+
+* Initial release!

data/README.md

@@ -58,7 +58,6 @@ class MovementSystem < Baku::System
   def process_entity(entity, transform, velocity)
     transform.x += velocity.x
     transform.y += velocity.y
-    transform.z += velocity.z
   end
 end
 ```

data/baku.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.5.0"
 end

data/lib/baku/component.rb

@@ -1,9 +1,7 @@
 module Baku
   class Component
-    attr_reader :id
-
     def initialize
-      @id = SecureRandom.uuid
+      
     end
   end
 end

data/lib/baku/component_mask.rb

@@ -0,0 +1,51 @@
+module Baku
+  class ComponentMask
+    attr_reader :value
+    
+    @@component_set = Set.new
+
+    class << self
+      def record_components(components)
+        components.each do |component|
+          @@component_set << component
+        end
+      end
+      
+      def from_components(components)
+        record_components(components)
+
+        mask_value = 0
+
+        @@component_set.each_with_index do |component, index|
+          mask_value |= (1 << index) if components.include?(component)
+        end
+
+        ComponentMask.new(mask_value)
+      end
+    end
+    
+    def initialize(value)
+      @value = value
+    end
+
+    def add_component(component_class)
+
+    end
+
+    def matches?(other_mask)
+      @value & other_mask.value == @value
+    end
+
+    def ==(other)
+      @value == other.value
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      value
+    end
+  end
+end

data/lib/baku/entity.rb

@@ -1,12 +1,11 @@
 module Baku
   class Entity
-    attr_reader :id, :components, :tags
+    include Baku::EventDispatcher
     
-    def initialize(world, tags = [])
-      @world = world
+    attr_reader :components, :tags
+    
+    def initialize(tags = [])
       @tags = tags
-      
-      @id = SecureRandom.uuid
       @components = {}
     end
 
@@ -16,9 +15,11 @@ module Baku
           new("Entity already has component: #{component.class}")
       end
 
-      # TODO: this is some pretty ugly coupling, figure out if there's a cleaner
-      # way to do this. Callbacks or something.
-      @world.entity_manager.entity_add_component(self, component)
+      components[component.class] = component
+
+      update_component_mask
+      
+      dispatch_event(:component_added, self, component)
     end
 
     def remove_component(component_class)
@@ -27,13 +28,25 @@ module Baku
           new("Entity does not have component: #{component_class}")
       end
 
-      # TODO: this is some pretty ugly coupling, figure out if there's a cleaner
-      # way to do this. Callbacks or something.
-      @world.entity_manager.entity_remove_component(self, get_component(component_class))
+      @components.delete(component_class)
+
+      update_component_mask
+      
+      dispatch_event(:component_removed, self, @components[component_class])
     end
     
     def get_component(component_class)
       @components[component_class]
     end
+
+    def component_mask
+      @component_mask ||= ComponentMask.from_components(@components)
+    end
+
+    private
+
+    def update_component_mask
+      @component_mask = ComponentMask.from_components(@components)
+    end
   end
 end

data/lib/baku/entity_manager.rb

@@ -1,54 +1,51 @@
 module Baku
+  # The EntityManager stores entities in such a way that they can be retrieved
+  # efficiently by either ComponentMask or tag. Before storing any entities, the
+  # ComponentMasks that we wish to match on should be registered. This step is
+  # performed transparently by the World whenever a System is added.
   class EntityManager
     def initialize
-      @entities_by_system_mask = {}
+      @entities_by_component_mask = {}
       @entities_by_tag = {}
-      
-      @component_set = Set.new
-      @system_mask_cache = {}
     end
 
-    def register_entity(entity)
+    def register_component_mask(component_mask)
+      @entities_by_component_mask[component_mask] = []
+    end
+
+    def add_entity(entity)
+      add_entity_to_matching_component_lists(entity)
+      
+      entity.add_event_listener(:component_added,
+                                method(:on_entity_component_added))
+      entity.add_event_listener(:component_removed,
+                                method(:on_entity_component_removed))
+
       entity.tags.each do |tag|
         @entities_by_tag[tag] ||= []
         @entities_by_tag[tag] << entity
       end
     end
 
-    def register_system(system)
-      system.components.each do |component|
-        @component_set << component
+    def remove_entity(entity)
+      entity.tags.each do |tag|
+        @entities_by_tag[tag].delete(entity)
       end
-
-      system_component_mask =
-        get_component_mask(system.components)
-
-      @system_mask_cache[system] = system_component_mask
       
-      @entities_by_system_mask[system_component_mask] = []
-    end
-    
-    # TODO: there may be a more efficent way to do this, like by comparing
-    # the diff of the mask before and after, but this works for now.
-    def entity_add_component(entity, component)
-      old_mask = get_component_mask(entity.components)
-      entity.components[component.class] = component
-      new_mask = get_component_mask(entity.components)
-
-      update_system_membership(entity, old_mask, new_mask)
-    end
+      entity.remove_event_listener(:component_added,
+                                   method(:on_entity_component_added))
+      entity.remove_event_listener(:component_removed,
+                                   method(:on_entity_component_removed))
 
-    def entity_remove_component(entity, component)
-      old_mask = get_component_mask(entity.components)
-      entity.components.delete(component.class)
-      new_mask = get_component_mask(entity.components)
-
-      update_system_membership(entity, old_mask, new_mask)
+      @entities_by_component_mask.each do |component_mask, entities|
+        if component_mask.matches?(entity.component_mask)
+          entities.delete(entity)
+        end
+      end
     end
 
-    def get_entities_for_system(system)
-      system_mask = @system_mask_cache[system]
-      @entities_by_system_mask[system_mask]
+    def get_entities(component_mask)
+      @entities_by_component_mask[component_mask]
     end
 
     def get_entities_by_tag(tag)
@@ -57,27 +54,30 @@ module Baku
 
     private
 
-    def get_component_mask(components)
-      mask = 0
-
-      @component_set.each_with_index do |c, i|
-        mask |= (1 << i) if components.include?(c)
+    def add_entity_to_matching_component_lists(entity)
+      @entities_by_component_mask.each do |component_mask, entities|
+        if component_mask.matches?(entity.component_mask)
+          entities << entity
+        end
       end
+    end
 
-      mask
+    def on_entity_component_added(entity, component)
+      add_entity_to_matching_component_lists(entity)
     end
 
-    def update_system_membership(entity, old_mask, new_mask)
-      @entities_by_system_mask.each do |system_mask, entities|
-        old_match = (system_mask & old_mask == system_mask)
-        new_match = (system_mask & new_mask == system_mask)
+    def on_entity_component_removed(entity, component)
+      old_mask = ComponentMask.from_components(entity.components + component)
+      new_mask = entity.component_mask
+
+      @entities_by_component_mask.each do |component_mask, entities|
+        old_match = component_mask.match?(old_mask)
+        new_match = component_mask.match?(new_mask)
         
         if old_match && !new_match
           entities.delete(entity)
-        elsif !old_match && new_match
-          entities << entity
         end
-      end
+      end      
     end
   end
 end

data/lib/baku/event_dispatcher.rb

@@ -0,0 +1,19 @@
+module Baku
+  module EventDispatcher
+    def add_event_listener(event_name, method)
+      @event_listeners ||= {}
+      @event_listeners[event_name] ||= []
+
+      @event_listeners[event_name] << method
+    end
+
+    def remove_event_listener(event_name, method)
+      @event_listeners[event_name].delete(method)
+    end
+    
+    def dispatch_event(event_name, *args)
+      return unless @event_listeners && @event_listeners.has_key?(event_name)
+      @event_listeners[event_name].each { |f| f.call(*args) }
+    end
+  end
+end

data/lib/baku/system.rb

@@ -1,25 +1,30 @@
 module Baku
   class System
     attr_reader :components, :game_loop_step
-    attr_accessor :world
+    attr_writer :entity_manager
     
     def initialize(components, game_loop_step)
       @components = components
       @game_loop_step = game_loop_step
     end
 
-    def execute
-      entities =
-        @world.entity_manager.get_entities_for_system(self)
-
-      entities.each do |entity|
+    def process_entities
+      if @entity_manager.nil?
+        raise StandardError.new("Must set :entity_manager property of System.")
+      end
+      
+      @entity_manager.get_entities(component_mask).each do |entity|
         entity_components = @components.map { |c| entity.get_component(c) }
         process_entity(entity, *entity_components)
       end
     end
-
+    
     def process_entity(entity)
       raise NotImplementedError
     end
+
+    def component_mask
+      @component_mask ||= ComponentMask.from_components(@components)
+    end
   end
 end

data/lib/baku/version.rb

@@ -1,3 +1,3 @@
 module Baku
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/baku/world.rb

@@ -26,28 +26,34 @@ module Baku
       end
       
       system_list << system
-      system.world = self
+
+      @entity_manager.register_component_mask(system.component_mask)
       
-      @entity_manager.register_system(system)
+      system.entity_manager = @entity_manager
     end
 
     def create_entity(tags = [])
-      entity = Entity.new(self, tags)
-      @entity_manager.register_entity(entity)
+      entity = Entity.new(tags)
+      @entity_manager.add_entity(entity)
       entity
     end
 
-    def get_entities_by_tag(tag)
-      @entity_manager.get_entities_by_tag(tag)
+    def destroy_entity(entity)
+      @entity_manager.remove_entity(entity)
     end
 
     def update(delta_ms)
       @delta_ms = delta_ms
-      @update_systems.each(&:execute)
+      
+      @update_systems.each do |system|
+        system.process_entities
+      end
     end
 
     def draw
-      @draw_systems.each(&:execute)
+      @draw_systems.each do |system|
+        system.process_entities
+      end
     end
   end
 end

data/lib/baku.rb

@@ -1,8 +1,14 @@
 require "baku/version"
 
 module Baku
-  require 'securerandom'
+  begin
+    require 'pry-byebug'
+  rescue LoadError
+    # development dependencies
+  end
+    
   require 'set'
-  
+
+  require_relative "baku/event_dispatcher.rb"
   Gem.find_files("baku/**/*.rb").each { |path| require path }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: baku
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - John Tuttle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
 description: An Entity Component System framework for Ruby
 email:
 - jtuttle.develops@gmail.com
@@ -62,6 +76,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -71,8 +86,10 @@ files:
 - bin/setup
 - lib/baku.rb
 - lib/baku/component.rb
+- lib/baku/component_mask.rb
 - lib/baku/entity.rb
 - lib/baku/entity_manager.rb
+- lib/baku/event_dispatcher.rb
 - lib/baku/system.rb
 - lib/baku/version.rb
 - lib/baku/world.rb