metro 0.1.1 → 0.1.2

data/bin/metro

@@ -7,5 +7,10 @@ end
 $:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
 
 require 'metro'
+require 'commands/thor'
 
-Metro.run(*ARGV)
+if Metro::Thor.tasks.keys.include? ARGV.first
+  Metro::Thor.start
+else
+  Metro.run(*ARGV)
+end

data/changelog.md

@@ -1,5 +1,9 @@
 # Metro
 
+## 0.1.2 / 2012-10-26
+
+* Generators for games, scenes, models, and views
+
 ## 0.1.1 / 2012-10-25
 
 * FIX: Requiring the sender gem

data/lib/commands/generate_game.rb

@@ -0,0 +1,13 @@
+module Metro
+
+  class GenerateGame < Generator
+
+    argument :name
+
+    def create_metro_file
+      directory "game", name
+    end
+
+  end
+
+end

data/lib/commands/generate_model.rb

@@ -0,0 +1,25 @@
+module Metro
+
+  class GenerateModel < Generator
+
+    no_tasks do
+
+      def model_filename
+        name.snake_case
+      end
+
+      def model_name
+        name.camel_case
+      end
+
+    end
+
+    argument :name
+
+    def create_model_file
+      template "model.rb.erb", "models/#{model_filename}.rb"
+    end
+
+  end
+
+end

data/lib/commands/generate_scene.rb

@@ -0,0 +1,26 @@
+module Metro
+
+  class GenerateScene < Generator
+
+    no_tasks do
+
+      def scene_filename
+        scene_name = name.gsub(/_?Scene$/i,'')
+        "#{scene_name.snake_case}_scene"
+      end
+
+      def scene_class_name
+        scene_name = name.gsub(/_?Scene$/i,'')
+        "#{scene_name.camel_case}Scene"
+      end
+
+    end
+
+    argument :name
+
+    def create_scene_file
+      template "scene.rb.erb", "scenes/#{scene_filename}.rb"
+    end
+  end
+
+end

data/lib/commands/generate_view.rb

@@ -0,0 +1,21 @@
+module Metro
+
+  class GenerateView < Generator
+
+    no_tasks do
+
+      def view_filename
+        view_name = name.to_s.gsub(/_?Scene$/i,'')
+        view_name.snake_case
+      end
+
+    end
+
+    argument :name
+
+    def create_view_file
+      template "view.yaml.erb", "views/#{view_filename}.yaml"
+    end
+  end
+
+end

data/lib/commands/thor.rb

@@ -0,0 +1,77 @@
+require 'thor'
+require 'thor/group'
+
+module Metro
+
+  class Generator < ::Thor::Group
+    include Thor::Actions
+
+    def self.source_root
+      File.join File.dirname(__FILE__), "..", "templates"
+    end
+  end
+
+  class UnknownGenerator
+
+    def self.start(commands)
+      raise "There is no command: [ #{commands.join(', ')} ]"
+    end
+
+  end
+
+
+  class Thor < Thor
+
+    no_tasks do
+
+      def banner
+        """
+********************************************************************************
+  ______  ___      _____
+  ___   |/  /_____ __  /_______________
+  __  /|_/ / _  _ \\_  __/__  ___/_  __ \\
+  _  /  / /  /  __// /_  _  /    / /_/ /
+  /_/  /_/   \\___/ \\__/  /_/     \\____/
+
+-------------------------------------------------------------------------------"""
+      end
+
+      def generators
+        Hash.new(UnknownGenerator).merge model: Metro::GenerateModel,
+          scene: Metro::GenerateScene,
+          view:  Metro::GenerateView
+      end
+
+      def generator(name)
+        generators[name.to_sym]
+      end
+
+    end
+
+    desc "new [GAMENAME]",
+      "Create a new game within the directory using with the [GAMENAME] given."
+    def new(game_name)
+      Metro::GenerateGame.start [ game_name ]
+    end
+
+    desc "generate",
+      "Create a new game model, view, or scene"
+    def generate(type,name)
+      gen = generator(type)
+      gen.start [ name ]
+    end
+
+    desc "help", "This commoand"
+    def help(topic)
+      say banner
+      print_table self.class.printable_tasks, indent: 4
+    end
+
+  end
+end
+
+
+require_relative 'generate_game'
+require_relative 'generate_model'
+require_relative 'generate_scene'
+require_relative 'generate_view'

data/lib/core_ext/string.rb

@@ -0,0 +1,15 @@
+class String
+
+  def snake_case
+    snaked_string = self.gsub(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+    snaked_string.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    snaked_string.downcase
+  end
+
+  def camel_case
+    camel_string = self.to_s.gsub(/Scene$/i,'')
+    camel_string = camel_string.sub(/^[a-z\d]*/) { $&.capitalize }
+    camel_string = camel_string.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
+  end
+
+end

data/lib/metro.rb

@@ -2,6 +2,7 @@ require 'gosu'
 require 'gosu_ext/color'
 require 'sender'
 
+require 'core_ext/string'
 require 'logger'
 require 'erb'
 

data/lib/metro/models/image.rb

@@ -9,13 +9,14 @@ module Metro
     # 
     class Image < Model
 
-      attr_accessor :angle, :center_x, :center_y, :x_factor, :y_factor
+      attr_accessor :angle, :center_x, :center_y, :x_factor, :y_factor, :z_order
 
       def after_initialize
         @angle = 0
         @center_x = @center_y = 0.5
         @x_factor = @y_factor = 1
         @z_order = 0
+        @color = Gosu::Color.new "rgba(255,255,255,1.0)"
       end
 
       def image

data/lib/metro/version.rb

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

data/lib/templates/game/README.md.tt

@@ -0,0 +1,10 @@
+# <%= name %>
+
+## Details
+
+Additional information or backstory about the game that you
+are creating. This file's intention is to allow a user to 
+refer to this for more information related to the game or 
+possibly any notes or caveats about the game.
+
+## Contact

data/lib/templates/game/metro.tt

@@ -0,0 +1,51 @@
+#
+# This is the main game file which contains information
+# about your game. T
+#
+# Remember, this is really a ruby file, so anything
+# that can be done with Ruby can be written here.
+# 
+# "With great power comes great responsibility" ~ Uncle Ben
+
+#
+# This is the name of your game...
+name "<%= name %>"
+
+#
+# The author of the game. This method can be executed
+# twice if more people are working on this game.
+#
+author "John Carmack"
+
+#
+# The website where the person playing this game
+# could learn more about this game, other games, the
+# authors, or perhaps ask for help or support.
+#
+website "www.idsoftware.com"
+
+#
+# The contact email address where a person that is
+# playing the game might want to contact to thank
+# or reach out for help.
+#
+contact "person@personemail.com"
+
+#
+# This sets the resolution for the game
+#
+resolution 640, 480
+
+#
+# The scene that will be shown first when the game
+# starts.
+#
+first_scene :brand
+
+#
+# Enable debug mode for the game. Which could
+# allow different logic. When this is set the
+# Metro::Game.debug? method will return a true
+# value.
+#
+# debug true

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

@@ -0,0 +1,13 @@
+class BrandScene < Metro::Scene
+
+  draws :brand
+
+  event :on_up, Gosu::KbEscape, Gosu::KbSpace, Gosu::GpButton0 do
+
+    animate actor: brand, to: { alpha: 0 }, interval: 60 do
+      transition_to :brand_to_title
+    end
+
+  end
+
+end

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

@@ -0,0 +1,13 @@
+class BrandToTitleScene < Metro::Scene
+
+  draws :title
+
+  animate actor: :title, to: { alpha: 255 }, interval: 120 do
+    transition_to :title
+  end
+
+  event :on_up, Gosu::KbEscape do
+    transition_to :title
+  end
+
+end

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

@@ -0,0 +1,15 @@
+class TitleScene < Metro::Scene
+
+  draw :title
+
+  draw :menu, options: [ 'Start Game', 'Exit' ]
+
+  event :on_up, Gosu::KbEscape do
+    exit
+  end
+
+  def start_game
+    transition_to :first
+  end
+
+end

data/lib/templates/game/views/brand.yaml

@@ -0,0 +1,5 @@
+brand:
+  model: metro::models::image
+  path: brand.jpg
+  x: 320
+  y: 240

data/lib/templates/game/views/brand_to_title.yaml

@@ -0,0 +1,9 @@
+title:
+  model: metro::models::label
+  text: "#{Metro::Game.name}"
+  x: 120
+  y: 40
+  x-factor: 2
+  y-factor: 2
+  color: rgba(255,255,255,0.0)
+  

data/lib/templates/game/views/title.yaml

@@ -0,0 +1,14 @@
+title:
+  model: metro::models::label
+  text: "#{Metro::Game.name}"
+  x: 120
+  y: 40
+  x-factor: 2
+  y-factor: 2
+  color: rgba(255,255,255,1.0)
+menu:
+  model: metro::models::menu
+  x: 260
+  y: 200
+  color: rgb(127,127,127)
+  highlight-color: rgb(255,255,255)

data/lib/templates/model.rb.erb

@@ -0,0 +1,59 @@
+class <%= model_name %> < Metro::Model
+
+  #
+  # Example Event Handling Definitions
+  #
+  # @example Registering the keyboard down event to execute a block of code
+  #
+  # event :on_down, Gosu::GpLeft, Gosu::GpUp, do
+  #   turn_left
+  # end
+  #
+  # @example Registering the keyboard up key to execute the method `jump`
+  #
+  # event :on_up, Gosu::KbEscape, do: :jump
+  #
+  # @example Registering for button held events that would build the model's acceleration
+  #
+  # event :on_hold, Gosu::KbRight, Gosu::GpRight do
+  #   acceleration += 1
+  # end
+  #
+  # Keystroke and Game Event Reference
+  #
+  # @see https://github.com/jlnr/gosu/blob/master/Gosu/ButtonsMac.hpp
+  # @see https://github.com/jlnr/gosu/blob/master/Gosu/ButtonsX.hpp
+  # @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.
+  #
+  # event :notification, :game_over do
+  #   puts "Game is Over!"
+  # end
+  #
+  # Within the models you could use the method `notification`
+  # to generate the notification
+  #
+  # def update_score
+  #   score = score + 1
+  #   if score >= winning_score
+  #     notification :game_over
+  #   end
+  #
+
+  #
+  # As model does a lot of work for you with regarding to setting up content, it is
+  # best not to override #initialize and instead define an #after_initialize method
+  # within the subclasses of Scene.
+  #
+  def after_initialize ; end
+
+  #
+  # This is called after every {#update} and when the OS wants the window to
+  # repaint itself.
+  #
+  def draw ; end
+
+end

data/lib/templates/scene.rb.erb

@@ -0,0 +1,117 @@
+class <%= scene_class_name %> < Metro::Scene
+  # By default the Scene Name is based on the class name
+  # but that can be overriden with the scene_name class method
+  # scene_name "credits"
+
+  #
+  # DRAWING and ACTORS
+  #
+  # @example Explicitly drawing a text label in the scene
+  #
+  # draw :title, 'text' => 'Title Screen',
+  #   'x' => 20, 'y' => 20, 'z-order' => 0,
+  #   'x-factor' => 3, 'y-factor' => 3,
+  #   'color' => 0xffffffff,
+  #   'model' => 'metro::models::label'
+  #
+  # The draw method can be simplier for models that have content defined
+  # for them in the view or the models themselves define the appropriate
+  # fields.
+  #
+  # @example defining multiple things to draw; their visual data would be
+  #   stored within the respective view file
+  #
+  # draws :menu, :hero, :enemy
+  #
+
+  #
+  # ANIMATIONS
+  #
+  # @example of the title being moved to a new y position and the alpha level
+  #
+  # animate actor: :title, to: { y: 80, alpha: 50 }, interval: 120 do
+  #   puts "Done Animating!"
+  # end
+  #
+
+  #
+  # Example Event Handling Definitions
+  #
+  # @example Registering the keyboard down event to execute a block of code
+  #
+  # event :on_down, Gosu::GpLeft, Gosu::GpUp, do
+  #   transition_to :next_scene
+  # end
+  #
+  # @example Registering the keyboard up key to execute the method `leave_scene`
+  #
+  # event :on_up, Gosu::KbEscape, do: :leave_scene
+  #
+  # @example Registering for button held events that would move an actor named `player`
+  #
+  # event :on_hold, Gosu::KbRight, Gosu::GpRight do
+  #   title.alpha = title.alpha - 1
+  # end
+  # Keystroke and Game Event Reference
+  #
+  # @see https://github.com/jlnr/gosu/blob/master/Gosu/ButtonsMac.hpp
+  # @see https://github.com/jlnr/gosu/blob/master/Gosu/ButtonsX.hpp
+  # @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.
+  #
+  # event :notification, :save_complete do
+  #   puts "Save Complete!"
+  # end
+  #
+  # Within the scene or in the models you could use the method `notification`
+  # to generate the notification
+  #
+  # def update
+  #   if game_save.complete?
+  #     notification :save_complete
+  #   end
+  # end
+  #
+
+  #
+  # As Scene does a lot of work for you with regarding to setting up content, it is
+  # best not to override #initialize and instead define an #after_initialize method
+  # within the subclasses of Scene.
+  #
+  def after_initialize ; end
+
+  #
+  # This method is called right after the scene has been adopted by the window
+  #
+  def show ; end
+
+  #
+  # This is called every update interval while the window is being shown.
+  #
+  def update ; end
+
+  #
+  # This is called after every {#update} and when the OS wants the window to
+  # repaint itself.
+  #
+  def draw ; end
+
+  #
+  # Before a scene is transisitioned away from to a new scene, this method is called
+  # to allow for the scene to complete any taskss, stop any actions, or pass any
+  # information from the existing scene to the scene that is about to replace it.
+  #
+  def prepare_transition_to(new_scene) ; end
+
+  #
+  # Before a scene is transisitioned to it is called with the previous scene. This
+  # allows for the new scene to rerieve any data from the previous scene to assist
+  # with the layout of the current scene.
+  #
+  def prepare_transition_from(old_scene) ; end
+
+
+end

data/lib/templates/view.yaml.erb

@@ -0,0 +1,32 @@
+title:
+  model: metro::models::label
+  text: STARRY KNIGHT
+  x: 30
+  y: 50
+  z-order: 4
+  x-factor: 3
+  y-factor: 3
+  color: "rgba(255,255,0,0.0)"
+logo:
+  model: metro::models::image
+  x: 540
+  y: 380
+  z-order: 4
+  path: "player.png"
+  color: "rgba(255,255,255,0.0)"
+star: &star_default
+  model: star
+  x: 100
+  y: 400
+  path: "star.png"
+  width: 25
+  height: 25
+  tileable: false
+star2:
+  <<: *star_default
+  x: 455
+  y: 333
+star3:
+  <<: *star_default
+  x: 515
+  y: 40

data/metro.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = Metro::WEBSITE
 
   gem.add_dependency 'gosu', '~> 0.7'
+  gem.add_dependency 'thor', '~> 0.16.0'
   gem.add_dependency 'sender', '~> 1.5.10'
   gem.add_development_dependency 'rspec', '~> 2.11'
 

data/spec/core_ext/string_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe String do
+
+  describe "#snake_case" do
+    context "when given a regular string" do
+      subject { "String" }
+      let(:expected_value) { "string" }
+
+      its(:snake_case) { should eq expected_value }
+    end
+
+    context "when given an already snake cased string" do
+      subject { "snake_cased" }
+      let(:expected_value) { "snake_cased" }
+
+      its(:snake_case) { should eq expected_value }
+    end
+
+    context "when given a camelCased string" do
+      subject { "SnakeCased" }
+      let(:expected_value) { "snake_cased" }
+
+      its(:snake_case) { should eq expected_value }
+    end
+
+    context "when given a partial camel_Cased string" do
+      subject { "snake_Cased" }
+      let(:expected_value) { "snake_cased" }
+      its(:snake_case) { should eq expected_value }
+    end
+  end
+
+  describe "#camel_case" do
+    context "when given a regular string" do
+      subject { "string" }
+      let(:expected_value) { "String" }
+      its(:camel_case) { should eq expected_value }
+    end
+
+    context "when given a snake_cased string" do
+      subject { "camel_cased" }
+      let(:expected_value) { "CamelCased" }
+      its(:camel_case) { should eq expected_value }
+    end
+
+    context "when given a partial camel_CasedString" do
+      subject { "camel_CasedString" }
+      let(:expected_value) { "CamelCasedstring" }
+      its(:camel_case) { should eq expected_value }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metro
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2012-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: sender
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +94,12 @@ files:
 - Rakefile
 - bin/metro
 - changelog.md
+- lib/commands/generate_game.rb
+- lib/commands/generate_model.rb
+- lib/commands/generate_scene.rb
+- lib/commands/generate_view.rb
+- lib/commands/thor.rb
+- lib/core_ext/string.rb
 - lib/gosu_ext/color.rb
 - lib/metro.rb
 - lib/metro/animation/animation.rb
@@ -109,8 +131,21 @@ files:
 - lib/metro/template_message.rb
 - lib/metro/version.rb
 - lib/metro/window.rb
+- lib/templates/game/README.md.tt
+- lib/templates/game/assets/brand.jpg
+- lib/templates/game/metro.tt
+- lib/templates/game/scenes/brand_scene.rb
+- lib/templates/game/scenes/brand_to_title_scene.rb
+- lib/templates/game/scenes/title_scene.rb
+- lib/templates/game/views/brand.yaml
+- lib/templates/game/views/brand_to_title.yaml
+- lib/templates/game/views/title.yaml
 - lib/templates/message.erb
+- lib/templates/model.rb.erb
+- lib/templates/scene.rb.erb
+- lib/templates/view.yaml.erb
 - metro.gemspec
+- spec/core_ext/string_spec.rb
 - spec/gosu_ext/color_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/burtlo/metro
@@ -118,8 +153,8 @@ licenses: []
 post_install_message: ! "    ______  ___      _____\n    ___   |/  /_____ __  /_______________\n
   \   __  /|_/ / _  _ \\_  __/__  ___/_  __ \\\n    _  /  / /  /  __// /_  _  /    /
   /_/ /\n    /_/  /_/   \\___/  \\__/ /_/     \\____/\n\n  Thank you for installing
-  metro 0.1.1 / 2012-10-25.\n  ---------------------------------------------------------------------\n
-  \ Changes:\n    \n  * FIX: Requiring the sender gem\n  \n\n  ---------------------------------------------------------------------\n"
+  metro 0.1.2 / 2012-10-26.\n  ---------------------------------------------------------------------\n
+  \ Changes:\n    \n  * Generators for games, scenes, models, and views\n  \n\n  ---------------------------------------------------------------------\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -144,6 +179,7 @@ summary: Metro is a 2D Gaming framework built around gosu (game development libr
   Metro makes it easy to create games by enforcing common conceptual structures and
   conventions.
 test_files:
+- spec/core_ext/string_spec.rb
 - spec/gosu_ext/color_spec.rb
 - spec/spec_helper.rb
 has_rdoc: