rugui 1.4.3 → 1.5.0

data/Changelog

@@ -1,3 +1,6 @@
+1.5.0
+- Added basic support for Rubygame as a framework adapter.
+
 1.4.3
 - Fixing options in rugui generator
 - Removing dependency on jeweler for gem release

data/README.rdoc

@@ -23,6 +23,12 @@ has made it possible to write a QT adapter and now it is possible to use all of
 the RuGUI features together with QT. As the framework evolve other framework
 adapters may be written, enabling the use of RuGUI with any other GUI frameworks.
 
+A basic support for building Rubygame applications was also added. It is still
+missing some functionality like signal connections and widget creation but it is
+usable. By using RuGUI you will gain a template directory structure as well some
+of the features of RuGUI, like configuration, a shell script for running your
+game, support for rspec and test-unit, etc.
+
 == Instalation
 
 Install the gem:
@@ -41,10 +47,12 @@ on the ActiveSupport gem, which can be installed by:
 
   gem install activesupport
 
-To be able to generate applications and controllers/models/views, you will need
-the rubigen gem, which can be installed by:
+Also the rugui generator uses thor, so you will also need to install it:
+
+  gem install thor
 
-  gem install rubigen
+Both gems should be installed when installing rugui gem, so you probably won't
+need to do this.
 
 == Generating an Application
 

data/lib/rugui/framework_adapters/Rubygame.rb

