metro 0.1.3 → 0.1.4

data/changelog.md

@@ -1,5 +1,9 @@
 # Metro
 
+## 0.1.4 / 2012-10-28
+
+* Removed dependency on the sender gem so metro is playable on Windows
+
 ## 0.1.3 / 2012-10-28
 
 * Fade Scene Transition support added

data/lib/commands/thor.rb

@@ -62,7 +62,7 @@ module Metro
     end
 
     desc "help", "This commoand"
-    def help(topic)
+    def help
       say banner
       print_table self.class.printable_tasks, indent: 4
     end

data/lib/metro.rb

@@ -1,7 +1,6 @@
 require 'gosu'
 require 'gosu_ext/color'
 require 'gosu_ext/gosu_constants'
-require 'sender'
 require 'i18n'
 
 
@@ -11,6 +10,8 @@ require 'logger'
 require 'erb'
 
 require 'locale/locale'
+require 'metro/asset_path'
+require 'metro/logging'
 require 'metro/version'
 require 'metro/template_message'
 require 'metro/window'
@@ -28,28 +29,6 @@ require_relative 'metro/missing_scene'
 #
 Game = Metro::Game
 
-def asset_path(name)
-  File.join Dir.pwd, "assets", name
-end
-
-def log
-  @log ||= begin
-    logger = Logger.new(STDOUT)
-    logger.level = Logger::DEBUG
-    logger
-  end
-end
-
-def error(messages, details = {})
-  details = { show: true }.merge details
-
-  message = TemplateMessage.new messages: messages, details: details,
-    website: Game.website, contact: Game.contact
-
-  warn message if details[:show]
-  exit 1
-end
-
 module Metro
   extend self
   extend GosuConstants
@@ -71,6 +50,7 @@ module Metro
   #
   def run(filename=default_game_filename)
     load_game_files
+    change_into_game_directory(filename)
     load_game_configuration(filename)
     configure_controls!
     start_game
@@ -80,13 +60,26 @@ module Metro
 
   def load_game_files
     $LOAD_PATH.unshift(Dir.pwd) unless $LOAD_PATH.include?(Dir.pwd)
-    Dir['models/*.rb'].each {|model| require model }
-    Dir['scenes/*.rb'].each {|scene| require scene }
+    load_paths 'models', 'scenes', 'lib'
+  end
+  
+  def change_into_game_directory(filename)
+    game_directory = File.dirname(filename)
+    Dir.chdir game_directory
+  end
+
+  def load_paths(*paths)
+    paths.flatten.compact.each {|path| load_path path }
+  end
+
+  def load_path(path)
+    Dir["#{path}/**/*.rb"].each {|model| require model }
   end
 
   def load_game_configuration(filename)
-    game_files_exist!(filename)
-    game_contents = File.read(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
@@ -110,7 +103,7 @@ module Metro
 
   def game_file_exists?(file)
     unless File.exists? file
-      error "error.missing_metro_file", file: file
+      error! "error.missing_metro_file", file: file
     end
   end
 

data/lib/metro/asset_path.rb

@@ -0,0 +1,22 @@
+#
+# The asset_path is a helper which will generate a filepath based on the current working
+# directory of the game. This allows for game author's to specify a path relative within
+# the assets directory of their game.
+# 
+# @note Paths that are defined within views use this helper and are assumed to be paths
+#   relative within the assets directory of the game.
+# 
+# @example Loading the branding image for the player model.
+# 
+#     class Player < Metro::Model
+#       def image
+#         @image ||= Gosu::Image.new( window, asset_path("player.png"), false )
+#       end
+#       def draw
+#         image.draw_rot(x,y,2,angle)
+#       end
+#     end
+# 
+def asset_path(name)
+  File.join Dir.pwd, "assets", name
+end

data/lib/metro/events/event_relay.rb

@@ -68,7 +68,7 @@ module Metro
 
     def self.check_for_already_defined_control!(control)
       if instance_methods.include? control.name
-        error "error.reserved_control_name", name: control.name
+        error! "error.reserved_control_name", name: control.name
       end
     end
 

data/lib/metro/logging.rb

@@ -0,0 +1,33 @@
+
+#
+# Generates a default logger to standard out that can be used within Metro or the game.
+# 
+# @example Outputting information at the debug level
+# 
+#     log.debug "The the screen resolution is #{Game.width},#{Game.height}"
+# 
+def log
+  @log ||= begin
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::DEBUG
+    logger
+  end
+end
+
+#
+# Display an error message defined within the localization file. A game error displays
+# a error title, message, and actions that can be taken to possibly address this issue.
+# 
+# @param [String] message the I18n string found in the locale file.
+# @param [Hash] details contains all the possible key-value pairs that might be needed
+#  for the localized error messages.
+# 
+def error!(messages, details = {})
+  details = { show: true }.merge details
+
+  message = TemplateMessage.new messages: messages, details: details,
+    website: Game.website, contact: Game.contact
+
+  warn message if details[:show]
+  exit 1
+end

data/lib/metro/models/model.rb

@@ -50,7 +50,7 @@ module Metro
     # @param [Symbol] event the name of the notification to generate.
     #
     def notification(event)
-      scene.notification(event.to_sym)
+      scene.notification(event.to_sym,self)
     end
 
     #
@@ -121,9 +121,7 @@ module Metro
       options.each do |raw_key,value|
 
         key = raw_key.to_s.dup
-        key.gsub!(/-/,'_')
-        key.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-        key.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        key = key.gsub(/-/,'_').snake_case
 
         unless respond_to? key
           self.class.send :define_method, key do
@@ -187,10 +185,7 @@ module Metro
         hash = Hash.new(Models::Generic)
 
         models.each do |model|
-          common_name = model.to_s.gsub(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-          common_name.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-          common_name.downcase!
-
+          common_name = model.to_s.snake_case
           hash[common_name] = model
         end
         hash

data/lib/metro/scene.rb

@@ -104,16 +104,9 @@ module Metro
     # Post a custom notification event. This will trigger any objects that are listening
     # for custom events.
     #
-    def notification(event)
+    def notification(event,sender=nil)
 
-      # __sender__ is made available through the sender gem, this is solely to make the
-      # the api call to generate a notification simply `#notification`. Freeing the caller
-      # from having to include themself in the execution.
-      #
-      # @note if the sender functionality proves troublesome across platforms this can
-      #   be dropped and simply require the sender to be included.
-      #
-      sender = __sender__ rescue UnknownSender
+      sender = sender || UnknownSender
 
       event_relays.each do |relay|
         relay.fire_events_for_notification(event,sender)
@@ -287,11 +280,7 @@ module Metro
     #
     def self.scene_name(scene_name=nil)
       @scene_name ||= begin
-        root_name = to_s.gsub(/Scene$/,'')
-        root_name.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-        root_name.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-        root_name.downcase!
-        root_name
+        to_s.gsub(/_?Scene$/i,'').snake_case
       end
 
       scene_name ? @scene_name = scene_name.to_s : @scene_name

data/lib/metro/version.rb

@@ -1,5 +1,5 @@
 module Metro
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
   WEBSITE = "https://github.com/burtlo/metro"
   CONTACT_EMAILS = ["franklin.webber@gmail.com"]
   

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

@@ -3,7 +3,7 @@ class BrandToTitleScene < Metro::Scene
   draws :title
 
   animate :title, to: { alpha: 255 }, interval: 2.seconds do
-    transition_to :title, with: :fade
+    transition_to :title
   end
 
   event :cancel do

data/lib/templates/scene.rb.erb

@@ -10,8 +10,8 @@ class <%= scene_class_name %> < Metro::Scene
   #
   # draw :title, 'text' => 'Title Screen',
   #   'x' => 20, 'y' => 20, 'z-order' => 0,
-  #   'x-factor' => 3, 'y-factor' => 3,
-  #   'color' => 0xffffffff,
+  #   'size' => 40,
+  #   'color' => 'rgb(255,255,255)',
   #   'model' => 'metro::models::label'
   #
   # The draw method can be simplier for models that have content defined
@@ -39,7 +39,7 @@ class <%= scene_class_name %> < Metro::Scene
   #
   # @example Registering the keyboard down event to execute a block of code
   #
-  # event :on_down, Gosu::GpLeft, Gosu::GpUp, do
+  # event :on_down, GpLeft, GpUp, do
   #   transition_to :next_scene
   # end
   #
@@ -49,7 +49,7 @@ class <%= scene_class_name %> < Metro::Scene
   #
   # @example Registering for button held events that would move an actor named `player`
   #
-  # event :on_hold, KbRight, Gosu::GpRight do
+  # event :on_hold, KbRight, GpRight do
   #   title.alpha = title.alpha - 1
   # end
   # Keystroke and Game Event Reference

data/metro.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'gosu', '~> 0.7'
   gem.add_dependency 'thor', '~> 0.16.0'
-  gem.add_dependency 'sender', '~> 1.5.10'
   gem.add_dependency 'i18n', '~> 0.6.1'
   gem.add_development_dependency 'rspec', '~> 2.11'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metro
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-28 00:00:00.000000000 Z
+date: 2012-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -43,22 +43,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.16.0
-- !ruby/object:Gem::Dependency
-  name: sender
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.5.10
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.5.10
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +113,7 @@ files:
 - lib/metro/animation/implicit_animation.rb
 - lib/metro/animation/on_update_operation.rb
 - lib/metro/animation/scene_animation.rb
+- lib/metro/asset_path.rb
 - lib/metro/events/control_definition.rb
 - lib/metro/events/controls.rb
 - lib/metro/events/event_factory.rb
@@ -137,6 +122,7 @@ files:
 - lib/metro/events/unknown_sender.rb
 - lib/metro/game.rb
 - lib/metro/game/dsl.rb
+- lib/metro/logging.rb
 - lib/metro/missing_scene.rb
 - lib/metro/models/draws.rb
 - lib/metro/models/generic.rb
@@ -184,12 +170,9 @@ licenses: []
 post_install_message: ! "    ______  ___      _____\n    ___   |/  /_____ __  /_______________\n
   \   __  /|_/ / _  _ \\_  __/__  ___/_  __ \\\n    _  /  / /  /  __// /_  _  /    /
   /_/ /\n    /_/  /_/   \\___/  \\__/ /_/     \\____/\n\n  Thank you for installing
-  metro 0.1.3 / 2012-10-28.\n  ---------------------------------------------------------------------\n
-  \ Changes:\n    \n  * Fade Scene Transition support added\n  * Numeric#seconds and
-  Numeric#ticks helpers added\n  * Scenes can now define delayed events `after 2.seconds
-  do ; end`\n  * Labels have more defaults and more font options and size\n  * Labels
-  and images will default to center of screen\n  * Able to define game controls within
-  your metro file\n  * Implicit animations support color change.\n  \n\n  ---------------------------------------------------------------------\n"
+  metro 0.1.4 / 2012-10-28.\n  ---------------------------------------------------------------------\n
+  \ Changes:\n    \n  * Removed dependency on the sender gem so metro is playable
+  on Windows\n  \n\n  ---------------------------------------------------------------------\n"
 rdoc_options: []
 require_paths:
 - lib