metro 0.2.7 → 0.3.0

data/changelog.md

@@ -1,5 +1,14 @@
 # Metro
 
+## 0.3.0 / 2012-11-25
+
+* FIX lots of typos in the documentation
+* Removed `up_action_missing` and `down_ation_missing` event handling
+* Notification events now have block support for 0, 1 and 2 parameters
+* FIX Registration of custom defined custom view parsers
+* FIX Grid Layer layout for Edit Mode
+
+
 ## 0.2.7 / 2012/11-20
 
 * FIX to the new game template

data/lib/commands/thor.rb

@@ -81,3 +81,5 @@ require_relative 'generate_game'
 require_relative 'generate_model'
 require_relative 'generate_scene'
 require_relative 'generate_view'
+require_relative 'build_windows'
+require_relative 'build_mac'

data/lib/core_ext/numeric.rb

@@ -2,14 +2,14 @@ class Numeric
 
   #
   # Set the tick interval which is used in conversion of seconds to
-  # ticks. By default
+  # ticks.
   #
   def self.tick_interval=(value)
     @tick_interval = value.to_f
   end
 
   #
-  # @return the game tick interval.
+  # @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
@@ -22,7 +22,7 @@ class Numeric
   # 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)
+  # @example Expressing an animation that takes place over 3 seconds (~180 ticks)
   #
   #     class ExampleScene < Metro::Scene
   #       draws :title

data/lib/metro/animation/has_animations.rb

@@ -8,8 +8,24 @@ module Metro
     end
 
     #
-    # A simplier syntax to enqueue an animation. At the moment this animation is going
-    # to be an implicit animation.
+    # Define an animation from within another animation block, an event block
+    # or a method.
+    #
+    # @example Defining an animation that fades out the hero when they have
+    #   died.
+    #
+    #     class HellScene
+    #       draws :hero
+    #
+    #       def update
+    #         if hero.dead?
+    #           animate :hero, to: { alpha: 0 }, interval: 60.ticks do
+    #             transition_to :game_over
+    #           end
+    #         end
+    #       end
+    #
+    #     end
     #
     def animate(actor_or_actor_name,options,&block)
       options[:actor] = actor(actor_or_actor_name)
@@ -29,7 +45,7 @@ module Metro
       # @example Defining an animation that fades in and moves a logo when it is
       #   done, transition to the title scene.
       #
-      #     animate :logo, to: { y: 80, alpha: 50 }, interval: 120 do
+      #     animate :logo, to: { y: 80, alpha: 50 }, interval: 120.ticks do
       #       transition_to :title
       #     end
       #

data/lib/metro/events/event_relay.rb

@@ -18,29 +18,6 @@ module Metro
   # @see #on_down
   # @see #on_hold
   #
-  # A target can also receive events when 'button_up' and 'button_down' events
-  # have been fired but did not map to any specified actions. This is similar to
-  # Ruby's {#method_missing}.
-  #
-  # To receive unampped 'button_up' events define a method
-  # named `up_action_missing(id)` within your target.
-  #
-  # To receive unampped 'button_down' events define a method
-  # named `down_action_missing(id)` within your target.
-  #
-  # @example Scene that receives all the 'button_up' and 'button_down' events that
-  #   are not mapped to actions.
-  #
-  #     class ExampleScene
-  #       def up_action_missing(id)
-  #         puts "No up action found for #{id}"
-  #       end
-  #
-  #       def down_action_missing(id)
-  #         puts "No down action found for #{id}"
-  #       end
-  #     end
-  #
   class EventRelay
 
     #
@@ -276,22 +253,20 @@ module Metro
         execute_block_for_target(&action) if window and window.button_down?(key)
       end
     end
-    
+
     def execute_block_for_target(&block)
       event_data = EventData.new(window)
       target.instance_exec(event_data,&block)
     end
 
-    # @return a block of code that is mapped for the 'button_up' id or a block that will attempt to call out
-    #   to the action missing method.
+    # @return a block of code that is mapped for the 'button_up' id
     def up_action(id)
-      up_actions[id] || lambda {|instance| send(:up_action_missing,id) if respond_to?(:up_action_missing) }
+      up_actions[id] || lambda {|no_op| }
     end
 