@@ -0,0 +1,233 @@
+require 'rubygame'
+
+Rubygame::TTF.setup if defined?(Rubygame::TTF)
+
+module RuGUI
+  module FrameworkAdapters
+    module Rubygame
+      class BaseController < RuGUI::FrameworkAdapters::BaseFrameworkAdapter::BaseController
+        def queue(&block)
+          block.call
+        end
+      end
+
+      class BaseMainController < RuGUI::FrameworkAdapters::Rubygame::BaseController
+        def run
+          catch :quit do
+            loop do
+              self.adapted_object.step
+            end
+          end
+        end
+
+        def refresh
+        end
+
+        def quit
+          throw :quit
+          Rubygame.quit
+        end
+      end
+
+      class BaseView < RuGUI::FrameworkAdapters::BaseFrameworkAdapter::BaseView
+        # Queues the block call, so that it is only gets executed in the main thread.
+        def queue(&block)
+          block.call
+        end
+
+        # Connects the signal from the widget to the given receiver block.
+        # The block is executed in the context of the receiver.
+        def connect_declared_signal_block(widget, signal, receiver, block)
+        end
+
+        # Connects the signal from the widget to the given receiver method.
+        def connect_declared_signal(widget, signal, receiver, method)
+        end
+
+        # Builds widgets from the given filename, using the proper builder.
+        def build_widgets_from(filename)
+        end
+
+        # Registers widgets as attributes of the view class.
+        def register_widgets
+        end
+
+        class << self
+          # Returns the builder file extension to be used for this view class.
+          def builder_file_extension
+          end
+        end
+      end
+    end
+  end
+end
+
+module RuGUI
+  class BaseController < BaseObject
+    include Rubygame::EventHandler::HasEventHandler
+  end
+
+  class BaseMainController < BaseController
+    attr_accessor :screen
+
+    def initialize
+      super
+
+      setup_clock
+      setup_event_queue
+      setup_screen
+      setup_quit_events
+      setup_autoload_resources
+      setup_main_view_screen
+    end
+
+    def step
+      clear_screen
+      tick
+      handle_events
+      update
+      screen.update
+    end
+
+    def tick
+      event_queue << clock.tick
+    end
+
+    def clock
+      @clock ||= Rubygame::Clock.new
+    end
+
+    def event_queue
+      @event_queue ||= Rubygame::EventQueue.new
+    end
+
+    class << self
+      def ignored_events(*args)
+        @ignored_events ||= []
+        @ignored_events += args unless args.empty?
+        @ignored_events
+      end
+
+      def framerate(frames_per_second=nil)
+        @framerate ||= frames_per_second || 30
+      end
+
+      def screen_width(width=nil)
+        @screen_width ||= width || 640
+      end
+
+      def screen_height(height=nil)
+        @screen_height ||= height || 480
+      end
+
+      def screen_depth(depth=nil)
+        @screen_depth ||= depth || 0
+      end
+
+      def screen_flags(flags=nil)
+        @screen_flags ||= flags || [Rubygame::HWSURFACE, Rubygame::DOUBLEBUF]
+      end
+
+      def screen_title(title=nil)
+        @screen_title ||= title || "RuGUI Game!"
+      end
+
+      def quit_hooks(quit_hooks=nil)
+        @quit_hooks ||= quit_hooks || [:escape, :q, Rubygame::Events::QuitRequested]
+      end
+    end
+
+    protected
+      # Your MainController can overwrite this and implement different clear screen logic.
+      def clear_screen
+        screen.fill :black
+      end
+
+      # Your MainController should overwrite this and implement update logic.
+      def update
+      end
+
+    private
+      def setup_clock
+        clock.target_framerate = self.class.framerate
+        clock.calibrate
+        clock.enable_tick_events
+      end
+
+      def setup_event_queue
+        event_queue.enable_new_style_events
+        event_queue.ignore = self.class.ignored_events
+      end
+
+      def setup_screen
+        self.screen = Rubygame::Screen.new(
+          [self.class.screen_width, self.class.screen_height],
+          self.class.screen_depth,
+          self.class.screen_flags)
+
+        self.screen.title = self.class.screen_title
+      end
+
+      def setup_quit_events
+        hooks = self.class.quit_hooks.inject({}) { |accumulator, hook| accumulator.merge(hook => :quit) }
+        make_magic_hooks hooks
+      end
+
+      def setup_main_view_screen
+        main_view.screen = screen if respond_to?(:main_view) && main_view.respond_to?(:screen=)
+      end
+
+      def setup_autoload_resources
+        Rubygame::Surface.autoload_dirs << images_dir if File.exist?(images_dir)
+        Rubygame::Sound.autoload_dirs << sound_dir if File.exist?(sound_dir)
+        Rubygame::Music.autoload_dirs << music_dir if File.exist?(music_dir)
+      end
+
+      def handle_events
+        event_queue.each do |event|
+          handle event
+        end
+      end
+
+      def images_dir
+        RuGUI.root.join('app', 'resources', 'images')
+      end
+
+      def sound_dir
+        RuGUI.root.join('app', 'resources', 'sfx')
+      end
+
+      def music_dir
+        RuGUI.root.join('app', 'resources', 'music')
+      end
+  end
+end
+
+module Rubygame
+  module Sprites
+    module Sprite
+      # Makes it call super
+      def initialize
+        super
+
+        @groups = []
+        @depth = 0
+      end
+    end
+  end
+end
+
+module RuGUI
+  class BaseImageSprite
+    include Rubygame::Sprites::Sprite
+
+    def initialize(name)
+      @groups = []
+      @depth = 0
+
+      @image = Rubygame::Surface[name]
+      @image.set_colorkey(@image.get_at([0, 0]))
+      @rect = @image.make_rect
+    end
+  end
+end

data/lib/rugui/generators/rugui/rugui_generator.rb

@@ -6,7 +6,7 @@ class Rugui < Thor::Group
            :desc => "The path where to generate the application, if not specified it will create the application in a directory with the same name of the application in the current directory."
 
   class_option :framework_adapter, :type => :string, :aliases => '-a', :default => 'gtk',
-                :desc => "Choose which framework adapter to use, must either 'gtk' or 'qt'"
+                :desc => "Choose which framework adapter to use, must be one of 'gtk', 'qt' or 'rubygame'"
 
   class_option :test_framework, :type => :string, :aliases => '-t', :default => 'RSpec',
                 :desc => "Choose which test framework to use, defaults to 'RSpec', but can be set to 'test-unit' also"
@@ -68,6 +68,8 @@ class Rugui < Thor::Group
   def create_app_files
     inside 'app' do
       copy_file 'main.rb'
+      directory 'controllers'
+      directory 'views'
     end
   end
 
@@ -79,13 +81,24 @@ class Rugui < Thor::Group
     directory framework_specific_file('app/controllers'), 'app/controllers'
     directory framework_specific_file('app/views'), 'app/views'
     directory framework_specific_file('app/resources'), 'app/resources'
-    directory framework_specific_file('config'), 'config'
   end
 
   def create_test_files
     directory test_framework_dir
   end
 
+  protected
+    def framework_adapter_name
+      case options[:framework_adapter]
+      when 'gtk'
+        'GTK'
+      when 'qt'
+        'Qt4'
+      when 'rubygame'
+        'Rubygame'
+      end
+    end
+
   private
     def framework_specific_file(path)
       File.join('framework_specific', options[:framework_adapter], path)

data/lib/rugui/generators/rugui/templates/{framework_specific/gtk/config/environment.rb → config/environment.rb.tt}

@@ -11,8 +11,8 @@ RuGUI::Initializer.run do |config|
   # See RuGUI::Configuration for more options.
 
   # Changes the framework adapter. Currently the only implemented framework
-  # adapters are GTK and Qt4. Defaults to GTK.
-  # config.framework_adapter = 'Qt4'
+  # adapters are GTK, Qt4 and Rubygame. Defaults to GTK.
+  config.framework_adapter = '<%= framework_adapter_name %>'
 
   # Add additional load paths for your own custom dirs
   # config.load_paths += %W( #{APPLICATION_ROOT}/extras )

data/lib/rugui/generators/rugui/templates/framework_specific/gtk/app/controllers/main_controller.rb

@@ -7,10 +7,6 @@
 class MainController < RuGUI::BaseMainController
   # Add your stuff here.
 
-  def setup_views
-    register_view :main_view
-  end
-
   on :main_window, 'delete-event' do |widget, event|
     quit
   end

data/lib/rugui/generators/rugui/templates/framework_specific/qt/app/controllers/main_controller.rb

@@ -6,8 +6,4 @@
 # the main view, but this is entirely up to you.
 class MainController < RuGUI::BaseMainController
   # Add your stuff here.
-
-  def setup_views
-    register_view :main_view
-  end
 end

data/lib/rugui/generators/rugui/templates/framework_specific/rubygame/app/controllers/main_controller.rb

@@ -0,0 +1,13 @@
+# The main controller for the application.
+#
+# NOTE: This controller doesn't inherit from ApplicationController, instead, it
+# inherits from RuGUI::BaseMainController. Use it only as a starting point.
+# Commonly it is used only to register global models and controllers, as well as
+# the main view, but this is entirely up to you.
+class MainController < RuGUI::BaseMainController
+  # Add your stuff here.
+
+  def update
+    main_view.update_screen
+  end
+end

data/lib/rugui/generators/rugui/templates/framework_specific/rubygame/app/views/main_view.rb

@@ -0,0 +1,9 @@
+class MainView < ApplicationView
+  attr_accessor :screen
+
+  def update_screen
+    screen.fill :black
+
+    # update screen logic goes here
+  end
+end

data/lib/rugui/version.rb

@@ -1,8 +1,8 @@
 module RuGUI
   module VERSION #:nodoc:
     MAJOR = 1
-    MINOR = 4
-    TINY  = 3
+    MINOR = 5
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 4
-  - 3
-  version: 1.4.3
+  - 5
+  - 0
+  version: 1.5.0
 platform: ruby
 authors: 
 - Vicente Mundim
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-05 00:00:00 -03:00
+date: 2010-04-06 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,68 +63,69 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - bin/rugui
-- lib/rugui/base_view_helper.rb
-- lib/rugui/base_controller.rb
+- lib/rugui/framework_adapters/base_framework_adapter.rb
+- lib/rugui/framework_adapters/GTK.rb
+- lib/rugui/framework_adapters/Rubygame.rb
+- lib/rugui/framework_adapters/framework_adapter_support.rb
+- lib/rugui/framework_adapters/Qt4.rb
+- lib/rugui/initializer.rb
+- lib/rugui/entity_registration_support.rb
+- lib/rugui/configuration.rb
 - lib/rugui/tasks/spec_application.rake
+- lib/rugui/tasks/test_application.rake
 - lib/rugui/tasks/rugui.rb
 - lib/rugui/tasks/runner_application.rake
 - lib/rugui/tasks/spec_framework.rake
-- lib/rugui/tasks/rugui_framework.rb
-- lib/rugui/tasks/test_application.rake
 - lib/rugui/tasks/gems_application.rake
-- lib/rugui/gem_dependency.rb
+- lib/rugui/tasks/rugui_framework.rb
+- lib/rugui/base_view_helper.rb
+- lib/rugui/vendor_gem_source_index.rb
 - lib/rugui/initialize_hooks.rb
-- lib/rugui/base_object.rb
-- lib/rugui/base_view.rb
+- lib/rugui/observable_property_proxy.rb
 - lib/rugui/property_changed_support.rb
+- lib/rugui/log_support.rb
+- lib/rugui/base_object.rb
 - lib/rugui/generators.rb
-- lib/rugui/gem_builder.rb
-- lib/rugui/initializer.rb
-- lib/rugui/configuration.rb
-- lib/rugui/framework_adapters/GTK.rb
-- lib/rugui/framework_adapters/framework_adapter_support.rb
-- lib/rugui/framework_adapters/Qt4.rb
-- lib/rugui/framework_adapters/base_framework_adapter.rb
-- lib/rugui/signal_support.rb
+- lib/rugui/property_observer.rb
+- lib/rugui/base_view.rb
 - lib/rugui/observable_property_support.rb
-- lib/rugui/vendor_gem_source_index.rb
+- lib/rugui/gem_builder.rb
 - lib/rugui/plugin/loader.rb
-- lib/rugui/entity_registration_support.rb
 - lib/rugui/base_model.rb
-- lib/rugui/log_support.rb
 - lib/rugui/generators/rugui/rugui_generator.rb
+- lib/rugui/generators/rugui/templates/app/views/application_view.rb
+- lib/rugui/generators/rugui/templates/app/views/view_helpers/main_view_helper.rb
+- lib/rugui/generators/rugui/templates/app/views/view_helpers/application_view_helper.rb
+- lib/rugui/generators/rugui/templates/app/main.rb
+- lib/rugui/generators/rugui/templates/app/controllers/application_controller.rb
 - lib/rugui/generators/rugui/templates/bin/main_executable
 - lib/rugui/generators/rugui/templates/bin/main_executable.bat
-- lib/rugui/generators/rugui/templates/framework_specific/qt/app/controllers/main_controller.rb
-- lib/rugui/generators/rugui/templates/framework_specific/qt/app/controllers/application_controller.rb
-- lib/rugui/generators/rugui/templates/framework_specific/qt/app/views/main_view.rb
-- lib/rugui/generators/rugui/templates/framework_specific/qt/app/views/application_view.rb
-- lib/rugui/generators/rugui/templates/framework_specific/qt/app/views/view_helpers/main_view_helper.rb
-- lib/rugui/generators/rugui/templates/framework_specific/qt/app/views/view_helpers/application_view_helper.rb
-- lib/rugui/generators/rugui/templates/framework_specific/qt/app/resources/ui/main_view.ui
-- lib/rugui/generators/rugui/templates/framework_specific/qt/config/environment.rb
-- lib/rugui/generators/rugui/templates/framework_specific/gtk/app/controllers/main_controller.rb
-- lib/rugui/generators/rugui/templates/framework_specific/gtk/app/controllers/application_controller.rb
-- lib/rugui/generators/rugui/templates/framework_specific/gtk/app/views/main_view.rb
-- lib/rugui/generators/rugui/templates/framework_specific/gtk/app/views/application_view.rb
-- lib/rugui/generators/rugui/templates/framework_specific/gtk/app/views/view_helpers/main_view_helper.rb
-- lib/rugui/generators/rugui/templates/framework_specific/gtk/app/views/view_helpers/application_view_helper.rb
-- lib/rugui/generators/rugui/templates/framework_specific/gtk/app/resources/glade/main_view.glade
-- lib/rugui/generators/rugui/templates/framework_specific/gtk/app/resources/styles/main.rc
-- lib/rugui/generators/rugui/templates/framework_specific/gtk/config/environment.rb
-- lib/rugui/generators/rugui/templates/test/test_helper.rb
+- lib/rugui/generators/rugui/templates/spec/spec_helper.rb
 - lib/rugui/generators/rugui/templates/spec/spec.opts
 - lib/rugui/generators/rugui/templates/spec/rcov.opts
-- lib/rugui/generators/rugui/templates/spec/spec_helper.rb
-- lib/rugui/generators/rugui/templates/app/main.rb
-- lib/rugui/generators/rugui/templates/README
+- lib/rugui/generators/rugui/templates/test/test_helper.rb
 - lib/rugui/generators/rugui/templates/Rakefile
-- lib/rugui/generators/rugui/templates/config/boot.rb
+- lib/rugui/generators/rugui/templates/README
+- lib/rugui/generators/rugui/templates/config/environments/test.rb
 - lib/rugui/generators/rugui/templates/config/environments/development.rb
 - lib/rugui/generators/rugui/templates/config/environments/production.rb
-- lib/rugui/generators/rugui/templates/config/environments/test.rb
-- lib/rugui/observable_property_proxy.rb
-- lib/rugui/property_observer.rb
+- lib/rugui/generators/rugui/templates/config/environment.rb.tt
+- lib/rugui/generators/rugui/templates/config/boot.rb
+- lib/rugui/generators/rugui/templates/framework_specific/qt/app/views/main_view.rb
+- lib/rugui/generators/rugui/templates/framework_specific/qt/app/controllers/main_controller.rb
+- lib/rugui/generators/rugui/templates/framework_specific/qt/app/resources/ui/main_view.ui
+- lib/rugui/generators/rugui/templates/framework_specific/gtk/app/views/main_view.rb
+- lib/rugui/generators/rugui/templates/framework_specific/gtk/app/controllers/main_controller.rb
+- lib/rugui/generators/rugui/templates/framework_specific/gtk/app/resources/glade/main_view.glade
+- lib/rugui/generators/rugui/templates/framework_specific/gtk/app/resources/styles/main.rc
+- lib/rugui/generators/rugui/templates/framework_specific/rubygame/app/views/main_view.rb
+- lib/rugui/generators/rugui/templates/framework_specific/rubygame/app/controllers/main_controller.rb
+- lib/rugui/generators/rugui/templates/framework_specific/rubygame/app/resources/sfx/sample_sound.mp3
+- lib/rugui/generators/rugui/templates/framework_specific/rubygame/app/resources/music/sample_music.mp3
+- lib/rugui/generators/rugui/templates/framework_specific/rubygame/app/resources/images/sample_image.png
+- lib/rugui/signal_support.rb
+- lib/rugui/gem_dependency.rb
+- lib/rugui/base_controller.rb
 - lib/rugui/version.rb
 - lib/rugui.rb
 - LICENSE
@@ -166,22 +167,22 @@ signing_key:
 specification_version: 3
 summary: A rails like MVC framework for building desktop applications with GUI frameworks.
 test_files: 
-- spec/spec.opts
-- spec/framework/log_support_spec.rb
-- spec/framework/base_view_helper_spec.rb
-- spec/framework/observable_property_proxy_spec.rb
+- spec/framework/base_model_spec.rb
 - spec/framework/property_observer_spec.rb
-- spec/framework/base_controller_spec.rb
+- spec/framework/observable_property_proxy_spec.rb
 - spec/framework/observable_property_support_spec.rb
 - spec/framework/base_view_spec.rb
-- spec/framework/base_model_spec.rb
-- spec/rcov.opts
+- spec/framework/base_view_helper_spec.rb
+- spec/framework/log_support_spec.rb
+- spec/framework/base_controller_spec.rb
 - spec/spec_helper.rb
-- spec/resource_files/my_other_view.glade
-- spec/resource_files/my_view.glade
-- spec/helpers/view_helpers.rb
+- spec/helpers/initialize_hooks_helper.rb
 - spec/helpers/models.rb
-- spec/helpers/controllers.rb
+- spec/helpers/view_helpers.rb
 - spec/helpers/observables.rb
+- spec/helpers/controllers.rb
 - spec/helpers/views.rb
-- spec/helpers/initialize_hooks_helper.rb
+- spec/spec.opts
+- spec/resource_files/my_other_view.glade
+- spec/resource_files/my_view.glade
+- spec/rcov.opts

data/lib/rugui/generators/rugui/templates/framework_specific/qt/app/controllers/application_controller.rb

@@ -1,4 +0,0 @@
-# A base controller for other application controllers.
-class ApplicationController < RuGUI::BaseController
-  # Add your stuff here.
-end

data/lib/rugui/generators/rugui/templates/framework_specific/qt/app/views/application_view.rb

@@ -1,4 +0,0 @@
-# A base view for application views.
-class ApplicationView < RuGUI::BaseView
-  # Add your stuff here.
-end

data/lib/rugui/generators/rugui/templates/framework_specific/qt/app/views/view_helpers/application_view_helper.rb

@@ -1,4 +0,0 @@
-# A base view helper for application views helpers.
-class ApplicationViewHelper < RuGUI::BaseViewHelper
-  # Add your stuff here.
-end

data/lib/rugui/generators/rugui/templates/framework_specific/qt/app/views/view_helpers/main_view_helper.rb

@@ -1,3 +0,0 @@
-class MainViewHelper < ApplicationViewHelper
-  # Add your stuff here.
-end

data/lib/rugui/generators/rugui/templates/framework_specific/qt/config/environment.rb

@@ -1,39 +0,0 @@
-# Uncomment below to force the RuGUI application into production mode
-# ENV['RUGUI_ENV'] ||= 'production'
-
-# Bootstrap the RuGUI environment, and default configuration
-require File.join(File.dirname(__FILE__), 'boot')
-
-RuGUI::Initializer.run do |config|
-  # Settings in config/environments/* take precedence over those specified here.
-  # Application configuration should go into files in config/initializers
-  # -- all .rb files in that directory are automatically loaded.
-  # See RuGUI::Configuration for more options.
-
-  # Changes the framework adapter. Currently the only implemented framework
-  # adapters are GTK and Qt4. Defaults to GTK.
-  config.framework_adapter = 'Qt4'
-
-  # Add additional load paths for your own custom dirs
-  # config.load_paths += %W( #{APPLICATION_ROOT}/extras )
-
-  # The log output, by default it is :stdout, but can be :stderr or any valid
-  # filename. Defaults to :stdout.
-  #config.logger[:output] = :stdout
-
-  # The level for logging. You can use :debug, :info, :warn, :error or :fatal
-  # That is the sequence of severity. Defaults to :info.
-  #config.logger[:level] = :info
-
-  # The format of timestamp. See the formatting for Time.strftime
-  #
-  # See with more details here:
-  # http://www.rubybrain.com/api/ruby-1.8.7/doc/index.html?a=M000253&name=strftime
-  #config.logger[:format] = "%Y-%m-%d %H:%M:%S"
-
-  # Specify gems that this application depends on.
-  # They can then be installed with "rake gems:install" on new installations.
-  # config.gem "bj"
-  # config.gem "hapricot", :version => '>0.8', :source => "http://code.whytheluckystiff.net"
-  # config.gem "aws-s3", :lib => "aws/s3"
-end