gamefic 2.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2288262e86ac4a5cf259b3a37e80ba56a3a4ed334b8842770109e1930799585d
-  data.tar.gz: 542aaff9c3f4d0aae1a4471fba5d52ff35b569971c861af006ddc78f0d1cc568
+  metadata.gz: 6647dc3319080277826fecd19b8466cfbe82a42f4f4c68aeb89fa74bd0de4319
+  data.tar.gz: 0dc0680cb42b981d6e93c12d03e95b4ffcce0a98acb0678595723ab2d5ae7db9
 SHA512:
-  metadata.gz: 6a89c7fb5978047517827e3cc2de5f172da5e6905a7e7efe0725763b4ce01d56725df46a443b903906effd962cebdbd238d81719b315eb26f3b8bf289d337089
-  data.tar.gz: 9976d0c58957309ba605e645a8c7e214d798c12e114b71e5d5fa2bb4b6d39878537612e670da6e42168dfd31ee5fce7304eee9983d1177d878262af630e6e582
+  metadata.gz: 1ec19185367b63b0ebe352e620af403e0aef00bdd7afac7135801551568ef5c35c923b45092cb4d781cd8458bba71776b042efe9837a0e9d2f144141b6b8d606
+  data.tar.gz: 300d2c30b05993ee4689f14ce8daeeec3585bfdf1cd7636ec6a931bfc568e8227a97771fdf6d20ec859080f3792b914a29ba1fc6a7246c9f9ef9eb563d81920c

data/.github/workflows/rspec.yml

@@ -1,40 +1,41 @@
-# 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
+# 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.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: false
+    - name: Set up Node
+      uses: actions/setup-node@v3
+    - name: Install dependencies
+      run: bundle install
+    - name: Run Ruby tests
+      run: bundle exec rspec
+    - name: Run Opal tests
+      run: bundle exec rake opal

data/.rspec-opal

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.solargraph.yml

@@ -1,5 +1,22 @@
+---
 include:
-  - lib/**/*.rb
+- "**/*.rb"
 exclude:
-  - spec/**/*
-  - test/**/*
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+- require_not_found
+formatter:
+  rubocop:
+    cops: safe
+    except: []
+    only: []
+    extra_args: []
+require_paths: []
+plugins: []
+max_files: 5000

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 3.0.0
+- Instantiate subplots from snapshots
+- Split Action into Response and Action
+- Logging
+- Remove deprecated Active#perform behavior
+- Snapshots use single static index
+- Hydration improvements
+- Snapshot metadata validation
+
 ## 2.4.0 - February 11, 2023
 - Fix arity of delegated methods in scripts
 - Action hooks accept verb filters

data/Rakefile

@@ -1,5 +1,9 @@
-require 'rake'
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 require 'rspec/core/rake_task'
+require 'opal/rspec/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = Dir.glob('spec/**/*_spec.rb')
@@ -8,3 +12,9 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   #t.rcov = true
 end
 task :default => :spec
+
+Opal::RSpec::RakeTask.new(:opal) do |_, config|
+  Opal.append_path File.expand_path('../lib', __FILE__)
+  config.pattern = 'spec/**/*_spec.rb'
+  config.requires = ['spec_helper']
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gamefic-sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gamefic.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.description   = "An adventure game and interactive fiction framework"
   s.authors       = ["Fred Snyder"]
   s.email         = 'fsnyder@gamefic.com'
-  s.homepage      = 'http://gamefic.com'
+  s.homepage      = 'https://gamefic.com'
   s.license       = 'MIT'
 
   s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
@@ -19,8 +19,11 @@ Gem::Specification.new do |s|
   end
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.3.0'
+  s.required_ruby_version = '>= 2.7.0'
 
