gamefic-what 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26184e189b91fc9cb8e92ac66c9c26d3f76366128bfaab70a2e5c45ad48578ff
-  data.tar.gz: 5d3c2424dbca05c0c97547972f4fd1d5243e437ba89d7d06427f7d9181edf384
+  metadata.gz: 7d9e9905a8d2e90f47f0e908036b534ceb215f25d819691d9cda6c924c3cd43b
+  data.tar.gz: 99ce298f2dff13991b9389b7b2954e513b419cfc333b3a84282659dfff42aceb
 SHA512:
-  metadata.gz: 9dcf9bc8d1d9e7774846bc62343eb97bdae62f59f5999e01126e480bdc04fd169ffb42616700f1643ba7ad2ae0691c192c8ebf364dfd0c297691628c8805bd62
-  data.tar.gz: eb07db1e55f4875bc34d0080e3dbac8df9b5e40ba14ce4747e53c38b610ebafad5f4065f6ce80ce8e576d0aa184f475261190bd77bfda43a3401676d7d48c23a
+  metadata.gz: 799be61910dcdb1ed0835019152eb0f066becc5b167a68a6bc61388a1b180900eb46ef48aa029b766f3e1c16c9ca4a15472ba7cf2937416e3f29ca2c932cb9f9
+  data.tar.gz: 586b62b7d239c541e15b47d5672171a47f26ddedf67bbf1afc3c86ead1e981d830f3b94fe4722dbf767d4b3d4ca00fe9a15002cbe2b78acbfda6a897f581a7e9

data/CHANGELOG.md

@@ -1,2 +1,6 @@
+## 1.0.1 - October 7, 2024
+- Answers reset asked_for_what
+- Sanitize input
+
 ## 1.0.0 - September 24, 2024
 - First release

data/README.md

@@ -1,70 +1,70 @@
-# Gamefic::What
-
-A Gamefic extension for expanding commands with an additional argument.
-
-This extension is included in `gamefic-standard`.
-
-## Installation
-
-Add the library to your Gamefic project's Gemfile:
-
-```
-gem 'gamefic-what'
-```
-
-Run `bundle install`.
-
-Add the requirement to your project's code (typically in `main.rb`):
-
-```
-require 'gamefic-what'
-```
-
-## Usage
-
-Example code:
-
-```ruby
-class Gamefic::Actor
-  include Gamefic::What::Askable
-end
-
-class MyPlot < Gamefic::Plot
-  include Gamefic::What
-
-  attr_seed :room, Gamefic::Entity, name: 'room'
-  attr_seed :thing, Gamefic::Entity, name: 'thing'
-
-  introduction do |actor|
-    actor.parent = room
-    thing.parent = room
-  end
-
-  respond :take, available do |actor, thing|
-    thing.parent = actor
-    actor.tell "You take #{thing}."
-  end
-
-  respond :take do |actor|
-    actor.tell 'What do you want to take?'
-    actor.ask_for_what 'take', nil
-  end
-end
-```
-
-Example gameplay:
-
-    > take
-    What do you want to take?
-    > the thing
-    You take a thing.
-
-## 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 the created tag, 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/[USERNAME]/gamefic-what.
+# Gamefic::What
+
+A Gamefic extension for expanding commands with an additional argument.
+
+This extension is included in `gamefic-standard`.
+
+## Installation
+
+Add the library to your Gamefic project's Gemfile:
+
+```
+gem 'gamefic-what'
+```
+
+Run `bundle install`.
+
+Add the requirement to your project's code (typically in `main.rb`):
+
+```
+require 'gamefic-what'
+```
+
+## Usage
+
+Example code:
+
+```ruby
+class Gamefic::Actor
+  include Gamefic::What::Askable
+end
+
+class MyPlot < Gamefic::Plot
+  include Gamefic::What
+
+  attr_seed :room, Gamefic::Entity, name: 'room'
+  attr_seed :thing, Gamefic::Entity, name: 'thing'
+
+  introduction do |actor|
+    actor.parent = room
+    thing.parent = room
+  end
+
+  respond :take, available do |actor, thing|
+    thing.parent = actor
+    actor.tell "You take #{thing}."
+  end
+
+  respond :take do |actor|
+    actor.tell 'What do you want to take?'
+    actor.ask_for_what 'take', nil
+  end
+end
+```
+
+Example gameplay:
+
+    > take
+    What do you want to take?
+    > the thing
+    You take a thing.
+
+## 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 the created tag, 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/[USERNAME]/gamefic-what.

data/lib/gamefic/what/askable.rb

@@ -2,7 +2,26 @@
 
 module Gamefic
   module What
+    # A mixin for Active entities that enables
     module Askable
+      # Set a template to be populated with the player's answer.
+      #
+      # The template's placeholder for the answer can take two forms:
+      # 1. An array with a nil element: `ask_for_what :use, nil`
+      # 2. A `__what__` placeholder in a string: `ask_for_what "use __what__"`
+      #
+      # @example
+      #   class Example::Plot < Gamefic::Plot
+      #     respond :use, available do |actor, thing|
+      #       actor.tell "You use #{the thing}."
+      #     end
+      #
+      #     respond :use do |actor|
+      #       actor.tell "What do you want to use?"
+      #       actor.ask_for_what :use, nil
+      #     end
+      #   end
+      #
       # @param tokens [String, Array<String, nil>]
       def ask_for_what(*tokens)
         @asking_for_what = [tokens].flatten
@@ -10,10 +29,16 @@ module Gamefic
 
       attr_reader :asked_for_what
 
-      def set_asked_for_what
+      def answer_for_what(text = nil)
+        text = text&.gsub('__what__', 'what') # "Don't recurse" -- Heavy D.
+        command = text && asked_for_what&.map { |token| token || text }
+                                        &.join(' ')
+                                        &.gsub('__what__', text)
         @asked_for_what = @asking_for_what
         @asking_for_what = nil
+        command
       end
+      alias set_asked_for_what answer_for_what
     end
   end
 end

data/lib/gamefic/what/version.rb

@@ -2,6 +2,6 @@
 
 module Gamefic
   module What
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

data/lib/gamefic/what.rb

@@ -1,25 +1,22 @@
-# frozen_string_literal: true
-
-require 'gamefic/what/askable'
-require 'gamefic/what/version'
-
-module Gamefic
-  # A Gamefic extension for expanding commands with an additional argument.
-  #
-  module What
-    extend Gamefic::Scriptable
-
-    on_player_update(&:set_asked_for_what)
-
-    respond nil, plaintext do |actor, text|
-      if actor.asked_for_what
-        actor.perform actor.asked_for_what
-                           .map { |part| part ? part.to_s : text }
-                           .join(' ')
-                           .gsub('__what__', text)
-      else
-        actor.proceed
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'gamefic/what/askable'
+require 'gamefic/what/version'
+
+module Gamefic
+  # A Gamefic extension for expanding commands with an additional argument.
+  #
+  module What
+    extend Gamefic::Scriptable
+
+    on_player_update(&:answer_for_what)
+
+    respond nil, plaintext do |actor, text|
+      if (command = actor.answer_for_what(text))
+        actor.perform command
+      else
+        actor.proceed
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-what
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-24 00:00:00.000000000 Z
+date: 2024-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic