metro 0.1.5 → 0.1.6

data/README.md

@@ -53,3 +53,22 @@ $ metro generate scene first
 ```
 
 This should generate a scene in the scenes directory. The scene file contains a lot of examples of how to draw, animate and have your scene listen to events.
+
+
+### Resources
+
+#### Art
+
+* [Lost Garden](http://www.lostgarden.com/2007/05/dancs-miraculously-flexible-game.html)
+
+#### Books
+
+* [Rules of Play](http://www.amazon.com/dp/0262240459)
+* [Game Programming Gems 8](http://www.amazon.com/dp/1584507020)
+* [Game Feel](http://www.amazon.com/dp/0123743281)
+* [Game Coding Complete](http://www.amazon.com/dp/1584506806)
+* [Game Design Workshop](http://www.amazon.com/dp/0240809742)
+* [Challenges For Game Designers](http://www.amazon.com/dp/158450580X)
+* [The Art of Game Design: A book of lenses](http://www.amazon.com/dp/0123694965)
+* [A Theory of Fun](http://www.theoryoffun.com)
+* [Andrew Rollings and Ernest Adams on Game Design](http://www.amazon.com/dp/1592730019)

data/changelog.md

@@ -1,5 +1,13 @@
 # Metro
 
+## 0.1.6 / 2012-11-07
+
+* Events are shared from superclasses to subclases.
+* Templates updated to use GameScene and GameModel for each game.
+* Models are automatically added to the update loop
+* Model properties now make it easier to store/retrieve various
+  common numeric, position font, image, and animation properties.
+
 ## 0.1.5 / 2012-11-01
 
 * Metro.reload! will reload all game classes

data/lib/commands/generate_model.rb

@@ -9,7 +9,7 @@ module Metro
       end
 
       def model_name
-        name.classify
+        name.camelize
       end
 
     end
@@ -17,7 +17,7 @@ module Metro
     argument :name
 
     def create_model_file
-      template "model.rb.erb", "models/#{model_filename}.rb"
+      template "model.rb.tt", "models/#{model_filename}.rb"
     end
 
   end

data/lib/commands/generate_scene.rb

@@ -11,7 +11,12 @@ module Metro
 
       def scene_class_name
         scene_name = name.gsub(/_?Scene$/i,'')
-        "#{scene_name.classify}Scene"
+        "#{scene_name.camelize}Scene"
+      end
+
+      def view_filename
+        view_name = name.to_s.gsub(/_?Scene$/i,'')
+        view_name.underscore
       end
 
     end
@@ -19,8 +24,13 @@ module Metro
     argument :name
 
     def create_scene_file
-      template "scene.rb.erb", "scenes/#{scene_filename}.rb"
+      template "scene.rb.tt", "scenes/#{scene_filename}.rb"
     end
+
+    def create_view_file
+      template "view.yaml.tt", "views/#{view_filename}.yaml"
+    end
+
   end
 
 end

data/lib/commands/generate_view.rb

@@ -14,7 +14,7 @@ module Metro
     argument :name
 
     def create_view_file
-      template "view.yaml.erb", "views/#{view_filename}.yaml"
+      template "view.yaml.tt", "views/#{view_filename}.yaml"
     end
   end
 

data/lib/gosu_ext/color.rb

@@ -26,7 +26,7 @@ class Gosu::Color
   end
 
   def self.parse_rgba(rgba)
-    if rgba =~ /rgba\(([\d]{1,3}),([\d]{1,3}),([\d]{1,3}),(\d(?:\.\d)?)\)/
+    if rgba =~ /rgba\(([\d]{1,3}(?:\.\d*)?),([\d]{1,3}(?:\.\d*)?),([\d]{1,3}(?:\.\d*)?),(\d(?:\.\d*)?)\)/
       [ (255 * $4.to_f).floor.to_i, $1.to_i, $2.to_i, $3.to_i ]
     end
   end

data/lib/gosu_ext/image.rb

@@ -0,0 +1,5 @@
+class Gosu::Image
+
+  attr_accessor :path, :tileable
+
+end

data/lib/metro.rb

@@ -1,10 +1,13 @@
 require 'gosu'
 require 'gosu_ext/color'
+require 'gosu_ext/image'
 require 'gosu_ext/gosu_constants'
 require 'i18n'
 require 'active_support'
 require 'active_support/dependencies'
 require 'active_support/inflector'
+require 'active_support/core_ext/hash'
+require 'active_support/hash_with_indifferent_access'
 
 require 'core_ext/numeric'
 require 'logger'
@@ -12,6 +15,9 @@ require 'erb'
 
 require 'locale/locale'
 require 'metro/asset_path'
+require 'metro/models/point'
+require 'metro/models/scale'
+require 'metro/models/dimensions'
 require 'metro/logging'
 require 'metro/version'
 require 'metro/template_message'
@@ -20,7 +26,6 @@ require 'metro/game'
 require 'metro/scene'
 require 'metro/scenes'
 require 'metro/models/model'
-require 'metro/models/generic'
 
 require_relative 'metro/missing_scene'
 
@@ -41,6 +46,10 @@ module Metro
     'metro'
   end
 
+  def asset_dir
+    File.join File.dirname(__FILE__), "assets"
+  end
+
   #
   # Run will load the contents of the game contents and game files
   # within the current working directory and start the game. By default
@@ -58,6 +67,7 @@ module Metro
   end
 
   def load_game_files!
+    EventDictionary.reset!
     prepare_watcher!
     load_game_files
     execute_watcher!
@@ -104,18 +114,21 @@ module Metro
 
   def load_game_files
     $LOAD_PATH.unshift(Dir.pwd) unless $LOAD_PATH.include?(Dir.pwd)
-    load_paths 'models', 'scenes', 'lib'
+    load_paths 'lib'
+    load_path 'scenes', prioritize: 'game_scene.rb'
+    load_path 'models', prioritize: 'game_model.rb'
   end
 
   def load_paths(*paths)
     paths.flatten.compact.each {|path| load_path path }
   end
 
-  def load_path(path)
-    Dir["#{path}/**/*.rb"].each {|model| require_or_load model }
+  def load_path(path,options = {})
+    files = Dir["#{path}/**/*.rb"]
+    files.sort! {|file| File.basename(file) == options[:prioritize] ? -1 : 1 }
+    files.each {|model| require_or_load model }
   end
 
-
   def load_game_configuration(filename)
     gamefile = File.basename(filename)
     game_files_exist!(gamefile)

data/lib/metro/animation/animation.rb

@@ -0,0 +1,31 @@
+module Metro
+
+  #
+  # The animation is an wrapper object for an array of Gosu::Images that also contains
+  # the additional information on the path, height, width, and tileability.
+  #
+  class Animation
+
+    attr_accessor :images, :path, :height, :width, :tileable
+
+    def initialize(params = {})
+      @images = Array(params[:images])
+      @path = params[:path]
+      @height = params[:height]
+      @width = params[:width]
+      @tileable = params[:tileable]
+    end
+
+    def to_hash
+      { path: path, width: width.to_i, height: height.to_i, tileable: !!tileable }
+    end
+
+    #
+    # @return a Gosu::Image to be displayed in a animation sequence.
+    #
+    def image
+      images[Gosu::milliseconds / 100 % images.size]
+    end
+
+  end
+end

data/lib/metro/asset_path.rb

@@ -20,3 +20,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.
+# 
+def metro_asset_path(name)
+  File.join Metro.asset_dir, name
+end

data/lib/metro/events/event_dictionary.rb

@@ -0,0 +1,53 @@
+require_relative 'event_factory'
+
+module Metro
+
+  module EventDictionary
+    extend self
+
+    #
+    # All defined events within this dictionary.
+    #
+    def events
+      @events ||= Hash.new
+    end
+
+    #
+    # @example Adding a new SceneEvent to the Dictionary
+    #
+    #     SceneEventDictionary.add target: scene_name, type: event_type, args: args, block: block
+    #
+    def add(params = {})
+      target = params[:target]
+      event = EventFactory.new params[:type], params[:args], &params[:block]
+      events[target] = events_for_target(target).push event
+    end
+
+    #
+    # Return all the events for all the specified targets.
+    #
+    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
+
+    #
+    # Return the events for the specified target
+    #
+    def events_for_target(scene_name)
+      events[scene_name] ||= []
+    end
+
+    #
+    # When the game is reset the event dictionary needs to flush out all of the events that it
+    # has loaded as the game files will be reloaded. All metro related components will not
+    # be removed as those files are not reloaded when the game is reloaded.
+    #
+    def reset!
+      events.delete_if { |name,events| ! name.start_with? "metro/" }
+    end
+
+  end
+
+end

data/lib/metro/events/event_factory.rb

@@ -2,11 +2,13 @@ module Metro
 
   class EventFactory
 
-    attr_reader :event, :buttons, :block
+    attr_reader :event, :args, :block
 
-    def initialize(event,buttons = [],&block)
+    alias_method :buttons, :args
+
+    def initialize(event,args=[],&block)
       @event = event
-      @buttons = buttons
+      @args = args
       @block = block
     end
 

data/lib/metro/events/has_events.rb

@@ -1,4 +1,4 @@
-require_relative 'event_factory'
+require_relative 'event_dictionary'
 
 module Metro
 
@@ -90,16 +90,15 @@ module Metro
       # 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
+      def event(event_type,*args,&block)
+        EventDictionary.add target: metro_name, type: event_type, args: args, block: block
       end
 
       #
-      # @return a list of all the EventFactories defined for the scene
+      # @return a list of all the EventFactories defined for this event holding object
       #
       def events
-        @events ||= []
+        EventDictionary.events_for_targets(hierarchy)
       end
 
     end

data/lib/metro/game.rb

@@ -27,7 +27,7 @@ module Metro
     end
 
     def center
-      [ width / 2 , height / 2 ]
+      Point.at width / 2 , height / 2
     end
 
     def fullscreen?

data/lib/metro/models/dimensions.rb

@@ -0,0 +1,21 @@
+module Metro
+  class Dimensions < Struct.new(:width,:height)
+
+    def self.none
+      new 0.0, 0.0
+    end
+
+    def self.of(width,height)
+      new width.to_f, height.to_f
+    end
+
+    def self.parse(string)
+      to *string.split(",",2).map(&:to_f)
+    end
+
+    def to_s
+      "#{width},#{height}"
+    end
+
+  end
+end

data/lib/metro/models/model.rb

@@ -1,5 +1,6 @@
 require_relative 'key_value_coding'
 require_relative 'rectangle_bounds'
+require_relative 'properties/property'
 
 module Metro
 
@@ -14,6 +15,120 @@ module Metro
   #
   class Model
 
+    #
+    # This is called every update interval while the actor is in the scene
+    #
+    # @note This method should be implemented in the Model subclass
+    #
+    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
+    # will be removed.
+    #
+    # @note This method should be implemented in the Model sublclass if you
+    #   are interested in having the model be removed from the scene.
+    #
+    def completed? ; false ; end
+
+
+    def self.property(name,options={})
+
+      # Use the name as the property type if one has not been provided.
+
+      property_type = options[:type] || name
+
+      property_class = Property.property(property_type)
+
+      # 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
+      # overlap.
+
+      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
+      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
+
+        parents = Array(options[:parents])
+
+        method_name = name
+
+        if options[:prefix]
+          method_name = (parents + [name]).join("_")
+        end
+
+        # Define a getter for the sub-property that will traverse the
+        # parent properties, finally returning the filtered value
+
+        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 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) }
+
+          prepared_value = property_class.new(self,options).set(value)
+          parent_value.send("#{name}=",prepared_value)
+
+          send("#{parents.last}=",parent_value)
+        end
+
+      else
+
+        define_method name do
+          raw_value = properties[name]
+          property_class.new(self,options).get raw_value
+        end
+
+        define_method "#{name}=" do |value|
+          prepared_value = property_class.new(self,options).set(value)
+          properties[name] = prepared_value
+        end
+
+      end
+
+    end
+
+    def properties
+      @properties ||= {}
+    end
+
+    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.
@@ -59,46 +174,6 @@ module Metro
     #
     include HasEvents
 
-    #
-    # Returns the color of the model. In most cases where color is a prominent
-    # attribute (e.g. label) this will be the color. In the cases where color
-    # is less promenint (e.g. image) this will likely be a color that can be
-    # used to influence the drawing of it.
-    #
-    # @see #alpha
-    #
-    def color
-      @color
-    end
-
-    #
-    # Sets the color of the model.
-    #
-    # @param [String,Fixnum,Gosu::Color] value the new color to set.
-    #
-    def color=(value)
-      @color = Gosu::Color.new(value)
-    end
-
-    #
-    # @return the alpha value of the model's color. This is an integer value
-    #   between 0 and 255.
-    #
-    def alpha
-      color.alpha
-    end
-
-    #
-    # Sets the alpha of the model.
-    #
-    # @param [String,Fixnum] value the new value of the alpha level for the model.
-    #   This value should be between 0 and 255.
-    #
-    def alpha=(value)
-      # TODO: coerce the value is between 0 and 255
-      color.alpha = value.to_i
-    end
-
     def saveable?
       true
     end
@@ -107,7 +182,7 @@ module Metro
     def contains?(x,y)
       false
     end
-    
+
     # Belongs to positionable items only
     def offset(x,y)
       self.x += x
@@ -121,6 +196,7 @@ module Metro
     # method or done with care to ensure that functionality is preserved.
     #
     def initialize(options = {})
+      _load(options)
       after_initialize
     end
 
@@ -135,22 +211,29 @@ module Metro
       options = {} unless options
 
       options.each do |raw_key,value|
-
         key = raw_key.to_s.dup
         key = key.gsub(/-/,'_').underscore
 
+
         unless respond_to? key
-          self.class.send :define_method, key do
-            instance_variable_get("@#{key}")
+          log.warn "Unknown Property #{key}"
+          self.class.send(:define_method,key) do
+            properties[key]
           end
+          #raise "Do not know (#{key}) property"
         end
 
         unless respond_to? "#{key}="
-          self.class.send :define_method, "#{key}=" do |value|
-            instance_variable_set("@#{key}",value)
+          log.warn "Unknown Property #{key}="
+          self.class.send(:define_method,"#{key}=") do |value|
+            properties[key] = value
           end
+
+          # raise "Do not know (#{key}=) property"
         end
 
+
+
         _loaded_options.push key
         send "#{key}=", value
       end
@@ -194,6 +277,20 @@ module Metro
       { name => hash }
     end
 
+    #
+    # @return a common name that can be used through the system as a common identifier.
+    #
+    def self.metro_name
+      name.underscore
+    end
+
+    #
+    # @return an array of all ancestor models by name
+    #
+    def self.hierarchy
+      ancestors.find_all {|a| a.respond_to? :metro_name }.map(&:metro_name)
+    end
+
     #
     # Captures all classes that subclass Model.
     #
@@ -237,9 +334,9 @@ module Metro
   end
 end
 
-require_relative 'generic'
-require_relative 'label'
-require_relative 'menu'
-require_relative 'image'
-require_relative 'rectangle'
-require_relative 'grid_drawer'
+require_relative 'models/generic'
+require_relative 'models/label'
+require_relative 'models/menu'
+require_relative 'models/image'
+require_relative 'models/rectangle'
+require_relative 'models/grid_drawer'