gamefic 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac4f50caef9bd101bf90447e3ab289b05a29470e8f722ad391f7f0c9d8c4a921
-  data.tar.gz: 926b7d40dc87036e3759a1a464d3db3c82187da4f829731d0d82b053ac5e52a4
+  metadata.gz: 85e6fc4d2b5c4a9abfe20cbbe17affdec1f1badb134e8cad88849a5305fb9bf0
+  data.tar.gz: 97a29823857d93fafa9e8a3bc4872e27a4a6da480f589535da6abf254eb5aa7a
 SHA512:
-  metadata.gz: 6a4b426b4703a29717dbcc59bfee2e3f5d3b1b2ceeb6121741f52111e5fe2d8165e0946f8c3a085f1a3c4094edab11e2966f751dbc3cfc1541809ebc3a9ad970
-  data.tar.gz: ba3f3e82bd772ae392ffb23b056b62de2c1b5bebb0e810fea81bd59449d3e64c8c848f748803ac36f155ad3a2891b0e42d76ca48e4e74239a776670f19fdcc0e
+  metadata.gz: 611c3b366e76a29cd2ffb95f906882a63ac9d73bfb6d1d7aaa505e4470f4526311704c2245285f908247b6248b086914d8a145e1c9b86577e197d8d77c707939
+  data.tar.gz: dc19cf51ab4edbc1b9f9708eb543c977527e3165a949d948782349e545d0a32fde42f8532c9071e0ddc86b521cc0d1cb778e8e88b1d7b0dcc575d547c5db1df1

data/.github/workflows/rspec.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1']
+        ruby-version: ['2.7', '3.0', '3.1', '3.3']
 
     steps:
     - uses: actions/checkout@v3

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 3.3.0 - September 1, 2024
+- Node#take
+- Node#include?
+- Reject non-string tokens in Text queries
+
+## 3.2.2 - July 21, 2024
+- Describable#described?
+
+## 3.2.1 - July 1, 2024
+- MultipleChoice accepts shortened text
+- Return Proxy::Agent from attr_seed and make_seed
+- MultipleChoice skips finish blocks for invalid input
+
 ## 3.2.0 - April 9, 2024
 - Bug fix for marshal of structs in Opal
 - Add last_input and last_prompt at start of take

data/Rakefile

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'opal/rspec/rake_task'
 
@@ -14,7 +13,8 @@ end
 task :default => :spec
 
 Opal::RSpec::RakeTask.new(:opal) do |_, config|
-  Opal.append_path File.expand_path('../lib', __FILE__)
+  Opal.append_path File.join(__dir__, 'lib')
+  config.default_path = 'spec'
   config.pattern = 'spec/**/*_spec.rb'
-  config.requires = ['spec_helper']
+  config.requires = ['opal_helper']
 end

data/lib/gamefic/active/messaging.rb

@@ -6,6 +6,7 @@ module Gamefic
     # a few shortcuts.
     #
     module Messaging
+      # @return [Messenger]
       def messenger
         @messenger ||= Messenger.new
       end

data/lib/gamefic/composer.rb

@@ -43,7 +43,7 @@ module Gamefic
         arguments = []
         response.queries.each_with_index do |query, idx|
           result = Scanner.send(method, query.select(actor), "#{remainder} #{expression.tokens[idx]}".strip)
-          break unless validate_result_from_query(result, query)
+          break unless valid_result_from_query?(result, query)
 
           if query.ambiguous?
             arguments.push result.matched
@@ -60,7 +60,7 @@ module Gamefic
 
       # @param result [Scanner::Result]
       # @param query [Query::Base]
-      def validate_result_from_query result, query
+      def valid_result_from_query? result, query
         return false if result.matched.empty?
 
         result.matched.length == 1 || query.ambiguous?

data/lib/gamefic/describable.rb

@@ -112,10 +112,11 @@ module Gamefic
     # Does the object have a description?
     #
     # @return [Boolean]
-    def description?
+    def described?
       @description.to_s != ''
     end
-    alias has_description? description?
+    alias description? described?
+    alias has_description? described?
 
     # Get the object's description.
     #

data/lib/gamefic/node.rb

@@ -42,6 +42,15 @@ module Gamefic
       parent&.add_child self
     end
 
+    # Add children to the node. Return all the node's children.
+    #
+    # @param children [Array<Node, Array<Node>>]
+    # @return [Array<Node>]
+    def take *children
+      children.flatten.each { |child| child.parent = self }
+      children
+    end
+
     # Determine if external objects can interact with this object's children.
     # For example, a game can designate that the contents of a bowl are
     # accessible, while the contents of a locked safe are not.
@@ -54,10 +63,14 @@ module Gamefic
     # True if this node is the other's parent.
     #
     # @param other [Node]
-    def has?(other)
+    def include?(other)
       other.parent == self
     end
 
+    def adjacent?(other)
+      other.parent == parent
+    end
+
     protected
 
     def add_child(node)

data/lib/gamefic/plot.rb

@@ -9,6 +9,8 @@ module Gamefic
       super
       subplots.each(&:ready)
       players.each(&:start_take)
+      subplots.each(&:conclude) if concluding?
+
       players.select(&:concluding?).each { |plyr| rulebook.run_player_conclude_blocks plyr }
       subplots.delete_if(&:concluding?)
     end

data/lib/gamefic/props/multiple_choice.rb

@@ -58,7 +58,8 @@ module Gamefic
       end
 
       def index_by_text
-        options.find_index { |text| input.downcase == text.downcase }
+        matches = options.map.with_index { |text, idx| next idx if text.downcase.start_with?(input.downcase) }.compact
+        matches.first if matches.one?
       end
     end
   end

