gamefic 1.3.2 → 1.4.0

data/lib/gamefic/scene.rb

@@ -1,15 +1,16 @@
+require 'gamefic/scene_data'
+
 module Gamefic
 
   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 :MultipleScene, 'gamefic/scene/multiple_scene'
     autoload :YesOrNo, 'gamefic/scene/yes_or_no'
-    autoload :Question, 'gamefic/scene/question'
   end
   
 end

data/lib/gamefic/scene/active.rb

@@ -5,13 +5,8 @@ module Gamefic
   # a Plot.
   #
   class Scene::Active < Scene::Base
-    def start actor
-      # TODO Anything necessary here?
-    end
     def finish actor, input
-      last_order = actor.perform input
-      # HACK Set the last_order here so inline performs don't set it
-      actor.send(:last_order=, last_order)
+      actor.perform input, from_user: true
     end
   end
   

data/lib/gamefic/scene/base.rb

@@ -1,21 +1,47 @@
-module Gamefic::Scene
+module Gamefic
   
   # The Base Scene is not intended for instantiation. Other Scene classes
   # should inherit from it.
   #
-  class Base
-    def prompt
-      @prompt ||= '>'
-    end
+  class Scene::Base
     def start actor
-      
+      start_data_for actor
     end
+
     def finish actor, input
-      
+      finish_data_for actor, input
     end
-    def state
+    
+    def type
       self.class.to_s.split('::').last
     end
+
+    def data_class
+      SceneData::Base
+    end
+
+    # Get the prompt to be displayed to the user when accepting input.
+    #
+    # @return [String] The text to be displayed.
+    def prompt_for actor
+      character_data[actor].prompt || '>'
+    end
+
+    private
+
+    def character_data
+      @character_data ||= {}
+    end
+
+    def start_data_for actor
+      character_data[actor] = data_class.new
+    end
+
+    def finish_data_for actor, input
+      data = character_data[actor]
+      data.input = input.strip
+      data
+    end
   end
   
 end

data/lib/gamefic/scene/conclusion.rb

@@ -3,9 +3,6 @@ module Gamefic
   # A Conclusion ends the Plot (or the character's participation in it).
   #
   class Scene::Conclusion < Scene::Custom
-    def initialize &block
-      @start = block
-    end
   end
   
 end

data/lib/gamefic/scene/custom.rb

@@ -1,21 +1,42 @@
 module Gamefic
   
   # A Custom Scene is a generic scene that allows for complete configuration
-  # of its behavior upon instantiation. It is suitable for direct instantion
+  # of its behavior upon instantiation. It is suitable for direct instantiation
   # or extension by other Scene classes.
   #
   class Scene::Custom < Scene::Base
-    def initialize config = {}
-      @start = config[:start]
-      @finish = config[:finish]
-      @prompt = config[:prompt]
+    def initialize
+      yield self if block_given?
     end
+    def on_start &block
+      @start = block
+    end
+
+    def on_finish &block
+      @finish = block
+    end
+
     def start actor
-      @start.call(actor) unless @start.nil?
+      data = start_data_for(actor)
+      do_start_block actor, data
+      data
     end
+
     def finish actor, input
-      @finish.call(actor, input) unless @finish.nil?
+      data = finish_data_for(actor, input)
+      do_finish_block actor, data
+    end
+
+    private
+
+    def do_start_block actor, data
+      @start.call actor, data unless @start.nil?
+    end
+
+    def do_finish_block actor, data
+      @finish.call actor, data unless @finish.nil?
     end
+
   end
   
 end

data/lib/gamefic/scene/multiple_choice.rb

@@ -8,59 +8,52 @@ module Gamefic
   # 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]
+    def data_class
+      SceneData::MultipleChoice
     end
-    
+
     def start actor
-      @current_options = @options.clone
-      @start.call(actor, @current_options) unless @start.nil?
-      tell_choices actor
+      data = start_data_for(actor)
+      do_start_block actor, data
+      tell_options actor, data
     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]
+      data = finish_data_for(actor, input)
+      get_choice data
+      if data.selection.nil?
+        actor.tell data.invalid_message
+        tell_options actor, data
+      else
+        do_finish_block actor, data
+      end
+      data
+    end
+
+    private
+    
+    def get_choice data
+      if data.input.strip =~ /[0-9]+/ and data.input.to_i > 0
+        data.number = data.input.to_i
+        data.index = data.number - 1
+        data.selection = data.options[data.number - 1]
       else
         index = 0
