gamefic-standard 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ad2cabfd4a0d81673d3ec48454ea842e5d5f68b5bb621b7b685b9d01d20ad16
-  data.tar.gz: 32e4c483f7a04eebe5bdec3e85f37a90341f2a3afe8f2e879bcda9808956ee31
+  metadata.gz: bb3b66cc12abfb8e46bd9b9fb042d2aeb34a0cdd1bd13b0c9865bee9493a5f54
+  data.tar.gz: c9e3e7f515bcf2b294ace5171fe0f843d8298135338f53950cca0e3468437ffe
 SHA512:
-  metadata.gz: 7c7cb2add780225ba638fba5d266abf2abdeabc4c01a5c0a55e6fdbd4c42a76d43c84f0ce20c8fc3807bb180553aa3570c448c1544b744e39ca06fbf392e8225
-  data.tar.gz: fe1479675ff888e72be337f5eb6f206b677a7fe5442cd343ed1442a48ef6079dcff3ddafce156e6e69c595282241133ccb7d6de3c99d1c2aed375144ebc177cf
+  metadata.gz: fc292cde7a1465c88a64bf17c13e1f9124ed98ed59382258b878d1a56bbafd890f818568cca80f0a72a11a30e45acceb6a1c9982b6847498cc6d12c0d9ae35e4
+  data.tar.gz: e4d588d264b1f1ff8a4f189de4736f5d4cf10361d1f145401e20987a1e4eac08a44e46af8a0cd34487421faea7f346846c511f893088237b985d62dacb9aadd9

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 4.1.0 - February 1, 2026
+- In and out directions
+- Room#connect= accepts hashes
+- Portal type names
+- Implicit taking
+- Piped words in syntaxes
+- Look#itemize_parent skips parent rooms
+
+## 4.0.1 - May 26, 2025
+- Fix lock/unlock actions
+
 ## 4.0.0 - January 25, 2025
 - Updates for Gamefic 4.0
 

data/gamefic-standard.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.7.0'
 
-  spec.add_dependency 'gamefic', '~> 4.0'
+  spec.add_dependency 'gamefic', '~> 4.2', '>= 4.2.1'
   spec.add_dependency 'gamefic-grammar', '~> 1.1'
   spec.add_dependency 'gamefic-what', '~> 2.0'
 

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

@@ -23,11 +23,8 @@ module Gamefic
           actor.tell "#{The container} is closed."
         end
 
-        interpret 'get in :thing', 'enter :thing'
-        interpret 'get inside :thing', 'enter :thing'
-        interpret 'sit in :thing', 'enter :thing'
-        interpret 'lie in :thing', 'enter :thing'
-        interpret 'stand in :thing', 'enter :thing'
+        interpret 'get in|inside :thing', 'enter :thing'
+        interpret 'sit|lie|stand in|inside :thing', 'enter :thing'
       end
     end
   end

data/lib/gamefic/standard/actions/give.rb

@@ -16,9 +16,7 @@ module Gamefic
         end
 
         respond :give, available(Character), available do |actor, _character, gift|
-          actor.execute :take, gift if gift.parent != actor
-
-          actor.proceed if gift.parent == actor
+          actor.proceed if actor.have_or_take(gift)
         end
 
         respond :give, Thing do |actor, thing|

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

@@ -11,8 +11,7 @@ module Gamefic
         end
 
         respond :insert, available, available(Receptacle) do |actor, thing, receptacle|
-          actor.execute :take, thing unless thing.parent == actor
-          next unless thing.parent == actor
+          next unless actor.have_or_take(thing)
 
           thing.parent = receptacle
           actor.tell "You put #{the thing} in #{the receptacle}."
@@ -30,23 +29,16 @@ module Gamefic
           actor.execute :drop, thing
         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'
-        interpret 'set :item in :container', 'insert :item :container'
-        interpret 'insert :item in :container', 'insert :item :container'
-
-        interpret 'drop :item inside :container', 'insert :item :container'
-        interpret 'put :item inside :container', 'insert :item :container'
-        interpret 'place :item inside :container', 'insert :item :container'
-        interpret 'set :item inside :container', 'insert :item :container'
-        interpret 'insert :item inside :container', 'insert :item :container'
-
-        interpret 'drop :item into :container', 'insert :item :container'
-        interpret 'put :item into :container', 'insert :item :container'
-        interpret 'place :item into :container', 'insert :item :container'
-        interpret 'set :item into :container', 'insert :item :container'
-        interpret 'insert :item into :container', 'insert :item :container'
+        interpret 'drop :item :container', 'insert :item :container'
+        interpret 'put :item :container', 'insert :item :container'
+        interpret 'place :item :container', 'insert :item :container'
+        interpret 'set :item :container', 'insert :item :container'
+
+        interpret 'insert :item in|inside|into :container', 'insert :item :container'
+        interpret 'drop :item in|inside|into :container', 'insert :item :container'
+        interpret 'put :item in|inside|into :container', 'insert :item :container'
+        interpret 'place :item in|inside|into :container', 'insert :item :container'
+        interpret 'set :item in|inside|into :container', 'insert :item :container'
       end
     end
   end

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

@@ -47,9 +47,7 @@ module Gamefic
         interpret 'exit', 'leave'
         interpret 'exit :supporter', 'leave :supporter'
         interpret 'get on :supporter', 'enter :supporter'
-        interpret 'get off :supporter', 'leave :supporter'
-        interpret 'get out :container', 'leave :container'
-        interpret 'get out of :container', 'leave :container'
+        interpret 'get (off|out|out of) :supporter', 'leave :supporter'
         interpret 'out', 'leave'
       end
     end

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

@@ -10,21 +10,32 @@ module Gamefic
           actor.tell "You can't lock #{the thing}."
         end
 
+        respond :lock, available(Lockable) do |actor, thing|
+          if thing.has_lock_key? && actor.children.include?(thing.lock_key)
+            actor.execute :lock, thing, thing.lock_key
+          else
+            actor.tell "You can't lock #{the thing}."
+          end
+        end
+
         respond :lock, available(Lockable, proc(&:has_lock_key?)), children do |actor, thing, key|
           if thing.lock_key == key
-            thing.locked = true
-            actor.tell "You lock ##{the thing} with #{the key}."
+            if thing.locked?
+              actor.tell "It's already locked."
+            else
+              thing.locked = true
+              actor.tell "You lock #{the thing} with #{the key}."
+            end
           else
             actor.tell "You can't lock #{the thing} with #{the key}."
           end
         end
 
-        respond :lock, available(Lockable, proc(&:has_lock_key?)), available do |actor, thing, key|
-          actor.execute :take, key if key.parent != actor
-          actor.proceed if key.parent == actor
+        respond :lock, available(Lockable, proc(&:has_lock_key?)), available do |actor, _thing, key|
+          actor.proceed if actor.have_or_take(key)
         end
 
-        interpret "lock :container with :key", "lock :container :key"  
+        interpret 'lock :container with :key', 'lock :container :key'
       end
     end
   end

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

@@ -32,7 +32,7 @@ module Gamefic
                   .each { |thing| actor.tell thing.locale_description }
 
           itemize_explicit_portals(actor)
-          itemize_parent(actor) unless actor.parent == actor.room
+          itemize_parent(actor)
         end
 
         def itemize_explicit_portals(actor)
@@ -58,7 +58,8 @@ module Gamefic
         end
 
         def itemize_parent(actor)
-          return unless (parent = actor.parent)
+          parent = actor.parent if parent != actor.room
+          return unless parent
 
           siblings = parent.children.that_are_not(actor)
           if siblings.empty?
@@ -130,15 +131,10 @@ module Gamefic
           itemize_room(actor)
         end
 
-        interpret 'look around', 'look'
-        interpret 'look here', 'look'
+        interpret 'look around|here', 'look'
         interpret 'l', 'look'
 
-        interpret 'look at :thing', 'look :thing'
-        interpret 'look on :thing', 'look :thing'
-        interpret 'look under :thing', 'look :thing'
-        interpret 'look beneath :thing', 'look :thing'
-        interpret 'look around :thing', 'look :thing'
+        interpret 'look at|on|under|beneath|around :thing', 'look :thing'
         interpret 'l :thing', 'look :thing'
         interpret 'examine :thing', 'look :thing'
         interpret 'x :thing', 'look :thing'

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

