metro-ld26 0.3.4

data/lib/templates/scene.rb.tt

@@ -0,0 +1,140 @@
+class <%= scene_class_name %> < GameScene
+  # By default the Scene Name is based on the class name
+  # but that can be overridden with the scene_name class method
+  # scene_name "credits"
+
+  draw :title
+
+  #
+  # DRAWING and ACTORS
+  #
+  # @example Explicitly drawing a text label in the scene
+  #
+  # draw :title, model: 'metro::ui::label',
+  #   text: 'Title Screen',
+  #   position: '20,20,0',
+  #   font: { size: 60 },
+  #   color: 'rgba(255,255,255,1.0)',
+  #   align: 'center',
+  #   vertical_align: 'center'
+  #
+  #
+  # The draw method can be simpler 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 :title, :hero, :enemy
+  #
+
+  #
+  # ANIMATIONS
+  #
+  # @example of the title being moved to a new y position and the alpha level
+  #
+  # animate :title, to: { y: 80, alpha: 50 }, interval: 120.ticks do
+  #   puts "Done Animating!"
+  # end
+  #
+  # @example of using nested animations and after blocks to generate a fade in
+  #   and fade out effect.
+  #
+  # after 2.seconds do
+  #   animate :title, to: { alpha: 255 }, interval: 1.second do
+  #     after 1.second do
+  #       animate :title, to: { alpha: 0 }, interval: 1.second
+  #     end
+  #   end
+  # end
+  #
+  # @note the interval can be specified in game ticks ( 1.tick, 23.ticks ) or
+  #   in seconds ( 1.second, 23.seconds ). 60 game times are roughly equivalent
+  #   to 1 second, however you should not use Metro for monitoring a nuclear
+  #   reactor.
+  #
+
+  #
+  # Example Event Handling Definitions
+  #
+  # @example Registering the keyboard down event to execute a block of code
+  #
+  # event :on_down, GpLeft, GpUp, do
+  #   transition_to :next_scene
+  # end
+  #
+  # @example Registering the keyboard up key to execute the method `leave_scene`
+  #
+  # event :on_up, KbEscape, do: :leave_scene
+  #
+  # @example Registering for button held events that would move an actor named `player`
+  #
+  # event :on_hold, KbRight, 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 player.x > 600 and player.y > 440
+  #     notification :player_wins
+  #   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.
+  # This is a great place to make changes to the scene before the update methods
+  # or draw methods have ever been called.
+  #
+  def show ; end
+
+  #
+  # This is called every update interval while the scene is being shown in the
+  # window.
+  #
+  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 transitioned away from to a new scene, this method is called
+  # to allow for the scene to complete any tasks, 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 transitioned to it is called with the previous scene. This
+  # allows for the new scene to retrieve 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.tt

@@ -0,0 +1,11 @@
+# http://www.yaml.org/YAML_for_ruby.html
+---
+title:
+  model: "metro::ui::label"
+  text: "Your Scene"
+  align: center
+  vertical_align: center
+  position: "190,200,4"
+  font:
+    size: 60
+  color: "rgba(255,255,0,1.0)"

data/lib/tmx_ext/object.rb

@@ -0,0 +1,26 @@
+module Tmx
+
+  class Object
+
+    # TODO: the mass and moment of interia should configurable through properties
+    def body
+      @body ||= CP::Body.new default_mass, default_moment_of_inertia
+    end
+
+    def shape
+      @shape ||= Tmx::ObjectShape.create_from_tmx_object(self)
+    end
+
+
+    def default_mass
+      Float::INFINITY
+    end
+
+    def default_moment_of_inertia
+      Float::INFINITY
+    end
+
+
+  end
+
+end

data/lib/tmx_ext/tile_set.rb

@@ -0,0 +1,41 @@
+module Tmx
+
+  #
+  # Define additional functionaly or override existing functionaliy on
+  # the Tmx class to make it compatible with Metro.
+  #
+  class TileSet
+    attr_accessor :window
+
+    def images
+      @images ||= raw_image_tiles.map {|image| crop_image(image) }
+    end
+
+    private
+
+    def raw_image_tiles
+      Gosu::Image.load_tiles(window, image_path, full_image_width, full_image_height, false)
+    end
+
+    def crop_image(image)
+      Metro::Image.crop window, image, crop_bounds
+    end
+
+    def full_image_width
+      tilewidth + spacing
+    end
+
+    def full_image_height
+      tileheight + spacing
+    end
+
+    def crop_bounds
+      @crop_bounds ||= Metro::Units::RectangleBounds.new left: margin, top: margin,
+                        right: full_image_width, bottom: full_image_height
+    end
+
+    def image_path
+      Metro::AssetPath.with(image).filepath
+    end
+  end
+end

data/metro.gemspec

@@ -0,0 +1,57 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metro/version'
+
+Struct.new("Changes",:date,:changes)
+
+Gem::Specification.new do |gem|
+  gem.name          = "metro-ld26"
+  gem.version       = Metro::VERSION
+  gem.authors       = ["Franklin Webber"]
+  gem.email         = Metro::CONTACT_EMAILS
+  gem.license       = "MIT"
+  gem.summary       = <<-EOS
+    Metro is a 2D Gaming framework built around gosu (game development library).
+    Metro makes it easy to create games by enforcing common conceptual structures
+    and conventions.
+  EOS
+  gem.description   = <<-EOS
+    Metro is a 2D Gaming framework built around gosu (game development library).
+    Metro makes it easy to create games by enforcing common conceptual structures
+    and conventions.
+  EOS
+
+  gem.homepage      = Metro::WEBSITE
+
+  gem.add_dependency 'gosu', '~> 0.7'
+  gem.add_dependency 'texplay', '~> 0.4'
+  gem.add_dependency 'tmx', '~> 0.1.2'
+  gem.add_dependency 'thor', '~> 0.16.0'
+  gem.add_dependency 'i18n', '~> 0.6.1'
+  gem.add_dependency 'active_support', '~> 3.0.0'
+  gem.add_dependency 'listen', '~> 0.6.0'
+  gem.add_development_dependency 'rspec', '~> 2.11'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  changes = Metro.changes_for_version(::Metro::VERSION)
+
+  gem.post_install_message = <<-EOM
+    ______  ___      _____
+    ___   |/  /_____ __  /_______________
+    __  /|_/ / _  _ \\_  __/__  ___/_  __ \\
+    _  /  / /  /  __// /_  _  /    / /_/ /
+    /_/  /_/   \\___/  \\__/ /_/     \\____/
+
+  Thank you for installing metro #{::Metro::VERSION} / #{changes.date}.
+  ---------------------------------------------------------------------
+  Changes:
+  #{changes.changes.map{|change| "  #{change}"}.join("")}
+  ---------------------------------------------------------------------
+EOM
+
+end

data/spec/core_ext/numeric_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Numeric do
+
+  before :each do
+    Numeric.tick_interval = 16.666666
+  end
+
+  describe "#tick(s)" do
+    context "when using an Integer" do
+      subject { 60 }
+      let(:expected_value) { 60 }
+
+      its(:tick) { should eq expected_value }
+      its(:ticks) { should eq expected_value }
+    end
+
+    context "when using a Float" do
+      subject { 70.1 }
+      let(:expected_value) { 70.1 }
+
+      its(:tick) { should eq expected_value }
+      its(:ticks) { should eq expected_value }
+    end
+  end
+
+  describe "#second(s)" do
+
+    context "when using an Integer" do
+      context "when the tick interval has not been set" do
+        subject { 2 }
+        let(:expected_value) { 120 }
+
+        its(:second) { should eq expected_value }
+        its(:seconds) { should eq expected_value }
+        its(:sec) { should eq expected_value }
+        its(:secs) { should eq expected_value }
+      end
+
+      context "when the tick interval has been set to 33.3333" do
+        before :each do
+          Numeric.tick_interval = 33.333333
+        end
+
+        subject { 2 }
+        let(:expected_value) { 60 }
+
+        its(:second) { should eq expected_value }
+        its(:seconds) { should eq expected_value }
+      end
+    end
+
+    context "when using a Float" do
+      context "when the tick interval has not been set" do
+        subject { 2.5 }
+        let(:expected_value) { 150 }
+
+        its(:second) { should eq expected_value }
+        its(:seconds) { should eq expected_value }
+        its(:sec) { should eq expected_value }
+        its(:secs) { should eq expected_value }
+      end
+
+      context "when the tick interval has been set" do
+        before :each do
+          Numeric.tick_interval = 33.333333
+        end
+
+        subject { 3.5 }
+        let(:expected_value) { 105 }
+
+        its(:second) { should eq expected_value }
+        its(:seconds) { should eq expected_value }
+      end
+    end
+  end
+
+end

data/spec/core_ext/string_spec.rb

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

data/spec/gosu_ext/color_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Gosu::Color do
+
+  shared_examples "a correctly defined color" do
+
+    let(:expected_red_value) { expected_color_values[0] }
+    let(:expected_green_value) { expected_color_values[1] }
+    let(:expected_blue_value) { expected_color_values[2] }
+    let(:expected_alpha_value) { expected_color_values[3] }
+
+    it "should have the correct red color" do
+      subject.red.should eq expected_red_value
+    end
+
+    it "should have the correct green color" do
+      subject.green.should eq expected_green_value
+    end
+
+    it "should have the correct blue color" do
+      subject.blue.should eq expected_blue_value
+    end
+
+    it "should have the correct alpha value" do
+      subject.alpha.should eq expected_alpha_value
+    end
+  end
+
+  shared_examples "a color defined as white" do
+    let(:expected_color_values) { [ 255, 255, 255, 255 ] }
+    it_behaves_like "a correctly defined color"
+  end
+
+  describe "#initialize" do
+
+    context "when defined with an existing Gosu Color" do
+      subject { described_class.new color }
+      let(:color) { described_class.new 123, 123, 123, 0 }
+      let(:expected_color_values) { [ 123, 123, 0, 123 ] }
+      it_behaves_like "a correctly defined color"
+    end
+
+    context "when defined with a hexadecimal value" do
+      subject { described_class.new hex }
+      let(:hex) { 0xFF777777 }
+      let(:expected_color_values) { [ 119, 119, 119, 255 ] }
+      it_behaves_like "a correctly defined color"
+    end
+
+    context "when defined with a gosu color hex string" do
+      subject { described_class.new hex }
+      let(:hex) { "0xFF777777" }
+      let(:expected_color_values) { [ 119, 119, 119, 255 ] }
+      it_behaves_like "a correctly defined color"
+    end
+
+    context "when defined with a hex string" do
+      subject { described_class.new hex }
+      let(:hex) { "#777777" }
+      let(:expected_color_values) { [ 119, 119, 119, 255 ] }
+      it_behaves_like "a correctly defined color"
+    end
+
+    context "when defined with a rgb string" do
+      subject { described_class.new rgb }
+      let(:rgb) { "rgb(127,127,127)" }
+      let(:expected_color_values) { [ 127, 127, 127, 255 ] }
+      it_behaves_like "a correctly defined color"
+    end
+
+    context "when defined with a rgba color" do
+      subject { described_class.new rgba }
+      let(:rgba) { "rgba(127,127,127,0.5)" }
+      let(:expected_color_values) { [ 127, 127, 127, 127 ] }
+      it_behaves_like "a correctly defined color"
+    end
+
+  end
+
+end