chione 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9b24299f45b2755cca922ee6762900f1afb4b2b7
-  data.tar.gz: e4bb1a2a39c594b2ecee9e898b358f138c9d6ce7
+SHA256:
+  metadata.gz: ef14891907c37d8047d88177ab303208f073f8e0e33e940cbf56989a1e45e3ac
+  data.tar.gz: 35eaace97f89719cd01ba69fa437baed47bdfc8bcb84f918ba4c7e0ce08c512e
 SHA512:
-  metadata.gz: fde13065c29d54acf5e355456f146740ed8a6f4a02084dff417944fae714e9395f566b2b717eef18ea398e4a7e9940f8f57871e1d9eb140ce60aa99bdaf45856
-  data.tar.gz: 19d74ac66382bd50991a149ff5082346ba6eb67cbf0a629852051f19361bde42e3b7ec1e2b3279f128dbca377e94e8057df88b8eca349bed45480f0cb5caea4f
+  metadata.gz: a2d8877f54851147ce6760c041e302fce3e1e1a55b6d64eaa0122c173b13b61b188d47d3bac630438bac81d25bf5b32b26d9b206ee6129b4513e459564183309
+  data.tar.gz: b085ac2e31c52eeeaee5f9776a1049ba6172c1d05927ea72b8229f8476c080a93cc732e9ab17c12cabc940630a056908c5a48277cb89785e44bf816b31245867

data/ChangeLog

@@ -1,8 +1,22 @@
+2017-06-06  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/chione/aspect.rb, lib/chione/component.rb, lib/chione/entity.rb,
+	lib/chione/manager.rb, lib/chione/mixins.rb, lib/chione/system.rb:
+	Pull up common #inspect functionality into a mixin
+
+	...and use it everywhere.
+	[0eb1e6c25953] [tip]
+
+	* lib/chione/world.rb, spec/chione/world_spec.rb:
+	Added World#remove_system and _manager; publish the instance of
+	/added and /removed events
+	[426735589cee]
+
 2017-05-31  Michael Granger  <ged@FaerieMUD.org>
 
 	* .hgtags:
 	Added tag v0.3.0 for changeset c91f71b3d7d9
-	[06fdcde9eb00] [tip]
+	[06fdcde9eb00] [github/master]
 
 	* .hgsigs:
 	Added signature for changeset 0d453cae95c3
@@ -19,7 +33,7 @@
 	* lib/chione.rb, lib/chione/archetype.rb, lib/chione/assemblage.rb,
 	spec/chione/archetype_spec.rb:
 	Add more backward-compat for Chione::Assemblage
-	[a2e8b35fb950] [github/master]
+	[a2e8b35fb950]
 
 	* .gems, Manifest.txt, Rakefile, chione.gemspec, lib/chione.rb,
 	lib/chione/archetype.rb, lib/chione/assemblage.rb,

data/History.md

@@ -1,3 +1,34 @@
+## v0.4.0 [2017-12-11] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Add caching and #inserted/#removed callbacks for aspect-membership to Systems.
+- Add Aspect#archetype and Archetype.from_aspect
+- Add Aspect#matches? to match individual entities
+- Add fixtures collection
+- Normalize entity IDs in the World API
+- Add constructor arguments to component-creation paths
+- Add the entity ID to Component's inspect output
+- Add Chione::IteratingSystem
+- Entities are thinner and systems make better use of named aspects
+- Added World#remove_system and _manager; publish the instance of /added and /removed events
+- Pull up common #inspect functionality into a mixin and use it everywhere.
+
+Changes:
+
+- The `every_tick` callback is now only passed the delta and the tick count
+- Init arguments are passed through to Component.add_component
+- Add a processing block to Component field declaration
+- Rename some component-API methods on the World for clarity (with aliases to the old methods)
+- Add the entity ID to components on registration
+- Event handler declarations no longer include an aspect.
+
+Bugfixes:
+
+- Fix API docs for Chione::System::on
+
+
+
 ##  v0.3.0 [2017-05-31] Michael Granger <ged@FaerieMUD.org>
 
 Changes:

data/Manifest.txt

@@ -12,6 +12,9 @@ lib/chione/assemblage.rb
 lib/chione/behaviors.rb
 lib/chione/component.rb
 lib/chione/entity.rb
+lib/chione/fixtures.rb
+lib/chione/fixtures/entities.rb
+lib/chione/iterating_system.rb
 lib/chione/manager.rb
 lib/chione/mixins.rb
 lib/chione/system.rb
@@ -20,6 +23,7 @@ spec/chione/archetype_spec.rb
 spec/chione/aspect_spec.rb
 spec/chione/component_spec.rb
 spec/chione/entity_spec.rb
+spec/chione/iterating_system_spec.rb
 spec/chione/manager_spec.rb
 spec/chione/mixins_spec.rb
 spec/chione/system_spec.rb

data/README.md

@@ -40,24 +40,28 @@ for making it better via email or whatever.
 
 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/
+* <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)
-
+* <https://github.com/junkdog/artemis-odb> (Java)
+* <http://www.richardlord.net/ash/> (ActionScript)
+* <https://github.com/libgdx/ashley> (Java)
+* <https://github.com/astrosilverio/braga> (Python)
+* <https://github.com/seanfisk/ecs> (Python)
+* <https://github.com/tdavies/Ember2> (ActionScript)
+* <https://github.com/cpowell/ruby-entity-component-framework> (JRuby)
+* <https://github.com/alecmce/xember> (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].
+[project page][bitbucket]. Or if you prefer Git, via
+[its Github mirror][github].
 
 After checking out the source, run:
 
@@ -98,3 +102,6 @@ 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.
 
 
+[bitbucket]: http://bitbucket.org/ged/chione
+[github]: https://github.com/ged/chione
+

data/Rakefile

@@ -36,6 +36,8 @@ hoespec = Hoe.spec 'chione' do |spec|
 	spec.dependency 'pluggability',    '~> 0.4'
 	spec.dependency 'uuid',            '~> 2.3'
 	spec.dependency 'deprecatable',    '~> 1.0'
+	spec.dependency 'fluent_fixtures', '~> 0.6'
+	spec.dependency 'faker',           '~> 1.8'
 
 	spec.dependency 'hoe-deveiate',            '~> 1.0',  :developer
 	spec.dependency 'simplecov',               '~> 0.12',  :developer

data/lib/chione.rb

@@ -12,7 +12,7 @@ module Chione
 	extend Loggability
 
 	# Gem version
-	VERSION = '0.3.0'
+	VERSION = '0.4.0'
 
 
 	# Loggability API -- set up a log host
@@ -26,9 +26,12 @@ module Chione
 	autoload :Component,  'chione/component'
 	autoload :Entity,     'chione/entity'
 	autoload :Manager,    'chione/manager'
-	autoload :System,     'chione/system'
 	autoload :World,      'chione/world'
 
+	autoload :System,          'chione/system'
+	autoload :IteratingSystem, 'chione/iterating_system'
+
+
 	##
 	# The global UUID object for generating new UUIDs
 	class << self; attr_reader :uuid ; end
@@ -36,9 +39,9 @@ module Chione
 
 
 	### Coerce the specified +object+ into a Chione::Component and return it.
-	def self::Component( object )
+	def self::Component( object, init_values={} )
 		return object if object.is_a?( Chione::Component )
-		return Chione::Component.create( object ) if
+		return Chione::Component.create( object, init_values ) if
 			object.is_a?( Class ) || object.is_a?( String ) || object.is_a?( Symbol )
 		raise TypeError, "can't convert %p into Chione::Component" % [ object.class ]
 	end

data/lib/chione/archetype.rb

@@ -5,6 +5,7 @@ require 'pluggability'
 require 'loggability'
 
 require 'chione' unless defined?( Chione )
+require 'chione/mixins'
 
 
 # An Archetype mixin for defining factories for common entity configurations.
@@ -21,10 +22,29 @@ module Chione::Archetype
 
 	### Extension callback -- add archetype functionality to an extended +object+.
 	def self::extended( object )
-		super
 		object.extend( Loggability )
+		# object.extend( Chione::Inspection )
+		object.extend( Chione::MethodUtilities )
+
+		super
+
 		object.log_to( :chione )
 		object.components ||= {}
+		object.singleton_attr_accessor :from_aspect
+	end
+
+
+	### Create an anonymous Archetype Module that will create entities which match
+	### the specified +aspect+ (Chione::Aspect).
+	def self::from_aspect( aspect )
+		mod = Module.new
+		mod.extend( self )
+		mod.from_aspect = aspect
+
+		aspect.all_of.each( &mod.method(:add) )
+		mod.add( aspect.one_of.first ) unless aspect.one_of.empty?
+
+		return mod
 	end
 
 
@@ -57,15 +77,41 @@ module Chione::Archetype
 	### Construct a new entity for the specified +world+ with all of the archetype's
 	### components.
 	def construct_for( world )
-		entity = world.create_entity
+		entity = world.create_blank_entity
 		self.components.each do |component_type, args|
 			component = component_type.new( *args )
-			entity.add_component( component )
+			world.add_component_to( entity, component )
 		end
 
 		return entity
 	end
 
+
+	### Return a human-readable representation of the object suitable for debugging.
+	def inspect
+		return "#<%p:%#016x %s>" % [
+			self.class,
+			self.object_id * 2,
+			self.inspect_details,
+		]
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Provide details about the Archetype for #inspect output.
+	def inspect_details
+		if self.from_aspect
+			return "Chione::Archetype from %p" % [ self.from_aspect ]
+		else
+			return "Chione::Archetype for creating entities with %s" %
+				[ self.components.keys.map( &:name ).join(', ') ]
+		end
+	end
+
+
 end # module Chione::Archetype
 
 

