metro 0.0.6 → 0.1.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in metro.gemspec
 gemspec
+
+
+group 'development' do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rb-fsevent', '~> 0.9.1'
+end

data/Guardfile

@@ -0,0 +1,4 @@
+guard 'rspec', version: 2, cli: "-c -f d" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+end

data/README.md

@@ -1,3 +1,11 @@
+```
+  ______  ___      _____
+  ___   |/  /_____ __  /_______________
+  __  /|_/ / _  _ \_  __/__  ___/_  __ \
+  _  /  / /  /  __// /_  _  /    / /_/ /
+  /_/  /_/   \___/ \__/  /_/     \____/
+
+```
 # metro
 
 Metro is a framework built around [gosu](https://github.com/jlnr/gosu) (the 2D game development library in Ruby). The goal of Metro is to enforce common conceptual structures and conventions making it easier to quickly generate a game.

data/lib/gosu_ext/color.rb

@@ -12,7 +12,7 @@ class Gosu::Color
       if value.is_a? Gosu::Color
         gosu_initialize value.alpha, value.red, value.green, value.blue
       elsif value.is_a? String
-        gosu_initialize value.to_i(16)
+        gosu_initialize *Array(self.class.parse_string(value))
       else
         gosu_initialize value
       end
@@ -21,4 +21,28 @@ class Gosu::Color
     end
   end
 
+  def self.parse_string(value)
+    parse_hex(value) || parse_rgb(value) || parse_rgba(value) || [ 255, 255, 255, 255 ]
+  end
+  
+  def self.parse_rgba(rgba)
+    if rgba =~ /rgba\(([\d]{1,3}),([\d]{1,3}),([\d]{1,3}),(\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
+
 end

data/lib/metro.rb

@@ -2,20 +2,24 @@ require 'gosu'
 require 'gosu_ext/color'
 
 require 'logger'
-
+require 'erb'
 
 require 'metro/version'
+require 'metro/error'
+require 'metro/template_message'
 require 'metro/window'
 require 'metro/game'
 require 'metro/scene'
 require 'metro/models/model'
 require 'metro/models/generic'
 
+require_relative 'metro/missing_scene'
+
+
 def asset_path(name)
   File.join Dir.pwd, "assets", name
 end
 
-
 def log
   @log ||= begin
     logger = Logger.new(STDOUT)
@@ -57,6 +61,7 @@ module Metro
   end
 
   def load_game_configuration(filename)
+    game_files_exist!(filename)
     game_contents = File.read(filename)
     game_block = lambda {|instance| eval(game_contents) }
     game = Game::DSL.parse(&game_block)
@@ -70,4 +75,27 @@ module Metro
     window.show
   end
 
+  def game_files_exist!(*files)
+    error_messages = files.compact.flatten.map { |file| game_file_exists?(file) }.reject {|exist| exist == true }
+    unless error_messages.empty?
+      display_error_message(error_messages)
+      exit 1
+    end
+  end
+
+  def game_file_exists?(file)
+    unless File.exists? file
+      Error.new title: "Unable to find Metro game file",
+        message: "The specified file `#{file}` which is required to run the game could not be found.",
+        details: [ "Ensure you have specified the correct file", "Ensure that the file exists at that location" ]
+    else
+      true
+    end
+  end
+
+  def display_error_message(messages)
+    message = TemplateMessage.new messages: messages, website: WEBSITE, email: CONTACT_EMAILS
+    warn message
+  end
+
 end

data/lib/metro/animation/animation_factory.rb

@@ -0,0 +1,14 @@
+module Metro
+
+  class AnimationFactory
+
+    attr_reader :options, :on_complete_block
+
+    def initialize(options = {},&block)
+      @options = options
+      @on_complete_block = block
+    end
+
+  end
+
+end

data/lib/metro/animation/has_animations.rb

@@ -0,0 +1,37 @@
+require_relative 'animation_factory'
+
+module Metro
+  module HasAnimations
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      #
+      # Define an animation to execute when the scene starts.
+      #
+      # @example Defining an animation that fades in and moves a logo when it is
+      #   done, transition to the title scene.
+      #
+      #     animate actor: :logo, to: { y: 80, alpha: 50 }, interval: 120 do
+      #       transition_to :title
+      #     end
+      #
+      def animate(options,&block)
+        scene_animation = AnimationFactory.new options, &block
+        animations.push scene_animation
+      end
+
+      #
+      # All the animations that are defined for the scene to be run the scene starts.
+      #
+      def animations
+        @animations ||= []
+      end
+
+    end
+
+  end
+end

data/lib/metro/error.rb

@@ -0,0 +1,21 @@
+class Error
+
+  def initialize(details = {})
+    @title = details[:title]
+    @message = details[:message]
+    @details = details[:details]
+  end
+
+  def title
+    "ERROR: #{@title.upcase}"
+  end
+
+  def message
+    @message
+  end
+
+  def details
+    @details.map {|detail| "* #{detail}" }.join("\n")
+  end
+
+end

data/lib/metro/events/event_factory.rb

@@ -0,0 +1,15 @@
+module Metro
+
+  class EventFactory
+
+    attr_reader :event, :buttons, :block
+
+    def initialize(event,buttons = [],&block)
+      @event = event
+      @buttons = buttons
+      @block = block
+    end
+
+  end
+
+end

data/lib/metro/{event_relay.rb → events/event_relay.rb}

@@ -56,6 +56,7 @@ module Metro
       @up_actions ||= {}
       @down_actions ||= {}
       @held_actions ||= {}
+      @custom_notifications ||= Hash.new([])
     end
 
     attr_reader :target, :window
@@ -68,9 +69,7 @@ module Metro
     # @example Registering for a button down event to call a method named 'previous_option'
     #
     #     class ExampleScene
-    #       def events(e)
-    #         e.on_down Gosu::GpLeft, Gosu::GpUp, do: :previous_option
-    #       end
+    #       event :on_down, Gosu::GpLeft, Gosu::GpUp, do: :previous_option
     #
     #       def previous_option
     #         @selected_index = @selected_index - 1
@@ -85,11 +84,9 @@ module Metro
     # @example Registering for a button down event with a block of code to execute
     #
     #     class ExampleScene
-    #       def events(e)
-    #         e.on_down Gosu::GpLeft, Gosu::GpUp do
-    #           @selected_index = @selected_index - 1
-    #           @selected_index = options.length - 1 if @selected_index <= -1
-    #         end
+    #        event :on_down, Gosu::GpLeft, Gosu::GpUp do
+    #         @selected_index = @selected_index - 1
+    #         @selected_index = options.length - 1 if @selected_index <= -1
     #       end
     #     end
     #
@@ -108,9 +105,7 @@ module Metro
     # @example Registering for a button down event to call a method named 'next_option'
     #
     #     class ExampleScene
-    #       def events(e)
-    #         e.on_up Gosu::KbEscape, do: :leave_scene
-    #       end
+    #        event :on_up, Gosu::KbEscape, do: :leave_scene
     #
     #       def leave_scene
     #         transition_to :title
@@ -123,10 +118,8 @@ module Metro
     # @example Registering for a button up event with a block of code to execute
     #
     #     class ExampleScene
-    #       def events(e)
-    #         e.on_up Gosu::KbEscape do
-    #           transition_to :title
-    #         end
+    #       event :on_up, Gosu::KbEscape do
+    #        transition_to :title
     #       end
     #     end
     #
@@ -147,18 +140,16 @@ module Metro
     # @example Registering for button held events
     #
     #     class ExampleScene
-    #       def events(e)
-    #         e.on_hold Gosu::KbLeft, Gosu::GpLeft do
-    #           player.turn_left
-    #         end
-    #
-    #         e.on_hold Gosu::KbRight, Gosu::GpRight do
-    #           player.turn_right
-    #         end
+    #       event :on_hold Gosu::KbLeft, Gosu::GpLeft do
+    #         player.turn_left
+    #       end
     #
-    #         e.on_hold Gosu::KbUp, Gosu::GpButton0, do: :calculate_accleration
+    #       event :on_hold, Gosu::KbRight, Gosu::GpRight do
+    #         player.turn_right
     #       end
     #
+    #       event :on_hold, Gosu::KbUp, Gosu::GpButton0, do: :calculate_accleration
+    #
     #       def calculate_acceleration
     #         long_complicated_calculated_result = 0
     #         # ... multi-line calculations to determine the player acceleration ...
@@ -171,7 +162,45 @@ module Metro
       _on(@held_actions,args,block)
     end
 
-    attr_reader :up_actions, :down_actions, :held_actions
+    #
+    # Register for a custom notification event. These events are fired when
+    # another object within the game posts a notification with matching criteria.
+    # If there has indeed been a match, then the stored action block will be fired.
+    #
+    # When the action block is specified is defined with no parameters it is assumed that
+    # that the code should be executed within the context of the object that defined
+    # the action, the 'target'.
+    #
+    # @example Registering for a save complete event that would re-enable a menu.
+    #
+    #     class ExampleScene
+    #       event :notification, :save_complete do
+    #         menu.enabled!
+    #       end
+    #     end
+    #
+    # The action block can also be specified with two parameters. In this case the code is
+    # no longer executed within the context of the object and is instead provided the
+    # the action target and the action source.
+    #
+    # @example Registering for a win game event that explicitly states the target and source.
+    #
+    #     class ExampleScene
+    #
+    #       event :notification, :win_game do |target,winner|
+    #         target.declare_winner winner
+    #       end
+    #
+    #       def declare_winner(winning_player)
+    #         # ...
+    #       end
+    #     end
+    #
+    def notification(param,&block)
+      custom_notifications[param.to_sym] = custom_notifications[param.to_sym] + [ block ]
+    end
+
+    attr_reader :up_actions, :down_actions, :held_actions, :custom_notifications
 
     def _on(hash,args,block)
       options = (args.last.is_a?(Hash) ? args.pop : {})
@@ -220,6 +249,35 @@ module Metro
       down_actions[id] || lambda {|instance| send(:down_action_missing,id) if respond_to?(:down_action_missing) }
     end
 
+    #
+    # Fire all events mapped to the matching notification.
+    #
+    def fire_events_for_notification(event,sender)
+      notification_actions = custom_notifications[event]
+      notification_actions.each do |action|
+        _fire_event_for_notification(event,sender,action)
+      end
+    end
+
+    #
+    # Fire a single event based on the matched notification.
+    #
+    # An action without any parameters is assumed to be executed within the contexxt
+    # of the target. If there are two parameters we will simply execute the action and
+    # pass it both the target and the sender.
+    # 
+    # @TODO: Allow for the blocks to be specified with one parameter: source (and executed
+    #   within the context of the target)
+    # 
+    # @TODO: Allow for the blocks to be specified with three parameters: source, target, event
+    #
+    def _fire_event_for_notification(event,sender,action)
+      if action.arity == 2
+        action.call(target,sender)
+      else
+        target.instance_eval(&action)
+      end
+    end
 
   end
 end

data/lib/metro/events/has_events.rb

@@ -0,0 +1,108 @@
+require_relative 'event_factory'
+
+module Metro
+
+  module HasEvents
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      #
+      # Register an event for the scene.
+      #
+      # @example Registering for a save complete event that would re-enable a menu.
+      #
+      #     class ExampleScene
+      #       event :notification, :save_complete do
+      #         menu.enabled!
+      #       end
+      #     end
+      #
+      # @example Registering for button held events
+      #
+      #     class ExampleScene
+      #       event :on_hold Gosu::KbLeft, Gosu::GpLeft do
+      #         player.turn_left
+      #       end
+      #
+      #       event :on_hold, Gosu::KbRight, Gosu::GpRight do
+      #         player.turn_right
+      #       end
+      #
+      #       event :on_hold, Gosu::KbUp, Gosu::GpButton0, do: :calculate_accleration
+      #
+      #       def calculate_acceleration
+      #         long_complicated_calculated_result = 0
+      #         # ... multi-line calculations to determine the player acceleration ...
+      #         player.accelerate = long_complicated_calculated_result
+      #       end
+      #     end
+      #
+      # @example Registering for a button down event to call a method named 'next_option'
+      #
+      #     class ExampleScene
+      #        event :on_up, Gosu::KbEscape, do: :leave_scene
+      #
+      #       def leave_scene
+      #         transition_to :title
+      #       end
+      #     end
+      #
+      # Here in this scene if the Escape Key is pressed and released the example scene
+      # will transition to the title scene.
+      #
+      # @example Registering for a button up event with a block of code to execute
+      #
+      #     class ExampleScene
+      #       event :on_up, Gosu::KbEscape do
+      #        transition_to :title
+      #       end
+      #     end
+      #
+      # @example Registering for a button down event to call a method named 'previous_option'
+      #
+      #     class ExampleScene
+      #       event :on_down, Gosu::GpLeft, Gosu::GpUp, do: :previous_option
+      #
+      #       def previous_option
+      #         @selected_index = @selected_index - 1
+      #         @selected_index = options.length - 1 if @selected_index <= -1
+      #       end
+      #     end
+      #
+      # Here in this scene if the GpLeft or GpUp buttons are pressed down the method
+      # `previous_options` will be executed.
+      #
+      #
+      # @example Registering for a button down event with a block of code to execute
+      #
+      #     class ExampleScene
+      #        event :on_down, Gosu::GpLeft, Gosu::GpUp do
+      #         @selected_index = @selected_index - 1
+      #         @selected_index = options.length - 1 if @selected_index <= -1
+      #       end
+      #     end
+      #
+      # This example uses a block instead of a method name but it is absolultey the same
+      # as the last example.
+      #
+      def event(event_type,*buttons,&block)
+        scene_event = EventFactory.new event_type, buttons, &block
+        events.push scene_event
+      end
+
+      #
+      # @return a list of all the EventFactories defined for the scene
+      #
+      def events
+        @events ||= []
+      end
+
+    end
+
+  end
+
+end