gamefic 0.6.1 → 1.0.0

data/lib/gamefic/scene/multiple_choice.rb

@@ -0,0 +1,73 @@
+module Gamefic
+
+  # Provide a list of options and process the selection in the scene's finish
+  # block. After the scene is finished, the :active scene will be cued unless
+  # some other scene has already been prepared or cued.
+  #
+  # The finish block's input parameter receives a MultipleChoice::Input object
+  # instead of a String.
+  #
+  class Scene::MultipleChoice < Scene::Custom
+    autoload :Input, 'gamefic/scene/multiple_choice/input'
+    
+    def initialize config = {}
+      super
+      @options = (config[:options] || [])
+      @invalid_choice_message = config[:invalid_choice_message]
+    end
+    
+    def start actor
+      @current_options = @options.clone
+      @start.call(actor, @current_options) unless @start.nil?
+      tell_choices actor
+    end
+    
+    def finish actor, input
+      this_scene = actor.scene
+      index = nil
+      choice = nil
+      if input.strip =~ /[0-9]+/ and input.to_i > 0
+        index = input.to_i - 1
+        choice = @current_options[index]
+      else
+        index = 0
+        @current_options.each { |o|
+          if o.casecmp(input).zero?
+            choice = o
+            break
+          end
+          index += 1
+        }
+      end
+      if choice.nil?
+        actor.tell invalid_choice_message
+        tell_choices actor
+      else
+        input_object = Input.new(input, index, choice)
+        super actor, input_object
+        actor.cue :active if (actor.scene == this_scene and actor.next_scene.nil?)
+      end
+    end
+
+    def prompt
+      @prompt ||= "Enter a choice:"
+    end
+    
+    def invalid_choice_message
+      @invalid_choice_message ||= "That's not a valid selection."
+    end
+    
+    private
+    
+    def tell_choices actor
+      list = '<ol class="multiple_choice">'
+      @current_options.each { |o|
+        list += "<li>#{o}</li>"
+      }
+      list += "</ol>"
+      actor.tell list
+    end
+    
+  end
+
+end

data/lib/gamefic/scene/passive.rb

@@ -0,0 +1,17 @@
+module Gamefic
+
+  # Passive Scenes immediately cue another scene after they're finished. If no
+  # scene has been cued or prepared, it defaults to the :active scene.
+  #
+  class Scene::Passive < Scene::Custom
+    def initialize &block
+      @start = block
+    end
+    def start actor
+      this_scene = actor.scene
+      super
+      actor.cue :active if (actor.scene == this_scene and actor.next_scene.nil?)     
+    end
+  end
+    
+end

data/lib/gamefic/scene/pause.rb

@@ -0,0 +1,24 @@
+module Gamefic
+
+  # Wait for input. After the scene is finished (e.g., the player presses
+  # Enter), the :active scene will be cued if no other scene has been prepared
+  # or cued.
+  #
+  class Scene::Pause < Scene::Custom
+    def initialize prompt = nil, &block
+      @prompt = prompt
+      @start = block
+    end
+    def start actor
+      @start_scene = actor.scene
+      super
+    end
+    def finish actor, input
+      actor.cue :active if (actor.scene == @start_scene and actor.next_scene.nil?)
+    end
+    def prompt
+      @prompt ||= "Press Enter to continue..."
+    end
+  end
+  
+end

data/lib/gamefic/scene/question.rb

@@ -0,0 +1,21 @@
+module Gamefic
+
+  # Question Scenes handle a string of arbitrary input. Examples include
+  # asking for a password, a destination, or a topic of conversation. The
+  # finish block is solely responsible for processing the answer.
+  # After the scene is finished, the :active scene will automatically be cued
+  # if no other scene has been cued or prepared.
+  #
+  class Scene::Question < Scene::Custom
+    def initialize prompt, &block
+      @prompt = prompt
+      @finish = block
+    end
+    def finish actor, input
+      this_scene = actor.scene
+      super
+      actor.cue :active if (actor.scene == this_scene and actor.next_scene.nil?)
+    end
+  end
+
+end

data/lib/gamefic/scene/yes_or_no.rb

@@ -0,0 +1,30 @@
+module Gamefic
+
+  # Prompt the user to answer "yes" or "no". The scene will accept variations
+  # like "YES" or "n" and normalize the answer to "yes" or "no" in the finish
+  # block. After the scene is finished, the :active scene will be cued if no
+  # other scene has been prepared or cued.
+  #
+  class Scene::YesOrNo < Scene::Custom
+    def initialize prompt = nil, &block
+      @prompt = prompt
+      @finish = block
+    end
+    def finish actor, input
+      answer = nil
+      if input.downcase[0, 1] == "y"
+        answer = "yes"
+      elsif input.downcase[0, 1] == "n"
+        answer = "no"
+      end
+      if answer.nil?
+        actor.tell "Please enter Yes or No."
+      else
+        this_scene = actor.scene
+        @finish.call actor, answer
+        actor.cue :active if (actor.scene == this_scene and actor.next_scene.nil?)
+      end
+    end
+  end
+
+end

data/lib/gamefic/scene.rb

@@ -1,125 +1,15 @@
 module Gamefic
 
-  # SceneManagers handle the creation and execution of player scenes.
-  #
-  # @example Create a scene that lets the player select a name.
-  #   scene_managers[:get_name] = SceneManager.new do |manager|
-  #     manager.state = "Active" # Tell the Engine that this scene accepts input
-  #     manager.prompt = "Enter your name:"
-  #     manager.start do |actor, data|
-  #       actor.tell "Let's start with a formal introduction."
-  #     end
-  #     manager.finish do |actor, data|
-  #       actor[:name] = data.input
-  #       actor.tell "Howdy, #{actor[:name]}!"
-  #       data.next_cue = :active # Proceed to the default :active scene
-  #     end
-  #   end
-  #
-  class SceneManager
-    attr_accessor :state
-    attr_writer :prompt
-    
-    def initialize &block
-      yield self if block_given?
-    end
-    
-    # Get the SceneData class that provide data about the current event to a
-    # Scene instance.
-    #
-    def data_class
-      SceneData
-    end
-    
-    # Get the name that describes this scene's state.
-    # Two common values for the state are Active and Passive. If a scene is
-    # Active, it is capable of accepting user input. If it is Passive, it
-    # is probably not interactive (e.g., a cutscene) and will usually cue
-    # an Active scene in order to continue gameplay.
-    #
-    # @return [String] The name of the state.
-    def state
-      @state ||= 'Passive'
-    end
-    
-    # Get the Scene class that the SceneManager uses to prepare a scene for
-    # the plot.
-    #
-    def scene_class
-      Scene
-    end
-    
-    # Define a Block to be executed when the scene starts. The Engine should
-    # execute this block before the player is queried for input.
-    #
-    # @yieldparam [Character]
-    # @yieldparam [SceneData]
-    def start &block
-      @start = block
-    end
-    
-    # Define a Block to be executed when the scene finishes. The engine should
-    # process user input in this block.
-    #
-    # @yieldparam [Character]
-    # @yieldparam [SceneData]
-    def finish &block
-      @finish = block
-    end
-    
-    # Prepare a new Scene for execution.
-    #
-    # @return [Scene]
-    def prepare key
-      scene_class.new(self, key)
-    end
-    
-    # Get the prompt to display to the user when requesting input.
-    #
-    # @return [String]
-    def prompt
-      @prompt ||= ">"
-    end
-end
-  
-  class SceneData
-    attr_accessor :input, :prompt, :next_cue
+  module Scene
+    autoload :Base, 'gamefic/scene/base'
+    autoload :Custom, 'gamefic/scene/custom'
+    autoload :Active, 'gamefic/scene/active'
+    autoload :Passive, 'gamefic/scene/passive'
+    autoload :Pause, 'gamefic/scene/pause'
+    autoload :Conclusion, 'gamefic/scene/conclusion'
+    autoload :MultipleChoice, 'gamefic/scene/multiple_choice'
+    autoload :YesOrNo, 'gamefic/scene/yes_or_no'
+    autoload :Question, 'gamefic/scene/question'
   end
   
-  class Scene
-    attr_reader :data, :state, :key
-    
-    def initialize(manager, key)
-      @manager = manager
-      @start = manager.instance_variable_get(:@start)
-      @finish = manager.instance_variable_get(:@finish)
-      @state = manager.state
-      @data = manager.data_class.new
-      @data.prompt = manager.prompt
-      @key = key
-    end
-    
-    # Start the scene. This method is typically called by the Plot.
-    #
-    # @param actor [Character] The Scene's Character.
-    def start actor
-      return if @start.nil?
-      @data.input = nil
-      @start.call actor, @data
-    end
-    
-    # Finish the scene. This method is typically called by the Plot.
-    # The Finish method is responsible for processing any input received
-    # from players.
-    #
-    # @param actor [Character] The Scene's Character.
-    # @param input [String] Input received from the Character (e.g., a player command).
-    def finish actor, input
-      @data.next_cue ||= :active
-      return if @finish.nil?
-      @data.input = input
-      @finish.call actor, @data
-    end
-  end
-
 end

