gamefic 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ac3f26cc5dcb62f6b4af8f0a365a316a4324605efecac8fd852f9980f00e336
-  data.tar.gz: 11348faf9a1c471c11ca4da93f419167db25a92ec7617fd73fb592fdf0ec7d7f
+  metadata.gz: 1ac7da649347939f4c5baadc676151b8a8c73714552c48a290de75bd072bb801
+  data.tar.gz: 6d83150ed62df24a4056e3e54ff5b499bc5f7a69ebe8d5cfaddb261f64573af4
 SHA512:
-  metadata.gz: 1bd78b541afec9fd2129d785442ddc811dacbc42c41f9c683329776f90ada2e105578324ef73fa7dedd7fc26ed828917f1a796765f0f1b74ade334b54c94d5ab
-  data.tar.gz: d3a982efcb6bdd0c306ebdab70ee722fcd1040d6cf51501b738b8bca65e955689dcfe2d77aa5e8684e1f0e18d27b71579410f51a6189d23014da47156bbbe3cf
+  metadata.gz: e068317caa9fbfb1f8a73bde4725f5df3f3bcad95ba87d44c8f973759cdc991e0fbbcea874fd451eacbd6ffd2ea2ade9144e61f2d358f31fec6a7f1e97ca3a10
+  data.tar.gz: 1ab813a5cb14307bc844c42424c9503bae6f73a48d12979a5369812619e5a2e80dfab2ac6181401045511286743fc20f35968bd46e5071cf24f296e3c1c20e36

data/.rubocop.yml

@@ -10,4 +10,7 @@ Style/StringLiterals:
 
 Style/Documentation:
   Description: 'Document classes and non-namespace modules.'
-  Enabled: false
+  Enabled: false
+
+Style/MethodDefParentheses:
+  Enabled: false

data/CHANGELOG.md

@@ -1,2 +1,6 @@
+# 2.0.3 - December 14, 2020
+- Remove unused Index class
+- Active#conclude accepts data argument
+
 # 2.0.2 - April 25, 2020
 - Improved snapshot serialization

data/lib/gamefic.rb

@@ -5,7 +5,6 @@ require 'gamefic/core_ext/array'
 require 'gamefic/core_ext/string'
 
 require 'gamefic/describable'
-# require 'gamefic/index'
 require 'gamefic/serialize'
 require 'gamefic/element'
 require 'gamefic/entity'
@@ -18,5 +17,4 @@ require "gamefic/syntax"
 require 'gamefic/world'
 require 'gamefic/scriptable'
 require 'gamefic/plot'
-require 'gamefic/plot/index'
 require 'gamefic/subplot'

data/lib/gamefic/action.rb

@@ -1,9 +1,4 @@
 module Gamefic
-  # Exception raised when the Action's proc arity is not compatible with the
-  # number of queries
-  class ActionArgumentError < ArgumentError
-  end
-
   class Action
     # An array of objects on which the action will operate, e.g., an entity
     # that is a direct object of a command.
@@ -54,25 +49,32 @@ module Gamefic
       self.class.meta?
     end
 
-    def self.subclass verb, *q, meta: false, &block
+    # @param verb [Symbol]
+    # @param queries [Array<Gamefic::Query::Base>]
+    # @param meta [Boolean]
+    # @return [Class<Action>]
+    def self.subclass verb, *queries, meta: false, &block
       act = Class.new(self) do
         self.verb = verb
         self.meta = meta
-        q.each { |q|
+        queries.each do |q|
           add_query q
-        }
+        end
         on_execute &block
       end
-      if !block.nil? and act.queries.length + 1 != block.arity and block.arity > 0
-        raise ActionArgumentError.new("Number of parameters is not compatible with proc arguments")
+      if !block.nil? && act.queries.length + 1 != block.arity && block.arity > 0
+        raise ArgumentError.new("Number of parameters is not compatible with proc arguments")
       end
       act
     end
 
     class << self
-      def verb
-        @verb
-      end
+      attr_reader :verb
+
+      # The proc to call when the action is executed
+      #
+      # @return [Proc]
+      attr_reader :executor
 
       def meta?
         @meta ||= false
@@ -93,7 +95,7 @@ module Gamefic
 
       def signature
         # @todo This is clearly unfinished
-        "#{verb} #{queries.map{|m| m.signature}.join(', ')}"
+        "#{verb} #{queries.map {|m| m.signature}.join(', ')}"
       end
 
       # True if this action is not intended to be performed directly by a
@@ -107,19 +109,13 @@ module Gamefic
         verb.to_s.start_with?('_')
       end
 
-      # The proc to call when the action is executed
-      #
-      # @return [Proc]
-      def executor
-        @executor
-      end
-
+      # @return [Integer]
       def rank
         if @rank.nil?
           @rank = 0
-          queries.each { |q|
+          queries.each do |q|
             @rank += (q.rank + 1)
-          }
+          end
           @rank -= 1000 if verb.nil?
         end
         @rank
@@ -128,22 +124,27 @@ module Gamefic
       def valid? actor, objects
         return false if objects.length != queries.length
         i = 0
-        queries.each { |p|
+        queries.each do |p|
           return false unless p.include?(actor, objects[i])
           i += 1
-        }
+        end
         true
       end
 
+      # Return an instance of this Action if the actor can execute it with the
+      # provided tokens, or nil if the tokens are invalid.
+      #
+      # @param action [Gamefic::Entity]
+      # @param tokens [Array<String>]
+      # @return [self, nil]
       def attempt actor, tokens
-        i = 0
         result = []
         matches = Gamefic::Query::Matches.new([], '', '')
-        queries.each { |p|
-          return nil if tokens[i].nil? and matches.remaining == ''
+        queries.each_with_index do |p, i|
+          return nil if tokens[i].nil? && matches.remaining == ''
           matches = p.resolve(actor, "#{matches.remaining} #{tokens[i]}".strip, continued: (i < queries.length - 1))
           return nil if matches.objects.empty?
-          accepted = matches.objects.select{|o| p.accept?(o)}
+          accepted = matches.objects.select { |o| p.accept?(o) }
           return nil if accepted.empty?
           if p.ambiguous?
             result.push accepted
@@ -151,20 +152,15 @@ module Gamefic
             return nil if accepted.length != 1
             result.push accepted.first
           end
-          i += 1
-        }
-        self.new(actor, result)
+        end
+        new(actor, result)
       end
 
       protected
 
-      def verb= sym
-        @verb = sym
-      end
+      attr_writer :verb
 
-      def meta= bool
-        @meta = bool
-      end
+      attr_writer :meta
     end
   end
 end

data/lib/gamefic/active.rb

@@ -117,9 +117,7 @@ module Gamefic
     #
     # @return [String] The output that resulted from performing the command.
     def quietly(*command)
-      if buffer_stack == 0
-        clear_buffer
-      end
+      clear_buffer if buffer_stack == 0
       set_buffer_stack buffer_stack + 1
       self.perform *command
       set_buffer_stack buffer_stack - 1
@@ -152,10 +150,12 @@ module Gamefic
     #   introduction do |actor|
     #     actor[:has_eaten] = false # Initial value
     #   end
+    #
     #   respond :eat do |actor|
     #     actor.tell "You eat something."
     #     actor[:has_eaten] = true
     #   end
+    #
     #   respond :eat do |actor|
     #     # This version will be executed first because it was implemented last
     #     if actor[:has_eaten]
@@ -187,13 +187,14 @@ module Gamefic
     # Use #prepare if you want to declare a scene to be started at the
     # beginning of the next turn.
     #
-    # @param new_scene [Class]
-    def cue new_scene, **options
+    # @param new_scene [Class<Scene::Base>]
+    # @param data [Hash] Additional scene data
+    def cue new_scene, **data
       @next_scene = nil
       if new_scene.nil?
         @scene = nil
       else
-        @scene = new_scene.new(self, **options)
+        @scene = new_scene.new(self, **data)
         @scene.start
       end
     end
@@ -202,10 +203,11 @@ module Gamefic
     # next turn. As opposed to #cue, a prepared scene will not start until the
     # current scene finishes.
     #
-    # @param new_scene [Class]
-    def prepare new_scene, **options
+    # @param new_scene [Class<Scene::Base>]
+    # @oaram data [Hash] Additional scene data
+    def prepare new_scene, **data
       @next_scene = new_scene
-      @next_options = options
+      @next_options = data
     end
 
     # Return true if the character is expected to be in the specified scene on
@@ -219,9 +221,11 @@ module Gamefic
     # Cue a conclusion. This method works like #cue, except it will raise a
     # NotConclusionError if the scene is not a Scene::Conclusion.
     #
-    def conclude scene
-      raise NotConclusionError unless scene <= Scene::Conclusion
-      cue scene
+    # @param new_scene [Class<Scene::Base>]
+    # @oaram data [Hash] Additional scene data
+    def conclude new_scene, **data
+      raise NotConclusionError unless new_scene <= Scene::Conclusion
+      cue new_scene, **data
     end
 
     # True if the character is in a conclusion.
@@ -269,6 +273,8 @@ module Gamefic
       @entered_scenes ||= []    
     end
 
+    # @param actions [Array<Gamefic::Action>]
+    # @param quietly [Boolean]
     def execute_stack actions, quietly: false
       return nil if actions.empty?
       a = actions.first

data/lib/gamefic/core_ext/array.rb

@@ -44,6 +44,9 @@ class Array
   #   animals = ['a dog', 'a cat', 'a mouse']
   #   animals.join_and #=> 'a dog, a cat, and a mouse'
   #
+  # @param sep [String] The separator for all but the last element
+  # @param andSep [String] The separator for the last element
+  # @param serial [Boolean] Use serial separators (e.g., serial commas)
   # @return [String]
   def join_and(sep = ', ', andSep = ' and ', serial = true)
     if self.length < 3

data/lib/gamefic/element.rb

@@ -12,12 +12,12 @@ module Gamefic
 
     # @todo It would be nice if this initialization wasn't necessary.
     def initialize(args = {})
-    # super self.class.default_attributes.merge(args)
-    self.class.default_attributes.merge(args).each_pair do |k, v|
-      public_send "#{k}=", v
-    end
-    post_initialize
-    yield self if block_given?
+      # super self.class.default_attributes.merge(args)
+      self.class.default_attributes.merge(args).each_pair do |k, v|
+        public_send "#{k}=", v
+      end
+      post_initialize
+      yield self if block_given?
     end
 
     def post_initialize

data/lib/gamefic/plot.rb

@@ -27,7 +27,6 @@ module Gamefic
 
     exclude_from_serial [:@static]
 
-    # @param structure [Gamefic::Structure]
     # @param metadata [Hash]
     def initialize metadata: {}
       @metadata = metadata
@@ -35,11 +34,6 @@ module Gamefic
       @static = [self] + scene_classes + entities
     end
 
-    def player_class cls = nil
-      @player_class = cls unless cls.nil?
-      @player_class ||= Gamefic::Actor
-    end
-
     # Get an Array of the Plot's current Syntaxes.
     #
     # @return [Array<Syntax>]
@@ -93,8 +87,8 @@ module Gamefic
       end
       call_player_update
       call_update
-      subplots.each { |s| s.update unless s.concluded? }
-      subplots.delete_if { |s| s.concluded? }
+      subplots.delete_if(&:concluded?)
+      subplots.each(&:update)
     end
 
     # Send a message to a group of entities.

data/lib/gamefic/query.rb

@@ -5,6 +5,7 @@ module Gamefic
     autoload :Descendants, 'gamefic/query/descendants'
     autoload :External, 'gamefic/query/external'
     autoload :Family, 'gamefic/query/family'
+    autoload :Tree, 'gamefic/query/tree'
     autoload :Itself, 'gamefic/query/itself'
     autoload :Matches, 'gamefic/query/matches'
     autoload :Parent, 'gamefic/query/parent'

data/lib/gamefic/query/base.rb

