qtext 0.5.0 → 0.6.0

data/History.txt

@@ -0,0 +1,10 @@
+== 0.6.0
+* add Qt::Widget.signal class method which adds some signal emitting and
+  handling methods.
+* remove Qt::Widget.construct and construct_exec because they're already part 
+  of Qt::Widget.new
+* Documentation
+* Some testing
+
+== 0.5.0
+* Add ActionBuilder to create menus and other sets of Qt::Action objects

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,24 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+env.sh
+lib/qtext.rb
+lib/qtext/action_builder.rb
+lib/qtext/extensions.rb
+lib/qtext/flags.rb
+lib/qtext/object_table_model.rb
+lib/qtext/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_object_table.rb
+test/test_widget.rb

data/README.txt

@@ -1,32 +1,39 @@
 = qtext
 
-* FIX (url)
+http://rubyforge.org/projects/qtext
 
 == DESCRIPTION:
 
-Some extensions to qt4-qtruby to make it more rubyish
+Some extensions to qt4-qtruby to make it more rubyish.
 
-== FEATURES/PROBLEMS:
-
-* FIX (list of features or problems)
+== FEATURES
+- ActionBuilder module to simplify creating Action objects for inclusion into menus.
+- ObjectTableModel so that you can easily display a collection of objects in a table
+- signal and construct_signal for Qt::Widget to reduce the need for c++ signatures
+- to_variant method for Object. Specific overrides for some objects.
+- invalid method for Qt::ModelIndex  to cache creation of an empty index
+- invalid method for Qt::Variant to cache creation of an empty variant
+- KeyEvent instances will respond to things like delete? (the delete key) for most keys
+- value method for some widgets (RadioButton, CheckBox), returning the value of the widget
 
 == SYNOPSIS:
 
-  FIX (code sample of usage)
+require 'qtext' 
 
 == REQUIREMENTS:
 
-* FIX (list of requirements)
-
+- qtruby4
+- Shoulda if you want to run tests
+- ActiveSupport. Only needed in Header for humanize.
 == INSTALL:
 
-* FIX (sudo gem install, anything else)
+sudo gem install qtext
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2008 FIX
+Copyright (c) 2008 John Anderson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'qtext/version'
+
+AUTHOR = 'FIXME full name'  # can also be an array of Authors
+EMAIL = "panic@semiosix.com"
+DESCRIPTION = "description of gem"
+GEM_NAME = 'qtext' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'qtext' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Qtext::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'qtext documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), '')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/env.sh

@@ -0,0 +1 @@
+export RUBYLIB=$RUBYLIB:`pwd`/lib

data/lib/qtext/action_builder.rb

@@ -1,66 +1,95 @@
 require 'Qt4'
 require 'qtext/extensions.rb'
 
+# The declaration of module Find in the require breaks
+# the constant in Qt::KeySequence. It's a bug in the Qt bindings.
+begin
+  $old_qt_key_sequence_find_value = Qt::KeySequence::Find
+  require 'find'
+  if Qt::KeySequence::Find == Find
+    module Qt
+      class KeySequence
+        Find = $old_qt_key_sequence_find_value
+      end
+    end
+  end
+  
+end
+
 =begin rdoc
-This module can be used to make the construction of collections of actions
-more rubyish. Menus are generally made up of a collection of actions.
+This module can be used in an object that has
+an add_action method (usually a subclass of Qt::Widget) to make the construction of
+collections of actions more rubyish.
+Menus are generally made up of a collection of actions.
 