+  s.add_development_dependency 'opal', '~> 1.7'
+  s.add_development_dependency 'opal-rspec', '~> 1.0'
+  s.add_development_dependency 'opal-sprockets', '~> 1.0'
   s.add_development_dependency 'rake', '~> 12.3', '>= 12.3'
   s.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'
   s.add_development_dependency 'simplecov', '~> 0.14'

data/lib/gamefic/action.rb

@@ -1,213 +1,82 @@
+# frozen_string_literal: true
+
 module Gamefic
+  # The handler for executing responses for a provided actor and array of
+  # arguments. It's also responsible for executing before_action and
+  # after_action hooks if necessary.
+  #
   class Action
-    # @return [Gamefic::Actor]
-    attr_reader :actor
+    include Logging
 
-    # An array of objects on which the action will operate, e.g., an entity
-    # that is a direct object of a command.
+    # Hooks are blocks of code that get executed before or after an actor
+    # performs an action. A before action hook is capable of cancelling the
+    # action's performance.
     #
-    # @return [Array<Object>]
+    class Hook
+      attr_reader :verbs
+
+      attr_reader :block
+
+      def initialize *verbs, &block
+        @verbs = verbs
+        @block = block
+      end
+
+      def match?(input)
+        verbs.empty? || verbs.include?(input)
+      end
+    end
+
+    # @return [Active]
+    attr_reader :actor
+
+    # @return [Array]
     attr_reader :arguments
-    alias parameters arguments
 
-    # @param actor [Gamefic::Actor]
-    # @param arguments [Array<Object>]
-    def initialize actor, arguments, with_callbacks = false
+    # @return [Response]
+    attr_reader :response
+
+    # @param actor [Active]
+    # @param arguments [Array]
+    # @param response [Response]
+    def initialize actor, arguments, response
       @actor = actor
       @arguments = arguments
-      @executed = false
-      @with_callbacks = with_callbacks
+      @response = response
     end
 
-    # Perform the action.
-    #
     def execute
-      return if @cancelled
-      run_before_actions
-      return if @cancelled
-      self.class.executor.call(@actor, *arguments) unless self.class.executor.nil?
+      return if cancelled?
+
       @executed = true
-      run_after_actions
+      response.execute actor, *arguments
     end
 
-    # 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.
+    # True if the response has been executed. False typically means that the
+    # #execute method has not been called or the action was cancelled in a
+    # before_action hook.
     #
-    def cancel
-      # @todo Emit a warning for attempts to cancel an action after it's been
-      #   executed
-      @cancelled = true
+    def executed?
+      @executed ||= false
     end
 
-    # True if the #execute method has been called for this action.
+    # Cancel an action. This method can be called in an action hook to
+    # prevent subsequent hooks and/or the action itself from being executed.
     #
-    # @return [Boolean]
-    def executed?
-      @executed
+    def cancel
+      @cancelled = true
     end
 
     def cancelled?
-      !@executed && @cancelled
+      @cancelled ||= false
     end
 
-    # The verb associated with this action.
-    #
-    # @return [Symbol] The symbol representing the verb
     def verb
-      self.class.verb
-    end
-
-    def signature
-      self.class.signature
-    end
-
-    def rank
-      self.class.rank
+      response.verb
     end
 
-    # True if the action is flagged as meta.
-    #
-    # @return [Boolean]
     def meta?
