gamefic 2.0.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ac3f26cc5dcb62f6b4af8f0a365a316a4324605efecac8fd852f9980f00e336
-  data.tar.gz: 11348faf9a1c471c11ca4da93f419167db25a92ec7617fd73fb592fdf0ec7d7f
+  metadata.gz: 361eaf767babb3c8b5d7e47616d326a85e1b42269da33c518de33f16f9568451
+  data.tar.gz: 96f4d79e833f93c41714c5781cf863d7e0b8832e90c746f6bafe6164e10095b5
 SHA512:
-  metadata.gz: 1bd78b541afec9fd2129d785442ddc811dacbc42c41f9c683329776f90ada2e105578324ef73fa7dedd7fc26ed828917f1a796765f0f1b74ade334b54c94d5ab
-  data.tar.gz: d3a982efcb6bdd0c306ebdab70ee722fcd1040d6cf51501b738b8bca65e955689dcfe2d77aa5e8684e1f0e18d27b71579410f51a6189d23014da47156bbbe3cf
+  metadata.gz: b9ad845f6f0271da17b64268b911f5d3fe40fbfd7fd563b411f6ef02e15b8a117abcd924d3586072040f428aafc0a92827458639f9f2c0ba9fa4883af7f33e05
+  data.tar.gz: 6f65996ac0ee16805763dd25fa89b1809a89acd0e44cb5d55f83ce22636aeadb6e43b733a15d44e6a397a636d5abde899c332d3601af60bcc4322a0c0ad1fb72

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

@@ -1,2 +1,16 @@
-# 2.0.2 - April 25, 2020
+## 2.2.0 - September 4, 2021
+- Dynamically inherit default attributes
+
+## 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/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
@@ -127,23 +123,28 @@ module Gamefic
 
       def valid? actor, objects
         return false if objects.length != queries.length
-        i = 0
-        queries.each { |p|
+        queries.each_with_index do |p, i|
           return false unless p.include?(actor, objects[i])
-          i += 1
-        }
+        end
         true
       end
 
-      def attempt actor, tokens
-        i = 0
+      # 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 command [Command]
+      # @return [self, nil]
+      def attempt actor, command
+        return nil if command.verb != verb
+        tokens = command.arguments
         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

@@ -6,12 +6,6 @@ module Gamefic
   # subclass that includes this module.
   #
   module Active
-    # The last action executed by the entity, as reported by the
-    # Active#performed method.
-    #
-    # @return [Gamefic::Action]
-    attr_reader :last_action
-
     # The scene in which the entity is currently participating.
     #
     # @return [Gamefic::Scene::Base]
@@ -104,22 +98,32 @@ module Gamefic
     # @example Send a command as a verb with parameters
     #   character.perform :take, @key
     #
+    # @todo Modify this method so it only accepts a single command.
+    #   Verbs with parameters should use Active#execute instead.
+    #   It might be necessary to support command splats with a deprecation
+    #   warning until version 3.
+    #
     # @return [Gamefic::Action]
     def perform(*command)
-      actions = []
-      playbooks.reverse.each { |p| actions.concat p.dispatch(self, *command) }
-      execute_stack actions
+      if command.length > 1
+        execute command.first, *command[1..-1]
+      else
+        dispatchers.push Dispatcher.dispatch(self, command.first.to_s)
+        proceed
+        dispatchers.pop
+      end
     end
 
     # Quietly perform a command.
     # This method executes the command exactly as #perform does, except it
     # buffers the resulting output instead of sending it to the user.
     #
+    # @todo Modify this method so it only accepts a single command.
+    #   See Active#perform for more information.
+    #
     # @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
@@ -139,9 +143,9 @@ module Gamefic
     #
     # @return [Gamefic::Action]
     def execute(verb, *params, quietly: false)
-      actions = []
-      playbooks.reverse.each { |p| actions.concat p.dispatch_from_params(self, verb, params) }
-      execute_stack actions, quietly: quietly
+      dispatchers.push Dispatcher.dispatch_from_params(self, verb, params)
+      proceed quietly: quietly
+      dispatchers.pop
     end
 
     # Proceed to the next Action in the current stack.
@@ -152,10 +156,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]
@@ -166,20 +172,19 @@ module Gamefic
     #   end
     #
     def proceed quietly: false
-      return if performance_stack.empty?
-      a = performance_stack.last.shift
-      unless a.nil?
-        if quietly
-          if buffer_stack == 0
-            @buffer = ""
-          end
-          set_buffer_stack(buffer_stack + 1)
-        end
-        a.execute
-        if quietly
-          set_buffer_stack(buffer_stack - 1)
-          @buffer
+      return if dispatchers.empty?
+      a = dispatchers.last.next
+      return if a.nil?
+      if quietly
+        if buffer_stack == 0
+          @buffer = ""
         end
+        set_buffer_stack(buffer_stack + 1)
+      end
+      a.execute
+      if quietly
+        set_buffer_stack(buffer_stack - 1)
+        @buffer
       end
     end
 
@@ -187,13 +192,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 +208,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 +226,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.
@@ -231,14 +240,6 @@ module Gamefic
       !scene.nil? && scene.kind_of?(Scene::Conclusion)
     end
 
-    # Record the last action the entity executed. This method is typically
-    # called when the entity performs an action in response to user input.
-    #
-    def performed action
-      action.freeze
-      @last_action = action
-    end
-
     def accessible?
       false
     end
@@ -266,35 +267,7 @@ module Gamefic
 
     # @return [Array<Gamefic::Scene::Base>]
     def entered_scenes
-      @entered_scenes ||= []    
-    end
-
-    def execute_stack actions, quietly: false
-      return nil if actions.empty?
-      a = actions.first
-      okay = true
-      unless a.meta?
-        playbooks.reverse.each do |playbook|
-          okay = validate_playbook playbook, a
-          break unless okay
-        end
-      end
-      if okay
-        performance_stack.push actions
-        proceed quietly: quietly
-        performance_stack.pop
-      end
-      a
-    end
-
-    def validate_playbook playbook, action
-      okay = true
-      playbook.validators.each { |v|
-        result = v.call(self, action.verb, action.parameters)
-        okay = (result != false)
-        break unless okay
-      }
-      okay
+      @entered_scenes ||= []
     end
 
     def buffer_stack
@@ -318,8 +291,8 @@ module Gamefic
       @buffer = ''
     end
 
-    def performance_stack
-      @performance_stack ||= []
+    def dispatchers
+      @dispatchers ||= []
     end
   end
 end

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
@@ -61,7 +64,7 @@ class Array
     join_and(sep, orSep, serial)
   end
 
-  # private
+  private
 
   def _keep(arr, cls, bool)
     if (cls.kind_of?(Class) or cls.kind_of?(Module))

data/lib/gamefic/core_ext/string.rb

@@ -6,15 +6,9 @@ class String
   #
   # @return [String] The capitalized text
   def capitalize_first
-    "#{self[0,1].upcase}#{self[1,self.length]}"
-  end
-
-  # An alias for #capitalize_first.
-  #
-  # @return [String]
-  def cap_first
-    self.capitalize_first
+    "#{self[0, 1].upcase}#{self[1, self.length]}"
   end
+  alias cap_first capitalize_first
 
   # Get an array of words split by any whitespace.
   #

data/lib/gamefic/dispatcher.rb

@@ -0,0 +1,76 @@
+module Gamefic
+  # The action selector for character commands.
+  #
+  class Dispatcher
+    # @param actor [Actor]
+    # @param commands [Array<Command>]
+    # @param actions [Array<Action>]
+    def initialize actor, commands = [], actions = []
+      @actor = actor
+      @commands = commands
+      @actions = actions
+    end
+
+    def merge dispatcher
+      commands.concat dispatcher.commands
+      actions.concat dispatcher.actions
+    end
+
+    def next
+      instance = nil
+      while instance.nil? && !@actions.empty?
+        action = actions.shift
+        commands.each do |cmd|
+          instance = action.attempt(actor, cmd)
+          if instance
+            unless instance.meta?
+              actor.playbooks.reverse.each do |playbook|
+                return nil unless validate_playbook(playbook, instance)
+              end
+            end
+            break
+          end
+        end
+      end
+      instance
+    end
+
+    # @param actor [Active]
+    # @param command [String]
+    # @return [Dispatcher]
+    def self.dispatch actor, command
+      group = actor.playbooks.reverse.map { |p| p.dispatch(actor, command) }
+      dispatcher = Dispatcher.new(actor)
+      group.each { |d| dispatcher.merge d }
+      dispatcher
+    end
+
+    # @param actor [Active]
+    # @param verb [Symbol]
+    # @param params [Array<Object>]
+    # @return [Dispatcher]
+    def self.dispatch_from_params actor, verb, params
+      group = actor.playbooks.reverse.map { |p| p.dispatch_from_params(actor, verb, params) }
+      dispatcher = Dispatcher.new(actor)
+      group.each { |d| dispatcher.merge d }
+      dispatcher
+    end
+
+    protected
+
+    # @return [Actor]
+    attr_reader :actor
+
+    # @return [Array<Command>]
+    attr_reader :commands
+
+    # @return [Array<Action>]
+    attr_reader :actions
+
+    private
+
+    def validate_playbook playbook, action
+      playbook.validators.all? { |v| v.call(actor, action.verb, action.parameters) != false }
+    end
+  end
+end