gamefic 4.0.1 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc53c7427d9e153ee3a41dfe297cf2c038733024a8d79c6feec8e648f6efd83a
-  data.tar.gz: 88be2b8ba3d282e762692f39ce63fde315609d0b2f9a766f0a99ede59554ba30
+  metadata.gz: 0e888ff6feb58de6f23f2727cc23fed710935f1876ea393ee84c19c2252166c8
+  data.tar.gz: 314a944a945ffb5c51cdc37b842452653408c5a902722b91585cb036b82ee8b7
 SHA512:
-  metadata.gz: d97432e274e89b7202df2c5f1bebae60450db5c71813cf8f7c711997920fa1e41ca2a63e22bdb29b2e77b29b37174858e61e145004440b1dfa0c96403cd5d6b4
-  data.tar.gz: 89023cc5765cabb26c86848ae73fd2871b22015aaeeadd48307ddbea004cb1ecb9a857d3e870b63497fc19405d7e07848643ede4bd80bf90336057ba2d9d49be
+  metadata.gz: aa90ce26213fbeec901719fcb1d099c14f627bb5c1ac94eefaa8c883c06f1d48bf6a269c4f259d67d6b63d35d6855a67cf5e3b0a22f3be23b3dde955afd47a3d
+  data.tar.gz: e237330cd06ca31b3b53ae00b2d774aa9f5b1ab6a307efcc179a07c77928d0e409f3c5237ec94739583c1b835cb8600d81c7c0b2b33ceaa4ced2f3b331f8a081

data/.yardopts

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

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 4.1.1 - March 2, 2025
+- Warn for duplicate chapters
+- YARD documentation
+
+## 4.1.0 - February 1, 2025
+- Correct Scenes#pause block
+
 ## 4.0.1 - January 26, 2025
 - Cue#prepare flushes messages
 

data/gamefic.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.7.0'
 
+  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/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/scene/base.rb

@@ -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

@@ -44,6 +44,7 @@ module Gamefic
       end
       alias scene block
 
+      # @return [Array<Proc>]
       def introductions
         @introductions ||= []
       end
@@ -84,6 +85,7 @@ 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
@@ -114,16 +116,26 @@ module Gamefic
         block Class.new(Scene::YesOrNo, &block), name
       end
 
+      # Create an active choice scene.
+      #
       # @param name [Symbol, nil]
       # @return [Class<Scene::ActiveChoice>]
       def active_choice(name = nil, &block)
         block Class.new(Scene::ActiveChoice, &block), name
       end
 
+      # Create a pause.
+      # The block will be executed at the start of the scene and the player
+      # will be prompted to press enter to continue.
+      #
       # @param name [Symbol, nil]
+      # @yieldparam [Actor]
+      # @yieldparam [Props::Default]
       # @return [Class<Scene::Pause>]
       def pause(name = nil, &block)
-        block Class.new(Scene::Pause, &block), name
+        block(Class.new(Scene::Pause) do
+          on_start(&block)
+        end, name)
       end
 
       # Create a conclusion.
@@ -136,6 +148,8 @@ module Gamefic
       #   end
       #
       # @param name [Symbol, nil]
+      # @yieldparam [Actor]
+      # @yieldparam [Props::Default]
       # @return [Class<Scene::Conclusion>]
       def conclusion(name = nil, &block)
         block(Class.new(Scene::Conclusion) do

data/lib/gamefic/scriptable/seeds.rb

@@ -3,10 +3,22 @@
 module Gamefic
   module Scriptable
     module Seeds
+      # @return [Array<Proc>]
       def seeds
         @seeds ||= []
       end
 
+      # Set methods and procs that get executed when a narrative gets initialized.
+      #
+      # @example
+      #   class Example < Gamefic::Plot
+      #     attr_reader :thing
+      #
+      #     seed do
+      #       @thing = make Entity, name: 'thing'
+      #     end
+      #   end
+      #
       def seed *methods, &block
         seeds.push(proc { methods.flatten.each { |method| send(method) } }) unless methods.empty?
         seeds.push block if block

data/lib/gamefic/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.1
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-26 00:00:00.000000000 Z
+date: 2025-03-02 00:00:00.000000000 Z
 dependencies:
+- !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 +126,7 @@ files:
 - ".rspec-opal"
 - ".rubocop.yml"
 - ".solargraph.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE