gamefic 1.6.0 → 2.0.3

data/lib/gamefic/plot/players.rb

@@ -1,15 +0,0 @@
-module Gamefic
-
-  module Plot::Players
-    def players
-      p_players.clone
-    end
-
-    private
-
-    def p_players
-      @p_players ||= []
-    end
-  end
-
-end

data/lib/gamefic/plot/scenes.rb

@@ -1,149 +0,0 @@
-module Gamefic
-
-  module Plot::Scenes
-    def default_scene
-      @default_scene ||= Scene::Active
-    end
-
-    def default_conclusion
-      @default_conclusion ||= Scene::Conclusion
-    end
-
-    # Add a block to be executed when a player is added to the game.
-    # Each Plot can only have one introduction. Subsequent calls will
-    # overwrite the existing one.
-    #
-    # @example Welcome the player to the game
-    #   introduction do |actor|
-    #     actor.tell "Welcome to the game!"
-    #   end
-    #
-    # @yieldparam [Gamefic::Character]
-    def introduction (&proc)
-      @introduction = proc
-    end
-
-    # Introduce a player to the game.
-    # This method is typically called by the Engine that manages game execution.
-    #
-    # @param [Gamefic::Character]
-    def introduce(player)
-      player.playbook = playbook
-      player.cue default_scene
-      p_players.push player
-      @introduction.call(player) unless @introduction.nil?
-    end
-
-    # Create a multiple-choice scene.
-    # The user will be required to make a valid choice to continue.
-    #
-    # @yieldparam [Gamefic::Character]
-    # @yieldparam [Gamefic::Scene::Data::MultipleChoice]
-    def multiple_choice *choices, &block
-      Scene::MultipleChoice.subclass do |actor, scene|
-        scene.options.concat choices
-        scene.on_finish &block
-      end
-    end
-    
-    # Create a yes-or-no scene.
-    # The user will be required to answer Yes or No to continue.
-    #
-    # @yieldparam [Gamefic::Character]
-    # @yieldparam [Gamefic::Scene::YesOrNo]
-    def yes_or_no prompt = nil, &block
-      Scene::YesOrNo.subclass do |actor, scene|
-        scene.prompt = prompt
-        scene.on_finish &block
-      end
-    end
-    
-    def question prompt = 'What is your answer?', &block
-      Scene::Custom.subclass do |actor, scene|
-        scene.prompt = prompt
-        scene.on_finish &block
-      end
-    end
-
-    # Create a scene that pauses the game.
-    # This scene will execute the specified block and wait for input from the
-    # the user (e.g., pressing Enter) to continue.
-    #
-    # @param prompt [String] The text to display when prompting the user to continue.
-    # @yieldparam [Gamefic::Character]
-    # @yieldparam [Gamefic::Scene::Pause]
-    def pause prompt = nil, &block
-      Scene::Pause.subclass do |actor, scene|
-        scene.prompt = prompt unless prompt.nil?
-        block.call(actor, scene) unless block.nil?
-      end
-    end
-    
-    # Create a conclusion.
-    # The game (or the character's participation in it) will end after this
-    # scene is complete.
-    #
-    # @yieldparam [Gamefic::Character]
-    # @yieldparam [Gamefic::Scene::Conclusion]
-    def conclusion &block
-      Scene::Conclusion.subclass &block
-    end
-    
-    # Create a custom scene.
-    #
-    # Custom scenes should always specify the next scene to be cued or
-    # prepared. If not, the scene will get repeated on the next turn.
-    #
-    # This method creates a Scene::Custom by default. You can customize other
-    # scene types by specifying the class to create.
-    #
-    # @example Ask the user for a name
-    #   @scene = custom do |scene|
-    #     data.prompt = "What's your name?"
-    #     scene.on_finish do |actor, data|
-    #       actor.name = data.input
-    #       actor.tell "Hello, #{actor.name}!"
-    #       actor.cue :active
-    #     end
-    #   end
-    #
-    # @param cls [Class] The class of scene to be instantiated.
-    # @yieldparam [Gamefic::Character]
-    # @yieldparam [Scene::Custom] The instantiated scene.
-    def custom cls = Scene::Custom, &block
-      cls.subclass &block
-    end
-
-    # Choose a new scene based on a list of options.
-    # This is a specialized type of multiple-choice scene that determines
-    # which scene to cue based on a Hash of choices and scene keys.
-    #
-    # @example Select a scene
-    #   scene_one = pause do |actor|
-    #     actor.tell "You went to scene one"
-    #   end
-    #
-    #   scene_two = pause do |actor|
-    #     actor.tell "You went to scene two"
-    #   end
-    #
-    #   select_one_or_two = multiple_scene "One" => scene_one, "Two" => scene_two
-    #
-    #   introduction do |actor|
-    #     actor.cue select_one_or_two # The actor will be prompted to select "one" or "two" and get sent to the corresponding scene
-    #   end
-    #
-    # @param map [Hash] A Hash of options and associated scene keys.
-    # @yieldparam [Gamefic::Character]
-    # @yieldparam [Gamefic::Scene::MultipleScene]
-    def multiple_scene map = {}, &block
-      Scene::MultipleScene.subclass do |actor, scene|
-        map.each_pair { |k, v|
-          scene.map k, v
-        }
-        block.call actor, scene unless block.nil?
-      end
-    end
-  end
-
-end

data/lib/gamefic/plot/theater.rb

@@ -1,73 +0,0 @@
-module Gamefic
-
-  module Plot::Theater
-    # Execute a block of code in a subset of the object's scope. An object's
-    # stage is an isolated namespace that has its own instance variables and
-    # access to its owner's public methods.
-    #
-    # There are two ways to execute code on the stage. It will accept either a
-    # string of code with an optional file name and line number, or a proc
-    # with optional arguments. See module_eval and module_exec for more
-    # information.
-    #
-    # @example Evaluate a string of code
-    #   stage "puts 'Hello'"
-    #
-    # @example Evaluate a string of code with a file name and line number
-    #   stage "puts 'Hello'", "file.rb", 1
-    #
-    # @example Execute a block of code
-    #   stage {
-    #     puts 'Hello'
-    #   }
-    #
-    # @example Execute a block of code with arguments
-    #   stage 'hello' { |message|
-    #     puts message # <- prints 'hello'
-    #   }
-    #
-    # @example Use an instance variable
-    #   stage "@message = 'hello'"
-    #   stage "puts @message" # <- prints 'hello'
-    #
-    # @return [Object] The value returned by the executed code
-    def stage *args, &block
-      if block.nil?
-        theater.module_eval *args
-      else
-        theater.module_exec *args, &block
-      end
-    end
-
-    # The module that acts as an isolated namespace for staged code.
-    #
-    # @return [Module]
-    def theater
-      return @theater unless @theater.nil?
-      instance = self
-
-      @theater = Module.new do
-        define_singleton_method :method_missing do |symbol, *args, &block|
-          instance.public_send :public_send, symbol, *args, &block
-        end
-
-        define_singleton_method :stage do |*args|
-          raise NoMethodError.new("The stage method is not available from inside staged scripts")
-        end
-
-        define_singleton_method :to_s do
-          "[Theater]"
-        end
-      end
-
-      # HACK: Include the theater module in Object so that classes and modules
-      # defined in scripts are accessible from procs passed to the stage.
-      Object.class_exec(@theater) do |t|
-        include t
-      end
-      
-      @theater
-    end
-  end
-
-end

data/lib/gamefic/plot/you_mount.rb

@@ -1,22 +0,0 @@
-require 'gamefic'
-require 'gamefic/grammar'
-
-module Gamefic
-  module Plot::YouMount
-    class YouGrammarSet
-      include Grammar::Gender
-      include Grammar::Person
-      include Grammar::Plural
-      include Grammar::WordAdapter
-    end
-    # @return [YouGrammarSet]
-    def you
-      if @you.nil?
-        @you = YouGrammarSet.new
-        @you.person = 2
-      end
-      @you
-    end
-  end
-  
-end

data/lib/gamefic/script.rb

@@ -1,13 +0,0 @@
-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'
-    autoload :Text, 'gamefic/script/text'
-  end
-
-end

data/lib/gamefic/script/base.rb

@@ -1,42 +0,0 @@
-module Gamefic
-
-  class Script::Base
-    def initialize
-      raise "#initialize must be defined in subclasses"
-    end
-
-    # Get the script's text.
-    # The text must be source code suitable for evaluation via Plot#stage.
-    #
-    # @return [String]
-    def read
-      raise "#read must be defined in subclasses"
-    end
-
-    # 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, 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)
-      path == other.path
-    end
-  end
-
-end

data/lib/gamefic/script/file.rb

@@ -1,14 +0,0 @@
-module Gamefic
-
-  class Script::File < Script::Base
-    attr_reader :path, :absolute_path
-    def initialize filename, path
-      @absolute_path = filename.gsub(/\/+/, '/')
-      @path = path
-    end
-    def read
-      File.read(@absolute_path)
-    end
-  end
-
-end

data/lib/gamefic/script/text.rb

@@ -1,14 +0,0 @@
-module Gamefic
-  
-  class Script::Text < Script::Base
-    attr_reader :path, :absolute_path
-    def initialize path, code, absolute_path = nil
-      @path = path
-      @code = code
-      @absolute_path = absolute_path || path
-    end
-    def read
-      @code
-    end
-  end
-end

data/lib/gamefic/shell.rb

@@ -1,76 +0,0 @@
-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')
-      Engine::Tty.start(plot)
-    end
-  end
-end

data/lib/gamefic/source.rb

@@ -1,14 +0,0 @@
-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'
-    autoload :Text, 'gamefic/source/text'
-  end
-  
-end

data/lib/gamefic/source/base.rb

@@ -1,12 +0,0 @@
-module Gamefic
-
-  class Source::Base
-    def initialize
-      raise "#initialize must be defined in subclasses"
-    end
-    def export path
-      raise "#export must be defined in subclasses"
-    end
-  end
-
-end