gamefic-standard 3.2.3 → 3.3.0

data/lib/gamefic-standard/enterable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Standard
+    module Enterable
+      attr_writer :enterable
+
+      def enterable?
+        @enterable ||= false
+      end
+    end
+  end
+end

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

@@ -1,2 +1,5 @@
+# frozen_string_literal: true
+
 Character = Gamefic::Actor
 Character.set_default gender: :other
+Character.include Gamefic::What::Askable

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

@@ -3,6 +3,6 @@
 # An openable and lockable receptacle.
 #
 class Container < Receptacle
-  include Openable
-  include Lockable
+  include Gamefic::Standard::Openable
+  include Gamefic::Standard::Lockable
 end

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

@@ -1,42 +1,42 @@
 # frozen_string_literal: true
 
-# An openable portal.
+# An openable and lockable portal.
 #
 class Door < Portal
-  include Openable
-  include Lockable
+  include Gamefic::Standard::Openable
+  include Gamefic::Standard::Lockable
 
   def post_initialize
     update_reverse_open
+    update_reverse_lock
   end
 
-  def open= bool
+  def open=(bool)
     super
+    reverse&.lock_key = lock_key
     update_reverse_open
+    update_reverse_lock
   end
 
-  def locked= bool
+  def locked=(bool)
     super
     update_reverse_lock
   end
 
-  def two_way_lock_key= key
-    lock_key = key
-    return if reverse.nil?
-    reverse.lock_key = key
+  def two_way_lock_key=(key)
+    self.lock_key = key
+    reverse&.lock_key = key
   end
 
   private
 
   def update_reverse_open
     rev = find_reverse
-    return if rev.nil? || rev.open? == open?
-    rev.open = open?
+    rev&.open = open? unless rev&.open? == open?
   end
 
   def update_reverse_lock
     rev = find_reverse
-    return if rev.nil? || rev.locked? == locked?
-    rev.locked = locked?
+    rev&.locked = locked? unless rev&.locked? == locked?
   end
 end

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

@@ -28,7 +28,7 @@ class Portal < Thing
   end
   alias find_reverse reverse
 
-  def direction= dir
+  def direction=(dir)
     @direction = Direction.find(dir)
   end
 

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Receptacle < Thing
-  include Enterable
+  include Gamefic::Standard::Enterable
 end

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

@@ -23,14 +23,12 @@ class Room < Thing
   # @param type [Class<Portal>]
   # @param two_way [Boolean]
   # @return [Portal, Array<Portal>]
-  def connect destination, direction: nil, type: Portal, two_way: true
+  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))
+    here = type.new parent: self, destination: destination, direction: Direction.find(direction), **opts
     return here unless two_way
 
-    there = type.new(parent: destination, destination: self, direction: direction&.reverse)
+    there = type.new parent: destination, destination: self, direction: direction&.reverse, **opts
     [here, there]
   end
 
@@ -43,4 +41,21 @@ class Room < Thing
       set_default explicit_exits: bool
     end
   end
+
+  protected
+
+  %w[north south west east northeast southeast southwest northwest up down].each do |direction|
+    define_method "#{direction}=" do |destination|
+      connect destination, direction: direction
+    end
+  end
+
+  def connect=(destinations)
+    all = [destinations].flatten
+    until all.empty?
+      destination = all.shift
+      direction = (all.first.is_a?(String) ? all.shift : nil)
+      connect destination, direction: direction
+    end
+  end
 end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Supporter < Thing
-  include Enterable
+  include Gamefic::Standard::Enterable
 end

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

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-class Gamefic::Entity
-  include Grammar::Attributes
-  include Standardized
-end
-
 Thing = Gamefic::Entity
 Thing.set_default itemized: true, portable: false
+Thing.include Gamefic::Standard::Standardized

data/lib/gamefic-standard/introduction.rb

@@ -1,8 +1,18 @@
 # frozen_string_literal: true
 
-Gamefic::Standard.script do
-  introduction do |actor|
-    actor.name = 'myself'
-    actor.synonyms = 'self me yourself you'
+module Gamefic
+  module Standard
+    # Add a simple introduction that sets an appropriate name and synonyms for
+    # the player character.
+    #
+    module Introduction
+      extend Gamefic::Scriptable
+
+      introduction do |actor|
+        actor.name = 'you'
+        actor.synonyms = 'self me yourself myself'
+        actor.proper_named = true
+      end
+    end
   end
 end

data/lib/gamefic-standard/lockable.rb

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

