baku 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28ac783aa88b25f6c40da785a9455b8ceffc57ce
+  data.tar.gz: e1352417ee1b095d41da14d033fa84bdadb57097
+SHA512:
+  metadata.gz: 5c68d176ad7eda25d66ec1674c3cf5a739c7eea941a3edcbe0133c8aa14242af7fd7277e95e20198e8fc9fd6b06bbead8e04ff5210ac270bb40a0a7472e3255f
+  data.tar.gz: 0fb615ce7c1b69ed0aad6147c96e9f02b5da16e62e8daf6c77dcd37194c0316ac5c75aef5c08135c3a06279f4249596500bcff3bca0b93d291af26d68249a234

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 John Tuttle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# 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 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!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'baku'
+```
+
+And then execute:
+
+    $ bundle
+
+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
+    transform.z += velocity.z
+  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
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push git
+commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/jtuttle/baku.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/baku.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "baku/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "baku"
+  spec.version       = Baku::VERSION
+  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.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.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "baku"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/baku/component.rb

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

data/lib/baku/entity.rb

@@ -0,0 +1,39 @@
+module Baku
+  class Entity
+    attr_reader :id, :components, :tags
+    
+    def initialize(world, tags = [])
+      @world = world
+      @tags = tags
+      
+      @id = SecureRandom.uuid
+      @components = {}
+    end
+
+    def add_component(component)
+      if @components.has_key?(component.class)
+        raise StandardError.
+          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)
+    end
+
+    def remove_component(component_class)
+      if !@components.has_key?(component_class)
+        raise StandardError.
+          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))
+    end
+    
+    def get_component(component_class)
+      @components[component_class]
+    end
+  end
+end

data/lib/baku/entity_manager.rb

@@ -0,0 +1,83 @@
+module Baku
+  class EntityManager
+    def initialize
+      @entities_by_system_mask = {}
+      @entities_by_tag = {}
+      
+      @component_set = Set.new
+      @system_mask_cache = {}
+    end
+
+    def register_entity(entity)
+      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
+      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
+
+    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)
+    end
+
+    def get_entities_for_system(system)
+      system_mask = @system_mask_cache[system]
+      @entities_by_system_mask[system_mask]
+    end
+
+    def get_entities_by_tag(tag)
+      @entities_by_tag[tag]
+    end
+
+    private
+
+    def get_component_mask(components)
+      mask = 0
+
+      @component_set.each_with_index do |c, i|
+        mask |= (1 << i) if components.include?(c)
+      end
+
+      mask
+    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)
+        
+        if old_match && !new_match
+          entities.delete(entity)
+        elsif !old_match && new_match
+          entities << entity
+        end
+      end
+    end
+  end
+end

data/lib/baku/system.rb

@@ -0,0 +1,25 @@
+module Baku
+  class System
+    attr_reader :components, :game_loop_step
+    attr_accessor :world
+    
+    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|
+        entity_components = @components.map { |c| entity.get_component(c) }
+        process_entity(entity, *entity_components)
+      end
+    end
+
+    def process_entity(entity)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/baku/version.rb

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

data/lib/baku/world.rb

@@ -0,0 +1,53 @@
+module Baku
+  class World
+    attr_reader :entity_manager, :blackboard, :delta_ms
+    
+    def initialize
+      # TODO: there's currently no way to interleave update and draw systems.
+      # Is this something we'll eventually need?
+      @update_systems = []
+      @draw_systems = []
+
+      @entity_manager = EntityManager.new
+      
+      @blackboard = {}
+    end
+
+    def add_system(system)
+      system_list = 
+        if system.game_loop_step == :update
+          @update_systems
+        elsif system.game_loop_step == :draw
+          @draw_systems
+        end
+
+      if system_list.map(&:class).include?(system.class)
+        raise StandardError.new("Already added #{system.class} system to world.")
+      end
+      
+      system_list << system
+      system.world = self
+      
+      @entity_manager.register_system(system)
+    end
+
+    def create_entity(tags = [])
+      entity = Entity.new(self, tags)
+      @entity_manager.register_entity(entity)
+      entity
+    end
+
+    def get_entities_by_tag(tag)
+      @entity_manager.get_entities_by_tag(tag)
+    end
+
+    def update(delta_ms)
+      @delta_ms = delta_ms
+      @update_systems.each(&:execute)
+    end
+
+    def draw
+      @draw_systems.each(&:execute)
+    end
+  end
+end

data/lib/baku.rb

@@ -0,0 +1,8 @@
+require "baku/version"
+
+module Baku
+  require 'securerandom'
+  require 'set'
+  
+  Gem.find_files("baku/**/*.rb").each { |path| require path }
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: baku
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Tuttle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: An Entity Component System framework for Ruby
+email:
+- jtuttle.develops@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- baku.gemspec
+- bin/console
+- bin/setup
+- lib/baku.rb
+- lib/baku/component.rb
+- lib/baku/entity.rb
+- lib/baku/entity_manager.rb
+- lib/baku/system.rb
+- lib/baku/version.rb
+- lib/baku/world.rb
+homepage: https://github.com/jtuttle/baku
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: An Entity Component System framework for Ruby
+test_files: []