chione 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4db53fed99c571b08d2413fc895bc32eef38194
-  data.tar.gz: 17972162d89c66ebc0d4e1f35aa2af2c667c6437
+  metadata.gz: e3f59bc83b67172347b8bdfba8dde65806c4d166
+  data.tar.gz: 1e55f3d92ded7e6250ab83207d548a5a7c4da4a2
 SHA512:
-  metadata.gz: e0e7538d0a928b90104586a5d70ee46068c2d8b8999b940e40a0f342720ec33c8f3407eea3a9baab2ae244330314175438a4975c32e3ba0486f09522a5c5d09b
-  data.tar.gz: 8af6a0b44089392eee195ea85fbdc57a9bc9f69f3b5cab431a7321185a1afcc84ce7d99a304a9c7f9de12f74c49a9da182912a70f42968ae6ce60e11723274b5
+  metadata.gz: 1e214f19a70f22f2556649740985d211918697acea54942fd76820f500e50f42100b9eed42ce31fbed112be5b82f54282c5a674487262cd0a8df40bacef61266
+  data.tar.gz: 75323d5fd8dd00fa7f78b22d5150e26e2112fb16c3a0b049ecce5753687bcc76cd3980f340515955607e49bad3c71420cefe31752243185007b85b9175e48ebb

data/History.md

@@ -0,0 +1,21 @@
+## v0.0.3 [2017-01-04] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Add a proper #inspect to Component
+
+Bugfixes:
+
+- Fix misnamed attr in World, update to latest Configurability syntax
+- Fix some documentation typos.
+
+
+## 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

@@ -1,9 +1,9 @@
 .rdoc_options
 .simplecov
 ChangeLog
-History.rdoc
+History.md
 Manifest.txt
-README.rdoc
+README.md
 Rakefile
 lib/chione.rb
 lib/chione/aspect.rb

data/{README.rdoc → README.md}

@@ -1,12 +1,19 @@
-= Chione
+# Chione
 
-home   :: http://faelidth.org/chione
-code   :: http://bitbucket.org/ged/chione
-github :: http://github.com/ged/chione
-docs   :: http://faelidth.org/chione/docs
+home
+: http://faelidth.org/chione
 
+code
+: http://bitbucket.org/ged/chione
 
-== Description
+github
+: http://github.com/ged/chione
+
+docs
+: http://faelidth.org/chione/docs
+
+
+## Description
 
 An Entity/Component System framework inspired by Artemis.
 
@@ -16,23 +23,20 @@ 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]
-
+for making it better via email or whatever.
 
 
-== Prerequisites
+## Prerequisites
 
-* Ruby 2.2
+* Ruby 2.3
 
 
-== Installation
+## Installation
 
     $ gem install chione
 
 
-== Resources
+## Resources
 
 Articles/posts on ECS:
 
@@ -49,10 +53,10 @@ Other ECS Frameworks:
 * http://www.ashframework.org/ (ActionScript)
 
 
