rugui 1.6.0 → 2.0.0.beta2

data/README.rdoc

@@ -27,32 +27,45 @@ 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.
+game, support for Rspec, etc.
 
-== Instalation
+== Dependencies
 
-Install the gem:
+RuGUI depends, of course, on the Ruby binding for the GUI framework that you'll
+use. When generating an application you may choose which framework you'll want
+to use. By default it will use GTK.
 
-    gem install rugui
+Here are the recommended way to install the bindings for each platform:
 
-To check if the installation was successful type in a console:
+=== Mac OS X
 
-    rugui -v
+We recommend that you use brew:
 
-== Dependencies
+    brew install gtk+   # for GTK
+    brew install qt     # for Qt4
+    brew install sdl    # for Rubygame
 
-RuGUI depends, of course, on the Ruby binding for the GUI framework that you'll
-use. It is known to work on Linux and Windows plataforms. Currently it depends
-on the ActiveSupport gem, which can be installed by:
+For Rubygame you may also want to install some other SDL related libraries:
+
+    brew install sdl_gfx sdl_image sdl_mixer sdl_net sdl_rtf sdl_sound sdl_ttf
+
+=== Linux
+
+TODO: Describe linux installation instructions for GTK, Qt4 and Rubygame
+
+=== Windows
 
-  gem install activesupport
+TODO: Describe windows installation instructions for GTK, Qt4 and Rubygame
 
-Also the rugui generator uses thor, so you will also need to install it:
+== Installation
 
-  gem install thor
+Install the gem:
+
+    gem install rugui
 
-Both gems should be installed when installing rugui gem, so you probably won't
-need to do this.
+To check if the installation was successful type in a console:
+
+    rugui -v
 
 == Generating an Application
 
@@ -61,22 +74,34 @@ application and type:
 
     rugui <app_name>
 
-For more options type:
+For more options type (including changing GUI framework):
 
     rugui -h
 
+Next cd into your application and run:
+
+    bundle install
+
+You'll surely want to use RVM[http://rvm.io].
+
+After all gems are installed you can run your application by:
+
+    rake run
+
 == Testing
 
-Your application may use Test::Unit or RSpec as the testing framework. If you
-have RSpec gem installed, 'rake -T' will list RSpec related tasks as well.
-Otherwise only Test::Unit tasks will be displayed.
+RuGUI ships with support for RSpec, just add specs to spec/ dir and you're ready
+to go!
+
+== Contributing
 
-== Using Active Support 3.0
+In order to run RuGUI framework specs, you just need to fork the repository, clone
+it to your machine, then after installing all dependencies, run:
 
-When using with Active Support 3.0 you'll need to install two gems that are
-needed by it: 
+    bundle install
+    rake spec
 
-  sudo gem install tzinfo i18n
+If all specs pass, then you're good to go and contribute by sending a pull request!
 
 == More info
 

data/Rakefile

@@ -1,11 +1,4 @@
-#
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
-
-
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-require 'lib/rugui/tasks/rugui_framework'
+require 'bundler/gem_tasks'
+require File.expand_path('../lib/rugui/tasks/rugui_framework', __FILE__)
 
+task :default => :spec

data/bin/rugui

@@ -3,11 +3,14 @@
 
 require 'rubygems'
 require 'thor/group'
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
 require 'rugui/generators'
 
 if %w(-v --version).include? ARGV.first
   require 'rugui/version'
-  puts "RuGUI #{RuGUI::VERSION::STRING}"
+  puts "RuGUI #{RuGUI::VERSION}"
   exit(0)
 end
 

data/lib/rugui/base_view.rb

@@ -37,11 +37,11 @@ module RuGUI
     attr_reader :widgets
     attr_reader :unnamed_widgets
 
-    class_inheritable_accessor :configured_builder_file
-    class_inheritable_accessor :configured_builder_file_usage
-    class_inheritable_accessor :configured_builder_file_extension
-    class_inheritable_accessor :configured_root
-    class_inheritable_accessor :configured_display_root
+    class_attribute :configured_builder_file
+    class_attribute :configured_builder_file_usage
+    class_attribute :configured_builder_file_extension
+    class_attribute :configured_root
+    class_attribute :configured_display_root
 
     def initialize
       @controllers = {}

