gamefic-standard 3.3.0 → 4.0.0

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

@@ -1,152 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Standard
-    module Actions
-      module Look
-        extend Gamefic::Scriptable
-
-        respond :look do |actor|
-          actor.execute :look, actor.room
-        end
-
-        respond :look, myself do |actor, _|
-          actor.tell actor.description
-          actor.execute :inventory
-        end
-
-        respond :look, available(Thing) do |actor, thing|
-          actor.tell thing.description
-          thing.children.that_are(proc(&:attached?)).that_are(proc(&:itemized?)).each do |item|
-            actor.tell "#{An item} is attached to #{the thing}."
-          end
-        end
-
-        respond :look, available(Supporter) do |actor, thing|
-          itemized = thing.children.that_are_not(proc(&:attached?)).that_are(proc(&:itemized?))
-          # If the supporter does not have a description but it does contain
-          # itemized things, avoid saying there's nothing special about it.
-          actor.proceed if thing.has_description? || itemized.empty?
-          actor.tell "You see #{itemized.join_and} on #{the thing}." unless itemized.empty?
-        end
-
-        respond :look, available(Receptacle) do |actor, thing|
-          actor.proceed
-          actor.tell "You're currently in #{the thing}." if actor.parent == thing
-          next unless actor.parent == thing || thing.accessible?
-
-          itemized = thing.children.that_are_not(actor, proc(&:attached?)).that_are(proc(&:itemized?))
-          next if itemized.empty?
-
-          if actor.parent == thing
-            actor.tell "You see #{itemized.join_and} here." unless itemized.empty?
-          else
-            actor.tell "You see #{itemized.join_and} in #{the thing}." unless itemized.empty?
-          end
-        end
-
-        respond :look, parent(Supporter, proc(&:enterable?)) do |actor, supporter|
-          actor.proceed
-          actor.tell "You are currently on #{the supporter}."
-        end
-
-        respond :look, available(Thing, Openable) do |actor, thing|
-          actor.tell thing.description if thing.has_description?
-          actor.tell "#{The thing} is #{thing.open? ? 'open' : 'closed'}."
-          next if thing.closed? || thing.children.empty?
-
-          actor.tell "You see #{thing.children.join_and}."
-        end
-
-        respond :look, room do |actor, _room|
-          actor.execute :_describe_room
-        end
-
-        meta :_describe_room do |actor|
-          next unless actor.room
-
-          actor.tell "<strong>#{actor.room.name.cap_first}</strong>"
-          actor.tell actor.room.description if actor.room.has_description?
-          actor.execute :_itemize_room
-        end
-
-        meta :_itemize_room do |actor|
-          room = actor.room
-          next unless room
-
-          with_locales = []
-          chars = room.children.that_are(Character).that_are(proc(&:itemized?)) - [actor]
-          charsum = []
-          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
-          items = room.children.that_are(proc(&:itemized?)) - [actor] - room.children.that_are(Character) - room.children.that_are(Portal)
-          itemsum = []
-          items.each do |item|
-            if item.locale_description.nil?
-              itemsum.push item
-            else
-              with_locales.push item
-            end
-          end
-          actor.tell "You see #{itemsum.join_and}." if itemsum.length > 0
-          with_locales.each do |entity|
-            actor.tell entity.locale_description
-          end
-          if room.explicit_exits?
-            portals = room.children.that_are(Portal).that_are(proc(&:itemized?))
-            if portals.length > 0
-              if portals.length == 1
-                p = portals[0]
-                actor.tell "There is an exit #{p.instruction}."
-              else
-                dirs = []
-                portals.each do |p|
-                  dirs.push p.instruction
-                end
-                order = %w[north northeast east southeast south southwest west northwest up
-                           down]
-                dirs.sort! { |a, b| (order.index(a.to_s) || order.length) <=> (order.index(b.to_s) || order.length) }
-                actor.tell "There are exits #{dirs.join_and(', ')}."
-              end
-            end
-          end
-          actor.execute :_look_parent_from_room
-        end
-
-        meta :_look_parent_from_room do |actor|
-          next unless actor.parent.is_a?(Supporter) || actor.parent.is_a?(Receptacle)
-
-          preposition = actor.parent.is_a?(Supporter) ? 'on' : 'in'
-          siblings = actor.parent.children.that_are_not(actor)
-          if siblings.empty?
-            actor.tell "You're #{preposition} #{the actor.parent}."
-          else
-            actor.tell "You're #{preposition} #{the actor.parent}, along with #{siblings.join_and}."
-          end
-        end
-
-        interpret 'look around', 'look'
-        interpret 'look 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 'l :thing', 'look :thing'
-        interpret 'examine :thing', 'look :thing'
-        interpret 'x :thing', 'look :thing'
-        interpret 'inspect :thing', 'look :thing'
-      end
-    end
-  end
-end

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

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Standard
-    module Actions
-      module Nil
-        extend Gamefic::Scriptable
-
-        meta nil, plaintext do |actor, string|
-          next if string.strip.empty?
-
-          words = string.keywords
-          list = actor.epic.synonyms
-          if list.include?(words[0]&.to_sym)
-            if words.length > 1
-              result = myself.query(actor, words[1..-1].join(' '))
-              found = [result.match].compact
-              avail = available(ambiguous: true)
-              result = avail.query(actor, result.remainder)
-              until result.match.nil?
-                found.concat result.match
-                result = avail.query(actor, result.remainder)
-              end
-              if found.empty?
-                verbs = actor.epic
-                            .syntaxes
-                            .select { |syn| syn.synonym == words[0].to_sym }
-                            .map(&:verb)
-                resps = actor.epic.responses_for(*verbs)
-                if resps.any? { |resp| !resp.queries.empty? }
-                  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]}" but not with the rest of your sentence. (Maybe it's a one-word command?)]
-                end
-              elsif result.remainder != ''
-                actor.tell %(I recognize "#{string.sub(/#{result.remainder}$/, '').strip}" as a command but was confused by "#{result.remainder}.")
-              elsif found.one?
-                verbs = actor.epic
-                            .syntaxes
-                            .select { |syn| syn.synonym == words[0].to_sym }
-                            .map(&:verb)
-                resps = actor.epic.responses_for(*verbs)
-                if resps.any? { |resp| !resp.queries.empty? }
-                  actor.tell %(I recognize "#{words[0]}" and "#{found.first.name}" but could not understand them together.)
-                else
-                  actor.tell %[I recognize "#{words[0]}" and "#{found.first.name}" but could not understand them together. (Maybe "#{words[0]}" is a one-word command?)]
-                end
-              else
-                verbs = actor.epic
-                            .syntaxes
-                            .select { |syn| syn.synonym == words[0].to_sym }
-                            .map(&:verb)
-                resps = actor.epic.responses_for(*verbs)
-                if resps.any? { |resp| !resp.queries.empty? }
-                  actor.tell %(I recognize "#{words[0]}" but I'm not sure if "#{words[1..-1].join(' ')}" means #{found.map(&:definitely).join_or}.)
-                else
-                  actor.tell %[I recognize "#{words[0]}" but not with the rest of your sentence. (Maybe it's a one-word command?)]
-                end
-              end
-            else
-              actor.tell %(I recognize "#{words[0]}" as a verb but could not understand it in this context.)
-            end
-          else
-            actor.tell %(I don't recognize "#{words[0]}" as a verb.)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Standard
-    module Actions
-      module Quit
-        extend Gamefic::Scriptable
-
-        yes_or_no :standard_confirm_quit do |actor, props|
-          actor.cue :default_conclusion if props.yes?
-        end
-
-        meta :quit do |actor|
-          actor.tell 'Are you sure you want to quit?'
-          actor.cue :standard_confirm_quit
-        end
-      end
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Standard
-    module Actions
-      module Repeat
-        extend Gamefic::Scriptable
-
-        meta :repeat do |actor|
-          if actor.last_input && !actor.last_input.empty?
-            actor.tell "Repeating <kbd>\"#{actor.last_input}\"</kbd>..."
-            actor.queue.push actor.last_input
-          else
-            actor.tell "You don't have a previous command to repeat right now."
-          end
-        end
-
-        interpret 'again', 'repeat'
-      end
-    end
-  end
-end

data/lib/gamefic-standard/actions.rb

@@ -1,56 +0,0 @@
-require 'gamefic-standard/actions/nil'
-require 'gamefic-standard/actions/attack'
-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'
-require 'gamefic-standard/actions/move'
-require 'gamefic-standard/actions/talk'
-require 'gamefic-standard/actions/wait'
-require 'gamefic-standard/actions/give'
-require 'gamefic-standard/actions/repeat'
-require 'gamefic-standard/actions/save-restore-undo'
-require 'gamefic-standard/actions/pronouns'
-
-module Gamefic
-  module Standard
-    module Actions
-      include Nil
-      include Attack
-      include Drop
-      include Enter
-      include Open
-      include Close
-      include Lock
-      include Unlock
-      include Go
-      include Insert
-      include Inventory
-      include Leave
-      include Look
-      include Search
-      include Place
-      include Quit
-      include Take
-      include Move
-      include Talk
-      include Wait
-      include Give
-      include Repeat
-      include SaveRestoreUndo
-      include Pronouns
-      include Gamefic::What
-    end
-  end
-end

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

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

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

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-# An openable and lockable receptacle.
-#
-class Container < Receptacle
-  include Gamefic::Standard::Openable
-  include Gamefic::Standard::Lockable
-end

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

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

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

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-class Fixture < Thing
-end

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

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

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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-# 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

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

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

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

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-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
-
-  class << self
-    def explicit_exits?
-      default_attributes[:explicit_exits]
-    end
-
-    def explicit_exits=(bool)
-      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/rubble.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'gamefic-standard/entities/scenery'
-
-# 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

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

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-# 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

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

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

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

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

data/lib/gamefic-standard/entities.rb

@@ -1,12 +0,0 @@
-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'

data/lib/gamefic-standard/queries.rb

@@ -1,12 +0,0 @@
-class Gamefic::Scope::Room < Gamefic::Scope::Base
-  def matches
-    [context.room].compact
-  end
-end
-
-# @todo Monkey patch
-module Gamefic::Scriptable::Queries
-  def room *args
-    Gamefic::Query::Scoped.new Gamefic::Scope::Room, *([Room] + args)
-  end
-end