metro 0.2.1 → 0.2.2

data/README.md

@@ -12,6 +12,8 @@ Metro is a framework built around [gosu](https://github.com/jlnr/gosu) (the 2D g
 
 > NOTE: This project is very early in development and at this point mostly a prototype to explore more of theses concepts to gain an understanding of core tools necessary to make games.
 
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/burtlo/metro)
+
 ## Installation
 
     $ gem install metro

data/changelog.md

@@ -1,5 +1,15 @@
 # Metro
 
+## 0.2.2 / 2012-11-10
+
+* Song support added (scene methods and model properties)
+* Sample support added (model properties)
+* Added a missing sample/song
+* Implicit Animation easings can now be more easily created and registered.
+* Properties can now be defined with a block
+* FIX Dimensions parse creation called wrong method
+* Removed support for specifying a color in animation
+
 ## 0.2.1 / 2012-11-08
 
 * FIX Scene fade transition color changing and implicit animations 

data/lib/gosu_ext/image.rb

@@ -34,5 +34,9 @@ module Metro
     # The tileability of the image
     attr_reader :tileable
 
+    def dimensions
+      Metro::Units::Dimensions.of width, height
+    end
+
   end
 end

data/lib/gosu_ext/sample.rb

@@ -0,0 +1,18 @@
+module Metro
+
+  #
+  # Sample is a wrapper class for a Gosu Sample. This allows for additional data to be stored
+  # without relying on monkey-patching on functionality.
+  #
+  class Sample < SimpleDelegator
+
+    attr_accessor :sample, :path
+
+    def initialize(sample,path)
+      super(sample)
+      @sample = sample
+      @path = path
+    end
+
+  end
+end

data/lib/gosu_ext/song.rb

@@ -0,0 +1,18 @@
+module Metro
+
+  #
+  # Song is a wrapper class for a Gosu Song. This allows for additional data to be stored
+  # without relying on monkey-patching on functionality.
+  #
+  class Song < SimpleDelegator
+
+    attr_accessor :song, :path
+
+    def initialize(song,path)
+      super(song)
+      @song = song
+      @path = path
+    end
+
+  end
+end

data/lib/metro.rb

@@ -13,6 +13,8 @@ require 'active_support/hash_with_indifferent_access'
 require 'gosu_ext/color'
 require 'gosu_ext/image'
 require 'gosu_ext/animation'
+require 'gosu_ext/song'
+require 'gosu_ext/sample'
 require 'gosu_ext/gosu_constants'
 require 'core_ext/numeric'
 

data/lib/metro/animation/easing/ease_in.rb

@@ -0,0 +1,15 @@
+module Metro
+  class Easing
+
+    #
+    # Perform a ease-in motion between the start position and the final position.
+    #
+    class EaseIn < Easing
+      def self.calculation(moment,start,change,interval)
+        change * (moment = moment / interval) * moment + start
+      end
+    end
+
+    register :ease_in, EaseIn
+  end
+end

data/lib/metro/animation/easing/easing.rb

@@ -0,0 +1,51 @@
+module Metro
+
+  #
+  # An easing is a means to calculate the steps between the start and the final
+  # over an interval.
+  #
+  class Easing
+
+    #
+    # The calculate method is called within the ImplicitAnimation and will create
+    # an array of all the states between the start and the final value.
+    #
+    def self.calculate(start,final,interval)
+      change = final - start
+      (1..interval).map { |time| calculation(time.to_f,start,change,interval) }
+    end
+
+    #
+    # The calculation method is to be overriden in the Easing subclasses.
+    # This calculation figures out the value at the current moemnt.
+    #
+    def self.calculation(moment,start,change,interval) ; 0 ; end
+
+    #
+    # Register an easing within the game system.
+    #
+    def self.register(name,easing_class)
+      easings[name] = easing_class.to_s
+    end
+
+    #
+    # @return the easing class based on the specified easing name.
+    #
+    def self.easing_for(easing)
+      easing_classname = easings[easing]
+      easing_classname.constantize
+    end
+
+    #
+    # A hash of all the supported easings within metro or game.
+    #
+    def self.easings
+      @easings_hash ||= HashWithIndifferentAccess.new("Metro::Easing::Linear")
+    end
+
+  end
+
+end
+
+require_relative 'linear'
+require_relative 'ease_in'

data/lib/metro/animation/easing/linear.rb

@@ -0,0 +1,15 @@
+module Metro
+  class Easing
+
+    #
+    # Perform a linear motion between the start position and the final position.
+    #
+    class Linear < Easing
+      def self.calculation(moment,start,change,interval)
+        change * moment / interval + start
+      end
+    end
+
+    register :linear, Linear
+  end
+end

data/lib/metro/animation/has_animations.rb

@@ -7,6 +7,20 @@ module Metro
       base.extend ClassMethods
     end
 
+    #
+    # A simplier syntax to enqueue an animation. At the moment this animation is going
+    # to be an implicit animation.
+    #
+    def animate(actor_or_actor_name,options,&block)
+      options[:actor] = actor(actor_or_actor_name)
+      options[:context] = self
+      animation_group = SceneAnimation.build options, &block
+      enqueue animation_group
+    end
+
+    # An alternative to stating `animate` syntax.
+    alias_method :change, :animate
+
     module ClassMethods
 
       #
@@ -24,6 +38,9 @@ module Metro
         animations.push scene_animation
       end
 
+      # Provide an alternative to the `animate` syntax.
+      alias_method :change, :animate
+
       #
       # All the animations that are defined for the scene to be run the scene starts.
       #

data/lib/metro/animation/implicit_animation.rb

@@ -1,4 +1,4 @@
-require_relative 'easing'
+require_relative 'easing/easing'
 
 module Metro
 
@@ -52,21 +52,7 @@ module Metro
     def after_initialize
       to.each do |attribute,final|
         start = actor.send(attribute)
-
-        if attribute == :color
-          final = Gosu::Color.new final
-          
-          # @TODO: This is not going to work when the color uses a non-standard
-          # name for the color property.
-
-          animations.push build_animation_step(:red,start.red,final.red)
-          animations.push build_animation_step(:green,start.green,final.green)
-          animations.push build_animation_step(:blue,start.blue,final.blue)
-          animations.push build_animation_step(:alpha,start.alpha,final.alpha)
-        else
-          animations.push build_animation_step(attribute,start,final)
-        end
-
+        animations.push build_animation_step(attribute,start,final)
       end
     end
 
@@ -74,7 +60,7 @@ module Metro
       step = AnimationStep.new
       step.actor = actor
       step.attribute = attribute
-      step.deltas = stepping(easing).calculate(start.to_f,final.to_f,interval.to_f)
+      step.deltas = easing_for(easing).calculate(start.to_f,final.to_f,interval.to_f)
       step
     end
 
@@ -90,13 +76,8 @@ module Metro
     # @return the correct easing based on the specified name. When the name
     #   provided does not match anything then default to linear easing.
     #
-    def stepping(stepping)
-      @steppings ||= begin
-        hash = HashWithIndifferentAccess.new("Metro::Easing::Linear")
-        hash.merge! linear: "Metro::Easing::Linear",
-          ease_in: "Metro::Easing::EaseIn"
-      end
-      @steppings[stepping].constantize
+    def easing_for(name)
+      Metro::Easing.easing_for(name)
     end
 
     #

data/lib/metro/models/draws.rb

@@ -12,7 +12,7 @@ module Metro
       #
       # Define an actor with the given name and options.
       #
-      # As a convience the draw method will define `getter` and `setter`
+      # As a convenience the draw method will define `getter` and `setter`
       # methods for the specified actor.
       #
       # @example Defining a title label within a scene
@@ -48,6 +48,15 @@ module Metro
         drawings.push scene_actor
       end
 
+      #
+      # Define a sound actor with the given anem and options.
+      # 
+      # @see #draw
+      # 
+      def play(song_name,options={})
+        draw song_name, options.merge(model: "metro::models::song")
+      end
+
       #
       # Define several actors to be drawn.
       #

data/lib/metro/models/model.rb

@@ -1,5 +1,4 @@
 require_relative 'key_value_coding'
-require_relative 'rectangle_bounds'
 require_relative 'properties/property'
 
 module Metro
@@ -16,6 +15,31 @@ module Metro
   class Model
     include Units
 
+    #
+    # This is an entry point for customization. As the model's {#initialize}
+    # method performs may perform some initialization that may be necessary.
+    #
+    # At this point the model has been created. However, the window and scene
+    # of the model will not have been defined and defined properties rely on
+    # the window or scene will return nil values. Other properties also will
+    # likely not be set.
+    #
+    # @note This method should be implemented in the Model subclass.
+    #
+    def after_initialize ; end
+
+
+    #
+    # This is an entry point for customization. After the model's properties
+    # have been set and the model has been assigned to the window and scene
+    # this method is called. Here is where customization of properties or
+    # final positioning can be performed.
+    #
+    # @note This method may be implemented in the Model subclass.
+    #
+    def show ; end
+
+
     #
     # This is called every update interval while the actor is in the scene
     #
@@ -23,6 +47,7 @@ module Metro
     #
     def update ; end
 
+
     #
     # This is called after an update. A model normally is not removed after
     # an update, however if the model responds true to #completed? then it
@@ -34,7 +59,41 @@ module Metro
     def completed? ; false ; end
 
 
-    def self.property(name,options={})
+    #
+    # This is called after every {#update} and when the OS wants the window to
+    # repaint itself.
+    #
+    # @note This method should be implemented in the Model subclass.
+    #
+    def draw ; end
+
+
+
+    #
+    # Define a property for the model. A property has a name and then can optionally specify
+    # a property type which will receive additional options.
+    #
+    # @example Defining various propertys for a model
+    #
+    #     class Player
+    #       property :position
+    #       property :angle, default: 0.0
+    #       property :turn_amount, default: 4.5
+    #       property :image, path: "player.png"
+    #       property :motto, type: :text, default: 'Hometown Heroes!'
+    #     end
+    #
+    # When the property name matches a property definition with that name they will be used. This is what
+    # happens for the 'position' and 'image' properties defined above. Both of those map to respective
+    # properties with matching names.
+    #
+    # Properties by default are assumed to be numeric properties so the types does not have to be stated.
+    # This is the case for 'angle' and 'turn_amount' properties.
+    #
+    # You may use any particular name for your properties as long as you specify the type. This is the case
+    # for the 'motto' property.
+    #
+    def self.property(name,options={},&block)
 
       # Use the name as the property type if one has not been provided.
 
@@ -42,6 +101,18 @@ module Metro
 
       property_class = Property.property(property_type)
 
+      define_method name do
+        raw_value = properties[name]
+        property_class.new(self,options,&block).get raw_value
+      end
+
+      define_method "#{name}=" do |value|
+        prepared_value = property_class.new(self,options).set(value)
+        properties[name] = prepared_value
+      end
+
+      # Define any sub-properties defined on this property
+
       # When the name does not match the property type then we want to force
       # the prefixing to be on for our sub-properties. This is to make sure
       # that when people define multiple fonts and colors that they do not
@@ -49,72 +120,60 @@ module Metro
 
       override_prefix = !(name == property_type)
 
-      # Define any properties defined on this property
-
       property_class.defined_properties.each do |subproperty|
         sub_options = { prefix: override_prefix }.merge(subproperty.options)
         sub_options = sub_options.merge(parents: (Array(sub_options[:parents]) + [name]))
-
-        property subproperty.name, sub_options
+        _sub_property subproperty.name, sub_options
       end
 
-      # To ensure that our sub-properties are aware of the of their
-      # parent property for which they are dependent on we will need
-      # to know this information because we need to behave appropriately
-      # within the getter and setter blocks below.
-
-      is_a_dependency = true if options[:parents]
-
-      if is_a_dependency
+    end
 
-        parents = Array(options[:parents])
+    #
+    # Defines the sub-properties defined within the property. This is to be used internally
+    # by the #property method.
+    #
+    def self._sub_property(name,options={},&block)
 
-        method_name = name
+      # Use the name as the property type if one has not been provided.
 
-        if options[:prefix]
-          method_name = (parents + [name]).join("_")
-        end
+      property_type = options[:type] || name
 
-        # Define a getter for the sub-property that will traverse the
-        # parent properties, finally returning the filtered value
+      property_class = Property.property(property_type)
 
