chingu 0.7.6.4 → 0.7.6.5

data/.gitignore

@@ -1,4 +1,5 @@
-*.gem
-pkg
+*.gem
+pkg
 .gem
-.git
+.git
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/README.rdoc

@@ -153,7 +153,7 @@ You're probably familiar with this very common Gosu pattern:
   Game.new.show   # Start the Game update/draw loop!
 
 
-Chingu doesn't change the fundamental concept/flow of Gosu, but it will make the above code cleaner:
+Chingu doesn't change the fundamental concept/flow of Gosu, but it will make the above code shorter:
   
   #
   # We use Chingu::Window instead of Gosu::Window
@@ -175,7 +175,7 @@ Chingu doesn't change the fundamental concept/flow of Gosu, but it will make the
   # The accessors image,x,y,zorder,angle,factor_x,factor_y,center_x,center_y,mode,alpha.
   # We also get a default #draw which draws the image to screen with the parameters listed above.
   # You might recognize those from #draw_rot - http://www.libgosu.org/rdoc/classes/Gosu/Image.html#M000023
-  # And in it's core, that's what Chingu::GameObject is, an encapsulation of draw_rot with some extra cheese.
+  # And in it's core, that's what Chingu::GameObject is, an encapsulation of draw_rot with some extras.
   # For example, we get automatic calls to draw/update with Chingu::GameObject, which usually is what you want. 
   # You could stop this by doing: @player = Player.new(:draw => false, :update => false)
   #
@@ -529,40 +529,40 @@ yes you guessed it, as class methods. If initialize_trait is defined inside Clas
 
 A simple trait could be:
 
-module Chingu
-  module Trait
-    module Inspect
+  module Chingu
+    module Trait
+      module Inspect
     
-      #
-      # methods namespaced to ClassMethods get's extended as ... class methods!
-      #
-      module ClassMethods
-        def initialize_trait(options)
+        #
+        # methods namespaced to ClassMethods get's extended as ... class methods!
+        #
+        module ClassMethods
+          def initialize_trait(options)
             # possible initialize stuff here
+          end
+        
+          def inspect
+            "There's {self.size} active instances of class {self.to_s}"
+          end
         end
       
+        #
+        # Namespaced outside ClassMethods get's included as normal instance-methods
+        #
         def inspect
-          "There's {self.size} active instances of class {self.to_s}"
+          "Hello I'm an #{self.class.to_s}"
         end
-      end
       
-      #
-      # Namespaced outside ClassMethods get's included as normal instance-methods
-      #
-      def inspect
-        "Hello I'm an #{self.class.to_s}"
       end
-      
     end
   end
-end
 
-class Enemy < GameObject
-  trait :inspect    # includes Chingu::Trait::Inspect and extends Chingu::Trait::Inspect::ClassMethods
-end
-10.times { Enemy.create }
-Enemy.inspect           # => "There's 10 active instances of class Enemy"
-Enemy.all.first.inspect # => "Hello I'm a Enemy"
+  class Enemy < GameObject
+    trait :inspect    # includes Chingu::Trait::Inspect and extends Chingu::Trait::Inspect::ClassMethods
+  end
+  10.times { Enemy.create }
+  Enemy.inspect           # => "There's 10 active instances of class Enemy"
+  Enemy.all.first.inspect # => "Hello I'm a Enemy"
 
 
 Example of using traits :velocity and :timer:
@@ -621,7 +621,7 @@ Adds accessors velocity_x, velocity_y, acceleration_x, acceleration_y, max_veloc
 They modify x, y as you would expect. *speed / angle will come*
 
 ==== Trait "bounding_box"
-Adds accessor 'bounding_box', which returns a Rect based on current image size,x,y,factor_x,factor_y,center_x,center_y
+Adds accessor 'bounding_box', which returns an instance of class Rect based on current image size,x,y,factor_x,factor_y,center_x,center_y
 You can also scale the calculated rect with trait-options:
 
   # This would return a rect slightly smaller then the image. 
@@ -631,6 +631,8 @@ You can also scale the calculated rect with trait-options:
   # Make the bounding box bigger then the image
   # :debug => true shows the actual box in red on the screen
   trait :bounding_box, :scale => 1.5, :debug => true
+  
+Inside your object you will also get a cache_bounding_box(). After that the bounding_box will be quicker but it will not longer adapt to size-changes.
 
 ==== Trait "bounding_circle"
 Adds accessor 'radius', which returns a Fixnum based on current image size,factor_x and factor_y
@@ -642,6 +644,8 @@ You can also scale the calculated radius with trait-options:
   # :debug => true shows the actual circle in red on the screen
   trait :bounding_circle, :debug => true
 
+Inside your object you will also get a cache_bounding_circle(). After that radius() will be quicker but it will not longer adapt to size-changes.
+
 ==== Trait "animation"
 Automatically load animations depending on the class-name.
 Useful when having a lot of simple classes thats mainpurpose is displaying an animation.
@@ -658,19 +662,25 @@ Assuming the below code is included in a class FireBall.
   # 
 	# The below example will set the 200ms delay between each frame on all animations loaded.
   #
-  trait :automatic_assets, :delay => 200
+  trait :animation, :delay => 200
 
 ==== Trait "effect"
 Adds accessors rotation_rate, fade_rate and scale_rate to game object.
 They modify angle, alpha and factor_x/factor_y each update. Since this is pretty easy to do yourself this trait might be up for deprecation.
 
-==== (IN DEVELOPMENT) Trait "viewport"
+==== Trait "viewport"
 A game state trait. Adds accessor *viewport*. Set viewport.x and viewport.y to.
 Basically what viewport.x = 10 will do is draw all game objects 10 pixels to the left of their ordinary position.
 Since the viewport has moved 10 pixels to the right, the game objects will be seen "moving" 10 pixels to the left.
-This is great for scrolling games.
+This is great for scrolling games. You also have:
+
+  viewport.game_area = [0,0,1000,400]   # Set scrolling limits, the effective game world if you so will
+  viewport.center_around(object)        # Center viweport around an object which responds to x() and y()
+  
+  viewport.lag      = 0.95              # Set a lag-factor to use in combination with x_target / y_target
+  viewport.x_target = 100               # This will move viewport towards X-coordinate 100, the speed is determined by the lag-parameter.
 
-==== (IN DEVELOPMENT) Trait "collision_detection"
+==== Trait "collision_detection"
 Adds class and instance methods for basic collision detection.
   
   # Class method example
@@ -689,11 +699,16 @@ Adds class and instance methods for basic collision detection.
   # Since You're not explicity telling what collision type to use it might be slighty slower.
   #
   [Player, PlayerBullet].each_collision(Enemy, EnemyBullet) do |friend, foe|
+    # do something
+  end
   
+  #
+  # You can also give each_collision() an array of objects.
+  #
+  Ball.each_collsion(@array_of_ground_items) do |ball, ground|
+    # do something
   end
-
-* API isn't stabilized yet! *
-
+  
 ==== (IN DEVELOPMENT) Trait "retrofy"
 Providing easier handling of the "retrofy" effect (non-blurry zoom)
 Aims to help out when using zoom-factor to create a retrofeeling with big pixels.

data/Rakefile

@@ -1,22 +1,42 @@
-require 'rubygems'
-require File.dirname(__FILE__) + '/lib/chingu'
-include Chingu
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "chingu"
-    gemspec.summary = "OpenGL accelerated 2D game framework for Ruby"
-    gemspec.description = "OpenGL accelerated 2D game framework for Ruby. Builds on Gosu (Ruby/C++) which provides all the core functionality. Chingu adds simple yet powerful game states, prettier input handling, deployment safe asset-handling, a basic re-usable game object and stackable game logic."
-    gemspec.email = "ippa@rubylicio.us"
-    gemspec.homepage = "http://github.com/ippa/chingu"
-    gemspec.authors = ["ippa"]
-    gemspec.rubyforge_project = "chingu"
-    gemspec.version = Chingu::VERSION
-    
-    gemspec.add_dependency 'gosu', '>= 0.7.22'
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
+require 'rubygems'
+require File.dirname(__FILE__) + '/lib/chingu'
+include Chingu
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "chingu"
+    gemspec.summary = "OpenGL accelerated 2D game framework for Ruby"
+    gemspec.description = "OpenGL accelerated 2D game framework for Ruby. Builds on Gosu (Ruby/C++) which provides all the core functionality. Chingu adds simple yet powerful game states, prettier input handling, deployment safe asset-handling, a basic re-usable game object and stackable game logic."
+    gemspec.email = "ippa@rubylicio.us"
+    gemspec.homepage = "http://github.com/ippa/chingu"
+    gemspec.authors = ["ippa"]
+    gemspec.rubyforge_project = "chingu"
+    gemspec.version = Chingu::VERSION
+    
+    gemspec.add_dependency 'gosu', '>= 0.7.22'
+    gemspec.add_development_dependency 'rspec', '>= 2.0.0.beta.12'
+    gemspec.add_development_dependency 'watchr'
+    gemspec.add_development_dependency 'rcov'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+# Rake RSpec2 task stuff
+gem 'rspec', '>= 2.0.0.beta.12'
+
+require 'rspec/core/rake_task'
+
+desc "Run the specs under spec"
+RSpec::Core::RakeTask.new do |t|
+end
+
+desc "Run the specs with rcov (for some reason always reports wrong code coverage)"
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rcov_opts = ['-T', '--no-html', '--exclude spec,gem']
+end
+
+task :default => :spec