data/lib/chione/aspect.rb

@@ -5,13 +5,15 @@ require 'set'
 require 'loggability'
 
 require 'chione' unless defined?( Chione )
+require 'chione/mixins'
+require 'chione/archetype'
 
 
 # An expression of component-matching criteria used to find entities that should be
 # processed by a System.
 class Chione::Aspect
 	extend Loggability
-
+	include Chione::Inspection
 
 	# Loggability API -- log to the chione logger
 	log_to :chione
@@ -95,34 +97,74 @@ class Chione::Aspect
 
 	### 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? )
+		return self.one_of.empty? && self.all_of.empty? && self.none_of.empty?
+	end
+
+
+	### Returns +true+ if the components contained in the specified +component_hash+
+	### match the Aspect's specifications.
+	def matches?( component_hash )
+		return true if self.empty?
+
+		component_hash = component_hash.components if component_hash.respond_to?( :components )
+
+		return false unless self.one_of.empty? ||
+			self.one_of.any? {|component| component_hash.key?(component) }
+		return false unless self.none_of.none? {|component| component_hash.key?(component) }
+		return false unless self.all_of.all? {|component| component_hash.key?(component) }
+
+		return true
+	end
+	alias_method :match, :matches?
+
+
+	### Given an +entity_hash+ keyed by Component class, return the subset of
+	### values matching the receiving Aspect.
+	def matching_entities( entity_hash )
+		initial_set = if self.one_of.empty?
+				entity_hash.values
+			else
+				entity_hash.values_at( *self.one_of )
+			end
+
+		with_one = initial_set.reduce( :| ) || Set.new
+		with_all = entity_hash.values_at( *self.all_of ).reduce( with_one, :& )
+		without_any = entity_hash.values_at( *self.none_of ).reduce( with_all, :- )
+
+		return without_any
 	end
 
 
-	### Return a human-readable String representation of the Aspect.
-	def inspect
+	### Return an (anonymous) Chione::Archetype module that can be used to create
+	### entities that match it.
+	def archetype
+		return Chione::Archetype.from_aspect( self )
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Return the detail part of the #inspect output.
+	def inspect_details
 		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 ]
+		str = "matching entities"
 		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

data/lib/chione/component.rb

@@ -14,6 +14,9 @@ class Chione::Component
 	    Pluggability,
 		Chione::MethodUtilities
 
+	include Chione::Inspection
+
+
 	# Loggability API -- log to the 'chione' logger
 	log_to :chione
 
@@ -26,16 +29,32 @@ class Chione::Component
 
 
 	### Declare a field for the component named +name+, with a default value of
-	### +default+.
-	def self::field( name, default: nil )
+	### +default+. If the optional +process_block+ is provided, it will be called
+	### with the new value being assigned to the field before it is set, and the
+	### return value of it will be used instead.
+	def self::field( name, default: nil, &process_block )
 		self.fields ||= {}
 		self.fields[ name ] = default
-		attr_accessor( name )
+
+		define_method( "process_#{name}", &process_block ) if process_block
+		define_method( "#{name}=" ) do |new_val|
+			new_val = self.send( "process_#{name}", new_val ) if self.respond_to?( "process_#{name}" )
+			self.instance_variable_set( "@#{name}", new_val )
+		end
+
+		attr_reader( name )
 	end
 
 
 	### Create a new component with the specified +values+.
-	def initialize( values={} )
+	def initialize( entity_id=nil, values={} )
+		if entity_id.is_a?( Hash )
+			values = entity_id
+			entity_id = nil
+		end
+
+		@entity_id = entity_id
+
 		if self.class.fields
 			self.class.fields.each do |name, default|
 				self.method( "#{name}=" ).call( values[name] || default_value(default) )
@@ -44,10 +63,25 @@ class Chione::Component
 	end
 
 
-	### Return a human-readable representation of the object suitable for debugging.
-	def inspect
-		fields_desc = self.fields_description
-		return "#<%p:%#x %s>" % [ self.class, self.object_id * 2, fields_desc ]
+	######
+	public
+	######
+
+	##
+	# The ID of the entity the component belongs to
+	attr_accessor :entity_id
+
+
+	#########
+	protected
+	#########
+
+	### Return the detailed part of the Component's #inspect output.
+	def inspect_details
+		return "{%s} %s" % [
+			self.entity_id || "(unassigned)",
+			self.fields_description
+		]
 	end
 
 
@@ -63,6 +97,7 @@ class Chione::Component
 	end
 
 
+
 	#######
 	private
 	#######