gamefic-standard 3.2.4 → 4.0.0

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

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

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-module Grammar
-  # Functions to select pronouns based on an entity's attributes, such as
-  # gender.
-  #
-  module Pronoun
-    extend self
-
-    # @param entity [#person, #plural?, #gender]
-    # @return [String]
-    def subjective(entity)
-      map(entity)[:subjective]
-    end
-    alias they subjective
-    alias he subjective
-    alias she subjective
-
-    # @param entity [#person, #plural?, #gender]
-    # @return [String]
-    def subjective_(entity)
-      subjective(entity).cap_first
-    end
-    alias they_ subjective_
-    alias he_ subjective_
-    alias she_ subjective_
-
-    # @param entity [#person, #plural?, #gender]
-    # @return [String]
-    def objective(entity)
-      map(entity)[:objective]
-    end
-    alias them objective
-
-    # @param entity [#person, #plural?, #gender]
-    # @return [String]
-    def objective_(entity)
-      objective(entity).cap_first
-    end
-    alias them_ objective_
-
-    # @param entity [#person, #plural?, #gender]
-    # @return [String]
-    def possessive(entity)
-      map(entity)[:possessive]
-    end
-    alias their possessive
-
-    # @param entity [#person, #plural?, #gender]
-    # @return [String]
-    def possessive_(entity)
-      possessive(entity).cap_first
-    end
-    alias their_ possessive_
-
-    # @param entity [#person, #plural?, #gender]
-    # @return [String]
-    def reflexive(entity)
-      map(entity)[:reflexive]
-    end
-    alias themselves reflexive
-    alias themself reflexive
-
-    # @param entity [#person, #plural?, #gender]
-    # @return [String]
-    def reflexive_(entity)
-      reflexive(entity).cap_first
-    end
-    alias themselves_ reflexive_
-    alias themself_ reflexive_
-
-    # @param entity [#person, #plural?, #gender]
-    # @return [Hash]
-    def map(entity)
-      plurality = (entity.plural? ? :plural : :singular)
-      maps[[(entity.person || 3), plurality, entity.gender]] ||
-        maps[[(entity.person || 3), plurality]]
-    end
-
-    private
-
-    def maps
-      @maps ||= {
-        [1, :singular] => Hash[map_keys.zip(%w[I me my myself])],
-        [2, :singular] => Hash[map_keys.zip(%w[you you your yourself])],
-        [3, :singular] => Hash[map_keys.zip(%w[it it its itself])],
-        [3, :singular, :male] => Hash[map_keys.zip(%w[he him his himself])],
-        [3, :singular, :female] => Hash[map_keys.zip(%w[she her her herself])],
-        [3, :singular, :other] => Hash[map_keys.zip(%w[they them their themselves])],
-        [3, :singular, :neutral] => Hash[map_keys.zip(%w[it it its itself])],
-        [1, :plural] => Hash[map_keys.zip(%w[we us our ourselves])],
-        [2, :plural] => Hash[map_keys.zip(%w[you you your yourselves])],
-        [3, :plural] => Hash[map_keys.zip(%w[they them their themselves])]
-      }
-    end
-
-    def map_keys
-      @map_keys ||= %i[subjective objective possessive reflexive]
-    end
-  end
-end

data/lib/gamefic-standard/grammar.rb

@@ -1,2 +0,0 @@
-require 'gamefic-standard/grammar/attributes'
-require 'gamefic-standard/grammar/pronoun'

data/lib/gamefic-standard/introduction.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-Gamefic::Standard.script do
-  introduction do |actor|
-    actor.name = 'myself'
-    actor.synonyms = 'self me yourself you'
-  end
-end

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

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

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

@@ -1,34 +0,0 @@
-# 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
-      @open = false
-    end
-    @locked
-  end
-
-  def open=(bool)
-    @open = bool
-    @locked = false if @open == true
-    @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

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

@@ -1,19 +0,0 @@
-# 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

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

data/lib/gamefic-standard/modules.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require 'gamefic-standard/modules/standardized'
-require 'gamefic-standard/modules/enterable'
-require 'gamefic-standard/modules/openable'
-require 'gamefic-standard/modules/lockable'

data/lib/gamefic-standard/pathfinder.rb

@@ -1,62 +0,0 @@
-#   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
-
-  # @return [Array<Room>]
-  def path
-    # @path is nil if the path is invalid, but #path should return an empty
-    # array instead.
-    @path || []
-  end
-
-  # @return [Boolean]
-  def valid?
-    path.length > 0 || origin == destination
-  end
-
-  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
-        end
-      }
-      path.push nil
-    }
-    @paths += new_paths
-    @paths.delete_if{|path| path.last.nil?}
-  end
-end

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

data/spec-opal/spec_helper.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require 'gamefic-standard'
-
-class TestPlot < Gamefic::Plot
-  include Gamefic::Standard
-end
-
-RSpec.configure do |config|
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-
-  config.after :each do
-    TestPlot.blocks.clear
-  end
-end