chingu 0.8rc2 → 0.8rc3

data/lib/chingu/traits/animation.rb

@@ -25,7 +25,7 @@ module Chingu
     # A chingu trait providing automatic loading of tile-animations
     #
     # For example:
-    # 	class FireBall; has_traits :animation; end;
+    # 	class FireBall; traits :animation; end;
     #
     # Will automatically load:
     # - fire_ball.png into self.animations[:default]
@@ -59,13 +59,11 @@ module Chingu
         Dir[glob].each do |tile_file|
           puts tile_file if trait_options[:animation][:debug]
           if tile_file =~ /[a-zA-Z\_+]_*(\d+)x(\d+)_*([a-zA-Z]*)\.(bmp|png)/
-            state = $3.length > 0 ? $3 : "default"            
+            state = $3.length > 0 ? $3 : "default"
             animations[state.to_sym] = Chingu::Animation.new(trait_options[:animation].merge(:file => tile_file))
           elsif tile_file =~ /[a-zA-Z\_+]\.(bmp|png)/
-            puts tile_file
             animations[:default] = Chingu::Animation.new(trait_options[:animation].merge(:file => tile_file))
           end
-          
         end
         return animations
       end

data/lib/chingu/traits/sprite.rb

@@ -43,10 +43,9 @@ module Chingu
       def setup_trait(object_options = {})        
         # default settings for all variables unless set in constructor
         defaults = {
-          :x => 0, :y => 0, :angle => 0,
-          :factor => ($window.factor||1.0),
+          :x => 0, :y => 0, :angle => 0, :factor => ($window.factor||1.0),
           :zorder => 100, :center_x => 0.5, :center_y => 0.5,
-          :mode => :default, :color => nil
+          :mode => :default, :color => nil, :visible => true
         }
         
         # if user specs :image take care of it first since width, height etc depends on it.
@@ -58,7 +57,7 @@ module Chingu
       end
 
       def color=(color)
-        @color = color.is_a?(Gosu::Color) ? color : Gosu::Color.new(color ||  0xFFFFFFFF)
+        @color = color.is_a?(Gosu::Color) ? color : Gosu::Color.new(color || 0xFFFFFFFF)
       end
 
       #
@@ -111,12 +110,14 @@ module Chingu
       # Usually better to have a large image and make it smaller then the other way around.
       #
       def width=(width)
-        @factor_x = width.to_f / @image.width.to_f
+        @factor_x = width.to_f / @image.width.to_f  if @image
       end
-    
-      # Get effective on width by calculating it from image-width and factor
+      
+      #
+      # Get effective  width by calculating it from image-width and factor_x
+      #
       def width
-        (@image.width * @factor_x).abs
+        (@image.width * @factor_x).abs              if @image
       end
 
       #
@@ -125,12 +126,14 @@ module Chingu
       # Usually better to have a large image and make it smaller then the other way around.
       #
       def height=(height)
-        @factor_y = height.to_f / @image.height.to_f
+        @factor_y = height.to_f / @image.height.to_f  if @image
       end
     
-      # Get effective on heightby calculating it from image-width and factor
+      #
+      # Get effective height by calculating it from image-width and factor
+      #
       def height
-        (@image.height.to_f * @factor_y).abs
+        (@image.height.to_f * @factor_y).abs        if @image
       end
 
       # Set width and height in one swoop
@@ -216,14 +219,14 @@ module Chingu
       # Our encapsulation of GOSU's image.draw_rot, uses the objects variables to draw it on screen if @visible is true
       #
       def draw
-        draw_relative
+        @image.draw_rot(@x, @y, @zorder, @angle, @center_x, @center_y, @factor_x, @factor_y, @color, @mode)  if @image
       end
 
       #
       # Works as #draw() but takes offsets for all draw_rot()-arguments. Used among others by the viewport-trait.
       #      
       def draw_relative(x=0, y=0, zorder=0, angle=0, center_x=0, center_y=0, factor_x=0, factor_y=0)
-        @image.draw_rot(@x+x, @y+y, @zorder+zorder, @angle+angle, @center_x+center_x, @center_y+center_y, @factor_x+factor_x, @factor_y+factor_y, @color, @mode)
+        @image.draw_rot(@x+x, @y+y, @zorder+zorder, @angle+angle, @center_x+center_x, @center_y+center_y, @factor_x+factor_x, @factor_y+factor_y, @color, @mode)  if @image
       end
 
       #

