metro 0.2.1 → 0.2.2

data/lib/metro/models/models/image.rb

@@ -22,20 +22,19 @@ module Metro
 
       property :image
 
+      property :dimensions do
+        image.dimensions
+      end
+
       def contains?(x,y)
         bounds.contains?(x,y)
       end
 
       def bounds
-        Bounds.new x - (width * center_x), y - (height * center_y), x + (width * center_x), y + (height * center_y)
-      end
-
-      def width
-        image.width
-      end
-
-      def height
-        image.height
+        Bounds.new x: x - (width * center_x),
+                   y: y - (height * center_y),
+                   width: width,
+                   height: height
       end
 
       def draw

data/lib/metro/models/models/label.rb

@@ -19,16 +19,12 @@ module Metro
 
       property :text
 
-      def bounds
-        Bounds.new x, y, x + width, y + height
-      end
-
-      def width
-        font.text_width(text) * x_factor
+      property :dimensions do
+        Dimensions.of (font.text_width(text) * x_factor), (font.height * y_factor)
       end
 
-      def height
-        font.height * y_factor
+      def bounds
+        Bounds.new x: x, y: y, width: width, height: height
       end
 
       def contains?(x,y)

data/lib/metro/models/models/menu.rb

@@ -19,6 +19,12 @@ module Metro
       property :unselected_color, type: :color, default: "rgba(119,119,119,1.0)"
       property :selected_color, type: :color, default: "rgba(255,255,255,1.0)"
 
+      property :dimensions do
+        width = font.text_width(longest_option_text)
+        height = options.length * font.height + (options.length - 1) * padding
+        Dimensions.of width, height
+      end
+
       # This is a temporary method as there is no options propery yet defined
       def options
         properties[:options]
@@ -82,21 +88,13 @@ module Metro
       end
 
       def bounds
-        Metro::Models::Bounds.new x, y, x + width, y + height
-      end
-
-      def width
-        font.text_width(longest_option_text)# * x_factor
+        Bounds.new x: x, y: y, width: width, height: height
       end
 
       def longest_option_text
         longest = options.map {|opt| opt }.inject("") {|longest,opt| opt.length > longest.length ? opt : longest }
       end
 
-      def height
-        options.length * font.height + (options.length - 1) * padding
-      end
-
       def option_at_index(index)
         menu_options[index]
       end

data/lib/metro/models/models/rectangle.rb

@@ -5,23 +5,18 @@ module Metro
 
       property :position
 
-      property :z_order, type: :numeric, default: 0
-
       property :color
 
-      attr_writer :width, :height
-
-      def width
-        @width || window.width
-      end
-
-      def height
-        @height || window.height
+      property :dimensions do
+        # By default the dimensions of the rectangle will be the size of the window
+        window.dimensions
       end
 
       def draw
