gamefic 1.6.0 → 2.0.3

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/external.rb

@@ -0,0 +1,18 @@
+module Gamefic
+  module Query
+    class External < Base
+      def initialize objects, *args
+        super(*args)
+        @objects = objects
+      end
+
+      def context_from subject
+        @objects
+      end
+
+      def accept?(entity)
+        @objects.include?(entity) && super(entity)
+      end
+    end
+  end
+end

data/lib/gamefic/query/family.rb

@@ -1,15 +1,11 @@
 module Gamefic
   module Query
+    # Query to retrieve the subject's siblings and all accessible descendants.
+    #
     class Family < Base
       def context_from(subject)
         result = []
-        top = subject.parent
-        unless top.nil?
-          #until top.parent.nil?
-          #  top = top.parent
-          #end
-          result.concat subquery_accessible(top)
-        end
+        result.concat subquery_accessible(subject.parent)
         result.delete subject
         subject.children.each { |c|
           result.push c

data/lib/gamefic/query/matches.rb

@@ -1,67 +1,75 @@
-module Gamefic
-  module Query
-    class Matches
-      attr_accessor :objects, :matching, :remaining
-
-      def initialize objects, matching, remaining
-        @objects = objects
-        @matching = matching
-        @remaining = remaining
-      end
-
-      def self.execute objects, description, continued: false
-        if continued
-          match_with_remainder objects, description
-        else
-          match_without_remainder objects, description
-        end
-      end
-
-      class << self
-        private
-
-        def match_without_remainder objects, description
-          matches = objects.select{ |e| e.match?(description) }
-          if matches.empty?
-            matching = ''
-            remaining = description
-          else
-            matching = description
-            remaining = ''
-          end
-          Matches.new(matches, matching, remaining)
-        end
-
-        def match_with_remainder objects, description
-          matching_objects = objects
-          matching_text = []
-          words = description.split(Matchable::SPLIT_REGEXP)
-          i = 0
-          #cursor = []
-          words.each { |w|
-            cursor = inner_match matching_objects, words, matching_text, i, w
-            break if cursor.empty? or (cursor & matching_objects).empty?
-            matching_objects = (cursor & matching_objects)
-            i += 1
-          }
-          objects = matching_objects
-          matching = matching_text.uniq.join(' ')
-          remaining = words[i..-1].join(' ')
-          m = Matches.new(objects, matching, remaining)
-          m
-        end
-
-        def inner_match matching_objects, words, matching_text, i, w
-          cursor = []
-          matching_objects.each { |o|
-            if o.match?(words[0..i].join(' '), fuzzy: true)
-              cursor.push o
-              matching_text.push w
-            end
-          }
-          cursor
-        end
-      end
-    end
-  end
-end
+module Gamefic
+  module Query
+    class Matches
+      # The resolved tokens
+      # @return [Array<Object>]
+      attr_reader :objects
+
+      # The matching string
+      # @return [String]
+      attr_reader :matching
+
+      # The remaining (unmatched) string
+      # @return [String]
+      attr_reader :remaining
+
+      def initialize objects, matching, remaining
+        @objects = objects
+        @matching = matching
+        @remaining = remaining
+      end
+
+      def self.execute objects, description, continued: false
+        if continued
+          match_with_remainder objects, description
+        else
+          match_without_remainder objects, description
+        end
+      end
+
+      class << self
+        private
+
+        def match_without_remainder objects, description
+          matches = objects.select{ |e| e.specified?(description) }
+          if matches.empty?
+            matching = ''
+            remaining = description
+          else
+            matching = description
+            remaining = ''
+          end
+          Matches.new(matches, matching, remaining)
+        end
+
+        def match_with_remainder objects, description
+          matching_objects = objects
+          matching_text = []
+          words = description.split(Keywords::SPLIT_REGEXP)
+          i = 0
+          words.each { |w|
+            cursor = inner_match matching_objects, words, matching_text, i, w
+            break if cursor.empty? or (cursor & matching_objects).empty?
+            matching_objects = (cursor & matching_objects)
+            i += 1
+          }
+          objects = matching_objects
+          matching = matching_text.uniq.join(' ')
+          remaining = words[i..-1].join(' ')
+          Matches.new(objects, matching, remaining)
+        end
+
+        def inner_match matching_objects, words, matching_text, i, w
+          cursor = []
+          matching_objects.each { |o|
+            if o.specified?(words[0..i].join(' '), fuzzy: true)
+              cursor.push o
+              matching_text.push w
+            end
+          }
+          cursor
+        end
+      end
+    end
+  end
+end

data/lib/gamefic/query/text.rb

@@ -2,15 +2,17 @@ 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)
-        parts = token.split(Matchable::SPLIT_REGEXP)
+
+      def resolve _subject, token, continued: false
+        return Matches.new([], '', token) unless accept?(token)
+        parts = token.split(Keywords::SPLIT_REGEXP)
         cursor = []
         matches = []
         i = 0
