metro 0.0.1 → 0.0.2

data/lib/metro/scene_view/drawers/composite_drawer.rb

@@ -0,0 +1,81 @@
+require_relative 'artists_block'
+require_relative 'label'
+require_relative 'select'
+require_relative 'image'
+
+module Metro
+  module SceneView
+
+    #
+    # The CompositeDrawer is a special drawer that looks at all the created drawers
+    # that have been defined and then determines which one should be used when drawing
+    # for a particular view type.
+    #
+    # This Drawer is used in the SceneView to handle the multitude of view objects
+    # that are thrown at it.
+    #
+    # @see SceneView
+    #
+    class CompositeDrawer < Drawer
+
+      #
+      # Render all the view elements defined that are supported by this drawer.
+      #
+      def draw(view)
+        view.each do |name,content|
+          type = content['type']
+          drawers[type].draw(content.merge 'name' => name)
+        end
+      end
+
+      #
+      # Given all the registered drawers map the things that they can draw
+      # to the particular drawer.
+      #
+      # @return a Hash which maps the types of things that can be drawn to
+      #   the specific drawer.
+      #
+      def drawers
+        @drawers ||= begin
+
+          # By default fall back to having artist's block when you do not know
+          # how to draw a particular view component.
+
+          hash = Hash.new(ArtistsBlock)
+
+          Drawer.drawers.each do |drawer|
+            drawer.draws_types.each do |type|
+
+              if not hash.key?(type) or (hash.key?(type) and override_on_conflict?(drawer,type))
+                hash[type] = drawer.new(scene)
+              end
+
+            end
+          end
+
+          hash
+        end
+      end
+
+      #
+      # @return true if the drawer should override the existing drawer, false if the drawer
+      #   should leave the existing drawer in it's place.
+      #
+      def override_on_conflict?(drawer,type)
+        if drawer.draw_options[:override]
+          true
+        else
+          log.warn override_warning_message(drawer,type)
+          false
+        end
+      end
+
+      def override_warning_message(drawer,type)
+        [ "Drawer Attempting to Override Existing Drawer For '#{type}'",
+          "#{drawer} will NOT be drawing '#{type}' as it is being handled by another Drawer.",
+          "To override this in the #{drawer.class} class specify the parameter \"draws '#{type}', overrides: true\"" ].join("\n")
+      end
+
+    end
+  end
+end

data/lib/metro/scene_view/drawers/drawer.rb

@@ -0,0 +1,115 @@
+module Metro
+  module SceneView
+
+    #
+    # A Drawer subclass does all the artistic work defined in the view granted by
+    # the {SceneView}. A Drawer at it's core defines a subclass which species
+    # the things that it can draw and then the draw method which it will draw
+    # those things.
+    #
+    # @example Creating a drawer to handle lines
+    #
+    #     class Line < Metro::SceneView::Drawer
+    #       draws :lines
+    #
+    #       def draw(view)
+    #         # Code would draw a line from:
+    #         #    view['x1'],view['y1'] to view['x2'],view['y2']
+    #         # with a thickness of view['thickness']
+    #       end
+    #     end
+    #
+    class Drawer
+
+      #
+      # Allows a Drawer to specify what 'type' components it is able to draw. The
+      # 'type' is defined within the view objects.
+      #
+      #     class LabelDrawer < Metro::SceneView::Drawer
+      #       draws 'labels', 'shiny-labels', 'pulsing-labels'
+      #     end
+      #
+      # @param [String,Array<String>] args a list of 'types' that this drawer is capable
+      #   of drawing.
+      #
+      def self.draws(*args)
+        @draws_types = args.flatten.compact.reject {|arg| arg.is_a? Hash }
+        @draws_options = args.flatten.compact.find {|arg| arg.is_a? Hash }
+      end
+
+      #
+      # This method is called right after initialization. Allowing for additional
+      # configuration.
+      #
+      # @note This method should be implemented in the Drawer subclass.
+      #
+      def after_initialize ; end
+
+      #
+      # This method is called on the Drawer so that it renders content.
+      #
+      # @note This method should be implemented in the Drawer subclass.
+      #
+      # @param [Hash] view the hash content of the view.
+      #
+      def draw(view) ; end
+
+      #
+      # @return the instance of window that is often necessary to create Gosu
+      #   components for rendering.
+      #
+      attr_reader :window
+
+      #
+      # @return the scene that is being drawn. This is required if the view content
+      #   requires live information from the scene or if the drawing is effected
+      #   by the state of the scene.
+      #
+      attr_reader :scene
+
+      #
+      # Captures all classes that subclass Drawer.
+      #
+      def self.inherited(base)
+        drawers << base
+      end
+
+      #
+      # All subclasses of Drawer, this should be all the defined scenes within the game.
+      #
+      # @return an Array of Drawer subclasses
+      #
+      def self.drawers
+        @drawers ||= []
+      end
+
+      #
+      # @return an array of all the types of components that this Drawer
+      #   is able to handle drawing.
+      #
+      def self.draws_types
+        Array(@draws_types)
+      end
+      
+      def self.draw_options
+        @draws_options || {}
+      end
+
+      #
+      # This initialize sets up the drawer. If a subclass Drawer needs to perform
+      # some customization, it is prefered to call {#after_initialize}.
+      #
+      # @see #after_initialize
+      #
+      # @param [Scene] scene the scene that this Drawer is going to be drawing. A
+      #   window is retrieved from the scene.
+      #
+      def initialize(scene)
+        @scene = scene
+        @window = scene.window
+        after_initialize
+      end
+
+    end
+  end
+end

