metro 0.1.6 → 0.2.0

data/changelog.md

@@ -1,5 +1,16 @@
 # Metro
 
+## 0.2.0 / 2012-11-07
+
+* Views now use position instead of `x`, `y`, and `z-order`
+* Point, Scale, and Dimensions is available in model and scenes.
+* 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.6 / 2012-11-07
 
 * Events are shared from superclasses to subclases.

data/lib/gosu_ext/image.rb

@@ -1,5 +1,38 @@
-class Gosu::Image
+module Metro
 
-  attr_accessor :path, :tileable
+  #
+  # 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
 
+    #
+    # Generate an image given the Gosu window and path. Consider using a model and an image
+    # property instead of using this method.
+    #
+    # @note this goes through the image property because that current performs the caching.
+    #
+    # @example Creating an Image
+    #
+    #     Metro::Image.create path: "relative_imagepath.png", window: window
+    #
+    # @see Metro::Model::ImageProperty
+    #
+    def self.create(params = {})
+      Model::ImageProperty.image_for params
+    end
+
+    def initialize(gosu_image,path,tileable)
+      super(gosu_image)
+      @path = path
+      @tileable = tileable
+    end
+
+    # The relative path of the image
+    attr_reader :path
+
+    # The tileability of the image
+    attr_reader :tileable
+
+  end
 end

data/lib/metro/game.rb

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

data/lib/metro/models/model.rb

@@ -14,6 +14,7 @@ module Metro
   # @see Models::Generic
   #
   class Model
+    include Units
 
     #
     # This is called every update interval while the actor is in the scene
@@ -208,40 +209,13 @@ module Metro
     # with the contents of the view.
     #
     def _load(options = {})
-      options = {} unless options
 
-      options.each do |raw_key,value|
-        key = raw_key.to_s.dup
-        key = key.gsub(/-/,'_').underscore
-
-
-        unless respond_to? 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}="
-          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
+      # Clean up and symbolize all the keys then merge  that with the existing properties
+      options.keys.each do |key|
+        options[key.to_s.underscore.to_sym] = options.delete(key)
       end
 
-    end
-
-    def _loaded_options
-      @_loaded_options ||= []
+      properties.merge! options
     end
 
     #
@@ -252,29 +226,14 @@ module Metro
     # to another model.
     #
     def _save
-      data_export = _loaded_options.map {|option| [ option, send(option) ] }.flatten
-      Hash[*data_export]
+      properties
     end
 
     #
-    # Generate a hash representation of the model. Currently this is ugly
+    # Generate a hash representation of the model.
     #
     def to_hash
-      export = _loaded_options.map {|option| [ option, send(option) ] }
-      export_with_name = export.reject {|item| item.first == "name" }
-
-      hash = export_with_name.inject({}) {|hash,elem| hash[elem.first] = elem.last ; hash }
-
-      # TODO:: color is a class that cannot be yamlized as it is and needs to be turned into a string.
-      # TODO: Hack to save the Gosu::Color class as a string value (this is
-      # what I hoped that the properties would solve)
-      hash.each do |subkey,subvalue|
-        if subvalue.is_a? Gosu::Color
-          hash[subkey] = subvalue.to_s
-        end
-      end
-
-      { name => hash }
+      { name => properties.except(:name) }
     end
 
     #

data/lib/metro/models/model_factory.rb

@@ -1,7 +1,7 @@
 module Metro
   class ModelFactory
 
-    attr_reader :name, :options
+    attr_reader :name
 
     def initialize(name,options)
       @name = name.to_s.downcase
@@ -16,7 +16,11 @@ module Metro
     end
 
     def load_from_previous_scene?
-      options[:from] == :previous_scene
+      @options[:from] == :previous_scene
+    end
+    
+    def options
+      @options.except(:from)
     end
 
     def model_name

data/lib/metro/models/models/grid_drawer.rb

@@ -34,14 +34,14 @@ module Metro
       end
 
       def draw_vertical_lines
-        xs = (width / spacing + 1).times.map {|segment| segment * spacing }
+        xs = (width / spacing + 1).to_i.times.map {|segment| segment * spacing }
         xs.each do |x|
           window.draw_line(x, 1, color, x, height, color, 0, :additive)
         end
       end
 
       def draw_horizontal_lines
-        ys = (height / spacing + 1).times.map {|segment| segment * spacing }
+        ys = (height / spacing + 1).to_i.times.map {|segment| segment * spacing }
         ys.each do |y|
           window.draw_line(1, y, color, width, y, color, 0, :additive)
         end

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

