gamefic 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa8d74d06ad87105050c1ca487acd976d293f4ca52fa6cc760061ccdbb3a14e7
-  data.tar.gz: f791519291a168cf31045d6bc2f136d4829f5ddce2fa7c370d6c4887f83f560e
+  metadata.gz: 2288262e86ac4a5cf259b3a37e80ba56a3a4ed334b8842770109e1930799585d
+  data.tar.gz: 542aaff9c3f4d0aae1a4471fba5d52ff35b569971c861af006ddc78f0d1cc568
 SHA512:
-  metadata.gz: e8abcf0f9ca24db9b8bc3f61be5d0d28dcd86c24f047e420eb117bd09411b70d5f3ae7e9c2c5d2277062c4c72a970d2c9144eb0990a46872eb80b7a7bd75369e
-  data.tar.gz: 2bdec46fe7d946a05c3d9bf258314db25c61f32459993f03f1c2096dd31b0056917332fcd5c05ee011e3c352e373a1dcaa74f670d069398e481334ff64c07f1d
+  metadata.gz: 6a89c7fb5978047517827e3cc2de5f172da5e6905a7e7efe0725763b4ce01d56725df46a443b903906effd962cebdbd238d81719b315eb26f3b8bf289d337089
+  data.tar.gz: 9976d0c58957309ba605e645a8c7e214d798c12e114b71e5d5fa2bb4b6d39878537612e670da6e42168dfd31ee5fce7304eee9983d1177d878262af630e6e582

data/.github/workflows/rspec.yml

@@ -0,0 +1,40 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with rspec.
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: RSpec
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      # uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: false
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

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,3 +1,9 @@
+## 2.4.0 - February 11, 2023
+- Fix arity of delegated methods in scripts
+- Action hooks accept verb filters
+- Opal exception for delegated methods
+- Support separation of kwargs in Ruby >= 2.7
+
 ## 2.3.0 - January 25, 2023
 - Remove unused Active#actions method
 - Add before_action and after_action hooks

data/Gemfile

@@ -1,7 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-group :test do
-  gem "simplecov"
-end

data/gamefic.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   end
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.1.0'
+  s.required_ruby_version = '>= 2.3.0'
 
   s.add_development_dependency 'rake', '~> 12.3', '>= 12.3'
   s.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'

data/lib/gamefic/action.rb

@@ -32,8 +32,11 @@ module Gamefic
 
     # Cancel an action. This method can be called in a before_action hook to
     # prevent subsequent hooks and the action itself from being executed.
+    # Cancelling an action in an after_action hook has no effect.
     #
     def cancel
+      # @todo Emit a warning for attempts to cancel an action after it's been
+      #   executed
       @cancelled = true
     end
 
@@ -44,6 +47,10 @@ module Gamefic
       @executed
     end
 
+    def cancelled?
+      !@executed && @cancelled
+    end
+
     # The verb associated with this action.
     #
     # @return [Symbol] The symbol representing the verb
@@ -91,8 +98,9 @@ module Gamefic
       return unless @with_callbacks
       @actor.playbooks
             .flat_map(&:before_actions)
-            .each do |block|
-              block.call(self)
+            .each do |hook|
+              next unless hook.verb.nil? || hook.verb == verb
+              hook.block.call(self)
               break if @cancelled
             end
     end
@@ -101,7 +109,10 @@ module Gamefic
       return unless @with_callbacks
       @actor.playbooks
             .flat_map(&:after_actions)
-            .each { |block| block.call(self) }
+            .each do |hook|
+              next unless hook.verb.nil? || hook.verb == verb
+              hook.block.call(self)
+            end
     end
 
     class << self

data/lib/gamefic/active.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Gamefic

data/lib/gamefic/dispatcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gamefic
   # The action selector for character commands.
   #
@@ -12,11 +14,16 @@ module Gamefic
       @started = false
     end
 
+    # @param dispatcher [Dispatcher]
+    # @return [void]
     def merge dispatcher
       commands.concat dispatcher.commands
       actions.concat dispatcher.actions
     end
 
+    # Get the next executable action.
+    #
+    # @return [Action]
     def next
       instance = nil
       while instance.nil? && !@actions.empty?

data/lib/gamefic/scriptable.rb

@@ -76,9 +76,14 @@ Gamefic::Scriptable.module_exec do
       instance = self
       theater ||= Object.new
       theater.instance_exec do
-        define_singleton_method :method_missing do |symbol, *args, **splat, &block|
-          result = instance.public_send :public_send, symbol, *args, **splat, &block
-          result
+        if RUBY_ENGINE == 'opal' || RUBY_VERSION =~ /^2\.[456]\./
+          define_singleton_method :method_missing do |symbol, *args, &block|
+            instance.public_send :public_send, symbol, *args, &block
+          end
+        else
+          define_singleton_method :method_missing do |symbol, *args, **splat, &block|
+            instance.public_send :public_send, symbol, *args, **splat, &block
+          end
         end
       end
       theater.extend Gamefic::Serialize

data/lib/gamefic/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gamefic
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 end

data/lib/gamefic/world/commands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'gamefic/action'
 
 module Gamefic
@@ -91,23 +93,29 @@ module Gamefic
       # @param command [Symbol] An imperative verb for the command
       # @param queries [Array<Query::Base>] Filters for the command's tokens
       # @yieldparam [Gamefic::Actor]
-      def meta(command, *queries, &proc)
-        playbook.meta command, *queries, &proc
+      def meta(command, *queries, &block)
+        playbook.meta command, *queries, &block
       end
 
       # Add a proc to be evaluated before a character executes an action.
+      # When a verb is specified, the proc will only be evaluated if the
+      # action's verb matches it.
       #
+      # @param verb [Symbol, nil]
       # @yieldparam [Gamefic::Action]
-      def before_action &block
-        playbook.before_actions.push block
+      def before_action verb = nil, &block
+        playbook.before_action verb, &block
       end
       alias validate before_action
 
       # Add a proc to be evaluated after a character executes an action.
+      # When a verb is specified, the proc will only be evaluated if the
+      # action's verb matches it.
       #
+      # @param [Symbol, nil]
       # @yieldparam [Gamefic::Action]
-      def after_action &block
-        playbook.after_actions.push block
+      def after_action verb = nil, &block
+        playbook.after_action verb, &block
       end
 
       # Create an alternate Syntax for an Action.
@@ -164,7 +172,7 @@ module Gamefic
           elsif q.is_a?(Gamefic::Element) || (q.is_a?(Class) && q <= Gamefic::Element)
             get_default_query.new(q)
           else
-            raise ArgumentError.new("Invalid argument for response: #{q}")
+            raise ArgumentError, "Invalid argument for response: #{q.inspect}"
           end
         end
       end

data/lib/gamefic/world/playbook.rb

@@ -5,6 +5,8 @@ module Gamefic
     # A collection of rules for performing commands.
     #
     class Playbook
+      ActionHook = Struct.new(:verb, :block)
+
       # An array of available syntaxes.
       #
       # @return [Array<Gamefic::Syntax>]
@@ -47,18 +49,24 @@ module Gamefic
       end
 
       # Add a proc to be evaluated before a character executes an action.
+      # When a verb is specified, the proc will only be evaluated if the
+      # action's verb matches it.
       #
+      # @param verb [Symbol, nil]
       # @yieldparam [Gamefic::Action]
-      def before_action &block
-        @before_actions.push block
+      def before_action verb = nil, &block
+        @before_actions.push ActionHook.new(verb, block)
       end
       alias validate before_action
 
       # Add a proc to be evaluated after a character executes an action.
+      # When a verb is specified, the proc will only be evaluated if the
+      # action's verb matches it.
       #
+      # @param verb [Symbol, nil]
       # @yieldparam [Gamefic::Action]
-      def after_action &block
-        @after_actions.push block
+      def after_action verb = nil, &block
+        @after_actions.push ActionHook.new(verb, block)
       end
 
       # Get an Array of all Actions associated with the specified verb.

data/lib/gamefic/world/scenes.rb

@@ -1,6 +1,9 @@
 module Gamefic
   module World
     module Scenes
+      include Commands
+      include Players
+
       # @return [Class<Gamefic::Scene::Activity>]
       def default_scene
         @default_scene ||= Scene::Activity
@@ -29,13 +32,12 @@ module Gamefic
       # This method is typically called by the Engine that manages game execution.
       #
       # @param [Gamefic::Actor]
+      # @return [void]
       def introduce(player)
         player.playbooks.push playbook unless player.playbooks.include?(playbook)
         player.cue default_scene
         players.push player
-        @introduction.call(player) unless @introduction.nil?
-        # @todo Find a better way to persist player characters
-        # Gamefic::Index.stick
+        @introduction&.call(player)
       end
 
       # Create a multiple-choice scene.
@@ -53,7 +55,7 @@ module Gamefic
       # @yieldparam [Gamefic::Scene::MultipleChoice]
       # @return [Class<Gamefic::Scene::MultipleChoice>]
       def multiple_choice *choices, &block
-        s = Scene::MultipleChoice.subclass do |actor, scene|
+        s = Scene::MultipleChoice.subclass do |_actor, scene|
           scene.options.concat choices
           scene.on_finish &block
         end
@@ -73,12 +75,12 @@ module Gamefic
       #     end
       #   end
       #
-      # @param prompt [String]
+      # @param prompt [String, nil]
       # @yieldparam [Gamefic::Actor]
       # @yieldparam [Gamefic::Scene::YesOrNo]
       # @return [Class<Gamefic::Scene::YesOrNo>]
       def yes_or_no prompt = nil, &block
-        s = Scene::YesOrNo.subclass do |actor, scene|
+        s = Scene::YesOrNo.subclass do |_actor, scene|
           scene.prompt = prompt
           scene.on_finish &block
         end
@@ -98,7 +100,7 @@ module Gamefic
       # @yieldparam [Gamefic::Scene::Base]
       # @return [Class<Gamefic::Scene::Base>]
       def question prompt = 'What is your answer?', &block
-        s = Scene::Base.subclass do |actor, scene|
+        s = Scene::Base.subclass do |_actor, scene|
           scene.prompt = prompt
           scene.on_finish &block
         end
@@ -116,13 +118,13 @@ module Gamefic
       #     actor.prepare default_scene
       #   end
       #
-      # @param prompt [String] The text to display when prompting the user to continue.
+      # @param prompt [String, nil] The text to display when prompting the user to continue
       # @yieldparam [Gamefic::Actor]
       # @return [Class<Gamefic::Scene::Pause>]
       def pause prompt = nil, &block
         s = Scene::Pause.subclass do |actor, scene|
           scene.prompt = prompt unless prompt.nil?
-          block.call(actor, scene) unless block.nil?
+          block&.call(actor, scene)
         end
         scene_classes.push s
         s
@@ -163,7 +165,7 @@ module Gamefic
       #     end
       #   end
       #
-      # @param cls [Class] The class of scene to be instantiated.
+      # @param cls [Class<Scene::Base>] The class of scene to be instantiated.
       # @yieldparam [Gamefic::Actor]
       # @return [Class<Gamefic::Scene::Base>]
       def custom cls = Scene::Base, &block
@@ -208,10 +210,10 @@ module Gamefic
       # @return [Class<Gamefic::Scene::MultipleScene>]
       def multiple_scene map = {}, &block
         s = Scene::MultipleScene.subclass do |actor, scene|
-          map.each_pair { |k, v|
+          map.each_pair do |k, v|
             scene.map k, v
-          }
-          block.call actor, scene unless block.nil?
+          end
+          block&.call actor, scene
         end
         scene_classes.push s
         s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-25 00:00:00.000000000 Z
+date: 2023-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -70,6 +70,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -142,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="