gamefic 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 758b3f682dd5837841ce39281a53e6d8beada80ca0f0f0308f2b3909d12349b7
-  data.tar.gz: c330934f0a69040e96cf7c18936b93e5b5cf7580ba95a0ef46e633a79975f513
+  metadata.gz: 5d4af1f6add0c467fce62acde7d4903e2165a0007312720ac0a43fb324e2a594
+  data.tar.gz: fe6adad9a8c85fd9eac1b9b6921e13f356da73489e9d82c95b63974f94f45df0
 SHA512:
-  metadata.gz: f95a19e039ef00076f23f90902077ba78941b2b186bad9963222da21001148741800058c97c7a110662f660af3334ef0a4732046210946ce9a9c54a340d8d566
-  data.tar.gz: dfb08b610f13a75c5515bf95d41834db415bee8a3d196238f53385c6d2983a84dcd8906d048440c21601858f13c48a0f2359da21ea0596455ee7fac7ddd66acf
+  metadata.gz: b2b0fda9b69825c655f6dfa90fa4c1bca78a6a53ea625946d54f9981d11104660f1e4f312bc53086559345f0c211edf979f237e18fd4bf95d83a2755e7b1cc9b
+  data.tar.gz: b1c85ff6f5c103354af38588bc129c989929c259ef4062abd8e9a0e5f92100fcf2134e1d16f3d8e3180bbcacd672d85b3cf5d1f162a8ff19217a64dc419e9bd7

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

@@ -0,0 +1,13 @@
+# 2.1.1 - July 23, 2021
+- Remove gamefic/scene/custom autoload
+
+# 2.1.0 - June 21, 2021
+- Remove redundant MultipleChoice prompt
+- Deprecate Scene::Custom
+
+# 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'
@@ -17,5 +16,5 @@ require "gamefic/action"
 require "gamefic/syntax"
 require 'gamefic/world'
 require 'gamefic/scriptable'
-require "gamefic/plot"
+require 'gamefic/plot'
 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

@@ -7,11 +7,15 @@ module Gamefic
   #
   class Element
     include Gamefic::Describable
-    include Gamefic::Index
+    # 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)
+      # 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

data/lib/gamefic/plot.rb

@@ -16,25 +16,22 @@ module Gamefic
     # @return [Hash]
     attr_reader :metadata
 
+    attr_reader :static
+
     include World
     include Scriptable
     # @!parse extend Scriptable::ClassMethods
     include Snapshot
     include Host
+    include Serialize
+
+    exclude_from_serial [:@static]
 
-    # @param structure [Gamefic::Structure]
     # @param metadata [Hash]
     def initialize metadata: {}
-      Gamefic::Index.clear
       @metadata = metadata
       run_scripts
-      mark_static_entities
-      Gamefic::Index.stick
-    end
-
-    def player_class cls = nil
-      @player_class = cls unless cls.nil?
-      @player_class ||= Gamefic::Actor
+      @static = [self] + scene_classes + entities
     end
 
     # Get an Array of the Plot's current Syntaxes.
@@ -59,7 +56,8 @@ module Gamefic
           .merge({
             messages: p.messages,
             last_prompt: p.last_prompt,
-            last_input: p.last_input
+            last_input: p.last_input,
+            queue: p.queue
           })
           .merge(p.state)
         )
@@ -89,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/plot/darkroom.rb

@@ -13,14 +13,21 @@ module Gamefic
       # Create a snapshot of the plot.
       #
       # @return [Hash]
