gamefic 4.1.0 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5aaa5c2e7e709434b596c7bd216138ccc693d3893c56ed87ee54640e545d729
-  data.tar.gz: a7f12b8da551d9f97b279e6050333561e5d348940681cab7cf894f97a9eca085
+  metadata.gz: e90aabf8b81551f127b57f7a70f62aa0cc92c0bc8e346ffe5056260678b0ae86
+  data.tar.gz: 7607b66f7927acd8310ba3a0be94834102c8fcf1d7458c3bbd950de44cabd9b0
 SHA512:
-  metadata.gz: b15fe4c2f586a9164a3166273c15638e548fbcf78d3f3e5bef41f55a8c054c06f1d5a16c62cbb13a252e635e0416c5fcb6da1f8574a1ac3323bb117d76f78fea
-  data.tar.gz: d26cb35d5a6fcae8f4c3511e2b22339491b5773d2288914c1125eeb38da4db51440e5780c28b1b4aec0344bb819f4abb97323d9ef5bcf21404667edf28705fe7
+  metadata.gz: c84cc7bf2a99438d3b61a11197b43c51d3577413f0249ad44360bb7b97520b3c1fec48e39f833c0bd999ae5de3a1b934e2d4b17983544840bccb861504207eca
+  data.tar.gz: 3c512256a34fa09048e79216a1defdc8fa076d89d2bb4549b1bbe35fbaae5c272eb156b84d5daa7f310a800d64217c49cb74c351115e7de8cd8ca25fd57382d5

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/.yardopts

@@ -0,0 +1 @@
+--plugin yard-solargraph

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 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
+
 ## 4.1.0 - February 1, 2025
 - Correct Scenes#pause block
 

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,9 @@ 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'
   s.add_development_dependency 'opal-rspec', '~> 1.0'
   s.add_development_dependency 'opal-sprockets', '~> 1.0'

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/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/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/plot.rb

@@ -41,6 +41,8 @@ module Gamefic
     end
 
     def self.append(chapter, **config)
+      Gamefic.logger.warn "Overwriting existing chapter #{chapter}" if appended_chapter_map.key?(chapter)
+
       appended_chapter_map[chapter] = config
     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
@@ -95,16 +95,18 @@ module Gamefic
           @finish_blocks ||= []
         end
 
-        # @yieldparam [Actor] The scene's actor
-        # @yieldparam [Props::Default] The scene's props
-        # @yieldparam [Hash] Additional context
+        # @yieldparam actor [Actor] The scene's actor
+        # @yieldparam props [Props::Default] The scene's props
+        # @yieldparam context [Hash] Additional context
+        # @yieldreceiver [Narrative]
         def on_start(&block)
           start_blocks.push block
         end
 
-        # @yieldparam [Actor] The scene's actor
-        # @yieldparam [Props::Default] The scene's props
-        # @yieldparam [Hash] Additional context
+        # @yieldparam actor [Actor] The scene's actor
+        # @yieldparam props [Props::Default] The scene's props
+        # @yieldparam context [Hash] Additional context
+        # @yieldreceiver [Narrative]
         def on_finish(&block)
           finish_blocks.push block
         end

data/lib/gamefic/scriptable/hooks.rb

@@ -26,7 +26,7 @@ module Gamefic
       # @param verbs [Array<Symbol>]
       # @yieldparam [Actor]
       # @yieldparam [Command]
-      # @yieldself [Object<self>]
+      # @yieldreceiver [Object<self>]
       def before_command(*verbs, &block)
         before_commands.push(proc do |actor, command|
           instance_exec(actor, command, &block) if verbs.empty? || verbs.include?(command.verb)
@@ -43,7 +43,7 @@ module Gamefic
       # @param verbs [Array<Symbol>]
       # @yieldparam [Actor]
       # @yieldparam [Command]
-      # @yieldself [Object<self>]
+      # @yieldreceiver [Object<self>]
       def after_command(*verbs, &block)
         after_commands.push(proc do |actor, command|
           instance_exec(actor, command, &block) if verbs.empty? || verbs.include?(command.verb)
@@ -52,7 +52,7 @@ module Gamefic
 
       # Define a callback to be executed after a scene starts.
       #
-      # @yieldself [Object<self>]
+      # @yieldreceiver [Object<self>]
       def on_ready(&block)
         ready_blocks.push block
       end
@@ -61,14 +61,14 @@ module Gamefic
       # a scene starts.
       #
       # @yieldparam [Actor]
-      # @yieldself [Object<self>]
+      # @yieldreceiver [Object<self>]
       def on_player_ready(&block)
         ready_blocks.push(proc { players.each { |player| instance_exec(player, &block) } })
       end
 
       # Define a callback to be executed after a scene finishes.
       #
-      # @yieldself [Object<self>]
+      # @yieldreceiver [Object<self>]
       def on_update(&block)
         update_blocks.push block
       end
@@ -77,7 +77,7 @@ module Gamefic
       # a scene finishes.
       #
       # @yieldparam [Actor]
-      # @yieldself [Object<self>]
+      # @yieldreceiver [Object<self>]
       def on_player_update(&block)
         update_blocks.push(proc { players.each { |player| instance_exec(player, &block) } })
       end
@@ -97,7 +97,7 @@ module Gamefic
       #
       # @yieldparam [Actor]
       # @yieldparam [Props::Output]
-      # @yieldself [Object<self>]
+      # @yieldreceiver [Object<self>]
       def on_player_output(&block)
         player_output_blocks.push(block)
       end
@@ -105,7 +105,7 @@ module Gamefic
       # Define a callback that gets executed when a narrative reaches a
       # conclusion.
       #
-      # @yieldself [Object<self>]
+      # @yieldreceiver [Object<self>]
       def on_conclude(&block)
         conclude_blocks.push(block)
       end
@@ -117,7 +117,7 @@ module Gamefic
       #   narrative itself concluding.
       #
       # @yieldparam [Actor]
-      # @yieldself [Object<self>]
+      # @yieldreceiver [Object<self>]
       def on_player_conclude(&block)
         player_conclude_blocks.push(block)
       end

data/lib/gamefic/scriptable/responses.rb

@@ -27,7 +27,7 @@ module Gamefic
       # @param verb [Symbol, String, nil] An imperative verb for the command
       # @param args [Array<Object>] Filters for the command's tokens
       # @yieldparam [Gamefic::Actor]
-      # @yieldself [Object<self>]
+      # @yieldreceiver [Object<self>]
       # @return [Response]
       def respond verb, *args, &proc
         response = Response.new(verb&.to_sym, *args, &proc)
@@ -41,7 +41,7 @@ module Gamefic
       # @param verb [Symbol, String, nil] An imperative verb for the command
       # @param args [Array<Object>] Filters for the command's tokens
       # @yieldparam [Gamefic::Actor]
-      # @yieldself [Object<self>]
+      # @yieldreceiver [Object<self>]
       # @return [Response]
       def meta verb, *args, &proc
         response = Response.new(verb&.to_sym, *args, meta: true, &proc)

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
@@ -44,6 +46,7 @@ module Gamefic
       end
       alias scene block
 
+      # @return [Array<Proc>]
       def introductions
         @introductions ||= []
       end
@@ -60,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
@@ -84,9 +88,10 @@ module Gamefic
       #   end
       #
       # @param name [Symbol, nil]
+      # @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.
@@ -111,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.
@@ -119,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.
@@ -129,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
@@ -148,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

@@ -18,7 +18,7 @@ module Gamefic
       # @param translation [String] The format of the translated command
       # @return [Syntax] the Syntax object
       def interpret command, translation
-        syntaxes.push Syntax.new(command, translation)
+        syntaxes.push(Syntax.new(command, translation)).last
       end
 
       def syntaxes

data/lib/gamefic/scripting/seeds.rb

@@ -3,7 +3,7 @@ module Gamefic
     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/version.rb

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

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.2
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-01 00:00:00.000000000 Z
+date: 2025-05-25 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
+    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: opal
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +140,7 @@ files:
 - ".rspec-opal"
 - ".rubocop.yml"
 - ".solargraph.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -226,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Gamefic