chingu 0.9rc7 → 0.9rc8

data/lib/chingu/helpers/game_object.rb

@@ -63,7 +63,11 @@ module Chingu
         objects.each do |object|
           object.each_pair do |klassname, attributes|
             begin
-              klass = Kernel::const_get(klassname)
+              klass = Object
+              names = klassname.split('::')
+              names.each do |name|
+                klass = klass.const_defined?(name) ? klass.const_get(name) : klass.const_missing(name)
+              end
               unless klass.class == "GameObject" && !except.include?(klass)
                 puts "Creating #{klassname.to_s}: #{attributes.to_s}" if debug
                 object = klass.create(attributes)

data/lib/chingu/helpers/game_state.rb

@@ -31,6 +31,7 @@ module Chingu
   #
   module GameState
     extend Forwardable
+    
     def_delegator :game_state_manager, :game_states
     def_delegator :game_state_manager, :push_game_state
     def_delegator :game_state_manager, :pop_game_state
@@ -38,6 +39,7 @@ module Chingu
     def_delegator :game_state_manager, :transitional_game_state
     def_delegator :game_state_manager, :current_game_state
     def_delegator :game_state_manager, :clear_game_states
+    def_delegator :game_state_manager, :pop_until_game_state
   end
   
   end

data/lib/chingu/simple_menu.rb

@@ -49,8 +49,8 @@ module Chingu
         elsif key.is_a? Image
           GameObject.new(options.merge!(:image => key))
         elsif key.is_a? GameObject
-          menu_item.options.merge!(options.dup)
-          menu_item
+          key.options.merge!(options.dup)
+          key
         end
         
         item.options[:on_select] = method(:on_select)

data/lib/chingu/text.rb

@@ -84,23 +84,20 @@ module Chingu
 
       if options[:background]
         @background = GameObject.new(:image => options[:background])
-        @background.attributes = self.attributes
-        @background.color = ::Gosu::Color::WHITE
-        @background.zorder -= 1
-        @background.x -= @padding
-        @background.y -= @padding
-        @background.width = self.width + @padding * 2
-        @background.height = self.height + @padding * 2
+        bg_update
+        @no_bg_update = options[:no_bg_update] || false # always update background attribute
       end
       
       self.height = options[:height]  if options[:height]
-    end
-    
+    end    
+
+
     #
     # Set a new text, a new image is created.
     #
     def text=(text)
-      @text = text
+      return if text.dup == @text # Have to make a dup for content comparison
+      @text = text.dup # Make a copy, again to have a different Objectid
       create_image
     end
     
@@ -111,6 +108,14 @@ module Chingu
       @gosu_font.text_width(@text, @factor_x)
     end
     
+    #
+    # Update the background attributes if necessary unless specified 
+    #
+    def update
+      super
+      bg_update if @background and !@no_bg_update
+    end
+
     #
     # Draws @background if present + our text in @image
     #
@@ -131,5 +136,15 @@ module Chingu
         @image = Gosu::Image.from_text($window, @text, @font, @size)
       end
     end
+
+    def bg_update
+      @background.attributes = self.attributes
+      @background.color = ::Gosu::Color::WHITE
+      @background.zorder -= 1
+      @background.x -= @padding
+      @background.y -= @padding
+      @background.width = self.width + @padding * 2
+      @background.height = self.height + @padding * 2  
+    end
   end
 end

data/lib/chingu/traits/sprite.rb

@@ -97,9 +97,9 @@ module Chingu
         raise ArgumentError.new("No image set") if image.nil?
         
         @image = if String === image
-                   # 1) Try loading the image the normal way
-                   # 2) Try looking up the picture using Chingus Image-cache
-                   Gosu::Image.new($window, image,false) rescue Gosu::Image[image]
+                   # 1) Try looking up the picture using Chingus Image-cache
+                   # 2) Try loading the image the normal way
+                   Gosu::Image[image] rescue Gosu::Image.new($window, image,false) 
                  elsif image.respond_to? :call
                    image.call
                  else

data/lib/chingu/viewport.rb

@@ -28,10 +28,10 @@ module Chingu
   #
   #
   # TODO:
-  # Implement use of viewports angle, center_x, center_y, factor_x, factor_y
+  # Implement use of viewports angle, center_x, center_y
   #
   class Viewport