@@ -11,8 +11,7 @@ module Gamefic
         end
 
         respond :place, available, available(Supporter) do |actor, thing, supporter|
-          actor.execute :take, thing unless thing.parent == actor
-          next unless thing.parent == actor
+          next unless actor.have_or_take(thing)
 
           thing.put supporter, :on
           actor.tell "You put #{the thing} on #{the supporter}."
@@ -27,12 +26,10 @@ module Gamefic
           actor.execute :drop, thing
         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|down on) :supporter', 'place :thing :supporter'
+        interpret 'set :thing (on|down on) :supporter', 'place :thing :supporter'
+        interpret 'drop :thing (on|down on) :supporter', 'place :thing :supporter'
+        interpret 'place :thing (on|down on) :supporter', 'place :thing :supporter'
       end
     end
   end

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

@@ -28,8 +28,7 @@ module Gamefic
           end
         end
 
-        interpret 'look inside :thing', 'search :thing'
-        interpret 'look in :thing', 'search :thing'
+        interpret 'look in|inside :thing', 'search :thing'
       end
     end
   end

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

@@ -16,16 +16,19 @@ module Gamefic
 
         respond :unlock, available(Lockable, proc(&:has_lock_key?)), children do |actor, thing, key|
           if thing.lock_key == key
-            thing.locked = false
-            actor.tell "You unlock #{the thing} with #{the key}."
+            if thing.locked?
+              thing.locked = false
+              actor.tell "You unlock #{the thing} with #{the key}."
+            else
+              actor.tell "It's already unlocked."
+            end
           else
             actor.tell "You can't unlock #{the thing} with #{the key}."
           end
         end
 
         respond :unlock, available(Lockable, proc(&:has_lock_key?)), available do |actor, _thing, key|
-          actor.execute :take, key if key.parent != actor
-          actor.proceed if key.parent == actor
+          actor.proceed if actor.have_or_take(key)
         end
 
         interpret 'unlock :container with :key', 'unlock :container :key'

data/lib/gamefic/standard/direction.rb

@@ -1,60 +1,88 @@
-class Direction
-  attr_writer :adjective, :adverb, :reverse
+module Gamefic
+  module Standard
+    # Descriptions of the geographical relationships between entities. Portals
+    # can use directions to identify the path to their destination, such as
+    # north, southwest, up, etc.
+    #
+    class Direction
+      attr_writer :adjective, :adverb, :reverse
 
-  # @return [String]
-  attr_accessor :name
+      # @return [String]
+      attr_accessor :name
 
-  def initialize **args
-    args.each { |key, value|
-      send "#{key}=", value
-    }
-  end
+      def initialize **args
+        args.each { |key, value|
+          send "#{key}=", value
+        }
+      end
 
-  # @return [String]
-  def adjective
-    @adjective || @name
-  end
+      # @return [String]
+      def adjective
+        @adjective || @name
+      end
 
-  # @return [String]
-  def adverb
-    @adverb || @name
-  end
+      # @return [String]
+      def adverb
+        @adverb || @name
+      end
 
-  # @return [String]
-  def synonyms
-    "#{adjective} #{adverb}"
-  end
+      # @return [String]
+      def synonyms
+        "#{adjective} #{adverb}"
+      end
 
-  def reverse
-    Direction.find @reverse
-  end
+      def reverse
+        Direction.find @reverse
+      end
 
-  def to_s
-    @name
-  end
+      def to_s
+        @name
+      end
 
-  class << self
-    def compass
-      @compass ||= {
-        north: Direction.new(name: 'north', adjective: 'northern', reverse: :south),
-        south: Direction.new(name: 'south', adjective: 'southern', reverse: :north),
-        west: Direction.new(name: 'west', adjective: 'western', reverse: :east),
-        east: Direction.new(name: 'east', adjective: 'eastern', reverse: :west),
-        northwest: Direction.new(name: 'northwest', adjective: 'northwestern', reverse: :southeast),
-        southeast: Direction.new(name: 'southeast', adjective: 'southeastern', reverse: :northwest),
-        northeast: Direction.new(name: 'northeast', adjective: 'northeastern', reverse: :southwest),
-        southwest: Direction.new(name: 'southwest', adjective: 'southwestern', reverse: :northeast),
-        up: Direction.new(name: 'up', adjective: 'upwards', reverse: :down),
-        down: Direction.new(name: 'down', adjective: 'downwards', reverse: :up)
-      }
-    end
+      class << self
+        # @return [Hash{Symbol => Direction}]
+        def compass
+          @compass ||= {
+            north: Direction.new(name: 'north', adjective: 'northern', reverse: :south),
+            south: Direction.new(name: 'south', adjective: 'southern', reverse: :north),
+            west: Direction.new(name: 'west', adjective: 'western', reverse: :east),
+            east: Direction.new(name: 'east', adjective: 'eastern', reverse: :west),
+            northwest: Direction.new(name: 'northwest', adjective: 'northwestern', reverse: :southeast),
+            southeast: Direction.new(name: 'southeast', adjective: 'southeastern', reverse: :northwest),
+            northeast: Direction.new(name: 'northeast', adjective: 'northeastern', reverse: :southwest),
+            southwest: Direction.new(name: 'southwest', adjective: 'southwestern', reverse: :northeast),
+            up: Direction.new(name: 'up', adjective: 'upwards', reverse: :down),
+            down: Direction.new(name: 'down', adjective: 'downwards', reverse: :up),
+            in: Direction.new(name: 'in', adjective: 'inside', reverse: :out),
+            out: Direction.new(name: 'in', adjective: 'inside', reverse: :in)
+          }
+        end
+
+        def names
+          compass.values.map(&:name)
+        end
+
+        # @param dir [Direction, String, Symbol]
+        # @return [Direction, nil]
+        def find(dir)
+          return dir if dir.is_a?(Direction)
 
-    # @param dir [Direction, String]
-    # @return [Direction, nil]
-    def find(dir)
-      return dir if dir.is_a?(Direction)
+          compass[dir.to_s.downcase.to_sym]
+        end
+      end
 
-      compass[dir.to_s.downcase.to_sym]
+      NORTH = compass[:north]
+      SOUTH = compass[:south]
+      WEST = compass[:west]
+      EAST = compass[:east]
+      NORTHWEST = compass[:northwest]
+      SOUTHEAST = compass[:southeast]
+      NORTHEAST = compass[:northeast]
+      SOUTHWEST = compass[:southwest]
+      UP = compass[:up]
+      DOWN = compass[:down]
+      IN = compass[:in]
+      OUT = compass[:out]
     end
   end
 end

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

@@ -6,6 +6,8 @@ module Gamefic
     Character.set_default gender: :other
 
     class Character
+      include ImplicitTaking
+
       def accessible
         children.select { |child| child.is_a?(Scenery) }
       end

data/lib/gamefic/standard/entities/door.rb

@@ -30,6 +30,10 @@ module Gamefic
         reverse&.lock_key = key
       end
 
+      def type_name
+        @type_name ||= 'door'
+      end
+
       private
 
       def update_reverse_open

data/lib/gamefic/standard/entities/portal.rb

@@ -8,6 +8,8 @@ module Gamefic
       # @return [Gamefic::Entity]
       attr_accessor :destination
 
+      attr_writer :type_name
+
       # Get the ordinal direction of this Portal
       # Portals have distinct direction and name properties so games can display a
       # bare compass direction for exits, e.g., "south" vs. "the southern door."
@@ -35,7 +37,8 @@ module Gamefic
       end
 
       def name
-        @name || direction&.name || destination.name
+        @name ||
+          (direction ? "#{type_name} #{direction.name}" : destination.name)
       end
 
       def instruction
@@ -45,6 +48,13 @@ module Gamefic
       def synonyms
         "#{super} #{@destination} #{@direction} #{!direction.nil? ? direction.synonyms : ''}"
       end
+
+      # A description of the portal type for generating automatic names, e.g.,
+      # "the northern exit"
+      #
+      def type_name
+        @type_name ||= 'exit'
+      end
     end
   end
 end

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

@@ -2,6 +2,9 @@
 
 module Gamefic
   module Standard