-Once included, it's intended to be called as follows, where self is a descendant of Qt::Widget:
-  build_actions do
-    list( :edit ) do
-      #~ new_action :action_cut, 'Cu&t', :shortcut => Qt::KeySequence::Cut
-      action :action_copy, '&Copy', :shortcut => Qt::KeySequence::Copy, :method => :copy_current_selection
-      action :action_paste, '&Paste', :shortcut => Qt::KeySequence::Paste, :method => :paste
-      separator
-      action :action_ditto, '&Ditto', :shortcut => 'Ctrl+\'', :method => :ditto, :tool_tip => 'Copy same field from previous record'
-      action :action_ditto_right, 'Ditto R&ight', :shortcut => 'Ctrl+]', :method => :ditto_right, :tool_tip => 'Copy field one to right from previous record'
-      action :action_ditto_left, '&Ditto L&eft', :shortcut => 'Ctrl+[', :method => :ditto_left, :tool_tip => 'Copy field one to left from previous record'
-      action :action_insert_date, 'Insert Date', :shortcut => 'Ctrl+;', :method => :insert_current_date
-      action :action_open_editor, '&Open Editor', :shortcut => 'F4', :method => :open_editor
-      separator
-      action :action_row, 'New Ro&w', :shortcut => 'Ctrl+N', :method => :row
-      action :action_refresh, '&Refresh', :shortcut => 'Ctrl+R', :method => :refresh
-      action :action_delete_rows, 'Delete Rows', :shortcut => 'Ctrl+Delete', :method => :delete_rows
-      
-      if $options[:debug]
-        action :action_dump, 'D&ump', :shortcut => 'Ctrl+Shift+D' do
-          puts model.collection[current_index.row].inspect
+Once included, it's intended to be called as follows:
+  def some_setup_method_or_other
+    build_actions do
+      list :edit do
+        #~ new_action :action_cut, 'Cu&t', :shortcut => Qt::KeySequence::Cut
+        action :action_copy, '&Copy', :shortcut => Qt::KeySequence::Copy, :method => :copy_current_selection
+        action :action_paste, '&Paste', :shortcut => Qt::KeySequence::Paste, :method => :paste
+        separator
+        action :action_ditto, '&Ditto', :shortcut => 'Ctrl+\'', :method => :ditto, :tool_tip => 'Copy same field from previous record'
+        action :action_ditto_right, 'Ditto R&ight', :shortcut => 'Ctrl+]', :method => :ditto_right, :tool_tip => 'Copy field one to right from previous record'
+        action :action_ditto_left, '&Ditto L&eft', :shortcut => 'Ctrl+[', :method => :ditto_left, :tool_tip => 'Copy field one to left from previous record'
+        action :action_insert_date, 'Insert Date', :shortcut => 'Ctrl+;', :method => :insert_current_date
+        action :action_open_editor, '&Open Editor', :shortcut => 'F4', :method => :open_editor
+        separator
+        action :action_row, 'New Ro&w', :shortcut => 'Ctrl+N', :method => :row
+        action :action_refresh, '&Refresh', :shortcut => 'Ctrl+R', :method => :refresh
+        action :action_delete_rows, 'Delete Rows', :shortcut => 'Ctrl+Delete', :method => :delete_rows
+        
+        if $options[:debug]
+          action :action_dump, 'D&ump', :shortcut => 'Ctrl+Shift+D' do
+            puts model.collection[current_index.row].inspect
+          end
         end
       end
+      
+      separator
     end
-    
-    separator
   end
-  
-You can also do something like this:
-
+Or you can pass a parameter to the block if you need access to surrounding variables:
   build_actions do |ab|
-    ab.list( :edit ) do
+    ab.list :edit do
       #~ new_action :action_cut, 'Cu&t', :shortcut => Qt::KeySequence::Cut
       ab.action :action_copy, '&Copy', :shortcut => Qt::KeySequence::Copy, :method => :copy_current_selection
     end
   end
-
 If the including class defines a method called action_triggered( &block ),
 it can be used to wrap the code triggered by actions. That way, the
 including class
-can catch exceptions and things like that. If this method is not
-defined, it will be defined as an empty wrapper.
+can catch exceptions and things like that.
+  def action_triggered( &block )
+    catch :something_happened do
+      yield
+    end
+  end
+If this method is not defined, it will be created in the including class as an empty wrapper.
 =end
 module ActionBuilder
-  def build_actions( &block )
-    yield( self )
-  end
-  
-  def collect_actions
-    @collect_actions ||= []
+  # raise a RuntimeError if the including class/module does not define add_action
+  def self.included( including_module )
+    shortlist = including_module.instance_methods.grep /action/i
+    # add_action is actually an method_missing lookup for addAction, so
+    # search for both.
+    unless shortlist.any? {|x| %w{add_action addAction}.include?( x )}
+      raise NotImplementedError( "#{including_module.class.name} must have an add_action method" )
+    end
   end
   
-  def collect_actions=( arr )
-    @collect_actions = arr
+  # Outer block for the build process.
+  def build_actions( &block )
+    raise 'a block must be present' if block.nil?
+    if block.arity == -1
+      instance_eval &block
+    else
+      yield self
+    end
   end
   
-  # create a new separator
+  # Create a new separator and add a new separator.
   def separator
     Qt::Action.construct( parent ) do |action|
       action.separator = true
@@ -69,27 +98,29 @@ module ActionBuilder
     end
   end
   
-  # create and return a list of actions. The actions are grouped together, but not
-  # as strongly as with Qt::ActionGroup
-  # a method called "#{group_name}_actions" will be added to self, which will return the
-  # set of Qt::Action instances created in the block
+  # Create and return a list of actions. The actions are grouped together, but not
+  # as strongly as with Qt::ActionGroup.
+  # A method called "#{group_name}_actions" will be added to self, which will return the
+  # set of Qt::Action instances created in the block.
   def list( group_name, &block )
     unless respond_to?( "#{group_name.to_s}_actions" )
       self.class.send( :define_method, "#{group_name.to_s}_actions" ) do
         eval "@#{group_name.to_s}_actions"
       end
     end
-    self.collect_actions = []
+    self.collect_actions.clear
     yield( self )
     # copy actions to the right instance variable
     eval "@#{group_name.to_s}_actions = collect_actions"
   end
   
-  # Create an action and add_action
-  # block takes predence over options[:method], which is a method
+  # Create a new Qt::Action and
+  # 1. pass it to Qt::Widget::add_action
+  # 1. add it to the collect_actions collection.
+  # The block takes predence over options[:method], which is a method
   # on self to be called.
-  # option keys can be any method in Qt::Action, ie :tool_tip, :shortcut, :status_tip etc
-  # a value for :shortcut is automatically passed to Qt::KeySequence.new
+  # Option keys can be any method in Qt::Action, ie :tool_tip, :shortcut, :status_tip etc.
+  # A value for :shortcut is automatically passed to Qt::KeySequence.new.
   def action( name_or_action, text = nil, options = {}, &block )
     if name_or_action.class == Qt::Action
       add_action( name_or_action )
@@ -114,15 +145,27 @@ module ActionBuilder
         # add action for Qt
         add_action action
         
-        # add actions for list. Yes, it's a side-effect. Is there a better way?
+        # add actions for list. Yes, it's a side-effect.
+        # TODO is there a better way to do this?
         collect_actions << action
         
         action_method_or_block( action, options, &block )
       end
     end
   end
+
+protected
+
+  # the set of actions created so far in a particular list.
+  def collect_actions
+    @collect_actions ||= []
+  end
+  
+  def collect_actions=( arr )
+    @collect_actions = arr
+  end
   
-  # if parent doesn't define this, add it so that 
+  # If parent doesn't define this, add it so that 
   # our action_method_or_block will work.
   unless instance_methods.include?( :action_triggered )
     def action_triggered( &someblock )

data/lib/qtext/extensions.rb

@@ -17,28 +17,6 @@ class Object
   end
 end
 
-class Class
-  # TODO Qt bindings will accept a block for new, which
-  # makes this somewhat irrelevant. Unless it's really
-  # necessary to pass args in
-  def construct_exec( *args, &block )
-    raise "block is nil" if block.nil?
-    inst = self.new( *args )
-    # using the Rails implementation, included in Qt
-    block.bind( inst )[*args]
-    # return the newly configured instance
-    inst
-  end
-
-  # see self.construct
-  def construct( *args, &block )
-    raise "block is nil" if block.nil?
-    inst = self.new( *args )
-    yield( inst )
-    inst
-  end
-end
-
 class NilClass
   def to_variant
     Qt::Variant.invalid