@@ -21,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.rb

@@ -1,16 +1,12 @@
-#require 'gamefic/scene_data'
-
 module Gamefic
-
   module Scene
     autoload :Base, 'gamefic/scene/base'
     autoload :Custom, 'gamefic/scene/custom'
-    autoload :Active, 'gamefic/scene/active'
+    autoload :Activity, 'gamefic/scene/activity'
     autoload :Pause, 'gamefic/scene/pause'
     autoload :Conclusion, 'gamefic/scene/conclusion'
     autoload :MultipleChoice, 'gamefic/scene/multiple_choice'
     autoload :MultipleScene, 'gamefic/scene/multiple_scene'
     autoload :YesOrNo, 'gamefic/scene/yes_or_no'
   end
-  
 end

data/lib/gamefic/scene/{active.rb → activity.rb}

@@ -1,26 +1,24 @@
 module Gamefic
-
   # Active Scenes handle the default command prompt, where input is parsed
   # into an Action performed by the Character. This is the default scene in
   # a Plot.
   #
-  class Scene::Active < Scene::Base
+  class Scene::Activity < Scene::Base
     def post_initialize
-      self.type = 'Active'
+      self.type = 'Activity'
     end
 
     def finish
       super
       o = nil
-      o = actor.perform input.strip unless input.nil?
+      o = actor.perform input.strip unless input.to_s.strip.empty?
       actor.performed o
     end
 
     class << self
       def type
-        'Active'
+        'Activity'
       end
     end
   end
-  
 end

data/lib/gamefic/scene/base.rb

@@ -1,56 +1,103 @@
 module Gamefic
-  
   # The Base Scene is not intended for instantiation. Other Scene classes
   # should inherit from it.
   #
   class Scene::Base
+    include Gamefic::Serialize
+    extend Gamefic::Serialize
+
+    # The scene's primary actor.
+    #
+    # @return [Gamefic::Actor]
     attr_reader :actor
+
+    # A human-readable string identifying the type of scene.
+    #
+    # @return [String]
     attr_writer :type
+
+    # The text to display when requesting input.
+    #
+    # @return [String]
     attr_writer :prompt
+
+    # The input received from the actor.
+    #
+    # @return [String]
     attr_reader :input
 
-    def initialize actor
+    # @return [Hash{Symbol => Object}]
+    attr_reader :data
+
+    def initialize actor, **data
       @actor = actor
+      @data = data
       post_initialize
     end
 
+    # A shortcut for the #data hash.
+    #
+    # @param key [Symbol]
+    # @return [Object]
+    def [] key
+      data[key]
+    end
+
     def post_initialize
     end
 
+    # Set a proc to be executed at the end of the scene.
+    #
     def on_finish &block
       @finish_block = block
     end
 
+    # Update the scene.
+    #
     def update
       @input = actor.queue.shift
       finish
     end
 
+    # Start the scene.
+    #
     def start
-      self.class.initialize_block.call @actor, self unless self.class.initialize_block.nil?
+      self.class.start_block.call @actor, self unless self.class.start_block.nil?
+      @actor.entered self if tracked?
     end
 
+    # Finish the scene.
+    #
     def finish
       @finish_block.call @actor, self unless @finish_block.nil?
+      @finished = true
     end
 
-    def flush
-      @state.clear
+    # Determine whether the scene's execution is finished.
+    #
+    # @return [Boolean]
+    def finished?
+      @finished ||= false
     end
 
+    # Get a hash that describes the current state of the scene.
+    #
+    # @return [Hash]
     def state
       {
-        scene: type, prompt: prompt, input: input #, output: actor.messages, busy: !actor.queue.empty?
+        scene: type, prompt: prompt
       }
     end
 
+    # @yieldparam [Class<Gamefic::Actor>]
+    # @return [Class<Gamefic::Scene::Base>]
     def self.subclass &block
       c = Class.new(self) do
-        on_initialize &block
+        on_start &block
       end
       c
     end
-    
+
     # Get the prompt to be displayed to the user when accepting input.
     #
     # @return [String] The text to be displayed.
@@ -58,19 +105,36 @@ module Gamefic
       @prompt ||= '>'
     end
 
+    # Get a String that describes the type of scene.
+    #
+    # @return [String]
     def type
       @type ||= 'Scene'
     end
 
-    def self.on_initialize &block
-      @initialize_block = block
+    # @yieldparam [Class<Gamefic::Scene::Base>]
+    def self.on_start &block
+      @start_block = block
+    end
+
+    def tracked?
+      self.class.tracked?
+    end
+
+    def tracked= bool
+      self.class.tracked = bool
     end
 
     class << self
-      def initialize_block
-        @initialize_block
+      attr_writer :tracked
+
+      def start_block
+        @start_block
+      end
+
+      def tracked?
+        @tracked ||= false
       end
     end
   end
-
 end