woyo-world 0.0.6 → 0.0.7

data/lib/woyo/world/version.rb

@@ -1,3 +1,3 @@
 module Woyo
-  WORLD_VERSION = "0.0.6"
+  WORLD_VERSION = "0.0.7"
 end

data/lib/woyo/world/way.rb

@@ -4,9 +4,11 @@ module Woyo
 
 class Way < WorldObject
 
-  attributes :description, name: lambda { |this| this.id.to_s.capitalize }
-
-  group! :passable, :closed, :open  # defaults to closed: true 
+  def initialize_object
+    super
+    attribute :going 
+    exclusion :passable, :closed, :open  # defaults to closed: true 
+  end
 
   def world
     from ? from.world : nil
@@ -46,7 +48,6 @@ class Way < WorldObject
     end
   end
 
-  attribute :going 
   
   def go
     { go: open?, going: self.going }

data/lib/woyo/world/world.rb

@@ -1,15 +1,19 @@
 require_relative 'world_object'
 require_relative 'location'
 require_relative 'way'
+require_relative 'item'
 require_relative 'character'
 
 module Woyo
 
 class World < WorldObject
 
-  attributes :name, :description, :start
-  
-  children :location, :character
+  children :location, :character, :item
+
+  def initialize_object
+    super
+    attributes :start
+  end
 
   def initialize &block
     super nil, context: nil, &block

data/lib/woyo/world/world_object.rb

@@ -1,14 +1,15 @@
 
 require_relative 'attributes'
-require_relative 'dsl'
+require_relative 'actions'
+require_relative 'evaluate'
 
 module Woyo
 
 class WorldObject
 
-  #prepend Attributes
   include Attributes
-  include DSL
+  include Actions
+  include Evaluate
 
   attr_reader :id, :context
   attr_accessor :_test
@@ -16,10 +17,13 @@ class WorldObject
   def initialize id, context: nil, &block
     @id = id.to_s.downcase.to_sym
     @context = context
-    super  # initializes attributes
+    attributes :description, name: proc { id.to_s.capitalize }
+    initialize_object
     evaluate &block
   end
 
+  def initialize_object ; end
+
 end
 
 end

data/rspec.json

@@ -0,0 +1 @@
+{"examples":[{"description":"#attributes returns empty AttributesHash for instance with no attributes","full_description":"Woyo::Attributes #attributes returns empty AttributesHash for instance with no attributes","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":12,"run_time":0.000600822},{"description":"#attributes returns AttributesHash with names and nil values for instance with unpopulated attributes","full_description":"Woyo::Attributes #attributes returns AttributesHash with names and nil values for instance with unpopulated attributes","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":18,"run_time":0.000109135},{"description":"#attributes returns AttributeHash with names and values for instance with populated attributes","full_description":"Woyo::Attributes #attributes returns AttributeHash with names and values for instance with populated attributes","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":26,"run_time":9.0917e-05},{"description":"#attributes returns AttributesHash with names and default values for instance with unpopulated attributes","full_description":"Woyo::Attributes #attributes returns AttributesHash with names and default values for instance with unpopulated attributes","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":37,"run_time":0.000109444},{"description":"have convenience accessor :names for :keys","full_description":"Woyo::Attributes have convenience accessor :names for :keys","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":45,"run_time":6.8282e-05},{"description":"can be written via method with =","full_description":"Woyo::Attributes can be written via method with =","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":51,"run_time":8.5617e-05},{"description":"can be written via method without =","full_description":"Woyo::Attributes can be written via method without =","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":62,"run_time":9.4259e-05},{"description":"can be read via method","full_description":"Woyo::Attributes can be read via method","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":73,"run_time":0.00011345},{"description":"list can be added to","full_description":"Woyo::Attributes list can be added to","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":84,"run_time":0.000106628},{"description":"list can be added to without duplication","full_description":"Woyo::Attributes list can be added to without duplication","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":92,"run_time":0.000101618},{"description":"can be defined with \"attribute\"","full_description":"Woyo::Attributes can be defined with \"attribute\"","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":100,"run_time":0.001249877},{"description":"can have a default value","full_description":"Woyo::Attributes can have a default value","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":108,"run_time":0.000179756},{"description":"can have a default proc","full_description":"Woyo::Attributes can have a default proc","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":122,"run_time":7.4385e-05},{"description":"default proc runs in instance scope","full_description":"Woyo::Attributes default proc runs in instance scope","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":128,"run_time":6.1819e-05},{"description":"can have a default lambda","full_description":"Woyo::Attributes can have a default lambda","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":135,"run_time":7.0772e-05},{"description":"default lambda runs in instance scope","full_description":"Woyo::Attributes default lambda runs in instance scope","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":141,"run_time":6.8076e-05},{"description":"#attr?","full_description":"Woyo::Attributes that are boolean have convenient instance accessors #attr?","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":156,"run_time":0.000111265},{"description":"#attr!","full_description":"Woyo::Attributes that are boolean have convenient instance accessors #attr!","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":161,"run_time":8.0153e-05},{"description":"#is? :attr","full_description":"Woyo::Attributes that are boolean have convenient instance accessors #is? :attr","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":168,"run_time":8.5972e-05},{"description":"#is :attr","full_description":"Woyo::Attributes that are boolean have convenient instance accessors #is :attr","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":174,"run_time":7.2978e-05},{"description":"without duplication","full_description":"Woyo::Attributes can be re-defined without duplication","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":187,"run_time":7.9704e-05},{"description":"to set default","full_description":"Woyo::Attributes can be re-defined to set default","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":195,"run_time":7.7479e-05},{"description":"to change default","full_description":"Woyo::Attributes can be re-defined to change default","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":203,"run_time":7.7911e-05},{"description":"can be accessed by named instance methods","full_description":"Woyo::Attributes groups can be accessed by named instance methods","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":221,"run_time":9.9924e-05},{"description":"names and nil values can be retrieved","full_description":"Woyo::Attributes groups names and nil values can be retrieved","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":225,"run_time":0.000104594},{"description":"names and default values can be retrieved","full_description":"Woyo::Attributes groups names and default values can be retrieved","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":232,"run_time":0.000131944},{"description":"members can be accessed via group","full_description":"Woyo::Attributes groups members can be accessed via group","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":240,"run_time":8.8867e-05},{"description":"members are attributes","full_description":"Woyo::Attributes groups members are attributes","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":246,"run_time":7.9698e-05},{"description":"attributes are members","full_description":"Woyo::Attributes groups attributes are members","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":252,"run_time":8.2007e-05},{"description":"#groups returns hash with names and groups","full_description":"Woyo::Attributes groups #groups returns hash with names and groups","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":257,"run_time":0.000117097},{"description":"can be accessed by named instance methods","full_description":"Woyo::Attributes exclusions can be accessed by named instance methods","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":272,"run_time":0.000133484},{"description":"first member is true, rest are false","full_description":"Woyo::Attributes exclusions first member is true, rest are false","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":276,"run_time":0.000113933},{"description":"#value returns true member","full_description":"Woyo::Attributes exclusions #value returns true member","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":282,"run_time":0.000118077},{"description":"making group member true affects member attributes","full_description":"Woyo::Attributes exclusions making group member true affects member attributes","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":288,"run_time":0.000109708},{"description":"making attribute true affects group members","full_description":"Woyo::Attributes exclusions making attribute true affects group members","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":295,"run_time":0.000111194},{"description":"#exclusions returns hash with names and exlcusions","full_description":"Woyo::Attributes exclusions #exclusions returns hash with names and exlcusions","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":302,"run_time":0.000174007},{"description":"accept a hash as value","full_description":"Woyo::Attributes with Hash value accept a hash as value","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":317,"run_time":0.000699821},{"description":"return the value of the first key that evaluates as a true attribute","full_description":"Woyo::Attributes with Hash value return the value of the first key that evaluates as a true attribute","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":321,"run_time":0.000107057},{"description":"otherwise return the hash","full_description":"Woyo::Attributes with Hash value otherwise return the hash","status":"passed","file_path":"./spec/woyo/world/attributes_spec.rb","line_number":329,"run_time":8.6088e-05},{"description":"has attributes","full_description":"Woyo::Character has attributes","status":"passed","file_path":"./spec/woyo/world/character_spec.rb","line_number":10,"run_time":0.000106901},{"description":"name attribute defaults to id","full_description":"Woyo::Character name attribute defaults to id","status":"passed","file_path":"./spec/woyo/world/character_spec.rb","line_number":15,"run_time":7.87e-05},{"description":"accepts world for parameter context:","full_description":"Woyo::Character accepts world for parameter context:","status":"passed","file_path":"./spec/woyo/world/character_spec.rb","line_number":19,"run_time":0.000115722},{"description":"accepts location for parameter context:","full_description":"Woyo::Character accepts location for parameter context:","status":"passed","file_path":"./spec/woyo/world/character_spec.rb","line_number":25,"run_time":0.000113242},{"description":"has attributes","full_description":"DSL world has attributes","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":10,"run_time":0.000108365},{"description":"contains locations","full_description":"DSL world contains locations","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":21,"run_time":0.000181966},{"description":"defined with attributes","full_description":"DSL location defined with attributes","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":60,"run_time":0.000128587},{"description":"redefined","full_description":"DSL location redefined","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":73,"run_time":0.000141228},{"description":"multiple with attributes","full_description":"DSL location multiple with attributes","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":96,"run_time":0.000179429},{"description":"to new location","full_description":"DSL ways new way to new location","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":125,"run_time":0.000273266},{"description":"to existing location","full_description":"DSL ways new way to existing location","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":146,"run_time":0.000254083},{"description":"to same location","full_description":"DSL ways new way to same location","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":169,"run_time":0.000205929},{"description":"to new location","full_description":"DSL ways existing way to new location","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":192,"run_time":0.000304538},{"description":"to existing location","full_description":"DSL ways existing way to existing location","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":217,"run_time":0.000259085},{"description":"to same location","full_description":"DSL ways existing way to same location","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":244,"run_time":0.001997442},{"description":"an open way","full_description":"DSL ways going an open way","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":288,"run_time":0.000162764},{"description":"a closed way","full_description":"DSL ways going a closed way","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":297,"run_time":0.00016135},{"description":"new","full_description":"DSL ways character new","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":344,"run_time":0.000153027},{"description":"existing","full_description":"DSL ways character existing","status":"passed","file_path":"./spec/woyo/world/dsl_spec.rb","line_number":359,"run_time":0.000133853},{"description":"can list classes to contain","full_description":"Woyo::Evaluate can list classes to contain","status":"passed","file_path":"./spec/woyo/world/evaluate_spec.rb","line_number":31,"run_time":7.1558e-05},{"description":"can add classes to contain","full_description":"Woyo::Evaluate can add classes to contain","status":"passed","file_path":"./spec/woyo/world/evaluate_spec.rb","line_number":35,"run_time":0.000917174},{"description":"can create child objects","full_description":"Woyo::Evaluate can create child objects","status":"passed","file_path":"./spec/woyo/world/evaluate_spec.rb","line_number":45,"run_time":6.8278e-05},{"description":"has hashes of each class of child objects","full_description":"Woyo::Evaluate has hashes of each class of child objects","status":"passed","file_path":"./spec/woyo/world/evaluate_spec.rb","line_number":53,"run_time":6.8478e-05},{"description":"hash a hash of all classes of child objects","full_description":"Woyo::Evaluate hash a hash of all classes of child objects","status":"passed","file_path":"./spec/woyo/world/evaluate_spec.rb","line_number":63,"run_time":6.7888e-05},{"description":"instance evals block with arity 0","full_description":"Woyo::Evaluate#evaluate instance evals block with arity 0","status":"passed","file_path":"./spec/woyo/world/evaluate_spec.rb","line_number":17,"run_time":0.00149878},{"description":"passes self to block with arity 1","full_description":"Woyo::Evaluate#evaluate passes self to block with arity 1","status":"passed","file_path":"./spec/woyo/world/evaluate_spec.rb","line_number":23,"run_time":5.4524e-05},{"description":"is a kind of hash","full_description":"Woyo::Attributes::AttributesHash is a kind of hash","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":22,"run_time":0.00022712},{"description":"provides list of attribute names","full_description":"Woyo::Attributes::AttributesHash provides list of attribute names","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":29,"run_time":4.5909e-05},{"description":"registers attribute listeners","full_description":"Woyo::Attributes::AttributesHash registers attribute listeners","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":33,"run_time":3.4579e-05},{"description":"maintains list of attribute listeners","full_description":"Woyo::Attributes::AttributesHash maintains list of attribute listeners","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":37,"run_time":4.5437e-05},{"description":"notifies listeners of attribute change","full_description":"Woyo::Attributes::AttributesHash notifies listeners of attribute change","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":42,"run_time":5.7731e-05},{"description":"does not notify listener if attribute does not change","full_description":"Woyo::Attributes::AttributesHash does not notify listener if attribute does not change","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":52,"run_time":5.6067e-05},{"description":"#initialize requires attributes object","full_description":"Woyo::Attributes::Group #initialize requires attributes object","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":70,"run_time":0.000125452},{"description":"maintains list of members","full_description":"Woyo::Attributes::Group maintains list of members","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":75,"run_time":5.1099e-05},{"description":"member names can be listed","full_description":"Woyo::Attributes::Group member names can be listed","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":79,"run_time":3.8831e-05},{"description":"members are backed by attributes","full_description":"Woyo::Attributes::Group members are backed by attributes","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":83,"run_time":5.7155e-05},{"description":"member values can be listed","full_description":"Woyo::Attributes::Group member values can be listed","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":95,"run_time":4.9062e-05},{"description":"has default","full_description":"Woyo::Attributes::Exclusion has default","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":107,"run_time":4.4003e-05},{"description":"defaults to first member true, the rest false","full_description":"Woyo::Attributes::Exclusion defaults to first member true, the rest false","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":111,"run_time":4.4923e-05},{"description":"registers as listener for attributes","full_description":"Woyo::Attributes::Exclusion registers as listener for attributes","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":117,"run_time":4.5312e-05},{"description":"setting a member true changes the rest to false","full_description":"Woyo::Attributes::Exclusion setting a member true changes the rest to false","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":123,"run_time":4.8502e-05},{"description":"for a group > 2 members setting a true member false reverts to default","full_description":"Woyo::Attributes::Exclusion for a group > 2 members setting a true member false reverts to default","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":130,"run_time":5.7171e-05},{"description":"for a binary group setting a true member false sets the other true","full_description":"Woyo::Attributes::Exclusion for a binary group setting a true member false sets the other true","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":137,"run_time":6.3755e-05},{"description":"can only set existing members","full_description":"Woyo::Attributes::Exclusion can only set existing members","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":146,"run_time":5.4135e-05},{"description":"can be reset to default!","full_description":"Woyo::Attributes::Exclusion can be reset to default!","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":150,"run_time":5.147e-05},{"description":"#value returns name of true member","full_description":"Woyo::Attributes::Exclusion #value returns name of true member","status":"passed","file_path":"./spec/woyo/world/group_spec.rb","line_number":156,"run_time":4.7433e-05},{"description":"has attributes","full_description":"Woyo::Location has attributes","status":"passed","file_path":"./spec/woyo/world/location_spec.rb","line_number":10,"run_time":9.6657e-05},{"description":"name attribute defaults to id","full_description":"Woyo::Location name attribute defaults to id","status":"passed","file_path":"./spec/woyo/world/location_spec.rb","line_number":15,"run_time":6.7713e-05},{"description":"accepts world for parameter context:","full_description":"Woyo::Location accepts world for parameter context:","status":"passed","file_path":"./spec/woyo/world/location_spec.rb","line_number":19,"run_time":0.000110204},{"description":"#here","full_description":"Woyo::Location #here","status":"passed","file_path":"./spec/woyo/world/location_spec.rb","line_number":60,"run_time":6.2542e-05},{"description":"#world","full_description":"Woyo::Location #world","status":"passed","file_path":"./spec/woyo/world/location_spec.rb","line_number":65,"run_time":8.7446e-05},{"description":"are listed (#ways)","full_description":"Woyo::Location ways are listed (#ways)","status":"passed","file_path":"./spec/woyo/world/location_spec.rb","line_number":27,"run_time":0.000370378},{"description":"are from here","full_description":"Woyo::Location ways are from here","status":"passed","file_path":"./spec/woyo/world/location_spec.rb","line_number":37,"run_time":0.00018087},{"description":"go to locations","full_description":"Woyo::Location ways go to locations","status":"passed","file_path":"./spec/woyo/world/location_spec.rb","line_number":47,"run_time":0.000181489},{"description":"has attributes","full_description":"Woyo::Way has attributes","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":10,"run_time":0.000131892},{"description":"name attribute defaults to id","full_description":"Woyo::Way name attribute defaults to id","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":15,"run_time":0.000110511},{"description":"accepts location for parameter context:","full_description":"Woyo::Way accepts location for parameter context:","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":19,"run_time":0.000144638},{"description":"is in a world","full_description":"Woyo::Way is in a world","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":26,"run_time":0.000154878},{"description":"leads from a location","full_description":"Woyo::Way leads from a location","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":33,"run_time":0.00013702},{"description":"leads to a location","full_description":"Woyo::Way leads to a location","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":39,"run_time":0.000158177},{"description":"defaults to closed if \"to\" not defined","full_description":"Woyo::Way defaults to closed if \"to\" not defined","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":47,"run_time":0.000118832},{"description":"defaults to open if \"to\" defined","full_description":"Woyo::Way defaults to open if \"to\" defined","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":53,"run_time":0.000142426},{"description":"may be made closed","full_description":"Woyo::Way may be made closed","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":60,"run_time":0.000135807},{"description":"may be made open","full_description":"Woyo::Way may be made open","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":70,"run_time":0.000114594},{"description":"may be closed!","full_description":"Woyo::Way may be closed!","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":79,"run_time":0.000143574},{"description":"can close!","full_description":"Woyo::Way can close!","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":89,"run_time":0.000145269},{"description":"can open!","full_description":"Woyo::Way can open!","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":99,"run_time":0.000141241},{"description":"query open?","full_description":"Woyo::Way query open?","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":108,"run_time":0.000244526},{"description":"query closed?","full_description":"Woyo::Way query closed?","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":116,"run_time":0.00023091},{"description":"can be described","full_description":"Woyo::Way description can be described","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":130,"run_time":6.2399e-05},{"description":"can be described open","full_description":"Woyo::Way description can be described open","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":135,"run_time":4.7681e-05},{"description":"can be described closed","full_description":"Woyo::Way description can be described closed","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":140,"run_time":4.769e-05},{"description":"when open","full_description":"Woyo::Way going when open","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":155,"run_time":6.4966e-05},{"description":"when closed","full_description":"Woyo::Way going when closed","status":"passed","file_path":"./spec/woyo/world/way_spec.rb","line_number":159,"run_time":5.0029e-05},{"description":"provides access to context","full_description":"Woyo::WorldObject provides access to context","status":"passed","file_path":"./spec/woyo/world/world_object_spec.rb","line_number":46,"run_time":4.924e-05},{"description":"initializes with symbol id","full_description":"Woyo::WorldObject#new initializes with symbol id","status":"passed","file_path":"./spec/woyo/world/world_object_spec.rb","line_number":8,"run_time":5.4612e-05},{"description":"creates id","full_description":"Woyo::WorldObject#new creates id","status":"passed","file_path":"./spec/woyo/world/world_object_spec.rb","line_number":12,"run_time":4.2743e-05},{"description":"converts id to lowercase","full_description":"Woyo::WorldObject#new converts id to lowercase","status":"passed","file_path":"./spec/woyo/world/world_object_spec.rb","line_number":16,"run_time":4.7502e-05},{"description":"accepts named parameter context:","full_description":"Woyo::WorldObject#new accepts named parameter context:","status":"passed","file_path":"./spec/woyo/world/world_object_spec.rb","line_number":20,"run_time":5.3458e-05},{"description":"accepts a block with arity 0","full_description":"Woyo::WorldObject#new accepts a block with arity 0","status":"passed","file_path":"./spec/woyo/world/world_object_spec.rb","line_number":24,"run_time":5.6628e-05},{"description":"instance evals block with arity 0","full_description":"Woyo::WorldObject#new instance evals block with arity 0","status":"passed","file_path":"./spec/woyo/world/world_object_spec.rb","line_number":30,"run_time":6.2236e-05},{"description":"accepts a block with arity 1","full_description":"Woyo::WorldObject#new accepts a block with arity 1","status":"passed","file_path":"./spec/woyo/world/world_object_spec.rb","line_number":34,"run_time":4.4374e-05},{"description":"passes self to block with arity 1","full_description":"Woyo::WorldObject#new passes self to block with arity 1","status":"passed","file_path":"./spec/woyo/world/world_object_spec.rb","line_number":40,"run_time":4.3688e-05},{"description":"has attributes :name, :description, :start","full_description":"Woyo::World has attributes :name, :description, :start","status":"passed","file_path":"./spec/woyo/world/world_spec.rb","line_number":8,"run_time":9.4831e-05},{"description":"initializes with no locations","full_description":"Woyo::World initializes with no locations","status":"passed","file_path":"./spec/woyo/world/world_spec.rb","line_number":13,"run_time":0.000129167},{"description":"initializes with no characters","full_description":"Woyo::World initializes with no characters","status":"passed","file_path":"./spec/woyo/world/world_spec.rb","line_number":17,"run_time":0.000126987}],"summary":{"duration":0.023193178,"example_count":125,"failure_count":0,"pending_count":0},"summary_line":"125 examples, 0 failures"}

data/spec/spec_doc.haml

@@ -0,0 +1,68 @@
+
+- def render_specdoc specdoc
+  - specdoc.each do |element|
+    - case
+    - when element.keys.first == :head    then render_head    element
+    - when element.keys.first == :text    then render_text    element
+    - when element.keys.first == :group   then render_group   element
+    - when element.keys.first == :example then render_example element
+
+- def render_group group_element
+  - group = group_element.values.first
+  - unless group.first[:hide]
+    - haml_tag :div do
+      - group.each do |element|
+        - case
+        - when element.keys.first == :head    then render_head    element, 2
+        - when element.keys.first == :text    then render_text    element
+        - when element.keys.first == :group   then render_group   element
+        - when element.keys.first == :example then render_example element
+
+- def render_example example_element
+  - example = example_element.values.first
+  - unless example.first[:hide]
+    - haml_tag :div do
+      - example.each do |element|
+        - case 
+        - when element.keys.first == :head  then render_head element, 3
+        - when element.keys.first == :text  then render_text element
+        - when element.keys.include?(:code) then render_code element
+
+- def render_head head_element, size = 1
+  - case size
+  - when 1 then haml_tag :h1, head_element.values.first
+  - when 2 then haml_tag :h2, head_element.values.first
+  - when 3 then haml_tag :h3, head_element.values.first
+  - when 4 then haml_tag :h4, head_element.values.first
+  - when 5 then haml_tag :h5, head_element.values.first
+  - else        haml_tag :h6, head_element.values.first
+
+- def render_text text_element
+  - haml_tag :p, text_element.values.first
+   
+- def render_code code_element
+  - unless code_element[:hide]
+    - haml_tag :div do
+      - haml_tag :pre, "<code>#{preserve(code_element[:code])}#{' #=> ' + code_element[:value].to_s if code_element[:value]}</code>"
+
+%html
+
+  %head
+    %meta{ charset: 'utf-8' }
+    %meta{ 'http-equiv' => "X-UA-Compatible", content: "chrome=1" }
+    %meta{ name: "description", content: specdoc.first[:group].collect { |element| element[:title] }.compact.first + ' : ' +  specdoc.first[:group].collect { |element| element[:tagline] }.compact.first }
+    %link{ rel: "stylesheet", type: "text/css", media: "screen", href: "stylesheets/stylesheet.css" }
+    %title= specdoc.first[:group].collect { |element| element[:title] }.compact.first
+
+  %body
+
+    %div#header_wrap.outer
+      %header.inner
+        %a#forkme_banner{ href: specdoc.first[:group].collect { |element| element[:url] }.compact.first } View on GitHub
+        %h1#project_title= specdoc.first[:group].collect { |element| element[:title] }.compact.first 
+        %h2#project_tagline= specdoc.first[:group].collect { |element| element[:tagline] }.compact.first 
+
+    %div#main_content_wrap.outer
+      %section#main_content.inner
+        - render_specdoc specdoc
+

