chione 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 942a44dbe1220f53a15e2677191e58b9a76105e786f35798120dc8d3d3a22312
-  data.tar.gz: e15195e1c3d30184b3f1ee0fde4ec572da7171dd957674099d5b5ec1446afe75
+  metadata.gz: 74a32ca8c0efb477b978216b6371d24c2cf2fabd037dade6424fdf3cda693bc8
+  data.tar.gz: cdc91fa64ece44754a3e4f687836195113779f96f64a7a01dffb64a6dcf3ed75
 SHA512:
-  metadata.gz: a17c48a8a466bc5e734f98d2b6d6ec393e785671ba415cd1ae45b637bc1896a6526cd64b309a9c16db48b8d541f1a2eef47f3517c1ff054a5e6bd20536d28e16
-  data.tar.gz: 7d5afadc0db038a8ff866fb10a237672c2687ea29c49a41f0faf24ee382df690626970336d78da88c3292410f41a38fa87d44dffd9fe3db5833e43d22a58dbff
+  metadata.gz: 1a21d24764d7ca1745ac3dbc5741a0782a569c1beb68cb643de4d6fff5f01ea03f12db588206c5941ed51d7c762210f1b0dba4d45a81b26d44fc7b47144cbe35
+  data.tar.gz: d15d0593e77f38c31fd437d6580e576466ddd45c50646b80502b7196b21ddfad7ca68f3c7a1a3dfdf8ff073d9f5fcacef8cc5711b7978e34de27877ea22116d0

data/ChangeLog