data/lib/chingu/window.rb

@@ -128,7 +128,7 @@ module Chingu
       # Without this self.fps would return an incorrect value.
       # If you override this in your Chingu::Window class, make sure to call super.
       #
-      @milliseconds_since_last_tick = @fps_counter.register_tick      
+      @milliseconds_since_last_tick = @fps_counter.register_tick
       
       intermediate_update
     end

data/spec/chingu/animation_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+module Chingu
+  describe Animation do  
+    before :each do
+      @game = Chingu::Window.new
+      @test_dir = File.join(File.dirname(File.expand_path(__FILE__)), 'images')
+      @animation_clean = Animation.new(:file => File.join(@test_dir, "droid_11x15.bmp"))
+      @animation = Animation.new(:file => File.join(@test_dir, "droid_11x15.bmp"), :delay => 0)
+    end
+
+    after :each do
+      @game.close
+    end
+    
+    describe "newly initialized object" do
+      it "should have default values" do
+        @animation_clean.bounce.should == false
+        @animation_clean.loop.should == true
+        @animation_clean.delay.should == 100
+        @animation_clean.index.should == 0
+        @animation_clean.step.should == 1
+      end
+    end
+
+    describe "Animation loading file: droid_11x15.bmp" do
+      it "should detect size and frames automatically from filename" do
+        @animation.size.should == [11,15]
+        @animation.frames.count.should == 14
+      end
+      
+      it "should give correct frames for .first and .last" do
+        @animation.first.should == @animation.frames.first
+        @animation.last.should == @animation.frames.last
+      end
+
+      it "should return frame with []" do
+        @animation[0].should == @animation.frames.first
+      end
+
+      it "should step animation forward with .next" do
+        @animation.next
+        @animation.index.should == 1
+      end
+
+      it "should stop animation when reaching end if loop and bounce are both false" do
+        @animation.loop = false
+        @animation.bounce = false
+        @animation.index = 14
+        @animation.next
+        @animation.index.should == 14
+      end
+
+      it "should loop animation when reaching end if loop is true" do
+        @animation.index = 14
+        @animation.next
+        @animation.index.should == 0
+      end
+      
+      it "should bounce animation when reaching end if bounce is true" do
+        @animation.bounce = true
+        @animation.index = 14
+        @animation.next
+        @animation.index.should == 13
+      end
+      
+      it "should use .step when moving animation forward" do
+        @animation.step = 5
+        @animation.next
+        @animation.index.should == 5
+        @animation.next
+        @animation.index.should == 10        
+      end
+      
+      it "should handle 'frame_names' pointing to a new animation containing a subset of the original frames" do
+        @animation.frame_names = { :scan => 0..5, :up => 6..7, :down => 8..9, :left => 10..11, :right => 12..13 }
+        
+        @animation[:scan].should be_kind_of(Animation)
+        @animation[:scan].frames.count.should == 6
+        @animation[:up].frames.count.should == 2
+        @animation[:down].frames.count.should == 2
+        @animation[:left].frames.count.should == 2
+        @animation[:right].frames.count.should == 2
+      end
+      
+    end
+  end
+end

data/spec/chingu/assets_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+module Chingu
+  describe Chingu::NamedResource do  
+    before :each do
+      @game = Chingu::Window.new
+      
+      # Gosu uses the paths based on where rspec is, not where this file is, so we need to do it manually!
+      Gosu::Image::autoload_dirs.unshift File.join(File.dirname(File.expand_path(__FILE__)), 'images')
+    end
+
+    after :each do
+      @game.close
+    end
+    
+    describe "Image" do
+      it "should have default autoload dirs" do
+        Gosu::Image.autoload_dirs.should include(".")
+        Gosu::Image.autoload_dirs.should include("#{@game.root}/media")
+      end
+      
+      it "should autoload image in Image.autoload_dirs" do
+        Gosu::Image["rect_20x20.png"].should be_kind_of Gosu::Image
+      end
+    
+      it "should return the same cached Gosu::Image if requested twice" do
+        Gosu::Image["rect_20x20.png"].should == Gosu::Image["rect_20x20.png"]
+      end
+      
+      #it "should raise error if image is nonexistent" do
+      #  Gosu::Image["nonexistent_image.png"].should raise_error RuntimeError
+      #end
+      
+    end
+
+    describe "Song" do
+      it "should have default autoload dirs" do
+        Gosu::Song.autoload_dirs.should include(".")
+        Gosu::Song.autoload_dirs.should include("#{@game.root}/media")
+      end
+    end
+    
+    describe "Sample" do
+      it "should have default autoload dirs" do
+        Gosu::Sample.autoload_dirs.should include(".")
+        Gosu::Sample.autoload_dirs.should include("#{@game.root}/media")
+      end
+    end
+        
+    describe "Font" do
+      it "should have default autoload dirs" do
+        Gosu::Font.autoload_dirs.should include(".")
+        Gosu::Font.autoload_dirs.should include("#{@game.root}/media")
+      end
+    end
+    
+  end
+end

