gamefic-standard 2.2.0 → 2.3.1

data/lib/gamefic-standard/modules/lockable.rb

@@ -0,0 +1,32 @@
+# A module for entities that are both openable and lockable.
+#
+module Lockable
+  include Openable
+
+  attr_accessor :lock_key
+
+  def locked=(bool)
+    @locked = bool
+    if @locked == true
+      self.open = false
+    end
+  end
+
+  def open=(bool)
+    @open = bool
+    @locked = false if @open == true
+  end
+
+  def locked?
+    @locked ||= false
+  end
+
+  def unlocked?
+    !locked?
+  end
+
+  def lock_key?
+    !@lock_key.nil?
+  end
+  alias has_lock_key? lock_key?
+end

data/lib/gamefic-standard/modules/openable.rb

@@ -0,0 +1,19 @@
+# A module for entities that are openable.
+#
+module Openable
+  def open= bool
+    @open = bool
+  end
+
+  def open?
+    @open ||= false
+  end
+
+  def closed?
+    !open?
+  end
+
+  def accessible?
+    open?
+  end
+end

data/lib/gamefic-standard/modules/standardized.rb

@@ -0,0 +1,59 @@
+module Standardized
+  # @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
+
+  # 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
+end

data/lib/gamefic-standard/modules.rb

@@ -3,5 +3,8 @@
 # portals between rooms.
 #
 
+require 'gamefic-standard/modules/standardized'
 require 'gamefic-standard/modules/use'
 require 'gamefic-standard/modules/enterable'
+require 'gamefic-standard/modules/openable'
+require 'gamefic-standard/modules/lockable'

data/lib/gamefic-standard/pathfinder.rb

@@ -1,9 +1,7 @@
-# @gamefic.script standard/pathfinder
 #   Pathfinders provide the shortest route between two locations. The
 #   destination needs to be accessible from the origin through portals. Note
 #   that Pathfinders do not take into account portals that characters should
 #   not be able to traverse, such as locked doors.
-
 class Pathfinder
   # @return [Room]
   attr_reader :origin

data/lib/gamefic-standard/queries.rb

@@ -6,10 +6,10 @@ class Gamefic::Query::Available < Gamefic::Query::Base
       result.concat subquery_accessible(top)
     end
     result.delete subject
-    subject.children.each { |c|
+    subject.children.each do |c|
       result.push c
       result.concat subquery_accessible(c)
-    }
+    end
     result
   end
 end

data/lib/gamefic-standard/test.rb

@@ -1,5 +1,3 @@
-# @gamefic.script standard/test
-
 module Tester
   def test_procs
     @test_procs ||= Hash.new

data/lib/gamefic-standard/version.rb

@@ -1,5 +1,5 @@
 module Gamefic
   module Standard
-    VERSION = '2.2.0'
+    VERSION = '2.3.1'
   end
 end

data/lib/gamefic-standard.rb

@@ -8,5 +8,3 @@ require 'gamefic-standard/modules'
 require 'gamefic-standard/direction'
 require 'gamefic-standard/entities'
 require 'gamefic-standard/actions'
-require 'gamefic-standard/container'
-require 'gamefic-standard/door'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-standard
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2022-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,40 +102,30 @@ files:
 - gamefic-standard.gemspec
 - lib/gamefic-standard.rb
 - lib/gamefic-standard/actions.rb
+- lib/gamefic-standard/actions/close.rb
 - lib/gamefic-standard/actions/drop.rb
 - lib/gamefic-standard/actions/enter.rb
 - lib/gamefic-standard/actions/go.rb
 - lib/gamefic-standard/actions/insert.rb
 - lib/gamefic-standard/actions/inventory.rb
 - lib/gamefic-standard/actions/leave.rb
+- lib/gamefic-standard/actions/lock.rb
 - lib/gamefic-standard/actions/look.rb
 - lib/gamefic-standard/actions/nil.rb
+- lib/gamefic-standard/actions/open.rb
 - lib/gamefic-standard/actions/place.rb
 - lib/gamefic-standard/actions/quit.rb
+- lib/gamefic-standard/actions/search.rb
 - lib/gamefic-standard/actions/take.rb
 - lib/gamefic-standard/actions/talk.rb
+- lib/gamefic-standard/actions/unlock.rb
 - lib/gamefic-standard/actions/wait.rb
 - lib/gamefic-standard/articles.rb
-- lib/gamefic-standard/clothing.rb
-- lib/gamefic-standard/clothing/actions.rb
-- lib/gamefic-standard/clothing/actions/doff.rb
-- lib/gamefic-standard/clothing/actions/drop.rb
-- lib/gamefic-standard/clothing/actions/inventory.rb
-- lib/gamefic-standard/clothing/actions/wear.rb
-- lib/gamefic-standard/clothing/entities.rb
-- lib/gamefic-standard/clothing/entities/clothing.rb
-- lib/gamefic-standard/clothing/entities/coat.rb
-- lib/gamefic-standard/clothing/entities/gloves.rb
-- lib/gamefic-standard/clothing/entities/hat.rb
-- lib/gamefic-standard/clothing/entities/pants.rb
-- lib/gamefic-standard/clothing/entities/shirt.rb
-- lib/gamefic-standard/clothing/entities/shoes.rb
-- lib/gamefic-standard/container.rb
 - lib/gamefic-standard/direction.rb