data/lib/gamefic/query/base.rb

@@ -24,16 +24,24 @@ module Gamefic
         @ambiguous = ambiguous
       end
 
-      # @deprecated Queries should only be used to select entities that are
-      #   eligible to be response arguments. After a text command is tokenized
-      #   into an array of expressions, the composer builds the command that
-      #   the dispatcher uses to execute actions. The #accept? method verifies
-      #   that the command's arguments match the response's queries.
+      # Get a query result for a given subject and token.
+      #
+      # @note This method is retained as a convenience for authors. Narratives
+      #   should use Composer to build commands, as it provides more precise
+      #   matching of tokens to valid response arguments. Authors can use
+      #   #query to find entities that match a token regardless of whether the
+      #   result matches an available response.
+      #
+      # @example
+      #   respond :reds do |actor|
+      #     reds = available(ambiguous: true).query(actor, 'red').match
+      #     actor.tell "The red things you can see here are #{reds.join_and}."
+      #   end
       #
       # @param subject [Gamefic::Entity]
       # @param token [String]
       # @return [Result]
-      def query(subject, token)
+      def query(_subject, _token)
         raise "#query not implemented for #{self.class}"
       end
 
@@ -42,7 +50,7 @@ module Gamefic
       #
       # @param subject [Entity]
       # @return [Array<Entity>]
-      def select subject
+      def select _subject
         raise "#select not implemented for #{self.class}"
       end
 
@@ -88,12 +96,14 @@ module Gamefic
         depth
       end
 
+      # @param scan [Scanner::Result]
       def ambiguous_result scan
         return Result.new(nil, scan.token) if scan.matched.empty?
 
         Result.new(scan.matched, scan.remainder)
       end
 
+      # @param scan [Scanner::Result]
       def unambiguous_result scan
         return Result.new(nil, scan.token) unless scan.matched.one?
 

data/lib/gamefic/query/scoped.rb

@@ -6,7 +6,6 @@ module Gamefic
     # relationship to the entity performing the query. For example,
     # Scope::Children would filter from an array of the entity's descendants.
     #
-    # @return [Class<Gamefic::Scope::Base>]
     class Scoped < Base
       attr_reader :scope
 

data/lib/gamefic/query/text.rb

@@ -39,6 +39,8 @@ module Gamefic
       private
 
       def match? token
+        return false unless token.is_a?(String)
+
         case @argument
         when Regexp
           token =~ @argument

data/lib/gamefic/scene/default.rb

@@ -53,7 +53,7 @@ module Gamefic
       # @param props [Props::Default]
       # @return [void]
       def finish actor, props
-        props.input = actor.queue.shift
+        props.input = actor.queue.shift&.strip
       end
 
       def run_start_blocks actor, props

data/lib/gamefic/scene/multiple_choice.rb

@@ -20,6 +20,12 @@ module Gamefic
         actor.tell format(props.invalid_message, input: props.input)
         actor.recue
       end
+
+      def run_finish_blocks actor, props
+        return unless props.index
+
+        super
+      end
     end
   end
 end

data/lib/gamefic/scriptable/proxy.rb

@@ -45,6 +45,7 @@ module Gamefic
       #   proxy(:@instance_variable_name)
       #
       # @param symbol [Symbol]
+      # @return [Agent]
       def proxy symbol
         Agent.new(symbol)
       end

data/lib/gamefic/scriptable/scenes.rb

@@ -38,6 +38,12 @@ module Gamefic
       end
       alias scene block
 
+      def preface name, klass = Scene::Activity, &start
+        rulebook.scenes.add klass.new(name, rulebook.narrative, on_start: start)
+        name
+      end
+      alias precursor preface
+
       # Add a block to be executed when a player is added to the game.
       # Each Plot should only have one introduction.
       #
@@ -55,7 +61,7 @@ module Gamefic
         rulebook.scenes
                 .introduction Scene::Default.new nil,
                                                  rulebook.narrative,
-                                                 on_start: proc { |actor, _props| instance_exec(actor, &start) }
+                                                 on_start: proc { |actor, _props| Stage.run(self, actor, &start) }
       end
 
       # Create a multiple-choice scene.

data/lib/gamefic/scriptable.rb

@@ -104,7 +104,7 @@ module Gamefic
     def make_seed klass, **opts
       @count ||= 0
       seed { make(klass, **opts) }
-      @count.tap { @count += 1 }
+      Proxy::Agent.new(@count.tap { @count += 1 })
     end
 
     # Seed an entity with an attribute method.
@@ -124,7 +124,7 @@ module Gamefic
         instance_variable_set("@#{name}", make(klass, **opts))
         self.class.define_method(name) { instance_variable_get("@#{name}") }
       end
-      @count.tap { @count += 1 }
+      Proxy::Agent.new(@count.tap { @count += 1 })
     end
 
     if RUBY_ENGINE == 'opal'

data/lib/gamefic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gamefic
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-09 00:00:00.000000000 Z
+date: 2024-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -195,7 +195,6 @@ files:
 - lib/gamefic/syntax/template.rb
 - lib/gamefic/vault.rb
 - lib/gamefic/version.rb
-- spec-opal/spec_helper.rb
 homepage: https://gamefic.com
 licenses:
 - MIT

data/spec-opal/spec_helper.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'gamefic'
-require 'ostruct'
-
-RSpec.configure do |config|
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  # config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  # Kernel.srand config.seed
-
-  config.after :each do
-    Gamefic::Narrative.blocks.clear
-    Gamefic::Plot.blocks.clear
-    Gamefic::Subplot.blocks.clear
-  end
-end