@@ -19,6 +19,11 @@ 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)"
 
+      # This is a temporary method as there is no options propery yet defined
+      def options
+        properties[:options]
+      end
+
       def alpha
         self.unselected_color_alpha
       end

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

@@ -1,5 +1,3 @@
-require_relative '../../animation/animation'
-
 module Metro
   class Model
 
@@ -25,10 +23,10 @@ module Metro
     #       end
     #     end
     #
-    # @example Defining an animation default.
+    # @example Defining an animation with a path.
     #
     #     class Hero < Metro::Model
-    #       property :animation, default: { path: "star.png",
+    #       property :animation, path: "star.png", dimensions: Dimensions.of(25,25)
     #         dimensions: Metro::Dimensions.of(25,25) }
     #
     #       def draw
@@ -39,8 +37,8 @@ module Metro
     # @example Using an animation property with a different property name
     #
     #     class Hero < Metro::Model
-    #       property :walking, type: :animation, default: { path: "star.png",
-    #         dimensions: Metro::Dimensions.of(25,25) }
+    #       property :walking, type: :animation, path: "star.png", 
+    #         dimensions: Metro::Dimensions.of(25,25)
     #
     #       def draw
     #         walking.image.draw text, x, y, z_order, x_factor, y_factor, color
@@ -85,19 +83,11 @@ module Metro
       end
 
       def default_image_path
-        if options[:default] and options[:default][:path]
-          asset_path(options[:default][:path])
-        else
-          metro_asset_path("missing_animation.png")
-        end
+        options[:path] ? options[:path] : metro_asset_path("missing_animation.png")
       end
 
       def default_dimensions
-        if options[:default] and options[:default][:dimensions]
-          options[:default][:dimensions]
-        else
-          Dimensions.of 16.0, 16.0
-        end
+        options[:dimensions] ? options[:dimensions] : Dimensions.of(16.0,16.0)
       end
 
       #
@@ -120,7 +110,7 @@ module Metro
 
         animation_images = images[path]
         unless animation_images
-          animation_images = create_image(window,absolute_path,width,height,tileable)
+          animation_images = create_images(window,absolute_path,width,height,tileable)
           images[path] = animation_images
         end
 
@@ -133,7 +123,7 @@ module Metro
 
       private
 
-      def self.create_image(window,path,width,height,tileable)
+      def self.create_images(window,path,width,height,tileable)
         Gosu::Image.load_tiles(window,path,width,height,tileable)
       end
 

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

@@ -23,16 +23,16 @@ module Metro
     #
     #     end
     #
-    # @example Defining an image property providing a default
+    # @example Defining an image property providing a path
     #
     #     class Player < Metro::Model
-    #       property :image, default: "player.png"
+    #       property :image, path: "player.png"
     #     end
     #
     # @example Using an image property with a different property name
     #
     #     class Player < Metro::Model
-    #       property :disconnected_image, type: :image, default: "disconnected_player.png"
+    #       property :disconnected_image, type: :image, path: "disconnected_player.png"
     #
     #       def draw
     #         disconnected_image.draw x, y, z_order, x_factor, y_factor, color, :add)
@@ -41,10 +41,18 @@ module Metro
     #
     class ImageProperty < Property
 
+      get do
+        default_image
+      end
+
       # Return the image at the specified path.
       # @note The path should be the relative path within the game.
       get String do |path|
-        self.class.image_for_path path: path, window: model.window
+        self.class.image_for path: path, window: model.window
+      end
+
+      set do
+        default_image.path
       end
 
       # Set the image with the specified path.
@@ -59,6 +67,15 @@ module Metro
         image.path
       end
 
+      def default_image
+        self.class.image_for path: default_image_path, window: model.window
+      end
+
+      def default_image_path
+        options[:path] || metro_asset_path("missing.png")
+      end
+
+
       #
       # Return an image for the specified path. On first request it will be loaded from
       # the file-system. On subsequent requests it will be pulled from the cache.
@@ -66,18 +83,22 @@ module Metro
       # @param [Hash] options the relative `path` to the image and the window for which it
       #   will be displayed.
       #
-      def self.image_for_path(options)
+      def self.image_for(options)
         options.symbolize_keys!
-        path = options[:path]
+
+        absolute_path = path = options[:path]
+        absolute_path = asset_path(absolute_path) unless absolute_path.start_with? "/"
+
+        tileable = !!options[:tileable]
         window = options[:window]
 
-        image = images[path]
-        unless image
-          image = create_image(window,path,false)
-          images[path] = image
+        gosu_image = images[path]
+        unless gosu_image
+          gosu_image = create_image(window,absolute_path,tileable)
+          images[path] = gosu_image
         end
 