data/spec/chingu/basic_game_object_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+class MyBasicGameObject < Chingu::BasicGameObject
+end
+
+class MyBasicGameObjectWithSetup < Chingu::BasicGameObject
+  def setup
+    @paused = true
+  end
+end
+
+module Chingu
+
+  describe BasicGameObject do
+    before :each do
+      @game = Chingu::Window.new
+    end
+    
+    after :each do
+      @game.close
+    end
+
+    it { should respond_to(:options) }
+    it { should respond_to(:paused) }
+    it { should respond_to(:setup_trait) }
+    it { should respond_to(:setup) }
+    it { should respond_to(:update_trait) }
+    it { should respond_to(:draw_trait) }
+    it { should respond_to(:filename) }
+
+    context "A class inherited from BasicGameObject" do
+      it "should be automatically stored in $window.game_objects" do
+        3.times { go = MyBasicGameObject.create }
+        $window.update
+        $window.game_objects.size.should == 3
+      end
+      
+      it "should have $window as parent" do
+        go = MyBasicGameObject.create
+        go.parent.should == $window
+      end
+      
+      it "should keep track of its instances in class#all" do
+        3.times { MyBasicGameObject.create }
+        #
+        # Can/should we remove the dependency on #update here before the created objects gets saved?
+        # We mostly protect against adding to the object array while iterating over it
+        #
+        $window.update
+        MyBasicGameObject.all.size.should == 3
+        MyBasicGameObject.size.should == 3
+      end
+      
+      it "should be removed from game_objects list when destroy() is called" do
+        go = MyBasicGameObject.create
+        $window.update
+        $window.game_objects.size.should == 1
+        go.destroy
+        $window.update
+        $window.game_objects.size.should == 0
+      end
+
+      it "should have all instances removed with classmethod #destroy_all()" do
+        3.times { MyBasicGameObject.create }
+        $window.update
+        MyBasicGameObject.destroy_all
+        $window.update
+        $window.game_objects.size.should == 0
+      end
+
+      it "should take hash-argument, parse it and save in options" do
+        game_object = MyBasicGameObject.new(:paused => false, :foo => :bar)
+        game_object.paused?.should == false
+        game_object.options.should == {:paused => false, :foo => :bar}
+      end
+
+      it "should call setup() at the end of initialization" do
+        game_object = MyBasicGameObjectWithSetup.new(:paused => false)
+        game_object.paused?.should == true
+      end
+      
+      it "should be unpaused by default" do
+        subject.paused?.should == false
+      end
+    
+      it "should change paused status with pause()/unpause()" do
+        subject.pause
+        subject.paused?.should == true
+        subject.unpause
+        subject.paused?.should == false
+      end
+      
+      it "should give a well named string with filename()" do
+        MyBasicGameObject.new.filename.should == "my_basic_game_object"
+      end
+
+    end
+    
+    context "when created with defaults in Chingu::Window" do
+      
+      it "should belong to main window it not created inside a game state" do
+        subject.parent.should == @game
+      end      
+    end
+    
+    context "when created in Chingu::GameState" do
+      
+    end
+    
+  end
+end

