metro 0.3.3 → 0.3.4

data/lib/metro/units/point.rb

@@ -5,6 +5,7 @@ module Metro
     # Represents and object that contains the x, y, and z position.
     #
     class Point < Struct.new(:x,:y,:z)
+      include CalculationValidations
 
       #
       # Generate a point at 0,0,0.
@@ -18,7 +19,7 @@ module Metro
       # all inputs to floating point and assumes that the z-value is
       # zero (as this is a 2D universe).
       #
-      def self.at(x,y,z=0.0)
+      def self.at(x=0.0,y=0.0,z=0.0)
         new x.to_f, y.to_f, z.to_f
       end
 
@@ -28,7 +29,7 @@ module Metro
       # either "x,y" or "x,y,z".
       #
       def self.parse(string)
-        at *string.split(",",3).map(&:to_f)
+        at *string.to_s.split(",",3).map(&:to_f)
       end
 
       # As this is a 2D world, the Z is often refered to as a the z-ordering
@@ -39,27 +40,10 @@ module Metro
         "#{x},#{y},#{z}"
       end
 
-      #
-      # Add this point to another another point-like structure. A point like structure
-      # is anything has the methods x, y, and z.
-      #
-      # @return a new point which is the sum of the point and the provided value.
-      #
-      def +(value)
-        raise "Unable to add point to #{value} #{value.class}" if [ :x, :y, :z ].find { |method| ! value.respond_to?(method) }
-        self.class.at (x + value.x.to_f), (y + value.y.to_f), (z + value.z.to_f)
-      end
+      private
 
-      #
-      # Subtract the point-like structure from this point. A point like structure
-      # is anything has the methods x, y, and z.
-      #
-      # @return a new point which is the difference of the point and the
-      #   provided value.
-      #
-      def -(value)
-        raise "Unable to subtract from this point with #{value} #{value.class}" if [ :x, :y, :z ].find { |method| ! value.respond_to?(method) }
-        self.class.at (x - value.x.to_f), (y - value.y.to_f), (z - value.z.to_f)
+      def calculation_requirements
+        [ :x, :y, :z ]
       end
 
     end

data/lib/metro/units/rectangle_bounds.rb

@@ -5,9 +5,7 @@ module Metro
     # An object that represents a rectanglar bounds.
     #
     class RectangleBounds
-
-      # Allow the ability to refer to the min, max values with their
-      # other alternate names.
+      include CalculationValidations
 
       attr_accessor :left, :right, :top, :bottom
 
@@ -46,15 +44,15 @@ module Metro
       end
 
       def ==(value)
-        return if [ :left, :right, :top, :bottom ].find { |method| ! value.respond_to?(method) }
+        check_calculation_requirements(value)
         left == value.left and right == value.right and top == value.top and bottom == value.bottom
       end
 
       #
       # Does this bounds contain the following point?
       #
-      def contains?(x,y)
-        x > left and x < right and y > top and y < bottom
+      def contains?(point)
+        point.x > left and point.x < right and point.y > top and point.y < bottom
       end
 
       #
@@ -68,6 +66,12 @@ module Metro
         "(#{left},#{top}) to (#{right},#{bottom})"
       end
 
+      private
+
+      def calculation_requirements
+        [ :left, :right, :top, :bottom ]
+      end
+
     end
 
   end

data/lib/metro/units/scale.rb

@@ -5,6 +5,7 @@ module Metro
     # Represents an object that contains the x scale factor, and y scale factor.
     #
     class Scale < Struct.new(:x_factor,:y_factor)
+      include CalculationValidations
 
       #
       # Create a scale that is 1:1.
@@ -34,6 +35,12 @@ module Metro
         "#{x_factor},#{y_factor}"
       end
 
+      private
+
+      def calculation_requirements
+        [ :x_factor, :y_factor ]
+      end
+
     end
   end
 end

data/lib/metro/units/units.rb

@@ -1,3 +1,4 @@
+require_relative 'calculation_validations'
 require_relative 'point'
 require_relative 'dimensions'
 require_relative 'scale'

data/lib/metro/version.rb

@@ -1,5 +1,5 @@
 module Metro
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
   WEBSITE = "https://github.com/burtlo/metro"
   CONTACT_EMAILS = ["dev@rubymetro.com"]
   

data/lib/metro/window.rb

@@ -13,6 +13,10 @@ module Metro
     #
     attr_accessor :scene
 
+    def state
+      scene.state
+    end
+
     #
     # @param [Fixnum] width the width of the game window
     # @param [Fixnum] height the height of the game window
@@ -32,7 +36,7 @@ module Metro
     # This is called every update interval while the window is being shown.
     #
     def update
-      scene.fire_events_for_held_buttons
+      state.fire_events_for_held_buttons
       scene.base_update
     end
 
@@ -49,7 +53,7 @@ module Metro
     # has focus.
     #
     def button_up(id)
-      scene.button_up(id)
+      state.fire_button_up(id)
     end
 
     #
@@ -57,7 +61,7 @@ module Metro
     # has focus.
     #
     def button_down(id)
-      scene.button_down(id)
+      state.fire_button_down(id)
     end
 
     #

data/lib/setup_handlers/reload_game_on_game_file_changes.rb

@@ -8,6 +8,10 @@ module Metro
     #
     class ReloadGameOnGameFileChanges
 
+      def watched_filepaths
+        source_filepaths + view_filepaths + asset_filepaths
+      end
+
       #
       # @NOTE this is duplication of the paths is also defined in LoadGameFiles.
       # @see Metro::SetupHandlers::LoadGameFiles
@@ -24,21 +28,17 @@ module Metro
         [ 'assets' ]
       end
 
-      def all_filepaths
-        source_filepaths + view_filepaths + asset_filepaths
-      end
-
       #
       # @param [Metro::Parameters::Options] options the options that the game
       #   was provided when it was launched.
       #
       def setup(options)
-        start_watcher if Game.debug?
+        start_watcher if Game.debug? and not options.packaged?
       end
 
       def start_watcher
         Thread.abort_on_exception = true
-        Thread.new { watch_filepaths(all_filepaths) }
+        Thread.new { watch_filepaths(watched_filepaths) }
       end
 
       #

data/lib/templates/game/models/hero.rb

@@ -1,9 +1,23 @@
-class Hero < Metro::Model
+class Hero < Metro::UI::Sprite
+
+  # A Metro::UI::Sprite predefines a number of commmon properties:
+  #
+  # * position
+  # * dimensions
+  # * color
+  # * angle
+  # * scale
+  #
+  # These properties add getter and setter methods of the following:
+  #
+  # * position, x, y, z and z_order (both z and z_order are the same)
+  # * dimensions, width, and height
+  # * color, red, green, blue, alpha
+  # * angle
+  # * scale, x_factor, y_factor
 
   property :image, path: "hero.png"
 
-  property :position
-  property :angle
   property :move_amount, default: 1.5
   property :turn_amount, default: 90.0
 
@@ -27,7 +41,22 @@ class Hero < Metro::Model
     self.angle += turn_amount
   end
 
-  def draw
-    image.draw_rot(x,y,z_order,angle.to_f)
-  end
+  # By default a Metro::UI::Sprite defines a #draw method which will
+  # draw the associated image with the position, rotation, and scale.
+  #
+  # If you would like to maintain the current draw functionality but augment
+  # it, you can define a draw method which calls to super.
+  #
+  # def draw
+  #   super
+  #   # custom drawing alongside the image
+  # end
+  #
+  # You may find it necessary to replace the existing draw functionality.
+  # Here you could define your own draw that overrides the original.
+  #
+  # def draw
+  #   # custom drawing without the original image draw
+  # end
+
 end

data/lib/templates/model.rb.tt

@@ -1,4 +1,4 @@
-class <%= model_name %> < GameModel
+class <%= model_name %> < Metro::Model
 
   #
   # Properties

data/spec/core_ext/string_spec.rb

@@ -30,24 +30,4 @@ describe String do
       its(:underscore) { should eq expected_value }
     end
   end
-
-  describe "#classify" do
-    context "when given a regular string" do
-      subject { "string" }
-      let(:expected_value) { "String" }
-      its(:classify) { should eq expected_value }
-    end
-
-    context "when given a underscored string" do
-      subject { "camel_cased" }
-      let(:expected_value) { "CamelCased" }
-      its(:classify) { should eq expected_value }
-    end
-
-    context "when given a partial camel_CasedString" do
-      subject { "camel_CasedString" }
-      let(:expected_value) { "CamelCasedString" }
-      its(:classify) { should eq expected_value }
-    end
-  end
 end

data/spec/metro/units/point_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe Metro::Units::Point do
+
+  subject { described_class.new x, y, z }
+
+  let(:x) { 12 }
+  let(:y) { 24 }
+  let(:z) { 36 }
+
+  its(:x) { should eq x }
+  its(:y) { should eq y }
+  its(:z) { should eq z }
+  its(:z_order) { should eq z }
+
+  let(:expected_string) { "#{x},#{y},#{z}" }
+  its(:to_s) { should eq expected_string }
+
+  describe "#+" do
+    context "when adding it to another point" do
+      let(:point) { described_class.at 1, 2, 3 }
+      let(:summed_point) { described_class.at 13, 26, 39 }
+
+      it "should be a sum of the two points" do
+        sum = subject + point
+        sum.should eq summed_point
+      end
+    end
+
+    context "when adding it to another point-like object" do
+      let(:point) { stub('Point Like',x: 1, y: 2, z: 3) }
+      let(:summed_point) { described_class.at 13, 26, 39 }
+
+      it "should be a sum of the two points" do
+        sum = subject + point
+        sum.should eq summed_point
+      end
+    end
+
+    context "when adding it to something not like a point" do
+      let(:point) { stub('Not Point Like') }
+      let(:summed_point) { described_class.at 13, 26, 39 }
+
+      it "should raise an error" do
+        expect { subject + point }.to raise_error
+      end
+    end
+  end
+
+  describe "#-" do
+    context "when adding it to another point" do
+      let(:point) { described_class.at 1, 2, 3 }
+      let(:summed_point) { described_class.at 11, 22, 33 }
+
+      it "should be a sum of the two points" do
+        sum = subject - point
+        sum.should eq summed_point
+      end
+    end
+
+    context "when adding it to another point-like object" do
+      let(:point) { stub('Point Like',x: 1, y: 2, z: 3) }
+      let(:summed_point) { described_class.at 11, 22, 33 }
+
+      it "should be a sum of the two points" do
+        sum = subject - point
+        sum.should eq summed_point
+      end
+    end
+
+    context "when adding it to something not like a point" do
+      let(:point) { stub('Not Point Like') }
+      let(:summed_point) { described_class.at 13, 26, 39 }
+
+      it "should raise an error" do
+        expect { subject - point }.to raise_error
+      end
+    end
+  end
+
+  describe "Class Methods" do
+
+    subject { described_class }
+
+    describe "#zero" do
+      let(:expected_point) { Point.new 0,0,0 }
+
+      it "should create a zero point" do
+        subject.zero.should == expected_point
+      end
+    end
+
+    describe "#at" do
+      let(:expected_point) { Point.new 1,2,3 }
+
+      it "should be equal to a new created point" do
+        subject.at(1,2,3).should == expected_point
+      end
+    end
+
+    describe "#parse" do
+      context "when the input string is defined with 'x,y,z'" do
+        let(:input) { "1,2,3" }
+        let(:expected_value) { Point.at(1,2,3) }
+
+        it "should create the expected point" do
+          subject.parse(input).should eq expected_value
+        end
+      end
+
+      context "when the input string is defined with 'x,y'" do
+        let(:input) { "1,2" }
+        let(:expected_value) { Point.at(1,2,0) }
+
+        it "should create the expected point" do
+          subject.parse(input).should eq expected_value
+        end
+      end
+
+      context "when the input is a nil" do
+        let(:input) { nil }
+        let(:expected_value) { Point.at(0,0,0) }
+
+        it "should create the expected point" do
+          subject.parse(input).should eq expected_value
+        end
+      end
+    end
+
+  end
+
+end

data/spec/setup_handlers/exit_if_dry_run_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Metro::SetupHandlers::ExitIfDryRun do
+
+  describe "#setup" do
+    context "when the options specify that this is a dry run" do
+
+      let(:options) { stub('Options', dry_run?: true) }
+
+      it "should exit the game" do
+        subject.should_receive(:exit)
+        subject.setup(options)
+      end
+    end
+
+    context "when the options DO NOT specify that this is a dry run" do
+
+      let(:options) { stub('Options', dry_run?: false) }
+
+      it "should not exit the game" do
+        subject.should_not_receive(:exit)
+        subject.setup(options)
+      end
+    end
+  end
+
+end