@@ -1,151 +1,3 @@
-2018-06-02  Michael Granger  <ged@FaerieMUD.org>
-
-	* .hgtags:
-	Added tag v0.5.0 for changeset 1fb4fb6761f2
-	[4a799c04f87f] [tip]
-
-	* .hgsigs:
-	Added signature for changeset 8b19a6b5fb12
-	[1fb4fb6761f2] [v0.5.0]
-
-	* History.md, chione.gemspec, lib/chione.rb:
-	Bump the minor version, update history.
-	[8b19a6b5fb12]
-
-	* README.md, Rakefile, chione.gemspec:
-	Update URLs, copyright dates
-	[349fe4d64ec7]
-
-	* lib/chione/archetype.rb, lib/chione/system.rb:
-	Fix blank archetype inspect details
-	[c64a0a142f5e]
-
-	* lib/chione/world.rb, spec/chione/world_spec.rb:
-	Update configuration to use chione namespace
-	[27a0eec7c366]
-
-2017-12-11  Michael Granger  <ged@FaerieMUD.org>
-
-	* .hgtags:
-	Added tag v0.4.0 for changeset 61536d84d951
-	[e23f5a4ba13d]
-
-	* .hgsigs:
-	Added signature for changeset b86a9cde058d
-	[61536d84d951] [v0.4.0]
-
-	* History.md, chione.gemspec, lib/chione.rb:
-	Bump the minor version, update history.
-	[b86a9cde058d]
-
-	* .ruby-version, lib/chione/system.rb, lib/chione/world.rb,
-	spec/chione/system_spec.rb:
-	Refactor tick and timing events.
-
-	COMPAT: the arguments passed to System.every_tick blocks are now
-	only the delta and the tick count.
-	[38c42eb46418]
-
-2017-10-04  Michael Granger  <ged@FaerieMUD.org>
-
-	* lib/chione/world.rb:
-	Normalize entity IDs in the World API
-	[d5736d289092]
-
-	* lib/chione/entity.rb, lib/chione/world.rb,
-	spec/chione/entity_spec.rb:
-	Pass init args through Component.add_component
-	[ba43a21631c5]
-
-	* lib/chione/system.rb:
-	Fix API docs for Chione::System::on
-	[7ee9fc0c0c8e]
-
-	* certs/ged.pem:
-	Update gem-signing cert
-	[e7986014f2c2]
-
-2017-07-21  Michael Granger  <ged@FaerieMUD.org>
-
-	* chione.gemspec, lib/chione.rb, lib/chione/archetype.rb,
-	lib/chione/aspect.rb, lib/chione/component.rb, lib/chione/system.rb,
-	lib/chione/world.rb, spec/chione/archetype_spec.rb,
-	spec/chione/component_spec.rb, spec/chione/system_spec.rb:
-	Work on System execution and Component construction
-
-	- Add constructor arguments to component-creation paths
-	- Add Aspect#archetype and Archetype.from_aspect
-	- Add a processing block to Component field declaration
-	[e0452d211146]
-
-2017-07-12  Michael Granger  <ged@FaerieMUD.org>
-
-	* chione.gemspec, lib/chione.rb, lib/chione/component.rb:
-	Add the entity ID to Component's inspect output
-	[7f1190b563a6]
-
-	* spec/chione/component_spec.rb:
-	Add coverage for Component #inspect.
-	[2de145d530d5]
-
-	* lib/chione/aspect.rb, lib/chione/system.rb, lib/chione/world.rb,
-	spec/chione/aspect_spec.rb, spec/chione/system_spec.rb:
-	Add caching and #inserted/#removed callbacks for aspect-membership
-	to Systems.
-	[6eed9e4055be]
-
-2017-07-11  Michael Granger  <ged@FaerieMUD.org>
-
-	* .gems, Manifest.txt, Rakefile, chione.gemspec,
-	lib/chione/archetype.rb, lib/chione/aspect.rb, lib/chione/entity.rb,
-	lib/chione/fixtures.rb, lib/chione/fixtures/entities.rb,
-	lib/chione/iterating_system.rb, lib/chione/system.rb,
-	lib/chione/world.rb, spec/chione/aspect_spec.rb,
-	spec/chione/iterating_system_spec.rb, spec/chione/system_spec.rb,
-	spec/chione/world_spec.rb, spec/spec_helper.rb:
-	Start adding system execution strategies
-
-	- Add fixtures collection
-	- Add Aspect#matches? to match individual entities
-	- Rename some component-API methods on the World for clarity (with
-	aliases to the old methods)
-	- Add Chione::IteratingSystem
-	- Add stubs for System#inserted and #removed
-	[783c4a657041]
-
-2017-07-07  Michael Granger  <ged@FaerieMUD.org>
-
-	* lib/chione/component.rb, lib/chione/world.rb,
-	spec/chione/component_spec.rb:
-	Add the entity ID to components on registration
-	[cf37f1305ad2]
-
-	* lib/chione/system.rb, spec/chione/system_spec.rb:
-	Remove aspects from event handler declarations.
-	[a8f3ac7113c3]
-
-	* lib/chione/system.rb, spec/chione/aspect_spec.rb,
-	spec/chione/system_spec.rb:
-	Checkpoint before undoing experimental event-based system execution
-	model
-	[f89f24dfb25c]
-
-2017-07-05  Michael Granger  <ged@FaerieMUD.org>
-
-	* lib/chione/system.rb, lib/chione/world.rb,
-	spec/chione/system_spec.rb:
-	Add execution models to Systems
-	[c9e80cf737e7]
-
-2017-06-30  Michael Granger  <ged@FaerieMUD.org>
-
-	* README.md, lib/chione/archetype.rb, lib/chione/aspect.rb,
-	lib/chione/entity.rb, lib/chione/system.rb, lib/chione/world.rb,
-	spec/chione/aspect_spec.rb, spec/chione/entity_spec.rb,
-	spec/chione/system_spec.rb, spec/chione/world_spec.rb:
-	Refactor for thinner entities and systems with named aspects
-	[d69678296749]
-
 2017-06-06  Michael Granger  <ged@FaerieMUD.org>
 
 	* lib/chione/aspect.rb, lib/chione/component.rb, lib/chione/entity.rb,
@@ -153,7 +5,7 @@
 	Pull up common #inspect functionality into a mixin
 
 	...and use it everywhere.
-	[0eb1e6c25953]
+	[0eb1e6c25953] [tip]
 
 	* lib/chione/world.rb, spec/chione/world_spec.rb:
 	Added World#remove_system and _manager; publish the instance of