-    attr_accessor :x, :y, :x_target, :y_target, :x_lag, :y_lag, :game_area
+    attr_accessor :x, :y, :x_target, :y_target, :x_lag, :y_lag, :factor_x, :factor_y, :game_area
     
     def initialize(options = {})
       @x = options[:x] || 0
@@ -40,6 +40,8 @@ module Chingu
       @y_target = options[:y_target] || @y
       @x_lag = options[:x_lag] || 0
       @y_lag = options[:y_lag] || 0
+      @factor_x = options[:factor_x] || 1
+      @factor_y = options[:factor_y] || 1
       @game_area = Chingu::Rect.new(options[:game_area] || [@x, @y, $window.width, $window.height])       
     end
     
@@ -57,8 +59,8 @@ module Chingu
     # TODO: Add support for x,y here!
     #
     def center_around(object)
-      self.x = object.x - $window.width / 2
-      self.y = object.y - $window.height / 2
+      self.x = object.x * @factor_x - $window.width / 2
+      self.y = object.y * @factor_y - $window.height / 2
     end
     
     #
@@ -114,14 +116,14 @@ module Chingu
     # Modify viewports x and y from target_x / target_y and x_lag / y_lag 
     # Use this to have the viewport "slide" after the player
     #
-    def move_towards_target			
+    def move_towards_target
       if @x_target && @x != @x_target
-        x_step = @x_target - @x
+        x_step = @x_target * @factor_x - @x
         self.x = @x + x_step * (1.0 - @x_lag)
       end
-      
+
       if @y_target && @y != @y_target
-        y_step = @y_target - @y
+        y_step = @y_target * @factor_y - @y
         self.y = @y + y_step * (1.0 - @y_lag)
       end
     end
@@ -132,9 +134,9 @@ module Chingu
     def x=(x)
       @x = x
       if @game_area
-        @x = @game_area.x                     if @x < @game_area.x
-        @x = @game_area.width-$window.width   if @x > @game_area.width-$window.width
-      end 
+        @x = @game_area.x * @factor_x         if @x < @game_area.x * @factor_x
+        @x = @game_area.width * @factor_x - $window.width   if @x > @game_area.width * @factor_x - $window.width
+      end
     end
 
     #
@@ -143,8 +145,8 @@ module Chingu
     def y=(y)
       @y = y
       if @game_area
-        @y = @game_area.y                       if @y < @game_area.y
-        @y = @game_area.height-$window.height   if @y > @game_area.height-$window.height
+        @y = @game_area.y * @factor_y           if @y < @game_area.y * @factor_y
+        @y = @game_area.height * @factor_y - $window.height   if @y > @game_area.height * @factor_y - $window.height
       end
     end
     
@@ -152,7 +154,9 @@ module Chingu
     # Apply the X/Y viewport-translation, used by trait "viewport"
     #
     def apply(&block)
-      $window.translate(-@x.to_i, -@y.to_i, &block)
+      $window.translate(-@x.to_i, -@y.to_i) do
+        $window.scale(@factor_x, @factor_y, 0, 0, &block)
+      end
     end
 
     def to_s

data/lib/chingu/window.rb

@@ -64,6 +64,8 @@ module Chingu
       @milliseconds_since_last_tick = 0
       @factor = 1
       @cursor = false
+      @times_muted = 0
+      @volume = DEFAULT_VOLUME
       
       setup
     end
@@ -194,5 +196,57 @@ module Chingu
 
       $window = nil
     end
