gamefic 1.6.0 → 2.0.3

data/bin/gamefic

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'gamefic'
-require 'gamefic/shell'
-
-# Make play the default command if the first argument is an existing file
-args = %w(play help).include?(ARGV[0]) || ARGV.count.zero? || !File.exist?(ARGV[0]) ? ARGV : ARGV.dup.unshift('play')
-
-Gamefic::Shell.start(args)

data/lib/gamefic/character.rb

@@ -1,232 +0,0 @@
-#require 'gamefic/director'
-
-
-module Gamefic
-  class NotConclusionError < Exception
-  end
-
-  class Character < Entity
-    autoload :State, 'gamefic/character/state'
-
-    attr_reader :queue, :user
-    # @return [Gamefic::Action]
-    attr_reader :last_action
-    # @return [Entity,nil]
-    attr_reader :last_object
-    attr_accessor :object_of_pronoun
-    attr_reader :scene
-    attr_reader :next_scene
-    attr_accessor :playbook
-    
-    include Character::State
-
-    def initialize(args = {})
-      super
-      @queue = Array.new
-      @messages = ''
-      @buffer_stack = 0
-      @buffer = ""
-    end
-    
-    # Connect a User.
-    #
-    # @param user [User]
-    def connect(user)
-      @user = user
-    end
-    
-    # Disconnect the current User.
-    #
-    def disconnect
-      @user = nil
-    end
-
-    # Send a message to the entity.
-    # This method will automatically wrap the message in HTML paragraphs.
-    # To send a message without paragraph formatting, use #stream instead.
-    #
-    # @param message [String]
-    def tell(message)
-      if @buffer_stack > 0
-        @buffer += message
-      else
-        super
-      end
-    end
-
-    # Send a message to the Character as raw text.
-    # Unlike #tell, this method will not wrap the message in HTML paragraphs.
-    #
-    # @param message [String]
-    def stream(message)
-      if @buffer_stack > 0
-        @buffer += message
-      else
-        super
-      end
-    end
-
-    # Perform a command.
-    # The command can be specified as a String or a set of tokens. Either form
-    # should yield the same result, but using tokens can yield better
-    # performance since it bypasses the parser.
-    #
-    # The command will be executed immediately regardless of game state.
-    #
-    # @example Send a command as a string
-    #   character.perform "take the key"
-    #
-    # @example Send a command as a set of tokens
-    #   character.perform :take, @key
-    #
-    def perform(*command)
-      #Director.dispatch(self, *command)
-      actions = playbook.dispatch(self, *command)
-      a = actions.first
-      okay = true
-      unless a.meta?
-        playbook.validators.each { |v|
-          result = v.call(self, a.verb, a.parameters)
-          okay = (result != false)
-          break if not okay
-        }
-      end
-      if okay
-        performance_stack.push actions
-        proceed
-        performance_stack.pop
-      end
-      a
-    end
-    
-    # Quietly perform a command.
-    # This method executes the command exactly as #perform does, except it
-    # buffers the resulting output instead of sending it to the user.
-    #
-    # @return [String] The output that resulted from performing the command.
-    def quietly(*command)
-      if @buffer_stack == 0
-        @buffer = ""
-      end
-      @buffer_stack += 1
-      self.perform *command
-      @buffer_stack -= 1
-      @buffer
-    end
-
-    # Proceed to the next Action in the current stack.
-    # This method is typically used in Action blocks to cascade through
-    # multiple implementations of the same verb.
-    #
-    # @example Proceed through two implementations of a verb
-    #   introduction do |actor|
-    #     actor[:has_eaten] = false # Initial value
-    #   end
-    #   respond :eat do |actor|
-    #     actor.tell "You eat something."
-    #     actor[:has_eaten] = true
-    #   end
-    #   respond :eat do |actor|
-    #     # This version will be executed first because it was implemented last
-    #     if actor[:has_eaten]
-    #       actor.tell "You already ate."
-    #     else
-    #       actor.proceed # Execute the previous implementation
-    #     end
-    #   end
-    #
-    def proceed quietly: false
-      #Director::Delegate.proceed_for self
-      return if performance_stack.empty?
-      a = performance_stack.last.shift
-      unless a.nil?
-        if quietly
-          if @buffer_stack == 0
-            @buffer = ""
-          end
-          @buffer_stack += 1
-        end
-        a.execute
-        if quietly
-          @buffer_stack -= 1
-          @buffer
-        end
-      end
-    end
-
-    # Immediately start a new scene for the character.
-    # Use #prepare if you want to declare a scene to be started at the
-    # beginning of the next turn.
-    #
-    def cue new_scene
-      @next_scene = nil
-      if new_scene.nil?
-        @scene = nil
-      else
-        @scene = new_scene.new(self)
-        @scene.start
-      end
-    end
-
-    # Prepare a scene to be started for this character at the beginning of the
-    # next turn.
-    #
-    def prepare s
-      @next_scene = s
-    end
-
-    # Return true if the character is expected to be in the specified scene on
-    # the next turn.
-    #
-    # @return [Boolean]
-    def will_cue? scene
-      (@scene.class == scene and @next_scene.nil?) or @next_scene == scene
-    end
-
-    # Cue a conclusion. This method works like #cue, except it will raise a
-    # NotConclusionError if the scene is not a Scene::Conclusion.
-    #
-    def conclude scene
-      raise NotConclusionError unless scene <= Scene::Conclusion
-      cue scene
-    end
-
-    # True if the character is in a conclusion.
-    #
-    # @return [Boolean]
-    def concluded?
-      !scene.nil? and scene.kind_of?(Scene::Conclusion)
-    end
-
-    def performed order
-      order.freeze
-      @last_action = order
-    end
-
-    # Get the prompt that the user should see for the current scene.
-    #
-    # @return [String]
-    #def prompt
-    #  scene.nil? ? '>' : scene.prompt
-    #end
-
-    def accessible?
-      false
-    end
-
-    def inspect
-      to_s
-    end
-
-    private
-
-    def delegate_stack
-      @delegate_stack ||= []
-    end
-
-    def performance_stack
-      @performance_stack ||= []
-    end
-  end
-
-end

data/lib/gamefic/character/state.rb

@@ -1,12 +0,0 @@
-module Gamefic
-  class Character
-    module State
-      def state
-        @state = {}
-        @state.merge! scene.state unless scene.nil?
-        @state.merge! output: messages
-        @state
-      end
-    end
-  end
-end

data/lib/gamefic/engine.rb

@@ -1,7 +0,0 @@
-module Gamefic
-
-  module Engine
-    autoload :Base, 'gamefic/engine/base'
-  end
-
-end

data/lib/gamefic/engine/base.rb

@@ -1,66 +0,0 @@
-module Gamefic
-
-  # Basic functionality for running a single-player game from a console.
-  #
-  class Engine::Base
-    attr_writer :user_class
-    attr_reader :plot
-
-    def initialize(plot)
-      @plot = plot
-      post_initialize
-    end
-
-    def post_initialize
-      # Override in subclasses
-    end
-
-    def user_class
-      @user_class ||= Gamefic::User::Base
-    end
-
-    def connect
-      @character = @plot.make Character, name: 'yourself', synonyms: 'self myself you me', proper_named: true
-      @user = user_class.new
-      @character.connect @user
-      @character
-    end
-
-    def run
-      connect
-      @plot.introduce @character
-      @user.update @character.state
-      turn until @character.concluded?
-      #print @user.flush
-    end
-
-    def turn
-      @plot.ready
-      unless @character.state[:options].nil?
-        list = '<ol class="multiple_choice">'
-        @character.state[:options].each { |o|
-          list += "<li><a href=\"#\" rel=\"gamefic\" data-command=\"#{o}\">#{o}</a></li>"
-        }
-        list += "</ol>"
-        @character.tell list
-      end
-      #print @user.flush
-      @user.update @character.state
-      #@character.flush
-      if @character.queue.empty?
-        receive
-      end
-      @plot.update
-      #print @user.flush
-      @user.update @character.state
-      #@character.flush
-    end
-
-    def receive
-      print @character.scene.prompt + ' '
-      input = STDIN.gets
-      @character.queue.push input unless input.nil?
-    end
-  end
-
-end

data/lib/gamefic/engine/tty.rb

@@ -1,24 +0,0 @@
-require 'gamefic/user/tty'
-
-module Gamefic
-
-  # Extend Engine::Base to connect with User::Tty, which provides ANSI
-  # formatting for HTML.
-  #
-  # @note Due to their dependency on io/console, User::Tty and Engine::Tty are
-  #   not included in the core Gamefic library. `require gamefic/tty` if you
-  #   need them.
-  #
-  class Engine::Tty < Engine::Base
-    def post_initialize
-      self.user_class = Gamefic::User::Tty
-    end
-
-    def self.start plot
-      engine = self.new(plot)
-      engine.connect
-      engine.run
-    end
-  end
-
-end

data/lib/gamefic/grammar.rb

@@ -1,13 +0,0 @@
-module Gamefic
-  module Grammar
-    autoload :Tense, 'gamefic/grammar/tense'
-    autoload :Pronouns, 'gamefic/grammar/pronouns'
-    autoload :Conjugator, 'gamefic/grammar/conjugator'
-    autoload :Verbs, 'gamefic/grammar/verbs'
-    autoload :VerbSet, 'gamefic/grammar/verb_set'
-    autoload :Person, 'gamefic/grammar/person'
-    autoload :Plural, 'gamefic/grammar/plural'
-    autoload :Gender, 'gamefic/grammar/gender'
-    autoload :WordAdapter, 'gamefic/grammar/word_adapter'
-  end
-end

data/lib/gamefic/grammar/conjugator.rb

@@ -1,20 +0,0 @@
-require 'gamefic'
-require 'gamefic/grammar'
-
-module Gamefic::Grammar
-  module Conjugator    
-    module ClassMethods
-      @@conjugated_verbs = {}
-      def conjugate infinitive, tense, *forms
-        @@conjugated_verbs[infinitive] ||= {}
-        @@conjugated_verbs[infinitive][tense] = VerbSet.new(infinitive, *forms)
-      end
-      def conjugated_verbs
-        @@conjugated_verbs
-      end
-    end
-    #def self.included(base)
-    #  base.extend ClassMethods
-    #end
-  end
-end

data/lib/gamefic/grammar/gender.rb

@@ -1,11 +0,0 @@
-require 'gamefic/grammar'
-
-module Gamefic::Grammar
-  module Gender
-    attr_writer :gender
-    def gender
-      # Supported values are "male", "female", "other", and "neutral"
-      @gender ||= (self.kind_of?(Character) ? "other" : "neutral")
-    end
-  end
-end

data/lib/gamefic/grammar/person.rb

@@ -1,10 +0,0 @@
-require 'gamefic/grammar'
-
-module Gamefic::Grammar
-  module Person
-    attr_writer :person
-    def person
-      @person ||= 3
-    end
-  end
-end

data/lib/gamefic/grammar/plural.rb

@@ -1,13 +0,0 @@
-require 'gamefic/grammar'
-
-module Gamefic::Grammar
-  module Plural
-    attr_writer :plural
-    def plural?
-      if @plural.nil?
-        @plural = false
-      end
-      @plural
-    end
-  end
-end

data/lib/gamefic/grammar/pronouns.rb

@@ -1,105 +0,0 @@
-require 'gamefic'
-require 'gamefic/grammar'
-
-module Gamefic::Grammar
-  class Pronouns
-    def initialize object
-      @object = object
-    end
-    
-    # Get the subjective pronoun (I, you, we, etc.)
-    #
-    # @return [String]
-    def subj
-      Pronouns.get_pronoun_set(@object)[0]
-    end
-    
-    # Get the objective pronoun (me, them, us, etc.)
-    #
-    # @return [String]
-    def obj
-      Pronouns.get_pronoun_set(@object)[1]
-    end
-    
-    # Get the possessive pronoun (my, your, our, etc.)
-    #
-    # @return [String]
-    def poss
-      Pronouns.get_pronoun_set(@object)[2]
-    end
-    
-    # Get the reflexive pronoun (myself, yourself, etc.)
-    #
-    # @return [String]
-    def reflex
-      Pronouns.get_pronoun_set(@object)[3]
-    end
-    
-    # Get the capitalized subjective pronoun
-    #
-    # @return [String]
-    def Subj
-      subj.cap_first
-    end
-    
-    # Get the capitalized objective pronoun
-    #
-    # @return [String]
-    def Obj
-      obj.cap_first
-    end
-    
-    # Get the capitalized possessive pronoun
-    #
-    # @return [String]
-    def Poss
-      obj.cap_first
-    end
-    
-    # Get the capitalized reflexive pronoun
-    #
-    # @return [String]
-    def Reflex
-      reflex.cap_first
-    end
-    
-    # Get a an array of pronouns based on the person, gender, and plurality of
-    # the provided object.
-    #
-    # @param obj An object that responds to #person, #gender, and #plural
-    # @return [Array<String>]
-    def self.get_pronoun_set(obj)
-      set = Pronouns.sets["#{obj.person}"]
-      if set.nil?
-        set = Pronouns.sets["#{obj.person}:#{obj.plural? ? 'plural' : 'singular'}"]
-      end
-      if set.nil?
-        set = Pronouns.sets["#{obj.person}:#{obj.plural? ? 'plural' : 'singular'}:#{obj.gender}"]
-      end
-      if set.nil?
-        raise "Pronoun set could not be determined"
-      end
-      set
-    end
-    
-    # TODO Consider implementing method_missing to determine correct pronoun
-    # from example, e.g., "he" would change to "she" for female entities
-    def self.sets
-      if @sets.nil?
-        @sets = {}
-        @sets["1:singular"] = ["I", "me", "my", "myself"]
-        @sets["2"] = ["you", "you", "your", "yourself"]
-        @sets["3:singular:male"] = ["he", "him", "his", "himself"]
-        @sets["3:singular:female"] = ["she", "her", "her", "herself"]
-        # "other" refers to a person or living being that is neither
-        # male or female or for whom gender is unspecified. It's
-        # typically used to avoid referring to a person as "it."
-        @sets["3:singular:other"] = ["they", "them", "their", "themselves"]
-        @sets["3:singular:neutral"] = ["it", "it", "its", "itself"]
-        @sets["1:plural"] = ["we", "us", "our", "ourselves"]
-        @sets["3:plural"] = ["they", "them", "their", "themselves"]
-      end
-      @sets
-    end
-  end
-end