-- lib/gamefic-standard/door.rb
-- lib/gamefic-standard/edible.rb
 - lib/gamefic-standard/entities.rb
 - lib/gamefic-standard/entities/character.rb
+- lib/gamefic-standard/entities/container.rb
+- lib/gamefic-standard/entities/door.rb
 - lib/gamefic-standard/entities/fixture.rb
 - lib/gamefic-standard/entities/item.rb
 - lib/gamefic-standard/entities/portal.rb
@@ -155,11 +139,12 @@ files:
 - lib/gamefic-standard/grammar.rb
 - lib/gamefic-standard/grammar/attributes.rb
 - lib/gamefic-standard/grammar/pronoun.rb
-- lib/gamefic-standard/lockable.rb
 - lib/gamefic-standard/modules.rb
 - lib/gamefic-standard/modules/enterable.rb
+- lib/gamefic-standard/modules/lockable.rb
+- lib/gamefic-standard/modules/openable.rb
+- lib/gamefic-standard/modules/standardized.rb
 - lib/gamefic-standard/modules/use.rb
-- lib/gamefic-standard/openable.rb
 - lib/gamefic-standard/pathfinder.rb
 - lib/gamefic-standard/queries.rb
 - lib/gamefic-standard/test.rb
@@ -183,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: The Gamefic standard script library.

data/lib/gamefic-standard/clothing/actions/doff.rb

@@ -1,14 +0,0 @@
-Gamefic.script do
-  respond :doff, Gamefic::Query::Children.new(Clothing) do |actor, clothing|
-    if !clothing.attached?
-      actor.tell "You're not wearing #{the clothing}."
-    else
-      clothing.attached = false
-      actor.tell "You take off #{the clothing}."
-    end
-  end
-
-  interpret "remove :clothing", "doff :clothing"
-  interpret "take off :clothing", "doff :clothing"
-  interpret "take :clothing off", "doff :clothing"
-end

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

@@ -1,10 +0,0 @@
-Gamefic.script do
-  respond :drop, Gamefic::Query::Children.new(Clothing) do |actor, clothing|
-    if clothing.attached?
-      actor.perform :doff, clothing
-    end
-    if !clothing.attached?
-      actor.proceed
-    end
-  end
-end

data/lib/gamefic-standard/clothing/actions/inventory.rb

@@ -1,16 +0,0 @@
-Gamefic.script do
-  respond :inventory do |actor|
-    if actor.children.length > 0
-      carried = actor.children.that_are_not(:attached?)
-      worn = actor.children.that_are(:attached?)
-      if carried.length > 0
-        actor.tell "You are carrying #{carried.join_and}."
-      end
-      if worn.length > 0
-        actor.tell "You are wearing #{worn.join_and}."
-      end
-    else
-      actor.tell "You aren't carrying anything."
-    end
-  end
-end

data/lib/gamefic-standard/clothing/actions/wear.rb

@@ -1,21 +0,0 @@
-Gamefic.script do
-  respond :wear, Use.available(Clothing) do |actor, clothing|
-    actor.perform :take, clothing unless clothing.parent == actor
-    next unless clothing.parent == actor
-    if clothing.attached?
-      actor.tell "You're already wearing #{the clothing}."
-    else
-      already = actor.children.that_are(clothing.class).that_are(:attached?)
-      if already.length == 0
-        clothing.attached = true
-        actor.tell "You put on #{the clothing}."
-      else
-        actor.tell "You're already wearing #{an already[0]}."
-      end
-    end
-  end
-
-  interpret "put on :clothing", "wear :clothing"
-  interpret "put :clothing on", "wear :clothing"
-  interpret "don :clothing", "wear :clothing"
-end

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

@@ -1,4 +0,0 @@
-require 'gamefic-standard/clothing/actions/doff'
-require 'gamefic-standard/clothing/actions/drop'
-require 'gamefic-standard/clothing/actions/inventory'
-require 'gamefic-standard/clothing/actions/wear'

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

@@ -1,5 +0,0 @@
-class Clothing < Item
-  def worn?
-    self.parent.kind_of?(Character) and self.attached?
-  end
-end

data/lib/gamefic-standard/clothing/entities/coat.rb

@@ -1,3 +0,0 @@
-class Coat < Clothing
-
-end

data/lib/gamefic-standard/clothing/entities/gloves.rb

@@ -1,3 +0,0 @@
-class Gloves < Clothing
-
-end

data/lib/gamefic-standard/clothing/entities/hat.rb

@@ -1,3 +0,0 @@
-class Hat < Clothing
-
-end

data/lib/gamefic-standard/clothing/entities/pants.rb

@@ -1,3 +0,0 @@
-class Pants < Clothing
-
-end

data/lib/gamefic-standard/clothing/entities/shirt.rb

@@ -1,3 +0,0 @@
-class Shirt < Clothing
-
-end

data/lib/gamefic-standard/clothing/entities/shoes.rb

@@ -1,3 +0,0 @@
-class Shoes < Clothing
-
-end

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

@@ -1,7 +0,0 @@
-require 'gamefic-standard/clothing/entities/clothing'
-require 'gamefic-standard/clothing/entities/coat'
-require 'gamefic-standard/clothing/entities/gloves'
-require 'gamefic-standard/clothing/entities/hat'
-require 'gamefic-standard/clothing/entities/pants'
-require 'gamefic-standard/clothing/entities/shirt'
-require 'gamefic-standard/clothing/entities/shoes'

data/lib/gamefic-standard/clothing.rb

@@ -1,4 +0,0 @@
-# @gamefic.script standard/clothing
-
-require 'gamefic-standard/clothing/entities'
-require 'gamefic-standard/clothing/actions'

data/lib/gamefic-standard/container.rb

@@ -1,27 +0,0 @@
-require 'gamefic-standard/openable'
-require 'gamefic-standard/lockable'
-
-# An openable and lockable receptacle.
-#
-class Container < Receptacle
-  include Openable
-  include Lockable
-end
-
-Gamefic.script do
-  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
-
-  respond :leave, Use.parent(Container, :enterable?, :closed?) do |actor, container|
-    actor.tell "#{The container} is closed."
-  end
-
-  respond :enter, Use.siblings(Container, :enterable?, :closed?) do |actor, container|
-    actor.tell "#{The container} is closed."
-  end
-end

data/lib/gamefic-standard/edible.rb

@@ -1,23 +0,0 @@
-# @gamefic.script standard/edible
-
-module Edibility
-  attr_writer :edible
-  def edible?
-    @edible ||= false
-  end
-end
-
-class Thing
-  include Edibility
-end
-
-Gamefic.script do
-  respond :eat, Use.available do |actor, item|
-    actor.tell "You can't eat #{the item}."
-  end
-
-  respond :eat, Use.available(:edible?) do |actor, item|
-    actor.tell "You eat #{the item}."
-    destroy item
-  end
-end

data/lib/gamefic-standard/lockable.rb

@@ -1,98 +0,0 @@
-# @gamefic.script standard/lockable
-
-require 'gamefic-standard/openable'
-
-# A module for entities that are both openable and lockable.
-#
-module Lockable
-  include Openable
-
-  attr_accessor :lock_key
-
-  def locked=(bool)
-    @locked = bool
-    if @locked == true
-      self.open = false
-    end
-  end
-
-  def open=(bool)
-    @open = bool
-    @locked = false if @open == true
-  end
-
-  def locked?
-    @locked ||= false
-  end
-
-  def unlocked?
-    !locked?
-  end
-
-  def lock_key?
-    !@lock_key.nil?
-  end
-  alias has_lock_key? lock_key?
-end
-
-Gamefic.script do
-  respond :lock, Use.available do |actor, thing|
-    actor.tell "You can't lock #{the thing}."
-  end
-
-  respond :_toggle_lock, Use.available(Lockable, :has_lock_key?) do |actor, thing|
-    verb = thing.locked? ? 'unlock' : 'lock'
-    key = nil
-    if thing.lock_key.parent == actor
-      key = thing.lock_key
-    end
-    if key.nil?
-      actor.tell "You don't have any way to #{verb} #{the thing}."
-    else
-      actor.tell "You #{verb} #{the thing} with #{the key}."
-      thing.locked = !thing.locked?
-    end
-  end
-
-  respond :lock, Use.available(Lockable, :has_lock_key?), Use.children do |actor, thing, key|
-    if thing.lock_key == key
-      actor.perform :_toggle_lock, thing
-    else
-      actor.tell "You can't unlock #{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
-
-  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
-      actor.perform :_toggle_lock, thing
-    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
-
-  respond :open, Use.available(Lockable) do |actor, thing|
-    if thing.locked?
-      actor.tell "#{The thing} is locked."
-    else
-      actor.proceed
-    end
-  end
-
-  interpret "lock :container with :key", "lock :container :key"
-  interpret "unlock :container with :key", "unlock :container :key"
-  interpret "open :container with :key", "unlock :container :key"
-end

data/lib/gamefic-standard/openable.rb

@@ -1,54 +0,0 @@
-# @gamefic.script standard/openable
-
-# A module for entities that are openable.
-#
-module Openable
-  def open= bool
-    @open = bool
-  end
-
-  def open?
-    @open ||= false
-  end
-
-  def closed?
-    !open?
-  end
-
-  def accessible?
-    open?
-  end
-end
-
-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 :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 open."
-    end
-  end
-
-  respond :look, Use.available(Thing, Openable) do |actor, thing|
-    actor.proceed
-    actor.tell "#{The thing} is #{thing.open? ? 'open' : 'closed'}."
-  end
-end