+    # An entity that represents a location in the game world that other
+    # entities can occupy.
+    #
     class Room < Thing
       attr_writer :explicit_exits
 
@@ -27,7 +30,7 @@ module Gamefic
       # @return [Portal, Array<Portal>]
       def connect(destination, direction: nil, type: Portal, two_way: true, **opts)
         direction = Direction.find(direction)
-        here = type.new parent: self, destination: destination, direction: Direction.find(direction), **opts
+        here = type.new parent: self, destination: destination, direction: direction, **opts
         return here unless two_way
 
         there = type.new parent: destination, destination: self, direction: direction&.reverse, **opts
@@ -36,18 +39,30 @@ module Gamefic
 
       protected
 
-      %w[north south west east northeast southeast southwest northwest up down].each do |direction|
+      Direction.names.each do |direction|
         define_method "#{direction}=" do |destination|
           connect destination, direction: direction
         end
       end
 
-      def connect=(destinations)
-        all = [destinations].flatten
+      def connect=(definitions)
+        all = [definitions].flatten
         until all.empty?
-          destination = all.shift
-          direction = (all.first.is_a?(String) ? all.shift : nil)
-          connect destination, direction: direction
+          definition = all.shift
+          if definition.is_a?(Hash)
+            connect definition[:destination], **definition.except(:destination)
+          else
+            # @todo Prefer definition hashes
+            direction = (all.first.is_a?(String) ? all.shift : nil)
+            connect definition, direction: direction
+          end
+        end
+      end
+
+      # @todo Candidate for deprecation
+      def one_way=(destinations)
+        [destinations].flatten.each do |destination|
+          connect destination, two_way: false
         end
       end
     end

data/lib/gamefic/standard/implicit_taking.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Standard
+    # A mixin that provides a #have_or_take method to automate possession.
+    # Authors can use it to ensure that an actor is holding an entity as a
+    # prerequisite to doing something with it.
+    #
+    module ImplicitTaking
+      # True if the actor is already holding the entity or successfully takes
+      # possession of it.
+      #
+      # @example Actor needs to be holding the item to use it
+      #   respond :use, Item do |actor, item|
+      #     if actor.have_or_take(item)
+      #       actor.tell "You're using #{the item}."
+      #     else
+      #       actor.tell "You can't use #{the item}."
+      #     end
+      #   end
+      #
+      # @param entity [Gamefic::Entity]
+      # @return [Boolean]
+      def have_or_take(entity)
+        execute(:take, entity) unless possessions.include?(entity)
+
+        possessions.include?(entity)
+      end
+      alias has_or_takes have_or_take
+
+      private
+
+      # @param from [Array<Gamefic::Entity>]
+      # @return [Array<Gamefic::Entity>]
+      def possessions(from = children)
+        return [] if from.empty?
+
+        from + possessions(from.flat_map(&:accessible))
+      end
+    end
+  end
+end

data/lib/gamefic/standard/version.rb

@@ -2,6 +2,6 @@
 
 module Gamefic
   module Standard
-    VERSION = '4.0.0'
+    VERSION = '4.1.0'
   end
 end

data/lib/gamefic/standard.rb

@@ -19,6 +19,7 @@ module Gamefic
     require 'gamefic/standard/openable'
     require 'gamefic/standard/lockable'
     require 'gamefic/standard/direction'
+    require 'gamefic/standard/implicit_taking'
     require 'gamefic/standard/entities'
     require 'gamefic/standard/actions'
     require 'gamefic/standard/introduction'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-standard
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Fred Snyder
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -16,14 +15,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
 - !ruby/object:Gem::Dependency
   name: gamefic-grammar
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +193,7 @@ files:
 - lib/gamefic/standard/entities/scenery.rb
 - lib/gamefic/standard/entities/supporter.rb
 - lib/gamefic/standard/entities/thing.rb
+- lib/gamefic/standard/implicit_taking.rb
 - lib/gamefic/standard/introduction.rb
 - lib/gamefic/standard/lockable.rb
 - lib/gamefic/standard/openable.rb
@@ -199,7 +205,6 @@ homepage: https://gamefic.com
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -214,8 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: The Gamefic standard script library.
 test_files: []