data/lib/metro/scene_view/drawers/image.rb

@@ -0,0 +1,30 @@
+module Metro
+  module SceneView
+
+    class Image < Drawer
+      draws 'image'
+
+      attr_reader :images
+
+      def after_initialize
+        @images = {}
+
+        content_images = scene.view.find_all { |name,content| self.class.draws_types.include?(content['type']) }
+
+        content_images.each do |name,content|
+          @images[name] = create_image(content)
+        end
+      end
+
+      def create_image(content)
+        Gosu::Image.new(window,asset_path(content['path']))
+      end
+
+      def draw(view)
+        images[view['name']].draw(view['x'],view['y'],1)
+      end
+
+    end
+
+  end
+end

data/lib/metro/scene_view/{components → drawers}/label.rb

@@ -1,6 +1,11 @@
 module Metro
   module SceneView
+
+    #
+    # Draws a string of text.
+    #
     class Label < Drawer
+      draws 'label'
 
       def font
         @font ||= Gosu::Font.new(window, Gosu::default_font_name, 20)

data/lib/metro/scene_view/{components → drawers}/select.rb

@@ -1,6 +1,16 @@
 module Metro
   module SceneView
+
+    #
+    # Draws a a menu of options. It is called a Select as it is named after the HTML
+    # element select. A select drawer also inserts itself into the scene as an event
+    # target as it needs to maintain the state of the menu. When an option is selected
+    # an event is fired based on the name of the option.
+    #
+    # @note Only one 'select' can be defined for a given scene.
+    # 
     class Select < Drawer
+      draws 'select'
 
       attr_accessor :selected_index, :options
 
@@ -34,8 +44,6 @@ module Metro
         @selected_index = @selected_index + 1
         @selected_index = 0 if @selected_index >= options.length
       end
-      
-      def _no_action ; end
 
       def font
         @font ||= Gosu::Font.new(window, Gosu::default_font_name, 20)

data/lib/metro/scene_view/json_view.rb

@@ -3,15 +3,35 @@ require 'json'
 module Metro
   module SceneView
 
+    #
+    # Provides support for a JSON Representation of a view.
+    #
     class JSONView
-      def self.find(view_name)
+
+      #
+      # Determine if a view exists for this specified format
+      #
+      # @param [String] view_name the name of the view to find
+      # @return a true if the json view exists and false if it does not exist.
+      #
+      def self.exists?(view_name)
         File.exists? json_view_name(view_name)
       end
 
+      #
+      # Parse the contents of the view given the name.
+      #
+      # @param [String] view_name the name of the view to read
+      # @return a Hash that contains the contents of the view.
+      #
       def self.parse(view_name)
         JSON.parse File.read json_view_name(view_name)
       end
 
+      #
+      # A helper method to generate the name of the json view file. In this case
+      # it is the view name with the suffix .json.
+      #
       def self.json_view_name(view_name)
         File.extname(view_name) == "" ? "#{view_name}.json" : view_name
       end

data/lib/metro/scene_view/no_view.rb

@@ -2,10 +2,21 @@ module Metro
   module SceneView
 
     class NoView
-      def self.find(view_name)
+
+      #
+      # A NoView is a last resort view which means this is will always will exist.
+      #
+      # @param [String] view_name the name of the view to find
+      # @return a true if the json view exists and false if it does not exist.
+      #
+      def self.exists?(view_name)
         true
       end
 
+      #
+      # A NoView will return an empty Hash to provide compatibility with other view
+      # types.
+      #
       def self.parse(view_name)
         {}
       end

data/lib/metro/scene_view/scene_view.rb

@@ -2,11 +2,29 @@ require_relative 'yaml_view'
 require_relative 'json_view'
 require_relative 'no_view'
 