-      self.class.meta?
-    end
-
-    # @param verb [Symbol]
-    # @param queries [Array<Gamefic::Query::Base>]
-    # @param meta [Boolean]
-    # @return [Class<Action>]
-    def self.subclass verb, *queries, meta: false, &block
-      act = Class.new(self) do
-        self.verb = verb
-        self.meta = meta
-        queries.each do |q|
-          add_query q
-        end
-        on_execute &block
-      end
-      if !block.nil? && act.queries.length + 1 != block.arity && block.arity > 0
-        raise ArgumentError.new("Number of parameters is not compatible with proc arguments")
-      end
-      act
-    end
-
-    private
-
-    def run_before_actions
-      return unless @with_callbacks
-      @actor.playbooks
-            .flat_map(&:before_actions)
-            .each do |hook|
-              next unless hook.verb.nil? || hook.verb == verb
-              hook.block.call(self)
-              break if @cancelled
-            end
-    end
-
-    def run_after_actions
-      return unless @with_callbacks
-      @actor.playbooks
-            .flat_map(&:after_actions)
-            .each do |hook|
-              next unless hook.verb.nil? || hook.verb == verb
-              hook.block.call(self)
-            end
-    end
-
-    class << self
-      attr_reader :verb
-
-      # The proc to call when the action is executed
-      #
-      # @return [Proc]
-      attr_reader :executor
-
-      def meta?
-        @meta ||= false
-      end
-
-      def add_query q
-        @specificity = nil
-        queries.push q
-      end
-
-      def queries
-        @queries ||= []
-      end
-
-      def on_execute &block
-        @executor = block
-      end
-
-      def signature
-        # @todo This is clearly unfinished
-        "#{verb} #{queries.map {|m| m.signature}.join(', ')}"
-      end
-
-      # True if this action is not intended to be performed directly by a
-      # character.
-      # If the action is hidden, users should not be able to perform it with a
-      # direct command. By default, any action whose verb starts with an
-      # underscore is hidden.
-      #
-      # @return [Boolean]
-      def hidden?
-        verb.to_s.start_with?('_')
-      end
-
-      # @return [Integer]
-      def rank
-        if @rank.nil?
-          @rank = 0
-          queries.each do |q|
-            @rank += (q.rank + 1)
-          end
-          @rank -= 1000 if verb.nil?
-        end
-        @rank
-      end
-
-      def valid? actor, objects
-        return false if objects.length != queries.length
-        queries.each_with_index do |p, i|
-          return false unless p.include?(actor, objects[i])
-        end
-        true
-      end
-
-      # Return an instance of this Action if the actor can execute it with the
-      # provided tokens, or nil if the tokens are invalid.
-      #
-      # @param action [Gamefic::Entity]
-      # @param command [Command]
-      # @return [self, nil]
-      def attempt actor, command, with_callbacks = false
-        return nil if command.verb != verb
-        tokens = command.arguments
-        result = []
-        matches = Gamefic::Query::Matches.new([], '', '')
-        queries.each_with_index do |p, i|
-          return nil if tokens[i].nil? && matches.remaining == ''
-          matches = p.resolve(actor, "#{matches.remaining} #{tokens[i]}".strip, continued: (i < queries.length - 1))
-          return nil if matches.objects.empty?
-          accepted = matches.objects.select { |o| p.accept?(o) }
-          return nil if accepted.empty?
-          if p.ambiguous?
-            result.push accepted
-          else
-            return nil if accepted.length != 1
-            result.push accepted.first
-          end
-        end
-        new(actor, result, with_callbacks)
-      end
-
-      protected
-
-      attr_writer :verb
-
-      attr_writer :meta
+      response.meta?
     end
   end
 end

data/lib/gamefic/active/cue.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Active
+    # The data that actors use to configure a Take.
+    #
+    class Cue
+      # @return [Symbol]
+      attr_reader :scene
+
+      # @return [Hash]
+      attr_reader :context
+
+      # @param scene [Symbol]
+      def initialize scene, **context
+        @scene = scene
+        @context = context
+      end
+
+      def to_s
+        scene.to_s
+      end
+    end
+  end
+end

data/lib/gamefic/active/epic.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Active
+    # A collection of narratives.
+    #
+    class Epic
+      include Logging
+
+      # @return [Set<Narrative>]
+      attr_reader :narratives
+
+      def initialize
+        @narratives = Set.new
+      end
+
+      # @param narrative [Narrative]
+      def add narrative
+        narratives.add narrative
+      end
+
+      # @param narrative [Narrative]
+      def delete narrative
+        narratives.delete narrative
+      end
+
+      # @return [Array<Rulebook>]
+      def rulebooks
+        narratives.map(&:rulebook)
+      end
+
+      # @return [Array<Symbol>]
+      def verbs
+        rulebooks.flat_map(&:verbs).uniq
+      end
+
+      # @return [Array<Symbol>]
+      def synonyms
+        rulebooks.flat_map(&:synonyms).uniq
+      end
+
+      def empty?
+        narratives.empty?
+      end
+
+      def one?
+        narratives.one?
+      end
+
+      # @param name [Symbol]
+      def conclusion? name
+        select_scene(name).conclusion?
+      end
+
+      # @param name [Symbol]
+      # @return [Scene]
+      def select_scene name
+        scenes = rulebooks.map { |rlbk| rlbk.scenes[name] }
+                          .compact
+        raise ArgumentError, "Scene named `#{name}` does not exist" if scenes.empty?
+
+        logger.warn "Found #{scenes.length} scenes named `#{name}`" unless scenes.one?
+
+        scenes.last
+      end
+    end
+  end
+end

data/lib/gamefic/active/messaging.rb

@@ -0,0 +1,43 @@
+module Gamefic
+  module Active
+    # A module for active entities that provides a default Messenger with
+    # a few shortcuts.
+    #
+    module Messaging
+      def messenger
+        @messenger ||= Messenger.new
+      end
+
+      # Send a message to the entity.
+      #
+      # This method will automatically wrap the message in HTML paragraphs.
+      # To send a message without paragraph formatting, use #stream instead.
+      #
+      # @param message [String]
+      def tell(message)
+        messenger.tell message
+      end
+
+      # Send a message to the entity as raw text.
+      #
+      # Unlike #tell, this method will not wrap the message in HTML paragraphs.
+      #
+      # @param message [String]
+      def stream(message)
+        messenger.stream message
+      end
+
+      def messages
+        messenger.messages
+      end
+
+      def buffer &block
+        messenger.buffer(&block)
+      end
+
+      def flush
+        messenger.flush
+      end
+    end
+  end
+end

data/lib/gamefic/active/take.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Active
+    # The combination of an actor and a scene to be performed in a plot turn.
+    #
+    class Take
+      # @return [Active]
+      attr_reader :actor
+
+      # @return [Active::Cue]
+      attr_reader :cue
+
+      # @return [Scene::Default]
+      attr_reader :scene
+
+      # @param actor [Active]
+      # @param cue [Active::Cue]
+      # @param props [Props::Default]
+      def initialize actor, cue, props = nil
+        @actor = actor
+        @cue = cue
+        @scene = actor.epic.select_scene(cue.scene)
+        @props = props
+      end
+
+      # @return [Props::Default]
+      def props
+        @props ||= @scene.new_props(**cue.context)
+      end
+
+      # @return [Props::Default]
+      def start
+        actor.output[:scene] = scene.to_hash
+        scene.run_start_blocks actor, props
+        scene.start actor, props
+        # @todo See if this can be handled better
+        actor.epic.rulebooks.each { |rlbk| rlbk.run_player_output_blocks actor, actor.output }
+        actor.output.merge!({
+                              messages: actor.messages,
+                              queue: actor.queue
+                            })
+        props
+      end
+
+      # @return [void]
+      def finish
+        actor.flush
+        scene.finish(actor, props)
+        actor.output.replace(last_prompt: props.prompt, last_input: props.input)
+        scene.run_finish_blocks actor, props
+      end
+
+      # @param actor [Active]
+      # @param cue [Active::Cue]
+      # @return [Props::Default]
+      def self.start actor, cue
+        Take.new(actor, cue).start
+      end
+
+      # @param actor [Active]
+      # @param cue [Active::Cue]
+      # @return [void]
+      def self.finish actor, cue, props
+        Take.new(actor, cue, props).finish
+      end
+    end
+  end
+end