-    # @return a block of code that is mapped for the 'button_down' id or a block that will attempt to call out
-    #   to the action missing method.
+    # @return a block of code that is mapped for the 'button_down' id
     def down_action(id)
-      down_actions[id] || lambda {|instance| send(:down_action_missing,id) if respond_to?(:down_action_missing) }
+      down_actions[id] || lambda {|no_op| }
     end
 
     #
@@ -311,14 +286,11 @@ module Metro
     # 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)
+        target.instance_exec(sender,event,&action)
+      elsif action.arity == 1
+        target.instance_exec(sender,&action)
       else
         target.instance_eval(&action)
       end

data/lib/metro/events/has_events.rb

@@ -25,15 +25,15 @@ module Metro
       # @example Registering for button held events
       #
       #     class ExampleScene
-      #       event :on_hold KbLeft, Gosu::GpLeft do
+      #       event :on_hold KbLeft, GpLeft do
       #         player.turn_left
       #       end
       #
-      #       event :on_hold, KbRight, Gosu::GpRight do
+      #       event :on_hold, KbRight, GpRight do
       #         player.turn_right
       #       end
       #
-      #       event :on_hold, KbUp, Gosu::GpButton0, do: :calculate_accleration
+      #       event :on_hold, KbUp, GpButton0, do: :calculate_accleration
       #
       #       def calculate_acceleration
       #         long_complicated_calculated_result = 0
@@ -66,7 +66,7 @@ module Metro
       # @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
+      #       event :on_down, GpLeft, GpUp, do: :previous_option
       #
       #       def previous_option
       #         @selected_index = @selected_index - 1
@@ -81,7 +81,7 @@ module Metro
       # @example Registering for a button down event with a block of code to execute
       #
       #     class ExampleScene
-      #        event :on_down, Gosu::GpLeft, Gosu::GpUp do
+      #        event :on_down, GpLeft, GpUp do
       #         @selected_index = @selected_index - 1
       #         @selected_index = options.length - 1 if @selected_index <= -1
       #       end

data/lib/metro/models/draws.rb

@@ -18,11 +18,11 @@ module Metro
       # @example Defining a title label within a scene
       #
       #     class ExampleScene
-      #       draw :title, text: Title Screen',
-      #         'model' => 'metro::ui::label'
-      #         position: "20,20,0",
-      #         scale: "3,3",
-      #         color: "rgba(255,255,255,1.0)"
+      #       draw :title, text: 'Title Screen',
+      #         model: 'metro::ui::label'
+      #         position: '20,20,0',
+      #         scale: '3,3',
+      #         color: 'rgba(255,255,255,1.0)'
       #
       #       def show
       #         puts "Where is my title? #{title.x},#{title.y}"

data/lib/metro/models/properties/animation_property.rb

@@ -2,8 +2,8 @@ module Metro
   class Model
 
     #
-    # A animation property manages an Animation, which is an array of Gosu::Images,
-    # and some metadata.
+    # An animation property manages an Animation, which is an array of
+    # Gosu::Images and some metadata.
     #
     # @see Animation
     #
@@ -75,7 +75,7 @@ module Metro
       end
 
       private
-      
+
       def create_animation(properties)
         self.class.animation_for properties
       end

data/lib/metro/models/properties/dimensions_property.rb

@@ -20,13 +20,13 @@ module Metro
     # @example Defining a dimensions providing a default
     #
     #     class Hero < Metro::Model
-    #       property :dimensions, default: Dimensions.of 100.0, 100.0
+    #       property :dimensions, default: Dimensions.of(100.0, 100.0)
     #     end
     #
     # @example Using a dimensions property with a different property name
     #
     #     class Hero < Metro::Model
-    #       property :box, type: dimensions, default: Dimensions.of 100.0, 100.0
+    #       property :box, type: dimensions, default: Dimensions.of(100.0, 100.0)
     #       # box_width, box_height
     #     end
     #

data/lib/metro/models/properties/scale_property.rb

@@ -2,58 +2,56 @@ module Metro
   class Model
 
     #
-    # A scale property maintains an x and y scaling factor. This scale is not applied to any
+    # A scale property maintains an x and y scaling factor.
     #
-    # A font property also defines a `font_size` property and a `font_name` property which allows a
-    # more direct interface. Changing these values will update the font the next time that it is drawn.
+    # A scale property also defines a `x_factor` property and a `y_factor`
+    # property which allows a more direct interface. Changing these values will
+    # update the scale the next time that it is used.
     #
-    # A font is stored in the properties as a hash representation and is converted into
-    # a Gosu::Font when it is retrieved within the system. When retrieving a font the Font
-    # Property will attempt to use a font that already exists that meets that criteria.
+    # A scale is stored in the properties as a string representation and is
+    # converted into a Scale when it is retrieved within the system.
     #
-    # The fonts are cached within the font property to help performance by reducing the unncessary
-    # creation of similar fonts.
-    #
-    # @example Defining a font property
+    # @example Defining a scale property
     #
     #     class Scoreboard < Metro::Model
     #       property :font
+    #       property :color
+    #       property :scale
     #
     #       def draw
-    #         font.draw text, x, y, z_order, x_factor, y_factor, color
+    #         image.draw text, x, y, z_order, x_factor, y_factor, color
     #       end
     #
     #     end
     #
-    # @example Defining a font property providing a default
-    #
-    #     class Hero < Metro::Model
-    #       property :font, default: { name: 'Comic Sans', size: 80 }
-    #     end
-    #
-    # @example Using the `font_size` and `font_name` properties
+    # @example Defining a scale property providing a default
     #
     #     class Hero < Metro::Model
-    #       property :color, default: "rgba(255,0,0,1.0)"
-    #
-    #       def dignified
-    #         self.font_size = 45
-    #         self.font_name = 'Helvetica'
-    #       end
+    #       property :image, path: 'hero.jpg'
+    #       property :scale, default: "1.0,1.0"
     #     end
     #
-    # @example Using a font property with a different property name
+    # @example Using a scale property with a different property name
     #
     #     class Hero < Metro::Model
-    #       property :alt_font, type: :font, default: "rgba(255,0,255,1.0)"
+    #       property :image, path: 'hero.jpg'
+    #       property :enraged_scale, type: :scale, default: "4.0,4.0"
+    #       property :angle
+    #       property :color
     #
     #       def draw
-    #         puts "Font: #{alt_font_name}:#{alt_font_size}"
-    #         alt_font.draw text, x, y, z_order, x_factor, y_factor, color
+    #         image.draw_rot x, y, z_order, angle.to_f, 0.5, 0.5, 
+    #           enraged_scale_factor_x, enraged_scale_factor_y, color
     #       end
     #     end
     #
     class ScaleProperty < Property
+      void drawRot(double x, double y, ZPos z,
+          double angle, double centerX = 0.5, double centerY = 0.5,
+          double factorX = 1, double factorY = 1,
+          Color c = Color::WHITE,
+          AlphaMode mode = amDefault) const;
+
 
       define_property :x_factor
 

data/lib/metro/models/properties/text_property.rb

@@ -11,6 +11,10 @@ module Metro
     # @example Defining a text property
     #
     #     class Scoreboard < Metro::Model
+    #       property :font
+    #       property :position
+    #       property :color
+    #       property :scale
     #       property :text
     #
     #       def draw
@@ -22,16 +26,21 @@ module Metro
     # @example Defining with a default and text that will be instance evaluated.
     #
     #     class ScoreBoard < Metro::Model
-    #       property :text, default: 'Score is #{player.score}'
+    #       property :score
+    #       property :text, default: 'Score is #{score}'
     #     end
     #
     # @example Using a text property with a different property name
     #
     #     class Hero < Metro::Model
+    #       proeprty :font
+    #       property :position
+    #       property :color
+    #       property :scale
     #       property :description, type: :text
     #
     #       def draw
-    #         description_font.draw description, x, y, z_order, x_factor, y_factor, color
+    #         font.draw description, x, y, z_order, x_factor, y_factor, color
     #       end
     #     end
     #

data/lib/metro/scene.rb

@@ -61,8 +61,8 @@ module Metro
     def draw ; end
 
     #
-    # Before a scene is transisitioned away from to a new scene, this method is called
-    # to allow for the scene to complete any taskss, stop any actions, or pass any
+    # Before a scene is transitioned away from to a new scene, this method is called
+    # to allow for the scene to complete any tasks, stop any actions, or pass any
     # information from the existing scene to the scene that is about to replace it.
     #
     # @note This method should be implemented in the Scene subclass.