@@ -103,6 +81,7 @@ module Qt
   class ItemSelection
     include Enumerable
     
+    # Iterate through SelectionRange instances in this selection
     def each( &block )
       index = 0
       max = self.count
@@ -122,9 +101,6 @@ module Qt
     end
   end
   
-  # This provides a bunch of methods to get easy access to the entity
-  # and it's values directly from the index without having to keep
-  # asking the model and jumping through other unncessary hoops
   class ModelIndex
     # Because using Qt::ModelIndex.new the whole time is wasteful
     def self.invalid
@@ -133,7 +109,8 @@ module Qt
     
     alias_method :old_inspect, :inspect
     def inspect
-      if valid?
+      # need the self here otherwise Qt bindings get confused.
+      if self.valid?
         #<Qt::ModelIndex:0xb6004e8c>
         # fetch address from superclass inspect
         super =~ /ModelIndex:(.*)>/
@@ -157,7 +134,8 @@ module Qt
     
   end
 
-  # make keystrokes easier to work with
+  # Make keystrokes events easier to work with. For <tt>Qt::Key_Whatever</tt>
+  # events, KeyEvent instances will now respond to <tt>whatever?</tt>
   class KeyEvent
     # override otherwise the new method_missing fails
     # to call the old_method_missing
@@ -184,8 +162,7 @@ module Qt
     
     alias_method :old_method_missing, :method_missing
     
-    # shortcut for the Qt::Key_Whatever constants
-    # just say event.whatever?
+    # Provide a shortcut for the Qt::Key_Whatever constants. Just say event.whatever?
     def method_missing( sym, *args )
       begin
         if sym.to_s[-1] == "?"[0]
@@ -218,10 +195,10 @@ module Qt
   end
   
   class TableView
-    # otherwise model object gets garbage-collected
-    def model=( m )
-      @model = m
-      super( m )
+    # store the model in a data member, otherwise it gets garbage-collected.
+    def model=( model )
+      @model = model
+      super( model )
     end
   end
   
@@ -266,9 +243,11 @@ module Qt
   
   class Widget
     # add a signal with the given signature, and create
-    # a method called method_name which will return the signal
+    # a method called method_name which will emit the signal, 
+    # a method called method_name_signal which will return the signal
     # ready to be used in a connect. If method_name is not provided
-    # the method will be named as the name part of signature 
+    # the method will be named as the name part of signature.
+    # Also create a handler on_method_name {|*args| }
     def self.construct_signal( signature, method_name = nil )
       # add the signal
       q_signal( signature )
@@ -286,7 +265,62 @@ module Qt
         SIGNAL( signature )
       end
       