data/lib/gamefic/script/base.rb

@@ -11,18 +11,23 @@ module Gamefic
     def read
       raise "#read must be defined in subclasses"
     end
-    # Get the script's path
+    # Get the script's path.
     #
     # @return [String]
     def path
       raise "#path must be defined in subclasses"
     end
-    # Get the absolute path of the script's original file
+    # Get the absolute path of the script's original file, or its URL for
+    # sources that are not file-based.
     #
     # @return [String]
     def absolute_path
       raise "#absolute_path must be defined in subclasses"
     end
+    # Script objects are equal if their relative paths are the same. Note that
+    # they are still considered equal if their absolute paths are different,
+    # or even if they come from different types of sources.
+    #
     # @param other[Script::Base]
     # @return [Boolean]
     def==(other)

data/lib/gamefic/script.rb

@@ -1,5 +1,9 @@
 module Gamefic
 
+  # Script classes provide code to be executed in Plots. They are accessed
+  # through Source classes, e.g., a Source::Text object is used to find
+  # Source::Files. 
+  #
   module Script
     autoload :Base, 'gamefic/script/base'
     autoload :File, 'gamefic/script/file'

data/lib/gamefic/shell/command/base.rb

@@ -0,0 +1,38 @@
+require 'gamefic/shell'
+require 'slop'
+
+class Gamefic::Shell::Command::Base
+  # Execute the command
+  #
+  def run input
+    raise "Unimplemented command"
+  end
+  
+  # Get the options for the command
+  #
+  # @return [Slop::Options]
+  def options
+    @options ||= Slop::Options.new
+  end
+  
+  # Get the help documentation for this command.
+  #
+  # @return [String]
+  def help
+    optons.to_s
+  end
+  
+  protected
+  
+  # @return [Slope::Result]
+  def parse input
+    parser.parse input
+  end
+  
+  private
+
+  # @return [Slop::Parser]  
+  def parser
+    @parser ||= Slop::Parser.new(options)
+  end
+end

data/lib/gamefic/shell/command/play.rb

@@ -0,0 +1,51 @@
+require 'zip'
+require 'tmpdir'
+require 'gamefic/engine/tty'
+require 'gamefic/shell'
+require 'yaml'
+
+class Gamefic::Shell::Command::Play < Gamefic::Shell::Command::Base
+  include Gamefic
+  
+  def run input
+    result = parse input
+    file = result.arguments[1]
+    raise "File not specified." if file.nil?
+    raise "'#{file}' does not exist." if !File.exist?(file)
+    raise "'#{file}' is a directory." if File.directory?(file)
+    play file
+  end
+
+  private
+  
+  def decompress(zipfile, destination)
+    Zip::File.open(zipfile) do |z|
+      z.each do |entry|
+        FileUtils.mkdir_p File.join(destination, File.dirname(entry.name))
+        full_path = File.join(destination, entry.name)
+        if !File.exist?(full_path)
+          entry.extract full_path
+        end
+      end
+    end
+  end
+
+  def play file
+    Dir.mktmpdir 'gamefic_' do |dir|
+      puts "Loading..."
+      story = Plot.new(Source::File.new(File.join(dir, 'scripts')))
+      begin
+        decompress file, dir
+      rescue Exception => e
+        puts "'#{file}' does not appear to be a valid Gamefic file."
+        #puts "Error: #{e.message}"
+        #exit 1
+      end
+      story.script 'main'
+      story.metadata = YAML.load_file File.join(dir, 'metadata.yaml')
+      engine = Tty::Engine.new story
+      puts "\n"
+      engine.run
+    end    
+  end
+end

data/lib/gamefic/shell/command.rb

@@ -0,0 +1,4 @@
+module Gamefic::Shell::Command
+  autoload :Base, 'gamefic/shell/command/base'
+  autoload :Play, 'gamefic/shell/command/play'
+end

data/lib/gamefic/shell/registry.rb

@@ -0,0 +1,13 @@
+module Gamefic
+  class Shell
+    module Registry
+      @commands = {}
+      def self.register cmd, cls
+        @commands[cmd] = cls
+      end
+      def self.get_command_class cmd
+        @commands[cmd]
+      end
+    end
+  end
+end