-        define_method method_name do
-          raw_value = (parents + [name]).inject(self) {|current,method| current.send(method) }
-          property_class.new(self,options).get raw_value
-        end
+      parents = Array(options[:parents])
 
-        # Define a setter for the sub-property that will find the parent
-        # value and set itself on that with the filtered value. The parent
-        # is then set.
-        #
-        # @TODO: If getters return dups and not instances of the original object then a very
-        #   deep setter will not be valid.
-        #
-        define_method "#{method_name}=" do |value|
-          parent_value = parents.inject(self) {|current,method| current.send(method) }
+      method_name = name
 
-          prepared_value = property_class.new(self,options).set(value)
-          parent_value.send("#{name}=",prepared_value)
+      if options[:prefix]
+        method_name = (parents + [name]).join("_")
+      end
 
-          send("#{parents.last}=",parent_value)
-        end
+      # Define a getter for the sub-property that will traverse the
+      # parent properties, finally returning the filtered value
 
-      else
+      define_method method_name do
+        raw_value = (parents + [name]).inject(self) {|current,method| current.send(method) }
+        property_class.new(self,options).get raw_value
+      end
 
-        define_method name do
-          raw_value = properties[name]
-          property_class.new(self,options).get raw_value
-        end
+      # Define a setter for the sub-property that will find the parent
+      # value and set itself on that with the filtered value. The parent
+      # is then set.
+      #
+      # @TODO: If getters return dups and not instances of the original object then a very
+      #   deep setter will not be valid.
+      #
+      define_method "#{method_name}=" do |value|
+        parent_value = parents.inject(self) {|current,method| current.send(method) }
 
-        define_method "#{name}=" do |value|
-          prepared_value = property_class.new(self,options).set(value)
-          properties[name] = prepared_value
-        end
+        prepared_value = property_class.new(self,options,&block).set(value)
+        parent_value.send("#{name}=",prepared_value)
 
+        send("#{parents.last}=",parent_value)
       end
-
     end
 
+
     def properties
       @properties ||= {}
     end
@@ -122,14 +181,6 @@ module Metro
     property :model, type: :text
     property :name, type: :text
 
-    #
-    # This is called after every {#update} and when the OS wants the window to
-    # repaint itself.
-    #
-    # @note This method should be implemented in the Model subclass.
-    #
-    def draw ; end
-
     #
     # The window that this model that this window is currently being
     # displayed.
@@ -153,14 +204,6 @@ module Metro
 
     include KeyValueCoding
 
-    #
-    # This is an entry point for customization. As the model's {#initialize}
-    # method performs may perform some initialization that may be necessary.
-    #
-    # @note This method should be implemented in the Model subclass.
-    #
-    def after_initialize ; end
-
     #
     # Generate a custom notification event with the given name.
     #
@@ -253,19 +296,12 @@ module Metro
     #
     # Captures all classes that subclass Model.
     #
-    # @see #self.scenes
+    # @see #self.models_hash
     #
-    def self.inherited(base)
-      models << base.to_s
-    end
-
-    #
-    # All subclasses of Model, this should be all the defined model within the game.
-    #
-    # @return an Array of Scene subclasses
-    #
-    def self.models
-      @models ||= []
+    def self.inherited(model)
+      models_hash[model.to_s] = model.to_s
+      models_hash[model.to_s.downcase] = model.to_s
+      models_hash[model.to_s.underscore] = model.to_s
     end
 
     #
@@ -273,20 +309,11 @@ module Metro
     #
     # @return the Model class given the specified model name.
     def self.model(name)
-      @models_hash ||= begin
-
-        hash = HashWithIndifferentAccess.new("Metro::Models::Generic")
-
-        models.each do |model|
-          hash[model.to_s] = model
-          hash[model.downcase] = model
-          hash[model.to_s.underscore] = model
-        end
-
-        hash
-      end
+      models_hash[name]
+    end
 
-      @models_hash[name]
+    def self.models_hash
+      @models_hash ||= HashWithIndifferentAccess.new("Metro::Models::Generic")
     end
 
   end
@@ -298,3 +325,4 @@ require_relative 'models/menu'
 require_relative 'models/image'
 require_relative 'models/rectangle'
 require_relative 'models/grid_drawer'
+require_relative 'models/song'