data/spec/spec_doc_formatter.rb

@@ -0,0 +1,89 @@
+RSpec::Support.require_rspec_core "formatters/base_formatter"
+RSpec::Support.require_rspec_core "formatters/console_codes"
+
+require 'json'
+require 'haml'
+
+class SpecDocFormatter < RSpec::Core::Formatters::BaseFormatter
+
+  RSpec::Core::Formatters.register self,  
+    :start,
+    :example_group_started, :example_group_finished,
+    :example_passed, :example_failed, :example_pending,
+    :stop
+
+  def initialize(output)
+    super
+  end
+  
+  def start(start_notification)
+    @specdoc_root = []
+    @specdoc_group = @specdoc_root
+    @specdoc_parents = []
+  end
+
+  def stop(examples_notification)
+    # if option[:json]
+    #output.puts json_format 
+    # end
+    # if option[:haml]
+    output.puts haml_format
+    # end
+  end
+
+  def json_format
+    JSON.pretty_generate @specdoc_root
+  end
+
+  def haml_format
+    Haml::Engine.new( File.read( File.join File.dirname( __FILE__ ), 'spec_doc.haml' )).render( self, specdoc: @specdoc_root )
+  end
+
+  def example_group_started(group_notification)
+    this_group = group_notification.group
+    this_group.init_specdoc
+    this_group_specdoc = this_group.metadata[:specdoc][this_group] 
+    @specdoc_group << { group: this_group_specdoc }
+    @specdoc_parents << @specdoc_group
+    @specdoc_group = this_group_specdoc
+    @specdoc_group << { description: this_group.description }
+  end
+
+  def example_group_finished(group_notification)
+    @specdoc_group = @specdoc_parents.pop
+  end
+
+  def example_passed(example_notification)
+    collect_example example_notification, :passed
+  end
+
+  def example_pending(example_notification)
+    collect_example example_notification, :pending
+  end
+
+  def example_failed(example_notification)
+    collect_example example_notification, :failed
+  end
+
+  def collect_example example_notification, result
+    this_example = example_notification.example
+    this_specdoc = this_example.metadata[:specdoc]
+    unless this_specdoc.any? { |element| element[:head] }
+      description = this_example.description
+      this_specdoc.unshift({ head: description == description.upcase ? description : description.capitalize }) 
+    end
+    this_specdoc.unshift( { result: result } )
+    placeholder = @specdoc_group.detect { |element| element[:example] == false }
+    if placeholder 
+      placeholder[:example] = this_specdoc
+    else
+      @specdoc_group << { example: this_specdoc }
+    end
+  end
+
+  def indent
+    ':' * @specdoc_parents.count
+  end
+  
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,115 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+end
+
+RSpec.configure do |config|
+
+  config.around :example do |example|
+    @example = example
+    @example.metadata[:specdoc] = []
+    @binding = @example.example_group_instance.eval_binding
+
+    def hide
+      @example.metadata[:specdoc] << { hide: true }
+    end
+
+    def head text
+      @example.metadata[:specdoc] << { head: text }
+    end
+
+    def text text
+      @example.metadata[:specdoc] << { text: text }
+    end
+
+    def code code
+      code_hash = case
+      when code.is_a?( String )
+        { code: code }
+      when code.respond_to?( :[] ) && code[:code]
+        code
+      when [:keys,:values,:count].all? { |m| code.respond_to? m } && code.count == 1
+        { code: code.keys.first, value: code.values.first }
+      else
+        raise "Don't know what to do with: #{code}"
+      end
+      code_hash[:code] = fix_indent(code_hash[:code])
+      @example.metadata[:specdoc] << code_hash
+      exec_code code_hash
+    end
+
+    def exec_code code
+      if code[:value]
+        expect(@binding.eval code.values_at(:pre,:code,:post).join "\n").to self.send((code[:op] ? code[:op] : :eq),(@binding.eval code[:value]))
+      else
+        @binding.eval code.values_at(:pre,:code,:post).join "\n"
+      end
+    end
+
+    def fix_indent text
+      lines = text.lines
+      leading = lines.collect { |l| l.index /[^ ]/ }
+      indent = leading.reject { |n| n == 0 }.min
+      if indent
+        indent_regex = Regexp.new('^'+' '*indent)
+        lines.each { |l| l.sub!(indent_regex,'') }
+      end
+      lines.join
+    end
+
+    example.run
+
+  end
+
+end
+
+class RSpec::Core::ExampleGroup
+
+  def eval_binding
+    binding
+  end
+
+  def self.title title
+    init_specdoc
+    metadata[:specdoc][self] << { title: title }
+  end
+
+  def self.tagline tagline
+    init_specdoc
+    metadata[:specdoc][self] << { tagline: tagline }
+  end
+
+  def self.url url
+    init_specdoc
+    metadata[:specdoc][self] << { url: url }
+  end
+
+  def self.hide
+    init_specdoc
+    metadata[:specdoc][self] << { hide: true }
+  end
+
+  def self.head head
+    init_specdoc
+    metadata[:specdoc][self] << { head: head }
+  end
+
+  def self.text text
+    init_specdoc
+    metadata[:specdoc][self] << { text: text }
+  end
+
+  def self.init_specdoc
+    metadata[:specdoc] = {} unless metadata[:specdoc]
+    metadata[:specdoc][self] = [] unless metadata[:specdoc][self]
+  end
+
+  def self.doc *args, &block
+    init_specdoc
+    metadata[:specdoc][self] << { example: false } # empty example order placeholder
+    example *args, &block
+  end
+
+end
+

data/spec/woyo/dsl/dsl_spec.rb

@@ -0,0 +1,367 @@
+require 'spec_helper'
+require 'woyo/world/world'
+
+describe 'DSL' do
+
+  title   "Woyo World"
+  tagline "World of Your Own"
+  url     "https://github.com/iqeo/woyo-world"
+
+  head "WOYO : World of Your Own"
+  text "This gem woyo-world is a Ruby-based DSL (Domain Specific Language) for creating and interacting with a virtual world. A world is comprised of locations to visit, and ways to go between locations."
+
+  context 'world' do
+
+    before :all do
+      @world = Woyo::World.new
+    end
+    def world ; @world ; end
+
+    head "World"
+    text "A world is comprised of attributes and objects, including locations, items, characters, etc.."
+  
+    doc 'has attributes' do
+      head "Attributes"
+      text "A world has attributes that describe and define it's operation."
+      code pre:  "world.evaluate do",
+           code:   "name 'Small'
+                    description 'A small world.'
+                    start :home",
+           post: "end"
+      text "Attributes may be accessed from the world."
+      text "The 'name' attribute is to be presented to the user" 
+      code "world.name" => "'Small'"
+      text "The 'description' attrbute is to be presented to the user"
+      code "world.description" => "'A small world.'"
+      text "The 'start' attribute refers to the location the user will start at in the world..."
+      code "world.start" => ":home"
+      text "...in this case 'home'."
+    end
+    
+    text "The most interesting worlds contain locations to visit."
+
+  end
+
+  context 'locations' do 
+
+    before :all do
+      @world = Woyo::World.new
+    end
+    def world ; @world ; end
+
+    head "Locations"
+    text "A location is a place to visit in a world."
+
+    doc  "from humble beginnings" do
+      text "A single location"
+      code pre:  "world.evaluate do",
+           code:   "location :home do
+                      name 'My Home'
+                      description 'This old house.'
+                    end",
+           post: "end"
+      text "Locations have an identifier (in this case :home) that is unique within the world." 
+      text "A location may be referenced like this..."
+      code "home = world.locations[:home]"
+      text "...or this..."
+      code "home = world.location :home"
+      text "To get information about the location..."
+      code "home.id" => ":home"
+      code "home.name" => "'My Home'"
+      code "home.description" => "'This old house.'"
+      text "This is a nice old house, but let's make some changes to it..."
+    end
+
+    doc "change begins at home" do
+      text "Let's make some changes to this location."
+      code pre:  "home = world.location :home
+                  world.evaluate do",
+           code:   "location :home do
+                      description 'Sweet home.'
+                    end",
+           post: "end"
+      text "The new description replaces the old one."
+      text "Now our home looks like this..."
+      code "home.name" => "'My Home'"
+      code "home.description" => "'Sweet home.'"
+      text "No matter how sweet, this little world is not very interesting..."
+      code "world.locations.count" => "1"
+      text "Let's expand our horizons..."
+    end
+
+    doc "expandng horizons" do
+      text "Add a location to our world"
+      code pre:  "home = world.location :home
+                    world.evaluate do",
+           code:   "location :garden do
+                      name 'Garden'
+                      description 'A green leafy place.'
+                    end",
+           post: "end"
+      text "Now our world is a little more interesting..."
+      code "world.locations.count" => "2"
+      code "garden = world.location :garden"
+      text "This seems like a nice garden..."
+      code "garden.id" => ":garden"
+      code "garden.name" => "'Garden'"
+      code "garden.description" => "'A green leafy place.'"
+      text "We'd like to visit this garden, but there's no way, really..."
+      code "home.ways"   => "{}"
+      code "garden.ways" => "{}"
+      text "To go from location to location we need Ways"
+    end
+
+  end
+
+  context 'ways' do
+
+    before :all do
+      @world = Woyo::World.new
+    end
+
+    def world ; @world ; end
+
+    head "Ways"
+    text "A way is a directional path between locations."
+
+    doc "from here to there" do
+      text "A way is defined within a location."
+      code pre:  "world.evaluate do",
+           code:   "location :here do
+                      way :road do
+                        to :there
+                        description 'A short road'
+                        going       'Takes a long time'
+                      end
+                    end",
+           post: "end"
+      text "Ways have an identifier (in this case :road) that is unique within that location."
+      text "A way may be referenced like this..."
+      code "here = world.locations[:here]" => nil
+      code "way = here.ways[:road]" => nil
+      text "...or this..."
+      code "here = world.location :here"
+      code "way = here.way :road"
+      text "The way's attributes include a description that may be included in location representation to the user."
+      code "way.description" => "'A short road'"
+      text "The location the way is defined within is the location the way is 'from'."
+      code "way.from.id" => ":here"
+      text "Ways connect 'to' a location (in this case :there). This location is created if it does not already exist."
+      code "way.to.id" => ":there"
+    end
+
+    doc "going a way" do
+      text "Ways connect locations so that a user can move about in your world. Usually upon user input, the user goes a way from location to location. An optional description of the 'going' may be presented."
+      code pre:  "world.evaluate do",
+           code:   "location :room do
+                      way :stairs do
+                        to :cellar
+                        description 'Rickety stairs lead down into darkness.'
+                        going       'Creaky steps lead uncertainly downwards...'
+                      end
+                    end
+                    location :cellar do
+                      description 'Dark and damp, as expected.'
+                    end",
+           post: "end"
+      text "Accessing the location and way..."
+      code "room = world.location :room" => nil
+      code "stairs = room.way :stairs" => nil
+      text "When we try to 'go' a way, the result describes the attempt."
+      code "attempt = stairs.go" => "{ go: true, going: 'Creaky steps lead uncertainly downwards...' }"
+      text "Whether successful or not (true in this case)..."
+      code "attempt[:go]" => "true"
+      text "And a description of the attempt..."
+      code "attempt[:going]" => "'Creaky steps lead uncertainly downwards...'"
+    end
+
+    doc "on the way" do
+      text "Ways may be open or closed, optionally with descriptions for each state. A user cannot go a closed way, and an alternative 'going' description may be presented if attempted."
+      code pre:  "world.evaluate do",
+           code:   "location :room do
+                      way :stairs do
+                        to :cellar
+                        description   open:   'Rickety stairs lead down into darkness.',
+                                      closed: 'Broken stairs end in darkness.'
+                        going         open:   'Creaky steps lead uncertainly downwards...',
+                                      closed: 'The dangerous stairs are impassable.'
+                      end
+                    end
+                    location :cellar do
+                      description 'Dark and damp, as expected.'
+                    end",
+           post: "end"
+      text "Accessing the location and way..."
+      code "room = world.location :room" => nil
+      code "stairs = room.way :stairs" => nil
+      text "Ways that go 'to' a location are open by default."
+      code "stairs.open?" => "true"
+      text "With an appropriate description."
+      code "stairs.description" => "'Rickety stairs lead down into darkness.'"
+      text "Going an open way succeeds."
+      code "attempt = stairs.go" => "{ go: true, going: 'Creaky steps lead uncertainly downwards...' }"
+      code "attempt[:go]" => "true"
+      code "attempt[:going]" => "'Creaky steps lead uncertainly downwards...'"
+      text "A way may be closed."
+      code "stairs.close!"
+      code "stairs.closed?" => "true"
+      text "The way has an appropriate description."
+      code "stairs.description" => "'Broken stairs end in darkness.'"
+      text "Going a closed way fails."
+      code "attempt = stairs.go" => "{ go: false, going: 'The dangerous stairs are impassable.' }"
+      code "attempt[:go]" => "false"
+      code "attempt[:going]" => "'The dangerous stairs are impassable.'"
+    end
+
+  end
+
+  context 'items' do
+
+    head 'Items'
+
+    doc 'stuff here' do
+      pending
+    end
+
+  end
+
+  context 'attributes' do
+
+    before :all do
+      @world = Woyo::World.new
+    end
+    def world ; @world ; end
+
+    head "Attributes"
+
+    doc "things change" do
+      text "Attribute values may be dynamic, their value determined by a Ruby code block. The value of the last expression in the block is the value assigned to the attribte."
+      code pre:  "world.evaluate do",
+           code:   "item :clock do
+                      attribute :time do
+                        Time.now.to_s
+                      end
+                    end",
+           post: "end"
+      text "'Time.now.to_s' is a Ruby expression that returns the current time in human readable string. Since it is the last (only) expression in the code block, it's value will be assigned to the attribute ':time'."
+      code "clock = world.item :clock"
+      code "clock.time" => "Time.now.to_s"
+      text "The code block will be evaluated each time the attribute is accessed, returning the current time. Let's wait a second and check the time again."
+      code "sleep 1"
+      code "clock.time" => "Time.now.to_s"
+    end
+
+    doc "these things" do
+      text "A dynamic attribute can access other attributes of the same object."
+      text "A simple calculator."
+      code pre:  "world.evaluate do",
+           code:   "item :calculator do
+                      attribute a: 1, b: 2
+                      attribute :sum do
+                        a + b
+                      end
+                    end",
+           post: "end"
+      text "Attribute 'sum' accesses attributes 'a' and 'b' and adds them."
+      code "calculator = world.item :calculator"
+      code "calculator.sum" => "3"
+      text "Being a dynamic attribute, changes to the related attributes affect the result."
+      code "calculator.a = 4"
+      code "calculator.b = 5"
+      code "calculator.sum" => "9"
+    end
+
+    doc "those things" do
+      text "Dynamic attributes provide a mechanism for one object to affect another. The Ruby code block may simply refer to an attribute of another object."
+      code pre:  "world.evaluate do",
+           code:   "item :bulb do
+                      attribute color: 'red'
+                    end
+                    item :lamp do    
+                      attribute :light do
+                        ( world.item :bulb ).color
+                      end
+                    end",
+           post: "end"
+      text "The lamp's light depends on the bulb color."
+      code "lamp = world.item :lamp"
+      code "lamp.light" => "'red'"
+      text "Let's change the bulb."
+      code "bulb = world.item :bulb"
+      code "bulb.color = 'green'"
+      text "New we see the lamp in a new light."
+      code "lamp.light" => "'green'"
+    end
+
+    text "All things... to access attributes of other objects, see 'Context'."
+    text "Being Ruby code, dynamic attributes could be used to make changes to other world objects, attributes, etc.., even to execute any arbitrary Ruby code. Don't do it, this way lies madness."
+    text "Dynamic attributes are intended only to provide a dynamic value to a attribute, not to change other attributes or world objects. Another mechanism: 'Actions', is intended to modify the world."
+
+  end
+
+  context 'context' do
+
+    before :all do
+      @world = Woyo::World.new
+    end
+    def world ; @world ; end
+
+    head 'Context'
+    text "Other objects may be referred to in different ways."
+
+    doc 'world' do
+      pending
+    end             
+
+    doc 'location' do
+      pending
+    end             
+
+    doc 'context' do
+      pending
+    end             
+
+  end
+
+  context "actions" do
+
+    before :all do
+      @world = Woyo::World.new
+    end
+    def world ; @world ; end
+
+    head "Actions"
+    text "World objects may have actions that can be invoked, usually via user interaction."
+    text "Actions change the state of the world, usually by changing the value of attributes on world objects"
+
+    doc "making changes" do
+      text "Actions may be defined for a world object, in this case, an item."
+      code pre:  "world.evaluate do",
+           code:   "location :here do
+                      item :thing do
+                        name 'Thing?'
+                        action :one do
+                          name 'Thing One'
+                        end
+                        action :two do
+                          name 'Thing Two'
+                        end
+                      end
+                    end",
+           post: "end"
+      text "Initially the name is as defined"
+      code "location = world.location :here"
+      code "thing = location.item :thing" => "world.locations[:here].items[:thing]"
+      code "thing.name" => "'Thing?'"
+      text "Invoking action 'one', changes the name."
+      code "thing.one"
+      code "thing.name" => "'Thing One'"
+      text "Invoking action 'two', changes the name again."
+      code "thing.two"
+      code "thing.name" => "'Thing Two'"
+    end
+
+  end
+
+end
+