-        @current_options.each { |o|
-          if o.casecmp(input).zero?
-            choice = o
+        data.options.each { |o|
+          if o.casecmp(data.input).zero?
+            data.selection = o
+            data.index = index
+            data.number = index + 1
             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
-      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
+    def tell_options actor, data
       list = '<ol class="multiple_choice">'
-      @current_options.each { |o|
+      data.options.each { |o|
         list += "<li>#{o}</li>"
       }
       list += "</ol>"

data/lib/gamefic/scene/multiple_scene.rb

@@ -0,0 +1,15 @@
+module Gamefic
+
+  class Scene::MultipleScene < Scene::Custom
+    def data_class
+      SceneData::MultipleScene
+    end
+
+    def finish actor, input
+      data = super
+      unless data.selection.nil?
+        actor.cue data.scene_for(selection)
+      end
+    end
+  end
+end

data/lib/gamefic/scene/pause.rb

@@ -1,23 +1,12 @@
 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.
+  # Pause for user input.
   #
   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..."
+      data = start_data_for(actor)
+      data.prompt = 'Press enter to continue...'
+      do_start_block actor, data
     end
   end
   

data/lib/gamefic/scene/yes_or_no.rb

@@ -6,23 +6,18 @@ module Gamefic
   # other scene has been prepared or cued.
   #
   class Scene::YesOrNo < Scene::Custom
-    def initialize prompt = nil, &block
-      @prompt = prompt
-      @finish = block
+    def data_class
+      SceneData::YesOrNo
     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
+      data = finish_data_for(actor, input)
+      if data.yes? or data.no?
         this_scene = actor.scene
-        @finish.call actor, answer
+        do_finish_block actor, data
         actor.cue :active if (actor.scene == this_scene and actor.next_scene.nil?)
+      else
+        actor.tell data.invalid_message
       end
     end
   end

data/lib/gamefic/scene_data.rb

@@ -0,0 +1,9 @@
+module Gamefic
+
+  module SceneData
+    autoload :Base, 'gamefic/scene_data/base'
+    autoload :MultipleChoice, 'gamefic/scene_data/multiple_choice'
+    autoload :YesOrNo, 'gamefic/scene_data/yes_or_no'
+  end
+
+end

data/lib/gamefic/scene_data/base.rb

@@ -0,0 +1,12 @@
+module Gamefic
+
+  class SceneData::Base
+    attr_writer :prompt
+    attr_accessor :input
+    
+    def prompt
+      @prompt ||= '>'
+    end
+  end
+
+end

data/lib/gamefic/scene_data/multiple_choice.rb

@@ -0,0 +1,19 @@
+module Gamefic
+
+  class SceneData::MultipleChoice < SceneData::Base
+    attr_accessor :selection
+    attr_accessor :number
+    attr_accessor :index
+    attr_writer :invalid_message
+    def options
+      @options ||= []
+    end
+    def prompt
+      @prompt ||= 'Enter a choice:'
+    end
+    def invalid_message
+      @invalid_message ||= 'That is not a valid choice.'
+    end
+  end
+
+end

data/lib/gamefic/scene_data/multiple_scene.rb

@@ -0,0 +1,25 @@
+module Gamefic
+
+  class SceneData::MultipleScene < SceneData::MultipleChoice
+    attr_accessor :selection
+    attr_accessor :number
+    def options
+      scene_map.keys
+    end
+
+    def map choice, scene
+      scene_map[choice] = scene
+    end
+
+    def scene_for choice
+      scene_map[choice]
+    end
+
+    private
+
+    def scene_map
+      @scene_map ||= {}
+    end
+  end
+
+end

data/lib/gamefic/scene_data/yes_or_no.rb

@@ -0,0 +1,18 @@
+module Gamefic
+
+  class SceneData::YesOrNo < SceneData::Base
+    def yes?
+      input.to_s[0,1].downcase == 'y'
+    end
+    def no?
+      input.to_s[0,1].downcase == 'n'
+    end
+    def prompt
+      @prompt ||= 'Yes or No?'
+    end
+    def invalid_message
+      @invalid_message ||= 'Please enter Yes or No.'
+    end
+  end
+
+end

data/lib/gamefic/shell.rb

@@ -1,78 +1,77 @@
-require 'thor'
-require 'gamefic/engine/tty'
-require 'zip'
-require 'tmpdir'
-require 'yaml'
-
-module Gamefic
-  class Shell < Thor
-    map %w[--version -v] => :version
-
-    desc "--version, -v", "Print the version"
-    def version
-      puts "gamefic #{Gamefic::VERSION}"
-    end
-    
-    desc 'play FILE_NAME', 'Execute a compiled (.gfic) game'
-    option :verbose, type: :boolean, aliases: :v, desc: "Don't suppress Ruby exceptions"
-    def play(file)
-      Dir.mktmpdir 'gamefic_' do |dir|
-        puts 'Loading...'
-        decompress file, dir
-        run_game(dir)
-      end
-    rescue Zip::Error => e
-      puts "'#{file}' does not appear to be a valid Gamefic file."
-      show_exception(e) if options[:verbose]
-    rescue StandardError => e
-      puts "An error occurred: #{e.message}"
-      show_exception(e) if options[:verbose]
-    end
-
-    desc 'info FILE_NAME', 'Print information about a (.gfic) game'
-    option :verbose, type: :boolean, aliases: :v, desc: "Don't suppress Ruby exceptions"
-    def info(file)
-      Dir.mktmpdir 'gamefic_' do |dir|
-        decompress file, dir
-        metadata = YAML.load_file File.join(dir, 'metadata.yaml')
-        metadata.each { |k, v|
-          puts "#{k}: #{v}"
-        }
-      end
-    rescue StandardError, Zip::Error => e
-      puts "'#{file}' does not appear to be a valid Gamefic file."
-      show_exception(e) if options[:verbose]
-    end
-    
-    # Custom error message for invalid command or filename
-    def method_missing(symbol, *args)
-      raise UndefinedCommandError, "Could not find command or file named \"#{symbol}\"."
-    end
-    
-    private
-
-    def show_exception(exception)
-      puts exception.inspect
-      puts exception.backtrace.join("\n")
-    end
-
-    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)
-          entry.extract full_path unless File.exist?(full_path)
-        end
-      end
-    end
-
-    def run_game(directory)
-      story = Plot.new(Source::File.new(File.join(directory, 'scripts')))
-      story.script 'main'
-      story.metadata = YAML.load_file File.join(directory, 'metadata.yaml')
-      engine = Tty::Engine.new story
-      puts "\n"
-      engine.run
-    end
-  end
-end
+require 'thor'
+require 'gamefic/engine/tty'
+require 'zip'
+require 'tmpdir'
+require 'yaml'
+
+module Gamefic
+  class Shell < Thor
+    map %w[--version -v] => :version
+
+    desc "--version, -v", "Print the version"
+    def version
+      puts "gamefic #{Gamefic::VERSION}"
+    end
+    
+    desc 'play FILE_NAME', 'Execute a compiled (.gfic) game'
+    option :verbose, type: :boolean, aliases: :v, desc: "Don't suppress Ruby exceptions"
+    def play(file)
+      Dir.mktmpdir 'gamefic_' do |dir|
+        puts 'Loading...'
+        decompress file, dir
+        run_game(dir)
+      end
+    rescue Zip::Error => e
+      puts "'#{file}' does not appear to be a valid Gamefic file."
+      show_exception(e) if options[:verbose]
+    rescue StandardError => e
+      puts "An error occurred: #{e.message}"
+      show_exception(e) if options[:verbose]
+    end
+
+    desc 'info FILE_NAME', 'Print information about a (.gfic) game'
+    option :verbose, type: :boolean, aliases: :v, desc: "Don't suppress Ruby exceptions"
+    def info(file)
+      Dir.mktmpdir 'gamefic_' do |dir|
+        decompress file, dir
+        metadata = YAML.load_file File.join(dir, 'metadata.yaml')
+        metadata.each { |k, v|
+          puts "#{k}: #{v}"
+        }
+      end
+    rescue StandardError, Zip::Error => e
+      puts "'#{file}' does not appear to be a valid Gamefic file."
+      show_exception(e) if options[:verbose]
+    end
+    
+    # Custom error message for invalid command or filename
+    def method_missing(symbol, *args)
+      raise UndefinedCommandError, "Could not find command or file named \"#{symbol}\"."
+    end
+    
+    private
+
+    def show_exception(exception)
+      puts exception.inspect
+      puts exception.backtrace.join("\n")
+    end
+
+    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)
+          entry.extract full_path unless File.exist?(full_path)
+        end
+      end
+    end
+
+    def run_game(directory)
+      plot = Plot.new(Source::File.new(File.join(directory, 'scripts')))
+      plot.script 'main'
+      plot.metadata = YAML.load_file File.join(directory, 'metadata.yaml')
+      puts ""
+      Engine::Tty.start(plot)
+    end
+  end
+end