data/spec/chingu/game_object_list_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+module Chingu
+
+  describe GameObjectList do
+    before :each do
+      @game = Chingu::Window.new      
+    end
+    
+    after :each do
+      @game.close
+    end
+    
+    it { should respond_to :draw }
+    it { should respond_to :update }
+    it { should respond_to :each }
+    it { should respond_to :each_with_index }
+    it { should respond_to :select }
+    it { should respond_to :first }
+    it { should respond_to :last }
+    it { should respond_to :show }
+    it { should respond_to :hide }
+    it { should respond_to :pause }
+    it { should respond_to :unpause}
+    
+    context "$window.game_objects" do
+      it "Should return created game objects" do
+        go1 = GameObject.create
+        go2 = GameObject.create
+        @game.game_objects.first.should == go1
+        @game.game_objects.last.should == go2
+      end
+      
+      it "should be able to destroy game_objects while iterating" do
+        10.times { GameObject.create }
+        @game.game_objects.each_with_index do |game_object, index|
+          game_object.destroy if index >= 5
+        end
+        @game.game_objects.size.should == 5
+      end
+      
+      it "should call update() on all unpaused game objects" do
+        GameObject.create.should_receive(:update)
+        GameObject.create(:paused => true).should_not_receive(:update)
+        @game.game_objects.update
+      end
+
+      it "should call draw() on all visible game objects" do
+        GameObject.create.should_receive(:draw)
+        GameObject.create(:visible => false).should_not_receive(:draw)
+        @game.game_objects.draw
+      end
+      
+      it "should call draw_relative() on all visible game objects" do
+        GameObject.create.should_receive(:draw_relative)
+        GameObject.create(:visible => false).should_not_receive(:draw_relative)
+        @game.game_objects.draw_relative
+      end
+      
+      it "should pause all game objects with pause!" do
+        5.times { GameObject.create }
+        @game.game_objects.pause!
+        @game.game_objects.each do |game_object|
+          game_object.paused.should == true
+        end
+      end
+      
+      it "should hide all game objects with hide!" do
+        5.times { GameObject.create }
+        @game.game_objects.hide!
+        @game.game_objects.each do |game_object|
+          game_object.visible.should == false
+        end
+      end
+      
+    end
+  end
+end

data/spec/chingu/game_object_spec.rb

@@ -3,13 +3,17 @@ require 'spec_helper'
 module Chingu
 
   describe GameObject do
-    before :all do
+    before :each do
       @game = Chingu::Window.new
       
       # Gosu uses the paths based on where rspec is, not where this file is, so we need to do it manually!
       Gosu::Image::autoload_dirs.unshift File.join(File.dirname(File.expand_path(__FILE__)), 'images')
     end
 
+    after :each do
+      @game.close
+    end
+
     it { should respond_to(:x) }
     it { should respond_to(:y) }
     it { should respond_to(:angle) }
@@ -30,6 +34,7 @@ module Chingu
         subject.angle.should == 0
         subject.x.should == 0
         subject.y.should == 0
+        subject.zorder.should == 100
         subject.factor_x.should == 1
         subject.factor_y.should == 1
         subject.center_x.should == 0.5
@@ -141,22 +146,53 @@ module Chingu
       end
     end
     
-    #context "when there's a global factor/scale" do
-    #  $window = Chingu::Window.new
-    #  $window.factor = 2
-    #  subject { described_class.new(:image => "rect_20x20.png") }
-    #  it "should use global factor/scale" do
-    #    subject.factor_x.should == 2
-    #    subject.factor_y.should == 2
-    #    subject.width.should == 40
-    #    subject.height.should == 40
-    #  end
-    #end
+    context "when there's a global factor/scale" do
+      before :each do
+        $window.factor = 2
+      end
+      
+      subject { described_class.new(:image => "rect_20x20.png") }
 
-    after(:all) do
-      $window.close
+      it "should use global factor/scale" do
+        subject.factor_x.should == 2
+        subject.factor_y.should == 2
+        subject.width.should == 40
+        subject.height.should == 40
+      end
     end
     
+    context "when there's missing parts" do
+      it "should return nil on width and height if there's no image available" do
+        game_object = GameObject.new
+        game_object.width.should == nil
+        game_object.height.should == nil
+      end
+    end
+    
+    context "class methods" do
+      it "should go through all instances of class on #each" do
+        go1 = GameObject.create
+        go2 = GameObject.create
+        
+        index = 0
+        GameObject.each do |game_object|
+          game_object.should == go1 if index==0
+          game_object.should == go2 if index==1
+          index += 1
+        end
+      end
+
+      it "should go through all instances of class on #each_with_index" do
+        go1 = GameObject.create
+        go2 = GameObject.create
+        
+        GameObject.each_with_index do |game_object, index|
+          game_object.should == go1 if index==0
+          game_object.should == go2 if index==1
+        end
+      end
+
+    end
   end
 
 end