chione 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4db53fed99c571b08d2413fc895bc32eef38194
+  data.tar.gz: 17972162d89c66ebc0d4e1f35aa2af2c667c6437
+SHA512:
+  metadata.gz: e0e7538d0a928b90104586a5d70ee46068c2d8b8999b940e40a0f342720ec33c8f3407eea3a9baab2ae244330314175438a4975c32e3ba0486f09522a5c5d09b
+  data.tar.gz: 8af6a0b44089392eee195ea85fbdc57a9bc9f69f3b5cab431a7321185a1afcc84ce7d99a304a9c7f9de12f74c49a9da182912a70f42968ae6ce60e11723274b5

data/.rdoc_options

@@ -0,0 +1,22 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+- "."
+charset: UTF-8
+exclude: 
+hyperlink_all: false
+line_numbers: true
+locale: 
+locale_dir: locale
+locale_name: 
+main_page: 
+markup: markdown
+output_decoration: true
+page_dir: 
+show_hash: true
+tab_width: 4
+template_stylesheets: []
+title: 
+visibility: :protected
+webcvs: 

data/.simplecov

@@ -0,0 +1,14 @@
+# Simplecov config
+
+SimpleCov.start do
+	add_filter 'spec'
+	add_filter 'integration'
+	add_group "Needing tests" do |file|
+		file.covered_percent < 90
+	end
+
+	if ENV['CIRCLE_ARTIFACTS']
+		dir = ENV['CIRCLE_ARTIFACTS'] + "/coverage"
+		coverage_dir( dir )
+	end
+end

data/ChangeLog

@@ -0,0 +1,114 @@
+2015-07-13  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/chione/behaviors.rb:
+	Add a shared-behaviors collection
+	[5ac263b85052] [github/master, tip]
+
+	* lib/chione/world.rb, spec/chione/world_spec.rb:
+	Add support for more than one GameWorld callback per event pattern
+	[bd5d3d7c9a25]
+
+	* lib/chione/entity.rb, spec/chione/entity_spec.rb:
+	Add an error-checking method for fetching components from entities
+	[e05eecf441a9]
+
+2015-07-06  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/chione/world.rb, spec/chione/world_spec.rb:
+	Send the System or Manager class instead of its name in added events
+	[8b8c61d98bbe]
+
+2015-07-03  Michael Granger  <ged@FaerieMUD.org>
+
+	* Manifest.txt, chione.gemspec, circle.yml:
+	Switch to Semaphore CI.
+	[0c557d993116]
+
+	* README.md:
+	Add some ECS resources to the README
+	[e52690bee302]
+
+2015-07-02  Michael Granger  <ged@FaerieMUD.org>
+
+	* .simplecov:
+	Trying a different coverage artifact path
+	[4608ebd79e6d]
+
+	* .simplecov, circle.yml:
+	Attempting to get coverage artifacts working
+	[645d40b6661d]
+
+	* spec/chione/world_spec.rb:
+	Fix some world specs
+	[4a0c788679d9]
+
+	* .circle.yml, circle.yml:
+	Rename .circle.yml to circle.yml. Ugh.
+	[b601a62a3282]
+
+	* Rakefile:
+	Add `test` alias for `spec` task
+	[1bc69f3c5f84]
+
+	* .circle.yml:
+	Trying out circleci for CI
+	[ddf85c924542]
+
+	* lib/chione/world.rb, spec/chione/world_spec.rb:
+	Start Systems and Managers added to running worlds.
+	[413fa0a7e63b]
+
+2015-06-26  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/chione/manager.rb, lib/chione/system.rb, lib/chione/world.rb,
+	spec/chione/world_spec.rb:
+	Add system/manager start/stop to the World, distinguish between
+	#started? and #running?
+	[4e8b849d2465]
+
+2015-06-24  Michael Granger  <ged@FaerieMUD.org>
+
+	* Rakefile, chione.gemspec:
+	Fix version of fivefish generator
+	[c6e04d3d5e33]
+
+	* lib/chione/manager.rb, lib/chione/system.rb, lib/chione/world.rb,
+	spec/chione/world_spec.rb:
+	Allow systems/managers to be created with args, start them if added
+	when the world is already running
+	[38215d3ce09a]
+
+	* .rdoc_options, Rakefile:
+	Include .md files in docs generation
+	[6f5aae40418c]
+
+	* README.md:
+	Fix up the README formatting
+	[eaf39049bdba]
+
+2015-06-23  Michael Granger  <ged@FaerieMUD.org>
+
+	* History.md, History.rdoc, Manifest.txt, README.md, README.rdoc,
+	Rakefile:
+	Convert README and History to markdown
+	[b2b9437fce76]
+
+2015-06-22  Michael Granger  <ged@FaerieMUD.org>
+
+	* .travis.yml, Gemfile, History.rdoc, Manifest.txt, README.rdoc,
+	Rakefile, cert/ged.pem, chione.gemspec:
+	Update build system stuff.
+	[89e6682e9be9]
+
+	* .gems, .hgignore, .pryrc, .rvmrc, .simplecov, .tm_properties,
+	History.rdoc, Manifest.txt, README.rdoc, Rakefile, experiments
+	/fnmatch-vs-regex.rb, lib/chione.rb, lib/chione/aspect.rb,
+	lib/chione/assemblage.rb, lib/chione/component.rb,
+	lib/chione/entity.rb, lib/chione/manager.rb, lib/chione/mixins.rb,
+	lib/chione/system.rb, lib/chione/world.rb,
+	spec/chione/aspect_spec.rb, spec/chione/assemblage_spec.rb,
+	spec/chione/component_spec.rb, spec/chione/entity_spec.rb,
+	spec/chione/manager_spec.rb, spec/chione/system_spec.rb,
+	spec/chione/world_spec.rb, spec/chione_spec.rb, spec/spec_helper.rb:
+	Initial implementation
+	[a566bf207cc5]

