metro-ld25 0.3.3

data/lib/commands/generate_game.rb

@@ -0,0 +1,13 @@
+module Metro
+
+  class GenerateGame < Generator
+
+    argument :name
+
+    def create_metro_file
+      directory "game", name
+    end
+
+  end
+
+end

data/lib/commands/generate_model.rb

@@ -0,0 +1,25 @@
+module Metro
+
+  class GenerateModel < Generator
+
+    no_tasks do
+
+      def model_filename
+        name.underscore
+      end
+
+      def model_name
+        name.camelize
+      end
+
+    end
+
+    argument :name
+
+    def create_model_file
+      template "model.rb.tt", "models/#{model_filename}.rb"
+    end
+
+  end
+
+end

data/lib/commands/generate_scene.rb

@@ -0,0 +1,36 @@
+module Metro
+
+  class GenerateScene < Generator
+
+    no_tasks do
+
+      def scene_filename
+        scene_name = name.gsub(/_?Scene$/i,'')
+        "#{scene_name.underscore}_scene"
+      end
+
+      def scene_class_name
+        scene_name = name.gsub(/_?Scene$/i,'')
+        "#{scene_name.camelize}Scene"
+      end
+
+      def view_filename
+        view_name = name.to_s.gsub(/_?Scene$/i,'')
+        view_name.underscore
+      end
+
+    end
+
+    argument :name
+
+    def create_scene_file
+      template "scene.rb.tt", "scenes/#{scene_filename}.rb"
+    end
+
+    def create_view_file
+      template "view.yaml.tt", "views/#{view_filename}.yaml"
+    end
+
+  end
+
+end

data/lib/commands/generate_view.rb

@@ -0,0 +1,21 @@
+module Metro
+
+  class GenerateView < Generator
+
+    no_tasks do
+
+      def view_filename
+        view_name = name.to_s.gsub(/_?Scene$/i,'')
+        view_name.underscore
+      end
+
+    end
+
+    argument :name
+
+    def create_view_file
+      template "view.yaml.tt", "views/#{view_filename}.yaml"
+    end
+  end
+
+end

data/lib/commands/thor.rb

@@ -0,0 +1,83 @@
+require 'thor'
+require 'thor/group'
+
+module Metro
+
+  class Generator < ::Thor::Group
+    include Thor::Actions
+
+    def self.source_root
+      File.join File.dirname(__FILE__), "..", "templates"
+    end
+  end
+
+  class UnknownGenerator
+
+    def self.start(commands)
+      raise "There is no command: [ #{commands.join(', ')} ]"
+    end
+
+  end
+
+
+  class Thor < Thor
+
+    no_tasks do
+
+      def banner
+        """
+********************************************************************************
+  ______  ___      _____
+  ___   |/  /_____ __  /_______________
+  __  /|_/ / _  _ \\_  __/__  ___/_  __ \\
+  _  /  / /  /  __// /_  _  /    / /_/ /
+  /_/  /_/   \\___/ \\__/  /_/     \\____/
+
+-------------------------------------------------------------------------------"""
+      end
+
+      def generators
+        Hash.new(UnknownGenerator).merge model: Metro::GenerateModel,
+          scene: Metro::GenerateScene,
+          view:  Metro::GenerateView
+      end
+
+      def generator(name)
+        generators[name.to_sym]
+      end
+
+    end
+
+    desc "new GAMENAME",
+      "Create a new game within the directory using with the GAMENAME given."
+    def new(game_name)
+      Metro::GenerateGame.start [ game_name ]
+    end
+
+    desc "generate TYPE NAME",
+      "Create a new type: model, view, or scene."
+    def generate(type,name)
+      gen = generator(type)
+      gen.start [ name ]
+    end
+    
+    desc "g TYPE NAME",
+      "Create a new type: model, view, or scene."
+    def g(type,name)
+      generate(type,name)
+    end
+    
+    desc "help", "This commoand"
+    def help
+      say banner
+      print_table self.class.printable_tasks, indent: 4
+    end
+
+  end
+end
+
+
+require_relative 'generate_game'
+require_relative 'generate_model'
+require_relative 'generate_scene'
+require_relative 'generate_view'

data/lib/core_ext/class.rb

@@ -0,0 +1,14 @@
+
+class Class
+
+  #
+  # Within Metro often times a Class or the name of the class is being used.
+  # ActiveSupport provides the constantize on Strings and Symbols but does
+  # not provide it on Class. So instead of providing redundant checks in
+  # places this monkeypatch simply makes Classes adhere to the same interface.
+  #
+  # @return [Class] itself.
+  def constantize
+    self
+  end
+end

data/lib/core_ext/numeric.rb

@@ -0,0 +1,59 @@
+class Numeric
+
+  #
+  # Set the tick interval which is used in conversion of seconds to
+  # ticks.
+  #
+  def self.tick_interval=(value)
+    @tick_interval = value.to_f
+  end
+
+  #
+  # @return the game tick interval. By default the tick interval is 16.66666
+  #
+  def self.tick_interval
+    @tick_interval.to_f == 0 ? 16.666666 : @tick_interval.to_f
+  end
+
+
+
+  #
+  # Provides the suffix 'second' which will translate seconds to
+  # game ticks. This is to allow for a number of seconds to be expressed
+  # in situations where game ticks are used (e.g. animations).
+  #
+  # @example Expressing an animation that takes place over 3 seconds (~180 ticks)
+  #
+  #     class ExampleScene < Metro::Scene
+  #       draws :title
+  #
+  #       animate :title, to: { x: 320, y: 444 }, interval: 3.seconds
+  #     end
+  #
+  def second
+    (self * 1000 / Numeric.tick_interval).floor
+  end
+
+  alias_method :seconds, :second
+  alias_method :secs, :second
+  alias_method :sec, :second
+
+  #
+  # Provides the suffix 'tick' which will simply express the number
+  # with a vanity suffix.
+  #
+  # @example Expressing an animation that takes place over 60 game ticks
+  #
+  #     class ExampleScene < Metro::Scene
+  #       draws :title
+  #
+  #       animate :title, to: { x: 320, y: 444 }, interval: 60.ticks
+  #     end
+  #
+  def tick
+    self
+  end
+
+  alias_method :ticks, :tick
+
+end

data/lib/gosu_ext/color.rb

@@ -0,0 +1,62 @@
+class Gosu::Color
+
+  alias_method :gosu_initialize, :initialize
+
+  #
+  # Monkey-patching the initialize to allow for another Gosu::Color
+  # and Strings.
+  #
+  def initialize(*args)
+    if args.length == 1
+      value = args.first
+      if value.is_a? Gosu::Color
+        gosu_initialize value.alpha, value.red, value.green, value.blue
+      elsif value.is_a? String
+        gosu_initialize *Array(self.class.parse_string(value))
+      else
+        gosu_initialize value
+      end
+    else
+      gosu_initialize *args
+    end
+  end
+
+  def self.parse_string(value)
+    parse_hex(value) || parse_rgb(value) || parse_rgba(value) || parse_gosu_color_string(value) || [ 255, 255, 255, 255 ]
+  end
+
+  def self.parse_rgba(rgba)
+    if rgba =~ /rgba\(([\d]{1,3}(?:\.\d*)?),([\d]{1,3}(?:\.\d*)?),([\d]{1,3}(?:\.\d*)?),(\d(?:\.\d*)?)\)/
+      [ (255 * $4.to_f).floor.to_i, $1.to_i, $2.to_i, $3.to_i ]
+    end
+  end
+
+  def self.parse_rgb(rgb)
+    if rgb =~ /rgb\(([\d]{1,3}),([\d]{1,3}),([\d]{1,3})\)/
+      [ 255, $1.to_i, $2.to_i, $3.to_i ]
+    end
+  end
+
+  def self.parse_hex(hex)
+    if hex =~ /0x([A-Fa-f0-9]{8})/
+      hex.to_i(16)
+    elsif hex =~ /#([A-Fa-f0-9]{6})/
+      "0xFF#{$1}".to_i(16)
+    end
+  end
+
+  def self.parse_gosu_color_string(string)
+    if string =~ /\(ARGB: ([\d]{1,3})\/([\d]{1,3})\/([\d]{1,3})\/([\d]{1,3})\)/
+      [ $1.to_i, $2.to_i, $3.to_i, $4.to_i ]
+    end
+  end
+
+  def to_s
+    "rgba(#{red},#{green},#{blue},#{alpha / 255.to_f})"
+  end
+
+  def to_json(*params)
+    to_s.to_json
+  end
+
+end

data/lib/gosu_ext/gosu_constants.rb

@@ -0,0 +1,53 @@
+module Metro
+
+  #
+  # The GosuEvents module creates aliases for the Keyboard and the Gamepad events
+  # within the Gosu Namespace. This is so Metro can use the events without requiring
+  # the namespace.
+  #
+  # This makes the interface of these events more portable.
+  #
+  module GosuConstants
+
+    def self.extended(base)
+      add constants: keyboard_events, to: base
+      add constants: gamepad_events, to: base
+      add constants: mouse_events, to: base
+    end
+
+    #
+    # @return the constant from which to search for all the other constants.
+    #   This helper method is to to save sprinkling the constant value
+    #   throughout the rest of the module.
+    def self.gosu
+      Gosu
+    end
+
+    def self.keyboard_events
+      find_all_constants_with_prefix "Kb"
+    end
+
+    def self.gamepad_events
+      find_all_constants_with_prefix "Gp"
+    end
+
+    def self.mouse_events
+      find_all_constants_with_prefix "Ms"
+    end
+
+    def self.find_all_constants_with_prefix(prefix)
+      gosu.constants.find_all { |c| c.to_s.start_with? prefix }
+    end
+
+    #
+    # Alias the list of given constants within the given class.
+    #
+    def self.add(options={})
+      events = options[:constants]
+      target = options[:to]
+
+      events.each {|event| target.const_set event, gosu.const_get(event) }
+    end
+
+  end
+end

data/lib/locale/en.yml

@@ -0,0 +1,35 @@
+---
+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."
+      actions:
+      - "Ensure you have specified the correct file"
+      - "Ensure that the file exists at that location"
+      - "Did you mean to generate a new game, scene, or model? Try: `metro help`"
+    specified_directory:
+      title: "Path specified is a directory"
+      message: "The specified path is a `%{directory}` and not a valid Metro game file."
+      actions:
+      - "Ensure you have specified the correct file"
+      - "Specify the path to the metro game file with the directory included."
+      - "Did you mean to generate a new game, scene, or model? Try: `metro help`"
+    reserved_control_name:
+      title: "Unable to define control: %{name}"
+      message: "The specified control name `%{name}` is RESERVED or ALREADY DEFINED."
+      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/locale/locale.rb

@@ -0,0 +1 @@
+I18n.load_path.push "#{File.dirname(__FILE__)}/en.yml"

data/lib/metro.rb

@@ -0,0 +1,140 @@
+require 'delegate'
+require 'logger'
+require 'erb'
+require 'open3'
+
+require 'gosu'
+require 'i18n'
+require 'listen'
+require 'tmxed'
+require 'active_support'
+require 'active_support/dependencies'
+require 'active_support/inflector'
+require 'active_support/core_ext/hash'
+require 'active_support/hash_with_indifferent_access'
+
+require 'gosu_ext/color'
+require 'gosu_ext/gosu_constants'
+require 'core_ext/numeric'
+require 'core_ext/class'
+require 'tmxed_ext/tile_set'
+
+require 'locale/locale'
+
+require 'metro/parameters/parameters'
+require 'metro/asset_path'
+require 'metro/units/units'
+require 'metro/logging'
+require 'metro/version'
+require 'metro/animation'
+require 'metro/font'
+require 'metro/image'
+require 'metro/sample'
+require 'metro/song'
+require 'metro/template_message'
+require 'metro/window'
+require 'metro/game'
+require 'metro/scene'
+require 'metro/scenes'
+require 'metro/models/model'
+require 'metro/missing_scene'
+
+#
+# To allow an author an easier time accessing the Game object from within their game.
+# They do not have to use the `Metro::Game` an instead use the `Game` constant.
+#
+Game = Metro::Game
+
+module Metro
+  extend self
+  extend GosuConstants
+
+  #
+  # @return [String] the filepath to the Metro executable
+  #
+  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
+
+  #
+  # @return [Array] an array of all the handlers that will be executed prior
+  #   to the game being launched.
+  #
+  def setup_handlers
+    @setup_handlers ||= []
+  end
+
+  #
+  # 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
+
+  #
+  # 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
+
+  #
+  # Start the game by lanunching a window with the game configuration and data
+  # that has been loaded.
+  #
+  def start_game
+    Game.start!
+  end
+
+  #
+  # 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 reload!
+    SetupHandlers::LoadGameFiles.new.load_game_files!
+  end
+
+  #
+  # 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.
+  #
+  # @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 game_has_valid_code?
+    execution = SetupHandlers::LoadGameFiles.new.launch_game_in_dry_run_mode
+
+    if execution.invalid?
+      error! 'error.unloadable_source', output: execution.output, exit: false
+    end
+
+    execution.valid?
+  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'