metro 0.2.5 → 0.2.6

data/changelog.md

@@ -1,5 +1,16 @@
 # Metro
 
+## 0.2.6 / 2012/11-20
+
+* Menus now support vertical and horizontal layout
+* Menus now support movement and selection noises
+* Menus can now have a default selection
+* Menus can be enabled/disabled
+* Added Array Property, Boolean Property, and Menu Options Property
+* FIX label horizontal center and right alignments
+* Generic Models will now show a warning instead of raising an exception
+* Removed event chain debug messaging
+
 ## 0.2.5 / 2012-11-18
 
 * FIX metro::ui::rectangle calculation

data/lib/metro.rb

@@ -21,6 +21,7 @@ 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'

data/lib/metro/asset_path.rb

@@ -1,12 +1,28 @@
+
+#
+# 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. For images,
+#   samples, and songs in a model consider using a property.
 #
-# 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.
+# @see Metro::Model::ImageProperty
+# @see Metro::Model::AnimationProperty
+# @see Metro::Model::SongProperty
+# @see Metro::Model::SampleProperty
 #
-# @note Paths that are defined within views use this helper and are assumed to be paths
-#   relative within the assets directory of the game.
+# @note Also consider the model classes Image, Animation, Song, and Sample for
+#   creating the assets found within the assets folder. Each of those will
+#   assist with using the asset_path internally to find the asset.
 #
-# @example Loading the branding image for the player model.
+# @see Metro::Image
+# @see Metro::Animation
+# @see Metro::Song
+# @see Metro::Sample
+#
+# @example Loading a raw Gosu::Image with an `asset_path`
 #
 #     class Player < Metro::Model
 #       def image
@@ -21,10 +37,12 @@ def asset_path(name)
   File.join Dir.pwd, "assets", name
 end
 
-
 #
-# The metro_asset_path is a helper which will generate a filepath based on the directory
-# of the metro library. This is used to retrieve assets internally for missing images.
+# The metro_asset_path is a helper which will generate a filepath based on the
+# directory of the metro library. This is used to retrieve internal assets which
+# can be used to serve up missing images, animations, samples, or songs or
+# defaults that may come with the metro game library.
+#
 #
 def metro_asset_path(name)
   File.join Metro.asset_dir, name

data/lib/metro/events/event_dictionary.rb

@@ -28,7 +28,6 @@ module Metro
     #
     def events_for_targets(*list)
       found_events = Array(list).flatten.compact.map {|s| events_for_target(s) }.flatten.compact
-      log.debug "Retrieved (#{found_events.count}) events for [#{list.join(",")}]"
       found_events
     end
 
@@ -50,4 +49,4 @@ module Metro
 
   end
 
-end
+end

data/lib/metro/font.rb

@@ -0,0 +1,66 @@
+module Metro
+
+  #
+  # Font is a wrapper class for a Gosu::Font. This allows for additional data
+  # to be stored without relying on monkey-patching on functionality.
+  #
+  class Font < SimpleDelegator
+
+    def initialize(gosu_font)
+      super(gosu_font)
+    end
+
+    #
+    # Return a font that matches the specified criteria. Using the name, size,
+    # and window a font will be generated or retrieved from the cache.
+    #
+    # @example Finding or creating a Font
+    #
+    #     Metro::Font.find_or_create window: model.window,
+    #       name: "Times New Roman", size: 24
+    #
+    # @param [Hash] value the hash that contains the `name`, `size` and `window`
+    # that describe the font.
+    #
+    def self.find_or_create(options)
+      window, name, size = create_params(options)
+      gosu_font = fonts["#{name}:#{size}:#{window}"]
+      gosu_font ? new(gosu_font) : create(options)
+    end
+
+    #
+    # Return a font that matches the specified criteria. Using the name, size,
+    # and window a font will be generated and stored in the cache.
+    #
+    # @example Creating a Font
+    #
+    #     Metro::Font.create window: model.window,
+    #       name: "Comic Sans", size: 48
+    #
+    # @param [Hash] value the hash that contains the `name`, `size` and `window`
+    # that describe the font.
+    #
+    def self.create(options)
+      window, name, size = create_params(options)
+      gosu_font = create_gosu_font(window,name,size)
+      fonts["#{name}:#{size}:#{window}"] = gosu_font
+      new(gosu_font)
+    end
+
+    private
+
+    def self.create_params(options)
+      options.symbolize_keys!
+      [ options[:window], options[:name], options[:size] ]
+    end
+
+    def self.create_gosu_font(window, name, size)
+      Gosu::Font.new window, name, size
+    end
+
+    def self.fonts
+      @fonts ||= {}
+    end
+
+  end
+end

data/lib/metro/image.rb

@@ -1,8 +1,8 @@
 module Metro
 
   #
-  # Image is a wrapper class for a Gosu Image. This allows for additional data to be stored
-  # without relying on monkey-patching on functionality.
+  # Image is a wrapper class for a Gosu Image. This allows for additional data
+  # to be stored without relying on monkey-patching on functionality.
   #
   class Image < SimpleDelegator
 
@@ -23,7 +23,8 @@ module Metro
     end
 
     #
-    # Finds an existing image or creates a new image given the window, path, and tileablilty.
+    # Finds an existing image or creates a new image given the window, path,
+    # and tileablilty.
     #
     # @example Finding or creating an Image
     #

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',
-      #         'x' => 20, 'y' => 20, 'z-order' => 0,
-      #         'x-factor' => 3, 'y-factor' => 3,
-      #         'color' => 0xffffffff,
+      #       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}"
@@ -32,6 +32,7 @@ module Metro
       def draw(actor_name,options = {})
 
         view_content_for_actor = view.content[actor_name.to_s]