data/lib/gamefic/shell.rb

@@ -1,82 +1,25 @@
-require 'zip'
-require 'tmpdir'
-require 'getoptlong'
-require 'gamefic/engine/tty'
-
 module Gamefic
 
   class Shell
-    attr_accessor :argv
+    autoload :Command, 'gamefic/shell/command'
+    
     def initialize
+      @commands = {}
+    end
     
+    def register cmd, cls
+      @commands[cmd] = cls
     end
+    
     def execute
-      if ARGV.length == 0
-        ARGV.push 'help'
-      end
-      cmd = ARGV.shift
-      case cmd
-        when 'play'
-          play ARGV.shift
-        when 'help'
-          help ARGV.shift
-        else
-          play cmd
+      command = ARGV[0]
+      cls = @commands[command]
+      if cls.nil?
+        Gamefic::Shell::Command::Play.new.run(['play'] + ARGV)
+      else
+        cls.new.run ARGV
       end
     end
-    private
-      def play file
-        if !File.exist?(file)
-          puts "'#{file}' does not exist."
-          exit 1
-        end
-        if File.directory?(file)
-          puts "'#{file}' is not a Gamefic file."
-          exit 1
-        end
-        Dir.mktmpdir 'gamefic_' do |dir|
-          puts "Loading..."
-          story = Plot.new(Source.new(dir + '/scripts'))
-          begin
-            decompress file, dir
-          rescue Exception => e
-            puts "'#{file}' does not appear to be a valid Gamefic file."
-            puts e.backtrace
-            exit 1
-          end
-          story.load dir + '/main'
-          engine = Tty::Engine.new story
-          puts "\n"
-          engine.run
-        end
-      end
-      def help command
-        shell_script = File.basename($0)
-        case command
-          when "play"
-            puts <<EOS
-#{shell_script} play [file]
-Play a Gamefic file on the command line.
-EOS
-          when nil, "help"
-          puts <<EOS
-#{shell_script} play [file] - play a Gamefic file
-#{shell_script} help - display this message
-#{shell_script} help [command] - display info about command
-EOS
-        else
-          puts "Unrecognized command '#{command}'"
-          exit 1
-        end
-      end
-      def decompress(zipfile, destination)
-        Zip::File.open(zipfile) do |z|
-          z.each do |entry|
-            FileUtils.mkdir_p "#{destination}/#{File.dirname(entry.name)}"
-            entry.extract "#{destination}/#{entry.name}"
-          end
-        end
-      end
   end
-
+  
 end

data/lib/gamefic/source/file.rb

@@ -10,7 +10,7 @@ module Gamefic
     def export path
       @directories.each { |directory|
         @@extensions.each { |ext|
-          abs_file = directory + '/' + path + ext
+          abs_file = File.join(directory, path + ext)
           if File.file?(abs_file)
             return Script::File.new(abs_file, path)
           end

data/lib/gamefic/source.rb

@@ -1,5 +1,10 @@
 module Gamefic
 
+  # Plots use Source classes to fetch scripts to be executed. The most common
+  # type of Source class is Source::File, which searches for scripts in
+  # a predefined list of directories on the filesystem, similar to the way
+  # that Kernel#require works.
+  #
   module Source
     autoload :Base, 'gamefic/source/base'
     autoload :File, 'gamefic/source/file'

data/lib/gamefic/tester.rb

@@ -13,7 +13,6 @@ module Gamefic
       actor[:test_queue] = queue
       actor[:test_queue_length] = queue.length
       actor[:test_queue_scene] = actor.scene
-      actor[:testing] = true
     end
   end
 

data/lib/gamefic/version.rb

@@ -1,3 +1,3 @@
 module Gamefic
-  VERSION = '0.6.1'
+  VERSION = '1.0.0'
 end

data/lib/gamefic.rb

@@ -7,11 +7,6 @@ require 'gamefic/serialized'
 require 'gamefic/entity'
 require 'gamefic/character'
 require "gamefic/scene"
-require "gamefic/scene/active"
-require "gamefic/scene/concluded"
-require "gamefic/scene/paused"
-require "gamefic/scene/multiplechoice"
-require "gamefic/scene/yesorno"
 require "gamefic/query"
 require "gamefic/action"
 require "gamefic/syntax"
@@ -20,4 +15,4 @@ require "gamefic/director"
 require "gamefic/plot"
 require "gamefic/engine"
 require "gamefic/direction"
-require "gamefic/snapshots"
+require "gamefic/version"