data/lib/gamefic-standard/openable.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Standard
+    # A module for entities that are openable.
+    #
+    module Openable
+      def open
+        self.open = true
+      end
+
+      def close
+        self.open = false
+      end
+
+      def open=(bool)
+        @open = bool
+      end
+
+      def open?
+        @open ||= false
+      end
+
+      def closed?
+        !open?
+      end
+
+      def accessible?
+        open?
+      end
+    end
+  end
+end

data/lib/gamefic-standard/pathfinder.rb

@@ -1,62 +1,82 @@
-#   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
-
-  # @return [Room]
-  attr_reader :destination
-
-  def initialize origin, destination
-    @origin = origin
-    @destination = destination
-    @path = nil
-    @paths = [[@origin]]
-    @visited = []
-    if @origin == @destination
-      @path = []
-    else
-      embark while @path.nil? && @paths.length > 0
-    end
-  end
+# frozen_string_literal: true
 
-  # @return [Array<Room>]
-  def path
-    # @path is nil if the path is invalid, but #path should return an empty
-    # array instead.
-    @path || []
-  end
+module Gamefic
+  module Standard
+    # Pathfinders provide the shortest route between two rooms. The destination
+    # needs to be accessible from the origin through portals. Note that
+    # Pathfinder does not take into account portals that characters should not
+    # be able to traverse, such as locked doors.
+    #
+    class Pathfinder
+      # @return [Room]
+      attr_reader :origin
 
-  # @return [Boolean]
-  def valid?
-    path.length > 0 || origin == destination
-  end
+      # @return [Room]
+      attr_reader :destination
+
+      # @param origin [Room]
+      # @param destination [Room]
+      def initialize(origin, destination)
+        @origin = origin
+        @destination = destination
+        @visited = []
+        if origin == destination
+          @path = []
+        else
+          embark [[origin]]
+        end
+      end
+
+      # An array of rooms starting with the first room after the origin and
+      # ending with the destination.
+      #
+      # The path will be empty if a path could not be found or the origin and
+      # destination are the same room.
+      #
+      # @return [Array<Room>]
+      def path
+        @path || []
+      end
+
+      # True if there is a valid path from the origin to the destination (or
+      # the origin and destination are the same room).
+      #
+      def valid?
+        !!@path
+      end
+
+      private
+
+      def embark(paths)
+        return if paths.empty?
+
+        new_paths = paths.each_with_object([]) do |path, acc|
+          updates = traverse(path)
+          acc.concat updates
+        end
+
+        if new_paths.last&.last == destination
+          @path = new_paths.last
+        else
+          embark new_paths
+        end
+      end
+
+      def traverse(path)
+        portals_with_destination(path).map do |portal|
+          next if @visited.include?(portal.destination)
+
+          return [path[1..] + [portal.destination]] if portal.destination == destination
 
-  private
-
-  def embark
-    new_paths = []
-    @paths.each { |path|
-      last = path.last
-      portals = last.children.that_are(Portal)
-      portals.each { |portal|
-        new_path = path.clone
-        if !@visited.include?(portal.destination)
-          new_path.push portal.destination
           @visited.push portal.destination
-          if portal.destination == @destination
-            @path = new_path
-            @path.shift
-            break
-          end
-          new_paths.push new_path
+          path + [portal.destination]
         end
-      }
-      path.push nil
-    }
-    @paths += new_paths
-    @paths.delete_if{|path| path.last.nil?}
+        .compact
+      end
+
+      def portals_with_destination(path)
+        path.last.children.that_are(Portal).select(&:destination)
+      end
+    end
   end
 end

data/lib/gamefic-standard/standardized.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Standard
+    # Common features of standard entities.
+    #
+    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
+        ascendant = parent
+        ascendant = ascendant.parent until ascendant.is_a?(Room) || ascendant.nil?
+        ascendant
+      end
+    end
+  end
+end

data/lib/gamefic-standard/version.rb

@@ -2,6 +2,6 @@
 
 module Gamefic
   module Standard
-    VERSION = '3.2.3'
+    VERSION = '3.3.0'
   end
 end

data/lib/gamefic-standard.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'gamefic'
+require 'gamefic-grammar'
+require 'gamefic-what'
 
 module Gamefic
   # The Gamefic standard library provides a base collection of entities and
@@ -10,15 +12,22 @@ module Gamefic
     extend Gamefic::Scriptable
 
     require 'gamefic-standard/version'
-    require 'gamefic-standard/grammar'
     require 'gamefic-standard/articles'
     require 'gamefic-standard/queries'
-    require 'gamefic-standard/modules'
+    require 'gamefic-standard/standardized'
+    require 'gamefic-standard/enterable'
+    require 'gamefic-standard/openable'
+    require 'gamefic-standard/lockable'
     require 'gamefic-standard/direction'
     require 'gamefic-standard/entities'
     require 'gamefic-standard/actions'
     require 'gamefic-standard/introduction'
-    require 'gamefic-standard/give'
+    require 'gamefic-standard/pathfinder'
+
+    include Articles
+    include Grammar::Pronoun
+    include Actions
+    include Introduction
 
     def connect(origin, destination, direction = nil, type: Portal, two_way: true)
       origin.connect destination, direction: direction, type: type, two_way: two_way

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-standard
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.3.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-01 00:00:00.000000000 Z
+date: 2024-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: gamefic-grammar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: gamefic-what
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: opal
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +150,7 @@ files:
 - lib/gamefic-standard/actions/close.rb
 - lib/gamefic-standard/actions/drop.rb
 - lib/gamefic-standard/actions/enter.rb
+- lib/gamefic-standard/actions/give.rb
 - lib/gamefic-standard/actions/go.rb
 - lib/gamefic-standard/actions/insert.rb
 - lib/gamefic-standard/actions/inventory.rb
@@ -143,6 +172,7 @@ files:
 - lib/gamefic-standard/actions/wait.rb
 - lib/gamefic-standard/articles.rb
 - lib/gamefic-standard/direction.rb
+- lib/gamefic-standard/enterable.rb
 - lib/gamefic-standard/entities.rb
 - lib/gamefic-standard/entities/character.rb
 - lib/gamefic-standard/entities/container.rb
@@ -156,21 +186,14 @@ files:
 - lib/gamefic-standard/entities/scenery.rb
 - lib/gamefic-standard/entities/supporter.rb
 - lib/gamefic-standard/entities/thing.rb
-- lib/gamefic-standard/give.rb
-- lib/gamefic-standard/grammar.rb
-- lib/gamefic-standard/grammar/attributes.rb
-- lib/gamefic-standard/grammar/pronoun.rb
 - lib/gamefic-standard/introduction.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/lockable.rb
+- lib/gamefic-standard/openable.rb
 - lib/gamefic-standard/pathfinder.rb
 - lib/gamefic-standard/queries.rb
+- lib/gamefic-standard/standardized.rb
 - lib/gamefic-standard/version.rb
-- spec-opal/spec_helper.rb
-homepage: http://gamefic.com
+homepage: https://gamefic.com
 licenses:
 - MIT
 metadata: {}

data/lib/gamefic-standard/give.rb

@@ -1,21 +0,0 @@
-module Gamefic::Standard::Give
-  extend Gamefic::Scriptable
-
-  script do
-    respond :give, available, children do |actor, _character, _gift|
-      actor.tell 'Nothing happens.'
-    end
-
-    respond :give, available(Character), available do |actor, character, gift|
-      actor.tell "#{The character} doesn't want #{the gift}."
-    end
-
-    respond :give, available(Character), available do |actor, _character, gift|
-      actor.execute :take, gift if gift.parent != actor
-
-      actor.proceed if gift.parent == actor
-    end
-
-    interpret 'give :gift to :character', 'give :character :gift'
-  end
-end

data/lib/gamefic-standard/grammar/attributes.rb

@@ -1,37 +0,0 @@
-module Grammar
-  # A collection of attributes that enable grammar features for entities, such
-  # as selecting their correct pronouns.
-  #
-  module Attributes
-    # @see #gender
-    attr_writer :gender
-
-    # @see #plural?
-    attr_writer :plural
-
-    # The gender of the object. Supported values are :male, :female, :neutral,
-    # and :other. Use :neutral for objects that don't have a gender (i.e.,
-    # "it"). Use :other for people or characters that have an unspecified or
-    # non-binary gender (i.e., "they").
-    #
-    # @return [Symbol]
-    def gender
-      @gender ||= :neutral
-    end
-
-    # True if the object should be referred to in the plural, e.g., "they"
-    # instead of "it."
-    # @return [Boolean]
-    #
-    def plural?
-      @plural ||= false
-    end
-
-    # For now, the object's person is always assumed to be third
-    # (he/she/it/they). A future version of this library might support first
-    # (I/me) and second (you).
-    def person
-      3
-    end
-  end
-end