+require_relative 'drawers/drawer'
+require_relative 'drawers/composite_drawer'
+
 module Metro
+
+  #
+  # SceneView provides support for a Scene to have a view as well as giving
+  # additional tools to also help draw that view.
+  #
   module SceneView
 
+    #
+    # When the module is included insure that all the class helper methods are added
+    # at the same time. As well as re-defining the {Scene#base_draw} method to allow
+    # for the use of the view_drawer.
+    #
     def self.included(base)
       base.extend ClassMethods
+
+      base.send :define_method, :base_draw do
+        view_drawer.draw(view)
+        draw
+      end
     end
 
     #
@@ -17,15 +35,25 @@ module Metro
     end
 
     #
-    # Loads the view based on the view parsers.
+    # Loads and caches the view content based on the avilable view parsers and
+    # the view files defined.
+    #
+    # @return a Hash of view content.
     #
     def view
       @view ||= begin
-        parser = _view_parsers.find { |parser| parser.find self.class.view_name }
+        parser = _view_parsers.find { |parser| parser.exists? self.class.view_name }
         parser.parse self.class.view_name
       end
     end
 
+    #
+    # @return an instance of a SceneView::Drawer that is capable of drawing
+    #   the Scene.
+    def view_drawer
+      @view_drawer ||= SceneView::CompositeDrawer.new(self)
+    end
+
     module ClassMethods
 
       #
@@ -35,14 +63,16 @@ module Metro
       # @example Custom View Name
       #
       #     class ClosingScene < Metro::Scene
-      #       view_name :alternate
+      #       view_name 'alternative'
       #     end
+      # 
+      #     ClosingScene.view_name # => views/alternative
       #
       def view_name(filename = nil)
         if filename
           @view_name = File.join "views", filename.to_s
         else
-          @view_name ||= File.join "views", "#{self.to_s[/^(.+)Scene$/,1].downcase}"
+          @view_name ||= File.join "views", scene_name
         end
       end
 

data/lib/metro/scene_view/yaml_view.rb

@@ -4,14 +4,31 @@ module Metro
   module SceneView
 
     class YAMLView
-      def self.find(view_name)
+
+      #
+      # Determine if a view exists for this specified format
+      #
+      # @param [String] view_name the name of the view to find
+      # @return a true if the yaml view exists and false if it does not exist.
+      #
+      def self.exists?(view_name)
         File.exists? yaml_view_name(view_name)
       end
 
+      #
+      # Parse the contents of the view given the name.
+      #
+      # @param [String] view_name the name of the view to read
+      # @return a Hash that contains the contents of the view.
+      #
       def self.parse(view_name)
         YAML.load File.read yaml_view_name(view_name)
       end
 
+      #
+      # A helper method to generate the name of the yaml view file. In this case
+      # it is the view name with the suffix .yaml.
+      #
       def self.yaml_view_name(view_name)
         File.extname(view_name) == "" ? "#{view_name}.yaml" : view_name
       end

data/lib/metro/scenes.rb

@@ -1,23 +1,65 @@
 module Metro
+
+  #
+  # @example Finding a scene based on the scene name
+  #
+  #     class IntroScene < Metro::Scene
+  #       # ... scene content ...
+  #     end
+  #
+  #     Scenes.find("intro")    # => IntroScene
+  #     Scenes.find(:intro)     # => IntroScene
+  #     Scenes.find(IntroScene) # => IntroScene
+  #
+  # @example Creating a scene instance based on the scene name
+  #
+  #     class IntroScene < Metro::Scene
+  #       # ... scene content ...
+  #     end
+  #
+  #     Scenes.generate("intro")    # => [SCENE: title]
+  #     Scenes.generate(:intro)     # => [SCENE: title]
+  #     Scenes.generate(IntroScene) # => [SCENE: title]
+  #
   module Scenes
     extend self
 
-    def scenes
-      @scenes ||= Scene.scenes.inject({}) do |dict,scene|
-        name = scene.to_s.gsub(/Scene$/,'').downcase.to_sym
+    #
+    # Finds the scene based on the specified scene name.
+    #
+    # @param [String,Symbol] scene_name the name of the scene to locate.
+    # @return the Scene class that is found matching the specified scene name.
+    #
+    def find(scene_name)
+      scenes_hash[scene_name]
+    end
+
+    #
+    # Finds the scene with the specified name and then creates an instance of that
+    # scene.
+    #
+    # @param [String,Symbol] scene_name the name of the scene to locate.
+    # @return an instance of Scene that is found matching the specified scene name
+    #
+    def generate(scene_name)
+      find(scene_name).new
+    end
+
+    private
+
+    #
+    # @return a Hash that allows for accessing  symbol names of the scenes
+    #   as well as the class name constants to allow for the scenes to be found.
+    #
+    def scenes_hash
+      @scenes_hash ||= Scene.scenes.inject({}) do |dict,scene|
+        name = scene.scene_name
         dict[name] = scene
+        dict[name.to_sym] = scene
         dict[scene] = scene
         dict
       end
     end
 
-    def find(scene_name)
-      scenes[scene_name.to_sym]
-    end
-    
-    def create(scene_name,window)
-      find(scene_name).new(window)
-    end
-
   end
 end

data/lib/metro/version.rb

@@ -1,3 +1,3 @@
 module Metro
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/metro/window.rb

@@ -4,33 +4,60 @@ module Metro
 
   #
   # A subclass of the Gosu::Window which simply acts as system
-  # to shuffle in and out scenes and transfer events.
+  # to shuffle in and out scenes and relay event information.
   #
   class Window < Gosu::Window
 
-    attr_reader :scene
+    #
+    # The scene of the window.
+    #
+    # @see Scene
+    #
+    attr_accessor :scene
 
-    def initialize(width,height,something)
-      super width, height, something
+    #
+    # @param [Fixnum] width the width of the game window
+    # @param [Fixnum] height the height of the game window
+    # @param [TrueClass,FalseClass] fullscreen the boolean flag to enable or
+    #   disable fullscreen
+    #
+    def initialize(width,height,fullscreen)
+      super width, height, fullscreen
     end
 
-    def scene=(new_scene)
-      @scene = new_scene
+    def scene=(scene)
+      scene.window = self
+      @scene = scene
     end
 
+    #
+    # This is called every update interval while the window is being shown.
+    #
     def update
-      scene.trigger_held_buttons
+      scene.fire_events_for_held_buttons
       scene.update
     end
 
+    #
+    # This is called after every {#update} and when the OS wants the window to
+    # repaint itself.
+    #
     def draw
-      scene._draw
+      scene.base_draw
     end
 
+    #
+    # Called before {#update} when the user releases a button while the window
+    # has focus.
+    #
     def button_up(id)
       scene.button_up(id)
     end
 
+    #
+    # Called before {#update} when the user presses a button while the window
+    # has focus.
+    #
     def button_down(id)
       scene.button_down(id)
     end

data/lib/metro.rb

@@ -23,16 +23,34 @@ end
 module Metro
   extend self
 
-  def run(filename="metro")
+  #
+  # @return [String] the default filename that contains the game contents
+  #
+  def default_game_filename
+    'metro'
+  end
+
+  #
+  # Run will load the contents of the game contents and game files
+  # within the current working directory and start the game. By default
+  # calling run with no parameter will look for a game file
+  #
+  # @param [String] filename the name of the game file to run. When not specified
+  #   the value uses the default filename.
+  #
+  def run(filename=default_game_filename)
     load_game_files
     load_game_configuration(filename)
     start_game
   end
 
+  private
+
   def load_game_files
     $LOAD_PATH.unshift(Dir.pwd) unless $LOAD_PATH.include?(Dir.pwd)
     Dir['models/*.rb'].each {|model| require model }
     Dir['scenes/*.rb'].each {|scene| require scene }
+    Dir['drawers/*.rb'].each {|drawer| require drawer }
   end
 
   def load_game_configuration(filename)
@@ -43,8 +61,8 @@ module Metro
   end
 
   def start_game
-    window = Window.new Game.width, Game.height, false
-    window.scene = Game.first_scene.new(window)
+    window = Window.new Game.width, Game.height, Game.fullscreen?
+    window.scene = Scenes.generate(Game.first_scene)
     window.show
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metro
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-18 00:00:00.000000000 Z
+date: 2012-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -47,10 +47,12 @@ files:
 - lib/metro/game/dsl.rb
 - lib/metro/model.rb
 - lib/metro/scene.rb
-- lib/metro/scene_view/components/drawer.rb
-- lib/metro/scene_view/components/label.rb
-- lib/metro/scene_view/components/select.rb
-- lib/metro/scene_view/components/unsupported_component.rb
+- lib/metro/scene_view/drawers/artists_block.rb
+- lib/metro/scene_view/drawers/composite_drawer.rb
+- lib/metro/scene_view/drawers/drawer.rb
+- lib/metro/scene_view/drawers/image.rb
+- lib/metro/scene_view/drawers/label.rb
+- lib/metro/scene_view/drawers/select.rb
 - lib/metro/scene_view/json_view.rb
 - lib/metro/scene_view/no_view.rb
 - lib/metro/scene_view/scene_view.rb