baku 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e4e011013e5257d5b0af62562561e971cf0e449b
-  data.tar.gz: 31931a5ea325fa8c8cb9e661e339935b83ac14fa
+SHA256:
+  metadata.gz: f95ddbe20ed9e1c88da6a47399d9a6f4ebf0cb5e0ad591b8cceae36a2091c103
+  data.tar.gz: add1c691aa86d0b462c39353aa52ac6bd009b833f3314b4a5bb5f05148641a25
 SHA512:
-  metadata.gz: b875ecf5c85daf770f8c91387848a93776aac8c5037112c9c9f5cd0832cb9948ebf7bfc321c035e4ce70848738d7622cecdc4607588ea3f45a92795c72f50f5f
-  data.tar.gz: 9bf020e852d6e1929541f7ccc7650360cea9d833e0bac78711ed33b196f84edf2a97b588beb98418bce1d94ba0cd4debc531fe6f6623a624114c3c2a3bf0c804
+  metadata.gz: 59fd7f1018890d362342dfe25fdb5776301a1e6a6439eeac35a5136556fe95bdaac48e24a940a3c23a0505cf79a056c6be5c5031bc5cd4df7c104e55b4cd0fe5
+  data.tar.gz: ebcd87f863c3ab2b092c8a01b965134cd5676714b4f1a4238c9a1d44520a31b86b4d1751db8c0e268e3f51a3c31a4fa71bcbf090636a13cce6c5718f7c80b64f

data/.gitignore

@@ -1,15 +1,52 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
+*.gem
+*.rbc
+/.config
 /coverage/
-/doc/
+/InstalledFiles
 /pkg/
 /spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
 /tmp/
 
-# rspec failure tracking
-.rspec_status
-.byebug_history
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
 .ruby-version
-.ruby-gemset
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.rspec_status

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# 0.3.1
+
+* Prevent system registration from overwriting existing entity list.
+
+# 0.3.0
+
+* Add tag system that processes entities by tag.
+
+# 0.2.6
+
+* Replace internal event listener with miru gem.
+
+# 0.2.5
+
+* Add has_component? to Entity.
+
+# 0.2.4
+
+* Add world disposal.
+
 # 0.2.3
 
 * Separate entity retrieval and processing logic in system to allow pre and post-processing.

data/README.md

@@ -1,12 +1,10 @@
 # Baku
 
-Baku provides a simple Entity Component System framework for use with Ruby game
-engines. It has been tested with [Gosu](https://www.libgosu.org/ruby.html), but
-should be flexible enough to work with any Ruby project that has a game loop.
+Baku provides a simple Entity Component System framework for use with Ruby game engines. It has been tested with [Gosu](https://www.libgosu.org/ruby.html), but should be flexible enough to work with any Ruby project that has a game loop.
 
-Baku is still very much a work in progress. There are undoubtedly bugs. I will
-be continually iterating and improving on it as I use it for my personal game
-development projects. Enjoy!
+Baku is still very much a work in progress. There are undoubtedly bugs. I will be continually iterating and improving on it as I use it for my personal game development projects. Enjoy!
+
+The [Baku wiki](https://github.com/jtuttle/baku/wiki) includes a [quick start guide](https://github.com/jtuttle/baku/wiki/quick-start-guide) if you're already familiar with the ECS approach. If not, there is also a descriptive [tutorial](https://github.com/jtuttle/baku/wiki/tutorial) that will cover ECS concepts while walking you through setting up Gosu with Baku.
 
 ## Installation
 
@@ -24,74 +22,6 @@ Or install it yourself as:
 
     $ gem install baku
 
-## Usage
-
-Create components by overriding `Baku::Component` and calling `super()`. The
-example component below simple stores the x and y coordinates of an entity in
-a 2D space.
-
-```
-class TransformComponent < Baku::Component
-  attr_accessor :x, :y
-
-  def initialize(x, y)
-    super()
-
-    @x = x
-    @y = y
-  end
-end
-```
-
-Create systems by overriding `Baku::System` and calling `super()` to specify the
-components that an entity must possess in order for it to be processed by the
-system. The example system below will only operate on entities that possess both
-a `TransformComponent` and a `VelocityComponent`. You will also need to specify
-whether the system will be run during the `:update` or `:draw` loop.
-
-```
-class MovementSystem < Baku::System
-  def initialize
-    super([TransformComponent, VelocityComponent], :update)
-  end
-
-  def process_entity(entity, transform, velocity)
-    transform.x += velocity.x
-    transform.y += velocity.y
-  end
-end
-```
-
-In your game initialization logic, create a `Baku::World` instance and register
-any systems you want to use. In the below example, we register our example
-system from above and create an entity that will be processed by the system:
-
-```
-def game_initialization
-  @world = Baku::World.new
-  @world.add_system(MovementSystem.new)
-
-  entity = @world.create_entity
-  entity.add_component(TransformComponent)
-  entity.add_component(VelocityComponent)
-end
-```
-
-In your game `update` and `draw` loops, call the `Baku::World` instance's
-`update` and `draw` methods. You'll want to keep track of the millseconds
-between frames and pass that to the `update` method if you're planning to
-use the entity component system for anything that needs it.
-
-```
-def game_update_loop
-  @world.update(delta_ms)
-end
-
-def game_draw_loop
-  @world.draw
-end
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/baku.gemspec

@@ -1,28 +1,28 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "baku/version"
+require 'baku/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "baku"
+  spec.name          = 'baku'
   spec.version       = Baku::VERSION
-  spec.authors       = ["John Tuttle"]
-  spec.email         = ["jtuttle.develops@gmail.com"]
+  spec.authors       = ['John Tuttle']
+  spec.email         = ['jtuttle.develops@gmail.com']
 
-  spec.summary       = "An Entity Component System framework for Ruby"
-  spec.description   = "An Entity Component System framework for Ruby"
-  spec.homepage      = "https://github.com/jtuttle/baku"
-  spec.license       = "MIT"
+  spec.summary       = 'An Entity Component System framework for Ruby'
+  spec.description   = 'An Entity Component System framework for Ruby'
+  spec.homepage      = 'https://github.com/jtuttle/baku'
+  spec.license       = 'MIT'
 
+  # use double quotes for "\x0" (https://github.com/bundler/bundler/issues/4133)
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  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"
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9.0'
+
+  spec.add_dependency 'miru', '~> 0.1.0'
 end

data/lib/baku.rb

@@ -6,9 +6,10 @@ module Baku
   rescue LoadError
     # development dependencies
   end
-    
+
   require 'set'
+  
+  require 'miru'
 
-  require_relative "baku/event_dispatcher.rb"
   Gem.find_files("baku/**/*.rb").each { |path| require path }
 end

data/lib/baku/component_system.rb

@@ -0,0 +1,35 @@
+require_relative 'system'
+
+module Baku
+  class ComponentSystem < System
+    attr_reader :components
+    
+    def initialize(components, game_loop_step)
+      @components = components
+      @game_loop_step = game_loop_step
+    end
+
+    def register_world(world)
+      super(world)
+
+      world.entity_manager.register_component_mask(component_mask)
+    end
+
+    def process_entities(entities)
+      entities.each do |entity|
+        entity_components = @components.map { |c| entity.get_component(c) }
+        process_entity(entity, *entity_components)
+      end
+    end
+
+    def component_mask
+      @component_mask ||= ComponentMask.from_components(@components)
+    end
+    
+    protected
+
+    def retrieve_entities
+      @world.entity_manager.get_entities(component_mask)
+    end
+  end
+end

data/lib/baku/entity.rb

@@ -1,6 +1,6 @@
 module Baku
   class Entity
-    include Baku::EventDispatcher
+    include Miru::EventDispatcher
     
     attr_reader :components, :tags
     
@@ -28,11 +28,16 @@ module Baku
           new("Entity does not have component: #{component_class}")
       end
 
+      removed_component = @components[component_class]
       @components.delete(component_class)
 
       update_component_mask
       
-      dispatch_event(:component_removed, self, @components[component_class])
+      dispatch_event(:component_removed, self, removed_component)
+    end
+
+    def has_component?(component_class)
+      @components.has_key?(component_class)
     end
     
     def get_component(component_class)

data/lib/baku/entity_manager.rb

@@ -9,17 +9,26 @@ module Baku
       @entities_by_tag = {}
     end
 
+    def dispose
+      @entities_by_component_mask.clear
+      @entities_by_tag.clear
+    end
+
     def register_component_mask(component_mask)
-      @entities_by_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.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] ||= []
@@ -31,11 +40,15 @@ module Baku
       entity.tags.each do |tag|
         @entities_by_tag[tag].delete(entity)
       end
-      
-      entity.remove_event_listener(:component_added,
-                                   method(:on_entity_component_added))
-      entity.remove_event_listener(:component_removed,
-                                   method(:on_entity_component_removed))
+
+      entity.remove_event_listener(
+        :component_added,
+        method(:on_entity_component_added)
+      )
+      entity.remove_event_listener(
+        :component_removed,
+        method(:on_entity_component_removed)
+      )
 
       @entities_by_component_mask.each do |component_mask, entities|
         if component_mask.matches?(entity.component_mask)
@@ -45,11 +58,11 @@ module Baku
     end
 
     def get_entities(component_mask)
-      @entities_by_component_mask[component_mask]
+      @entities_by_component_mask[component_mask] || []
     end
 
     def get_entities_by_tag(tag)
-      @entities_by_tag[tag]
+      @entities_by_tag[tag] || []
     end
 
     private
@@ -69,17 +82,17 @@ module Baku
     end
 
     def on_entity_component_removed(entity, component)
-      old_mask = ComponentMask.from_components(entity.components + component)
+      old_mask = ComponentMask.from_components(entity.components.keys + [component.class])
       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)
-        
+        old_match = component_mask.matches?(old_mask)
+        new_match = component_mask.matches?(new_mask)
+
         if old_match && !new_match
           entities.delete(entity)
         end
-      end      
+      end
     end
   end
 end

data/lib/baku/system.rb

@@ -1,42 +1,34 @@
 module Baku
   class System
     attr_reader :components, :game_loop_step
-    attr_writer :world
     
     def initialize(components, game_loop_step)
       @components = components
       @game_loop_step = game_loop_step
     end
 
+    def register_world(world)
+      @world = world
+    end
+
     def execute
       if @world.nil?
         raise StandardError.new("Must set :world property of System.")
       end
       
-      entities = @world.entity_manager.get_entities(component_mask)
+      entities = retrieve_entities
 
       process_entities(entities)
     end
-
-    def process_entities(entities)
-      entities.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
-
-    private
+    protected
 
     def retrieve_entities
-      @world.entity_manager.get_entities(component_mask)
+      raise NotImplementedError
     end
   end
 end

data/lib/baku/tag_system.rb

@@ -0,0 +1,24 @@
+require_relative 'system'
+
+module Baku
+  class TagSystem < System
+    attr_reader :tag
+    
+    def initialize(tag, game_loop_step)
+      @tag = tag
+      @game_loop_step = game_loop_step
+    end
+
+    def process_entities(entities)
+      entities.each do |entity|
+        process_entity(entity)
+      end
+    end
+    
+    protected
+    
+    def retrieve_entities
+      @world.entity_manager.get_entities_by_tag(@tag)
+    end
+  end
+end

data/lib/baku/version.rb

@@ -1,3 +1,3 @@
 module Baku
-  VERSION = "0.2.3"
+  VERSION = "0.3.1"
 end

data/lib/baku/world.rb

@@ -13,6 +13,13 @@ module Baku
       @blackboard = {}
     end
 
+    def dispose
+      @update_systems.clear
+      @draw_systems.clear
+      @entity_manager.dispose
+      @blackboard.clear
+    end
+
     def add_system(system)
       system_list = 
         if system.game_loop_step == :update
@@ -24,12 +31,10 @@ module Baku
       if system_list.map(&:class).include?(system.class)
         raise StandardError.new("Already added #{system.class} system to world.")
       end
-      
-      system_list << system
 
-      @entity_manager.register_component_mask(system.component_mask)
+      system.register_world(self)
       
-      system.world = self
+      system_list << system
     end
 
     def create_entity(tags = [])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: baku
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.1
 platform: ruby
 authors:
 - John Tuttle
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: miru
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: An Entity Component System framework for Ruby
 email:
 - jtuttle.develops@gmail.com
@@ -87,17 +101,18 @@ files:
 - lib/baku.rb
 - lib/baku/component.rb
 - lib/baku/component_mask.rb
+- lib/baku/component_system.rb
 - lib/baku/entity.rb
 - lib/baku/entity_manager.rb
-- lib/baku/event_dispatcher.rb
 - lib/baku/system.rb
+- lib/baku/tag_system.rb
 - lib/baku/version.rb
 - lib/baku/world.rb
 homepage: https://github.com/jtuttle/baku
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,9 +127,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: An Entity Component System framework for Ruby
 test_files: []

data/lib/baku/event_dispatcher.rb

@@ -1,19 +0,0 @@
-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