-== Contributing
+## 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 
+{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:
@@ -63,9 +67,9 @@ This task will install any missing dependencies, run the tests/specs,
 and generate the API documentation.
 
 
-== License
+## License
 
-Copyright (c) 2015, Michael Granger
+Copyright (c) 2015-2017, Michael Granger
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Rakefile

@@ -18,21 +18,28 @@ 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.readme_file = 'README.md'
+	spec.history_file = 'History.md'
+	spec.extra_rdoc_files = FileList[ '*.rdoc', '*.md' ]
+	spec.license 'BSD-3-Clause'
+	spec.urls = {
+		home:   'http://deveiate.org/projects/LinguaThauma',
+		code:   'http://repo.deveiate.org/LinguaThauma',
+		docs:   'http://deveiate.org/code/LinguaThauma',
+		github: 'http://github.com/ged/LinguaThauma',
+	}
 
 	spec.developer 'Michael Granger', 'ged@FaerieMUD.org'
 
-	spec.dependency 'loggability',     '~> 0.11'
-	spec.dependency 'configurability', '~> 2.2'
+	spec.dependency 'loggability',     '~> 0.12'
+	spec.dependency 'configurability', '~> 3.0'
 	spec.dependency 'uuid',            '~> 2.3'
 
-	spec.dependency 'hoe-deveiate',            '~> 0.3',  :developer
-	spec.dependency 'simplecov',               '~> 0.7',  :developer
+	spec.dependency 'hoe-deveiate',            '~> 0.8',  :developer
+	spec.dependency 'simplecov',               '~> 0.12',  :developer
 	spec.dependency 'rdoc-generator-fivefish', '~> 0.1',  :developer
 
-	spec.require_ruby_version( '>=2.2.1' )
+	spec.require_ruby_version( '>=2.3.3' )
 	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

@@ -13,7 +13,7 @@ module Chione
 
 
 	# Gem version
-	VERSION = '0.0.2'
+	VERSION = '0.0.3'
 
 
 	require 'chione/mixins'

data/lib/chione/assemblage.rb

@@ -6,7 +6,7 @@ require 'loggability'
 require 'chione' unless defined?( Chione )
 
 
-# An Assemblage mixin for defining factories for commmon entity configurations.
+# An Assemblage mixin for defining factories for common entity configurations.
 module Chione::Assemblage
 	extend Loggability
 

data/lib/chione/component.rb

@@ -1,10 +1,17 @@
 # -*- ruby -*-
 #encoding: utf-8
 
+require 'loggability'
+
 require 'chione' unless defined?( Chione )
 
 # The Component (data) class
 class Chione::Component
+	extend Loggability
+
+	# Loggability API -- log to the 'chione' logger
+	log_to :chione
+
 
 	# The Hash of fields implemented by the component
 	class << self
@@ -31,13 +38,32 @@ 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 ]
+	end
+
+
+	### Return a description of the fields this component has.
+	def fields_description
+		return self.class.fields.keys.collect do |name|
+			val = self.instance_variable_get( "@#{name}" )
+			"%s: %s" % [
+				name,
+				truncate_string( val.inspect, 20 )
+			]
+		end.join( ' ' )
+	end
+
+
 	#######
 	private
 	#######
 
 	### Make a deep copy of the specified +value+.
 	def deep_copy( value )
-		Marshal.load( Marshal.dump(value) )
+		return Marshal.load( Marshal.dump(value) )
 	end
 
 end # class Chione::Component

data/lib/chione/mixins.rb

@@ -8,15 +8,15 @@ module Chione
 
 	# A collection of methods for declaring other methods.
 	#
-	#   class MyClass
-	#       extend Chione::MethodUtilities
+	#     class MyClass
+	#         extend Chione::MethodUtilities
 	#
-	#       singleton_attr_accessor :types
-	#       singleton_method_alias :kinds, :types
-	#   end
+	#         singleton_attr_accessor :types
+	#         singleton_method_alias :kinds, :types
+	#     end
 	#
-	#   MyClass.types = [ :pheno, :proto, :stereo ]
-	#   MyClass.kinds # => [:pheno, :proto, :stereo]
+	#     MyClass.types = [ :pheno, :proto, :stereo ]
+	#     MyClass.kinds # => [:pheno, :proto, :stereo]
 	#
 	module MethodUtilities
 

data/lib/chione/world.rb

@@ -19,41 +19,23 @@ class Chione::World
 	log_to :chione
 
 	# Configurability API -- use the 'gameworld' section of the config
-	config_key :gameworld
+	configurability :gameworld do
 
+		##
+		# :singleton-method:
+		# Configurable: The maximum number of seconds to wait for any one System
+		# or Manager thread to exit before killing it when shutting down.
+		setting :max_stop_wait, default: 5
 
-	# Default config tunables
-	CONFIG_DEFAULTS = {
-		max_stop_wait: 5,
-		timing_event_interval: 1,
-	}
+		##
+		# :singleton-method:
+		# Configurable: The number of seconds between timing events.
+		setting :timing_event_interval, default: 1
 
-
-	##
-	# :singleton-method:
-	# Configurable: The maximum number of seconds to wait for any one System
-	# or Manager thread to exit before killing it when shutting down.
-	singleton_attr_accessor :max_stop_wait
-	@max_stop_wait = CONFIG_DEFAULTS[:max_stop_wait]
-
-	##
-	# :singleton-method:
-	# Configurable: The number of seconds between timing events.
-	singleton_attr_accessor :timing_event_interval
-	@timing_event_interval = CONFIG_DEFAULTS[ :timing_event_interval ]
-
-
-	### Configurability API -- configure the GameWorld.
-	def self::configure( config=nil )
-		config = self.defaults.merge( config || {} )
-
-		self.max_stop_wait = config[:max_stop_wait]
-		self.timing_event_interval = config[:timing_event_interval]
 	end
 
 
 
-
 	### Create a new Chione::World
 	def initialize
 		@entities      = {}
@@ -93,7 +75,7 @@ class Chione::World
 	attr_reader :world_threads
 
 	# The Thread object running the World's IO reactor loop
-	attr_reader :io_thread
+	attr_reader :main_thread
 
 	# The Hash of event subscription callbacks registered with the world, keyed by
 	# event pattern.
@@ -325,7 +307,7 @@ class Chione::World
 	#########
 
 	### The loop the main thread executes after the world is started. The default
-	### implementation just broadcasts the +timing+ event, so will likely want to
+	### implementation just broadcasts the +timing+ event, so you will likely want to
 	### override this if the main thread should do something else.
 	def timing_loop
 		self.log.info "Starting timing loop."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chione
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Michael Granger
@@ -10,27 +10,32 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDbDCCAlSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA+MQwwCgYDVQQDDANnZWQx
+  MIIEbDCCAtSgAwIBAgIBATANBgkqhkiG9w0BAQsFADA+MQwwCgYDVQQDDANnZWQx
   GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
-  HhcNMTUwNDAxMjEyNDEzWhcNMTYwMzMxMjEyNDEzWjA+MQwwCgYDVQQDDANnZWQx
+  HhcNMTYwODIwMTgxNzQyWhcNMTcwODIwMTgxNzQyWjA+MQwwCgYDVQQDDANnZWQx
   GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