-        window.draw_quad(x,y,color,width,x,color,
-                         width,height,color,y,height,color,
+        window.draw_quad(x,y,color,
+                         width,x,color,
+                         width,height,color,
+                         y,height,color,
                          z_order)
       end
     end

data/lib/metro/models/models/song.rb

@@ -0,0 +1,33 @@
+module Metro
+  module Models
+
+    #
+    # A song represents an audio representation.
+    #
+    class Song < Metro::Model
+
+      property :song
+      property :volume, default: 1.0
+      property :state, type: :text, default: 'play'
+
+      def show
+        song.volume = self.volume
+        play if state == "play"
+      end
+
+      def stop
+        song.stop
+      end
+
+      def play
+        song.play if not song.playing? and not song.paused?
+      end
+
+      def pause
+        song.playing? ? song.pause : song.play
+      end
+
+    end
+
+  end
+end

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

@@ -30,6 +30,17 @@ module Metro
     #       # box_width, box_height
     #     end
     #
+    # @example Using a dimensions property providing a default block (to be calculated
+    #   when the model retrieves the value - allowing for the model's scene and window
+    #   to be set.)
+    #
+    #     class Hero < Metro::Model
+    #       property :dimensions do
+    #         # Return the dimensions of the current window for the hero
+    #         model.window.dimensions
+    #       end
+    #     end
+    #
     class DimensionsProperty < Property
 
       define_property :width
@@ -57,7 +68,13 @@ module Metro
       end
 
       def default_dimensions
-        (options[:default] and options[:default].is_a? Dimensions) ? options[:default] : Dimensions.none
+        if block
+          model.instance_eval(&block)
+        elsif options[:default] and options[:default].is_a? Dimensions
+          options[:default]
+        else
+          Dimensions.none
+        end
       end
 
     end

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

@@ -63,7 +63,7 @@ module Metro
 
       # Set the image with the given image. A Gosu::Image does not normally
       # store it's path, however, this functionality has been monkey-patched.
-      set Gosu::Image do |image|
+      set Metro::Image do |image|
         image.path
       end
 
@@ -98,7 +98,7 @@ module Metro
           images[path] = gosu_image
         end
 
-        Image.new gosu_image, path, tileable
+        Metro::Image.new gosu_image, path, tileable
       end
 
       def self.images

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

@@ -54,6 +54,12 @@ module Metro
         default_point
       end
 
+      # When getting a point, then simply send that point on. This is often
+      # the case when the property is initailized by a scene.
+      get Point do |point|
+        point
+      end
+
       # When getting a string convert it to a point.
       get String do |value|
         Point.parse(value)

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

@@ -1,63 +1,145 @@
 module Metro
   class Model
 
+    #
+    # A property is a value filter that allows you to specify filtering options
+    # both on the setting and the getting of a value. The property itself does
+    # not maintain any of these values but keeps in mind the particular model
+    # and options that it is created when applying the filtering.
+    #
+    # @note Property is intented to be subclassed to provide filtering of particular types.
+    #
     class Property
       include Units
 
-      attr_reader :model, :options
+      attr_reader :model, :options, :block
 
-      def initialize(model,options={})
+      #
+      # @param [Model] model the model associated with this property.
+      # @param [Types] options the additional options that may be set with
+      #   this property. This may be default values or options on how
+      #   this properby should behave.
+      #
+      def initialize(model,options={},&block)
         @model = model
         @options = options
+        @block = block
       end
 
-      def self.gets
-        @gets ||= begin
-          hash = HashWithIndifferentAccess.new { |hash,key| hash["NilClass"] }
-          hash["NilClass"] = lambda { |value| raise "#{self} is not able to translate the #{value} (#{value.class})" }
-          hash
-        end
-      end
-
+      # Define a filter block for getting a value of that type.
       def self.get(type=NilClass,&block)
         gets[type.to_s] = block
       end
 
+      # All get filter blocks defined
+      def self.gets
+        @gets ||= hash_with_default_to_nil
+      end
+
+      # Perform a get of the value, running it through the get
+      # filter block that matches the type.
       def get(value)
         get_block = self.class.gets[value.class.to_s]
         instance_exec(value,&get_block)
       end
 
-      def self.sets
-        @sets ||= begin
-          hash = HashWithIndifferentAccess.new { |hash,key| hash["NilClass"] }
-          hash["NilClass"] = lambda { |value| raise "#{self} is not able to translate the #{value} (#{value.class})" }
-          hash
-        end
-      end
-
+      # Define a filter block for setting a value of the type.
       def self.set(type=NilClass,&block)
         sets[type.to_s] = block
       end
 
+      # All set filter blocks defined
+      def self.sets
+        @sets ||= hash_with_default_to_nil
+      end
+
+      # Perform a set of the value, running it through the set
+      # filter block that matches the type.
       def set(value)
         set_block = self.class.sets[value.class.to_s]
         instance_exec(value,&set_block)
       end
 
+      # Define a filter block that applies to both the setting and getting of a property.
       def self.get_or_set(type=NilClass,&block)
         gets[type.to_s] = block
         sets[type.to_s] = block
       end
 
-      def self.defined_properties
-        @defined_properties ||= []
-      end
-
+      #
+      # Allow a property to define a sub-property.
+      #
+      # A sub-property that is defined can be any type of exiting properties. Which
+      # may also define more sub-properties. These sub-properties will be available as properties
+      # through the names provided.
+      #
+      # @example DimensionProperty defining two numeric sub-properties for height and width
+      #
+      #     class DimensionsProperty < Property
+      #       define_property :width
+      #       define_property :height
+      #     end
+      #
+      #     class Frogger < Metro::Model
+      #       property :dimensions
+      #
+      #       def after_initialize
+      #         puts "Frog dimensions are #{dimensions}"
+      #         puts "(#{dimensions.width},#{dimensions.height}) == (#{width},#{height})"
+      #       end
+      #     end
+      #
+      # The sub-properties can also be prefixed with the parent property name:
+      #
+      # @example FontProperty defines sub-properties which include the parent propery prefix
+      #
+      #     class FontProperty < Property
+      #       define_property :size, prefix: true
+      #       define_property :name, type: :text, prefix: true
+      #     end
+      #
+      #     class MyLabel < Metro::Model
+      #       property :font
+      #
+      #       def after_initialize
+      #         puts "Font is: #{font} - #{font_name}:#{font_size}"
+      #       end
+      #     end
+      #
+      # If you define a property with the non-default name it will automatically add the prefix
+      # to all the sub-properties. This is to prevent any getter/setter method name collisions.
+      #
+      # @example DimensionProperty defining two numeric sub-properties for height and width
+      #
+      #     class DimensionsProperty < Property
+      #       define_property :width
+      #       define_property :height
+      #     end
+      #
+      #     class Frogger < Metro::Model
+      #       property :dims, type: :dimensions
+      #
+      #       def after_initialize
+      #         puts "Frog dimensions are #{dims}"
+      #         puts "(#{dims.width},#{dims.height}) == (#{dims_width},#{dims_height})"
+      #       end
+      #     end
+      #
       def self.define_property(name,options = {})
         defined_properties.push PropertyDefinition.new name, options
       end
 
+      #
+      # @return an array of all the defined properties.
+      #
+      def self.defined_properties
+        @defined_properties ||= []
+      end
+
+      #
+      # Capture all the subclassed properties and add them to the availble list of
+      # properties.
+      #
       def self.inherited(subclass)
         property_name = subclass.to_s.gsub(/Property$/,'').split("::").last.underscore
         properties_hash[property_name] = subclass.to_s
@@ -67,19 +149,41 @@ module Metro
         @properties ||= []
       end
 
+      #
+      # @return a Property Class that matches the specified name.
+      #
       def self.property(name)
         property_classname = properties_hash[name]
         property_classname.constantize
       end
 
+      #
+      # Generate a properties hash. This properties will default to the numeric key when the property
+      # type cannot be found.
+      #
       def self.properties_hash
-        @properties_hash ||= ActiveSupport::HashWithIndifferentAccess.new { |hash,key| hash[:numeric] }
+        @properties_hash ||= HashWithIndifferentAccess.new { |hash,key| hash[:numeric] }
+      end
+
+      #
+      # Generate a hash that will default all missing keys to the NilClass key and the NilClass key will
+      # return a cource of action that will raise an exception. This means by default that if it is not
+      # overridden an error is generated.
+      #
+      def self.hash_with_default_to_nil
+        hash = HashWithIndifferentAccess.new { |hash,key| hash["NilClass"] }
+        hash["NilClass"] = lambda { |value| raise "#{self} is not able to translate the #{value} (#{value.class})" }
+        hash
       end
 
     end
 
   end
 
+  #
+  # A property definition contains the name of the property and the options specified with it.
+  # This is used internally to define properties and sub-properties.
+  #
   class PropertyDefinition
 
     attr_reader :name, :options
@@ -102,3 +206,5 @@ require_relative 'font_property'
 require_relative 'image_property'
 require_relative 'position_property'
 require_relative 'scale_property'
+require_relative 'song_property'
+require_relative 'sample_property'

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

@@ -0,0 +1,97 @@
+module Metro
+  class Model
+
+    #
+    # A sample property maintains a Gosu::Sample.
+    #
+    # A sample is stored in the properties as the path in the assets folder and is converted into
+    # a Gosu::Sample when it is retrieved within the system. When retrieving a sample the Sample
+    # Property will attempt to use a sample that already exists that meets that criteria.
+    #
+    # @example Defining a sample property
+    #
+    #     class Hero < Metro::Model
+    #       property :sample
+    #     end
+    #
+    # @example Defining a sample property providing a default
+    #
+    #     class Hero < Metro::Model
+    #       property :sample, path: 'pickup.wav'
+    #     end
+    #
+    # @example Using a sample property with a different property name
+    #
+    #     class Hero < Metro::Model
+    #       property :pickup_sample, type: :sample, path: 'pickup.wav'
+    #     end
+    #    
+    class SampleProperty < Metro::Model::Property
+
+      # By default, getting an unsupported value will return the default sample
+      get do |value|
+        default_sample
+      end
+      
+      # Bu default, setting sn unsupported value will save the default sample filename
+      set do |value|
+        default_sample_filename
+      end
+
+      # Generate a sample from the specified string filepath
+      get String do |filename|
+        self.class.sample_for path: filename, window: model.window
+      end
+
+      # The assumption here is that the string is a sample filepath
+      set String do |filename|
+        filename
+      end
+
+      # Setting the song value with a Metro::Sample will save the string filepath
+      set Metro::Sample do |sample|
+        sample.path
+      end
+      
+      #
+      # @return the default sample for the sample property. This is based on the default
+      #   sample name.
+      #
+      def default_sample
+        self.class.sample_for path: default_sample_filename, window: model.window
+      end
+      
+      #
+      # @return a string sample name that is default. If the property was not created with
+      #   a default value the the default sample is the missing sample found in Metro.
+      #
+      def default_sample_filename
+        options[:path] || metro_asset_path("missing.wav")
+      end
+      
+      #
+      # Returns a Metro::Sample. This is composed of the metadata provided and a Gosu::Sample.
+      #
+      # @param [Hash] options the path, window, and other parameters necessary to generate
+      #   a sample.
+      #
+      def self.sample_for(options)
+        options.symbolize_keys!
+        relative_path = options[:path]
+        window = options[:window]
+
+        absolute_path = path = options[:path]
+        absolute_path = asset_path(absolute_path) unless absolute_path.start_with? "/"
+
+        gosu_sample = create_sample(window,absolute_path)
+
+        Metro::Sample.new gosu_sample, relative_path
+      end
+
+      def self.create_sample(window,filename)
+        Gosu::Sample.new(window, filename)
+      end
+
+    end
+  end
+end