gamefic-standard 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 755a0c99a63ecce4d48bbbf7381e744c0b7bba4afe57d63c77a8d7febbeba51c
-  data.tar.gz: dcd68b55305fa872123273e76bec293bacf3b396608249291f483d3f01627bf9
+  metadata.gz: cc492bd7007da79a0370041571eda045f2d56c66987406001adb9609fa2272ff
+  data.tar.gz: 1f7d3bfaa885983d894b6eada5a752b629ca42183c96abcc22d7cf4f1f0c7a60
 SHA512:
-  metadata.gz: 19c17e7ae751826ef14a8533b406b2d9d978fbaad606949aebd2547f34a4a6ee7a901613e4d128694c784e8a8cf993b3c60d8cb6ba050de46a80e70455e0ff55
-  data.tar.gz: f10f11412b6128ec91057c060ef418fd54789cd9d616c24178b4e2c070f00cf5c4c478f56e49fe07eea029d29114c11df14566c1826d00bb962f7e581702cb13
+  metadata.gz: da8171873782d6fdea921d9a19981a581afb0e80913798ec969c2e9bd173ab73268ea3d1aff7e7d32f57dc969fa4d4ef3d386a36cb68a7a88220b7350082ad43
+  data.tar.gz: 3727672be7777bee08b33a79f3bee5fb2203e1cfe4ca140c6fa837b4b11d9cb4f2fadb35c7fb724bf7cae4a800382af6f240628141bede10bed053db184ae6c3

data/CHANGELOG.md

@@ -1,8 +1,25 @@
-# 2.2.0 - June 21, 2021
+## 2.3.1 - September 25, 2022
+- Handle leave actions without parents
+
+## 2.3.0 - September 4, 2021
+- Use nil actions for untokenized arguments
+- Fix response to closing closed entities
+- Working give action
+- Miscellaneous fixes for new specs
+- Search action
+- Separate actions from entities/modules
+- Remove clothing
+- Improve lockable behavior
+- Remove edible
+- Remove broken connect method
+- Leave action opens entered containers
+- Reduce entity inheritance
+
+## 2.2.0 - June 21, 2021
 - Insert, place, and wear try take first
 - Improved verb recognition
 - Openable doors
 
-# 2.1.0 - March 7, 2021
+## 2.1.0 - March 7, 2021
 - Remove sticky attribute
 - Use set_player_class

data/gamefic-standard.gemspec

@@ -35,7 +35,7 @@ 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.0', '>= 2.0.3'
+  spec.add_dependency 'gamefic', '~> 2.2'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'

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

@@ -0,0 +1,14 @@
+Gamefic.script do
+  respond :close, Use.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."
+    end
+  end
+end

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

@@ -1,10 +1,13 @@
 Gamefic.script do
-  respond :drop, Use.family() do |actor, thing|
-    if thing.parent != actor
-      actor.tell "You're not carrying #{the thing}."
-    else
-      actor.proceed
-    end
+  respond :drop, Use.available do |actor, thing|
+    actor.tell "You're not carrying #{the thing}."
+  end
+
+  respond :drop, Gamefic::Query::Descendants.new do |actor, thing|
+    actor.perform :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|

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

@@ -16,6 +16,10 @@ Gamefic.script do
     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
+
   interpret "get on :thing", "enter :thing"
   interpret "get in :thing", "enter :thing"
 end

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

@@ -1,27 +1,32 @@
 Gamefic.script do
   respond :go, Use.siblings(Portal) do |actor, portal|
-    if actor.parent != actor.room
-      actor.perform :leave
+    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.perform :look
     end
+  end
+
+  respond :go, Use.text do |actor, text|
     if actor.parent == actor.room
-      if portal.destination.nil?
-        actor.tell "That portal leads nowhere."
+      actor.tell "I don't see any way to go \"#{text} from here."
+    else
+      actor.perform :leave
+      if actor.parent == actor.room
+        actor.perform "go #{text}"
       else
-        actor.parent = portal.destination
-        if !portal.direction.nil?
-          actor.tell "You go #{portal.direction}."
-        end
-        actor.perform :look
+        actor.proceed
       end
     end
   end
 
-  respond :go, Use.text do |actor, string|
-    actor.tell "You don't see any exit \"#{string}\" from here."
-  end
-
-  respond :go do |actor|
-    actor.tell "Where do you want to go?"
+  respond :go, Use.available(Door) do |actor, door|
+    actor.perform :open, door unless door.open?
+    actor.proceed if door.open?
   end
 
   interpret "north", "go north"

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

@@ -10,6 +10,14 @@ Gamefic.script do
     actor.tell "You put #{the thing} in #{the receptacle}."
   end
 
+  respond :insert, Use.available, Use.available(Container) do |actor, _thing, container|
+    if container.open?
+      actor.proceed
+    else
+      actor.tell "#{The container} is closed."
+    end
+  end
+
   interpret "drop :item in :container", "insert :item :container"
   interpret "put :item in :container", "insert :item :container"
   interpret "place :item in :container", "insert :item :container"

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

@@ -8,6 +8,11 @@ Gamefic.script do
     actor.parent = thing.parent
   end
 
+  respond :leave, Use.parent(Supporter, :enterable?) do |actor, thing|
+    actor.tell "You get off #{the thing}."
+    actor.parent = thing.parent
+  end
+
   respond :leave, Use.room do |actor, room|
     portals = room.children.that_are(Portal)
     if portals.length == 0
@@ -20,7 +25,16 @@ Gamefic.script do
   end
 
   respond :leave do |actor|
-    actor.perform :leave, actor.parent
+    if actor.parent
+      actor.perform :leave, actor.parent
+    else
+      actor.tell "You don't see any obvious exits."
+    end
+  end
+
+  respond :leave, Use.parent(Container, :enterable?, :closed?) do |actor, container|
+    actor.perform :open, container
+    actor.proceed if container.open?
   end
 
   interpret "exit", "leave"

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

@@ -0,0 +1,21 @@
+Gamefic.script do
+  respond :lock, Use.available do |actor, thing|
+    actor.tell "You can't lock #{the thing}."
+  end
+
+  respond :lock, Use.available(Lockable, :has_lock_key?), Use.children do |actor, thing, key|
+    if thing.lock_key == key
+      thing.locked = true
+      actor.tell "You lock ##{the thing} with #{the key}."
+    else
+      actor.tell "You can't lock #{the thing} with #{the key}."
+    end
+  end
+
+  respond :lock, Use.available(Lockable, :has_lock_key?), Use.available do |actor, thing, key|
+    actor.perform :take, key if key.parent != actor
+    actor.proceed if key.parent == actor
+  end
+
+  interpret "lock :container with :key", "lock :container :key"
+end

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

@@ -1,8 +1,4 @@
 Gamefic.script do
-  respond :look, Use.text do |actor, string|
-    actor.tell "You don't see any \"#{string}\" here."
-  end
-
   respond :look, Use.text(/^here$/i) do |actor, _|
     actor.perform :look, actor.room
   end
@@ -14,9 +10,9 @@ Gamefic.script do
 
   respond :look, Use.available(Thing) do |actor, thing|
     actor.tell thing.description
-    thing.children.that_are(:attached?).that_are(:itemized?).each { |item|
+    thing.children.that_are(:attached?).that_are(:itemized?).each do |item|
       actor.tell "#{An item} is attached to #{the thing}."
-    }
+    end
   end
 
   respond :look, Use.available(Supporter) do |actor, thing|
@@ -40,6 +36,11 @@ Gamefic.script do
     actor.tell "You are currently on #{the supporter}."
   end
 
+  respond :look, Use.available(Thing, Openable) do |actor, thing|
+    actor.proceed
+    actor.tell "#{The thing} is #{thing.open? ? 'open' : 'closed'}."
+  end
+
   respond :look, Use.room do |actor, room|
     actor.tell "<strong>#{room.name.cap_first}</strong>"
     actor.tell room.description if room.has_description?
@@ -52,13 +53,13 @@ Gamefic.script do
     with_locales = []
     chars = room.children.that_are(Character).that_are(:itemized?) - [actor]
     charsum = []
-    chars.each { |char|
+    chars.each do |char|
       if char.locale_description.nil?
         charsum.push char
       else
         with_locales.push char
       end
-    }
+    end
     if charsum.length > 0
       actor.tell "#{charsum.join_and.cap_first} #{charsum.length == 1 ? 'is' : 'are'} here."
     end
@@ -85,9 +86,9 @@ Gamefic.script do
           actor.tell "There is an exit #{p.instruction}."
         else
           dirs = []
-          portals.each { |p|
+          portals.each do |p|
             dirs.push p.instruction
-          }
+          end
           actor.tell "There are exits #{dirs.join_and(', ')}."
         end
       end

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

@@ -7,7 +7,13 @@ Gamefic.script do
       if words.length > 1
         found = Gamefic::Query::Available.new.resolve(actor, words[1..-1].join(' ')).objects
         if found.empty?
-          actor.tell %(I recognize "#{words[0]}" as a verb but could not understand the rest of your sentence.)
+          actions = []
+          actor.playbooks.reverse.each { |p| actions.concat p.actions_for(words[0].to_sym) }
+          if actions.any? { |a| a.queries.one? && !a.queries.first.is_a?(Gamefic::Query::Text) }
+            actor.tell %(I recognize "#{words[0]}" as a verb but don't know what you mean by "#{words[1..-1].join(' ')}.")
+          else
+            actor.tell %(I recognize "#{words[0]}" as a verb but could not understand the rest of your sentence.)
+          end
         elsif found.one?
           actor.tell %(I recognize "#{words[0]}" and "#{found.first.name}" but could not understand them together.)
         else
@@ -20,13 +26,4 @@ Gamefic.script do
       actor.tell %(I don't recognize "#{words[0]}" as a verb.)
     end
   end
-
-  meta nil, Gamefic::Query::Text.new(/^it$/) do |actor, string|
-    words = string.split_words
-    if verbs(to_s: true).include?(words[0])
-      actor.tell "I'm not sure what you mean by \"it.\""
-    else
-      actor.proceed
-    end
-  end
 end

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

@@ -0,0 +1,29 @@
+Gamefic.script do
+  respond :open, Use.available do |actor, thing|
+    actor.tell "You can't open #{the thing}."
+  end
+
+  respond :open, Use.available(Openable) do |actor, thing|
+    if thing.open?
+      actor.tell "#{The thing} is already open."
+    else
+      actor.tell "You open #{the thing}."
+      thing.open = true
+    end
+  end
+
+  respond :open, Use.available(Lockable) do |actor, thing|
+    if thing.locked?
+      actor.tell "#{The thing} is locked."
+    else
+      actor.proceed
+    end
+  end
+
+  respond :open, Use.available(Lockable, :has_lock_key?), Use.available do |actor, thing, key|
+    actor.perform :unlock, thing, key
+    actor.perform :open, thing if thing.unlocked?
+  end
+
+  interpret 'open :thing with :key', 'open :thing :key'
+end

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

@@ -15,22 +15,10 @@ Gamefic.script do
     actor.tell "You put #{the thing} on #{the supporter}."
   end
 
-  respond :place, Use.visible, Use.text do |actor, _thing, supporter|
-    actor.tell "You don't see anything called \"#{supporter}\" here."
-  end
-
-  respond :place, Use.text, Use.visible do |actor, thing, supporter|
-    actor.tell "You don't see anything called \"#{thing}\" here."
-  end
-
-  respond :place, Use.text, Use.text do |actor, thing, supporter|
-    actor.tell "I don't know what you mean by \"#{thing}\" or \"#{supporter}.\""
-  end
-
-  interpret "put :thing on :supporter", "place :thing :supporter"
-  interpret "put :thing down on :supporter", "place :thing :supporter"
-  interpret "set :thing on :supporter", "place :thing :supporter"
-  interpret "set :thing down on :supporter", "place :thing :supporter"
-  interpret "drop :thing on :supporter", "place :thing :supporter"
-  interpret "place :thing on :supporter", "place :thing :supporter"
+  interpret 'put :thing on :supporter', 'place :thing :supporter'
+  interpret 'put :thing down on :supporter', 'place :thing :supporter'
+  interpret 'set :thing on :supporter', 'place :thing :supporter'
+  interpret 'set :thing down on :supporter', 'place :thing :supporter'
+  interpret 'drop :thing on :supporter', 'place :thing :supporter'
+  interpret 'place :thing on :supporter', 'place :thing :supporter'
 end

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

@@ -0,0 +1,26 @@
+Gamefic.script do
+  respond :search, Use.available(Thing) do |actor, thing|
+    actor.perform :look, thing
+  end
+
+  respond :search, Use.available(Receptacle) do |actor, thing|
+    if thing.accessible?
+      itemized = thing.children.that_are_not(:attached?).that_are(:itemized?)
+      if itemized.empty?
+        actor.tell "There's nothing inside #{the thing}."
+      else
+        actor.tell "You see #{itemized.join_and} in #{the thing}." unless itemized.empty?
+      end
+    else
+      actor.tell "You can't see inside #{the thing}."
+    end
+  end
+
+  respond :search, Use.available(Container, :closed?) do |actor, container|
+    actor.perform :open, container
+    actor.proceed if container.open?
+  end
+
+  interpret 'look inside :thing', 'search :thing'
+  interpret 'look in :thing', 'search :thing'
+end

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

@@ -1,8 +1,4 @@
 Gamefic.script do
-  respond :take, Use.text do |actor, text|
-    actor.tell "You don't see any \"#{text}\" here."
-  end
-
   respond :take, Use.available do |actor, thing|
     if thing.parent == actor
       actor.tell "You're already carrying #{the thing}."

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

@@ -12,11 +12,7 @@ Gamefic.script do
   end
 
   respond :talk, Use.available(Character) do |actor, character|
-    if actor == character
-      actor.perform :talk
-    else
-      actor.tell "#{The character} has nothing to say."
-    end
+    actor.tell "#{The character} has nothing to say."
   end
 
   interpret "talk to :character", "talk :character"

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

@@ -0,0 +1,21 @@
+Gamefic.script do
+  respond :unlock, Use.available do |actor, thing|
+    actor.tell "You can't unlock #{the thing}."
+  end
+
+  respond :unlock, Use.available(Lockable, :has_lock_key?), Use.children do |actor, thing, key|
+    if thing.lock_key == key
+      thing.locked = false
+      actor.tell "You unlock ##{the thing} with #{the key}."
+    else
+      actor.tell "You can't unlock #{the thing} with #{the key}."
+    end
+  end
+
+  respond :unlock, Use.available(Lockable, :has_lock_key?), Use.available do |actor, _thing, key|
+    actor.perform :take, key if key.parent != actor
+    actor.proceed if key.parent == actor
+  end
+
+  interpret "unlock :container with :key", "unlock :container :key"
+end

data/lib/gamefic-standard/actions.rb

@@ -1,11 +1,16 @@
 require 'gamefic-standard/actions/nil'
 require 'gamefic-standard/actions/drop'
 require 'gamefic-standard/actions/enter'
+require 'gamefic-standard/actions/open'
+require 'gamefic-standard/actions/close'
+require 'gamefic-standard/actions/lock'
+require 'gamefic-standard/actions/unlock'
 require 'gamefic-standard/actions/go'
 require 'gamefic-standard/actions/insert'
 require 'gamefic-standard/actions/inventory'
 require 'gamefic-standard/actions/leave'
 require 'gamefic-standard/actions/look'
+require 'gamefic-standard/actions/search'
 require 'gamefic-standard/actions/place'
 require 'gamefic-standard/actions/quit'
 require 'gamefic-standard/actions/take'

data/lib/gamefic-standard/entities/character.rb

@@ -1,11 +1,2 @@
-class Character < Thing
-  include Gamefic::Active
-
-  def gender
-    @gender ||= :other
-  end
-end
-
-Gamefic.script do
-  set_player_class Character
-end
+Character = Gamefic::Actor
+Character.set_default gender: :other

data/lib/gamefic-standard/entities/container.rb

@@ -0,0 +1,6 @@
+# An openable and lockable receptacle.
+#
+class Container < Receptacle
+  include Openable
+  include Lockable
+end

data/lib/gamefic-standard/{door.rb → entities/door.rb}

@@ -1,5 +1,3 @@
-require 'gamefic-standard/openable'
-
 # An openable portal.
 #
 class Door < Portal
@@ -40,10 +38,3 @@ class Door < Portal
     rev.locked = locked?
   end
 end
-
-Gamefic.script do
-  respond :go, Use.available(Door) do |actor, door|
-    actor.perform :open, door unless door.open?
-    actor.proceed if door.open?
-  end
-end

data/lib/gamefic-standard/entities/room.rb

@@ -8,9 +8,7 @@ class Room < Thing
   end
 
   def tell(message)
-    children.each { |c|
-      c.tell message
-    }
+    children.each { |c| c.tell message }
   end
 
   def find_portal(direction)
@@ -61,15 +59,3 @@ module Gamefic::World
     portal
   end
 end
-
-Room.module_exec self do |plot|
-  # Define the connect method dynamically so the plot is available
-  define_method :connect do |destination, direction = nil, type: Portal, two_way: true|
-    plot.connect self, destination, direction, type: Portal, two_way: true
-  end
-end
-class Room
-  # @!method connect destination, direction = nil, type: Portal, two_way: true
-  #   Create a portal to connect this room to a destination.
-  #   @return [Portal]
-end

data/lib/gamefic-standard/entities/thing.rb

@@ -1,64 +1,7 @@
-class Thing < Gamefic::Entity
+class Gamefic::Entity
   include Grammar::Attributes
-
-  # @return [Boolean]
-  attr_writer :itemized
-
-  # @return [Boolean]
-  attr_writer :portable
-
-  # An optional description to use when itemizing entities in room
-  # descriptions. The locale_description will be used instead of adding
-  # the entity's name to a list.
-  #
-  # @return [String, nil]
-  attr_accessor :locale_description
-
-  set_default itemized: true
-  set_default portable: false
-
-  # Itemized entities are automatically listed in room descriptions.
-  #
-  # @return [Boolean]
-  def itemized?
-    @itemized
-  end
-
-  # Portable entities can be taken with TAKE actions.
-  #
-  # @return [Boolean]
-  def portable?
-    @portable
-  end
-
-  # @return [Boolean]
-  def attached?
-    @attached ||= false
-  end
-
-  # @param bool [Boolean]
-  def attached= bool
-    @attached = if parent.nil?
-      # @todo Log attachment failure
-      false
-    else
-      bool
-    end
-  end
-
-  def parent= new_parent
-    self.attached = false unless new_parent == parent
-    super
-  end
-
-  # The entity's parent room (i.e., the closest ascendant that is a Room).
-  #
-  # @return [Room]
-  def room
-    p = parent
-    until p.is_a?(Room) or p.nil?
-      p = p.parent
-    end
-    p
-  end
+  include Standardized
 end
+
+Thing = Gamefic::Entity
+Thing.set_default itemized: true, portable: false

data/lib/gamefic-standard/entities.rb

@@ -3,7 +3,9 @@ require 'gamefic-standard/entities/character'
 require 'gamefic-standard/entities/fixture'
 require 'gamefic-standard/entities/item'
 require 'gamefic-standard/entities/portal'
+require 'gamefic-standard/entities/door'
 require 'gamefic-standard/entities/receptacle'
+require 'gamefic-standard/entities/container'
 require 'gamefic-standard/entities/room'
 require 'gamefic-standard/entities/scenery'
 require 'gamefic-standard/entities/rubble'

data/lib/gamefic-standard/give.rb

@@ -1,23 +1,20 @@
-# @gamefic.script standard/give
-
-respond :give, Use.available, Gamefic::Query::Children.new do |actor, _character, gift|
-  actor.tell "Nothing happens."
-end
+Gamefic.script do
+  respond :give, Use.available, Gamefic::Query::Children.new do |actor, _character, _gift|
+    actor.tell 'Nothing happens.'
+  end
 
-respond :give, Use.available(Character), Use.available do |actor, character, gift|
-  actor.tell "#{The character} doesn't want #{the gift}."
-end
+  respond :give, Use.available(Character), Use.available do |actor, character, gift|
+    actor.tell "#{The character} doesn't want #{the gift}."
+  end
 
-respond :give, Use.available(Character), Use.available do |actor, _character, gift|
-  if gift.parent == actor
-    actor.proceed
-  else
-    actor.tell "You don't have #{the gift}."
+  respond :give, Use.available(Character), Use.available do |actor, _character, gift|
+    if gift.parent != actor
+      actor.perform :take, gift
+    end
+    if gift.parent == actor
+      actor.proceed
+    end
   end
-end
 
-respond :give, Use.text, Use.available do |actor, character, _gift|
-  actor.tell "You don't see any \"#{character}\" here."
+  interpret 'give :gift to :character', 'give :character :gift'
 end
-
-interpret "give :gift to :character", "give :character :gift"