@@ -55,13 +55,18 @@ module Gamefic
         result.include?(object)
       end
 
+      # A ranking of how precise the query's arguments are.
+      #
+      # Query precision is a factor in calculating Action#rank.
+      #
+      # @return [Integer]
       def precision
         if @precision.nil?
           @precision = 1
           arguments.each { |a|
-            if a.kind_of?(Class)
+            if a.is_a?(Class)
               @precision += 100
-            elsif a.kind_of?(Gamefic::Entity)
+            elsif a.is_a?(Gamefic::Entity)
               @precision += 1000
             end
           }
@@ -69,10 +74,7 @@ module Gamefic
         end
         @precision
       end
-
-      def rank
-        precision
-      end
+      alias rank precision
 
       def signature
         "#{self.class.to_s.split('::').last.downcase}(#{simplify_arguments.join(', ')})"
@@ -83,18 +85,18 @@ module Gamefic
       # @return [Boolean]
       def accept?(entity)
         result = true
-        arguments.each { |a|
-          if a.kind_of?(Symbol)
-            result = (entity.send(a) != false)
-          elsif a.kind_of?(Regexp)
-            result = (!entity.to_s.match(a).nil?)
-          elsif a.is_a?(Module) or a.is_a?(Class)
-            result = (entity.is_a?(a))
+        arguments.each do |a|
+          result = if a.is_a?(Symbol)
+            (entity.send(a) != false)
+          elsif a.is_a?(Regexp)
+            !entity.to_s.match(a).nil?
+          elsif a.is_a?(Module) || a.is_a?(Class)
+            entity.is_a?(a)
           else
-            result = (entity == a)
+            (entity == a)
           end
           break if result == false
-        }
+        end
         result
       end
 
@@ -109,10 +111,10 @@ module Gamefic
         return [] if entity.nil?
         result = []
         if entity.accessible?
-          entity.children.each { |c|
+          entity.children.each do |c|
             result.push c
             result.concat subquery_accessible(c)
-          }
+          end
         end
         result
       end
@@ -121,7 +123,7 @@ module Gamefic
 
       def simplify_arguments
         arguments.map do |a|
-          if a.kind_of?(Class) or a.kind_of?(Object)
+          if a.is_a?(Class) || a.is_a?(Object)
             a.to_s.split('::').last.downcase
           else
             a.to_s.downcase
@@ -136,13 +138,12 @@ module Gamefic
       def denest(objects, token)
         parts = token.split(NEST_REGEXP)
         current = parts.pop
-        last_result = objects.select{ |e| e.specified?(current) }
-        last_result = objects.select{ |e| e.specified?(current, fuzzy: true) } if last_result.empty?
-        result = last_result
-        while parts.length > 0
+        last_result = objects.select { |e| e.specified?(current) }
+        last_result = objects.select { |e| e.specified?(current, fuzzy: true) } if last_result.empty?
+        until parts.empty?
           current = "#{parts.last} #{current}"
-          result = last_result.select{ |e| e.specified?(current) }
-          result = last_result.select{ |e| e.specified?(current, fuzzy: true) } if result.empty?
+          result = last_result.select { |e| e.specified?(current) }
+          result = last_result.select { |e| e.specified?(current, fuzzy: true) } if result.empty?
           break if result.empty?
           parts.pop
           last_result = result

data/lib/gamefic/query/descendants.rb

@@ -5,9 +5,9 @@ module Gamefic
         result = []
         children = super
         result.concat children
-        children.each { |c|
+        children.each do |c|
           result.concat subquery_accessible(c)
-        }
+        end
         result
       end
     end

data/lib/gamefic/query/family.rb

@@ -1,5 +1,7 @@
 module Gamefic
   module Query
+    # Query to retrieve the subject's siblings and all accessible descendants.
+    #
     class Family < Base
       def context_from(subject)
         result = []

data/lib/gamefic/query/text.rb

@@ -2,14 +2,15 @@ module Gamefic
   module Query
     class Text < Base
       def initialize *arguments
