gamefic 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42ffeca62def8cbb07d70245a06be065a602c28d
-  data.tar.gz: 49c299be7bafa2aef310aeef08f84b17631b3ce4
+  metadata.gz: b365a88c85293650a4450cb905443a222aa1fa23
+  data.tar.gz: 2e299521b31b1c357651c52b7d2978c69988f306
 SHA512:
-  metadata.gz: a2b1a5142f260633c4b3d59f2c2cd48896926566554e67fe89f09ad0cdd15f98ff2305a09ca8022af3bbc1ae7d50108a9e6a7ead77a1aa48c2445837e918e8b4
-  data.tar.gz: 199e10aa6fd28ed8c4d29dbd17eb6420ff5350fa3689e23ba9f4468af75febf9a115af328e6652365a585c3df70bf2a81cf8b803270cf28ff4810a3346fdead0
+  metadata.gz: 5839d40d6211f3327e7f0d79667e591456e44a72da1f622f87af99127dcc97a207b6cefe06f6beb5edb75e135d85b1517a8731504b032fa706062f86d4c69e0b
+  data.tar.gz: 6ad1537348f09477915daab0a77b1709cea1380145323ab4d803565898f9ab693bd0fd065dd33eef57d94d09d104355d64e7119978e2f57fba359c58a599fde5

data/lib/gamefic/action.rb

@@ -1,5 +1,10 @@
 module Gamefic
 
+  # Exception raised when the Action's proc arity is not compatible with the
+  # number of queries
+  class ActionArgumentError < ArgumentError
+  end
+  
   # Actions manage the execution of commands that Characters can perform.
   # 
   class Action
@@ -7,28 +12,24 @@ module Gamefic
     attr_writer :meta
     @@order_key_seed = 0
     
-    def initialize(plot, verb, *queries, &proc)
+    def initialize(verb, *queries, &proc)
       if !verb.kind_of?(Symbol)
         verb = verb.to_s
         verb = nil if verb == ''
       end
-      @plot = plot
       @order_key = @@order_key_seed
       @@order_key_seed += 1
       @proc = proc
       if (verb.kind_of?(Symbol) == false and !verb.nil?)
-        raise "Action verbs must be symbols"
+        raise "Action verbs must be symbols #{verb}"
       end
       if !@proc.nil?
-        if (queries.length + 1 != @proc.arity) and (queries.length == 0 and @proc.arity != -1)
-          raise "Number of queries is not compatible with proc arguments"
+        if (queries.length + 1 != @proc.arity) and (@proc.arity > 0)
+          raise ActionArgumentError.new("Number of queries is not compatible with proc arguments")
         end
       end
       @verb = verb
       @queries = queries
-      if !plot.nil?
-        plot.send :add_action, self
-      end
     end
     
     # Get the specificity of the Action.
@@ -44,14 +45,12 @@ module Gamefic
       if verb.nil?
         spec = -100
       end
-      magnitude = 1
       @queries.each { |q|
         if q.kind_of?(Query::Base)
-          spec += (q.specificity * magnitude)
+          spec += q.specificity
         else
-          spec += magnitude
+          spec += 1
         end
-        #magnitude = magnitude * 10
       }
       return spec
     end

data/lib/gamefic/director/delegate.rb

@@ -4,7 +4,7 @@ module Gamefic
       # If we use Query::Base.new in the @disambiguator declaration, Opal
       # passes the block to the query instead of the action.
       base = Query::Base.new
-      @@disambiguator = Action.new nil, nil, base do |actor, entities|
+      @@disambiguator = Action.new nil, base do |actor, entities|
         definites = []
         entities.each { |entity|
           definites.push entity.definitely
@@ -23,53 +23,7 @@ module Gamefic
         while !executed
           order = @orders.shift
           break if order.nil?
-          arg_i = 0
-          final_arguments = []
-          order.arguments.each { |argument|
-            if argument.length > 1 and !order.action.queries[arg_i].allow_many?
-              if argument[0].kind_of?(Array)
-                # This thing refers to multiple items. Just keep going.
-                final_arguments = nil
-                break
-              else
-                ambiguous = argument
-              end
-              order = Order.new(@actor, @@disambiguator, [])
-              final_arguments = [ambiguous]
-              break
-            end
-            valid = []
-            if order.action.queries[arg_i].allow_ambiguous?
-              valid = argument.flatten
-            else
-              argument.each { |m|
-                if order.action.queries[arg_i].validate(@actor, m)
-                  valid.push m
-                else
-                  final_arguments = nil
-                  break
-                end
-              }
-            end
-            if order.action == @@disambiguator or final_arguments.nil?
-              break
-            end
-            if order.action.queries[arg_i].allow_many?
-              final_arguments.push valid.flatten
-            elsif valid.length == 1
-              final_arguments.push valid[0]
-            else
-              final_arguments = nil
-              break
-            end
-            arg_i += 1
-          }
-          if !final_arguments.nil?
-            # The actor is always the first argument to an Action proc
-            final_arguments.unshift @actor
-            order.action.execute(*final_arguments)
-            executed = true
-          end
+          executed = try(order)
         end
         @actor.send(:delegate_stack).pop
       end
@@ -86,6 +40,65 @@ module Gamefic
         proceed
       end
       private
+      def try order
+        executed = false
+        arg_i = 0
+        final_arguments = []
+        order.arguments.each { |argument|
+          if argument.length > 1 and !order.action.queries[arg_i].allow_many?
+            if argument[0].kind_of?(Array)
+              # This thing refers to multiple items. Just keep going.
+              final_arguments = nil
+              break
+            else
+              ambiguous = argument
+            end
+            order = Order.new(@actor, @@disambiguator, [])
+            final_arguments = [ambiguous]
+            break
+          end
+          if order.action.queries[arg_i].allow_ambiguous?
+            valid = argument.flatten
+          else
+            valid = validate(argument, arg_i, order)
+            if valid.nil?
+              final_arguments = nil
+              break
+            end
+          end
+          if order.action == @@disambiguator or final_arguments.nil?
+            break
+          end
+          if order.action.queries[arg_i].allow_many?
+            final_arguments.push valid.flatten
+          elsif valid.length == 1
+            final_arguments.push valid[0]
+          else
+            final_arguments = nil
+            break
+          end
+          arg_i += 1
+        }
+        if !final_arguments.nil?
+          # The actor is always the first argument to an Action proc
+          final_arguments.unshift @actor
+          order.action.execute(*final_arguments)
+          executed = true
+        end
+        executed
+      end
+      def validate argument, arg_i, order
+        valid = []
+        argument.each { |m|
+          if order.action.queries[arg_i].validate(@actor, m)
+            valid.push m
+          else
+            valid = nil
+            break
+          end
+        }
+        valid
+      end
     end
   end
 end

data/lib/gamefic/director/parser.rb

@@ -102,7 +102,7 @@ module Gamefic
               objects.push Order.new(actor, action, prepared)
             else
               if !action.queries.last.allow_many? or action.queries.last.allow_ambiguous?
-                misunderstood = Action.new nil, nil, Query::Text.new do |actor, text|
+                misunderstood = Action.new nil, Query::Text.new do |actor, text|
                   actor.tell "I understand the first part of your command but not \"#{text}.\""
                 end
                 misunderstood.meta = true

data/lib/gamefic/engine/tty.rb

@@ -33,10 +33,7 @@ module Gamefic
         @stream.ansi
       end
       def save filename, snapshot
-        data = {
-          :metadata => @character.plot.metadata,
-          :entities => snapshot
-        }
+        data = snapshot.merge(:metadata => @character.plot.metadata)
         json = JSON.generate data
         if json.nil?
           @character.tell "Nothing to save."
@@ -63,7 +60,7 @@ module Gamefic
             if (data[:metadata] != @character.plot.metadata)
               @character.tell "The save file is not compatible with this version of the game."
             else
-              return data[:entities]
+              return data
             end
           else
             @character.tell "File \"#{filename}\" not found."

data/lib/gamefic/plot.rb

@@ -5,6 +5,7 @@ require 'gamefic/tester'
 require 'gamefic/source'
 require 'gamefic/script'
 require 'gamefic/query'
+require 'gamefic/subplot'
 
 module Gamefic
 
@@ -25,8 +26,11 @@ module Gamefic
     # Gamefic Studio has a PlotStageMetaMapper that handles it, but it doesn't run if
     # the plugin isn't activated.
     #include Gamefic, Tester, SceneMount, CommandMount, EntityMount, QueryMount, ArticleMount, YouMount, Snapshot
-    mount Gamefic, Tester, SceneMount, CommandMount, EntityMount, QueryMount, ArticleMount, YouMount, Snapshot
-    expose :script, :introduction, :assert_action, :before_player_update, :on_update, :on_player_update, :entities, :on_ready, :on_player_ready, :players, :scenes, :metadata
+    mount Gamefic, Tester, SceneMount, CommandMount, EntityMount, QueryMount,
+      ArticleMount, YouMount, Snapshot, Subplot::Host
+    expose :script, :introduction, :assert_action, :before_player_update,
+      :on_update, :on_player_update, :entities, :on_ready, :on_player_ready,
+      :players, :scenes, :metadata
     
     # @param [Source::Base]
     def initialize(source = nil)
@@ -44,6 +48,7 @@ module Gamefic
       @players = []
       @asserts = {}
       @default_scene = :active
+      @subplots = []
       post_initialize
     end
 
@@ -165,6 +170,7 @@ module Gamefic
     # Introduce a player to the game.
     # This method is typically called by the Engine that manages game execution.
     def introduce(player)
+      player.extend Subplot::Feature
       @players.push player
       if @introduction != nil
         @introduction.call(player)
@@ -341,7 +347,7 @@ module Gamefic
         user_friendly += " #{new_name}"
         args.push new_name
       }
-      Syntax.new self, user_friendly.strip, "#{action.verb} #{args.join(' ')}"
+      add_syntax Syntax.new(user_friendly.strip, "#{action.verb} #{args.join(' ')}")
     end
     def rem_action(action)
       @commands[action.verb].delete(action)

data/lib/gamefic/plot/command_mount.rb

@@ -24,7 +24,9 @@ module Gamefic
       act
     end
     def action(command, *queries, &proc)
-      Action.new(self, command, *queries, &proc)
+      act = Action.new(command, *queries, &proc)
+      add_action act
+      act
     end
     # Create an Action that responds to a command.
     # An Action uses the command argument to identify the imperative verb that
@@ -72,7 +74,8 @@ module Gamefic
       xlate(*args)
     end
     def xlate(*args)
-      syn = Syntax.new(self, *args)
+      syn = Syntax.new(*args)
+      add_syntax syn
       syn
     end
     def commandwords

data/lib/gamefic/plot/snapshot.rb

@@ -2,6 +2,10 @@ require 'json'
 
 module Gamefic
   module Plot::Snapshot
+  
+    # Take a snapshot of the plot's current state.
+    #
+    # @return [Hash]
     def save
       store = []
       index = 0
@@ -44,44 +48,59 @@ module Gamefic
       else
         store = reduce(store)
       end
-      store
+      return {
+        entities: store,
+        subplots: save_subplots
+      }
     end
+    
+    # Restore the plot to the state of the provided snapshot.
+    #
+    # @param [Hash]
     def restore snapshot
-      internal_restore snapshot, true
+      restore_initial_state
+      internal_restore snapshot[:entities]
+      restore_subplots snapshot[:subplots]
     end
+    
     private
-    def internal_restore snapshot, with_restore = true
-      if with_restore
+    
+    # Restore the plot to the state of its first snapshot.
+    #
+    def restore_initial_state
         @entities[@initial_state.length..-1].each { |e|
           e.parent = nil
         }
         @entities.slice! @initial_state.length..-1
-        internal_restore @initial_state, false
-      end
+        internal_restore @initial_state
+    end
+    
+    def internal_restore snapshot
       index = 0
       snapshot.each { |hash|
         if entities[index].nil?
-          if with_restore
-            cls = Kernel.const_get(hash[:class])
-            entities[index] = make cls
-          else
-            break
-          end
+          cls = Kernel.const_get(hash[:class])
+          @entities[index] = make cls
         end 
-        hash.each_pair { |k, v|
-          if k == :scene
-            entities[index].cue v.to_sym
-          else
-            entities[index].send("#{k}=", unserialize(v)) if k != :session and k != :class
-          end
-        }
+        internal_restore_hash hash, index
+        index += 1
+      }
+      nil
+    end
+    def internal_restore_hash hash, index
+      hash.each { |k, v|
+        if k == :scene
+          entities[index].cue v.to_sym
+        elsif (k != :session and k != :class)
+          entities[index].send("#{k}=", unserialize(v))
+        end
         unless hash[:session].nil?
           hash[:session].each_pair { |k, v|
             entities[index].session[k.to_sym] = unserialize(v)
           }
         end
-        index += 1
       }
+      nil
     end
     def reduce entities
       reduced = []
@@ -98,7 +117,6 @@ module Gamefic
       }
       reduced
     end
-    private
     def can_serialize? obj
       return true if (obj == true or obj == false or obj.nil?)
       allowed = [String, Fixnum, Float, Numeric, Entity, Direction, Hash, Array, Symbol]
@@ -111,23 +129,9 @@ module Gamefic
       return nil if obj.nil?
       return false if obj == false
       if obj.kind_of?(Hash)
-        hash = {}
-        obj.each_pair { |k, v|
-          if can_serialize?(k) and can_serialize?(v)
-            hash[serialize_obj(k)] = serialize_obj(v)
-          end
-        }
-        return hash
+        return serialize_hash obj
       elsif obj.kind_of?(Array)
-        arr = []
-        obj.each_index { |i|
-          if can_serialize?(obj[i])
-            arr[i] = serialize_obj(obj[i])
-          else
-            raise "Bad array in snapshot"
-          end
-        }
-        return arr
+        return serialize_array obj
       else
         if obj.kind_of?(Entity)
           return "#<EIN_#{@entities.index(obj)}>"
@@ -137,29 +141,91 @@ module Gamefic
       end
       return obj
     end
+    def serialize_hash obj
+      hash = {}
+      obj.each_pair { |k, v|
+        if can_serialize?(k) and can_serialize?(v)
+          hash[serialize_obj(k)] = serialize_obj(v)
+        end
+      }
+      return hash
+    end
+    def serialize_array obj
+      arr = []
+      obj.each_index { |i|
+        if can_serialize?(obj[i])
+          arr[i] = serialize_obj(obj[i])
+        else
+          raise "Bad array in snapshot"
+        end
+      }
+      return arr
+    end
     def unserialize obj
       if obj.kind_of?(Hash)
-        hash = {}
-        obj.each_pair { |k, v|
-          hash[unserialize(k)] = unserialize(v)
-        }
-        hash
+        unserialize_hash obj
       elsif obj.kind_of?(Array)
-        arr = []
-        obj.each_index { |i|
-          arr[i] = unserialize(obj[i])
-        }
-        arr
+        unserialize_array obj
+      elsif obj.to_s.match(/^#<EIN_[0-9]+>$/)
+        i = obj[6..-2].to_i
+        @entities[i]
+      elsif obj.to_s.match(/^#<DIR_[a-z]+>$/)
+        Direction.find(obj[6..-2])
       else
-        if obj.to_s.match(/^#<EIN_[0-9]+>$/)
-          i = obj[6..-2].to_i
-          @entities[i]
-        elsif obj.to_s.match(/^#<DIR_[a-z]+>$/)
-          Direction.find(obj[6..-2])
-        else
-          obj
-        end
+        obj
       end
     end
+    def unserialize_hash obj
+      hash = {}
+      obj.each_pair { |k, v|
+        hash[unserialize(k)] = unserialize(v)
+      }
+      hash
+    end
+    def unserialize_array obj
+      arr = []
+      obj.each_index { |i|
+        arr[i] = unserialize(obj[i])
+      }
+      arr
+    end
+    def save_subplots
+      arr = []
+      subplots.each { |s|
+        hash = {}
+        hash[:class] = s.class.to_s
+        s.instance_variables.each { |k|
+          v = s.instance_variable_get(k)
+          if can_serialize?(v)
+            hash[k] = serialize_obj(v)
+          end
+        }
+        arr.push hash
+      }
+      arr
+    end
+    def restore_subplots arr
+      players.each { |p|
+        p.send(:p_subplots).clear
+      }
+      p_subplots.clear
+      arr.each { |hash|
+        cls = Kernel.const_get(hash[:class])
+        subplot = cls.new self
+        hash.each { |k, v|
+          if k != :class
+            subplot.instance_variable_set(k, unserialize(v))
+          end
+        }
+        subplot.players.each { |p|
+          p.send(:p_subplots).push subplot
+        }
+        subplot.entities.each { |e|
+          e.extend Subplot::Element
+          e.instance_variable_set(:@subplot, subplot)
+        }
+        p_subplots.push subplot
+      }
+    end
   end
 end

data/lib/gamefic/subplot.rb

@@ -0,0 +1,81 @@
+module Gamefic
+
+  class Subplot
+    module Element
+      attr_reader :subplot
+    end
+    module Feature
+      def subplots
+        p_subplots.clone
+      end
+      private
+      def p_subplots
+        @p_subplots ||= []
+      end
+    end
+    module Host
+      # Get an array of all the current subplots.
+      #
+      # @return [Array<Subplot>]
+      def subplots
+        p_subplots.clone
+      end
+      
+      # Start a new subplot based on the provided class.
+      #
+      # @param [Class] The class of the subplot to be created (Subplot by default)
+      # @return [Subplot]
+      def branch subplot_class = Subplot, &block
+        subplot = subplot_class.new(self, &block)
+        p_subplots.push subplot
+        subplot
+      end
+      
+      private
+      def p_subplots
+        @p_subplots ||= []
+      end
+    end
+    
+    attr_reader :plot, :entities, :players
+    
+    def initialize plot
+      @plot = plot
+      @entities = []
+      @players = []
+      @concluded = false
+      post_initialize
+      yield(self) if block_given?
+    end
+    def post_initialize
+    end
+    def make *args
+      e = plot.make(*args)
+      e.extend Gamefic::Subplot::Element
+      e.instance_variable_set(:@subplot, self)
+      entities.push e
+      e
+    end
+    def introduce player
+      player.send(:p_subplots).push self
+      players.push player
+    end
+    def exeunt player
+      player.send(:p_subplots).delete self
+      players.delete player
+    end
+    def conclude
+      concluded = true
+      entities.each { |e|
+        e.destroy
+      }
+      players.each { |p|
+        exeunt p
+      }
+    end
+    def concluded?
+      @concluded
+    end
+  end
+  
+end

data/lib/gamefic/syntax.rb

@@ -6,7 +6,7 @@ module Gamefic
     attr_reader :token_count, :first_word, :verb, :template, :command
     @@phrase = '([\w\W\s\S]*?)'
     
-    def initialize plot, template, *command
+    def initialize template, *command
       command = command.join(' ')
       words = template.split_words
       @token_count = words.length
@@ -50,9 +50,6 @@ module Gamefic
       }
       @replace = subs.join(' ')
       @regexp = Regexp.new("^#{tokens.join(' ')}$", Regexp::IGNORECASE)
-      if !plot.nil?
-        plot.send :add_syntax, self
-      end
     end
     
     # Convert a String into a Command.

data/lib/gamefic/version.rb

@@ -1,3 +1,3 @@
 module Gamefic
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,41 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2016-11-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: An adventure game and interactive fiction framework
@@ -124,6 +138,7 @@ files:
 - lib/gamefic/source/file.rb
 - lib/gamefic/source/text.rb
 - lib/gamefic/stage.rb
+- lib/gamefic/subplot.rb
 - lib/gamefic/syntax.rb
 - lib/gamefic/tester.rb
 - lib/gamefic/version.rb
@@ -137,18 +152,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Gamefic
 test_files: []
+has_rdoc: