clevic 0.7.0 → 0.8.0

data/Manifest.txt

@@ -17,6 +17,7 @@ lib/clevic/db_options.rb
 lib/clevic/delegates.rb
 lib/clevic/extensions.rb
 lib/clevic/field.rb
+lib/clevic/field_builder.rb
 lib/clevic/item_delegate.rb
 lib/clevic/model_builder.rb
 lib/clevic/model_column.rb

data/README.txt

@@ -9,7 +9,8 @@ editing of tables in a pre-existing relational DBMS.
 
 Using ActiveRecord means Clevic supports Postgresql, Mysql and so on. It's been tested with Postgres and sqlite.
 
-Using Qt means it runs on Linux, Windows and OSX.
+Using Qt means it runs on Linux, Windows and OSX. Thoroughly tested
+in Linux, slightly tested in Windows and OSX.
 
 == FEATURES:
 
@@ -22,6 +23,7 @@ Using Qt means it runs on Linux, Windows and OSX.
 * Filter by current field.
 * search by field contents.
 * cut and paste in CSV format
+* point Clevic at a Rails project and see your models in a GUI
 
 === Shortcuts:
 
@@ -37,9 +39,11 @@ Using Qt means it runs on Linux, Windows and OSX.
 
 Models and their UI representation must be defined in Ruby. A class that
 inherits from Clevic::Record (which itself inherits from ActiveRecord::Base) will provide
-a minimally functional UI.
-Beyond that, the framework provides
-an easy Rails-migrations-like syntax for defining more complex and useful behaviour.
+a minimally functional UI. Beyond that, the framework provides
+a DSL for defining more complex and useful behaviour (see Clevic::ModelBuilder).
+
+Clevic also knows how to build a default UI with sensible defaults from
+ActiveRecord::Base subclasses.
 
 In the models/ subdirectory, start with minimal_models.rb.
 account_models.rb and times_models.rb provide definitions for more real-world examples.
@@ -57,18 +61,17 @@ comments, see Clevic::Browser and Clevic::ModelBuilder.
 * leverages SQL whenever possible to handle large datasets, sorting, filtering
   etc. So it's probably not suitable for talking to a remote db across a slow link.
 
-=== Plans
-
-* sortable by row headers
-* color highlighting of fields and records on definable criteria
-
 == PROBLEMS:
 
 See TODO file.
 
 == SYNOPSIS:
 
-	clevic model_definition_file
+	clevic model_definition_file.rb
+	
+	OR
+	
+	clevic path_to_rails_project [model_tweaks.rb]
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -72,6 +72,7 @@ end
 desc "irb in this project's context"
 task :irb do |t|
   ARGV.shift()
+  ENV['RUBYLIB'] ||= ''
   ENV['RUBYLIB'] += ":#{File.expand_path('.')}/lib"
   exec "irb -Ilib -rclevic"
 end
@@ -124,8 +125,8 @@ Rake::RDocTask.new(:docs) do |rd|
   rd.options << "-t #{title}"
 end
 
-desc "Update History.txt from the SVN log"
-task :history do |t|
+desc "Update ChangeLog from the SVN log"
+task :changelog do |t|
   ARGV.shift
-  exec "svn2cl --break-before-msg -o History.txt #{ARGV.join(' ')}"
+  exec "svn2cl --break-before-msg -o ChangeLog #{ARGV.join(' ')}"
 end

data/TODO

@@ -1,31 +1,32 @@
-Make sure shortcuts don't edit a read-only field
+rename model_class to entity_class, and related terminology clarification.
+tests
+allow directories for a setup. Problem here is tab order.
+metadata for virtual fields
+exception when ditto-left/right to a field with incompatible type
 generate models - DrySQL
+allow moving of tabs
+habtm relations
+has_many :through
+composed_of & aggregates
+generate schema from definition? See rubyforge
 Ctrl-PgDn to last row in this column. Also extend selection
 sorting by header. See void QAbstractItemModel::sort ( int column, Qt::SortOrder order = Qt::AscendingOrder )
 - layoutChanged
 
-search with acts_as_searchable and hyperestraier
-
 undo
 - acts_as_trashable to undo deletes
 - other commands. Possibly via ActiveRecord callbacks?
 - Keep a history of changes, ie xy, new. xy, changed. x,y copied etc.
+- Use Transaction::Simple?
+- undo of field changes
 
 Using F4 to open list, and then selecting from the combo and exiting using Return (or tab?) doesn't set the correct value
 wrap description, and allow Access-style zooming
-
-search in relational fields doesn't work because the search value is compared to the id of the related record
-Use Webrick as a way to export CSV reports?
-See Ruport and Documatic for reports
-
-generate models - DrySQL
 Ctrl-PgDn to last row in this column. Also extend selection
 sorting by header. See void QAbstractItemModel::sort ( int column, Qt::SortOrder order = Qt::AscendingOrder )
 - layoutChanged
 
 search with acts_as_searchable and hyperestraier
-acts_as_trashable to undo deletes
-implement undo of field changes
 
 moving of columns
 /-style keyboard search by selected column, or everything if no column selected
@@ -41,7 +42,7 @@ filtering by various things. http://doc.trolltech.com/4.3/qsortfilterproxymodel.
 highlighting by various things
 cut and paste (in model format)
 
-drop cached model objects from CacheTable when they're not in use
+drop cached model objects from CacheTable when they're not in use. WeakRef?
 
 allow scroll viewport to centre when at end of dataset
 QAbstractItemView::ScrollHint
@@ -51,6 +52,12 @@ QAbstractItemView::ScrollHint
     \value PositionAtBottom  Scroll to position the item at the bottom of the viewport.
     \value PositionAtCenter  Scroll to position the item at the center of the viewport.
 
+Reports
+-------
+Use Webrick as a way to export CSV reports?
+See Ruport and Documatic for reports
+Ruby Datavision Bridge for reports
+
 OSX
 ---
 Check that qtruby4 runs on OSX and so does Clevic. It does. Very slowly on Mac Mini with Motorola.
@@ -83,7 +90,7 @@ shortcut sets, depending on which OS you're used. use QKeyEvent::matches ( QKeyS
 
 Doing data capture, sort by id, but unfilter reverts to date/id rather than entry order
 optional warnings for back-dated entries. Highlighting 
-make sure bsearch easier to install
+make bsearch easier to install
 
 handle db errors
 easier way to run models, search LOAD_PATH
@@ -97,8 +104,11 @@ store previous searches, by model & app
 
 maybe
 -----
+acts_as_shellable looks nices
+consolidate read-only-ness checks 
 Look at DataMapper. Not suitable - need to declare properties.
 use rubigen for creating model definition files
+ActiveMDB for migrating.
 allow moving of rows
 discontiguous copying of entities/csv
 multi-row copying
@@ -106,6 +116,11 @@ pasting of csv, into rectangular regions
 collect a set of data requests to the model, and do them in one SQL query. See EntryTableView#moveCursor
 Use SQL cursors for find & find_next?
 Use roo to parse spreadsheets?
+Criteria for SQL statement building http://criteria.rubyforge.org/
+SqlCache
+SqlStatement
+Csv2Sql
+QueryBuilder
 
 Accounts
 --------

data/bin/clevic

@@ -1,13 +1,12 @@
 #! /usr/bin/ruby
 
+require 'pathname'
+
 require 'clevic/browser.rb'
+require 'clevic/db_options.rb'
 require 'optparse'
+require 'active_support'
 
-# find and require variations on file_path
-def require_if( file_path )
-  require file_path if File.exist?( file_path ) || File.exist?( file_path + '.rb' )
-end
-  
 $options = {}
 oparser = OptionParser.new
 oparser.banner = <<BANNER
@@ -22,6 +21,7 @@ oparser.separator ''
 oparser.on( '-H', '--host HOST', 'RDBMS host', String ) { |o| $options[:host] = o }
 oparser.on( '-u', '--user USERNAME', String ) { |o| $options[:username] = o }
 oparser.on( '-p', '--pass PASSWORD', String ) { |o| $options[:password] = o }
+oparser.on( '-P', '--profile PROFILE', String ) { |o| $options[:profile] = o }
 oparser.on( '-t', '--table TABLE', 'Table to display', String ) { |o| $options[:table] = o }
 oparser.on( '-d', '--database DATABASE', 'Database name', String ) { |o| $options[:database] = o }
 oparser.on( '-D', '--debug' ) { |o| $options[:debug] = true }
@@ -38,14 +38,67 @@ if $options[:debug]
   pp $options
 end
 
-if args.size > 0
-  $options[:definition] = args.shift
-  require_if "#{$options[:definition]}_models"
-  require_if $options[:definition]
-else
-  raise "no model definition file specified"
+class Pathname
+  # require this pathname if it exists
+  def require_if_exists
+    require realpath.to_s if exist?
+  end
 end
 
+def load_rails_models( root, config, models )
+  # initialize Rails
+  load config + 'environment.rb'
+  #~ puts "RAILS_ROOT: #{RAILS_ROOT.inspect}"
+  require 'initializer.rb'
+  Rails::Initializer.run do |config|
+    config.frameworks -= [ :action_mailer, :action_pack, :active_resource ]
+  end
+  
+  # load lib/ files
+  $: << ( root + 'lib' ).realpath.to_s
+  ( root + 'lib' ).children.each do |filename|
+    puts "filename: #{filename.inspect}"
+    load filename if filename.file?
+  end
+  
+  # TODO check for Dirty in 2.1.x
+  ActiveRecord::Base.send(:include, ActiveRecord::Dirty)
+  
+  # load models
+  models.children.each_with_index do |filename,i|
+  #~ %w{subscriber}.map{|x| models + "#{x}.rb"}.each_with_index do |filename,i|
+    begin
+      load filename if filename.file?
+    rescue Exception => e
+      puts "Error loading #{filename.basename.to_s}: #{e.message.inspect}"
+      puts e.backtrace
+    end
+  end
+end
+
+def load_models( pathname )
+  if pathname.directory?
+    config = pathname + 'config'
+    app = pathname + 'app'
+    models = app + 'models'
+    # check if this is a Rails directory
+    if config.exist? && app.exist? && models.exist?
+      # this is probably a Rails project"
+      load_rails_models( pathname, config, models )
+    end
+  else
+    # assume we have a single file, and try some variations
+    ( pathname + '.rb' ).require_if_exists
+    pathname.require_if_exists
+    ( pathname + '_models' ).require_if_exists
+    ( pathname + '_models.rb' ).require_if_exists
+  end
+end
+
+# load model files
+raise "no model definition file specified" if args.empty?
+args.each { |arg| load_models( Pathname.new( arg ) ) }
+
 app = Qt::Application.new( args )
 
 # show UI

data/config/hoe.rb

@@ -8,7 +8,7 @@ RUBYFORGE_PROJECT = 'clevic' # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
 EXTRA_DEPENDENCIES = [
-    ['qtext', '>=0.4.1'],
+    ['qtext', '>=0.5.0'],
     ['activerecord', '=2.0.2'],
     ['fastercsv', '>=1.2.3']
     # This isn't always installed from gems

data/lib/clevic/browser.rb

@@ -1,22 +1,13 @@
 require 'clevic/search_dialog.rb'
 require 'clevic/ui/browser_ui.rb'
+require 'clevic/record.rb'
+require 'clevic.rb'
 
 module Clevic
 
 =begin rdoc
-The main application class. Each model for display should have a self.ui method
-which returns a Clevic::TableView instance, usually in conjunction with
-a ModelBuilder.
-
-  Clevic::TableView.new( Entry, parent ).create_model.new( Entry, parent ).create_model
-    .
-    .
-    .
-  end
-  
-Model instances may also implement <tt>self.key_press_event( event, current_index, view )</tt>
-and <tt>self.data_changed( top_left_index, bottom_right_index, view )</tt> methods so that
-they can respond to editing events and do Neat Stuff.
+The main application class. Display as many tabs as there are Clevic::Record or ActiveRecord::Base
+subclasses. 
 =end
 class Browser < Qt::Widget
   slots *%w{dump() refresh_table() filter_by_current(bool) next_tab() previous_tab() current_changed(int)}
@@ -38,26 +29,48 @@ class Browser < Qt::Widget
     @layout.main_widget.layout.add_widget @tables_tab
     @tables_tab.tab_bar.focus_policy = Qt::NoFocus
     
-    # connect slots
-    @layout.action_dump.connect       SIGNAL( 'triggered()' ),          &method( :dump )
-    @layout.action_refresh.connect    SIGNAL( 'triggered()' ),          &method( :refresh_table )
-    @layout.action_filter.connect     SIGNAL( 'triggered(bool)' ),      &method( :filter_by_current )
+    # hide the file menu, for now
+    @layout.menubar.remove_action( @layout.menu_file.menu_action )
+    
+    # tab navigation
     @layout.action_next.connect       SIGNAL( 'triggered()' ),          &method( :next_tab )
     @layout.action_previous.connect   SIGNAL( 'triggered()' ),          &method( :previous_tab )
-    @layout.action_find.connect       SIGNAL( 'triggered()' ),          &method( :find )
-    @layout.action_find_next.connect  SIGNAL( 'triggered()' ),          &method( :find_next )
-    @layout.action_new_row.connect    SIGNAL( 'triggered()' ),          &method( :new_row )
+
+    # dump model for current tab
+    @layout.action_dump.visible = $options[:debug]
+    @layout.action_dump.connect       SIGNAL( 'triggered()' ),          &method( :dump )
     
     tables_tab.connect                SIGNAL( 'currentChanged(int)' ),  &method( :current_changed )
     
-    # as an example
-    #~ tables_tab.connect SIGNAL( 'currentChanged(int)' ) { |index| puts "other current_changed: #{index}" }
     load_models
+    update_menus
   end
   
-  # activated by Ctrl-D for debugging
+  def update_menus
+    # update edit menu
+    @layout.menu_edit.clear
+    
+    # do the model-specific menu items first
+    table_view.model_actions.each do |action|
+      @layout.menu_edit.add_action( action )
+    end
+    
+    # now do the generic edit items
+    table_view.edit_actions.each do |action|
+      @layout.menu_edit.add_action( action )
+    end
+    
+    # update search menu
+    @layout.menu_search.clear
+    table_view.search_actions.each do |action|
+      @layout.menu_search.add_action( action )
+    end
+  end
+  
+  # activated by Ctrl-Shift-D for debugging
   def dump
-    puts "table_view.model: #{table_view.model.inspect}" if table_view.class == Clevic::TableView
+    puts "table_view.model: #{table_view.model.inspect}"
+    puts "table_view.model.model_class: #{table_view.model.model_class.inspect}"
   end
   
   # return the Clevic::TableView object in the currently displayed tab
@@ -69,57 +82,6 @@ class Browser < Qt::Widget
     @tables_tab
   end
   
-  # display a search dialog, and find the entered text
-  def find
-    @search_dialog ||= SearchDialog.new
-    result = @search_dialog.exec( table_view.current_index.gui_value )
-    
-    override_cursor( Qt::BusyCursor ) do
-      case result
-        when Qt::Dialog::Accepted
-          search_for = @search_dialog.search_text
-          table_view.search( @search_dialog )
-        when Qt::Dialog::Rejected
-          puts "Don't search"
-        else
-          puts "unknown dialog code #{result}"
-      end
-    end
-  end
-  
-  def find_next
-    if @search_dialog.nil?
-      @layout.statusbar.show_message( 'No previous find' )
-    else
-      override_cursor( Qt::BusyCursor ) do
-        save_from_start = @search_dialog.from_start?
-        @search_dialog.from_start = false
-        table_view.search( @search_dialog )
-        @search_dialog.from_start = save_from_start
-      end
-    end
-  end
-  
-  # force a complete reload of the current tab's data
-  def refresh_table
-    override_cursor( Qt::BusyCursor ) do
-      table_view.model.reload_data
-    end
-  end
-  
-  # toggle the filter, based on current selection.
-  def filter_by_current( bool_filter )
-    # TODO if there's no selection, use the current index instead
-    table_view.filter_by_indexes( table_view.selection_model.selected_indexes )
-    
-    # set the checkbox in the menu item
-    @layout.action_filter.checked = table_view.filtered
-    
-    # update the tab, so there's a visual indication of filtering
-    tab_title = table_view.filtered ? translate( '| ' + table_view.model_class.name.humanize ) : translate( table_view.model_class.name.humanize )
-    tables_tab.set_tab_text( tables_tab.current_index, tab_title )
-  end
-  
   # slot to handle Ctrl-Tab and move to next tab, or wrap around
   def next_tab
     tables_tab.current_index = 
@@ -140,15 +102,11 @@ class Browser < Qt::Widget
     end
   end
   
-  def new_row
-    table_view.model.add_new_item
-  end
-  
   # slot to handle the currentChanged signal from tables_tab, and
   # set focus on the grid
   def current_changed( current_tab_index )
-    tables_tab.current_widget.setFocus
-    @layout.action_filter.checked = table_view.filtered
+    update_menus
+    tables_tab.current_widget.set_focus
   end
   
   # shortcut for the Qt translate call
@@ -156,37 +114,20 @@ class Browser < Qt::Widget
     Qt::Application.translate("Browser", st, nil, Qt::Application::UnicodeUTF8)
   end
 
-  # return the list of descendants of ActiveRecord::Base
+  # return the list of descendants of ActiveRecord::Base, or
+  # of Clevic::Record
   def find_models
     models = []
-    ObjectSpace.each_object( Class ) {|x| models << x if x.ancestors.include?( Clevic::Record ) }
-    models
-  end
-  
-  # define a default ui with plain fields for all
-  # columns (except id) in the model. Could combine this with
-  # DrySQL to automate the process.
-  def define_default_ui( model )
-    reflections = model.reflections.keys.map{|x| x.to_s}
-    ui_columns = model.columns.reject{|x| x.name == 'id' }.map do |x|
-      att = x.name.gsub( '_id', '' )
-      if reflections.include?( att )
-        att
-      else
-        x.name
-      end
-    end
-    
-    Clevic::TableView.new( model, tables_tab ).create_model do
-      ui_columns.each do |column|
-        if model.reflections.has_key?( column.to_sym )
-          relational column.to_sym
-        else
-          plain column.to_sym
+    ObjectSpace.each_object( Class ) do |x|
+      if x.ancestors.include?( ActiveRecord::Base )
+        case
+          when x == ActiveRecord::Base; # don't include this
+          when x == Clevic::Record; # don't include this
+          else; models << x
         end
       end
-      records :order => 'id'
     end
+    models.sort{|a,b| a.name <=> b.name}
   end
   
   # Create the tabs, each with a collection for a particular model class.
@@ -194,18 +135,47 @@ class Browser < Qt::Widget
   # models parameter can be an array of Model objects, in order of display.
   # if models is nil, find_models is called
   def load_models
-    models = Clevic::Record.models || find_models
+    models = Clevic::Record.models
+    models = find_models if models.empty?
     
     # Add all existing model objects as tabs, one each
-    models.each do |model|
-      tab = 
-      if model.respond_to?( :ui )
-        model.ui( tables_tab )
-      else
-        define_default_ui( model )
+    models.each do |model_class|
+      begin
+        next unless model_class.table_exists?
+        
+        # create the the table_view and the table_model for the model_class
+        tab =
+        if model_class.respond_to?( :ui )
+          puts "Entity#ui deprecated. Use build_table_model instead."
+          model_class.ui( tables_tab )
+        else
+          Clevic::TableView.new( model_class, tables_tab )
+        end
+        
+        # show status messages
+        tab.connect( SIGNAL( 'status_text(QString)' ) ) { |msg| @layout.statusbar.show_message( msg, 10000 ) }
+        
+        # add a new tab
+        tables_tab.add_tab( tab, translate( model_class.name.demodulize.tableize.humanize ) )
+        
+        # add the table to the Table menu
+        action = Qt::Action.new( @layout.menu_model )
+        action.text = translate( model_class.name.demodulize.tableize.humanize )
+        action.connect SIGNAL( 'triggered()' ) do
+          tables_tab.current_widget = tab
+        end
+        @layout.menu_model.add_action( action )
+        
+        # handle filter status changed, so we can provide a visual indication
+        tab.connect SIGNAL( 'filter_status(bool)' ) do |status|
+          # update the tab, so there's a visual indication of filtering
+          tab_title = ( tab.filtered ? '| ' : '' ) + translate( model_class.name.humanize )
+          tables_tab.set_tab_text( tables_tab.current_index, tab_title )
+        end
+      rescue Exception => e
+        puts e.backtrace if $options[:debug]
+        puts "Model #{model_class} will not be available: #{e.message}"
       end
-      tab.connect( SIGNAL( 'status_text(QString)' ) ) { |msg| @layout.statusbar.show_message( msg, 20000 ) }
-      tables_tab.add_tab( tab, translate( model.name.humanize ) )
     end
   end