-      # TODO create the connection method
+      # create the connection method
+      line, st = __LINE__, <<-EOF
+        def on_#{base_method_name}( &block )
+          connect( #{method_name} ) do |*args|
+            yield( *args )
+          end
+        end
+      EOF
+      class_eval st, __FILE__, line + 1
+    end
+    
+    # specify a signal symbol, and add the other methods, namely
+    # - <tt>symbol</tt> which emits the signal
+    # - <tt>symbol_signal</tt> which is the method added by q_signal, ie the actual Qt emitter
+    # - <tt>on_symbol {|*args| }</tt> which is the handler
+    def self.signal( symbol )
+      # add the signal emitter
+      signature = "#{symbol.to_s}_signal( QVariant & )"
+      q_signal( signature )
+      
+      # add an emitter
+      line_number, st = __LINE__, <<-EOF
+        def #{symbol.to_s}( *args )
+          #~ puts "ingoing args: \#\{args.inspect\}"
+          # convert args to variant(s)
+          variant =
+          case args.size
+            when 0; Qt::Variant.new
+            when 1; args[0].to_variant
+            else; Qt::Variant.new( args )
+          end
+          #~ puts "ingoing variant: \#\{variant.inspect\}"
+          emit #{symbol.to_s}_signal( variant )
+        end
+      EOF
+      class_eval st, __FILE__, line_number + 1
+      
+      # create the connection method
+      line_number, st = __LINE__, <<-EOF
+        def on_#{symbol.to_s}( &block )
+          Kernel.raise "on_#{symbol.to_s} must have a block" if block.nil?
+          connect( SIGNAL( '#{signature}' ) ) do |variant|
+            #~ puts "outcoming variant: \#\{variant.inspect\}"
+            # convert variants to Ruby objects
+            args =
+            case variant.typeName
+              when nil; nil
+              when 'QVariantList'; variant.value.map{|x| x.value}
+              else variant.value
+            end
+            #~ puts "outcoming args: \#\{args.inspect\}"
+            yield( *args )
+          end
+        end
+      EOF
+      class_eval st, __FILE__, line_number + 1
     end
   end
 

data/lib/qtext/object_table_model.rb

@@ -1,9 +1,17 @@
 require 'active_support'
 require 'qtext/flags.rb'
 
+=begin rdoc
+A header for ObjectTableModel.
+=end
 class Header
   attr_reader :attribute, :title, :alignment
-  
+
+  # args is a hash that can contain the following:
+  # - :attribute (required) is the name of the attribute on objects in the table's collection,
+  #   the values for which will be displayed in this column.
+  # - :title is the column header. Defaults to attribute.humanize
+  # - :alignment is one of the Qt::Align constants. Defaults to Qt::AlignLeft | Qt::AlignVCenter.
   def initialize( args = {} )
     raise "there must be an attribute" unless args.has_key?( :attribute )
     @attribute = args[:attribute]
@@ -13,23 +21,46 @@ class Header
 end
 
 =begin rdoc
-A Qt TableModel that is given a collection of objects, and a collection
-of headers, which are methods to call on the objects to populate columns
+A specialisation of Qt::TableModel that is given a collection of objects, and a collection
+of headers, which are methods to call on the objects to populate columns.
+
+Given
+  Thing = Struct.new( :name, :value, :location, :price, :other, :ignored )
+and
+  @data = method_to_create_lots_of_things
+The following will display the four named attributes in 4 columns
+  ObjectTableModel.new :data => @data, :headers => [ :name, :value, :location, :price ]
+and this will right-align the price column:
+  ObjectTableModel.new :data => @data, :headers => [ :name, :value, :location, Header.new( :attribute => :price, :alignment => Qt::AlignRight ) ]
 =end
 class ObjectTableModel < Qt::AbstractTableModel
   include QtFlags
   attr_reader :collection, :headers
   
-  # data => array of objects
-  # headers => array of methods to call on objects
+  # Rubyish method for rowCount
+  def row_count( parent_index = Qt::ModelIndex.invalid )
+    rowCount( parent_index )
+  end
+  
+  # Rubyish method for columnCount
+  def column_count( parent_index = Qt::ModelIndex.invalid )
+    columnCount( parent_index )
+  end
+  
+  # args can contain the following:
+  # - :parent => the Qt::Object that is the parent of this class.
+  # - :headers => array of either symbols representing the attribute on the
+  #   elements of the data collection, or Header instances.
+  # - :data => array of objects, with attributes corresponding to the headers
+  # - :collection is an alias for :data
   def initialize( args = {} )
-    super()
+    super( args[:parent] )
     @collection = args[:data] || args[:collection] || []
     set_headers( args[:headers] )
   end
 
   # implementation of Qt:AbstractItemModel method
-  def rowCount( parent_model_index )
+  def rowCount( parent_model_index = Qt::ModelIndex.invalid )
     if parent_model_index.valid?
       0
     else
@@ -45,16 +76,6 @@ class ObjectTableModel < Qt::AbstractTableModel
     end
   end
   
-  def attribute_for_index( column )
-    headers[column]
-  end
-  
-  def field_value_at( index )
-    obj = collection[index.row]
-    att = attribute_for_index( index.column ).attribute
-    obj.send( att ) unless obj.nil? or att.nil?
-  end
-
   # implementation of Qt:AbstractItemModel method
   def headerData( section, orientation, role )
     value =
@@ -152,7 +173,7 @@ class ObjectTableModel < Qt::AbstractTableModel
   end
   
   # implementation of Qt:AbstractItemModel method
-  # TODO make this editable
+  #-- TODO make this editable
   def flags( index )
     return 0 unless index.valid?
     super
@@ -162,6 +183,7 @@ class ObjectTableModel < Qt::AbstractTableModel
     collection[index]
   end
   
+  # Set the value at the index, and make sure the view is updated.
   def []=( index, value )
     if index >= collection.size
       beginInsertRows( Qt::ModelIndex.invalid, collection.size, collection.size + ( index - collection.size ) )
@@ -173,6 +195,7 @@ class ObjectTableModel < Qt::AbstractTableModel
     end
   end
 
+  # Insert a new object into the collection, and make sure the view is updated.
   def <<( obj )
     beginInsertRows( Qt::ModelIndex.invalid, collection.size, collection.size )
     collection << obj
@@ -198,7 +221,7 @@ class ObjectTableModel < Qt::AbstractTableModel
     reset
   end
 
-  # a collection of CheckableFields
+  # a collection of Header instances
   def headers=( arr )
     set_headers( arr )
     reset
@@ -215,4 +238,15 @@ protected
       end
     end
   end
+
+  def attribute_for_index( column )
+    headers[column]
+  end
+  
+  def field_value_at( index )
+    obj = collection[index.row]
+    att = attribute_for_index( index.column ).attribute
+    obj.send( att ) unless obj.nil? or att.nil?
+  end
+
 end

data/lib/qtext/version.rb

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

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/qtext.rb'}"
+puts "Loading qtext gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'qtext' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'qtext'
+
+require 'rubygems'
+begin
+  require 'newgem'
+  require 'rubyforge'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
+
+version  = Qtext::VERSION::STRING
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/test/test_helper.rb

@@ -1,2 +1,48 @@
 require 'test/unit'
 require File.dirname(__FILE__) + '/../lib/qtext'
+require 'shoulda'
+
+# Allow running of setup and teardown things before
+# an entire suite, instead of just one per test
+class SuiteWrapper < Test::Unit::TestSuite
+  attr_accessor :tests
+  
+  def initialize( name, test_case )
+    super( name )
+    @test_case = test_case
+  end
+  
+  def startup
+  end
+  
+  def shutdown
+  end
+  
+  def run( *args )
+    startup
+    @test_case.startup if @test_case.respond_to? :startup
+    retval = super
+    @test_case.shutdown if @test_case.respond_to? :shutdown
+    shutdown
+    retval
+  end
+end
+
+module Test
+  module Unit
+    class TestCase
+      unless respond_to? :old_suite
+        class << self
+          alias_method :old_suite, :suite
+        end
+        
+        def self.suite
+          os = old_suite
+          sw = SuiteWrapper.new( os.name, self )
+          sw.tests = os.tests
+          sw
+        end
+      end
+    end
+  end
+end

data/test/test_object_table.rb

@@ -3,25 +3,72 @@ require 'qtext/object_table_model.rb'
 require 'Qt4'
 
 class TestObjectTableModel < Test::Unit::TestCase
-  Thing = Struct.new( :name, :value, :location, :price )
+  Thing = Struct.new( :name, :value, :location, :price, :ignored )
+  
+  def self.startup
+    $app ||= Qt::Application.new( [] )
+  end
+  
   def setup
     @data = [
-      Thing.new( "Screwdriver", 'high', 'toolbox', 10.96 ),
-      Thing.new( "Thermometer", '15 degrees', 'bathroom', 0.01 ),
+      Thing.new( "Screwdriver", 'high', 'toolbox', 10.96, 'not' ),
+      Thing.new( "Thermometer", '15 degrees', 'bathroom', 0.01, 'here' ),
       Thing.new( "Bed", 'large', 'bedroom' ),
-      Thing.new( "Approximation", 'useful', 'maths', 'none' )
+      Thing.new( "Approximation", 'useful', 'maths', 'none', 'all' )
     ]
+    @model = ObjectTableModel.new( :data => @data, :headers => [ :name, :value, :location, Header.new( :attribute => :price, :alignment => Qt::AlignRight ) ] )
+    @main_window = Qt::MainWindow.new
+    @view = Qt::TableView.new( @main_window ) { |tv| tv.model = @model }
+    @main_window.central_widget = @view
+  end
+  
+  should 'have a 4 x 4 size' do
+    assert_equal 4, @model.rowCount
+    assert_equal 4, @model.row_count
+    assert_equal 4, @model.columnCount
+    assert_equal 4, @model.column_count
+  end
+  
+  should 'have 0x0 size for children models at a given index' do
+    index = @model.create_index(1,1)
+    assert_equal 0, @model.row_count( index )
+    assert_equal 0, @model.column_count( index )
+  end
+
+  should 'return correct data' do
+    @data.each_with_index do |item,i|
+      Thing.members.each_with_index do |member,j|
+        next if j >= 4
+        model_index = @model.create_index(i,j)
+        assert_equal item[member], @model.data( model_index ).value
+      end
+    end
+  end
+  
+  should 'return nil for invalid index' do
+    assert_equal Qt::Variant.invalid, @model.data( Qt::ModelIndex.invalid )
+  end
+  
+  should 'have price aligned right' do
+    assert_equal Qt::AlignLeft.to_i, @model.data( @model.create_index(0,0), Qt::TextAlignmentRole ).to_i & Qt::AlignLeft.to_i
+    assert_equal Qt::AlignLeft.to_i, @model.data( @model.create_index(0,1), Qt::TextAlignmentRole ).to_i & Qt::AlignLeft.to_i
+    assert_equal Qt::AlignRight.to_i, @model.data( @model.create_index(0,3), Qt::TextAlignmentRole ).to_i & Qt::AlignRight.to_i
+  end
+  
+  should_eventually 'display the window' do
+  #~ should 'display the window' do
+    @main_window.window_title = 'Test ObjectTableModel'
+    @main_window.move( 150, 0 )
+    @main_window.show
+    $app.exec
+  end
+  
+  should 'have a nil parent' do
+    assert_nil @model.parent
   end
   
-  def test_model
-    model = ObjectTableModel.new( :data => @data, :headers => [ :name, :value, :location, :price ] )
-    app = Qt::Application.new( [] )
-    main_window = Qt::MainWindow.new
-    main_window.central_widget = Qt::TableView.construct( main_window ) { |tv| tv.model = model }
-    
-    main_window.window_title = 'Test ObjectTableModel'
-    main_window.move( 150, 0 )
-    main_window.show
-    app.exec
+  should 'have parent == @model' do
+    model = ObjectTableModel.new( :parent => @model, :data => @data, :headers => [ :name, :value, :location, Header.new( :attribute => :price, :alignment => Qt::AlignRight ) ] )
+    assert_equal @model, model.parent
   end
 end

data/test/test_widget.rb

@@ -0,0 +1,106 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+$app = Qt::Application.new []
+
+class Thok < Qt::Widget
+  signal :whatever
+end
+
+class TestWidget < Test::Unit::TestCase
+
+  def setup
+    @thok = Thok.new
+  end
+  
+  should 'have a whatever_signal method' do
+    assert_equal 1, @thok.methods.grep( /^whatever_signal$/ ).size
+    assert_raise ArgumentError do
+      @thok.whatever_signal( 'hello' )
+    end
+    
+    assert_nothing_raised do
+      @thok.whatever_signal( 'hello'.to_variant )
+    end
+  end
+  
+  should 'have a whatever emitter' do
+    assert_equal 1, @thok.methods.grep( /^whatever$/ ).size
+    assert_nothing_raised { @thok.whatever }
+    assert_nothing_raised { @thok.whatever 1 }
+    assert_nothing_raised { @thok.whatever 1,2,3 }
+    assert_nothing_raised { @thok.whatever [4,5,6] }
+  end
+  
+  should 'have an on_whatever handler' do
+    assert_equal 1, @thok.methods.grep( /^on_whatever$/ ).size
+  end
+  
+  context 'on_whatever handler' do
+    should 'handle nil args' do
+      @thok.on_whatever do |arg|
+        assert_nil arg
+      end
+      @thok.whatever
+      @thok.whatever( nil )
+    end
+    
+    should 'handle single args' do
+      @thok.on_whatever do |arg|
+        assert_not_nil arg
+        assert_not_equal Array, arg.class
+      end
+      @thok.whatever 1
+      @thok.whatever 'hello'
+    end
+    
+    should_eventually 'handle objects' do
+      NVP = Struct.new :name, :value
+      nvp = NVP.new
+      nvp.name = 'how'
+      nvp.value = 'that'
+      @thok.on_whatever do |arg|
+        assert_not_nil arg
+        assert_equal NVP, arg.class
+      end
+      @thok.whatever nvp
+    end
+    
+    should 'handle arg lists' do
+      @thok.on_whatever do |arg1,arg2|
+        assert_not_nil arg1
+        assert_not_nil arg2
+        assert_not_equal Array, arg1.class
+        assert_not_equal Array, arg2.class
+      end
+      @thok.whatever 1,2
+      @thok.whatever 'hello','there'
+    end
+    
+    should 'handle a single array' do
+      @thok.on_whatever do |ary|
+        assert_not_nil ary
+        assert_equal Array, ary.class
+        assert_equal 3, ary.size
+        assert_equal [4,5,6], ary
+      end
+      @thok.whatever [4,5,6]
+    end
+    
+    should_eventually 'handle multiple arrays' do
+      @thok.on_whatever do |ary1,ary2|
+        assert_not_nil ary1
+        assert_not_nil ary2
+        assert_equal Array, ary1.class
+        assert_equal Array, ary2.class
+        assert_equal 3, ary1.size
+        assert_equal 3, ary2.size
+        # fails here because ary1 is an array of variants
+        puts "ary1: #{ary1.inspect}"
+        assert_equal [4,5,6], ary1
+        assert_equal [7,8,9], ary2
+      end
+      @thok.whatever( [4,5,6], [7,8,9] )
+    end
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: qtext
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - FIXME full name
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-21 00:00:00 +02:00
+date: 2008-10-09 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,25 +30,38 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
 - README.txt
 files: 
+- History.txt
+- License.txt
+- Manifest.txt
 - README.txt
+- Rakefile
+- config/hoe.rb
+- config/requirements.rb
+- env.sh
 - lib/qtext.rb
 - lib/qtext/action_builder.rb
-- lib/qtext/version.rb
-- lib/qtext/flags.rb
 - lib/qtext/extensions.rb
+- lib/qtext/flags.rb
 - lib/qtext/object_table_model.rb
+- lib/qtext/version.rb
+- script/console
+- script/destroy
+- script/generate
+- script/txt2html
+- tasks/deployment.rake
+- tasks/environment.rake
+- tasks/website.rake
+- test/test_helper.rb
+- test/test_object_table.rb
+- test/test_widget.rb
 has_rdoc: true
 homepage: http://qtext.rubyforge.org
-post_install_message: |+
-  
-  For more information on qtext, see http://qtext.rubyforge.org
-  
-  NOTE: Change this information in PostInstall.txt 
-  You can also delete it if you don't want it.
-  
-  
+post_install_message: ""
 rdoc_options: 
 - --main
 - README.txt
@@ -75,5 +88,5 @@ specification_version: 2
 summary: description of gem
 test_files: 
 - test/test_object_table.rb
-- test/test_qtext.rb
+- test/test_widget.rb
 - test/test_helper.rb

data/test/test_qtext.rb

@@ -1,11 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-
-class TestQtext < Test::Unit::TestCase
-
-  def setup
-  end
-  
-  def test_truth
-    assert true
-  end
-end