clevic 0.8.0 → 0.11.1

data/History.txt

@@ -1,3 +1,12 @@
+== 0.11.1
+* Define views in separate classes (subclass of Clevic::View) while
+	maintaining view definition inside the ActiveRecord::Base subclass.
+* foreground and background color specifiers for fields
+* better handling of virtual fields
+* more tests
+* make Clevic::Record a module to be included in an ActiveRecord::Base
+* use Gather for hash/block value collection.
+
 == 0.8.0
 * Big improvements to the way the UI is defined in Entity classes.
 * Show Entity-specific menus, both in the menu bar and as a right-click.

data/Manifest.txt

@@ -4,27 +4,29 @@ README.txt
 Rakefile
 TODO
 bin/clevic
-bin/import-times
 config/hoe.rb
-config/jamis.rb
 config/requirements.rb
-env.sh
-lib/active_record/dirty.rb
+lib/clevic/dirty.rb
 lib/clevic.rb
 lib/clevic/browser.rb
 lib/clevic/cache_table.rb
 lib/clevic/db_options.rb
+lib/clevic/default_view.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
+lib/clevic/order_attribute.rb
 lib/clevic/record.rb
 lib/clevic/search_dialog.rb
+lib/clevic/sql_dialects.rb
 lib/clevic/table_model.rb
+lib/clevic/table_searcher.rb
 lib/clevic/table_view.rb
+lib/clevic/view.rb
+lib/clevic/ui/.gitignore
 lib/clevic/ui/browser.ui
 lib/clevic/ui/browser_ui.rb
 lib/clevic/ui/icon.png
@@ -44,8 +46,9 @@ sql/accounts.sql
 sql/times.sql
 sql/times_sqlite.sql
 tasks/website.rake
-website/index.html
-website/index.txt
-website/screenshot.png
-website/stylesheets/screen.css
-website/template.html.erb
+test/test_cache_table.rb
+test/test_helper.rb
+test/test_model_index_extensions.rb
+test/test_order_attribute.rb
+test/test_sql_dialects.rb
+test/test_table_searcher.rb

data/README.txt

@@ -37,20 +37,17 @@ in Linux, slightly tested in Windows and OSX.
 
 === Model definition:
 
-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
-a DSL for defining more complex and useful behaviour (see Clevic::ModelBuilder).
+Models and their UI representation must be defined in Ruby. A descendant of ActiveRecord::Base
+that includes the Clevic::Record module will provide a minimally functional UI.
 
-Clevic also knows how to build a default UI with sensible defaults from
-ActiveRecord::Base subclasses.
+Beyond that, the framework provides a DSL for defining more complex and useful behaviour
+(see Clevic::ModelBuilder).
 
 In the models/ subdirectory, start with minimal_models.rb.
 account_models.rb and times_models.rb provide definitions for more real-world examples.
 Associated SQL schemas are in the sql subdirectory.
 
-For implementation and more extensive
-comments, see Clevic::Browser and Clevic::ModelBuilder.
+For implementation and more extensive comments, see Clevic::ModelBuilder.
 
 === Framework
 
@@ -84,7 +81,7 @@ See TODO file.
 === Other
 
 * bsearch (http://0xcc.net/ruby-bsearch)
-* active_record/dirty (included)
+* active_record/dirty (included, for active_record < 2.1.x)
 * db driver (ie postgres-pr)
 * rdbms (ie postgres)
 

data/Rakefile

@@ -15,7 +15,7 @@ end
 
 # list of .ui files
 UI_FILES = FileList.new( 'lib/clevic/ui/*.ui' )
-CLEAN.include( 'ChangeLog' )
+CLEAN.include( 'ChangeLog', 'coverage', 'profiling' )
 CLOBBER.include( 'ChangeLog', 'pkg', 'lib/clevic/ui/*_ui.rb' )
 
 UI_FILES.each do |ui_file|
@@ -57,12 +57,6 @@ task :run => :ui do |t|
   exec "ruby -Ilib bin/clevic #{ARGV.join(' ')}"
 end
 
-desc "Runs Clevic in warning mode, with test databases and debug flag on"
-task :sqlite => :ui do |t|
-  ARGV.shift()
-  exec "ruby -Ilib bin/clevic #{ARGV.join(' ')} times_sqlite_model.rb"
-end
-
 desc "Runs Clevic in debug mode, with test databases"
 task :debug => :ui do |t|
   ARGV.shift()
@@ -90,6 +84,7 @@ MODELS_LIST.each do |model_file|
   namespace :irb do
     task short_model( model_file ) do |t|
       ARGV.shift()
+      ARGV.shift() if ARGV[0] == '--'
       ENV['RUBYLIB'] ||= '.'
       ENV['RUBYLIB'] += ":#{File.expand_path('.')}/lib"
       exec "irb -Ilib -rclevic -r#{model_file} -rclevic/db_options.rb"
@@ -99,6 +94,17 @@ MODELS_LIST.each do |model_file|
   # generate runs
   namespace :run do
     desc "run clevic with #{model_file}"
+    task short_model( model_file )  => :ui do |t|
+      ARGV.shift()
+      ARGV.shift() if ARGV[0] == '--'
+      cmd = "ruby -Ilib bin/clevic -D #{model_file} #{ARGV.join(' ')}"
+      puts "cmd: #{cmd.inspect}"
+      exec cmd
+    end
+  end
+
+  namespace :warn do
+    desc "run clevic with #{model_file} and warnings on"
     task short_model( model_file )  => :ui do |t|
       ARGV.shift()
       exec "ruby -w -Ilib bin/clevic -D #{model_file} #{ARGV.join(' ')}"
@@ -108,25 +114,30 @@ end
 
 task :package => :ui
 
-# redefine this from the Hoe-1.7.0 sources to use
-# the jamis template.
-Rake::RDocTask.new(:docs) do |rd|
-  rd.main = "README.txt"
-  rd.options << '-d' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/ and not ENV['NODOT']
-  rd.rdoc_dir = 'doc'
-  rd.template = 'config/jamis.rb'
-  files = $hoe.spec.files.grep($hoe.rdoc_pattern)
-  files -= ['Manifest.txt']
-  rd.rdoc_files.push(*files)
-
-  title = "#{$hoe.name}-#{$hoe.version} Documentation"
-  title = "#{$hoe.rubyforge_name}'s " + title if $hoe.rubyforge_name != $hoe.name
-
-  rd.options << "-t #{title}"
-end
-
 desc "Update ChangeLog from the SVN log"
 task :changelog do |t|
   ARGV.shift
   exec "svn2cl --break-before-msg -o ChangeLog #{ARGV.join(' ')}"
 end
+
+# remove hoe documentation task
+Rake::Task['docs'].clear
+
+# make this respond to docs, so it fits in with the rest of the build
+Rake::RDocTask.new do |rdoc|
+  rdoc.name = :docs
+  rdoc.title = "Clevic DB UI builder"
+  rdoc.main = 'README.txt'
+  rdoc.rdoc_dir = 'doc'
+  rdoc.rdoc_files.include %w{History.txt lib/**/*.rb README.txt TODO}
+  rdoc.options += [
+      '-SHN',
+      '-f', 'darkfish',  # This is the important bit
+      '-A', 'property=Property',
+      #~ '--quiet',
+      "--opname=index.html",
+      #~ "--line-numbers",
+      #~ '--format=darkfish',
+      #~ "--inline-source"
+    ]
+end

data/TODO

@@ -1,8 +1,23 @@
-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
+need a :name specified for Field that defaults to the attribute name
+allow directories for a setup.
+implement the :default field option
+ModelBuilder#modify_field to override default_ui definitions
+rename ModelBuilder to ViewBuilder?
+
+need a text field (multiple lines, edit in a separate window)
+need a map field (For ie -1 = short, 1 = long). Already in restricted, but it's kinda clunky.
+:records missing in define_ui causes a crash
+
+:display and :format in ModelBuilder
+tests. Use ZenTest to generate tests
+Check out ar-extensions. Like operators look nice.
+make sure ActiveRecord doesn't keep updating column definitions. ie production mode.
+caching of repeated related entity lookups. Possibly ActiveRecord::QueryCache
+Ramen http://ramen.rubyforge.org/ for metadata. MySQL and MSSQL only right now.
+
+metadata for virtual fields. Add a member to Field for class_name.constantize
+consolidate metadata across TableModel, and Field. Would like to have it all in Field.
+gui_value vs attribute_value vs field_value etc
 generate models - DrySQL
 allow moving of tabs
 habtm relations
@@ -14,17 +29,16 @@ sorting by header. See void QAbstractItemModel::sort ( int column, Qt::SortOrder
 - layoutChanged
 
 undo
+- could possibly handle this in the TableModel
 - 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
+- memoize
 
 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
-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
 
@@ -33,7 +47,7 @@ moving of columns
 /-style filtering?
 
 for dates, add year if not specified, with 6 months on either side range. Configurable?
-value formatting not in model
+value parsing not in model
 copy a field from a mouse-selection (ctrl-b maybe)
 hiding of fields
 
@@ -68,11 +82,11 @@ Ctrl-; date formatting goes 07--08 instead of 07-Apr-08. But typing the full mon
 
 empty database
 --------------
-resize fields for first record, while it's being entered. use Qt::ExpandingLineEdit for ComboDelegate? Doesn't exist in Ruby bindings
+resize fields for first record, while it's being entered. use Qt::ExpandingLineEdit for ComboDelegate? Doesn't exist in Ruby bindings.
 
 editing
 -------
-F2 for standard edit, F4 for calendar edit
+F2 for standard edit, F4 for full edit, ie text window, or calendar edit
 Only move for data_changed if field was exited with tab, not enter.
 tooltips for tabs
 Help in general for new data capture people
@@ -101,14 +115,15 @@ changes more or less instantly.
 preferences
 -----------
 store previous searches, by model & app
+store year ranges for 2 digit years in dates.
 
 maybe
 -----
-acts_as_shellable looks nices
+acts_as_shellable looks nice
 consolidate read-only-ness checks 
 Look at DataMapper. Not suitable - need to declare properties.
-use rubigen for creating model definition files
-ActiveMDB for migrating.
+use rubigen for creating model definition files?
+ActiveMDB for migrating?
 allow moving of rows
 discontiguous copying of entities/csv
 multi-row copying
@@ -125,7 +140,6 @@ QueryBuilder
 Accounts
 --------
 paste of "common" records with different dates
-restricted type for Account Type record
 
 Times
 -----
@@ -133,5 +147,3 @@ Times
 Ctrl-Shift-" should not copy date if it already exists, and should not copy time if it's a different date.
 Ctrl-Shift-" after it's done, tab doesn't change fields
 look up invoice for project leaves the wrong fields highlighted, and focus in the wrong field.
-warnings on overlap times (in status bar, or highlight)
-warnings on large intervals (in status bar, or highlight)

data/bin/clevic

@@ -2,8 +2,8 @@
 
 require 'pathname'
 
+require 'clevic.rb'
 require 'clevic/browser.rb'
-require 'clevic/db_options.rb'
 require 'optparse'
 require 'active_support'
 
@@ -38,49 +38,91 @@ if $options[:debug]
   pp $options
 end
 
+unless $options[:verbose]
+  # turn off "Object#type deprecated" messages
+  # and anything else output by rb_warn
+  $VERBOSE = nil
+end
+
 class Pathname
   # require this pathname if it exists
   def require_if_exists
     require realpath.to_s if exist?
   end
+
+  # just for fun, really
+  alias_method :/, :+
+end
+
+def subclasses( base )
+  classes = []
+  ObjectSpace.each_object( Class ) do |x|
+    if x.ancestors.include?( base )
+      case
+        when x == ActiveRecord::Base; # don't include this
+        else; classes << x
+      end
+    end
+  end
+  classes.sort{|a,b| a.name <=> b.name}
 end
 
 def load_rails_models( root, config, models )
   # initialize Rails
-  load config + 'environment.rb'
-  #~ puts "RAILS_ROOT: #{RAILS_ROOT.inspect}"
+  load config / 'environment.rb'
   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 lib/ files for the rails project
+  $: << ( root / 'lib' ).realpath.to_s
+  ( root / 'lib' ).children.each do |filename|
     load filename if filename.file?
   end
-  
-  # TODO check for Dirty in 2.1.x
-  ActiveRecord::Base.send(:include, ActiveRecord::Dirty)
+
+  # include Dirty if it isn't already
+  begin
+    ActiveRecord::Dirty
+  rescue NameError
+    ActiveRecord::Base.send(:include, ActiveRecord::Dirty)
+  end
   
   # load models
-  models.children.each_with_index do |filename,i|
-  #~ %w{subscriber}.map{|x| models + "#{x}.rb"}.each_with_index do |filename,i|
+  models.find do |dir_entry|
+    # don't load directory entries
+    next unless dir_entry.file?
+    # only load .rb files
+    next unless dir_entry.basename.to_s =~ /\.rb$/
     begin
-      load filename if filename.file?
+      load dir_entry
     rescue Exception => e
-      puts "Error loading #{filename.basename.to_s}: #{e.message.inspect}"
+      puts "Error loading #{dir_entry.basename.to_s}: #{e.message}"
       puts e.backtrace
     end
   end
+  
+  # include the Clevic::Record module in each descendant of
+  # ActiveRecord::Base so that the default views will be created.
+  subclasses( ActiveRecord::Base ).each do |model|
+    if model.table_exists?
+      model.send :include, Clevic::Record unless model.abstract_class?
+    end
+  end
+end
+
+def load_single_model_file( pathname )
+  ( pathname + '.rb' ).require_if_exists
+  pathname.require_if_exists
+  ( pathname + '_models' ).require_if_exists
+  ( pathname + '_models.rb' ).require_if_exists
 end
 
 def load_models( pathname )
   if pathname.directory?
-    config = pathname + 'config'
-    app = pathname + 'app'
-    models = app + 'models'
+    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"
@@ -88,26 +130,31 @@ def load_models( pathname )
     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
+    load_single_model_file( pathname )
   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
-main_window = Qt::MainWindow.new
-browser = Clevic::Browser.new( main_window )
-# this must come after Clevic::Browser.new
-# TODO should really find a better place for this
-main_window.window_title = $options[:database]
-main_window.show
-# make sure any partially edited records are saved when the window is closed
-app.connect( SIGNAL('lastWindowClosed()') ) { browser.save_all }
-app.exec
+begin
+  # 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
+  main_window = Qt::MainWindow.new
+  browser = Clevic::Browser.new( main_window )
+  # this must come after Clevic::Browser.new
+  main_window.show
+  # make sure any partially edited records are saved when the window is closed
+  app.connect( SIGNAL('lastWindowClosed()') ) { browser.save_all }
+  begin
+    app.exec
+  rescue
+    puts $!.message
+    puts $!.backtrace
+  end
+rescue Exception => e
+  puts e.message
+  puts e.backtrace
+end