chingu 0.8.1 → 0.9rc1

data/README.rdoc

@@ -776,6 +776,34 @@ Adds class and instance methods for basic collision detection.
     # do something
   end
   
+==== Trait "asynchronous"
+Allows your code to specify a GameObject's behavior asynchronously, including
+tweening, movement and even method calls. Tasks are added to a queue to be
+processed in order; the task at the front of the queue is updated each tick
+and removed when it has finished.
+
+  # Simple one-trick example
+  # This will cause an object to move from its current location to 64,64.
+  @guy.async.tween :x => 64, :y => 64
+  
+  # Block syntax example
+  # This will cause a line of text to fade out and vanish.
+  Chingu::Text.trait :asynchronous
+  message = Chingu::Text.new 'Goodbye, World!'
+  message.async do |q|
+    q.wait 500
+    q.tween 2000, :alpha => 0, :scale => 2
+    q.call :destroy
+  end
+
+Currently available tasks are wait(timeout, &condition), tween(timeout,
+properties), call(method, *arguments) and exec { ... }.
+
+For a more complete example of how to use this trait, see
+examples/example_async.rb.
+
+
+
 ==== (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

@@ -14,7 +14,7 @@ begin
     gemspec.rubyforge_project = "chingu"
     gemspec.version = Chingu::VERSION
     
-    gemspec.add_dependency 'gosu', '>= 0.7.25'
+    gemspec.add_dependency 'gosu', '>= 0.7.27'
     gemspec.add_dependency 'rest-client'
     gemspec.add_dependency 'crack'    
     gemspec.add_development_dependency 'rspec', '>= 2.1.0'

data/benchmarks/benchmark_ping_localhost.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require File.join(File.dirname($0), "..", "lib", "chingu")
+include Gosu
+include Chingu
+
+#
+# Simple
+#
+class Game < Chingu::Window
+  
+  def setup
+    on_input(:esc, :exit)
+    
+    @client = Client.new
+    @server = Server.new
+    
+    @server.start("0.0.0.0", 1234)
+    @client.connect("127.0.0.1", 1234)
+  end
+  
+  def update
+    @client.update
+    @client.update_trait
+    @server.update
+    @server.update_trait
+  end
+  
+end
+
+#
+# Our Client. We inherit from Chingu::GameStates::NetworkClient
+#
+class Client < GameStates::NetworkClient
+  trait :timer
+  
+  def on_connect
+    $window.caption = "[CONNECTED]"
+    send_msg(:timestamp => Gosu::milliseconds)
+    every(1000) { send_msg(:timestamp => Gosu::milliseconds) }
+  end
+  
+  def on_msg(msg)
+    latency = (Gosu::milliseconds - msg[:timestamp])
+    #puts "PONG: #{latency}ms"
+    $window.caption = "PONG: #{latency}ms"
+  end
+  
+end
+
+#
+# Our Server. We inherit from Chingu::GameStates::NetworkServer
+#
+class Server < GameStates::NetworkServer
+  
+  def on_msg(socket, msg)
+    #puts "PING: #{msg[:timestamp]}"
+    send_msg(socket, {:timestamp => msg[:timestamp]})
+  end
+  
+end
+
+Game.new.show

data/chingu.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chingu}
-  s.version = "0.8.1"
+  s.version = "0.9rc1"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["ippa"]
-  s.date = %q{2011-01-08}
+  s.date = %q{2011-02-20}
   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 = [
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     "benchmarks/benchmark4.rb",
     "benchmarks/benchmark5.rb",
     "benchmarks/benchmark6.rb",
+    "benchmarks/benchmark_ping_localhost.rb",
     "benchmarks/game_object_list_benchmark.rb",
     "benchmarks/game_objects_benchmark.rb",
     "benchmarks/lookup_benchmark.rb",
@@ -60,6 +61,8 @@ Gem::Specification.new do |s|
     "examples/example25_fibers_state_machine.rb",
     "examples/example26_splash_screen.rb",
     "examples/example27_console.rb",
+    "examples/example28_networking.rb",
+    "examples/example29_asynchronous.rb",
     "examples/example2_gamestate_basics.rb",
     "examples/example3_parallax.rb",
     "examples/example4_gamestates.rb",
@@ -118,10 +121,20 @@ Gem::Specification.new do |s|
     "lib/chingu.rb",
     "lib/chingu/animation.rb",
     "lib/chingu/assets.rb",
+    "lib/chingu/async/basic_task.rb",
+    "lib/chingu/async/task_builder.rb",
+    "lib/chingu/async/task_list.rb",
+    "lib/chingu/async_tasks/call.rb",
+    "lib/chingu/async_tasks/exec.rb",
+    "lib/chingu/async_tasks/move.rb",
+    "lib/chingu/async_tasks/parallel.rb",
+    "lib/chingu/async_tasks/tween.rb",
+    "lib/chingu/async_tasks/wait.rb",
     "lib/chingu/basic_game_object.rb",
     "lib/chingu/classic_game_object.rb",
     "lib/chingu/console.rb",
     "lib/chingu/core_ext/array.rb",
+    "lib/chingu/core_ext/range.rb",
     "lib/chingu/fpscounter.rb",
     "lib/chingu/game_object.rb",
     "lib/chingu/game_object_list.rb",
@@ -132,6 +145,8 @@ Gem::Specification.new do |s|
     "lib/chingu/game_states/edit.rb",
     "lib/chingu/game_states/enter_name.rb",
     "lib/chingu/game_states/fade_to.rb",
+    "lib/chingu/game_states/network_client.rb",
+    "lib/chingu/game_states/network_server.rb",
     "lib/chingu/game_states/pause.rb",
     "lib/chingu/game_states/popup.rb",
     "lib/chingu/gosu_ext/image.rb",
@@ -155,6 +170,7 @@ Gem::Specification.new do |s|
     "lib/chingu/simple_menu.rb",
     "lib/chingu/text.rb",
     "lib/chingu/traits/animation.rb",
+    "lib/chingu/traits/asynchronous.rb",
     "lib/chingu/traits/bounding_box.rb",
     "lib/chingu/traits/bounding_circle.rb",
     "lib/chingu/traits/collision_detection.rb",
@@ -214,6 +230,8 @@ Gem::Specification.new do |s|
     "examples/example25_fibers_state_machine.rb",
     "examples/example26_splash_screen.rb",
     "examples/example27_console.rb",
+    "examples/example28_networking.rb",
+    "examples/example29_asynchronous.rb",
     "examples/example2_gamestate_basics.rb",
     "examples/example3_parallax.rb",
     "examples/example4_gamestates.rb",
@@ -250,14 +268,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<gosu>, [">= 0.7.25"])
+      s.add_runtime_dependency(%q<gosu>, [">= 0.7.27"])
       s.add_runtime_dependency(%q<rest-client>, [">= 0"])
       s.add_runtime_dependency(%q<crack>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 2.1.0"])
       s.add_development_dependency(%q<watchr>, [">= 0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
-      s.add_dependency(%q<gosu>, [">= 0.7.25"])
+      s.add_dependency(%q<gosu>, [">= 0.7.27"])
       s.add_dependency(%q<rest-client>, [">= 0"])
       s.add_dependency(%q<crack>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 2.1.0"])
@@ -265,7 +283,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<gosu>, [">= 0.7.25"])
+    s.add_dependency(%q<gosu>, [">= 0.7.27"])
     s.add_dependency(%q<rest-client>, [">= 0"])
     s.add_dependency(%q<crack>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 2.1.0"])

data/examples/example12_trait_timer.rb

@@ -24,7 +24,11 @@ class Cube < GameObject
   def initialize(options)
     super
     self.input = {  :left => :left, :right => :right, :up => :up, :down => :down, 
-                    :space => :shake1, :return => :shake2 }
+                    :space => :shake1, :return => :shake2, :a => :test_after }
+  end
+  
+  def test_after
+    after(1000) { @color = Color::CYAN }
   end
   
   def left

data/examples/example28_networking.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require File.join(File.dirname($0), "..", "lib", "chingu")
+include Gosu
+include Chingu
+
+#
+# Simple
+#
+class Game < Chingu::Window
+  
+  def setup
+    on_input(:esc, :exit)
+    
+    @client = Client.new
+    @server = Server.new
+    
+    @server.start("0.0.0.0", 1234)
+    @client.connect("127.0.0.1", 1234)
+  end
+  
+  def update
+    #
+    # Since we have 2 games states going we don't switch to them ( i.e. push_game_state @server )
+    # Rather we just call #update manually so they can do their thing. 
+    #
+    # Server#update will poll incoming connections, handle sockets and read/parse incomong data.
+    # Client#update will read/parse incoming data, send output.
+    #
+    @client.update  
+    @server.update
+  end
+  
+end
+
+#
+# Our Client. We inherit from Chingu::GameStates::NetworkClient
+#
+class Client < GameStates::NetworkClient
+  
+  def on_connect
+    puts "[#{self.ip}] Connected! Sending a msg..."
+    send_msg(:hi => :there)
+  end
+  
+  #
+  # Only 1 argument, the msg, since client only does 1 connecion (the one to the server)
+  #
+  def on_msg(msg)
+    puts "Client Got: #{msg.inspect}"
+  end
+  
+end
+
+#
+# Our Server. We inherit from Chingu::GameStates::NetworkServer
+#
+class Server < GameStates::NetworkServer
+  
+  #
+  # Overload on_msg callback in server to make something happen
+  # Servers #on_msg takes 2 arguments, since server can handle many clients
+  #
+  def on_connect(socket)
+    send_msg(socket, {:hi => :there})
+  end
+  
+  def on_msg(socket, msg)
+    puts "Server Got: #{msg.inspect}"
+    send_msg(socket, {:woff => :mjau, :numbers => [1,2,3]})
+  end
+  
+end
+
+Game.new.show

data/examples/example29_asynchronous.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+require 'rubygems' rescue nil
+$LOAD_PATH.unshift File.join(File.expand_path(__FILE__), "..", "..", "lib")
+require 'chingu'
+include Gosu
+include Chingu
+$stderr.sync = $stdout.sync = true
+
+Chingu::Text.trait :asynchronous
+
+class BadGuy < Chingu::GameObject
+  trait :asynchronous
+  
+  def fire!
+    # Create a text object to represent shooting sounds.
+    text = Chingu::Text.create("Pew!", :x => x, :y => y - height)
+    
+    # Now, make that text object fade out and disappear asynchronously.
+    text.async do |q|
+      q.tween(750, :alpha => 0, :scale => 2)
+      q.call :destroy
+    end
+  end
+  
+end
+
+class Game < Chingu::Window
+  
+  def initialize
+    super 480, 240, false
+    
+    self.caption = "Press [SPACE] to run the demo"
+    
+    # Create our bad guy!
+    @boss = BadGuy.create :image => 'Starfighter.bmp'
+    
+    # Instruct the boss to move along a path while rotating clockwise.
+    # Nothing is actually done until the run loop calls #update.
+    @boss.async do |q|
+      # These tasks are performed sequentially and asynchronously
+      # using the magic of queues. Each GameObject has its own!
+      q.wait { button_down? Gosu::KbSpace }
+      q.tween(1000, :x => 100, :y => 100, :angle => 45)
+      q.tween(1000, :y => 200, :angle => 90)
+      q.call :fire!
+    end
+    
+    # Single tasks can also be given with a less verbose syntax.
+    # Wait a second...
+    @boss.async.wait 1000
+    
+    # Move and fire one more time, just for good measure.
+    @boss.async do |q|
+      q.tween(1000, :x => 200, :y => 100, :angle => 360)
+      3.times do
+        q.wait 500
+        q.call :fire!
+      end
+    end
+    
+  end
+  
+end
+
+Game.new.show

data/lib/chingu.rb

@@ -34,10 +34,12 @@ require File.join(CHINGU_ROOT,"chingu","require_all") # Thanks to http://github.
 # and GameObject to get the correct class_inheritable_accssor
 require_all "#{CHINGU_ROOT}/chingu/helpers"
 require_all "#{CHINGU_ROOT}/chingu/traits"
+require_all "#{CHINGU_ROOT}/chingu/async"
+require_all "#{CHINGU_ROOT}/chingu/async_tasks"
 require_all "#{CHINGU_ROOT}/chingu"
 
 module Chingu
-  VERSION = "0.8.1"
+  VERSION = "0.9rc1"
   
   DEBUG_COLOR = Gosu::Color.new(0xFFFF0000)
   DEBUG_ZORDER = 9999

data/lib/chingu/async/basic_task.rb

@@ -0,0 +1,46 @@
+#--
+#
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
+# Copyright (C) 2009 ippa / ippa@rubylicio.us
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+
+require 'weakref'
+
+module Chingu
+  module Async
+    
+    class BasicTask
+      
+      def initialize
+      end
+      
+      #
+      # Returns true if the task has finished executing. The meaning of
+      # "finished" is determined by the particular subclass.
+      #
+      def finished?
+        true
+      end
+      
+      def update(object)
+      end
+      
+    end
+    
+  end
+end

data/lib/chingu/async/task_builder.rb

@@ -0,0 +1,71 @@
+#--
+#
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
+# Copyright (C) 2009 ippa / ippa@rubylicio.us
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+
+module Chingu
+  module Async
+    
+    #
+    # Implements a DSL for appending new tasks to an task queue.
+    #
+    class TaskBuilder
+      def initialize(tasks)
+        @tasks = tasks
+      end
+      
+      #
+      # Add a new task to the queue. The first argument is a Symbol or
+      # String naming the type of task; remaining arguments are passed
+      # on to the task's constructor.
+      # 
+      # If a block is supplied, it is scheduled to be executed as soon as the
+      # task is finished.
+      #
+      def task(task, *args, &block)
+        case task
+        when Symbol, String
+          klass_name = Chingu::Inflector.camelize(task)
+          klass = Chingu::AsyncTasks.const_get(klass_name)
+          
+          task = klass.new(*args, &block)
+          
+        when Chingu::Async::BasicTask
+          # pass
+          
+        when Class
+          task = task.new(*args, &block)
+          
+        else raise TypeError, "task must be a Task object or task name"
+        end
+        
+        @tasks.enq(task)
+        task
+      end
+      
+      #
+      # Attempting to invoke a nonexistant method automatically calls
+      # +task+ with the method name as the task type.
+      #
+      alias :method_missing :task
+      
+    end
+    
+  end
+end