data/chingu.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chingu}
-  s.version = "0.7.6.4"
+  s.version = "0.7.6.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["ippa"]
-  s.date = %q{2010-06-19}
+  s.date = %q{2010-06-22}
   s.description = %q{OpenGL accelerated 2D game framework for Ruby. Builds on Gosu (Ruby/C++) which provides all the core functionality. Chingu adds simple yet powerful game states, prettier input handling, deployment safe asset-handling, a basic re-usable game object and stackable game logic.}
   s.email = %q{ippa@rubylicio.us}
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".gitignore",
+     ".rspec",
      "History.txt",
      "LICENSE",
      "README.rdoc",
@@ -144,7 +145,14 @@ Gem::Specification.new do |s|
      "lib/chingu/traits/velocity.rb",
      "lib/chingu/traits/viewport.rb",
      "lib/chingu/viewport.rb",
-     "lib/chingu/window.rb"
+     "lib/chingu/window.rb",
+     "spec/chingu/fpscounter_spec.rb",
+     "spec/chingu/game_object_spec.rb",
+     "spec/chingu/inflector_spec.rb",
+     "spec/chingu/rect_20x20.png",
+     "spec/chingu/text_spec.rb",
+     "spec/spec_helper.rb",
+     "specs.watchr"
   ]
   s.homepage = %q{http://github.com/ippa/chingu}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -153,7 +161,12 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{OpenGL accelerated 2D game framework for Ruby}
   s.test_files = [
-    "examples/example10_traits_retrofy.rb",
+    "spec/chingu/fpscounter_spec.rb",
+     "spec/chingu/game_object_spec.rb",
+     "spec/chingu/inflector_spec.rb",
+     "spec/chingu/text_spec.rb",
+     "spec/spec_helper.rb",
+     "examples/example10_traits_retrofy.rb",
      "examples/example11_animation.rb",
      "examples/example12_trait_timer.rb",
      "examples/example13_high_scores.rb",
@@ -185,11 +198,20 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<gosu>, [">= 0.7.22"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.12"])
+      s.add_development_dependency(%q<watchr>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<gosu>, [">= 0.7.22"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.12"])
+      s.add_dependency(%q<watchr>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
     s.add_dependency(%q<gosu>, [">= 0.7.22"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.12"])
+    s.add_dependency(%q<watchr>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
   end
 end
 

data/examples/example21.yml

@@ -2,7 +2,7 @@
 - CogWheel: 
     :x: 1088.0
     :y: 352.0
-    :angle: 261.503276348003
+    :angle: 89.6056498795325
     :zorder: 95
     :factor_x: 1.68525252525252
     :factor_y: 1.68525252525252
@@ -10,7 +10,7 @@
 - CogWheel: 
     :x: 448.0
     :y: 416.0
-    :angle: 213.943880498079
+    :angle: 25.84150696655
     :zorder: 88
     :factor_x: 1.68525252525252
     :factor_y: 1.68525252525252
@@ -938,7 +938,7 @@
 - CogWheel: 
     :x: 1792.0
     :y: 320.0
-    :angle: 182.497282580259
+    :angle: 354.39490904873
     :zorder: 95
     :factor_x: 1.68525252525252
     :factor_y: 1.68525252525252
@@ -954,7 +954,7 @@
 - CogWheel: 
     :x: 2464.0
     :y: 288.0
-    :angle: 14.156596894522
+    :angle: 202.258970426051
     :zorder: 95
     :factor_x: 1.68525252525252
     :factor_y: 1.68525252525252
@@ -962,7 +962,7 @@
 - CogWheel: 
     :x: 2460.0
     :y: 960.0
-    :angle: 184.497282580259
+    :angle: 356.39490904873
     :zorder: 95
     :factor_x: 1.68525252525252
     :factor_y: 1.68525252525252
@@ -1073,40 +1073,40 @@
     :color: 4294967295
 - Saw: 
     :x: 2304.0
-    :y: 42973.9722397467
-    :angle: 148.973186119936
+    :y: 42976.1107255511
+    :angle: 261.473186119936
     :zorder: 100
     :factor_x: 0.317794486215539
     :factor_y: 0.320401002506266
     :color: 4294967295
 - Saw: 
     :x: 2016.0
-    :y: 32173.9806240522
-    :angle: 341.066180171485
+    :y: 32175.484146951
+    :angle: 208.138399597758
     :zorder: 100
     :factor_x: 0.398395989974937
     :factor_y: 0.401002506265664
     :color: 4294967295
 - Saw: 
     :x: 1696.0
-    :y: 14500.9946086338
-    :angle: 51.8801650144799
+    :y: 14501.0352990104
+    :angle: 324.163114805279
     :zorder: 100
     :factor_x: 0.958395989974934
     :factor_y: 0.961002506265664
     :color: 4294967295
 - Saw: 
     :x: 1056.0
-    :y: 24036.9954416873
-    :angle: 324.855862936146
+    :y: 24037.5592580972
+    :angle: 15.9317824583088
     :zorder: 100
     :factor_x: 0.637794486215539
     :factor_y: 0.640401002506266
     :color: 4294967295
 - Saw: 
     :x: 1344.0
-    :y: 24036.9954416873
-    :angle: 327.855862936147
+    :y: 24037.5592580972
+    :angle: 18.9317824583097
     :zorder: 100
     :factor_x: 0.637794486215539
     :factor_y: 0.640401002506266
@@ -1361,72 +1361,72 @@
     :color: 4294967295
 - Saw: 
     :x: 2176.0
-    :y: 42813.9722397467
-    :angle: 151.973186119936
+    :y: 42816.1107255511
+    :angle: 264.473186119936
     :zorder: 100
     :factor_x: 0.317794486215539
     :factor_y: 0.320401002506266
     :color: 4294967295
 - Saw: 
     :x: 1280.0
-    :y: 30824.098278027
-    :angle: 268.052196057188
+    :y: 30825.187526242
+    :angle: 100.11960470903
     :zorder: 100
     :factor_x: 0.47739348370927
     :factor_y: 0.48
     :color: 4294967295
 - Saw: 
     :x: 1055.0
-    :y: 91481.6743590043
-    :angle: 19.6523317612529
+    :y: 91487.0519231069
+    :angle: 340.565793299832
     :zorder: 100
     :factor_x: 0.156390977443606
     :factor_y: 0.158997493734336
     :color: 4294967295
 - Saw: 
     :x: 960.0
-    :y: 91545.6743590044
-    :angle: 22.6523317612509
+    :y: 91551.051923107
+    :angle: 343.56579329983
     :zorder: 100
     :factor_x: 0.156390977443606
     :factor_y: 0.158997493734336
     :color: 4294967295
 - Saw: 
     :x: 1120.0
-    :y: 91545.6743590044
-    :angle: 22.6523317612509
+    :y: 91551.051923107
+    :angle: 343.56579329983
     :zorder: 100
     :factor_x: 0.156390977443606
     :factor_y: 0.158997493734336
     :color: 4294967295
 - Saw: 
     :x: 864.0
-    :y: 91481.6743590043
-    :angle: 25.6523317612509
+    :y: 91487.0519231069
+    :angle: 346.56579329983
     :zorder: 100
     :factor_x: 0.156390977443606
     :factor_y: 0.158997493734336
     :color: 4294967295
 - Saw: 
     :x: 1247.0
-    :y: 27755.9489495749
-    :angle: 283.946457785343
+    :y: 27757.0390756253
+    :angle: 116.850869550061
     :zorder: 100
     :factor_x: 0.477192982456137
     :factor_y: 0.479799498746867
     :color: 4294967295
 - Saw: 
     :x: 1088.0
-    :y: 54674.3885593251
-    :angle: 243.763506646168
+    :y: 54677.6042372912
+    :angle: 303.350371053014
     :zorder: 100
     :factor_x: 0.236591478696738
     :factor_y: 0.239197994987469
     :color: 4294967295
 - Saw: 
     :x: 960.0
-    :y: 54674.3885593251
-    :angle: 246.763506646169
+    :y: 54677.6042372912
+    :angle: 306.350371053015
     :zorder: 100
     :factor_x: 0.236591478696738
     :factor_y: 0.239197994987469
@@ -1545,88 +1545,88 @@
     :color: 4294967295
 - Saw: 
     :x: 2272.0
-    :y: 1545.89456467036
-    :angle: 146.639909411433
+    :y: 1337.55913437343
+    :angle: 13.7121288377064
     :zorder: 100
     :factor_x: 0.398395989974937
     :factor_y: 0.401002506265664
     :color: 4294967295
 - Saw: 
     :x: 1792.0
-    :y: 1492.18378106955
-    :angle: 352.539543057765
+    :y: 1388.25144363545
+    :angle: 103.378734621911
     :zorder: 100
     :factor_x: 0.79859649122807
     :factor_y: 0.801203007518797
     :color: 4294967295
 - Saw: 
     :x: 2112.0
-    :y: 1472.55311973017
-    :angle: 50.5639527921968
+    :y: 1307.53499156828
+    :angle: 89.8156391328329
     :zorder: 100
     :factor_x: 0.237794486215539
     :factor_y: 0.240401002506266
     :color: 4294967295
 - Saw: 
     :x: 1504.0
-    :y: 1475.21132713439
-    :angle: 4.15384615445959
+    :y: 1301.3453085376
+    :angle: 53.5473372787263
     :zorder: 100
     :factor_x: 0.23719298245614
     :factor_y: 0.239799498746867
     :color: 4294967295
 - Saw: 
     :x: 1344.0
-    :y: 1470.10650887575
-    :angle: 7.15384615446169
+    :y: 1304.67244294168
+    :angle: 56.5473372787284
     :zorder: 100
     :factor_x: 0.23719298245614
     :factor_y: 0.239799498746867
     :color: 4294967295
 - Saw: 
     :x: 1152.0
-    :y: 1442.5380388842
-    :angle: 10.1538461544596
+    :y: 1336.12764158919
+    :angle: 59.5473372787263
     :zorder: 100
     :factor_x: 0.23719298245614
     :factor_y: 0.239799498746867
     :color: 4294967295
 - Saw: 
     :x: 992.0
-    :y: 1484.67432950191
-    :angle: 30.4853091222945
+    :y: 1465.56513409961
+    :angle: 328.10025165105
     :zorder: 100
     :factor_x: 0.156992481203007
     :factor_y: 0.159598997493734
     :color: 4294967295
 - Saw: 
     :x: 800.0
-    :y: 1484.67432950191
-    :angle: 33.4853091222945
+    :y: 1465.56513409961
+    :angle: 331.10025165105
     :zorder: 100
     :factor_x: 0.156992481203007
     :factor_y: 0.159598997493734
     :color: 4294967295
 - Saw: 
     :x: 1248.0
-    :y: 1538.26656151419
-    :angle: 184.999590383916
+    :y: 1528.82649842271
+    :angle: 297.499590383916
     :zorder: 100
     :factor_x: 0.317794486215539
     :factor_y: 0.320401002506266
     :color: 4294967295
 - Saw: 
     :x: 928.0
-    :y: 1516.67432950192
-    :angle: 36.4853091222945
+    :y: 1497.56513409962
+    :angle: 334.10025165105
     :zorder: 100
     :factor_x: 0.156992481203007
     :factor_y: 0.159598997493734
     :color: 4294967295
 - Saw: 
     :x: 672.0
-    :y: 1454.14495530015
-    :angle: 33.4853091222945
+    :y: 1384.07790549172
+    :angle: 331.10025165105
     :zorder: 100
     :factor_x: 0.156992481203007
     :factor_y: 0.159598997493734