+    
+    # GLOBAL SOUND SETTINGS
+    
+    DEFAULT_VOLUME = 1.0 # However, 0.5 is a better value for general use.
+
+    # Set the global volume of all Samples and Songs, not affected by Window being muted.
+    def volume=(value)
+      raise "Bad volume setting" unless value.is_a? Numeric
+
+      old_volume = @volume
+      @volume = [[value, 1.0].min, 0.0].max.to_f
+
+      Song.send(:recalculate_volumes, old_volume, @volume)
+
+      volume
+    end
+
+    # Volume of all Samples and Songs, not affected by the Window being muted.
+    attr_reader :volume
+
+    # Actual volume of all Samples and Songs, affected by the Window being muted.
+    def effective_volume
+      muted? ? 0.0 : @volume
+    end
+
+    # Mute the window and all Samples and Songs played.
+    # Muting stacks, so sound will only be heard if the number of unmutes is the same as the number of mutes.
+    def mute
+      unless muted?
+        Song.send(:resources).each_value {|song| song.send :mute }
+      end
+      @times_muted += 1
+
+      self
+    end
+
+    # Unmute the window and all Samples and Songs played.
+    # Muting stacks, so sound will only be heard if the number of unmutes is the same as the number of mutes.
+    def unmute
+      raise "Can't unmute when not muted" unless muted?
+      @times_muted -= 1
+      unless muted?
+        Song.send(:resources).each_value {|song| song.send :unmute }
+      end
+
+      self
+    end
+
+    # Is the window currently muted?
+    def muted?
+      @times_muted > 0
+    end   
   end
 end

data/spec/chingu/animation_spec.rb

@@ -6,8 +6,9 @@ module Chingu
       @game = Chingu::Window.new
       @test_dir = File.join(File.dirname(File.expand_path(__FILE__)), 'images')
       Gosu::Image.autoload_dirs << @test_dir
-      @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)
+      @file = "droid_11x15.bmp"
+      @animation_clean = Animation.new(:file => @file)
+      @animation = Animation.new(:file => @file, :delay => 0)
     end
 
     after :each do
@@ -33,8 +34,45 @@ module Chingu
         @anim = Animation.new(:file => "images/droid_11x15.bmp")
         @anim.frames.count.should == 14
       end
+      
+      it "should load from a Gosu image" do
+        Dir.chdir(File.dirname(File.expand_path(__FILE__)))
+        @anim = Animation.new(:image => Gosu::Image["images/droid_11x15.bmp"], :size => [11, 15])
+        @anim.frames.count.should == 14
+      end
     end
-
+    
+    describe "Animation loading using :frames" do    
+      it "should have the same frames" do 
+        anim = Animation.new :frames => @animation_clean.frames      
+        anim.frames.should == @animation_clean.frames
+      end
+      
+      it "should reject non-consistent frame sizes" do       
+        ->{ Animation.new :frames => @animation_clean.frames + [Gosu::Image[@file]]}.should raise_error ArgumentError
+      end
+    end
+    
+    describe "Animation loading using :image" do
+      before :each do
+        @anim = Animation.new :image => Gosu::Image[@file]
+      end
+      
+      it "should have the same frames" do       
+        @anim.frames.zip(@animation_clean.frames).all? { |a, b| a.to_blob == b.to_blob }
+      end
+    end
+    
+    describe "Animation loading errors" do      
+      it "should fail unless one of the creation params is given" do       
+        ->{ Animation.new }.should raise_error ArgumentError
+      end
+      
+      it "should fail if more than one creation params" do
+        ->{ Animation.new :image => Gosu::Image[@file], :file => @file}.should raise_error ArgumentError
+      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]

data/spec/chingu/game_state_manager_spec.rb

@@ -60,22 +60,69 @@ module Chingu
     describe "switch_game_state" do
       before :each do
         @game.push_game_state(Chingu::GameStates::Pause)
-        @game.switch_game_state(Chingu::GameStates::Edit)
+        @game.switch_game_state(Chingu::GameStates::Debug)
       end
       
       it "should replace current game state" do
-        @game.current_game_state.class.should == Chingu::GameStates::Edit
+        @game.current_game_state.should be_a Chingu::GameStates::Debug
       end
       
       it "should not change the total amount of game states" do
         @game.game_states.count.should == 1
       end
     end
+    
+    describe "pop_until_game_state" do
+      before :each do
+        @game.push_game_state(Chingu::GameStates::Pause)       
+        @game.push_game_state(Chingu::GameStates::Debug)
+        @game.push_game_state(Chingu::GameStates::Debug)
+        @states = @game.game_state_manager.instance_variable_get(:@game_states).dup
+      end
+      
+      describe "with class" do
+        it "should finalize popped states" do
+          @states[1].should_receive(:finalize)
+          @states[2].should_receive(:finalize)
+          @game.pop_until_game_state(Chingu::GameStates::Pause)
+        end
+        
+        it "should setup revealed states" do
+          @states[0].should_receive(:setup)
+          @states[1].should_receive(:setup)
+          @game.pop_until_game_state(Chingu::GameStates::Pause)          
+        end
+          
+        it "should pop down to the given game state" do
+          @game.pop_until_game_state(Chingu::GameStates::Pause)
+          @game.game_states.should eq [@states[0]]
+        end
+      end
+      
+      describe "with instance" do
+        it "should finalize popped states" do
+          @states[1].should_receive(:finalize)
+          @states[2].should_receive(:finalize)
+          @game.pop_until_game_state(@states[0])          
+        end
+        
+        it "should setup revealed states" do
+          @states[0].should_receive(:setup)
+          @states[1].should_receive(:setup)
+          @game.pop_until_game_state(@states[0])          
+        end
+          
+        it "should pop down to the given game state" do
+          @game.pop_until_game_state(@states[0])
+          @game.game_states.should eq [@states[0]]
+        end
+      end
+    end
       
     describe "clear_game_states" do
       it "should clear all game states" do
         @game.push_game_state(Chingu::GameStates::Pause)
-        @game.switch_game_state(Chingu::GameStates::Edit)
+        @game.push_game_state(Chingu::GameStates::Edit)
         @game.clear_game_states
         @game.game_states.count.should == 0
       end

data/spec/chingu/network_spec.rb

@@ -16,14 +16,14 @@ module Chingu
     
     describe Chingu::GameStates::NetworkServer do
       it "should open listening port on start()" do
-        @server = described_class.new(:ip => "0.0.0.0", :port => 9999)
+        @server = described_class.new(:address => "0.0.0.0", :port => 9999)
         @server.should_receive(:on_start)
         @server.start
         @server.stop
       end
 
       it "client should timeout when connecting to blackhole ip" do
-        @client = Chingu::GameStates::NetworkClient.new(:ip => "1.2.3.4", :port => 1234, :debug => true)
+        @client = Chingu::GameStates::NetworkClient.new(:address => "1.2.3.4", :port => 1234, :debug => true)
         @client.connect
         
         #@client.should_receive(:on_timeout) ## gives on_connection_refused instead, kind of ok.
@@ -32,15 +32,15 @@ module Chingu
       end
 
       it "should call on_start_error() if failing" do
-        @server = described_class.new(:ip => "1.2.3.999", :port => 12345678) # crazy ip:port
+        @server = described_class.new(:address => "1.2.3.999", :port => 12345678) # crazy address:port
         @server.should_receive(:on_start_error)
         @server.start
         @server.stop
       end
 
       it "should call on_connect() and on_disconnect() when client connects" do
-        @server = described_class.new(:ip => "0.0.0.0", :port => 9999)
-        @client = Chingu::GameStates::NetworkClient.new(:ip => "127.0.0.1", :port => 9999)
+        @server = described_class.new(:address => "0.0.0.0", :port => 9999)
+        @client = Chingu::GameStates::NetworkClient.new(:address => "127.0.0.1", :port => 9999)
         
         @server.should_receive(:on_start)
         @server.should_receive(:on_connect).with(an_instance_of(TCPSocket))
@@ -58,19 +58,64 @@ module Chingu
     end
     
     describe Chingu::GameStates::NetworkClient do
-      it "should call on_connection_refused callback when connecting to closed port" do
-        @client = described_class.new(:ip => "127.0.0.1", :port => 55421) # closed we assume
-        @client.should_receive(:on_connection_refused)
+      describe "connect" do
+        it "should call on_connection_refused callback when connecting to closed port" do
+          @client = described_class.new(:address => "127.0.0.1", :port => 55421) # closed we assume
+          @client.should_receive(:on_connection_refused)
+          @client.connect
+          5.times { @client.update }
+        end
+ 
+        it "should not call on_timeout callback when unable to connect for less time than the timeout" do
+          @client = described_class.new(:address => "127.0.0.1", :port => 55421, :timeout => 250) # closed we assume
+          @client.connect
+          @client.should_not_receive(:on_timeout)
+          5.times { @client.update; sleep 0.01 }
+        end
+      
+        it "should call on_timeout callback when unable to connect for longer than the timeout" do
+          @client = described_class.new(:address => "127.0.0.1", :port => 55421, :timeout => 250) # closed we assume
+          @client.connect
+          @client.update
+          sleep 0.3   
+          @client.should_receive(:on_timeout)        
+          5.times { @client.update }
+        end
+      end
+    end
+    
+    describe "Connecting" do
+      before :each do        
+        @client = Chingu::GameStates::NetworkClient.new(:address => "127.0.0.1", :port => 9999)    
+        @server = Chingu::GameStates::NetworkServer.new(:port => 9999)        
+      end
+      
+      it "should connect to the server, when the server starts before it" do
+        #@server.start
+        #@client.connect
+        #5.times { @client.update }
+        #@client.should be_connected
+      end
+      
+      it "should connect to the server, even when the server isn't initialy available" do
         @client.connect
-        5.times { @client.update }
+        3.times { @client.update; sleep 0.2; @server.update; @client.flush }
+        @server.start
+        3.times { @client.update; sleep 0.2; @server.update; @client.flush }
+        @client.should be_connected
+      end
+      
+      after :each do 
+        @client.close
+        @server.close
       end
     end
     
     describe "Network communication" do
       before :each do
         @server = Chingu::GameStates::NetworkServer.new(:port => 9999).start
-        @client = Chingu::GameStates::NetworkClient.new(:ip => "127.0.0.1", :port => 9999).connect
-        @client2 = Chingu::GameStates::NetworkClient.new(:ip => "127.0.0.1", :port => 9999).connect
+        @client = Chingu::GameStates::NetworkClient.new(:address => "127.0.0.1", :port => 9999).connect
+        @client2 = Chingu::GameStates::NetworkClient.new(:address => "127.0.0.1", :port => 9999).connect
         @client.update until @client.connected?
         @client2.update until @client2.connected?
       end
@@ -123,6 +168,94 @@ module Chingu
           end
         end
       end
+
+      describe "byte and packet counters" do
+        before :each do
+          @packet = "Hello! " * 10
+          @packet_length = Marshal.dump(@packet).length
+          @packet_length_with_header = @packet_length + 4
+        end
+
+        it "should be zeroed initially" do
+          [@client, @client2, @server].each do |network|
+            network.packets_sent.should be 0
+            network.bytes_sent.should be 0
+            network.packets_received.should be 0
+            network.bytes_received.should be 0
+          end
+        end
+
+        describe "client to server" do
+          before :each do
+            @client.send_msg(@packet)
+            @server.update
+          end
+
+          describe "client" do
+            it "should increment counters correctly when sending a message" do
+              @client.packets_sent.should eq 1
+              @client.bytes_sent.should eq @packet_length_with_header
+            end
+          end
+
+          describe "server" do
+            it "should increment counters correctly when receiving a message" do
+              @server.packets_received.should eq 1
+              @server.bytes_received.should eq @packet_length_with_header
+            end
+          end
+        end
+
+        describe "server to client"  do
+          before :each do
+            @server.update
+            @server.send_msg(@server.sockets[0], @packet)
+            @client.update
+          end
+
+          describe "server" do
+            it "should increment sent counters" do
+              @server.packets_sent.should eq 1
+              @server.bytes_sent.should eq @packet_length_with_header
+            end
+          end
+
+          describe "client" do
+            it "should increment received counters" do
+              @client.packets_received.should eq 1
+              @client.bytes_received.should eq @packet_length_with_header
+              @client2.packets_received.should eq 0
+              @client2.bytes_received.should eq 0
+            end
+          end
+        end
+
+        describe "server to clients"  do
+          before :each do
+            @server.update
+            @server.broadcast_msg(@packet)
+            @client.update
+            @client2.update
+          end
+
+          describe "server" do
+            it "should increment sent counters" do
+              # Single message, broadcast to two clients.
+              @server.packets_sent.should eq 2
+              @server.bytes_sent.should eq @packet_length_with_header * 2
+            end
+          end
+
+          describe "clients" do
+            it "should increment received counters" do
+              [@client, @client2].each do |client|
+                client.packets_received.should eq 1
+                client.bytes_received.should eq @packet_length_with_header
+              end
+            end
+          end
+        end
+      end
     end
   end
 end