gamefic-standard 2.0.0

data/lib/gamefic-standard/modules.rb

@@ -0,0 +1,7 @@
+# The StandardMethods module provides a namespace to define additional methods
+# for plots and subplots. Examples include the `connect` method for creating
+# portals between rooms.
+#
+
+require 'gamefic-standard/modules/use'
+require 'gamefic-standard/modules/enterable'

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

@@ -0,0 +1,19 @@
+module Enterable
+  attr_writer :enterable, :leave_verb, :enter_verb, :inside_verb
+
+  def enterable?
+    @enterable ||= false
+  end
+
+  def inside_verb
+    @inside_verb ||= "be in"
+  end
+
+  def enter_verb
+    @enter_verb ||= "enter"
+  end
+
+  def leave_verb
+    @leave_verb ||= "leave"
+  end
+end

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

@@ -0,0 +1,45 @@
+module Use
+  def self.children *args
+    Gamefic::Query::Children.new *args
+  end
+
+  def self.family *args
+    Gamefic::Query::Family.new *args
+  end
+
+  def self.parent *args
+    Gamefic::Query::Parent.new *args
+  end
+
+  def self.siblings *args
+    Gamefic::Query::Siblings.new *args
+  end
+
+  def self.text *args
+    Gamefic::Query::Text.new *args
+  end
+
+  def self.available *args
+    Gamefic::Query::Available.new *args
+  end
+
+  def self.reachable *args
+    available *args
+  end
+
+  def self.visible *args
+    available *args
+  end
+
+  def self.room *args
+    Gamefic::Query::Room.new *args
+  end
+
+  def self.itself *args
+    Gamefic::Query::Room.new *args
+  end
+
+  def self.from objects, *args
+    Gamefic::Query::External.new objects, *args
+  end
+end

data/lib/gamefic-standard/openable.rb

@@ -0,0 +1,49 @@
+# @gamefic.script standard/openable
+
+# 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
+
+Gamefic.script do
+  respond :open, Use.available do |actor, thing|
+    actor.tell "You can't open #{the thing}."
+  end
+
+  respond :open, Use.available(Openable) do |actor, thing|
+    if thing.open?
+      actor.tell "#{The thing} is already open."
+    else
+      actor.tell "You open #{the thing}."
+      thing.open = true
+    end
+  end
+
+  respond :close, Use.available do |actor, thing|
+    actor.tell "You can't close #{the thing}."
+  end
+
+  respond :close, Use.available(Openable) do |actor, thing|
+    if thing.open?
+      actor.tell "You close #{the thing}."
+      thing.open = false
+    else
+      actor.tell "#{The thing} is already open."
+    end
+  end
+end

data/lib/gamefic-standard/pathfinder.rb

@@ -0,0 +1,65 @@
+# @gamefic.script standard/pathfinder
+#   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
+      while @path.nil? and @paths.length > 0
+        embark
+      end
+    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 or 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

@@ -0,0 +1,25 @@
+class Gamefic::Query::Available < Gamefic::Query::Base
+  def context_from(subject)
+    result = []
+    top = subject.room || subject.parent
+    unless top.nil?
+      result.concat subquery_accessible(top)
+    end
+    result.delete subject
+    subject.children.each { |c|
+      result.push c
+      result.concat subquery_accessible(c)
+    }
+    result
+  end
+end
+
+class Gamefic::Query::Room < Gamefic::Query::Base
+  def context_from(subject)
+    subject.room ? [subject.room] : []
+  end
+end
+
+Gamefic.script do
+  set_default_query Gamefic::Query::Available
+end

data/lib/gamefic-standard/test.rb

@@ -0,0 +1,36 @@
+# @gamefic.script standard/test
+
+module Tester
+  def test_procs
+    @test_procs ||= Hash.new
+  end
+
+  def on_test name = :me, &block
+    test_procs[name] = block
+  end
+
+  def run_test name, actor
+    queue = []
+    test_procs[name].call(actor, queue)
+    actor.queue.concat queue
+  end
+end
+
+class Gamefic::Plot
+  include Tester
+end
+
+class Gamefic::Subplot
+  include Tester
+end
+
+Gamefic.script do
+  meta :test, Gamefic::Query::Text.new do |actor, name|
+    sym = name.to_sym
+    if test_procs[sym].nil?
+      actor.tell "There's no test named '#{name}' in this game."
+    else
+      run_test sym, actor
+    end
+  end
+end

data/lib/gamefic-standard/version.rb

@@ -0,0 +1,5 @@
+module Gamefic
+  module Standard
+    VERSION = '2.0.0'
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: gamefic-standard
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Fred Snyder
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gamefic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description: A collection of components for building games and interactive fiction
+  in Gamefic.
+email:
+- fsnyder@castwide.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".vscode/launch.json"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gamefic-standard.gemspec
+- lib/gamefic-standard.rb
+- lib/gamefic-standard/actions.rb
+- lib/gamefic-standard/actions/drop.rb
+- lib/gamefic-standard/actions/enter.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/look.rb
+- lib/gamefic-standard/actions/nil.rb
+- lib/gamefic-standard/actions/place.rb
+- lib/gamefic-standard/actions/quit.rb
+- lib/gamefic-standard/actions/take.rb
+- lib/gamefic-standard/actions/talk.rb
+- lib/gamefic-standard/actions/wait.rb
+- lib/gamefic-standard/articles.rb
+- lib/gamefic-standard/clothing.rb
+- lib/gamefic-standard/clothing/actions.rb
+- lib/gamefic-standard/clothing/actions/doff.rb
+- lib/gamefic-standard/clothing/actions/drop.rb
+- lib/gamefic-standard/clothing/actions/inventory.rb
+- lib/gamefic-standard/clothing/actions/wear.rb
+- lib/gamefic-standard/clothing/entities.rb
+- lib/gamefic-standard/clothing/entities/clothing.rb
+- lib/gamefic-standard/clothing/entities/coat.rb
+- lib/gamefic-standard/clothing/entities/gloves.rb
+- lib/gamefic-standard/clothing/entities/hat.rb
+- lib/gamefic-standard/clothing/entities/pants.rb
+- lib/gamefic-standard/clothing/entities/shirt.rb
+- lib/gamefic-standard/clothing/entities/shoes.rb
+- lib/gamefic-standard/container.rb
+- lib/gamefic-standard/direction.rb
+- lib/gamefic-standard/edible.rb
+- lib/gamefic-standard/entities.rb
+- lib/gamefic-standard/entities/character.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/give.rb
+- lib/gamefic-standard/grammar.rb
+- lib/gamefic-standard/grammar/attributes.rb
+- lib/gamefic-standard/grammar/pronoun.rb
+- lib/gamefic-standard/lockable.rb
+- lib/gamefic-standard/modules.rb
+- lib/gamefic-standard/modules/enterable.rb
+- lib/gamefic-standard/modules/use.rb
+- lib/gamefic-standard/openable.rb
+- lib/gamefic-standard/pathfinder.rb
+- lib/gamefic-standard/queries.rb
+- lib/gamefic-standard/test.rb
+- lib/gamefic-standard/version.rb
+homepage: http://gamefic.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: The Gamefic standard script library.
+test_files: []