-        image
+        Image.new gosu_image, path, tileable
       end
 
       def self.images
@@ -86,13 +107,8 @@ module Metro
 
       private
 
-      # @TODO The Gosu::Image creation should automatically perform this operation of saving the path
-      #   to the image. This should be monkey-patched onto the image so that images created outside
-      #   of this process will also have a specified path.
       def self.create_image(window,path,tileable)
-        image = Gosu::Image.new(window,asset_path(path),tileable)
-        image.path = path
-        image
+        Gosu::Image.new(window,path,tileable)
       end
 
     end

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

@@ -2,6 +2,8 @@ module Metro
   class Model
 
     class Property
+      include Units
+      
       attr_reader :model, :options
 
       def initialize(model,options={})

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

@@ -22,7 +22,7 @@ module Metro
     # @example Defining with a default and text that will be instance evaluated.
     #
     #     class ScoreBoard < Metro::Model
-    #       property :font, default: 'Score is #{player.score}'
+    #       property :text, default: 'Score is #{player.score}'
     #     end
     #
     # @example Using a text property with a different property name
@@ -31,7 +31,7 @@ module Metro
     #       property :description, type: :text
     #
     #       def draw
-    #         description_font.draw text, x, y, z_order, x_factor, y_factor, color
+    #         description_font.draw description, x, y, z_order, x_factor, y_factor, color
     #       end
     #     end
     #
@@ -57,7 +57,7 @@ module Metro
       end
 
       def default_text
-        options[:default] || 'Text for #{model} not specified!'
+        options[:default] || 'TEXT NOT SPECIFIED!'
       end
 
     end

data/lib/metro/scene.rb

@@ -27,6 +27,7 @@ module Metro
   # so that every subclass does not have to constantly call `super`.
   #
   class Scene
+    include Units
 
     #
     # As Scene does a lot of work for you with regarding to setting up content, it is

data/lib/metro/units/dimensions.rb

@@ -0,0 +1,23 @@
+module Metro
+  module Units
+    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
+end

data/lib/metro/units/point.rb

@@ -0,0 +1,25 @@
+module Metro
+  module Units
+    class Point < Struct.new(:x,:y,:z)
+      def self.zero
+        new 0.0, 0.0, 0.0
+      end
+
+      def self.at(x,y,z=0.0)
+        new x.to_f, y.to_f, z.to_f
+      end
+
+      def self.parse(string)
+        at *string.split(",",3).map(&:to_f)
+      end
+
+      alias_method :z_order, :z
+      alias_method :z_order=, :z=
+
+      def to_s
+        "#{x},#{y},#{z}"
+      end
+
+    end
+  end
+end

data/lib/metro/units/scale.rb

@@ -0,0 +1,23 @@
+module Metro
+  module Units
+    class Scale < Struct.new(:x_factor,:y_factor)
+
+      def self.one
+        new 1.0, 1.0
+      end
+
+      def self.to(x,y)
+        new x.to_f, y.to_f
+      end
+
+      def self.parse(string)
+        to *string.split(",",2).map(&:to_f)
+      end
+
+      def to_s
+        "#{x_factor},#{y_factor}"
+      end
+
+    end
+  end
+end

data/lib/metro/units/units.rb

@@ -0,0 +1,3 @@
+require_relative 'point'
+require_relative 'dimensions'
+require_relative 'scale'

data/lib/metro/version.rb

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

data/lib/metro.rb

@@ -1,7 +1,8 @@
+require 'delegate'
+require 'logger'
+require 'erb'
+
 require 'gosu'
-require 'gosu_ext/color'
-require 'gosu_ext/image'
-require 'gosu_ext/gosu_constants'
 require 'i18n'
 require 'active_support'
 require 'active_support/dependencies'
@@ -9,15 +10,16 @@ require 'active_support/inflector'
 require 'active_support/core_ext/hash'
 require 'active_support/hash_with_indifferent_access'
 
+require 'gosu_ext/color'
+require 'gosu_ext/image'
+require 'gosu_ext/animation'
+require 'gosu_ext/gosu_constants'
 require 'core_ext/numeric'
-require 'logger'
-require 'erb'
 
 require 'locale/locale'
+
 require 'metro/asset_path'
-require 'metro/models/point'
-require 'metro/models/scale'
-require 'metro/models/dimensions'
+require 'metro/units/units'
 require 'metro/logging'
 require 'metro/version'
 require 'metro/template_message'

data/lib/templates/game/scenes/game_scene.rb

@@ -12,8 +12,19 @@ class GameScene < Metro::Scene
   event :on_up, KbR do |event|
     if event.control?
       Metro.reload!
-      transition_to self.class.scene_name
+      transition_to scene_name
     end
   end
 
+  #
+  # @example Setting up the ability for all subclassed scenes
+  #   to be edited with the 'Ctrl+E' event
+  #
+  event :on_up, KbR do |event|
+    if event.control?
+      transition_to scene_name, with: edit
+    end
+  end
+
+
 end

data/lib/templates/model.rb.tt

@@ -1,21 +1,59 @@
 class <%= model_name %> < GameModel
 
   #
-  # Example Event Handling Definitions
+  # Properties
   #
-  # @example Registering the keyboard down event to execute a block of code
+  # Models commonly have properties that you want to be able to get, set, and save.
+  # Usually within ruby you would write attr_accessor methods and initialize them.
+  # Metro provides some shorthand class helper methods that allow you to quickly
+  # define these properties with the added benefit that they will be persisted when
+  # the model is saved within the view and the type will be maintained.
   #
-  # event :on_down, Gosu::GpLeft, Gosu::GpUp, do
+  # # @example of adding a `position` property to your model
+  # # Property defines a `position` accessor as well as `x`, `y`, and `z` (or `z_order`)
+  # # accessors.
+  # property :position
+  #
+  # # @example of adding an `image` property to your model
+  # # An image property can be set up with an image path or that can be set later
+  # # through the `image` accessor that is added.
+  #
+  # property :image, path: "player.png"
+  #
+  # # @example of adding an `numeric` property to your model
+  # # A lot of times you want to track some numeric value like score. Here we
+  # # create a `score` accessor and assign a default value.
+  # property :score, type: numeric, default: 0
+  #
+  # # @example of adding an `text` property to your model
+  # # A lot of times you want to track some numeric value like score. Here we
+  # # create a `text` accessor and assign a default value.
+  # property :description, type: text, default: 'Greetings Earthling!'
+  #
+  # For more information see the other defined properties.
+  #
+  # @see Metro::Model::AnimationProperty
+  # @see Metro::Model::ImageProperty
+  # @see Metro::Model::NumericProperty
+  # @see Metro::Model::ScaleProperty
+  # @see Metro::Model::TextProperty
+  # @see Metro::Model::PositionProperty
+  # @see Metro::Model::FontProperty
+  #
+
+  #
+  # Events
+  #
+  # # @example Registering the keyboard down event to execute a block of code
+  # event :on_down, GpLeft, GpUp, do
   #   turn_left
   # end
   #
-  # @example Registering the keyboard up key to execute the method `jump`
-  #
+  # # @example Registering the keyboard up key to execute the method `jump`
   # event :on_up, KbEscape, do: :jump
   #
-  # @example Registering for button held events that would build the model's acceleration
-  #
-  # event :on_hold, KbRight, Gosu::GpRight do
+  # # @example Registering for button held events that would build the model's acceleration
+  # event :on_hold, KbRight, GpRight do
   #   acceleration += 1
   # end
   #
@@ -26,8 +64,8 @@ class <%= model_name %> < GameModel
   # @see https://github.com/jlnr/gosu/blob/master/Gosu/ButtonsWin.hpp
   #
   #
-  # @example Registering for an event called 'save_complete' event that anyone
-  #   can generate and this scene block will execute this code.
+  # # @example Registering for an event called 'save_complete' event that anyone
+  # #   can generate and this scene block will execute this code.
   #
   # event :notification, :game_over do
   #   puts "Game is Over!"
@@ -37,10 +75,11 @@ class <%= model_name %> < GameModel
   # to generate the notification
   #
   # def update_score
-  #   score = score + 1
+  #   @score = score + 1
   #   if score >= winning_score
   #     notification :game_over
   #   end
+  # end
   #
 
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metro
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -110,6 +110,7 @@ files:
 - Rakefile
 - bin/metro
 - changelog.md
+- lib/assets/missing.png
 - lib/assets/missing_animation.png
 - lib/commands/generate_game.rb
 - lib/commands/generate_model.rb
@@ -117,6 +118,7 @@ files:
 - lib/commands/generate_view.rb
 - lib/commands/thor.rb
 - lib/core_ext/numeric.rb
+- lib/gosu_ext/animation.rb
 - lib/gosu_ext/color.rb
 - lib/gosu_ext/gosu_constants.rb
 - lib/gosu_ext/image.rb
@@ -124,7 +126,6 @@ files:
 - lib/locale/locale.rb
 - lib/metro.rb
 - lib/metro/animation/after_interval_factory.rb
-- lib/metro/animation/animation.rb
 - lib/metro/animation/animation_factory.rb
 - lib/metro/animation/easing.rb
 - lib/metro/animation/has_animations.rb
@@ -145,7 +146,6 @@ files:
 - lib/metro/game/dsl.rb
 - lib/metro/logging.rb
 - lib/metro/missing_scene.rb
-- lib/metro/models/dimensions.rb
 - lib/metro/models/draws.rb
 - lib/metro/models/key_value_coding.rb
 - lib/metro/models/model.rb
@@ -156,7 +156,6 @@ files:
 - lib/metro/models/models/label.rb
 - lib/metro/models/models/menu.rb
 - lib/metro/models/models/rectangle.rb
-- lib/metro/models/point.rb
 - lib/metro/models/properties/angle.rb
 - lib/metro/models/properties/animation.rb
 - lib/metro/models/properties/color.rb
@@ -170,7 +169,6 @@ files:
 - lib/metro/models/properties/text.rb
 - lib/metro/models/properties/velocity.rb
 - lib/metro/models/rectangle_bounds.rb
-- lib/metro/models/scale.rb
 - lib/metro/scene.rb
 - lib/metro/scenes.rb
 - lib/metro/template_message.rb
@@ -178,6 +176,10 @@ files:
 - lib/metro/transitions/fade_transition_scene.rb
 - lib/metro/transitions/scene_transitions.rb
 - lib/metro/transitions/transition_scene.rb
+- lib/metro/units/dimensions.rb
+- lib/metro/units/point.rb
+- lib/metro/units/scale.rb
+- lib/metro/units/units.rb
 - lib/metro/version.rb
 - lib/metro/views/json_view.rb
 - lib/metro/views/no_view.rb
@@ -223,12 +225,13 @@ licenses: []
 post_install_message: ! "    ______  ___      _____\n    ___   |/  /_____ __  /_______________\n
   \   __  /|_/ / _  _ \\_  __/__  ___/_  __ \\\n    _  /  / /  /  __// /_  _  /    /
   /_/ /\n    /_/  /_/   \\___/  \\__/ /_/     \\____/\n\n  Thank you for installing
-  metro 0.1.6 / 2012-11-07.\n  ---------------------------------------------------------------------\n
-  \ Changes:\n    \n  * Events are shared from superclasses to subclases.\n  * Templates
-  updated to use GameScene and GameModel for each game.\n  * Models are automatically
-  added to the update loop\n  * Model properties now make it easier to store/retrieve
-  various\n    common numeric, position font, image, and animation properties.\n  \n\n
-  \ ---------------------------------------------------------------------\n"
+  metro 0.2.0 / 2012-11-07.\n  ---------------------------------------------------------------------\n
+  \ Changes:\n    \n  * Views now use position instead of `x`, `y`, and `z-order`\n
+  \ * Point, Scale, and Dimensions is available in model and scenes.\n  * Events are
+  shared from superclasses to subclases.\n  * Templates updated to use GameScene and
+  GameModel for each game.\n  * Models are automatically added to the update loop\n
+  \ * Model properties now make it easier to store/retrieve various\n    common numeric,
+  position font, image, and animation properties.\n  \n  \n\n  ---------------------------------------------------------------------\n"
 rdoc_options: []
 require_paths:
 - lib

data/lib/metro/models/dimensions.rb

@@ -1,21 +0,0 @@
-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/point.rb

@@ -1,23 +0,0 @@
-module Metro
-  class Point < Struct.new(:x,:y,:z)
-    def self.zero
-      new 0.0, 0.0, 0.0
-    end
-
-    def self.at(x,y,z=0.0)
-      new x.to_f, y.to_f, z.to_f
-    end
-
-    def self.parse(string)
-      at *string.split(",",3).map(&:to_f)
-    end
-
-    alias_method :z_order, :z
-    alias_method :z_order=, :z=
-
-    def to_s
-      "#{x},#{y},#{z}"
-    end
-
-  end
-end

data/lib/metro/models/scale.rb

@@ -1,21 +0,0 @@
-module Metro
-  class Scale < Struct.new(:x_factor,:y_factor)
-
-    def self.one
-      new 1.0, 1.0
-    end
-
-    def self.to(x,y)
-      new x.to_f, y.to_f
-    end
-
-    def self.parse(string)
-      to *string.split(",",2).map(&:to_f)
-    end
-
-    def to_s
-      "#{x_factor},#{y_factor}"
-    end
-
-  end
-end