rugui 1.2.1 → 1.2.2

data/Changelog

@@ -0,0 +1,54 @@
+1.2.0
+- Added support for gems dependency mechanism
+
+1.1.2
+- Updated README docs
+
+1.1.1
+- Added support to prevent root widgets of views from being displayed by passing false to use_builder class method.
+- Created a find_child in QT adapter since QT's one is not working.
+- Fixing a error when creating views which doesn't use builder files.
+- Removed unnecessary requires in framework files
+
+1.1.0
+- Added support to Qt4 as well as GTK as backend GUI frameworks.
+- Added a DSL to connect signals to controllers and views.
+
+1.0.0
+- Created a RuGUI::BaseObject which implements the inspect method for RuGUI related objects.
+- Added some generators (for models, controllers and views with its resources).
+- Added support for before/after initialize hooks for Controller, View, ViewHelper and Model base classes.
+- Using Pathname to wrap Configuration#root_path. Now you can use configuration.root_path.join('my_path'), instead of File.join(configuration.root_path, 'my_path')
+
+0.6.0
+- Added a method to quickly get the main controller from any BaseController.
+- Now the application generator creates a /bin directory with a bash and bat scripts to run the application
+- Fixing a small bug with update_observable_properties method
+
+0.5.0
+- Added a method to update observable properties values.
+- Added support to set initial values of observable properties while instancing an object, using a map (property + value).
+- Added a method to get all observable properties of an object with theirs values.
+- Using class_inheritable_accessor instead of using class variables for observable properties options in ObservablePropertySupport
+- Using class_inheritable_accessor instead of creating fake class attributes in BaseView
+- Added method setup_view_helpers in BaseView, so that one can register more helpers if needed.
+- Fixed a bug where named observable property change methods were not being called when an observable property was changed.
+- Added :prevent_reset option to observable properties.
+- Added :boolean options to observable properties, which automatically creates 'question' methods for the properties.
+- Added a method to copy all observable properties from one observable to another.
+- Fixed an issue which caused observable properties not to be copied when a hash with string keys was given when creating an observable or when updating its observable properties
+- Boolean observable properties 'question' accessors now can be used directly in if's
+
+0.4.0
+- Added plugins support
+
+0.3.0
+- PropertyObserver was receiving notifications from named observables even when the name of the observer was the same as the class name.
+- Migrated tests from TestUnit to RSpec.
+- Added application generator.
+
+0.2.1
+- Adding support to execute RuGUI application in various environments
+
+0.2.0
+- Initial Release, forked from RubyGtkMvc code.

data/Rakefile

@@ -7,6 +7,8 @@ require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rubygems'
+require 'lib/rugui/tasks/rugui_framework'
+
 
 begin
   require 'jeweler'
@@ -19,52 +21,12 @@ begin
     gemspec.authors = ["Vicente Mundim", "Felipe Mesquita", "Claudio Escudero"]
     gemspec.add_dependency(%q<activesupport>, [">= 2.1.1"])
     gemspec.add_dependency(%q<rubigen>, [">= 1.5.1"])
-    gemspec.version = "1.2.1"
+    gemspec.version = "1.2.2"
     gemspec.date = %q{2009-04-01}
     gemspec.rubyforge_project = "rugui"
     gemspec.executables = ['rugui']
+    gemspec.files = FileList["bin/*", "lib/**/*", "rugui_generators/**/*", "script/*", "spec/**/*", "Changelog", "LICENSE", "Rakefile", "README"].to_a
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "RuGUI #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-begin
-  require 'rake/contrib/sshpublisher'
-  namespace :rubyforge do
-
-    desc "Release gem and RDoc documentation to RubyForge"
-    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
-
-    namespace :release do
-      desc "Publish RDoc to RubyForge."
-      task :docs => [:rdoc] do
-        config = YAML.load(
-            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
-        )
-
-        host = "#{config['username']}@rubyforge.org"
-        remote_dir = "/var/www/gforge-projects/rugui"
-        local_dir = 'rdoc'
-
-        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
-      end
-    end
-  end
-rescue LoadError
-  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
-end

data/lib/rugui/tasks/release_framework.rake

@@ -0,0 +1,39 @@
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "RuGUI #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/rugui"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/lib/rugui/version.rb

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

data/rugui_generators/controller/USAGE

@@ -0,0 +1 @@
+

data/rugui_generators/controller/controller_generator.rb

@@ -0,0 +1,35 @@
+require File.join(File.dirname(__FILE__), "../generators_support")
+
+class ControllerGenerator < RubiGen::Base
+  include GeneratorsSupport
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      build_controller_templates(m)
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a RuGUI controller.
+
+USAGE: script/generate controller YOUR_CONTROLLER_NAME
+EOS
+    end
+
+    def add_options!(opts)
+      controller_add_options!(opts)
+    end
+end

data/rugui_generators/controller/templates/controller.erb

@@ -0,0 +1,3 @@
+class <%= controller_name %>Controller < ApplicationController
+  # Add your stuff here.
+end

data/rugui_generators/generators_support.rb

@@ -0,0 +1,75 @@
+module GeneratorsSupport
+  protected
+    # Build controller templates.
+    def build_controller_templates(m)
+      m.template "../../controller/templates/controller.erb", "app/controllers/#{@name.underscore}_controller.rb", :assigns => { :controller_name => @name.camelize }
+    end
+
+    # Build view templates.
+    def build_view_templates(m)
+      # app/views
+      m.template "../../view/templates/view.erb", "app/views/#{@name.underscore}_view.rb", :assigns => { :view_name => @name.camelize, :uses_builder => uses_builder? }
+      # app/views/helpers
+      m.template "../../view/templates/view_helper.erb", "app/views/helpers/#{@name.underscore}_view_helper.rb", :assigns => { :view_name => @name.camelize }
+      if uses_builder?
+        if framework_based_on_directory_structure == 'GTK'
+          # app/resources/glade
+          m.file glade_template, "app/resources/glade/#{@name.underscore}_view.glade"
+        else
+          # app/resources/ui
+          m.file ui_template, "app/resources/ui/#{@name.underscore}_view.ui"
+        end
+      end
+    end
+
+    # Implements add_options!(opts) for views.
+    def view_add_options!(opts)
+      opts.separator ' '
+      opts.on("-x", "--without-builder", "Create the view without a glade.") { |o| @uses_builder = false }
+      opts.on("-e", "--default-builder", "Create the view with a default builder.") { |o| @toplevel = nil }
+      opts.on("-w", "--window", option_phrase_for('window')) { |o| @toplevel = "window" }
+      opts.on("-d", "--dialog-box", option_phrase_for('dialog box')) { |o| @toplevel = "dialog_box" }
+      opts.on("-a", "--about-dialog", option_phrase_for('about dialog')) { |o| @toplevel = "about_dialog" }
+      opts.on("-u", "--color-selection-dialog", option_phrase_for('color selection dialog')) { |o| @toplevel = "color_selection_dialog" }
+      opts.on("-j", "--file-chooser-dialog", option_phrase_for('file chooser dialog')) { |o| @toplevel = "file_chooser_dialog" }
+      opts.on("-n", "--font-selection-dialog", option_phrase_for('font selection dialog')) { |o| @toplevel = "font_selection_dialog" }
+      opts.on("-i", "--input-dialog", option_phrase_for('input dialog')) { |o| @toplevel = "input_dialog" }
+      opts.on("-m", "--message-dialog", option_phrase_for('message dialog')) { |o| @toplevel = "message_dialog" }
+      opts.on("-r", "--recent-chooser-dialog", option_phrase_for('recent chooser dialog')) { |o| @toplevel = "recent_chooser_dialog" }
+    end
+
+    # Implements add_options!(opts) for controllers.
+    def controller_add_options!(opts)
+      opts.separator ' '
+    end
+
+    def option_phrase_for(toplevel)
+      "Create the view with a glade file using #{toplevel} template as toplevel (GTK only)."
+    end
+
+    # Gets the correct glade template.
+    def glade_template
+      return "../../view/templates/view.glade" if @toplevel.nil?
+      return "../../view/templates/toplevels/#{@toplevel}.glade"
+    end
+
+    # Gets the correct glade template.
+    def ui_template
+      return "../../view/templates/view.ui"
+    end
+
+    def uses_builder?
+      !!@uses_builder
+    end
+
+    def extract_options
+    end
+
+    def framework_based_on_directory_structure
+      if File.exist?("app/resources/ui")
+        'Qt4'
+      else
+        'GTK'
+      end
+    end
+end

data/rugui_generators/model/USAGE

@@ -0,0 +1 @@
+

data/rugui_generators/model/model_generator.rb

@@ -0,0 +1,35 @@
+class ModelGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      m.template "model.erb", "app/models/#{@name.underscore}.rb", :assigns => { :model_name => @name.camelize }
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a RuGUI model.
+
+USAGE: script/generate model YOUR_MODEL_NAME
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ' '
+    end
+
+    def extract_options
+    end
+end

data/rugui_generators/model/templates/model.erb

@@ -0,0 +1,3 @@
+class <%= model_name %> < RuGUI::BaseModel
+  # Add your stuff here.
+end

data/rugui_generators/pack/USAGE

@@ -0,0 +1 @@
+

data/rugui_generators/pack/pack_generator.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), "../generators_support")
+
+class PackGenerator < RubiGen::Base
+  include GeneratorsSupport
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    @uses_builder = true
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      build_controller_templates(m)
+      build_view_templates(m)
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a RuGUI controller and view with its resources.
+
+USAGE: script/generate pack YOUR_CONTROLLER_AND_VIEW_NAME [options]
+EOS
+    end
+
+    def add_options!(opts)
+      view_add_options!(opts)
+    end
+
+    def extract_options
+    end
+end

data/rugui_generators/pack/templates/README

@@ -0,0 +1,3 @@
+Take a look at:
+  ../../controller/templates/*
+  ../../view/templates/*

data/rugui_generators/rugui/USAGE

@@ -0,0 +1 @@
+

data/rugui_generators/rugui/rugui_generator.rb

@@ -0,0 +1,163 @@
+class RuguiGenerator < RubiGen::Base
+
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    set_initial_values
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @name = base_name
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+      FRAMEWORK_SPECIFIC_DIRS[@framework].each { |path| m.directory path }
+
+      # Root files
+      m.file_copy_each %w(README Rakefile)
+      # app/
+      m.file "main.rb", "app/main.rb"
+      # app/controllers
+      %w(main application).each do |file|
+        m.file "#{@framework}/#{file}_controller.rb", "app/controllers/#{file}_controller.rb"
+      end
+      # app/views
+      %w(main application).each do |file|
+        m.file "#{@framework}/#{file}_view.rb", "app/views/#{file}_view.rb"
+      end
+      # app/view/helpers
+      %w(main application).each do |file|
+        m.file "#{@framework}/#{file}_view_helper.rb", "app/views/helpers/#{file}_view_helper.rb"
+      end
+
+      case @framework
+      when 'GTK'
+        # app/resources/glade
+        m.file "#{@framework}/main_view.glade", "app/resources/glade/main_view.glade"
+        # app/resources/styles
+        m.file "#{@framework}/main.rc", "app/resources/styles/main.rc"
+      when 'Qt4'
+        # app/resources/ui
+        m.file "#{@framework}/main_view.ui", "app/resources/ui/main_view.ui"
+      end
+
+      # config/boot.rb
+      m.file "boot.rb", "config/boot.rb"
+      # config/environment.rb
+      m.file "#{@framework}/environment.rb", "config/environment.rb"
+      # config/environments
+      %w(development test production).each do |file|
+        m.file "#{file}.rb.sample", "config/environments/#{file}.rb.sample"
+      end
+
+      # bin/
+      m.template "main_executable.bat.erb", "bin/#{@name}.bat", :assigns => { :application_root => @name }
+      m.file "main_executable.erb", "bin/#{@name}"
+
+      # test/
+      if @test_suite.include?("unit")
+        TEST_DIRS.each { |path| m.directory path }
+        m.file "test_helper.rb", "test/test_helper.rb"
+      end
+
+      # spec/
+      if @test_suite.include?("rspec")
+        RSPEC_DIRS.each { |path| m.directory path }
+        %w(rcov.opts spec.opts spec_helper.rb).each { |file| m.file file, "spec/#{file}"  }
+      end
+
+      # scripts/
+      m.dependency "install_rubigen_scripts", [destination_root, 'rugui'],
+        :shebang => options[:shebang], :collision => :force
+    end
+  end
+
+  protected
+    def banner
+<<-EOS
+Creates a RuGUI application.
+
+USAGE: #{spec.name} YOUR_PROJECT_NAME
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ' '
+      opts.separator 'Options:'
+      opts.on("-r", "--rspec", "Add RSpec support to the project.") { |o| @test_suite << "rspec"  }
+      opts.on("-o", "--only-rspec", "Use RSpec instead of Test::Unit::TestCase.") { |o| @test_suite = ["rspec"]  }
+      opts.on("--qt4", "Use Qt4 templates for this application.") { |o| @framework = 'Qt4' }
+      opts.on("-v", "--version", "Show the RuGUI version number and quit.")
+    end
+
+    # Set initial values.
+    def set_initial_values
+      @test_suite = ["unit"]
+      @framework = "GTK"
+    end
+
+    def extract_options
+    end
+
+    BASEDIRS = [
+      # bin directory contains executables for the application.
+      'bin',
+      # app directory contains the controllers, models, resources, and views.
+      'app',
+      'app/controllers',
+      'app/models',
+      'app/resources',
+      'app/views',
+      'app/views/helpers',
+      # config directory contains environments configuration, boot file and
+      # other configuration stuff.
+      'config',
+      'config/environments',
+      # lib directory contains utility libraries which doesn't fit into a
+      # separate gem or plugin. Also it contains additional rake tasks which
+      # will be automatically added if present in lib/tasks.
+      'lib',
+      'lib/tasks',
+      # log directory contains default log files for the application.
+      'log',
+      # vendor directory contains third-party software.
+      'vendor'
+    ]
+
+    TEST_DIRS = [
+      'test',
+      'test/controllers',
+      'test/models',
+      'test/views',
+      'test/views/helpers',
+      'test/lib'
+    ]
+
+    RSPEC_DIRS = [
+      'spec',
+      'spec/controllers',
+      'spec/models',
+      'spec/views',
+      'spec/views/helpers',
+      'spec/lib'
+    ]
+
+    FRAMEWORK_SPECIFIC_DIRS = {
+      'GTK' => [
+        'app/resources/glade',
+        'app/resources/styles',
+      ],
+      'Qt4' => [
+        'app/resources/ui',
+      ]
+    }
+end

data/rugui_generators/rugui/templates/GTK/application_controller.rb

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

data/rugui_generators/rugui/templates/GTK/application_view.rb

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

data/rugui_generators/rugui/templates/GTK/application_view_helper.rb

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

data/rugui_generators/rugui/templates/GTK/environment.rb

@@ -0,0 +1,39 @@
+# 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

data/rugui_generators/rugui/templates/GTK/main.rc

@@ -0,0 +1,23 @@
+# This is a sample gtkrc file used to add application specific styles to the
+# application. Styles defined here will override any theme style defined by the
+# GTK theme machinery.
+#
+# The root path of the application can be obtained by using '{ROOT_PATH}'. So,
+# to set the pixmap path, for example, one would write this in the head of this
+# file:
+#
+# pixmap_path "{ROOT_PATH}/app/resources/styles/images"
+#
+
+# Just a sample style setting:
+#
+#style "message_label"
+#{
+#    fg[NORMAL] = "#5a0000"
+#    fg[ACTIVE] = "#5a0000"
+#    fg[PRELIGHT] = "#5a0000"
+#    fg[SELECTED] = "#5a0000"
+#    fg[INSENSITIVE] = "#5a0000"
+#    font_name = "Arial Bold 18px"
+#}
+#widget "*message_label" style "message_label"

data/rugui_generators/rugui/templates/GTK/main_controller.rb

@@ -0,0 +1,17 @@
+# 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 setup_views
+    register_view :main_view
+  end
+
+  on :main_window, 'delete-event' do |widget, event|
+    quit
+  end
+end