data/History.rdoc

@@ -0,0 +1,9 @@
+== v0.0.2 [2015-07-13] Michael Granger <ged@FaerieMUD.org>
+
+Fix a couple of build problems.
+
+
+== v0.0.1 (unreleased) [2015-07-13] Michael Granger <ged@FaerieMUD.org>
+
+Initial release.
+

data/Manifest.txt

@@ -0,0 +1,27 @@
+.rdoc_options
+.simplecov
+ChangeLog
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/chione.rb
+lib/chione/aspect.rb
+lib/chione/assemblage.rb
+lib/chione/behaviors.rb
+lib/chione/component.rb
+lib/chione/entity.rb
+lib/chione/manager.rb
+lib/chione/mixins.rb
+lib/chione/system.rb
+lib/chione/world.rb
+spec/chione/aspect_spec.rb
+spec/chione/assemblage_spec.rb
+spec/chione/component_spec.rb
+spec/chione/entity_spec.rb
+spec/chione/manager_spec.rb
+spec/chione/mixins_spec.rb
+spec/chione/system_spec.rb
+spec/chione/world_spec.rb
+spec/chione_spec.rb
+spec/spec_helper.rb

data/README.rdoc

@@ -0,0 +1,96 @@
+= Chione
+
+home   :: http://faelidth.org/chione
+code   :: http://bitbucket.org/ged/chione
+github :: http://github.com/ged/chione
+docs   :: http://faelidth.org/chione/docs
+
+
+== Description
+
+An Entity/Component System framework inspired by Artemis.
+
+This library is still experimental. I am writing it by extracting out ideas from
+a multi-user game I'm working on, and things may change radically if I find
+that parts of it don't work or could be done a better way.
+
+That said, let me know if you're using it for anything and I'll try to keep
+you abreast of any changes I'm considering, and I'm happy to chat about ideas
+for making it better via email or the project's Gitter channel:
+
+{rdoc-image:https://badges.gitter.im/Join%20Chat.svg}[https://gitter.im/ged/chione]
+
+
+
+== Prerequisites
+
+* Ruby 2.2
+
+
+== Installation
+
+    $ gem install chione
+
+
+== Resources
+
+Articles/posts on ECS:
+
+* http://gameprogrammingpatterns.com/component.html
+* http://t-machine.org/index.php/2007/09/03/entity-systems-are-the-future-of-mmog-development-part-1/
+* http://www.richardlord.net/blog/what-is-an-entity-framework
+* http://www.richardlord.net/blog/why-use-an-entity-framework
+* http://cowboyprogramming.com/2007/01/05/evolve-your-heirachy/
+
+Other ECS Frameworks:
+
+* https://github.com/junkdog/artemis-odb (Java)
+* https://github.com/libgdx/ashley (Java)
+* http://www.ashframework.org/ (ActionScript)
+
+
+== Contributing
+
+You can check out the current development source with Mercurial via its
+{project page}[http://bitbucket.org/ged/chione]. Or if you prefer Git, via 
+{its Github mirror}[https://github.com/ged/chione].
+
+After checking out the source, run:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the API documentation.
+
+
+== License
+
+Copyright (c) 2015, Michael Granger
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+

data/Rakefile

@@ -0,0 +1,92 @@
+#!/usr/bin/env rake
+
+require 'rake/clean'
+
+begin
+	require 'hoe'
+rescue LoadError
+	abort "This Rakefile requires 'hoe' (gem install hoe)"
+end
+
+GEMSPEC = 'chione.gemspec'
+
+
+Hoe.plugin :mercurial
+Hoe.plugin :signing
+Hoe.plugin :deveiate
+
+Hoe.plugins.delete :rubyforge
+
+hoespec = Hoe.spec 'chione' do |spec|
+	spec.readme_file = 'README.rdoc'
+	spec.history_file = 'History.rdoc'
+	spec.license 'BSD'
+
+	spec.developer 'Michael Granger', 'ged@FaerieMUD.org'
+
+	spec.dependency 'loggability',     '~> 0.11'
+	spec.dependency 'configurability', '~> 2.2'
+	spec.dependency 'uuid',            '~> 2.3'
+
+	spec.dependency 'hoe-deveiate',            '~> 0.3',  :developer
+	spec.dependency 'simplecov',               '~> 0.7',  :developer
+	spec.dependency 'rdoc-generator-fivefish', '~> 0.1',  :developer
+
+	spec.require_ruby_version( '>=2.2.1' )
+	spec.hg_sign_tags = true if spec.respond_to?( :hg_sign_tags= )
+	spec.check_history_on_release = true if spec.respond_to?( :check_history_on_release= )
+
+	spec.rdoc_locations << "yhaliwell:/usr/local/www/public/chione/docs"
+end
+
+
+
+ENV['VERSION'] ||= hoespec.spec.version.to_s
+
+# Ensure the specs pass before checking in
+task 'hg:precheckin' => [ :check_history, :check_manifest, :gemspec, :spec ]
+
+task :test => :spec
+
+# Rebuild the ChangeLog immediately before release
+task :prerelease => 'ChangeLog'
+CLOBBER.include( 'ChangeLog' )
+
+desc "Build a coverage report"
+task :coverage do
+	ENV["COVERAGE"] = 'yes'
+	Rake::Task[:spec].invoke
+end
+CLOBBER.include( 'coverage' )
+
+
+# Use the fivefish formatter for docs generated from development checkout
+if File.directory?( '.hg' )
+	require 'rdoc/task'
+
+	Rake::Task[ 'docs' ].clear
+	RDoc::Task.new( 'docs' ) do |rdoc|
+	    rdoc.main = "README.rdoc"
+		rdoc.markup = 'markdown'
+	    rdoc.rdoc_files.include( "*.rdoc", "ChangeLog", "lib/**/*.rb" )
+	    rdoc.generator = :fivefish
+		rdoc.title = 'Chione'
+	    rdoc.rdoc_dir = 'doc'
+	end
+end
+
+
+task :gemspec => GEMSPEC
+file GEMSPEC => __FILE__
+task GEMSPEC do |task|
+	spec = $hoespec.spec
+	spec.files.delete( '.gemtest' )
+	spec.signing_key = nil
+	spec.cert_chain = ['certs/ged.pem']
+	spec.version = "#{spec.version.bump}.0.pre#{Time.now.strftime("%Y%m%d%H%M%S")}"
+	File.open( task.name, 'w' ) do |fh|
+		fh.write( spec.to_ruby )
+	end
+end
+
+CLOBBER.include( GEMSPEC.to_s )

data/lib/chione.rb

@@ -0,0 +1,37 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'uuid'
+require 'loggability'
+
+# An Entity/Component System inspired by Artemis
+module Chione
+	extend Loggability
+
+	# Loggability API -- set up a log host
+	log_as :chione
+
+
+	# Gem version
+	VERSION = '0.0.2'
+
+
+	require 'chione/mixins'
+
+	autoload :Aspect,     'chione/aspect'
+	autoload :Assemblage, 'chione/assemblage'
+	autoload :Component,  'chione/component'
+	autoload :Entity,     'chione/entity'
+	autoload :Manager,    'chione/manager'
+	autoload :System,     'chione/system'
+	autoload :World,      'chione/world'
+
+	##
+	# The global UUID object for generating new UUIDs
+	class << self; attr_reader :uuid ; end
+	@uuid = UUID.new
+
+end # module Chione
+
+# vim: set nosta noet ts=4 sw=4:
+

data/lib/chione/aspect.rb

@@ -0,0 +1,163 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'set'
+require 'loggability'
+
+require 'chione' unless defined?( Chione )
+
+
+# An expression of component-matching criteria used to find entities that should be
+# processed by a System.
+class Chione::Aspect
+	extend Loggability
+
+
+	# Loggability API -- log to the chione logger
+	log_to :chione
+
+
+	### Return a new Aspect that will match entities with at least one of the specified
+	### +component_types+.
+	def self::with_one_of( *component_types )
+		return self.new( one_of: component_types.flatten )
+	end
+
+
+	### Return a new Aspect that will match entities with all of the specified
+	### +component_types+.
+	def self::with_all_of( *component_types )
+		return self.new( all_of: component_types.flatten )
+	end
+
+
+	### Return a new Aspect that will match entities with none of the specified
+	### +component_types+.
+	def self::with_none_of( *component_types )
+		return self.new( none_of: component_types.flatten )
+	end
+
+
+	### Create a new empty Aspect
+	def initialize( one_of: [], all_of: [], none_of: [] )
+		@one_of  = Set.new( one_of )
+		@all_of  = Set.new( all_of )
+		@none_of = Set.new( none_of )
+	end
+
+
+	### Copy constructor.
+	def initialize_copy( other )
+		super
+		@one_of  = @one_of.dup
+		@all_of  = @all_of.dup
+		@none_of = @none_of.dup
+	end
+
+
+	######
+	public
+	######
+
+	# The Set of component types which matching entities must have at least one of.
+	attr_reader :one_of
+
+	# The Set of component types which matching entities must have all of.
+	attr_reader :all_of
+
+	# The Set of component types which matching entities must not have any of.
+	attr_reader :none_of
+
+
+	### Return a dup of this Aspect that also requires that matching entities have at least
+	### one of the given +component_types+.
+	def with_one_of( *component_types )
+		return self.dup_with( one_of: component_types.flatten )
+	end
+	alias_method :and_one_of, :with_one_of
+
+
+	### Return a dup of this Aspect that also requires that matching entities have all
+	### of the given +component_types+.
+	def with_all_of( *component_types )
+		return self.dup_with( all_of: component_types.flatten )
+	end
+	alias_method :and_all_of, :with_all_of
+
+
+	### Return a dup of this Aspect that also requires that matching entities have none
+	### of the given +component_types+.
+	def with_none_of( *component_types )
+		return self.dup_with( none_of: component_types.flatten )
+	end
+	alias_method :and_none_of, :with_none_of
+
+
+	### Returns true if the receiver is an empty aspect, i.e., matches all entities.
+	def empty?
+		return [ self.one_of, self.all_of, self.none_of ].all?( &:empty? )
+	end
+
+
+	### Return a human-readable String representation of the Aspect.
+	def inspect
+		parts = []
+		parts << self.one_of_description
+		parts << self.all_of_description
+		parts << self.none_of_description
+		parts.compact!
+
+		str = "#<%p:%#0x matching entities" % [ self.class, self.object_id * 2 ]
+		if parts.empty?
+			str << " with any components"
+		else
+			str << parts.join( ', ' )
+		end
+		str << ">"
+
+		return str
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Return a String describing the components matching entities must have at
+	### least one of.
+	def one_of_description
+		return nil if self.one_of.empty?
+		return " with at least one of: %s" % [ self.one_of.map(&:name).join(', ') ]
+	end
+
+
+	### Return a String describing the components matching entities must have all of.
+	def all_of_description
+		return nil if self.all_of.empty?
+		return " with all of: %s" % [ self.all_of.map(&:name).join(', ') ]
+	end
+
+
+	### Return a String describing the components matching entities must not have any of.
+	def none_of_description
+		return nil if self.none_of.empty?
+		return " with none of: %s" % [ self.none_of.map(&:name).join(', ') ]
+	end
+
+
+	### Return a copy of the receiver with the specified additional +required+ and
+	### +excluded+ components.
+	def dup_with( one_of: [], all_of: [], none_of: [] )
+		self.log.debug "Making dup of %p with one_of: %p, all_of: %p, none_of: %p" %
+			[ self, one_of, all_of, none_of ]
+
+		copy = self.dup
+		copy.one_of.merge( one_of )
+		copy.all_of.merge( all_of )
+		copy.none_of.merge( none_of )
+
+		self.log.debug "  dup is: %p" % [ copy ]
+		return copy
+	end
+
+end # class Chione::Aspect