gamefic-standard 3.3.0 → 4.0.0

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Standard
+    class Fixture < Thing
+    end    
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Standard
+    # An entity that is portable by default.
+    #
+    class Item < Thing
+      set_default portable: true
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Standard
+    # An entity that provides access from one room to another.
+    #
+    class Portal < Thing
+      # @return [Gamefic::Entity]
+      attr_accessor :destination
+
+      # 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."
+      #
+      # A portal's destination can also be nil, in which case it can be referenced
+      # in commands by its destination, e.g., "go to the house."
+      #
+      # @return [Direction, nil]
+      attr_reader :direction
+
+      # Find the portal in the destination that returns to this portal's parent
+      #
+      # @return [Room, nil]
+      def reverse
+        return nil if destination.nil?
+
+        destination.children.that_are(Portal).find do |portal|
+          portal.destination == parent
+        end
+      end
+      alias find_reverse reverse
+
+      def direction=(dir)
+        @direction = Direction.find(dir)
+      end
+
+      def name
+        @name || direction&.name || destination.name
+      end
+
+      def instruction
+        direction || (destination ? "to #{destination.definitely}" : name)
+      end
+
+      def synonyms
+        "#{super} #{@destination} #{@direction} #{!direction.nil? ? direction.synonyms : ''}"
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Standard
+    class Room < Thing
+      attr_writer :explicit_exits
+
+      set_default explicit_exits: true
+
+      def explicit_exits?
+        @explicit_exits
+      end
+
+      def tell(message)
+        children.each { |c| c.tell message }
+      end
+
+      # @return [Array<Portal>]
+      def portals
+        children.that_are(Portal)
+      end
+
+      # @param destination [Room]
+      # @param direction [Direction, String, nil]
+      # @param type [Class<Portal>]
+      # @param two_way [Boolean]
+      # @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
+        return here unless two_way
+
+        there = type.new parent: destination, destination: self, direction: direction&.reverse, **opts
+        [here, there]
+      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
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'gamefic/standard/entities/scenery'
+
+module Gamefic
+  module Standard
+    # Rubble is Scenery with slightly modified action responses.
+    # Intended for things that might be portable but are useless.
+    # Rule of thumb: Scenery is something that can't be carried,
+    # like a table or the sky; and Rubble is something that might
+    # be portable but is otherwise useless, like trash or debris.
+    #
+    class Rubble < Scenery
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Standard
+    # Scenery is an entity that is not itemized by default. They're typically used
+    # to provide a description for objects that can be observed but do not respond
+    # to any other interactions.
+    #
+    class Scenery < Thing
+      set_default itemized: false
+    end
+  end
+end

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

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

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Standard
+    Thing = Gamefic::Entity
+    Thing.set_default itemized: true, portable: false
+    Thing.include Gamefic::Standard::Standardized
+  end
+end

data/lib/gamefic/standard/entities.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Gamefic
+  module Standard
+    require 'gamefic/standard/entities/thing'
+    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'
+    require 'gamefic/standard/entities/supporter'
+  end
+end

data/lib/{gamefic-standard → gamefic/standard}/lockable.rb

@@ -9,6 +9,14 @@ module Gamefic
 
       attr_accessor :lock_key
 
+      def lock
+        self.locked = true
+      end
+
+      def unlock
+        self.locked = false
+      end
+
       def locked=(bool)
         @locked = bool
         @open = false if @locked

data/lib/{gamefic-standard → gamefic/standard}/openable.rb

@@ -25,8 +25,8 @@ module Gamefic
         !open?
       end
 
-      def accessible?
-        open?
+      def accessible
+        open? ? children : []
       end
     end
   end

data/lib/gamefic/standard/queries.rb

@@ -0,0 +1,24 @@
+module Gamefic
+  module Standard
+    module Queries
+      class RoomQuery < Gamefic::Query::Base
+        def span(subject)
+          [subject.room].compact
+        end
+      end
+    end
+  end
+end
+
+# @todo Monkey patch
+module Gamefic
+  module Scriptable
+    module Queries
+      include Gamefic::Standard::Queries
+
+      def room *args
+        RoomQuery.new(Gamefic::Standard::Room, *args, name: 'room')
+      end
+    end
+  end
+end

data/lib/{gamefic-standard → gamefic/standard}/version.rb

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

data/lib/gamefic/standard.rb

@@ -0,0 +1,32 @@
+# 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
+  # rules for interactive fiction.
+  #
+  module Standard
+    extend Gamefic::Scriptable
+
+    require 'gamefic/standard/version'
+    require 'gamefic/standard/articles'
+    require 'gamefic/standard/queries'
+    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/pathfinder'
+
+    include Articles
+    include Grammar::Pronoun
+    include Actions
+    include Introduction
+  end
+end

data/lib/gamefic-standard.rb

@@ -1,36 +1,3 @@
 # 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
-  # rules for interactive fiction.
-  #
-  module Standard
-    extend Gamefic::Scriptable
-
-    require 'gamefic-standard/version'
-    require 'gamefic-standard/articles'
-    require 'gamefic-standard/queries'
-    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/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
-    end
-  end
-end
+require 'gamefic/standard'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-standard
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-05 00:00:00.000000000 Z
+date: 2025-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: gamefic-grammar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: gamefic-what
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: opal
   requirement: !ruby/object:Gem::Requirement
@@ -145,54 +145,56 @@ files:
 - bin/setup
 - gamefic-standard.gemspec
 - lib/gamefic-standard.rb
-- lib/gamefic-standard/actions.rb
-- lib/gamefic-standard/actions/attack.rb
-- 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
-- lib/gamefic-standard/actions/leave.rb
-- lib/gamefic-standard/actions/lock.rb
-- lib/gamefic-standard/actions/look.rb
-- lib/gamefic-standard/actions/move.rb
-- lib/gamefic-standard/actions/nil.rb
-- lib/gamefic-standard/actions/open.rb
-- lib/gamefic-standard/actions/place.rb
-- lib/gamefic-standard/actions/pronouns.rb
-- lib/gamefic-standard/actions/quit.rb
-- lib/gamefic-standard/actions/repeat.rb
-- lib/gamefic-standard/actions/save-restore-undo.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/direction.rb
-- lib/gamefic-standard/enterable.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
-- lib/gamefic-standard/entities/receptacle.rb
-- lib/gamefic-standard/entities/room.rb
-- lib/gamefic-standard/entities/rubble.rb
-- lib/gamefic-standard/entities/scenery.rb
-- lib/gamefic-standard/entities/supporter.rb
-- lib/gamefic-standard/entities/thing.rb
-- lib/gamefic-standard/introduction.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
+- lib/gamefic/standard.rb
+- lib/gamefic/standard/actions.rb
+- lib/gamefic/standard/actions/attack.rb
+- 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
+- lib/gamefic/standard/actions/leave.rb
+- lib/gamefic/standard/actions/lock.rb
+- lib/gamefic/standard/actions/look.rb
+- lib/gamefic/standard/actions/mount.rb
+- lib/gamefic/standard/actions/move.rb
+- lib/gamefic/standard/actions/nil.rb
+- lib/gamefic/standard/actions/open.rb
+- lib/gamefic/standard/actions/place.rb
+- lib/gamefic/standard/actions/pronouns.rb
+- lib/gamefic/standard/actions/quit.rb
+- lib/gamefic/standard/actions/repeat.rb
+- lib/gamefic/standard/actions/save-restore-undo.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/direction.rb
+- lib/gamefic/standard/enterable.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
+- lib/gamefic/standard/entities/receptacle.rb
+- lib/gamefic/standard/entities/room.rb
+- lib/gamefic/standard/entities/rubble.rb
+- lib/gamefic/standard/entities/scenery.rb
+- lib/gamefic/standard/entities/supporter.rb
+- lib/gamefic/standard/entities/thing.rb
+- lib/gamefic/standard/introduction.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
 homepage: https://gamefic.com
 licenses:
 - MIT

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Standard
-    module Actions
-      module Give
-        extend Gamefic::Scriptable
-
-        include Gamefic::What
-
-        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} has no use for #{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
-
-          respond :give, Thing do |actor, thing|
-            actor.tell "Who do you want to give #{the thing} to?"
-            actor.ask_for_what "give #{thing} to __what__"
-          end
-
-          respond :give, Character do |actor, character|
-            actor.tell "What do you want to give to #{the character}?"
-            actor.ask_for_what "give __what__ to #{character}"
-          end
-
-          interpret 'give :gift to :character', 'give :character :gift'
-        end
-      end
-    end
-  end
-end