gamefic 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 567c41f4ddc68dcf42fcb5952d6279250100f117
-  data.tar.gz: 7d2b9383cc049ab220917377ae7c76a7d4adc694
+  metadata.gz: 63846578f9f4d58fb35a150a601b8b5d16b197c8
+  data.tar.gz: 360676b4be22f3eb71661bf8ee9c63edd629207b
 SHA512:
-  metadata.gz: 3ce9c4b0051c2e64591b7a08ce693d2817b9c66e94240e3f4ae52ecb012b0e89355ca692efe01dbd502d1590d18e05755c93d96cd2c695e7a4ae068b6e5f8e66
-  data.tar.gz: 318903449d67116cf8da824a29c845180516de69ba4344d1f45499acef3f6cc5c728e3fb31641010dca3735a8a786835a4447a4dea5405a941dd482dcf014ce3
+  metadata.gz: 6a1f09d1c998ddeca48c721c0d8336479b0f1762b98f6a57f1f440f08309b33f1993585ac386d9443a4b5d616012d85c285f5d4298bd64437e025d235d52cb1f
+  data.tar.gz: 3fd2d90bb464dc6c2ed83d9a72fba6d3177b7cdd65853b740fdc77a7414b8113a8b4a5e79466fc3e1e964f01d1427d0daf30f90abe93fca7b461459ff867b76b

data/lib/gamefic/director/parser.rb

@@ -31,7 +31,16 @@ module Gamefic
         if options.length == 0
           tokens.unshift command
         end
-        options.sort{ |a,b| b.action.specificity <=> a.action.specificity }
+        # HACK: This sort is necessary for a problem on Windows.
+        options.sort{ |a,b|
+          if a.action.specificity == b.action.specificity
+            # Newer action takes precedence
+            b.action.order_key <=> a.action.order_key
+          else
+            # Higher specificity takes precedence
+            b.action.specificity <=> a.action.specificity
+          end
+        }
       end
       def self.from_string(actor, command)
         options = []
@@ -45,7 +54,16 @@ module Gamefic
             options.concat bind_contexts_in_result(actor, match.arguments, action)
           }
         }
-        options.sort{ |a,b| b.action.specificity <=> a.action.specificity }
+        # HACK: This sort is necessary for a problem on Windows.
+        options.sort{ |a,b|
+          if a.action.specificity == b.action.specificity
+            # Newer action takes precedence
+            b.action.order_key <=> a.action.order_key
+          else
+            # Higher specificity takes precedence
+            b.action.specificity <=> a.action.specificity
+          end
+        }
       end
       class << self
         private

data/lib/gamefic/plot.rb

@@ -24,8 +24,10 @@ module Gamefic
     # TODO: Metadata could use better protection
     attr_accessor :metadata
     include Stage
-    mount Gamefic, Tester, Players, SceneMount, CommandMount, Entities,
-      ArticleMount, YouMount, Snapshot, Host, Callbacks
+    # @!parse include Gamefic, Tester, Players, SceneMount, CommandMount, Entities
+    mount Gamefic, Tester, Players, SceneMount, CommandMount, Entities
+    # @!parse include ArticleMount, YouMount, Snapshot, Host, Callbacks
+    mount ArticleMount, YouMount, Snapshot, Host, Callbacks
     expose :script, :metadata
 
     # @param [Source::Base]

data/lib/gamefic/plot/entities.rb

@@ -10,7 +10,7 @@ module Gamefic
       #
       # @param cls [Class] The Class of the Entity to be created.
       # @param args [Hash] The entity's properties.
-      # @return The Entity instance.
+      # @return [Entity]
       def make cls, args = {}, &block
         ent = cls.new args, &block
         if ent.kind_of?(Entity) == false
@@ -55,10 +55,16 @@ module Gamefic
         result.objects[0]
       end
 
+      # Get an array of entities associated with this plot.
+      #
+      # @return [Array<Entity>]
       def entities
         p_entities.clone
       end
 
+      # Get an array of players associated with this plot.
+      #
+      # @return [Array<Character>]
       def players
         p_players.clone
       end

data/lib/gamefic/plot/host.rb

@@ -33,7 +33,7 @@ module Gamefic
     # Determine whether the player is involved in a subplot.
     #
     # @return [Boolean]
-    def subbed? player
+    def in_subplot? player
       !subplot_for(player).nil?
     end
 

data/lib/gamefic/stage.rb

@@ -1,6 +1,10 @@
 module Gamefic
 
   module Stage
+    # Execute a block of code in a subset of the object's scope.
+    #
+    # An object's stage is an isolated namespace that has its own instance
+    # variables and limited access to its parent's instance methods.
     def stage *args, &block
       s = generate_stage
       if block.nil?
@@ -47,6 +51,14 @@ module Gamefic
     end
 
     module ClassMethods
+      # Mount a module in this class.
+      #
+      # Mounting a module will include it like a typical mixin and expose its
+      # public methods to the stage.
+      #
+      # Assuming you have a module Foo with one public method bar,
+      # <code>mount Foo</code> is functionally equivalent to
+      # <code>include Foo; expose bar</code>.
       def mount *args
         args.each { |a|
           include a
@@ -54,6 +66,17 @@ module Gamefic
         }
       end
 
+      # Give this object's stage access to an instance method.
+      #
+      # @example
+      #   class Container
+      #     def foobar; end
+      #     expose :foobar
+      #   end
+      #   x = Container.new
+      #   x.stage do
+      #     foobar
+      #   end
       def expose *args
         args.each { |a|
           exposed_methods[a] = nil

data/lib/gamefic/subplot.rb

@@ -8,10 +8,15 @@ module Gamefic
     attr_reader :plot
     attr_writer :denied_message
 
+    # @!parse include Plot::Entities
     mount Plot::Entities
+    # @!parse include Plot::CommandMount
     mount Plot::CommandMount
+    # @!parse include Plot::Callbacks
     mount Plot::Callbacks
+    # @!parse include Plot::SceneMount
     mount Plot::SceneMount
+    
     expose :plot, :conclude
 
     class << self
@@ -46,7 +51,7 @@ module Gamefic
       @playbook ||= plot.playbook.dup
     end
 
-    # HACK: Always assume subplots are running for the sake of entity destruction    
+    # HACK: Always assume subplots are running for the sake of entity destruction
     def running?
       true
     end
@@ -56,7 +61,7 @@ module Gamefic
     end
 
     def introduce player
-      if plot.subbed?(player)
+      if plot.in_subplot?(player)
         player.tell denied_message
       else
         super

data/lib/gamefic/version.rb

@@ -1,3 +1,3 @@
 module Gamefic
-  VERSION = '1.5.0'
+  VERSION = '1.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-14 00:00:00.000000000 Z
+date: 2017-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor