gamefic 4.1.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e888ff6feb58de6f23f2727cc23fed710935f1876ea393ee84c19c2252166c8
-  data.tar.gz: 314a944a945ffb5c51cdc37b842452653408c5a902722b91585cb036b82ee8b7
+  metadata.gz: 923f92309b7fcac0e2ed6aa4e691e2feea39521f15f19c7b7a560ddb7583b365
+  data.tar.gz: 858516d0d245300605612517d833e858b84b8a40473f6e9bf7d8670c5589cd77
 SHA512:
-  metadata.gz: aa90ce26213fbeec901719fcb1d099c14f627bb5c1ac94eefaa8c883c06f1d48bf6a269c4f259d67d6b63d35d6855a67cf5e3b0a22f3be23b3dde955afd47a3d
-  data.tar.gz: e237330cd06ca31b3b53ae00b2d774aa9f5b1ab6a307efcc179a07c77928d0e409f3c5237ec94739583c1b835cb8600d81c7c0b2b33ceaa4ced2f3b331f8a081
+  metadata.gz: d3d3aa37745380138eb41ed6bee89231e96b385a1c5b8fffc42eb90bb23e9fdcb5d9ea0466fe7f5e1b2d9d459609ec002c3f80d6d6ab324658cbdea4fce1aee2
+  data.tar.gz: 16a1c623c7fc6173f306f43ca080b668b72fdef3700469a6b421abcf88df04c405137f1458727754fce9706107502d7bc0f1dd4cf6c91115784e14de38a6af5e

data/.github/workflows/rspec.yml

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

data/.rubocop.yml

@@ -1,4 +1,4 @@
-Metrics/LineLength:
+Layout/LineLength:
   Description: 'Limit lines to 80 characters.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits'
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 4.2.0 - November 27, 2025
+- Syntaxes support variable (piped) words
+- Props::MultipleChoice#index_of
+
+## 4.1.2 - May 25, 2025
+- Seed unreferenced entities
+- Ensure seed uniqueness
+- Add base64 dependency
+
 ## 4.1.1 - March 2, 2025
 - Warn for duplicate chapters
 - YARD documentation

data/Rakefile

@@ -15,7 +15,8 @@ task :default => :spec
 
 Opal::RSpec::RakeTask.new(:opal) do |_, config|
   Opal.append_path File.join(__dir__, 'lib')
+  Opal.append_path File.join(__dir__, 'spec', 'fixtures', 'modular')
   config.default_path = 'spec'
   config.pattern = 'spec/**/*_spec.rb'
-  config.requires = ['opal_helper']
+  config.requires = ['opal_helper', 'modular_test_script', 'modular_test_plot']
 end

data/gamefic.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.7.0'
 
+  s.add_runtime_dependency 'base64', '~> 0.1'
   s.add_runtime_dependency 'yard-solargraph', '~> 0.1'
 
   s.add_development_dependency 'opal', '~> 1.7'

data/lib/gamefic/active/narratives.rb

@@ -66,6 +66,8 @@ module Gamefic
         narrative_set.flat_map(&:after_commands)
       end
 
+      # @sg-ignore Type checker has trouble reconciling return type of `Set#each`
+      #   with unresolved `generic<R>` of `Enumerable#each`
       def each(&block)
         narrative_set.each(&block)
       end

data/lib/gamefic/binding.rb

@@ -22,8 +22,10 @@ module Gamefic
       end
     end
 
+    # @return [Narrative]
     attr_reader :narrative
 
+    # @return [Proc]
     attr_reader :code
 
     # @param narrative [Narrative]

data/lib/gamefic/chapter.rb

@@ -44,6 +44,7 @@ module Gamefic
 
     # Subclasses can override this method to handle additional configuration.
     #
+    # @return [void]
     def configure; end
 
     class << self

data/lib/gamefic/describable.rb

@@ -142,10 +142,10 @@ module Gamefic
     #
     # @param text [String]
     def description=(text)
-      @description = (text if text != (format(Describable.default_description, name: definitely, Name: definitely.capitalize_first)))
+      @description = (text if text != format(Describable.default_description, name: definitely, Name: definitely.capitalize_first))
     end
 
-    def synonyms= text
+    def synonyms=(text)
       @synonyms = text
     end
 

data/lib/gamefic/narrative.rb

@@ -62,7 +62,7 @@ module Gamefic
     #
     # In the base Narrative class, this method runs all applicable player
     # conclude blocks and the narrative's own conclude blocks.
-    # 
+    #
     # @return [void]
     def turn
       players.select(&:concluding?).each { |plyr| player_conclude_blocks.each { |blk| blk[plyr] } }
@@ -77,6 +77,7 @@ module Gamefic
     # @param snapshot [String]
     # @return [self]
     def self.restore(snapshot)
+      # @sg-ignore
       Marshal.load(snapshot)
     end
 

data/lib/gamefic/narrator.rb

@@ -14,16 +14,16 @@ module Gamefic
 
     # Cast a player character in the plot.
     #
-    # @param character [Actor]
-    # @return [Actor]
+    # @param character [Actor, Active]
+    # @return [Actor, Active]
     def cast(character = plot.introduce)
       plot.cast character
     end
 
     # Uncast a player character from the plot.
     #
-    # @param character [Actor]
-    # @return [Actor]
+    # @param character [Actor, Active]
+    # @return [Actor, Active]
     def uncast(character)
       plot.uncast character
     end

data/lib/gamefic/order.rb

@@ -20,9 +20,9 @@ module Gamefic
     def to_actions
       Action.sort(
         actor.narratives
-            .responses_for(verb)
-            .map { |response| match_arguments(response) }
-            .compact
+             .responses_for(verb)
+             .map { |response| match_arguments(response) }
+             .compact
       )
     end
 

data/lib/gamefic/props/multiple_choice.rb

@@ -5,9 +5,6 @@ module Gamefic
     # Props for MultipleChoice scenes.
     #
     class MultipleChoice < Default
-      # A message to send the player for an invalid choice. A formatting
-      # token named %<input>s can be used to inject the user input.
-      #
       # @return [String]
       attr_writer :invalid_message
 
@@ -18,6 +15,13 @@ module Gamefic
         @options ||= []
       end
 
+      # A message to send the player for an invalid choice. A formatting
+      # token named `%<input>s` can be used to inject the user input.
+      #
+      # @example
+      #   props.invalid_message = '"%<input>s" is not a valid choice.'
+      #
+      # @return [String]
       def invalid_message
         @invalid_message ||= '"%<input>s" is not a valid choice.'
       end
@@ -28,7 +32,7 @@ module Gamefic
       def index
         return nil unless input
 
-        @index ||= index_by_number || index_by_text
+        @index ||= index_of(input)
       end
 
       # The one-based index of the selected option.
@@ -53,15 +57,36 @@ module Gamefic
         !!index
       end
 
+      # Get the index of an option using input criteria, e.g., a one-based
+      # number or the text of the option. The return value is the option's
+      # zero-based index or nil.
+      #
+      # @example
+      #   props = Gamefic::Props::MultipleChoice.new
+      #   props.options.push 'First choice', 'Second choice'
+      #
+      #   props.index_of(1)               # => 0
+      #   props.index_of('Second choice') # => 1
+      #
+      # @param option [String, Integer]
+      # @return [Integer, nil]
+      def index_of(option)
+        index_by_number(option) || index_by_text(option)
+      end
+
       private
 
-      def index_by_number
-        return input.to_i - 1 if input.match(/^\d+$/) && options[input.to_i - 1]
+      # @param [String, Integer]
+      # @return [Integer, nil]
+      def index_by_number(input)
+        return input.to_i - 1 if input.to_s.match(/^\d+$/) && options[input.to_i - 1]
 
         nil
       end
 
-      def index_by_text
+      # @param [String]
+      # @return [Integer, nil]
+      def index_by_text(input)
         options.find_index { |opt| opt.casecmp?(input) }
       end
     end

data/lib/gamefic/props/multiple_partial.rb

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

data/lib/gamefic/query/base.rb

@@ -77,7 +77,7 @@ module Gamefic
       # gets sorted in descending order of their responses' overall precision,
       # so the action with the highest precision gets attempted first.
       #
-      # @return [Integer]
+      # @return [::Integer]
       def precision
         @precision ||= calculate_precision
       end

data/lib/gamefic/scanner.rb

@@ -18,7 +18,7 @@ module Gamefic
     # @param selection [Array<Entity>]
     # @param token [String]
     # @param use [Array<Class<Scanner::Base>>]
-    # @return [Result]
+    # @return [Result, nil]
     def self.scan(selection, token, use = processors)
       result = nil
       use.each do |processor|

data/lib/gamefic/scene/base.rb

@@ -12,8 +12,8 @@ module Gamefic
       attr_reader :actor, :narrative, :props, :context
 
       # @param actor [Actor]
-      # @param narrative [Narrative]
-      # @param props [Props::Default]
+      # @param narrative [Narrative, nil]
+      # @param props [Props::Default, nil]
       def initialize(actor, narrative = nil, props = nil, **context)
         @actor = actor
         @narrative = narrative

data/lib/gamefic/scriptable/scenes.rb

@@ -11,11 +11,13 @@ module Gamefic
       # @return [Scene::Conclusion]
       attr_reader :default_conclusion
 
+      # @param [Scene::Base]
       def select_default_scene(klass)
         scene_classes.add klass
         @default_scene = klass
       end
 
+      # @param [Scene::Conclusion]
       def select_default_conclusion(klass)
         scene_classes.add klass
         @default_conclusion = klass
@@ -61,7 +63,8 @@ module Gamefic
       #
       # @yieldparam [Gamefic::Actor]
       # @yieldparam [Props::Default]
-      # @return [Symbol]
+      # @yieldreceiver [Object<self>]
+      # @return [void]
       def introduction(&start)
         introductions.push start
       end
@@ -88,7 +91,7 @@ module Gamefic
       # @yieldreceiver [Class<Scene::MultipleChoice>]
       # @return [Class<Scene::MultipleChoice>]
       def multiple_choice(name = nil, &block)
-        block Class.new(Scene::MultipleChoice, &block), name
+        self.block Class.new(Scene::MultipleChoice, &block), name
       end
 
       # Create a yes-or-no scene.
@@ -113,7 +116,7 @@ module Gamefic
       # @param name [Symbol, nil]
       # @return [Class<Scene::YesOrNo>]
       def yes_or_no(name = nil, &block)
-        block Class.new(Scene::YesOrNo, &block), name
+        self.block Class.new(Scene::YesOrNo, &block), name
       end
 
       # Create an active choice scene.
@@ -121,7 +124,7 @@ module Gamefic
       # @param name [Symbol, nil]
       # @return [Class<Scene::ActiveChoice>]
       def active_choice(name = nil, &block)
-        block Class.new(Scene::ActiveChoice, &block), name
+        self.block Class.new(Scene::ActiveChoice, &block), name
       end
 
       # Create a pause.
@@ -131,9 +134,10 @@ module Gamefic
       # @param name [Symbol, nil]
       # @yieldparam [Actor]
       # @yieldparam [Props::Default]
+      # @yieldreceiver [Object<self>]
       # @return [Class<Scene::Pause>]
       def pause(name = nil, &block)
-        block(Class.new(Scene::Pause) do
+        self.block(Class.new(Scene::Pause) do
           on_start(&block)
         end, name)
       end
@@ -150,9 +154,10 @@ module Gamefic
       # @param name [Symbol, nil]
       # @yieldparam [Actor]
       # @yieldparam [Props::Default]
+      # @yieldreceiver [Object<self>]
       # @return [Class<Scene::Conclusion>]
       def conclusion(name = nil, &block)
-        block(Class.new(Scene::Conclusion) do
+        self.block(Class.new(Scene::Conclusion) do
           on_start(&block)
         end, name)
       end

data/lib/gamefic/scriptable/seeds.rb

@@ -62,7 +62,7 @@ module Gamefic
     #   pick('the red box')
     #
     # @param args [Array]
-    # @return [Proxy]
+    # @return [Proxy::Pick]
     def pick *args
       Proxy::Pick.new(*args)
     end

data/lib/gamefic/scriptable/syntaxes.rb

@@ -17,8 +17,15 @@ module Gamefic
       # @param command [String] The format of the original command
       # @param translation [String] The format of the translated command
       # @return [Syntax] the Syntax object
-      def interpret command, translation
-        syntaxes.push Syntax.new(command, translation)
+      def interpret(command, translation)
+        parts = Syntax.split(command)
+        additions = if parts.first.include?('|')
+                      parts.first.split('|').map { |verb| Syntax.new("#{verb} #{verb[1..].join(' ')}", translation) }
+                    else
+                      [Syntax.new(command, translation)]
+                    end
+        syntaxes.concat additions
+        additions
       end
 
       def syntaxes

data/lib/gamefic/scripting/hooks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gamefic
   module Scripting
     # Scripting hook methods are instance methods that return callbacks for

data/lib/gamefic/scripting/responses.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gamefic
   module Scripting
     module Responses

data/lib/gamefic/scripting/scenes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gamefic
   module Scripting
     module Scenes

data/lib/gamefic/scripting/seeds.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Gamefic
   module Scripting
     module Seeds
       # @return [Array<Proc>]
       def seeds
-        self.class.seeds
+        (included_scripts.flat_map(&:seeds) + self.class.seeds).uniq
       end
     end
   end

data/lib/gamefic/scripting/syntaxes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gamefic
   module Scripting
     module Syntaxes

data/lib/gamefic/scripting.rb

@@ -35,7 +35,7 @@ module Gamefic
                       .map { |blk| Binding.new(self, blk) }
     end
 
-    def self.included other
+    def self.included(other)
       super
       other.extend Scriptable
     end

data/lib/gamefic/syntax.rb

@@ -82,9 +82,10 @@ module Gamefic
     #
     # @param text [String]
     # @return [Boolean]
-    def accept?(text)
+    def match?(text)
       !!text.match(regexp)
     end
+    alias accept? match?
 
     # Get a signature that identifies the form of the Syntax.
     # Signatures are used to compare Syntaxes to each other.
@@ -118,6 +119,48 @@ module Gamefic
       string.start_with?(':') ? nil : string.to_sym
     end
 
+    # Split a syntax template by words and expressions.
+    #
+    # @param template [String]
+    # @return [Array<String>]
+    def self.split(template)
+      parens = 0
+      result = template.normalize.chars.each.with_object(['']) do |char, result|
+        parens = parse_token(char, parens, result)
+      end
+      raise "Unbalanced parentheses in syntax '#{template}'" unless parens.zero?
+
+      result.pop if result.last.empty?
+
+      result
+    end
+
+    class << self
+      private
+
+      # @param char [String]
+      # @param parens [Integer]
+      # @param result [Array<String>]
+      def parse_token(char, parens, result)
+        case char
+        when /[()]/
+          parens += (char == '(' ? 1 : -1)
+        when /\s/
+          return parens if result.last.empty?
+
+          if parens.positive?
+            result.push(result.pop + char)
+          else
+            result.push ''
+          end
+        else
+          result.push(result.pop + char)
+        end
+
+        parens
+      end
+    end
+
     private
 
     # @return [String]
@@ -142,9 +185,9 @@ module Gamefic
 
     # @return [Array<String>]
     def make_tokens
-      template.keywords.map.with_index do |word, idx|
+      Syntax.split(template).map.with_index do |word, idx|
+        next "(?:\\b#{word.gsub('|', '|\\b')})" if word.include?('|')
         next word unless word.match?(PARAM_REGEXP)
-
         next nil if idx.positive? && template.keywords[idx - 1].match?(PARAM_REGEXP)
 
         '([\w\W\s\S]*?)'

data/lib/gamefic/version.rb

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

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Fred Snyder
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-02 00:00:00.000000000 Z
+date: 2025-11-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: yard-solargraph
   requirement: !ruby/object:Gem::Requirement
@@ -226,7 +239,6 @@ homepage: https://gamefic.com
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -241,8 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Gamefic
 test_files: []