@@ -73,8 +73,8 @@ module Metro
     def prepare_transition_to(new_scene) ; end
 
     #
-    # Before a scene is transisitioned to it is called with the previous scene. This
-    # allows for the new scene to rerieve any data from the previous scene to assist
+    # Before a scene is transitioned to it is called with the previous scene. This
+    # allows for the new scene to retrieve any data from the previous scene to assist
     # with the layout of the current scene.
     #
     # @note This method should be implemented in the Scene subclass.

data/lib/metro/version.rb

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

data/lib/metro/views/no_view.rb

@@ -7,7 +7,7 @@ module Metro
       # A NoView is a last resort view which means this is will always will exist.
       #
       # @param [String] view_path the name of the view to find
-      # @return a true if the json view exists and false if it does not exist.
+      # @return a true all the time as this is the last resort format.
       #
       def self.exists?(view_path)
         true

data/lib/metro/views/parsers.rb

@@ -8,18 +8,34 @@ module Metro
     module Parsers
       extend self
 
+      #
+      # Register a view parser.
+      #
+      # A parser is any class or instance that responds to #exists?(view_path),
+      # #parse(view_path) and #format.
+      #
+      # @param [Parser] parser the parser to add to the list of available parsers.
+      #
       def register(parser)
         parsers.push parser
       end
 
+      #
+      # @return [Array<Parsers>] an array of all the registered view parsers. The
+      #   last parser is the NoView parser.
+      #
       def parsers
         @parsers ||= []
       end
+
+      def parsers_with_no_view_fallback
+        parsers + [ NoView ]
+      end
+
     end
 
     Parsers.register YAMLView
     Parsers.register JSONView
-    Parsers.register NoView
 
   end
 end

data/lib/metro/views/view.rb

@@ -80,7 +80,7 @@ module Metro
     # Supported view formats
     #
     def supported_parsers
-      Views::Parsers.parsers
+      Views::Parsers.parsers_with_no_view_fallback
     end
 
     #

data/lib/metro/views/writers.rb

@@ -7,14 +7,29 @@ module Metro
     module Writers
       extend self
 
+      #
+      # Register a view writer
+      #
+      # A writer is any class or instance that responds to #write(view_path,content),
+      # and #format.
+      #
+      # @param [Writer] writer the writer to add to the list of available writers..
+      #
       def register(writer)
         writers.push writer
       end
 
+      #
+      # @return [Array<Writers>] an array of all the registered view writers.
+      #
       def writers
         @writers ||= []
       end
 
+      #
+      # The default view writer, this is the one that will be used if no view
+      # can be found by the writers.
+      #
       attr_accessor :default_writer
 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metro
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-21 00:00:00.000000000 Z
+date: 2012-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -250,10 +250,11 @@ licenses: []
 post_install_message: ! "    ______  ___      _____\n    ___   |/  /_____ __  /_______________\n
   \   __  /|_/ / _  _ \\_  __/__  ___/_  __ \\\n    _  /  / /  /  __// /_  _  /    /
   /_/ /\n    /_/  /_/   \\___/  \\__/ /_/     \\____/\n\n  Thank you for installing
-  metro 0.2.7 / 2012/11-20.\n  ---------------------------------------------------------------------\n
-  \ Changes:\n    \n  * FIX to the new game template\n  * Updated the game template
-  to give more movement to the hero in the first scene\n  * Added the fade-in, fade-out
-  helper to show all the instructions\n  \n\n  ---------------------------------------------------------------------\n"
+  metro 0.3.0 / 2012-11-25.\n  ---------------------------------------------------------------------\n
+  \ Changes:\n    \n  * FIX lots of typos in the documentation\n  * Removed `up_action_missing`
+  and `down_ation_missing` event handling\n  * Notification events now have block
+  support for 0, 1 and 2 parameters\n  * FIX Registration of custom defined custom
+  view parsers\n  * FIX Grid Layer layout for Edit Mode\n  \n  \n\n  ---------------------------------------------------------------------\n"
 rdoc_options: []
 require_paths:
 - lib