-  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDb92mkyYwuGBg1oRxt2tkH
-  +Uo3LAsaL/APBfSLzy8o3+B3AUHKCjMUaVeBoZdWtMHB75X3VQlvXfZMyBxj59Vo
-  cDthr3zdao4HnyrzAIQf7BO5Y8KBwVD+yyXCD/N65TTwqsQnO3ie7U5/9ut1rnNr
-  OkOzAscMwkfQxBkXDzjvAWa6UF4c5c9kR/T79iA21kDx9+bUMentU59aCJtUcbxa
-  7kcKJhPEYsk4OdxR9q2dphNMFDQsIdRO8rywX5FRHvcb+qnXC17RvxLHtOjysPtp
-  EWsYoZMxyCDJpUqbwoeiM+tAHoz2ABMv3Ahie3Qeb6+MZNAtMmaWfBx3dg2u+/WN
-  AgMBAAGjdTBzMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBSZ0hCV
-  qoHr122fGKelqffzEQBhszAcBgNVHREEFTATgRFnZWRARmFlcmllTVVELm9yZzAc
-  BgNVHRIEFTATgRFnZWRARmFlcmllTVVELm9yZzANBgkqhkiG9w0BAQUFAAOCAQEA
-  lUKo3NXePpuvN3QGsOLJ6QhNd4+Q9Rz75GipuMrCl296V8QFkd2gg9EG44Pqtk+9
-  Zac8TkKc9bCSR0snakp+cCPplVvZF0/gMzkSTUJkDBHlNV16z73CyWpbQQa+iLJ4
-  uisI6gF2ZXK919MYLn2bFJfb7OsCvVfyTPqq8afPY+rq9vlf9ZPwU49AlD8bPRic
-  0LX0gO5ykvETIOv+WgGcqp96ceNi9XVuJMh20uWuw6pmv/Ub2RqAf82jQSbpz09G
-  G8LHR7EjtPPmqCCunfyecJ6MmCNaiJCBxq2NYzyNmluPyHT8+0fuB5kccUVZm6CD
-  xn3DzOkDE6NYbk8gC9rTsA==
+  ggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC/JWGRHO+USzR97vXjkFgt
+  83qeNf2KHkcvrRTSnR64i6um/ziin0I0oX23H7VYrDJC9A/uoUa5nGRJS5Zw/+wW
+  ENcvWVZS4iUzi4dsYJGY6yEOsXh2CcF46+QevV8iE+UmbkU75V7Dy1JCaUOyizEt
+  TH5UHsOtUU7k9TYARt/TgYZKuaoAMZZd5qyVqhF1vV+7/Qzmp89NGflXf2xYP26a
+  4MAX2qqKX/FKXqmFO+AGsbwYTEds1mksBF3fGsFgsQWxftG8GfZQ9+Cyu2+l1eOw
+  cZ+lPcg834G9DrqW2zhqUoLr1MTly4pqxYGb7XoDhoR7dd1kFE2a067+DzWC/ADt
+  +QkcqWUm5oh1fN0eqr7NsZlVJDulFgdiiYPQiIN7UNsii4Wc9aZqBoGcYfBeQNPZ
+  soo/6za/bWajOKUmDhpqvaiRv9EDpVLzuj53uDoukMMwxCMfgb04+ckQ0t2G7wqc
+  /D+K9JW9DDs3Yjgv9k4h7YMhW5gftosd+NkNC/+Y2CkCAwEAAaN1MHMwCQYDVR0T
+  BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFHKN/nkRusdqCJEuq3lgB3fJvyTg
+  MBwGA1UdEQQVMBOBEWdlZEBGYWVyaWVNVUQub3JnMBwGA1UdEgQVMBOBEWdlZEBG
+  YWVyaWVNVUQub3JnMA0GCSqGSIb3DQEBCwUAA4IBgQAPJzKiT0zBU7kpqe0aS2qb
+  FI0PJ4y5I8buU4IZGUD5NEt/N7pZNfOyBxkrZkXhS44Fp+xwBH5ebLbq/WY78Bqd
+  db0z6ZgW4LMYMpWFfbXsRbd9TU2f52L8oMAhxOvF7Of5qJMVWuFQ8FPagk2iHrdH
+  inYLQagqAF6goWTXgAJCdPd6SNeeSNqA6vlY7CV1Jh5kfNJJ6xu/CVij1GzCLu/5
+  DMOr26DBv+qLJRRC/2h34uX71q5QgeOyxvMg+7V3u/Q06DXyQ2VgeeqiwDFFpEH0
+  PFkdPO6ZqbTRcLfNH7mFgCBJjsfSjJrn0sPBlYyOXgCoByfZnZyrIMH/UY+lgQqS
+  6Von1VDsfQm0eJh5zYZD64ZF86phSR7mUX3mXItwH04HrZwkWpvgd871DZVR3i1n
+  w8aNA5re5+Rt/Vvjxj5AcEnZnZiz5x959NaddQocX32Z1unHw44pzRNUur1GInfW
+  p4vpx2kUSFSAGjtCbDGTNV2AH8w9OU4xEmNz8c5lyoA=
   -----END CERTIFICATE-----
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2017-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -38,28 +43,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: configurability
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: uuid
   requirement: !ruby/object:Gem::Requirement
@@ -94,14 +99,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: hoe-highline
   requirement: !ruby/object:Gem::Requirement
@@ -117,61 +122,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rdoc-generator-fivefish
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: rdoc-generator-fivefish
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '3.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '3.15'
 description: |-
   An Entity/Component System framework inspired by Artemis.
 
@@ -181,25 +186,22 @@ description: |-
 
   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]
+  for making it better via email or whatever.
 email:
 - ged@FaerieMUD.org
 executables: []
 extensions: []
 extra_rdoc_files:
-- History.rdoc
+- History.md
 - Manifest.txt
-- README.rdoc
+- README.md
 files:
-- ".gemtest"
 - ".rdoc_options"
 - ".simplecov"
 - ChangeLog
-- History.rdoc
+- History.md
 - Manifest.txt
-- README.rdoc
+- README.md
 - Rakefile
 - lib/chione.rb
 - lib/chione/aspect.rb
@@ -221,21 +223,21 @@ files:
 - spec/chione/world_spec.rb
 - spec/chione_spec.rb
 - spec/spec_helper.rb
-homepage: http://faelidth.org/chione
+homepage: http://deveiate.org/projects/LinguaThauma
 licenses:
-- BSD
+- BSD-3-Clause
 metadata: {}
 post_install_message: 
 rdoc_options:
 - "--main"
-- README.rdoc
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.1
+      version: 2.3.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -243,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: An Entity/Component System framework inspired by Artemis

data/History.rdoc

@@ -1,9 +0,0 @@
-== 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.
-