gamefic 2.0.2 → 2.2.0

data/lib/gamefic/element.rb

@@ -7,17 +7,20 @@ module Gamefic
   #
   class Element
     include Gamefic::Describable
-    # include Gamefic::Index
     include Gamefic::Serialize
 
-    # @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?
+      klass = self.class
+      defaults = {}
+      while klass <= Element
+        defaults = klass.default_attributes.merge(defaults)
+        klass = klass.superclass
+      end
+      defaults.merge(args).each_pair do |k, v|
+        public_send "#{k}=", v
+      end
+      post_initialize
+      yield self if block_given?
     end
 
     def post_initialize
@@ -38,10 +41,6 @@ module Gamefic
       def default_attributes
         @default_attributes ||= {}
       end
-
-      def inherited subclass
-        subclass.set_default default_attributes
-      end
     end
   end
 end

data/lib/gamefic/entity.rb

@@ -13,10 +13,10 @@ module Gamefic
 
     # Set the Entity's parent.
     #
-    # @param node [Gamefic::Entity] The new parent.
+    # @param node [Gamefic::Entity, nil] The new parent.
     def parent=(node)
-      if node != nil and node.kind_of?(Entity) == false
-        raise "Entity's parent must be an Entity"
+      if node && node.is_a?(Entity) == false
+        raise ArgumentError, "Entity's parent must be an Entity"
       end
       super
     end

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>]
@@ -80,7 +74,6 @@ module Gamefic
       entities.each { |e| e.flush }
       call_before_player_update
       players.each do |p|
-        p.performed nil
         next unless p.scene
         p.last_input = p.queue.last
         p.last_prompt = p.scene.prompt
@@ -93,8 +86,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/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/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/scene/activity.rb

@@ -10,9 +10,7 @@ module Gamefic
 
     def finish
       super
-      o = nil
-      o = actor.perform input.strip unless input.to_s.strip.empty?
-      actor.performed o
+      actor.perform input.strip unless input.to_s.strip.empty?
     end
 
     class << self

data/lib/gamefic/scene/base.rb

@@ -1,6 +1,8 @@
 module Gamefic
-  # The Base Scene is not intended for instantiation. Other Scene classes
-  # should inherit from it.
+  # An abstract class for building different types of scenes. It can be
+  # extended either through concrete subclasses or by creating anonymous
+  # subclasses through a scene helper method like
+  # `Gamefic::World::Scenes#custom`.
   #
   class Scene::Base
     include Gamefic::Serialize

data/lib/gamefic/scene/conclusion.rb

@@ -1,7 +1,7 @@
 module Gamefic
   # A Conclusion ends the Plot (or the character's participation in it).
   #
-  class Scene::Conclusion < Scene::Custom
+  class Scene::Conclusion < Scene::Base
     def type
       @type ||= 'Conclusion'
     end

data/lib/gamefic/scene/multiple_choice.rb

@@ -6,7 +6,7 @@ module Gamefic
   # The finish block's input parameter receives a MultipleChoice::Input object
   # instead of a String.
   #
-  class Scene::MultipleChoice < Scene::Custom
+  class Scene::MultipleChoice < Scene::Base
     # The zero-based index of the selected option.
     #
     # @return [Integer]
@@ -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.
@@ -33,7 +33,6 @@ module Gamefic
       get_choice
       if selection.nil?
         actor.tell invalid_message
-        tell_options
       else
         super
       end
@@ -77,14 +76,5 @@ module Gamefic
         }
       end
     end
-
-    def tell_options
-      list = '<ol class="multiple_choice">'
-      options.each { |o|
-        list += "<li><a href=\"#\" rel=\"gamefic\" data-command=\"#{o}\">#{o}</a></li>"
-      }
-      list += "</ol>"
-      actor.tell list
-    end
   end
 end

data/lib/gamefic/scene/pause.rb

@@ -1,7 +1,7 @@
 module Gamefic
   # Pause for user input.
   #
-  class Scene::Pause < Scene::Custom
+  class Scene::Pause < Scene::Base
     def post_initialize
       self.type = 'Pause'
       self.prompt = 'Press enter to continue...'

data/lib/gamefic/scene/yes_or_no.rb

@@ -4,7 +4,7 @@ module Gamefic
   # block. After the scene is finished, the :active scene will be cued if no
   # other scene has been prepared or cued.
   #
-  class Scene::YesOrNo < Scene::Custom
+  class Scene::YesOrNo < Scene::Base
     attr_writer :invalid_message
 
     def post_initialize

data/lib/gamefic/scene.rb

@@ -1,7 +1,6 @@
 module Gamefic
   module Scene
     autoload :Base, 'gamefic/scene/base'
-    autoload :Custom, 'gamefic/scene/custom'
     autoload :Activity, 'gamefic/scene/activity'
     autoload :Pause, 'gamefic/scene/pause'
     autoload :Conclusion, 'gamefic/scene/conclusion'

data/lib/gamefic/serialize.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 module Gamefic
   module Serialize
     def to_serial(index = [])
@@ -30,13 +32,6 @@ module Gamefic
       end
     end
 
-    def self.instances
-      GC.start
-      result = []
-      ObjectSpace.each_object(Gamefic::Serialize) { |obj| result.push obj }
-      result
-    end
-
     # @param string [String]
     # @return [Object]
     def self.string_to_constant string
@@ -69,7 +64,7 @@ class Object
   end
 
   def from_serial(index = [])
-    if self.is_a?(Hash) && (self['class'] || self['instance'])
+    if self.is_a?(Hash)
       if self['instance']
         elematch = self['instance'].match(/^#<ELE_([\d]+)>$/)
         object = index[elematch[1].to_i]
@@ -83,6 +78,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
@@ -106,25 +103,8 @@ class Object
       return index.index(match[1].to_i) if match
       match = self.match(/#<SYM:([a-z0-9_\?\!]+)>/i)
       return match[1].to_sym if match
-      # return nil if self == '#<UNKNOWN>'
+      return nil if self == '#<UNKNOWN>'
       self
-    elsif self.is_a?(Hash)
-      result = {}
-      unknown = false
-      self.each_pair do |k, v|
-        k2 = k.from_serial(index)
-        v2 = v.from_serial(index)
-        if k2 == "#<UNKNOWN>" || v2 == "#<UNKNOWN>"
-          unknown = true
-          break
-        end
-        result[k2] = v2
-      end
-      result = "#<UNKNOWN>" if unknown
-      result
-    elsif self && self != true
-      STDERR.puts "Unable to unserialize #{self.class}"
-      nil
     else
       # true, false, or nil
       self
@@ -208,3 +188,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