-      def save reduce: false
-        result = {
-          'elements' => Gamefic::Index.serials,
-          'entities' => plot.entities.map(&:to_serial),
-          'players' => plot.players.map(&:to_serial),
-          'theater_instance_variables' => plot.theater.serialize_instance_variables,
-          'subplots' => plot.subplots.reject(&:concluded?).map { |s| serialize_subplot(s) },
-          'metadata' => plot.metadata
+      def save
+        index = plot.static + plot.players
+        plot.to_serial(index)
+        {
+          'program' => {}, # @todo Metadata for version control, etc.
+          'index' => index.map do |i|
+            if i.is_a?(Gamefic::Serialize)
+              {
+                'class' => i.class.to_s,
+                'ivars' => i.serialize_instance_variables(index)
+              }
+            else
+              i.to_serial(index)
+            end
+          end
         }
       end
 
@@ -28,64 +35,45 @@ module Gamefic
       #
       # @param snapshot [Hash]
       def restore snapshot
-        Gamefic::Index.elements.map(&:destroy)
-        Gamefic::Index.unserialize snapshot['elements']
-        plot.entities.clear
-        snapshot['entities'].each do |ser|
-          plot.entities.push Index.from_serial(ser)
-        end
+        # @todo Use `program` for verification
 
-        snapshot['theater_instance_variables'].each_pair do |k, s|
-          v = Gamefic::Index.from_serial(s)
-          next if v == "#<UNKNOWN>"
-          plot.theater.instance_variable_set(k, v)
-        end
+        plot.subplots.each(&:conclude)
+        plot.subplots.clear
 
-        snapshot['subplots'].each { |s| unserialize_subplot(s) }
-      end
-
-      private
-
-      def namespace_to_constant string
-        space = Object
-        string.split('::').each do |part|
-          space = space.const_get(part)
+        index = plot.static + plot.players
+        snapshot['index'].each_with_index do |obj, idx|
+          next if index[idx]
+          elematch = obj['class'].match(/^#<ELE_([\d]+)>$/)
+          if elematch
+            klass = index[elematch[1].to_i]
+          else
+            klass = Gamefic::Serialize.string_to_constant(obj['class'])
+          end
+          index.push klass.allocate
         end
-        space
-      end
 
-      def serialize_subplot s
-        {
-          'class' => s.class.to_s,
-          'entities' => s.entities.map(&:to_serial),
-          'instance_variables' => s.serialize_instance_variables,
-          'theater_instance_variables' => s.theater.serialize_instance_variables
-        }
-      end
-
-      def unserialize_subplot s
-        cls = namespace_to_constant(s['class'])
-        sp = cls.allocate
-        sp.instance_variable_set(:@plot, plot)
-        s['entities'].each do |e|
-          sp.entities.push Gamefic::Index.from_serial(e)
-        end
-        s['instance_variables'].each_pair do |k, v|
-          next if v == "#<UNKNOWN>"
-          sp.instance_variable_set(k, Gamefic::Index.from_serial(v))
-        end
-        s['theater_instance_variables'].each_pair do |k, v|
-          next if v == "#<UNKNOWN>"
-          sp.theater.instance_variable_set(k, Gamefic::Index.from_serial(v))
-        end
-        plot.subplots.push sp
-        sp.send(:run_scripts)
-        # @todo Assuming one player
-        if plot.players.first
-          sp.players.push plot.players.first
-          plot.players.first.playbooks.push sp.playbook unless plot.players.first.playbooks.include?(sp.playbook)
+        snapshot['index'].each_with_index do |obj, idx|
+          if index[idx].class.to_s != obj['class']
+            STDERR.puts "MISMATCH: #{index[idx].class} is not #{obj['class']}"
+            STDERR.puts obj.inspect
+          end
+          obj['ivars'].each_pair do |k, v|
+            next if k == '@subplots'
+            uns = v.from_serial(index)
+            next if uns == "#<UNKNOWN>"
+            index[idx].instance_variable_set(k, uns)
+          end
+          if index[idx].is_a?(Gamefic::Subplot)
+            index[idx].extend Gamefic::Scriptable
+            index[idx].instance_variable_set(:@theater, nil)
+            index[idx].send(:run_scripts)
+            index[idx].players.each do |pl|
+              pl.playbooks.push index[idx].playbook unless pl.playbooks.include?(index[idx].playbook)
+            end
+            index[idx].instance_variable_set(:@static, [index[idx]] + index[idx].scene_classes + index[idx].entities)
+            plot.subplots.push index[idx]
+          end
         end
-        sp
       end
     end
   end