-        arguments.each { |a|
-          if (a.kind_of?(Symbol) or a.kind_of?(String)) and !a.to_s.end_with?('?')
+        arguments.each do |a|
+          if (a.kind_of?(Symbol) || a.kind_of?(String)) && !a.to_s.end_with?('?')
             raise ArgumentError.new("Text query arguments can only be boolean method names (:method?) or regular expressions")
           end
-        }
+        end
         super
       end
-      def resolve(subject, token, continued: false)
+
+      def resolve _subject, token, continued: false
         return Matches.new([], '', token) unless accept?(token)
         parts = token.split(Keywords::SPLIT_REGEXP)
         cursor = []
@@ -22,20 +23,18 @@ module Gamefic
         }
         if continued
           Matches.new([matches.join(' ')], matches.join(' '), parts[i..-1].join(' '))
+        elsif matches.length == parts.length
+          Matches.new([matches.join(' ')], matches.join(' '), '')
         else
-          if matches.length == parts.length
-            Matches.new([matches.join(' ')], matches.join(' '), '')
-          else
-            Matches.new([], '', parts.join(' '))
-          end
+          Matches.new([], '', parts.join(' '))
         end
       end
 
-      def include?(subject, token)
+      def include? _subject, token
         accept?(token)
       end
 
-      def accept?(entity)
+      def accept? entity
         return false unless entity.kind_of?(String) and !entity.empty?
         super
       end

data/lib/gamefic/query/tree.rb

@@ -0,0 +1,17 @@
+module Gamefic
+  module Query
+    # Query to retrieve all of the subject's ancestors, siblings, and descendants.
+    #
+    class Tree < Family
+      def context_from(subject)
+        result = super
+        parent = subject.parent
+        until parent.nil?
+          result.unshift parent
+          parent = parent.parent
+        end
+        result
+      end
+    end
+  end
+end

data/lib/gamefic/scene/multiple_choice.rb

@@ -14,7 +14,7 @@ module Gamefic
 
     # The one-based index of the selected option.
     #
-    # @return [Number]
+    # @return [Integer]
     attr_reader :number
 
     # The full text of the selected option.

data/lib/gamefic/serialize.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 module Gamefic
   module Serialize
     def to_serial(index = [])
@@ -83,6 +85,8 @@ class Object
           return object
         elsif self['class'] == 'Class'
           return Gamefic::Serialize.string_to_constant(self['name'])
