gamefic 2.0.0 → 2.1.1

data/lib/gamefic/subplot.rb

@@ -4,22 +4,30 @@ module Gamefic
   class Subplot #< Container
     include World
     include Scriptable
+    include Gamefic::Serialize
     # @!parse extend Scriptable::ClassMethods
 
     # @return [Gamefic::Plot]
     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
       @concluded = false
+      @more = more
       configure more
       run_scripts
       playbook.freeze
       self.introduce introduce unless introduce.nil?
+      @static = [self] + scene_classes + entities
+    end
+
+    def static
+      plot.static
     end
 
     def players
@@ -63,6 +71,7 @@ module Gamefic
       # @todo I'm not sure why rejecting nils is necessary here. It's only an
       #   issue in Opal.
       entities.reject(&:nil?).each { |e| destroy e }
+      # plot.static.remove(scene_classes + entities)
     end
 
     def concluded?

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.0'
+  VERSION = '2.1.1'
 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

@@ -43,11 +43,18 @@ module Gamefic
       # @param [Gamefic::Entity] The entity to remove
       def destroy entity
         entity.parent = nil
-        index = entities.index(entity)
-        return if index.nil? || index < static_entity_length - 1
-        entities.delete_at index
+        # index = entities.index(entity)
+        # return if index.nil? || index < static_entity_length - 1
+        # entities.delete_at index
+        # players.delete entity
+        # entity.destroy
+
+        # @todo It might make sense to destroy the entity completely now. It
+        #   will still have a reference in the index, but that shouldn't impact
+        #   the current state of the plot.
+        return if static.include?(entity)
+        entities.delete entity
         players.delete entity
-        entity.destroy
       end
 
       # Pick an entity based on its description.
@@ -86,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

data/lib/gamefic/world/scenes.rb

@@ -35,7 +35,7 @@ module Gamefic
         players.push player
         @introduction.call(player) unless @introduction.nil?
         # @todo Find a better way to persist player characters
-        Gamefic::Index.stick
+        # Gamefic::Index.stick
       end
 
       # Create a multiple-choice scene.
@@ -95,10 +95,10 @@ module Gamefic
       #
       # @param prompt [String]
       # @yieldparam [Gamefic::Actor]
-      # @yieldparam [Gamefic::Scene::Custom]
-      # @return [Class<Gamefic::Scene::Custom>]
+      # @yieldparam [Gamefic::Scene::Base]
+      # @return [Class<Gamefic::Scene::Base>]
       def question prompt = 'What is your answer?', &block
-        s = Scene::Custom.subclass do |actor, scene|
+        s = Scene::Base.subclass do |actor, scene|
           scene.prompt = prompt
           scene.on_finish &block
         end
@@ -144,29 +144,29 @@ module Gamefic
         scene_classes.push s
         s
       end
-      
+
       # Create a custom scene.
       #
       # Custom scenes should always specify the next scene to be cued or
       # prepared. If not, the scene will get repeated on the next turn.
       #
-      # This method creates a Scene::Custom by default. You can customize other
+      # This method creates a Scene::Base by default. You can customize other
       # scene types by specifying the class to create.
       #
       # @example Ask the user for a name
-      #   @scene = custom do |scene|
-      #     data.prompt = "What's your name?"
-      #     scene.on_finish do |actor, data|
-      #       actor.name = data.input
+      #   @scene = custom do |actor, scene|
+      #     scene.prompt = "What's your name?"
+      #     scene.on_finish do
+      #       actor.name = scene.input
       #       actor.tell "Hello, #{actor.name}!"
-      #       actor.cue :active
+      #       actor.cue default_scene
       #     end
       #   end
       #
       # @param cls [Class] The class of scene to be instantiated.
       # @yieldparam [Gamefic::Actor]
-      # @return [Class<Gamefic::Scene::Custom>]
-      def custom cls = Scene::Custom, &block
+      # @return [Class<Gamefic::Scene::Base>]
+      def custom cls = Scene::Base, &block
         s = cls.subclass &block
         scene_classes.push s
         s

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Fred Snyder
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-24 00:00:00.000000000 Z
+date: 2021-07-03 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
@@ -74,6 +74,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".solargraph.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -89,7 +90,6 @@ files:
 - lib/gamefic/describable.rb
 - lib/gamefic/element.rb
 - lib/gamefic/entity.rb
-- lib/gamefic/index.rb
 - lib/gamefic/keywords.rb
 - lib/gamefic/messaging.rb
 - lib/gamefic/node.rb
@@ -108,11 +108,11 @@ 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
 - lib/gamefic/scene/conclusion.rb
-- lib/gamefic/scene/custom.rb
 - lib/gamefic/scene/multiple_choice.rb
 - lib/gamefic/scene/multiple_scene.rb
 - lib/gamefic/scene/pause.rb
@@ -133,7 +133,7 @@ homepage: http://gamefic.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,8 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Gamefic
 test_files: []