+
         actor_data = view_content_for_actor.merge(options)
         actor_data[:name] = actor_name
 
@@ -50,9 +51,9 @@ module Metro
 
       #
       # Define a sound actor with the given anem and options.
-      # 
+      #
       # @see #draw
-      # 
+      #
       def play(song_name,options={})
         draw song_name, options.merge(model: "metro::audio::song")
       end
@@ -82,4 +83,4 @@ module Metro
     end
 
   end
-end
+end

data/lib/metro/models/model.rb

@@ -113,13 +113,18 @@ module Metro
     #
     include HasEvents
 
+    #
+    # A helper method that allows the current model to generate another model. This
+    # is useful as it allows for the current model to pass window and scene state
+    # to the created model.
     #
     # @param [String] model_name the name of the model to be created.
     # @return [Metro::Model] the metro model instance
     #
-    def create(model_name)
+    def create(model_name,options={})
+      # @TODO: this is another path that parallels the ModelFactory
       model_class = Metro::Model.model(model_name).constantize
-      mc = model_class.new
+      mc = model_class.new options
       mc.scene = scene
       mc.window = window
       mc
@@ -159,8 +164,7 @@ module Metro
     # with the contents of the view.
     #
     def _load(options = {})
-
-      # Clean up and symbolize all the keys then merge  that with the existing properties
+      # Clean up and symbolize all the keys then merge that with the existing properties
       options.keys.each do |key|
         property_name = key.to_s.underscore.to_sym
         if respond_to? "#{property_name}="
@@ -168,7 +172,6 @@ module Metro
         else
           options[property_name] = options.delete(key)
         end
-
       end
 
       properties.merge! options

data/lib/metro/models/model_factory.rb

@@ -5,26 +5,24 @@ module Metro
 
     def initialize(name,options)
       @name = name.to_s.downcase
-      @options = options
+      @options = options.symbolize_keys
     end
 
     def create
       actor_class = class_for_actor(model_name)
-      instance = actor_class.new
-      instance._load options
-      instance
+      actor_class.new options
     end
 
     def load_from_previous_scene?
       @options[:from] == :previous_scene
     end
-    
+
     def options
       @options.except(:from)
     end
 
     def model_name
-      options['model'] || options[:model] || name
+      options[:model] || name
     end
 
     def class_for_actor(model_name)

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

@@ -70,7 +70,7 @@ module Metro
       end
 
       # Setting with a hash will assume the hash defines an animation.
-      set Hash do |value|
+      set Hash, HashWithIndifferentAccess do |value|
         value.except(:window)
       end
 

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

@@ -0,0 +1,24 @@
+module Metro
+  class Model
+
+    #
+    # The array property will simply store or retrieve an array.
+    #
+    class ArrayProperty < Property
+
+      get do |value|
+        value.is_a?(NilClass) ? default_value : Array(value)
+      end
+
+      set do |value|
+        Array(value).map {|item| item }
+      end
+
+      def default_value
+        options[:default] or []
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,27 @@
+module Metro
+  class Model
+
+    #
+    # The boolean property will simply convert any input into a true or
+    # false value.
+    #
+    class BooleanProperty < Property
+
+      # For all cases the value is converted to floating point when it can
+      # otherwise the default number is used.
+      get_or_set do |value|
+        if value.is_a?(NilClass)
+          default_value
+        else
+          !!value
+        end
+      end
+
+      def default_value
+        !!options[:default]
+      end
+
+    end
+
+  end
+end

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

@@ -81,13 +81,13 @@ module Metro
       end
 
       # Save a hash representation of the font when given a font
-      set Gosu::Font do |font|
+      set Metro::Font do |font|
         { name: font.name, size: font.height }
       end
 
       # Save the hash provided. It is assumed to contain the correct font data.
-      set Hash do |hash|
-        hash.symbolize_keys!
+      set Hash, HashWithIndifferentAccess do |hash|
+        hash.to_hash
       end
 
       #
@@ -120,34 +120,10 @@ module Metro
       # @param [Hash] value the hash that contains the `name`, `size` and `window` that describe the font.
       #
       def self.font_for(value)
-        value.symbolize_keys!
-        name = value[:name]
-        size = value[:size]
-        window = value[:window]
-
-        font = fonts["#{name}:#{size}:#{window}"]
-        unless font
-          font = create_font(window,name,size)
-          fonts["#{name}:#{size}:#{window}"] = font
-        end
-
-        font
-      end
-
-      #
-      # @return the fonts currently cached by the FontProperty.
-      #
-      def self.fonts
-        @fonts ||= {}
-      end
-
-      private
-
-      def self.create_font(window,name,size)
-        Gosu::Font.new window, name, size
+        Font.find_or_create(value)
       end
 
     end
 
   end
-end
+end

data/lib/metro/models/properties/options_property/no_option.rb

@@ -0,0 +1,29 @@
+module Metro
+  class Model
+    class OptionsProperty
+
+      #
+      # When the options cannot find a selected menu option then this no option
+      # is returned instead of a nil value. This allows for a warning to be generated
+      # if any methods target this item.
+      # 
+      # Also if the option will send a 'missing_menu_action' if the options were to
+      # ask for the selected action.
+      # 
+      class NoOption
+        def method_missing(name,*args,&block)
+          log.warn warning_message
+        end
+        
+        def warning_message
+          "No valid options were found in the menu"
+        end
+
+        def properties
+          { action: :missing_menu_action }
+        end
+      end
+
+    end
+  end
+end