+        elsif self['class'] == 'Set'
+          return Set.new(self['data'].map { |el| el.from_serial(index) })
         else
           elematch = self['class'].match(/^#<ELE_([\d]+)>$/)
           if elematch
@@ -208,3 +212,12 @@ class Hash
     result
   end
 end
+
+class Set
+  def to_serial(index = [])
+    {
+      'class' => 'Set',
+      'data' => to_a.map { |el| el.to_serial(index) }
+    }
+  end
+end

data/lib/gamefic/subplot.rb

@@ -11,8 +11,9 @@ module Gamefic
     attr_reader :plot
 
     # @param plot [Gamefic::Plot]
-    # @param introduce [Gamefic::Actor]
-    # @param next_cue [Class<Gamefic::Scene::Base>]
+    # @param introduce [Gamefic::Actor, nil]
+    # @param next_cue [Class<Gamefic::Scene::Base>, nil]
+    # @param more [Hash]
     def initialize plot, introduce: nil, next_cue: nil, **more
       @plot = plot
       @next_cue = next_cue
@@ -98,15 +99,5 @@ module Gamefic
     #
     def configure more
     end
-
-    # def to_serial(index)
-    #   puts "Serializing #{self}"
-    #   super
-    # end
-
-    # def from_serial index = []
-    #   # @todo Customize subplot unserialization
-    #   super
-    # end
   end
 end

data/lib/gamefic/syntax.rb

@@ -86,6 +86,7 @@ module Gamefic
     end
 
     def ==(other)
+      return false unless other.is_a?(Syntax)
       signature == other.signature
     end
 

data/lib/gamefic/version.rb

@@ -1,3 +1,3 @@
 module Gamefic
-  VERSION = '2.0.2'
+  VERSION = '2.0.3'
 end

data/lib/gamefic/world.rb

@@ -1,4 +1,6 @@
 module Gamefic
+  # A collection of classes and modules related to generating a world model.
+  #
   module World
     autoload :Playbook,  'gamefic/world/playbook'
     autoload :Entities,  'gamefic/world/entities'

data/lib/gamefic/world/commands.rb

@@ -96,7 +96,7 @@ module Gamefic
       end
 
       # Declare a dismabiguation response for actions.
-      # The disambigurator is executed when an action expects an argument to
+      # The disambiguator is executed when an action expects an argument to
       # reference a specific entity but its query matched more than one. For
       # example, "red" might refer to either a red key or a red book.
       #
@@ -144,7 +144,7 @@ module Gamefic
       #
       # @return [Array<String>]
       def verbs
-        playbook.verbs.map { |v| v.to_s }.reject{ |v| v.start_with?('_') }
+        playbook.verbs.map(&:to_s).reject { |v| v.start_with?('_') }
       end
 
       # Get an Array of all Actions defined in the Plot.
@@ -164,20 +164,20 @@ module Gamefic
 
       private
 
+      # @param queries [Array]
+      # @return [Array<Query::Base>]
       def map_response_args queries
-        result = []
-        queries.each do |q|
+        queries.map do |q|
           if q.is_a?(Regexp)
-            result.push Gamefic::Query::Text.new(q)
+            Gamefic::Query::Text.new(q)
           elsif q.is_a?(Gamefic::Query::Base)
-            result.push q
+            q
           elsif q.is_a?(Gamefic::Element) || (q.is_a?(Class) && q <= Gamefic::Element)
-            result.push get_default_query.new(q)
+            get_default_query.new(q)
           else
             raise ArgumentError.new("Invalid argument for response: #{q}")
           end
         end
-        result
       end
     end
   end

data/lib/gamefic/world/entities.rb

@@ -93,16 +93,6 @@ module Gamefic
       def players
         @players ||= []
       end
-
-      # private
-
-      # def mark_static_entities
-      #   @static_entity_length ||= entities.length
-      # end
-
-      # def static_entity_length
-      #   @static_entity_length || 0
-      # end
     end
   end
 end

data/lib/gamefic/world/playbook.rb

@@ -3,6 +3,16 @@ module Gamefic
     # A collection of rules for performing commands.
     #
     class Playbook
+      # An array of available syntaxes.
+      #
+      # @return [Array<Gamefic::Syntax>]
+      attr_reader :syntaxes
+
+      # An array of defined validators.
+      #
+      # @return [Array<Proc>]
+      attr_reader :validators
+
       def initialize commands: {}, syntaxes: [], validators: [], disambiguator: nil
         @commands = commands
         @syntaxes = syntaxes
@@ -10,13 +20,6 @@ module Gamefic
         @disambiguator = disambiguator
       end
 
-      # An array of available syntaxes.
-      #
-      # @return [Array<Gamefic::Syntax>]
-      def syntaxes
-        @syntaxes
-      end
-
       # An array of available actions.
       #
       # @return [Array<Gamefic::Action>]
@@ -31,21 +34,14 @@ module Gamefic
         @commands.keys
       end
 
-      # An array of defined validators.
-      #
-      # @return [Array<Proc>]
-      def validators
-        @validators
-      end
-
       # Get the action for handling ambiguous entity references.
       #
       def disambiguator
         @disambiguator ||= Action.subclass(nil, Query::Base.new) do |actor, entities|
           definites = []
-          entities.each { |entity|
+          entities.each do |entity|
             definites.push entity.definitely
-          }
+          end
           actor.tell "I don't know which you mean: #{definites.join_or}."
         end
       end
@@ -66,7 +62,7 @@ module Gamefic
       # Get an Array of all Actions associated with the specified verb.
       #
       # @param verb [Symbol] The Symbol for the verb (e.g., :go or :look)
-      # @return [Array<Action>] The verb's associated Actions
+      # @return [Array<Class<Action>>] The verb's associated Actions
       def actions_for verb
         @commands[verb] || []
       end
@@ -150,12 +146,8 @@ module Gamefic
       # @return [Array<Gamefic::Action>]
       def dispatch(actor, *command)
         result = []
-        if command.length > 1
-          result.concat dispatch_from_params(actor, command[0], command[1..-1])
-        end
-        if result.empty?
-          result.concat dispatch_from_string(actor, command.join(' '))
-        end
+        result.concat dispatch_from_params(actor, command[0], command[1..-1]) if command.length > 1
+        result.concat dispatch_from_string(actor, command.join(' ')) if result.empty?
         result
       end
 
@@ -167,14 +159,13 @@ module Gamefic
       def dispatch_from_string actor, text
         result = []
         commands = Syntax.tokenize(text, actor.syntaxes)
-        commands.each { |c|
-          available = actions_for(c.verb)
-          available.each { |a|
+        commands.each do |c|
+          actions_for(c.verb).each do |a|
             next if a.hidden?
             o = a.attempt(actor, c.arguments)
             result.unshift o unless o.nil?
-          }
-        }
+          end
+        end
         sort_and_reduce_actions result
       end
 
@@ -185,9 +176,9 @@ module Gamefic
       def dispatch_from_params actor, verb, params
         result = []
         available = actions_for(verb)
-        available.each { |a|
+        available.each do |a|
           result.unshift a.new(actor, params) if a.valid?(actor, params)
-        }
+        end
         sort_and_reduce_actions result
       end
 
@@ -217,38 +208,37 @@ module Gamefic
         user_friendly = action.verb.to_s.gsub(/_/, ' ')
         args = []
         used_names = []
-        action.queries.each { |c|
+        action.queries.each do |_c|
           num = 1
           new_name = ":var"
           while used_names.include? new_name
-            num = num + 1
+            num += 1
             new_name = ":var#{num}"
           end
           used_names.push new_name
           user_friendly += " #{new_name}"
           args.push new_name
-        }
+        end
         add_syntax Syntax.new(user_friendly.strip, "#{action.verb} #{args.join(' ')}") unless action.verb.to_s.start_with?('_')
       end
 
       def add_syntax syntax
-        if @commands[syntax.verb] == nil
-          raise "No actions exist for \"#{syntax.verb}\""
-        end
+        raise "No actions exist for \"#{syntax.verb}\"" if @commands[syntax.verb].nil?
+
         @syntaxes.unshift syntax
-        @syntaxes.uniq! &:signature
-        @syntaxes.sort! { |a, b|
+        @syntaxes.uniq!(&:signature)
+        @syntaxes.sort! do |a, b|
           if a.token_count == b.token_count
             # For syntaxes of the same length, length of action takes precedence
             b.first_word <=> a.first_word
           else
             b.token_count <=> a.token_count
           end
-        }
+        end
       end
 
       def sort_and_reduce_actions arr
-        arr.sort_by.with_index{|a, i| [a.rank, -i]}.reverse.uniq(&:class)
+        arr.sort_by.with_index { |a, i| [a.rank, -i]}.reverse.uniq(&:class)
       end
     end
   end

data/lib/gamefic/world/players.rb

@@ -2,6 +2,7 @@ module Gamefic
   module World
     module Players
       include Gamefic::World::Entities
+      include Gamefic::World::Commands
 
       # An array of entities that are currently connected to users.
       #
@@ -10,12 +11,27 @@ module Gamefic
         @players ||= []
       end
 
-      # Get the character that the player will control on introduction.
+      def player_class cls = nil
+        STDERR.puts "Modifying player_class this way is deprecated. Use set_player_class instead" unless cls.nil?
+        @player_class = cls unless cls.nil?
+        @player_class ||= Gamefic::Actor
+      end
+
+      # @param cls [Class]
+      def set_player_class cls
+        unless cls < Gamefic::Active && cls <= Gamefic::Entity
+          raise ArgumentError, "Player class must be an active entity"
+        end
+        @player_class = cls
+      end
+
+      # Make a character that a player will control on introduction.
       #
       # @return [Gamefic::Actor]
-      def get_player_character
+      def make_player_character
         cast player_class, name: 'yourself', synonyms: 'self myself you me', proper_named: true
       end
+      alias get_player_character make_player_character
     end
   end
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-25 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '12.3'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '12.3'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +96,6 @@ files:
 - lib/gamefic/plot.rb
 - lib/gamefic/plot/darkroom.rb
 - lib/gamefic/plot/host.rb
-- lib/gamefic/plot/index.rb
 - lib/gamefic/plot/snapshot.rb
 - lib/gamefic/query.rb
 - lib/gamefic/query/base.rb
@@ -109,6 +108,7 @@ files:
 - lib/gamefic/query/parent.rb
 - lib/gamefic/query/siblings.rb
 - lib/gamefic/query/text.rb
+- lib/gamefic/query/tree.rb
 - lib/gamefic/scene.rb
 - lib/gamefic/scene/activity.rb
 - lib/gamefic/scene/base.rb
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Gamefic

data/lib/gamefic/plot/index.rb

@@ -1,92 +0,0 @@
-module Gamefic
-  class Plot
-    # A fixed index of plot elements. Plots and subplots use an index to track
-    # objects created in scripts.
-    #
-    class Index
-      # @param elements [Array]
-      def initialize elements
-        @elements = elements.uniq.freeze
-      end
-
-      # @return [Boolean]
-      def include? element
-        @elements.include?(element)
-      end
-
-      def all
-        @elements
-      end
-
-      def concat elements
-        @elements = (@elements + elements).uniq.freeze
-      end
-
-      def remove elements
-        @elements = (@elements - elements).uniq.freeze
-      end
-
-      # @return [Object]
-      def element index
-        @elements[index]
-      end
-
-      def id_for(element)
-        include?(element) ? "#<ELE_#{@elements.index(element)}>" : nil
-      end
-
-      # def self.from_serial serial, static
-      #   if serial.is_a?(Hash) && (serial['class'] || serial['element'])
-      #     if serial['class']
-      #       elematch = serial['class'].match(/^#<ELE_([\d]+)>$/)
-      #       if elematch
-      #         klass = static.element(elematch[1].to_i)
-      #       else
-      #         klass = eval(serial['class'])
-      #       end
-      #       object = klass.allocate
-      #     elsif serial['element']
-      #       object = static.element(serial['element'])
-      #     end
-      #     serial.each_pair do |k, v|
-      #       next unless k.to_s.start_with?('@')
-      #       object.instance_variable_set(k, from_serial(v, static))
-      #     end
-      #     object
-      #   elsif serial.is_a?(Numeric)
-      #     serial
-      #   elsif serial.is_a?(String)
-      #     match = serial.match(/#<ELE_([0-9]+)>/)
-      #     return static.element(match[1].to_i) if match
-      #     match = serial.match(/#<SYM:([a-z0-9_\?\!]+)>/i)
-      #     return match[1].to_sym if match
-      #     serial
-      #   elsif serial.is_a?(Array)
-      #     result = serial.map { |e| from_serial(e, static) }
-      #     result = "#<UNKNOWN>" if result.any? { |e| e == "#<UNKNOWN>" }
-      #     result
-      #   elsif serial.is_a?(Hash)
-      #     result = {}
-      #     unknown = false
-      #     serial.each_pair do |k, v|
-      #       k2 = from_serial(k, static)
-      #       v2 = from_serial(v, static)
-      #       if k2 == "#<UNKNOWN>" || v2 == "#<UNKNOWN>"
-      #         unknown = true
-      #         break
-      #       end
-      #       result[k2] = v2
-      #     end
-      #     result = "#<UNKNOWN>" if unknown
-      #     result
-      #   elsif serial && serial != true
-      #     STDERR.puts "Unable to unserialize #{serial.class}"
-      #     nil
-      #   else
-      #     # true, false, or nil
-      #     serial
-      #   end
-      # end
-    end
-  end
-end