gamefic-standard 2.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6abba8f34782d5cfb4beee5d43dc31f155b535da326b385d7404e939d3920c6e
-  data.tar.gz: 938d1bdcdbf488ee44531fcc00df5de29c4979869986c5ddbc3e7e479ae8e6bf
+  metadata.gz: 6c2ec7dc0f67d10c0539b74d735051ea02a42971a758b73b86ed393cfa9208e1
+  data.tar.gz: 8843dd046b42baac0c495a1da403bc4f5b6992f324360b4c66623aa2e3ae8e2a
 SHA512:
-  metadata.gz: 8b21f6722f5247b3881bc3d056e77838de488f3d907114234a6c3737a9b37f6a7373d62dc1337a83a5c1e46f022e1cc7dd90f5c55c09043010e07ac814d01a97
-  data.tar.gz: 3ea46e35b5f526854c8666f1dee03a5d72f77995dc2cdf803ae6f5b26b07bc619e698b9fc14b1f2c8082924d10cbe4a4ca219ac3db8b08210668c46a5b4cf1e9
+  metadata.gz: 6a4e56f9898345fa40c7b0743b5231fb4b18266644765e6e222c3aff884dc15f4f18707ae2cb0826c6cd1b6f5056f1347649a41a9480ec8601cefcbd6f1114d2
+  data.tar.gz: 3bfa5195316099738fe004bc29aec5f00782ccef7405324d452d0bcb644e2ea917866df37ef86a1879ec2fa68b8eae8c1ffeb0f181fe9aea1a648369232fcf73

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 tests
+      run: bundle exec rspec
+    - name: Run tests
+      run: bundle exec rake opal

data/.rspec-opal

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

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.0.0 - January 27, 2024
+- Updates for Gamefic 3.0
+
 ## 2.4.0 - February 11, 2023
 - Change Actor#perform to Actor#execute
 - Update gamefic dependency

data/Gemfile

@@ -2,3 +2,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in gamefic-standard.gemspec
 gemspec
+
+gem 'gamefic', git: 'https://github.com/castwide/gamefic.git', branch: 'v3'

data/README.md

@@ -1,60 +1,64 @@
-# Gamefic Standard
-
-The standard library for the Gamefic interactive fiction framework.
-
-Gamefic Standard provides common useful components for adventure games. [Inform](http://inform7.com/)
-developers should find it similar to Inform's Standard Rules. It defines common
-components like Rooms and Characters, along with in-game commands like `GO`,
-`GET`, and `DROP` to enable basic interactivity.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'gamefic-standard'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install gamefic-standard
-
-## Usage
-
-Require the library in your game scripts:
-
-```ruby
-require 'gamefic'
-require 'gamefic-standard'
-
-Gamefic.script do
-  @office = make Room, name: 'office'
-  @desk = make Fixture, name: 'desk', parent: @office
-
-  introduction do |actor|
-    actor.parent = @office
-    actor.tell "You're in an office."
-  end
-end
-```
-
-Go to the [Gamefic website](https://gamefic.com) or the [SDK repo](https://github.com/castwide/gamefic-sdk)
-for more information about using Gamefic.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/castwide/gamefic-standard.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# Gamefic Standard
+
+The standard library for the Gamefic interactive fiction framework.
+
+Gamefic Standard provides common useful components for adventure games. [Inform](http://inform7.com/)
+developers should find it similar to Inform's Standard Rules. It defines common
+components like Rooms and Characters, along with in-game commands like `GO`,
+`GET`, and `DROP` to enable basic interactivity.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gamefic-standard'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gamefic-standard
+
+## Usage
+
+Require the library in your game scripts:
+
+```ruby
+require 'gamefic'
+require 'gamefic-standard'
+
+class MyPlot < Gamefic::Plot
+  seed do
+    @office = make Room, name: 'office'
+    @desk = make Fixture, name: 'desk', parent: @office
+  end
+
+  script do
+    introduction do |actor|
+      actor.parent = @office
+      actor.tell "You're in an office."
+    end
+  end
+end
+```
+
+Go to the [Gamefic website](https://gamefic.com) or the [SDK repo](https://github.com/castwide/gamefic-sdk)
+for more information about using Gamefic.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/castwide/gamefic-standard.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,14 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'opal/rspec/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Opal::RSpec::RakeTask.new(:opal) do |_, config|
+  Opal.append_path File.expand_path('../lib', __FILE__)
+  Opal.use_gem('gamefic')
+  config.pattern = 'spec/**/*_spec.rb'
+  config.requires = ['spec_helper']
+end

data/gamefic-standard.gemspec

@@ -35,10 +35,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'gamefic', '~> 2.4'
+  spec.required_ruby_version = '>= 2.7.0'
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'gamefic', '~> 3.0'
+
+  spec.add_development_dependency 'opal', '~> 1.7'
+  spec.add_development_dependency 'opal-rspec', '~> 1.0'
+  spec.add_development_dependency 'opal-sprockets', '~> 1.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.14'
 end

data/lib/gamefic-standard/actions/attack.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Standard
+    script do
+      respond :attack do |actor, thing|
+        actor.tell "Violence is not the answer here."
+      end
+
+      respond :attack, Thing do |actor, _thing|
+        actor.execute :attack
+      end
+
+      interpret 'fight', 'attack'
+      interpret 'battle', 'attack'
+      interpret 'kill', 'attack'
+      interpret 'punch', 'attack'
+      interpret 'kick', 'attack'
+      interpret 'hit', 'attack'
+      interpret 'fight :thing', 'attack :thing'
+      interpret 'battle :thing', 'attack :thing'
+      interpret 'kill :thing', 'attack :thing'
+      interpret 'punch :thing', 'attack :thing'
+      interpret 'kick :thing', 'attack :thing'
+      interpret 'hit :thing', 'attack :thing'
+    end
+  end
+end

data/lib/gamefic-standard/actions/close.rb

@@ -1,14 +1,18 @@
-Gamefic.script do
-  respond :close, Use.available do |actor, thing|
-    actor.tell "You can't close #{the thing}."
-  end
+module Gamefic
+  module Standard
+    script do
+      respond :close, available do |actor, thing|
+        actor.tell "You can't close #{the thing}."
+      end
 
-  respond :close, Use.available(Openable) do |actor, thing|
-    if thing.open?
-      actor.tell "You close #{the thing}."
-      thing.open = false
-    else
-      actor.tell "#{The thing} is already closed."
+      respond :close, available(Openable) do |actor, thing|
+        if thing.open?
+          actor.tell "You close #{the thing}."
+          thing.open = false
+        else
+          actor.tell "#{The thing} is already closed."
+        end
+      end
     end
   end
 end

data/lib/gamefic-standard/actions/drop.rb

@@ -1,20 +1,24 @@
-Gamefic.script do
-  respond :drop, Use.available do |actor, thing|
-    actor.tell "You're not carrying #{the thing}."
-  end
+module Gamefic
+  module Standard
+    script do
+      respond :drop, available do |actor, thing|
+        actor.tell "You're not carrying #{the thing}."
+      end
 
-  respond :drop, Gamefic::Query::Descendants.new do |actor, thing|
-    actor.execute :take, thing
-    next unless thing.parent == actor
-    thing.parent = actor.parent
-    actor.tell "You drop #{the thing}."
-  end
+      respond :drop, children do |actor, thing|
+        actor.execute :take, thing
+        next unless thing.parent == actor
+        thing.parent = actor.parent
+        actor.tell "You drop #{the thing}."
+      end
 
-  respond :drop, Use.children do |actor, thing|
-    thing.parent = actor.parent
-    actor.tell "You drop #{the thing}."
-  end
+      respond :drop, children do |actor, thing|
+        thing.parent = actor.parent
+        actor.tell "You drop #{the thing}."
+      end
 
-  interpret "put down :thing", "drop :thing"
-  interpret "put :thing down", "drop :thing"
+      interpret "put down :thing", "drop :thing"
+      interpret "put :thing down", "drop :thing"
+    end
+  end
 end

data/lib/gamefic-standard/actions/enter.rb

@@ -1,25 +1,35 @@
-Gamefic.script do
-  respond :enter, Use.siblings do |actor, thing|
-    actor.tell "#{The thing} can't accommodate you."
-  end
+module Gamefic
+  module Standard
+    script do
+      respond :enter, siblings do |actor, thing|
+        actor.tell "#{The thing} can't accommodate you."
+      end
 
-  respond :enter, Use.siblings(Enterable, :enterable?) do |actor, supporter|
-    actor.parent = supporter
-    actor.tell "You get in #{the supporter}."
-  end
+      respond :enter, siblings(Enterable, proc(&:enterable?)) do |actor, supporter|
+        actor.parent = supporter
+        actor.tell "You get in #{the supporter}."
+      end
 
-  respond :enter, Use.parent do |actor, container|
-    actor.tell "You're already in #{the container}."
-  end
+      respond :enter, parent do |actor, container|
+        actor.tell "You're already in #{the container}."
+      end
 
-  respond :enter, Use.parent(Supporter) do |actor, supporter|
-    actor.tell "You're inside #{the supporter} already."
-  end
+      respond :enter, parent(Supporter) do |actor, supporter|
+        actor.tell "You're inside #{the supporter} already."
+      end
 
-  respond :enter, Use.siblings(Container, :enterable?, :closed?) do |actor, container|
-    actor.tell "#{The container} is closed."
-  end
+      respond :enter, siblings(Container, proc(&:enterable?), proc(&:closed?)) do |actor, container|
+        actor.tell "#{The container} is closed."
+      end
 
-  interpret "get on :thing", "enter :thing"
-  interpret "get in :thing", "enter :thing"
+      interpret "get on :thing", "enter :thing"
+      interpret "get in :thing", "enter :thing"
+      interpret "sit on :thing", "enter :thing"
+      interpret "sit in :thing", "enter :thing"
+      interpret "lie on :thing", "enter :thing"
+      interpret "lie in :thing", "enter :thing"
+      interpret "stand on :thing", "enter :thing"
+      interpret "stand in :thing", "enter :thing"
+    end
+  end
 end

data/lib/gamefic-standard/actions/go.rb

@@ -1,55 +1,59 @@
-Gamefic.script do
-  respond :go, Use.siblings(Portal) do |actor, portal|
-    if portal.destination.nil?
-      actor.tell "That portal leads nowhere."
-    else
-      actor.parent = portal.destination
-      if !portal.direction.nil?
-        actor.tell "You go #{portal.direction}."
+module Gamefic
+  module Standard
+    script do
+      respond :go, siblings(Portal) do |actor, portal|
+        if portal.destination.nil?
+          actor.tell "That portal leads nowhere."
+        else
+          actor.parent = portal.destination
+          if !portal.direction.nil?
+            actor.tell "You go #{portal.direction}."
+          end
+          actor.execute :look
+        end
       end
-      actor.execute :look
-    end
-  end
 
-  respond :go, Use.text do |actor, text|
-    if actor.parent == actor.room
-      actor.tell "I don't see any way to go \"#{text} from here."
-    else
-      actor.execute :leave
-      if actor.parent == actor.room
-        actor.perform "go #{text}"
-      else
-        actor.proceed
+      respond :go, plaintext do |actor, text|
+        if actor.parent == actor.room
+          actor.tell "I don't see any way to go \"#{text}\" from here."
+        else
+          actor.execute :leave
+          if actor.parent == actor.room
+            actor.perform "go #{text}"
+          else
+            actor.proceed
+          end
+        end
       end
-    end
-  end
 
-  respond :go, Use.available(Door) do |actor, door|
-    actor.execute :open, door unless door.open?
-    actor.proceed if door.open?
-  end
+      respond :go, available(Door) do |actor, door|
+        actor.execute :open, door unless door.open?
+        actor.proceed if door.open?
+      end
 
-  interpret "north", "go north"
-  interpret "south", "go south"
-  interpret "west", "go west"
-  interpret "east", "go east"
-  interpret "up", "go up"
-  interpret "down", "go down"
-  interpret "northwest", "go northwest"
-  interpret "northeast", "go northeast"
-  interpret "southwest", "go southwest"
-  interpret "southeast", "go southeast"
+      interpret "north", "go north"
+      interpret "south", "go south"
+      interpret "west", "go west"
+      interpret "east", "go east"
+      interpret "up", "go up"
+      interpret "down", "go down"
+      interpret "northwest", "go northwest"
+      interpret "northeast", "go northeast"
+      interpret "southwest", "go southwest"
+      interpret "southeast", "go southeast"
 
-  interpret "n", "go north"
-  interpret "s", "go south"
-  interpret "w", "go west"
-  interpret "e", "go east"
-  interpret "u", "go up"
-  interpret "d", "go down"
-  interpret "nw", "go northwest"
-  interpret "ne", "go northeast"
-  interpret "sw", "go southwest"
-  interpret "se", "go southeast"
+      interpret "n", "go north"
+      interpret "s", "go south"
+      interpret "w", "go west"
+      interpret "e", "go east"
+      interpret "u", "go up"
+      interpret "d", "go down"
+      interpret "nw", "go northwest"
+      interpret "ne", "go northeast"
+      interpret "sw", "go southwest"
+      interpret "se", "go southeast"
 
-  interpret "go to :place", "go :place"
+      interpret "go to :place", "go :place"
+    end
+  end
 end

data/lib/gamefic-standard/actions/help.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Standard
+    script do
+      respond :verbs do |actor|
+        list = rulebook.synonyms.reject { |syn| syn.to_s.start_with?('_') }
+                      .map { |syn| "<kbd>#{syn}</kbd>"}
+                      .join_and
+        actor.tell "I understand the following commands: #{list}."
+        actor.tell "Try using commands in plain sentences like <kbd>go north</kbd> or <kbd>take the coin</kbd>."
+        actor.tell "For more information about a specific command, try <kbd>help [command]</kbd>, e.g., <kbd>help go</kbd>."
+      end
+
+      interpret 'commands', 'verbs'
+      interpret 'help', 'verbs'
+
+      respond :help, plaintext do |actor, command|
+        if rulebook.synonyms.include?(command.to_sym) && !command.start_with?('_')
+          available = rulebook.syntaxes.select { |syntax| syntax.synonym == command.to_sym }
+                              .uniq(&:signature)
+          examples = available.map(&:template)
+                              .map do |tmpl|
+                                tmpl.text
+                                    .gsub(/:character/i, '[someone]')
+                                    .gsub(/:var[0-9]?/i, '[something]')
+                                    .gsub(/:([a-z0-9]+)/i, "[\\1]")
+                              end
+                              .reject { |tmpl| tmpl.include?('[something] [something]') }
+          actor.tell 'Examples:'
+          actor.stream '<ul>'
+          examples.each do |xmpl|
+            actor.stream "<li><kbd>#{xmpl}</kbd></li>"
+          end
+          actor.stream '</ul>'
+          related = available.map(&:verb)
+                              .uniq
+                              .that_are_not(command.to_sym)
+                              .sort
+                              .map { |sym| "<kbd>#{sym}</kbd>"}
+          next if related.empty?
+
+          actor.tell "Related: #{related.join(', ')}"
+        elsif command =~ /[^a-z]/i
+          actor.tell "Try asking for help with a specific command, e.g., <kbd>help go</kbd>"
+        else
+          actor.tell "\"#{command.cap_first}\" is not a verb I understand."
+        end
+      end
+    end
+  end
+end