metro 0.3.1 → 0.3.2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+before_install:
+ - sudo apt-get install build-essential freeglut3-dev libfreeimage-dev libgl1-mesa-dev libopenal-dev libpango1.0-dev libsdl-mixer1.2-dev libsdl-ttf2.0-dev libsndfile-dev libxinerama-dev

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in metro.gemspec
 gemspec
 
+gem 'rake'
 
 group 'development' do
   gem 'guard'

data/README.md

@@ -11,24 +11,33 @@ Metro is a framework built around [gosu](https://github.com/jlnr/gosu) (the 2D g
 
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/burtlo/metro)
 
+[![Build Status](https://travis-ci.org/burtlo/metro.png)](https://travis-ci.org/burtlo/metro)
+
+[![Dependency Status](https://gemnasium.com/burtlo/metro.png)](https://gemnasium.com/burtlo/metro)
+
 ## Why Use Metro?
 
 You want to develop games in Ruby.
 
 ### Why not just use Gosu?
 
-Gosu does not a lot for you. When you finish the [initial tutorial](https://github.com/jlnr/gosu/wiki/Ruby-Tutorial) you are left with a brittle game that is very resistant to changes or new features.
+Gosu does a lot of great work bringing OpenGL to Ruby. However, when you finish the [initial tutorial](https://github.com/jlnr/gosu/wiki/Ruby-Tutorial) you are left with a brittle game that is very resistant to changes or new features.
 
 * Metro provides the concept of a [Scene](https://github.com/burtlo/metro/wiki/Scenes) which is the first abstraction you would likely build after completing the tutorial.
 
-* Sane management of images, animations, fonts, songs, and samples.
+> Developing your game in individual scenes will make it easier to logically layout your game.
+
+* Sane management of images, animations, fonts, songs, and samples through [model properties](https://github.com/burtlo/metro/wiki/Model-properties).
+
+> Having to load and cache fonts and images in every one of your models is tedious. It is also is wasteful as several of the same fonts are being used all over the place.
 
-* [Implicit animations](https://github.com/burtlo/metro/wiki/Animations)
+* [Key-frame animations](https://github.com/burtlo/metro/wiki/Animations)
+
+> Metro makes it simple to move an actor from one position to another position. So simple movements, fades, color changes, and really any property change over time is defined very simply.
 
 * [Event Handling](https://github.com/burtlo/metro/wiki/Events)
 
-Metro is built on top of Gosu providing a moderate structure which should
-development joyful.
+> Delete those huge `if ... elsif ... else` input checking structures for keyboard, gamepad, and mouse button presses (down,up, and held). Metro makes it easy to define them and an attach a course of action to take when the event happens.
 
 ### Why not use Chingu or Gamebox?
 
@@ -37,8 +46,29 @@ Both [Gamebox](https://github.com/shawn42/gamebox) and
 larger set of features.
 
 With Metro the focus is on a smaller set of features with an emphasis on an
-implementation that leads to joyful development. The features have been
-developed with documentation and examples.
+implementation that leads to joyful development. An emphasis has been applied to creating elegant solutions which have documentation and examples.
+
+* Active Reloading while building your scenes.
+
+> Adjustments to your game code while working on a scene will automatically
+reload your game code. The template game sets up a shortcut key (**Ctrl+R**) that allows you to explicitly reload the game and the current scene.
+
+* Scene Edit Support
+
+> All scenes can have their visual component layout re-adjusted through an edit
+mode. The edit mode layout works for all labels, images, and menus.
+
+### Why you shouldn't use Metro?
+
+Metro has some the following limitations:
+
+* Limited to the gems defined within Metro
+
+> At this point in time you are not able to define and package additional dependencies with your game. This means if you are using a gem that is not already defined by Metro you will run into trouble when running it on alternate systems. This will likely be addressed in the future when more demand arises.
+
+* Difficult Deployment
+
+> For individuals to play your game, they will also have to install Metro. However, work is being made to bring some simple packaging to Metro games to make them stand-along executables.
 
 ## Installation
 

data/Rakefile

@@ -1 +1,18 @@
 require "bundler/gem_tasks"
+
+begin
+
+  require 'rspec/core/rake_task'
+
+  desc "Run all rspecs"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+    t.rspec_opts = '-c'
+  end
+
+  task :default => :spec
+
+rescue LoadError
+  puts "please install rspec to run tests"
+  puts "install with gem install rspec"
+end

data/changelog.md

@@ -1,5 +1,13 @@
 # Metro
 
+## 0.3.2 / 2012-11-26
+
+* Debug Mode will now automatically reload the game and scene on source
+  file changes.
+* Reloading the game will no longer take down the app for syntax errors
+  and other errors that are easily detected by simply loading the code.
+* Template game is now automatically has debug mode enabled by default
+
 ## 0.3.1 / 2012-11-25
 
 * FIX issue with some Gosu example code left in the oven
@@ -63,11 +71,11 @@
 
 ## 0.2.1 / 2012-11-08
 
-* FIX Scene fade transition color changing and implicit animations 
+* FIX Scene fade transition color changing and implicit animations
   for colors
 * Games creating custom properties will appear in the property list
 * Properties now correctly default to numeric properties
-* Point objects can be added to other point objects. 
+* Point objects can be added to other point objects.
 
 ## 0.2.0 / 2012-11-07
 

data/lib/locale/en.yml

@@ -2,6 +2,10 @@
 en:
   website: "%{website}"
   error:
+    unloadable_source:
+      title: "Metro CANNOT load your game code!"
+      message: "There is an error within your game code that needs to be fixed before Metro\nis able to replace the current running game code:\n\n%{output}"
+      actions: []
     missing_metro_file:
       title: "Unable to find Metro game file"
       message: "The specified file `%{file}` which is required to run the game could not be found."
@@ -22,3 +26,10 @@ en:
       actions:
       - "Ensure that the control name is not already defined."
       - "Replace the use of this control name with name"
+  dry_run:
+    success:
+      title: "Metro Game Dependencies Have Been Met!"
+      message: "Your game should be able to be run."
+      actions:
+      - "Metro dependencies have successfully been loaded"
+      - "Game dependencies have successfully been loaded"

data/lib/metro.rb

@@ -1,9 +1,11 @@
 require 'delegate'
 require 'logger'
 require 'erb'
+require 'open3'
 
 require 'gosu'
 require 'i18n'
+require 'listen'
 require 'active_support'
 require 'active_support/dependencies'
 require 'active_support/inflector'
@@ -16,6 +18,7 @@ require 'core_ext/numeric'
 
 require 'locale/locale'
 
+require 'metro/parameters/parameters'
 require 'metro/asset_path'
 require 'metro/units/units'
 require 'metro/logging'
@@ -31,8 +34,7 @@ require 'metro/game'
 require 'metro/scene'
 require 'metro/scenes'
 require 'metro/models/model'
-
-require_relative 'metro/missing_scene'
+require 'metro/missing_scene'
 
 #
 # To allow an author an easier time accessing the Game object from within their game.
@@ -45,123 +47,91 @@ module Metro
   extend GosuConstants
 
   #
-  # @return [String] the default filename that contains the game contents
+  # @return [String] the filepath to the Metro executable
   #
-  def default_game_filename
-    'metro'
+  def executable_path
+    File.absolute_path File.join(File.dirname(__FILE__), "..", "bin", "metro")
   end
 
+  #
+  # @return [String] the filepath to the Metro assets
+  #
   def asset_dir
     File.join File.dirname(__FILE__), "assets"
   end
 
   #
-  # Run will load the contents of the game contents and game files
-  # within the current working directory and start the game. By default
-  # calling run with no parameter will look for a game file
-  #
-  # @param [String] filename the name of the game file to run. When not specified
-  #   the value uses the default filename.
+  # @return [Array] an array of all the handlers that will be executed prior
+  #   to the game being launched.
   #
-  def run(filename=default_game_filename)
-    move_to_game_directory!(filename)
-    load_game_files!
-    load_game_configuration(filename)
-    configure_controls!
-    start_game
+  def setup_handlers
+    @setup_handlers ||= []
   end
 
-  def load_game_files!
-    EventDictionary.reset!
-    prepare_watcher!
-    load_game_files
-    execute_watcher!
+  #
+  # Register a setup handler. While this method is present, it is far
+  # too late for game code to be executed as these pregame handlers will already
+  # have started executing. This allows for modularity within the Metro library
+  # with the possibility that this functionality could become available to
+  # individual games if the load process were to be updated.
+  #
+  def register_setup_handler(handler)
+    setup_handlers.push handler
   end
 
-  alias_method :reload!, :load_game_files!
-
-  private
-
-  def move_to_game_directory!(filename)
-    game_directory = File.dirname(filename)
-    Dir.chdir game_directory
+  #
+  # Run will load the contents of the game contents and game files
+  # within the current working directory and start the game.
+  #
+  # @param [Array<String>] parameters an array of parameters that contains
+  #   the commands in the format that would normally be parsed into the
+  #   ARGV array.
+  #
+  def run(*parameters)
+    options = Parameters::CommandLineArgsParser.parse(parameters)
+    setup_handlers.each { |handler| handler.setup(options) }
+    start_game
   end
 
   #
-  # The watcher will keep track of all the constants that were added to the Object
-  # Namespace after the start of the execution of the game. This will allow for only
-  # those objects to be reloaded.
+  # Start the game by lanunching a window with the game configuration and data
+  # that has been loaded.
   #
-  def watcher
-    @watcher ||= ActiveSupport::Dependencies::WatchStack.new
+  def start_game
+    Game.start!
   end
 
   #
-  # The watcher should watch the Object Namespace for any changes. Any constants
-  # that are added will be tracked from this point forward.
+  # When called all the game-related code will be unloaded and reloaded.
+  # Providding an opportunity for a game author to tweak the code without having
+  # to restart the game.
   #
-  def prepare_watcher!
-    ActiveSupport::Dependencies.clear
-    watcher.watch_namespaces([ Object ])
+  def reload!
+    SetupHandlers::LoadGameFiles.new.load_game_files!
   end
 
   #
-  # The watcher will now mark all the constants that it has watched being loaded
-  # as unloadable. Doing so exhausts the list of constants found so the watcher
-  # will be empty.
+  # When called the game-related code will be loaded in a sub-process to see
+  # if the code is valid. This is used in tandem with {#reload} and should be
+  # called prior to ensure that the code that is replacing the current code
+  # is valid.
   #
-  # @note an exception is raised if the watcher is not prepared every time this
-  #   is called.
+  # @return [TrueClass,FalseClass] true if the game code that was loaded was
+  #   loaded successfully. false if the game code was not able to be loaded.
   #
-  def execute_watcher!
-    watcher.new_constants.each { |constant| unloadable constant }
-  end
+  def game_has_valid_code?
+    execution = SetupHandlers::LoadGameFiles.new.launch_game_in_dry_run_mode
 
-  def load_game_files
-    $LOAD_PATH.unshift(Dir.pwd) unless $LOAD_PATH.include?(Dir.pwd)
-    load_paths 'lib'
-    load_path 'scenes', prioritize: 'game_scene.rb'
-    load_path 'models', prioritize: 'game_model.rb'
-  end
-
-  def load_paths(*paths)
-    paths.flatten.compact.each {|path| load_path path }
-  end
-
-  def load_path(path,options = {})
-    files = Dir["#{path}/**/*.rb"]
-    files.sort! {|file| File.basename(file) == options[:prioritize] ? -1 : 1 }
-    files.each {|file| require_or_load file }
-  end
+    if execution.invalid?
+      error! 'error.unloadable_source', output: execution.output, exit: false
+    end
 
-  def load_game_configuration(filename)
-    gamefile = File.basename(filename)
-    game_files_exist!(gamefile)
-    game_contents = File.read(gamefile)
-    game_block = lambda {|instance| eval(game_contents) }
-    game = Game::DSL.parse(&game_block)
-    Game.setup game
+    execution.valid?
   end
-
-  def configure_controls!
-    EventRelay.define_controls Game.controls
-  end
-
-  def start_game
-    window = Window.new Game.width, Game.height, Game.fullscreen?
-    window.caption = Game.name
-    window.scene = Scenes.generate(Game.first_scene)
-    window.show
-  end
-
-  def game_files_exist!(*files)
-    files.compact.flatten.each { |file| game_file_exists?(file) }
-  end
-
-
-  def game_file_exists?(file)
-    error!("error.missing_metro_file",file: file) unless File.exists?(file)
-    error!("error.specified_directory",directory: file) if File.directory?(file)
-  end
-
 end
+
+require 'setup_handlers/move_to_game_directory'
+require 'setup_handlers/load_game_files'
+require 'setup_handlers/load_game_configuration'
+require 'setup_handlers/exit_if_dry_run'
+require 'setup_handlers/reload_game_on_game_file_changes'

data/lib/metro/game.rb

@@ -8,7 +8,37 @@ module Metro
       @config = game_configuration
     end
 
-    attr_reader :config
+    #
+    # Creates a window and starts the game with the game parameters.
+    #
+    def start!
+      @window = Window.new width, height, fullscreen?
+      window.caption = name
+      window.scene = Scenes.generate(first_scene)
+      window.show
+    end
+
+    # The original parameters specified during execution. These are the args
+    # found on the command-line that are passed in when the game started.
+    def execution_parameters
+      @execution_parameters ||= []
+    end
+
+    attr_writer :execution_parameters
+
+    #
+    # @return the current game window.
+    #
+    attr_reader :window
+
+    #
+    # @return [Scene,NilClass] the current scene that is being displayed. If 
+    #   this is called before the window is being displayed when this will return
+    #   a nil value.
+    # 
+    def current_scene
+      window ? window.scene : nil
+    end
 
     def first_scene
       fetch(:first_scene)
@@ -62,6 +92,7 @@ module Metro
       config.send(name) rescue fallback
     end
 
+    attr_reader :config
 
   end
 end

data/lib/metro/logging.rb

@@ -23,11 +23,11 @@ end
 #  for the localized error messages.
 # 
 def error!(messages, details = {})
-  details = { show: true }.merge details
+  details = { show: true, exit: true }.merge details
 
   message = TemplateMessage.new messages: messages, details: details,
     website: Game.website, contact: Game.contact
 
   warn message if details[:show]
-  exit 1
+  exit 1 if details[:exit]
 end

data/lib/metro/parameters/command_line_args_parser.rb

@@ -0,0 +1,68 @@
+module Metro
+  module Parameters
+
+    #
+    # The CommandLineArgsParser converts the argument list passed in from the
+    # command-line and generates an Metro::Parameters::Options object.
+    #
+    module CommandLineArgsParser
+      extend self
+
+      #
+      # Given the array of parameters usually from the Command-Line ARGV and
+      # convert that information into various parameters
+      #
+      def parse(*parameters)
+        parameters = parameters.flatten.compact
+        options = { execution_parameters: parameters.dup }
+
+        command_flags = extract_command_flags!(parameters)
+        filename = extract_game_file!(parameters)
+
+        Options.new options.merge(filename: filename).merge(command_flags)
+      end
+
+      private
+
+      #
+      # Find all the flags within the array of parameters, extract them and
+      # generate a hash. Their presence within the array means that they should
+      # have a true value.
+      #
+      # @return [Hash] a hash that contains all the flags as keys and true as
+      #   their values. As the presence of the flag means the value is true.
+      #
+      def extract_command_flags!(parameters)
+        raw_command_flags = parameters.flatten.find_all { |arg| arg.start_with? "--" }
+        parameters.delete_if { |param| raw_command_flags.include? param }
+
+        flag_names = raw_command_flags.map { |flag| flag[/--(.+)$/,1].underscore.to_sym }
+        flag_values = [ true ] * flag_names.count
+        Hash[flag_names.zip(flag_values)]
+      end
+
+      #
+      # From the current parameters array remove the first element which should
+      # be the default game file. When there is no value then use the default
+      # game filename
+      #
+      # @return [String] the game file name to use
+      #
+      def extract_game_file!(parameters)
+        parameters.delete_at(0) || default_game_filename
+      end
+
+      #
+      # The default for games is to have a game file called 'metro'. So if they
+      # do not provide the file parameter we assume that it is this file.
+      #
+      # @return [String] the default filename that contains the game contents
+      #
+      def default_game_filename
+        'metro'
+      end
+
+    end
+
+  end
+end

data/lib/metro/parameters/options.rb

@@ -0,0 +1,25 @@
+module Metro
+  module Parameters
+
+    #
+    # Options are the result of a parameters parser. The options class defines
+    # a read-only structure that provides getters for all the parameters
+    # specified within the has.
+    #
+    # @see CommandLineArgsParser
+    #
+    class Options
+      def initialize(params = {})
+        params.each do |key,value|
+          self.class.send(:define_method,key) { value }
+          self.class.send(:define_method,"#{key}?") { value }
+        end
+      end
+      
+      def method_missing(name,*args,&block)
+        return false
+      end
+    end
+
+  end
+end

data/lib/metro/parameters/parameters.rb

@@ -0,0 +1,2 @@
+require_relative 'command_line_args_parser'
+require_relative 'options'

data/lib/metro/version.rb

@@ -1,7 +1,7 @@
 module Metro
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
   WEBSITE = "https://github.com/burtlo/metro"
-  CONTACT_EMAILS = ["franklin.webber@gmail.com"]
+  CONTACT_EMAILS = ["dev@rubymetro.com"]
   
   def self.changes_for_version(version)
 

data/lib/setup_handlers/exit_if_dry_run.rb

@@ -0,0 +1,26 @@
+module Metro
+  module SetupHandlers
+
+    #
+    # If the user has enabled the dry-run flag, this is the point at which the
+    # game will exit.
+    #
+    # Dry run mode is useful for determine if all dependencies have successfully
+    # been met and the source code will load successfully.
+    #
+    class ExitIfDryRun
+      #
+      # @param [Metro::Parameters::Options] options the options that the game
+      #   was provided when it was launched.
+      #
+      def setup(options)
+        return unless options.dry_run?
+        puts TemplateMessage.new message: 'dry_run.success'
+        exit
+      end
+    end
+  end
+
+  register_setup_handler SetupHandlers::ExitIfDryRun.new
+
+end

data/lib/setup_handlers/game_execution.rb

@@ -0,0 +1,65 @@
+module Metro
+  module SetupHandlers
+
+    #
+    # The GameExecution allows for a game to be executed. This is used by Metro
+    # to validate that the code can be loaded and run before actually running
+    # it (specifically when reloading live running code)
+    #
+    class GameExecution
+
+      #
+      # Perform a game execution with the specified parameters and return the
+      # result of that game execution.
+      #
+      def self.execute(parameters)
+        execution = new(parameters)
+        execution.execute!
+        execution
+      end
+
+      # @return the output generated from the execution of code.
+      attr_reader :output
+
+      # @return an array of parameters that will be provided to the execution
+      #   of the game.
+      attr_reader :parameters
+
+      #
+      # @param [Array] parameters an array of the game parameters that are
+      #   to be provided to this execution of the game.
+      #
+      def initialize(parameters)
+        @parameters = parameters
+      end
+
+      # @return the status code that was returned when the game execution
+      #   has completed.
+      def status
+        @status ||= 0
+      end
+
+      # Perform the game execution.
+      def execute!
+        @output, @status = Open3.capture2e(game_execution_string)
+      end
+
+      # @return [TrueClass,FalseClass] true if the execution was successful.
+      def valid?
+        status == 0
+      end
+
+      # @return [TrueClass,FalseClass] true if the execution was a failure.
+      def invalid?
+        status != 0
+      end
+
+      private
+
+      def game_execution_string
+        "#{Metro.executable_path} #{parameters.join(" ")}"
+      end
+    end
+
+  end
+end

data/lib/setup_handlers/load_game_configuration.rb

@@ -0,0 +1,65 @@
+module Metro
+  module SetupHandlers
+
+    #
+    # LoadGameConfiguration is a meta pregame setup handler as it defines multiple
+    # setup handlers to be executed related to game configuration.
+    #
+    class GameConfiguration
+      #
+      # @param [Metro::Parameters::Options] options the options that the game
+      #   was provided when it was launched.
+      #
+      def setup(options)
+        ParseAndLoadGameConfiguration.new.setup(options)
+        ConfigureControls.new.setup(options)
+      end
+    end
+
+    #
+    # Loads the game configuration information and sets up a Game object with the
+    # content loaded from the game configuration.
+    #
+    class ParseAndLoadGameConfiguration
+
+      #
+      # @param [Metro::Parameters::Options] options the options that the game
+      #   was provided when it was launched.
+      #
+      def setup(options)
+        filename = options.filename
+
+        Game.execution_parameters = options.execution_parameters
+
+        gamefile = File.basename(filename)
+        game_files_exist!(gamefile)
+        game_contents = File.read(gamefile)
+        game_block = lambda {|instance| eval(game_contents) }
+        game = Game::DSL.parse(&game_block)
+        Game.setup game
+      end
+
+      def game_files_exist!(*files)
+        files.compact.flatten.each { |file| game_file_exists?(file) }
+      end
+
+      def game_file_exists?(file)
+        error!("error.missing_metro_file",file: file) unless File.exists?(file)
+        error!("error.specified_directory",directory: file) if File.directory?(file)
+      end
+    end
+
+    #
+    # After the game has been configured it is time to configure the controls for
+    # the game.
+    #
+    class ConfigureControls
+      def setup(options)
+        EventRelay.define_controls Game.controls
+      end
+    end
+  end
+
+  register_setup_handler SetupHandlers::GameConfiguration.new
+
+end

data/lib/setup_handlers/load_game_files.rb

@@ -0,0 +1,101 @@
+require_relative 'game_execution'
+
+module Metro
+  module SetupHandlers
+
+    #
+    # LoadGameFiles will load all the game files within the current working
+    # directory that are in the pre-defined Metro game folders.
+    #
+    # LoadGameFiles uses ActiveSupport::Dependencies::WatchStack to spy on all
+    # the constants that are added when the game runs. This grants the class
+    # the ability to provide dynamic reloading of the classes as they change.
+    #
+    class LoadGameFiles
+
+      #
+      # @param [Metro::Parameters::Options] options the options that the game
+      #   was provided when it was launched.
+      #
+      def setup(options)
+        load_game_files!
+      end
+
+      #
+      # Drop any already defined events. Drop all the existing classes, reload
+      # the game files, and prepare the new game files for unloading the next
+      # time around that reload has been called.
+      #
+      def load_game_files!
+        EventDictionary.reset!
+        Image.images.clear
+        Animation.images.clear
+        Song.songs.clear
+        Font.fonts.clear
+
+        prepare_watcher!
+        load_game_files
+        execute_watcher!
+      end
+
+      #
+      # Launch the game in a sub-process in dry-run mode. Starting the
+      # game in dry-run mode here makes it so it will not launch a window
+      # and simply check to see if the code is valid and working correctly.
+      #
+      def launch_game_in_dry_run_mode
+        GameExecution.execute Game.execution_parameters + [ "--dry-run" ]
+      end
+
+      #
+      # The watcher should watch the Object Namespace for any changes. Any constants
+      # that are added will be tracked from this point forward.
+      #
+      def prepare_watcher!
+        ActiveSupport::Dependencies.clear
+        watcher.watch_namespaces([ Object ])
+      end
+
+      #
+      # The watcher will keep track of all the constants that were added to the Object
+      # Namespace after the start of the execution of the game. This will allow for only
+      # those objects to be reloaded.
+      #
+      def watcher
+        @watcher ||= ActiveSupport::Dependencies::WatchStack.new
+      end
+
+      def load_game_files
+        $LOAD_PATH.unshift(Dir.pwd) unless $LOAD_PATH.include?(Dir.pwd)
+        load_paths 'lib'
+        load_path 'scenes', prioritize: 'game_scene.rb'
+        load_path 'models', prioritize: 'game_model.rb'
+      end
+
+      def load_paths(*paths)
+        paths.flatten.compact.each {|path| load_path path }
+      end
+
+      def load_path(path,options = {})
+        files = Dir["#{path}/**/*.rb"]
+        files.sort! {|file| File.basename(file) == options[:prioritize] ? -1 : 1 }
+        files.each {|file| require_or_load file }
+      end
+
+      #
+      # The watcher will now mark all the constants that it has watched being loaded
+      # as unloadable. Doing so exhausts the list of constants found so the watcher
+      # will be empty.
+      #
+      # @note an exception is raised if the watcher is not prepared every time this
+      #   is called.
+      #
+      def execute_watcher!
+        watcher.new_constants.each { |constant| unloadable constant }
+      end
+    end
+  end
+
+  register_setup_handler SetupHandlers::LoadGameFiles.new
+
+end

data/lib/setup_handlers/move_to_game_directory.rb

@@ -0,0 +1,25 @@
+module Metro
+  module SetupHandlers
+
+    #
+    # If the filename provide contains path information, then we need to move the
+    # current working directory into the root of the game directory. This is
+    # important because assets and other various paths are dependent on that
+    # being the location during execution.
+    #
+    class MoveToGameDirectory
+      #
+      # @param [Metro::Parameters::Options] options the options that the game
+      #   was provided when it was launched.
+      # 
+      def setup(options)
+        filename = options.filename
+        game_directory = File.dirname(filename)
+        Dir.chdir game_directory
+      end
+    end
+  end
+
+  register_setup_handler SetupHandlers::MoveToGameDirectory.new
+
+end

data/lib/setup_handlers/reload_game_on_game_file_changes.rb

@@ -0,0 +1,74 @@
+module Metro
+  module SetupHandlers
+
+    #
+    # When the game is launched in **debug** mode the game directories will be
+    # monitored for changes. When a change occurs within one of the game source
+    # files the game and scene will be reloaded.
+    #
+    class ReloadGameOnGameFileChanges
+
+      #
+      # @NOTE this is duplication of the paths is also defined in LoadGameFiles.
+      # @see Metro::SetupHandlers::LoadGameFiles
+      #
+      def source_filepaths
+        [ 'lib', 'scenes', 'models' ]
+      end
+
+      def view_filepaths
+        [ 'views' ]
+      end
+
+      def asset_filepaths
+        [ 'assets' ]
+      end
+
+      def all_filepaths
+        source_filepaths + view_filepaths + asset_filepaths
+      end
+
+      #
+      # @param [Metro::Parameters::Options] options the options that the game
+      #   was provided when it was launched.
+      #
+      def setup(options)
+        start_watcher if Game.debug?
+      end
+
+      def start_watcher
+        Thread.abort_on_exception = true
+        Thread.new { watch_filepaths(all_filepaths) }
+      end
+
+      #
+      # Defines the listener that will watch the filepaths
+      #
+      def watch_filepaths(filepaths)
+        listener = Listen.to(*filepaths)
+        listener.change(&on_change)
+        listener.start
+      end
+
+      #
+      # @return [Proc] the body of code to execute when a file change event has
+      #   been received.
+      #
+      def on_change
+        Proc.new { |modified,added,removed| reload_game_because_files_changed(modified + added + removed) }
+      end
+
+      #
+      # Perform a game reload if the game source is valid.
+      #
+      def reload_game_because_files_changed(changed)
+        log.debug "Metro has detected #{changed.count} game source #{changed.count != 1 ? 'files have' : 'file has'} changed. RELOADING GAME CODE!"
+        if Metro.game_has_valid_code?
+          Game.current_scene.after(1.tick) { Metro.reload! ; transition_to(scene_name) }
+        end
+      end
+    end
+  end
+
+  register_setup_handler SetupHandlers::ReloadGameOnGameFileChanges.new
+end

data/lib/templates/game/lib/custom_easing.rb

@@ -0,0 +1,32 @@
+#
+# The lib folder is a great place for you to define:
+#
+# * New Units
+# * Monkey Patches for Metro
+# * New model properties
+# * Custom Easings
+# * Custom View Parers/Writers
+# * Anything that isn't quite a model, scene, or view
+#
+
+#
+# This custom easing is an exact copy of the 'Ease In' easing defined in Metro.
+# It is present here as an example.
+#
+class CustomEasing < Metro::Easing
+
+  #
+  # @param [Float] moment the point in time within the interval. For example for
+  #   a 60 tick interval, this would be the values 0, 1, 2, 3, 4, 5, 6, ... 59.
+  # @param [Float] start the starting value of the property
+  # @param [Float] change the final value for the property
+  # @param [Float] interval the total length of the interval
+  #
+  # @return [Float] the value at the particular moment of the interval
+  def self.calculation(moment,start,change,interval)
+    # @note this is the exact same as the already defined Ease In
+    change * (moment = moment / interval) * moment + start
+  end
+end
+
+Metro::Easing.register :custom, CustomEasing

data/lib/templates/game/metro.tt

@@ -15,7 +15,7 @@ name "<%= name %>"
 # The author of the game. This method can be executed
 # twice if more people are working on this game.
 #
-author "John Carmack"
+author "Your Name"
 
 #
 # The website where the person playing this game
@@ -42,7 +42,6 @@ resolution 640, 480
 #
 first_scene :brand
 
-
 #
 # Defines controls which are meta events. They can be used group button
 # events together under a single name so that you can use it throughout
@@ -61,4 +60,4 @@ end
 # Game.debug? method will return a true
 # value.
 #
-# debug true
+debug true

data/lib/templates/game/scenes/game_scene.rb

@@ -11,8 +11,9 @@ class GameScene < Metro::Scene
   #
   event :on_up, KbR do |event|
     if event.control?
-      Metro.reload!
-      transition_to scene_name
+      if Metro.game_has_valid_code?
+        after(1.tick) { Metro.reload! ; transition_to(scene_name) }
+      end
     end
   end
 
@@ -28,7 +29,7 @@ class GameScene < Metro::Scene
 
   #
   # This animation helper will fade in and fade out information.
-  # 
+  #
   def fade_in_and_out(name)
     animate name, to: { alpha: 255 }, interval: 2.seconds do
       after 1.second do

data/lib/templates/message.erb

@@ -1,24 +1,23 @@
 ********************************************************************************
-```
-  ______  ___      _____
-  ___   |/  /_____ __  /_______________
-  __  /|_/ / _  _ \_  __/__  ___/_  __ \
-  _  /  / /  /  __// /_  _  /    / /_/ /
-  /_/  /_/   \___/ \__/  /_/     \____/
+    ______  ___      _____
+    ___   |/  /_____ __  /_______________
+    __  /|_/ / _  _ \_  __/__  ___/_  __ \
+    _  /  / /  /  __// /_  _  /    / /_/ /
+    /_/  /_/   \___/ \__/  /_/     \____/
 
-```
--------------------------------------------------------------------------------
+--------------------------------------------------------------------------------
 <% messages.each do |message| %>
 ## <%= message.title %>
 
 <%= message.message %>
 
-## Details
+<% unless message.actions.empty? %>## Details
 
-<%= message.actions %>
-<% end %>
+<%= message.actions %><% end %><% end %>
+<% if website.present? || email.present? %>
 ## Contact
 
 <%= website %>
 <%= email %>
+<% end %>
 ********************************************************************************

data/metro.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.version       = Metro::VERSION
   gem.authors       = ["Franklin Webber"]
   gem.email         = Metro::CONTACT_EMAILS
-
+  gem.license       = "MIT"
   gem.summary       = <<-EOS
     Metro is a 2D Gaming framework built around gosu (game development library).
     Metro makes it easy to create games by enforcing common conceptual structures
@@ -28,6 +28,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'thor', '~> 0.16.0'
   gem.add_dependency 'i18n', '~> 0.6.1'
   gem.add_dependency 'active_support', '~> 3.0.0'
+  gem.add_dependency 'listen', '~> 0.6.0'
   gem.add_development_dependency 'rspec', '~> 2.11'
 
   gem.files         = `git ls-files`.split($/)

data/spec/metro/parameters/command_line_args_parser_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Metro::Parameters::CommandLineArgsParser do
+
+  describe "Class Methods" do
+
+    subject { described_class }
+
+    describe "#parse" do
+      context "when given no parameters" do
+
+      end
+
+      context "when given an array of parameters" do
+
+        subject { described_class.parse parameters }
+        let(:parameters) { [ '--upset-the-world', expected_filename, '--check-dependencies', 'unread_command' ] }
+        let(:expected_filename) { 'metro' }
+
+        it "should maintain an original parameter list" do
+          subject.execution_parameters.should eq parameters
+        end
+
+        it "should consider the first non-flag the game file" do
+          subject.filename.should eq expected_filename
+        end
+
+        it "should find all the flags" do
+          subject.upset_the_world?.should be_true
+          subject.check_dependencies?.should be_true
+        end
+        
+        it "should return false when non-existant flags are present" do
+          subject.wants_food_mild?.should be_false
+        end
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metro
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -75,6 +75,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +111,7 @@ description: ! "    Metro is a 2D Gaming framework built around gosu (game devel
   library).\n    Metro makes it easy to create games by enforcing common conceptual
   structures\n    and conventions.\n"
 email:
-- franklin.webber@gmail.com
+- dev@rubymetro.com
 executables:
 - metro
 extensions: []
@@ -103,6 +119,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -182,6 +199,9 @@ files:
 - lib/metro/models/ui/label.rb
 - lib/metro/models/ui/menu.rb
 - lib/metro/models/ui/rectangle.rb
+- lib/metro/parameters/command_line_args_parser.rb
+- lib/metro/parameters/options.rb
+- lib/metro/parameters/parameters.rb
 - lib/metro/sample.rb
 - lib/metro/scene.rb
 - lib/metro/scenes.rb
@@ -206,9 +226,16 @@ files:
 - lib/metro/views/writers.rb
 - lib/metro/views/yaml_view.rb
 - lib/metro/window.rb
+- lib/setup_handlers/exit_if_dry_run.rb
+- lib/setup_handlers/game_execution.rb
+- lib/setup_handlers/load_game_configuration.rb
+- lib/setup_handlers/load_game_files.rb
+- lib/setup_handlers/move_to_game_directory.rb
+- lib/setup_handlers/reload_game_on_game_file_changes.rb
 - lib/templates/game/README.md.tt
 - lib/templates/game/assets/brand.jpg
 - lib/templates/game/assets/hero.png
+- lib/templates/game/lib/custom_easing.rb
 - lib/templates/game/metro.tt
 - lib/templates/game/models/hero.rb
 - lib/templates/game/scenes/brand_scene.rb
@@ -239,6 +266,7 @@ files:
 - spec/metro/models/properties/options_property/options_spec.rb
 - spec/metro/models/properties/position_property_spec.rb
 - spec/metro/models/ui/label_spec.rb
+- spec/metro/parameters/command_line_args_parser_spec.rb
 - spec/metro/scene_spec.rb
 - spec/metro/scene_views/json_view_spec.rb
 - spec/metro/scene_views/yaml_view_spec.rb
@@ -246,13 +274,17 @@ files:
 - spec/metro/views/view_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/burtlo/metro
-licenses: []
+licenses:
+- MIT
 post_install_message: ! "    ______  ___      _____\n    ___   |/  /_____ __  /_______________\n
   \   __  /|_/ / _  _ \\_  __/__  ___/_  __ \\\n    _  /  / /  /  __// /_  _  /    /
   /_/ /\n    /_/  /_/   \\___/  \\__/ /_/     \\____/\n\n  Thank you for installing
-  metro 0.3.1 / 2012-11-25.\n  ---------------------------------------------------------------------\n
-  \ Changes:\n    \n  * FIX issue with some Gosu example code left in the oven\n  \n\n
-  \ ---------------------------------------------------------------------\n"
+  metro 0.3.2 / 2012-11-26.\n  ---------------------------------------------------------------------\n
+  \ Changes:\n    \n  * Debug Mode will now automatically reload the game and scene
+  on source\n    file changes.\n  * Reloading the game will no longer take down the
+  app for syntax errors\n    and other errors that are easily detected by simply loading
+  the code.\n  * Template game is now automatically has debug mode enabled by default\n
+  \ \n\n  ---------------------------------------------------------------------\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -291,6 +323,7 @@ test_files:
 - spec/metro/models/properties/options_property/options_spec.rb
 - spec/metro/models/properties/position_property_spec.rb
 - spec/metro/models/ui/label_spec.rb
+- spec/metro/parameters/command_line_args_parser_spec.rb
 - spec/metro/scene_spec.rb
 - spec/metro/scene_views/json_view_spec.rb
 - spec/metro/scene_views/yaml_view_spec.rb