data/lib/rugui/configuration.rb

@@ -47,14 +47,6 @@ module RuGUI
     # A hash of application specific configurations.
     attr_accessor :application
 
-    # An array of gems that this RuGUI application depends on.  RuGUI will automatically load
-    # these gems during installation, and allow you to install any missing gems with:
-    #
-    #   rake gems:install
-    #
-    # You can add gems with the #gem method.
-    attr_accessor :gems
-    
     def initialize
       set_root_path!
 
@@ -65,7 +57,6 @@ module RuGUI
       self.styles_paths = default_styles_paths
       self.queue_timeout = default_queue_timeout
       self.automatically_register_conventionally_named_views = default_automatically_register_conventionally_named_views
-      self.gems = default_gems
       self.logger = {}
       self.application = {}
     end
@@ -73,7 +64,7 @@ module RuGUI
     # The path to the current environment's file (<tt>development.rb</tt>, etc.). By
     # default the file is at <tt>config/environments/#{environment}.rb</tt>.
     def environment_path
-      root_path.join('config', 'environments', "#{environment}.rb")
+      root_path.join('config', 'environments', "#{environment}.rb").to_s
     end
 
     def set_root_path!
@@ -83,21 +74,6 @@ module RuGUI
       @root_path = Pathname.new(File.expand_path(::APPLICATION_ROOT))
     end
 
-    # Adds a single Gem dependency to the RuGUI application. By default, it will require
-    # the library with the same name as the gem. Use :lib to specify a different name.
-    #
-    #   # gem 'aws-s3', '>= 0.4.0'
-    #   # require 'aws/s3'
-    #   config.gem 'aws-s3', :lib => 'aws/s3', :version => '>= 0.4.0', \
-    #     :source => "http://code.whytheluckystiff.net"
-    #
-    # To require a library be installed, but not attempt to load it, pass :lib => false
-    #
-    #   config.gem 'qrp', :version => '0.4.1', :lib => false
-    def gem(name, options = {})
-      @gems << RuGUI::GemDependency.new(name, options)
-    end
-
     private
       def default_environment
         ::RUGUI_ENV
@@ -136,9 +112,5 @@ module RuGUI
       def default_automatically_register_conventionally_named_views
         true
       end
-
-      def default_gems
-        []
-      end
   end
 end

data/lib/rugui/entity_registration_support.rb

@@ -7,6 +7,16 @@ module RuGUI
         end
       end
 
+      def clear_all_registries
+        self.entity_registrations.keys.each do |entity|
+          clear_registry(entity)
+        end
+      end
+
+      def clear_registry(entity)
+        self.entity_registrations[entity] = []
+      end
+
       private
         def register_entity(entity, name)
           self.entity_registrations[entity] ||= []
@@ -15,8 +25,13 @@ module RuGUI
     end
 
     def self.included(base)
-      base.class_inheritable_accessor :entity_registrations
+      base.class_attribute :entity_registrations
       base.entity_registrations = {}
+
+      def base.inherited(base)
+        base.entity_registrations = {}
+      end
+
       base.extend(ClassMethods)
     end
 
@@ -91,4 +106,4 @@ module RuGUI
         class_eval
       end
   end
-end
+end

data/lib/rugui/framework_adapters/GTK.rb

@@ -1,5 +1,4 @@
 require 'gtk2'
-require 'libglade2'
 
 unless Object.respond_to?(:instance_exec) # Ruby 1.9 does already has Object#instance_exec
   # See the discussion here: http://eigenclass.org/hiki.rb?instance_exec
@@ -104,6 +103,7 @@ module RuGUI
 
         # Adds a widget to the given container widget.
         def add_widget_to_container(widget, container_widget)
+          widget.parent.remove(widget) if widget.parent && widget.parent != container_widget
           container_widget.add(widget)
         end
 
@@ -128,9 +128,9 @@ module RuGUI
         # it is used instead of the view itself.
         def autoconnect_signals(other_target = nil)
           if self.adapted_object.use_builder?
-            self.adapted_object.glade.signal_autoconnect_full do |source, target, signal_name, handler_name, signal_data, after|
-              target ||= other_target
-              self.adapted_object.glade.connect(source, target, signal_name, handler_name, signal_data) if target.respond_to?(handler_name)
+            self.adapted_object.builder_instance.connect_signals do |name|
+              target = other_target || self.adapted_object
+              target.method(name) if target.respond_to?(name)
             end
           end
         end
@@ -152,28 +152,26 @@ module RuGUI
 
         # Builds widgets from the given filename, using the proper builder.
         def build_widgets_from(filename)
-          self.adapted_object.glade = GladeXML.new(filename, self.adapted_object.root, nil, nil, GladeXML::FILE)
+          self.adapted_object.builder_instance ||= Gtk::Builder.new
+          self.adapted_object.builder_instance.add_from_file(filename)
 
-          self.adapted_object.glade.widget_names.each do |widget_name|
-            self.adapted_object.send(:create_attribute_for_widget, widget_name) unless self.adapted_object.glade[widget_name].nil?
+          self.adapted_object.builder_instance.objects.each do |widget|
+            self.adapted_object.send(:create_attribute_for_widget, widget.builder_name)
           end
-          self.adapted_object.root_widget.show if self.adapted_object.display_root? and not self.adapted_object.root_widget.nil?
         end
 
         # Registers widgets as attributes of the view class.
         def register_widgets
-          self.adapted_object.glade.widget_names.each do |widget_name|
-            unless self.adapted_object.glade[widget_name].nil?
-              self.adapted_object.send("#{widget_name}=".to_sym, self.adapted_object.glade[widget_name])
-              self.adapted_object.widgets[widget_name] = self.adapted_object.glade[widget_name]
-            end
+          self.adapted_object.builder_instance.objects.each do |widget|
+            self.adapted_object.send("#{widget.builder_name}=", widget)
+            self.adapted_object.widgets[widget.builder_name] = widget
           end
         end
 
         class << self
           # Returns the builder file extension to be used for this view class.
           def builder_file_extension
-            'glade'
+            'xml'
           end
         end
       end
@@ -183,9 +181,7 @@ end
 
 module RuGUI
   class BaseView < BaseObject
-    class_inheritable_accessor :configured_glade_usage
-
-    attr_accessor :glade
+    attr_accessor :builder_instance
 
     # Adds a signal handler for all widgets of the given type.
     def add_signal_handler_for_widget_type(widget_type, signal, &block)
@@ -218,22 +214,9 @@ module RuGUI
     # definition doesn't need to point to an existing widget we can use this
     # to simplify the widget styling here.
     def change_widget_style(widget_or_name, widget_path_style)
-      if widget_or_name.is_a?(Gtk::Widget)
-        widget = widget_or_name
-      else
-        widget = @glade[widget_or_name.to_s]
-      end
+      widget = widget_or_name.is_a?(Gtk::Widget) ? widget_or_name : self.builder_instance.get_object(widget_or_name)
       style = Gtk::RC.get_style_by_paths(Gtk::Settings.default, widget_path_style.to_s, nil, nil)
       widget.style = style
     end
-
-    class << self
-      # Call this method at class level if the view should be built from a glade
-      # file.
-      def use_glade
-        self.logger.warn('DEPRECATED - Call use_builder class method instead in your view.')
-        use_builder
-      end
-    end
   end
-end
+end

data/lib/rugui/framework_adapters/Qt4.rb

@@ -13,6 +13,21 @@ end
 
 Qt.create_application
 
+# This is a monkey patch needed because ActiveSupport::Depndencies define a load
+# method that conflicts with Qt::UiLoader#load method. We save the old load method,
+# require ActiveSupport::Depndencies, the revert the load method back again.
+class Qt::UiLoader
+  alias old_qt_load load
+end
+
+require 'active_support/dependencies'
+
+class Qt::UiLoader
+  alias load old_qt_load
+end
+
+### End of Qt::UiLoader monkey patch
+
 module RuGUI
   module FrameworkAdapters
     module Qt4
@@ -108,10 +123,14 @@ module RuGUI
 
         private
           def load_ui_file(filename)
-            file = Qt::File.new(filename)
-            file.open(Qt::File::ReadOnly)
+            file = Qt::File.new(filename) do
+              open(Qt::File::ReadOnly)
+            end
+
             loader = Qt::UiLoader.new
-            loader.load(file, nil)
+            loader.load file
+          ensure
+            file.close if file.present?
           end
 
           def root_widget_from(ui_file_root_widget)

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

@@ -8,12 +8,9 @@ class Rugui < Thor::Group
   class_option :framework_adapter, :type => :string, :aliases => '-a', :default => 'gtk',
                 :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"
-
   class_option :version, :type => :boolean, :aliases => "-v", :group => :rugui,
                            :desc => "Show RuGUI version number and quit"
- 
+
   class_option :help, :type => :boolean, :aliases => "-h", :group => :rugui,
                       :desc => "Show this help message and quit"
 
@@ -31,6 +28,7 @@ class Rugui < Thor::Group
   def create_root_files
     copy_file 'README'
     copy_file 'Rakefile'
+    template 'Gemfile.tt'
   end
 
   def create_directory_structure
@@ -81,7 +79,7 @@ class Rugui < Thor::Group
   end
 
   def create_test_files
-    directory test_framework_dir
+    directory 'spec'
   end
 
   protected
@@ -100,8 +98,4 @@ class Rugui < Thor::Group
     def framework_specific_file(path)
       File.join('framework_specific', options[:framework_adapter], path)
     end
-
-    def test_framework_dir
-      options[:test_framework] == 'RSpec' ? 'spec' : 'test'
-    end
 end

data/lib/rugui/generators/rugui/templates/Gemfile.tt

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+
+# RuGUI gem
+gem 'rugui', '~> 2.0.0.beta'
+
+# GTK ruby bindings
+<%= '#' unless framework_adapter_name == 'GTK' %>gem 'gtk2'
+
+# Qt ruby bindings
+<%= '#' unless framework_adapter_name == 'Qt4' %>gem 'qtbindings'
+
+# Rubygame
+<%= '#' unless framework_adapter_name == 'Rubygame' %>gem 'rubygame'
+
+# Uncomment this if you want to debug applications
+# gem 'debugger'
+
+group :test do
+  gem 'rspec', '>= 2.11.0'
+end

data/lib/rugui/generators/rugui/templates/Rakefile

@@ -1,7 +1,3 @@
 require File.join(File.dirname(__FILE__), 'config', 'boot')
 
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
 require 'rugui/tasks/rugui'

data/lib/rugui/generators/rugui/templates/app/main.rb

@@ -5,7 +5,7 @@
 # Do not modify it, unless you know what you are doing.
 #
 
-require File.join(File.dirname(__FILE__), '..', 'config', 'environment')
+require File.expand_path('../../config/environment', __FILE__)
 
 main_controller = MainController.new
 main_controller.run

data/lib/rugui/generators/rugui/templates/config/boot.rb

@@ -1,81 +1,8 @@
-# Do not change this file!
-#
-# This was mainly copied (but modified a little bit) from the rails framework
-# initializers, but made less picky about gem loading.
+require 'rubygems'
 
-APPLICATION_ROOT = File.expand_path("#{File.dirname(__FILE__)}/..") unless defined?(APPLICATION_ROOT)
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 
-module RuGUI
-  class << self
-    def boot!
-      unless booted?
-        preinitialize
-        pick_boot.run
-      end
-    end
+APPLICATION_ROOT = File.expand_path('../..', __FILE__) unless defined?(APPLICATION_ROOT)
 
-    def booted?
-      defined? RuGUI::Initializer
-    end
-
-    def pick_boot
-      (vendor_rugui? ? VendorBoot : GemBoot).new
-    end
-
-    def vendor_rugui?
-      File.exist?("#{APPLICATION_ROOT}/vendor/rugui")
-    end
-
-    def preinitialize
-      load(preinitializer_path) if File.exist?(preinitializer_path)
-    end
-
-    def preinitializer_path
-      "#{APPLICATION_ROOT}/config/preinitializer.rb"
-    end
-  end
-
-  class Boot
-    def run
-      load_initializer
-      RuGUI::Initializer.run(:set_load_path)
-    end
-  end
-
-  class VendorBoot < Boot
-    def load_initializer
-      require "#{APPLICATION_ROOT}/vendor/rugui/lib/rugui/initializer"
-    end
-  end
-
-  class GemBoot < Boot
-    def load_initializer
-      self.class.load_rubygems
-      load_rugui
-      require 'rugui/initializer'
-    end
-
-    def load_rugui
-      require 'rugui'
-    rescue Gem::LoadError
-      $stderr.puts %(Missing the RuGUI gem. Please `gem install rugui`.)
-      exit 1
-    end
-
-    class << self
-      def rubygems_version
-        Gem::RubyGemsVersion if defined? Gem::RubyGemsVersion
-      end
-
-      def load_rubygems
-        require 'rubygems'
-      rescue LoadError
-        $stderr.puts %(RuGUI requires RubyGems. Please install RubyGems and try again: http://rubygems.rubyforge.org)
-        exit 1
-      end
-    end
-  end
-end
-
-# All that for this:
-RuGUI.boot!
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/lib/rugui/generators/rugui/templates/config/environment.rb.tt

@@ -1,8 +1,14 @@
 # Uncomment below to force the RuGUI application into production mode
 # ENV['RUGUI_ENV'] ||= 'production'
+ENV['RUGUI_ENV'] ||= 'development'
 
 # Bootstrap the RuGUI environment, and default configuration
-require File.join(File.dirname(__FILE__), 'boot')
+require File.expand_path('../boot', __FILE__)
+
+# require gems
+Bundler.require(:default, ENV['RUGUI_ENV'])
+
+require 'rugui/initializer'
 
 RuGUI::Initializer.run do |config|
   # Settings in config/environments/* take precedence over those specified here.
@@ -30,10 +36,4 @@ RuGUI::Initializer.run do |config|
   # 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

data/lib/rugui/generators/rugui/templates/framework_specific/gtk/app/resources/xml/main_view.xml

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<interface>
+  <!-- interface-requires gtk+ 2.6 -->
+  <!-- interface-naming-policy toplevel-contextual -->
+  <object class="GtkWindow" id="main_window">
+    <property name="visible">True</property>
+    <property name="can_focus">False</property>
+    <property name="title" translatable="yes">Hello World!</property>
+    <child>
+      <object class="GtkVBox" id="main_container">
+        <property name="visible">True</property>
+        <property name="can_focus">False</property>
+        <child>
+          <object class="GtkLabel" id="message_label">
+            <property name="visible">True</property>
+            <property name="can_focus">False</property>
+            <property name="label" translatable="yes">Just a simple label</property>
+          </object>
+          <packing>
+            <property name="expand">True</property>
+            <property name="fill">True</property>
+            <property name="position">0</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkButton" id="hello_button">
+            <property name="label" translatable="yes">click me</property>
+            <property name="use_action_appearance">False</property>
+            <property name="visible">True</property>
+            <property name="can_focus">True</property>
+            <property name="receives_default">True</property>
+            <signal name="clicked" handler="on_hello_button_clicked" swapped="no"/>
+          </object>
+          <packing>
+            <property name="expand">True</property>
+            <property name="fill">True</property>
+            <property name="position">1</property>
+          </packing>
+        </child>
+      </object>
+    </child>
+  </object>
+</interface>

data/lib/rugui/generators/rugui/templates/spec/spec_helper.rb

@@ -1,7 +1,5 @@
 $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 
-require 'spec'
-
 # Forcing the 'test' environment.
 ENV["RUGUI_ENV"] = "test"