@@ -164,7 +16,7 @@
 
 	* .hgtags:
 	Added tag v0.3.0 for changeset c91f71b3d7d9
-	[06fdcde9eb00]
+	[06fdcde9eb00] [github/master]
 
 	* .hgsigs:
 	Added signature for changeset 0d453cae95c3

data/History.md

@@ -1,3 +1,11 @@
+## v0.6.0 [2018-07-05] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Add dependency-injection to Chione::System
+- Set the thread name of the main world thread
+
+
 ##  v0.5.0 [2018-06-02] Michael Granger <ged@FaerieMUD.org>
 
 Bugfixes:

data/Rakefile

@@ -44,7 +44,7 @@ hoespec = Hoe.spec 'chione' do |spec|
 	spec.dependency 'rdoc-generator-fivefish', '~> 0.3',  :developer
 	spec.dependency 'rdoc',                    '~> 5.1',  :developer
 
-	spec.require_ruby_version( '>=2.3.3' )
+	spec.require_ruby_version( '>=2.5.0' )
 	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= )
 

data/lib/chione.rb

@@ -12,7 +12,7 @@ module Chione
 	extend Loggability
 
 	# Gem version
-	VERSION = '0.5.0'
+	VERSION = '0.6.0'
 
 
 	# Loggability API -- set up a log host

data/lib/chione/system.rb

@@ -46,6 +46,10 @@ class Chione::System
 	# System is started.
 	singleton_attr_reader :event_handlers
 
+	##
+	# Systems to be injected by the world when this System is started.
+	singleton_attr_reader :injected_systems
+
 
 	### Add the specified +component_types+ to the Aspect of this System as being
 	### required in any entities it processes.
@@ -62,6 +66,18 @@ class Chione::System
 	end
 
 
+	### Dependency-injection: declare one or more +systems+ that should be passed to #start
+	### by the running World.
+	def self::inject( *systems )
+		systems.each do |system_type|
+			system_type = system_type.to_sym
+			system_class = Chione::System.get_subclass( system_type )
+			attr_accessor( "#{system_type}_system" )
+			self.injected_systems[ system_type ] = system_class
+		end
+	end
+
+
 	### Declare a block that is called once whenever an event matching +event_name+ is
 	### broadcast to the World.
 	def self::on( event_name, &block )
@@ -91,6 +107,7 @@ class Chione::System
 		super
 		subclass.instance_variable_set( :@aspects, DEFAULT_ASPECT_HASH.clone )
 		subclass.instance_variable_set( :@event_handlers, self.event_handlers&.dup || [] )
+		subclass.instance_variable_set( :@injected_systems, self.injected_systems&.dup || {} )
 	end
 
 
@@ -120,9 +137,14 @@ class Chione::System
 
 
 	### Start the system.
-	def start
-		self.log.info "Starting the %p system; %d event handlers to register" %
-			[ self.class, self.class.event_handlers.length ]
+	def start( **injected_systems )
+		self.log.info "Starting the %p system; %d injected systems, %d event handlers to register" %
+			[ self.class, injected_systems.length, self.class.event_handlers.length ]
+
+		injected_systems.each do |name, other_system|
+			self.public_send( "#{name}_system=", other_system )
+		end
+
 		self.class.event_handlers.each do |event_name, method_name|
 			callback = self.method( method_name )
 			self.log.info "Registering %p as a callback for '%s' events." % [ callback, event_name ]

data/lib/chione/world.rb

@@ -114,7 +114,8 @@ class Chione::World
 	def start
 		@main_thread = Thread.new do
 			Thread.current.abort_on_exception = true
-			self.log.info "Main thread (%s) started." % [ Thread.current ]
+			Thread.current.name = "Main World"
+			self.log.info "Main thread (%p) started." % [ Thread.current ]
 			@world_threads.add( Thread.current )
 			@world_threads.enclose
 
@@ -162,9 +163,11 @@ class Chione::World
 	def start_systems
 		self.log.info "Starting %d Systems" % [ self.systems.length ]
 		self.systems.each do |system_class, sys|
+			injections = self.make_injection_hash_for( system_class )
+
 			self.log.debug "  starting %p" % [ system_class ]
 			start = Time.now
-			sys.start
+			sys.start( **injections )
 			finish = Time.now
 			self.log.debug "  started in %0.5fs" % [ finish - start ]
 		end
@@ -499,6 +502,21 @@ class Chione::World
 	protected
 	#########
 
+	### Return a Hash of the loaded Chione::Systems that +system_class+ has requested
+	### be injected into it.
+	def make_injection_hash_for( system_class )
+		self.log.debug "Injecting %d other system/s into %p" %
+			[ system_class.injected_systems.length, system_class ]
+		return system_class.injected_systems.each_with_object({}) do |(name, injected_class), hash|
+			self.log.debug "  inject %p: %p" % [ name, injected_class ]
+			system = self.systems[ injected_class ] or
+				raise "Can't inject %p into %p: not configured to run it" %
+					[ injected_class, system_class]
+			hash[ name ] = system
+		end
+	end
+
+
 	### Update any entity caches in the system when an +entity+ has its +components+ hash changed.
 	def update_entity_caches( entity, components )
 		entity = entity.id if entity.respond_to?( :id )

data/spec/chione/system_spec.rb

@@ -290,5 +290,62 @@ describe Chione::System do
 
 	end
 
+
+	describe "dependency-injection" do
+
+		let( :subclass1 ) do
+			Class.new( described_class )
+		end
+		let( :subclass2 ) do
+			Class.new( described_class )
+		end
+		let( :world ) { Chione::World.new }
+
+
+		before( :each ) do
+			@real_derivatives = described_class.derivatives.dup
+			# Pretend that the anonymous classes have names so they can be injected by name
+			described_class.derivatives.merge!( 'events' => subclass1, 'physics' => subclass2 )
+		end
+
+		after( :each ) do
+			described_class.derivatives.replace( @real_derivatives )
+		end
+
+
+		it "allows one system to have another system injected into it" do
+			subclass1.inject( :physics )
+
+			world.add_system( subclass1 )
+			world.add_system( subclass2 )
+			world.start_systems
+
+			result = world.systems[ subclass1 ].physics_system
+
+			expect( result ).to be_a( subclass2 )
+		end
+
+
+		it "allows systems to inject one another" do
+			subclass1.inject( :physics )
+			subclass2.inject( :events )
+
+			world.add_system( subclass1 )
+			world.add_system( subclass2 )
+			world.start_systems
+
+			expect( world.systems[subclass1].physics_system ).to be_a( subclass2 )
+			expect( world.systems[subclass2].events_system ).to be_a( subclass1 )
+		end
+
+
+		it "raises an error if the system to inject can't be loaded" do
+			expect {
+				subclass1.inject( :tantalus )
+			}.to raise_error( /couldn't find a system named 'tantalus'/i )
+		end
+
+	end
+
 end
 

data/spec/chione/world_spec.rb

@@ -410,6 +410,22 @@ describe Chione::World do
 			world.stop
 		end
 
+
+		it "raises an error if a system wants to inject a system that hasn't been added" do
+			@real_derivatives = Chione::System.derivatives.dup
+			Chione::System.derivatives[ 'warning' ] = Class.new( Chione::System ) do
+				def self::name; "WarningSystem"; end
+			end
+			test_system.inject( :warning )
+			world.add_system( test_system )
+
+			expect {
+				world.start_systems
+			}.to raise_error( /can't inject/i )
+		ensure
+			Chione::System.derivatives.replace( @real_derivatives )
+		end
+
 	end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chione
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Michael Granger
@@ -35,7 +35,7 @@ cert_chain:
   X0qdrKi+2aZZ0NGuFj9AItBsVmAvkBGIpX4TEKQp5haEbPpmaqO5nIIhV26PXmyT
   OMKv6pWsoS81vw5KAGBmfX8nht/Py90DQrbRvakATGI=
   -----END CERTIFICATE-----
-date: 2018-06-02 00:00:00.000000000 Z
+date: 2018-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -298,7 +298,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.3
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -306,7 +306,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: An Entity/Component System framework inspired by Artemis