clevic 0.6.0 → 0.7.0

data/History.txt

@@ -1,3 +1,185 @@
+2008-07-25 12:04  panic
+
+	* bin/clevic, lib/clevic/db_options.rb:
+	  fix username not being overridden by command-line options
+
+2008-07-25 11:55  panic
+
+	* README.txt, Rakefile, TODO, bin/clevic, config/hoe.rb,
+	  lib/clevic/browser.rb, lib/clevic/db_options.rb,
+	  lib/clevic/record.rb, models/accounts_models.rb,
+	  models/times_models.rb, models/times_sqlite_models.rb:
+	  Automatically keep track of model definition order, and show
+	  tabs in that order. Group models under one Rake namespace.
+
+2008-07-25 11:35  panic
+
+	* website/index.html, website/index.txt,
+	  website/template.html.erb:
+	  more documentation
+
+2008-07-25 11:22  panic
+
+	* TODO:
+	  rearrange TODO
+
+2008-07-25 11:17  panic
+
+	* History.txt, Manifest.txt, README.txt, Rakefile, script/console:
+	  update packaging
+
+2008-07-24 21:09  panic
+
+	* accounts_models.rb, minimal_models.rb, models,
+	  models/accounts_models.rb, models/minimal_models.rb,
+	  models/times_models.rb, models/times_sqlite_models.rb,
+	  models/values_models.rb, times_models.rb, times_sqlite_model.rb,
+	  values_models.rb:
+	  move model definition files to their own directory
+
+2008-07-24 21:07  panic
+
+	* TODO, accounts_models.rb, times_models.rb, website/index.html:
+	  notes and comments
+
+2008-07-24 21:03  panic
+
+	* sql/accounts.sql, sql/times.sql:
+	  remove panic
+
+2008-07-24 21:00  panic
+
+	* Rakefile, accounts_models.rb, bin/clevic, lib/clevic.rb,
+	  lib/clevic/browser.rb, lib/clevic/db_options.rb,
+	  lib/clevic/item_delegate.rb, lib/clevic/record.rb,
+	  lib/clevic/table_model.rb, minimal_models.rb, times_models.rb,
+	  times_sqlite_model.rb, values_models.rb:
+	  Inherit models from Clevic::Record. Allow for minimal model
+	  definitions.
+
+2008-07-24 19:03  panic
+
+	* TODO, accounts_models.rb, bin/clevic, lib/clevic/cache_table.rb,
+	  lib/clevic/db_options.rb, lib/clevic/item_delegate.rb,
+	  lib/clevic/table_model.rb, lib/clevic/table_view.rb,
+	  times_models.rb, times_sqlite_model.rb:
+	  make sure current record is saved when tab loses focus
+
+2008-07-24 15:59  panic
+
+	* TODO, lib/clevic/field.rb, lib/clevic/table_view.rb:
+	  don't allow filtering on virtual fields
+
+2008-07-24 13:54  panic
+
+	* lib/clevic/extensions.rb, lib/clevic/model_builder.rb,
+	  lib/clevic/table_model.rb, lib/clevic/ui/browser.ui:
+	  UI and code tweaks
+
+2008-07-24 13:38  panic
+
+	* TODO, accounts_models.rb, lib/clevic/field.rb,
+	  lib/clevic/model_builder.rb, lib/clevic/table_model.rb,
+	  times_models.rb, times_sqlite_model.rb:
+	  Allow display of related fields as read-only. New read-only
+	  attribute for fields. Distinct now default sorts by frequency.
+	  All field types can now use a Proc for :display.
+
+2008-07-24 11:35  panic
+
+	* accounts_models.rb, lib/clevic/field.rb,
+	  lib/clevic/model_builder.rb, times_models.rb,
+	  times_sqlite_model.rb:
+	  fix some issue with display of relational fields
+
+2008-07-24 10:50  panic
+
+	* lib/clevic/delegates.rb:
+	  check before doing true/false gsub
+
+2008-07-24 10:44  panic
+
+	* TODO, accounts_models.rb, lib/clevic/cache_table.rb,
+	  lib/clevic/delegates.rb, lib/clevic/extensions.rb,
+	  lib/clevic/field.rb, lib/clevic/model_builder.rb,
+	  lib/clevic/table_model.rb, lib/clevic/version.rb,
+	  times_models.rb, times_sqlite_model.rb:
+	  allow for blocks to format relational delegates
+
+2008-07-23 09:46  panic
+
+	* Rakefile, TODO, accounts_models.rb, lib/clevic/db_options.rb,
+	  times_models.rb, values_models.rb:
+	  remove username. Do clobber list.
+
+2008-07-21 18:12  panic
+
+	* TODO:
+	  update todo
+
+2008-07-17 18:41  panic
+
+	* Rakefile, TODO, bin/clevic, config/hoe.rb,
+	  lib/clevic/cache_table.rb, lib/clevic/db_options.rb,
+	  lib/clevic/table_model.rb, lib/clevic/version.rb:
+	  fix search with sqlite
+
+2008-07-17 16:50  panic
+
+	* TODO, lib/clevic/db_options.rb, lib/clevic/delegates.rb,
+	  lib/clevic/field.rb, lib/clevic/item_delegate.rb, sql/times.sql,
+	  sql/times_sqlite.sql, times_models.rb, times_sqlite_model.rb:
+	  check that it works with sqlite
+
+2008-07-17 11:15  panic
+
+	* accounts_models.rb:
+	  really fix use of test database
+
+2008-07-17 10:48  panic
+
+	* Manifest.txt:
+	  add necessary generated files to Manifest
+
+2008-07-07 20:42  panic
+
+	* Manifest.txt, website/javascripts/rounded_corners_lite.inc.js:
+	  fix manifest
+
+2008-07-07 20:39  panic
+
+	* INSTALL, Rakefile, accounts_models.rb, bin/clevic,
+	  config/jamis.rb, lib/clevic.rb, lib/clevic/cache_table.rb,
+	  lib/clevic/db_options.rb, lib/clevic/version.rb, template,
+	  times_models.rb, values_models.rb:
+	  new DbOptions class. Move jamis.rb into config.
+
+2008-07-07 19:39  panic
+
+	* README.txt, Rakefile, accounts_models.rb, config, config/hoe.rb,
+	  config/requirements.rb, lib/clevic/version.rb, script,
+	  script/console, script/destroy, script/generate,
+	  script/txt2html, tasks, tasks/website.rake, values_models.rb,
+	  website, website/index.html, website/index.txt,
+	  website/javascripts,
+	  website/javascripts/rounded_corners_lite.inc.js,
+	  website/screenshot.png, website/stylesheets,
+	  website/stylesheets/screen.css, website/template.html.erb:
+	  pull in rubigen scripts and things from another project
+
+2008-07-05 20:53  panic
+
+	* README.txt:
+	  update README slightly
+
+2008-07-04 20:16  panic
+
+	* History.txt, Manifest.txt, README.txt, Rakefile, TODO,
+	  bin/clevic, lib/clevic/db_options.rb,
+	  lib/clevic/model_builder.rb, lib/clevic/version.rb, template,
+	  template/jamis.rb:
+	  improve docs and comments. Do gem dependencies.
+
 2008-06-26 14:56  panic
 
 	* README.txt:

data/Manifest.txt

@@ -3,7 +3,6 @@ Manifest.txt
 README.txt
 Rakefile
 TODO
-accounts_models.rb
 bin/clevic
 bin/import-times
 config/hoe.rb
@@ -21,6 +20,7 @@ lib/clevic/field.rb
 lib/clevic/item_delegate.rb
 lib/clevic/model_builder.rb
 lib/clevic/model_column.rb
+lib/clevic/record.rb
 lib/clevic/search_dialog.rb
 lib/clevic/table_model.rb
 lib/clevic/table_view.rb
@@ -30,15 +30,19 @@ lib/clevic/ui/icon.png
 lib/clevic/ui/search_dialog.ui
 lib/clevic/ui/search_dialog_ui.rb
 lib/clevic/version.rb
+models/accounts_models.rb
+models/minimal_models.rb
+models/times_models.rb
+models/times_sqlite_models.rb
+models/values_models.rb
 script/console
 script/destroy
 script/generate
 script/txt2html
 sql/accounts.sql
 sql/times.sql
+sql/times_sqlite.sql
 tasks/website.rake
-times_models.rb
-values_models.rb
 website/index.html
 website/index.txt
 website/screenshot.png

data/README.txt

@@ -1,35 +1,27 @@
 = clevic
 
-http://clevic.rubyforge.org/
+http://clevic.rubyforge.org
 
 == DESCRIPTION:
 
 Database framework and Qt Model/View GUI for data capture and
-editing of tables in a pre-existing relational DBMS. Thanks to ActiveRecord,
-Postgresql, Mysql and so on are supported. Has only been tested with Postgres.
+editing of tables in a pre-existing relational DBMS.
 
-There is a mild focus on reducing keystrokes for repetitive data capture,
-so it provides
-nice keyboard shortcuts for all sorts of things. Model (table) objects
-are extensible to allow for model (table) specific cleverness, like
-auto-filling-in of fields.
+Using ActiveRecord means Clevic supports Postgresql, Mysql and so on. It's been tested with Postgres and sqlite.
 
-Start with Clevic::Browser
+Using Qt means it runs on Linux, Windows and OSX.
 
 == FEATURES:
 
+=== User Interface
+
+* edit data in a table
+* in-place combo boxes for choosing values from related tables (foreign keys)
+* distinct combo boxes to list previous values for a field
+* display read-only fields from related tables
 * Filter by current field.
 * search by field contents.
-* uses ActiveRecord for data access. Does *not* use the Qt SQL models.
-* sensible caching to handle large data sets without unnecessary memory and cpu usage
-* in-place Combo boxes for related table and foreign keys
-* distinct combo boxes to list previous values for a field
 * cut and paste in CSV format
-* sortable by row headers (not yet)
-* color highlighting of fields and records on definable criteria (not yet).
-* extensions to various Qt classes to make db programming easier.
-* 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.
 
 === Shortcuts:
 
@@ -43,12 +35,33 @@ Start with Clevic::Browser
 
 === Model definition:
 
-Right now, models must be defined in Ruby. The framework provides
-an easy Rails-migrations-like syntax for that.
-Start with account_models.rb and times_models.rb, with associated SQL
-schemas in the sql subdirectory. For implementation and more extensive
+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.
+
+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.
 
+=== Framework
+
+* use blocks to format values for particular fields.
+* sensible caching to handle large data sets without unnecessary memory and cpu usage
+* extensions to various Qt classes to make db programming easier.
+* uses ActiveRecord for data access. Does *not* use the Qt SQL models.
+* 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.
@@ -62,7 +75,7 @@ See TODO file.
 === Gems
 * fastercsv
 * ruby-qt4
-* qtext (not available on rubyforge yet. Download from http://www.semiosix.com/qtext-0.2.0.gem)
+* qtext
 * ActiveRecord
 
 === Other

data/Rakefile

@@ -15,7 +15,8 @@ end
 
 # list of .ui files
 UI_FILES = FileList.new( 'lib/clevic/ui/*.ui' )
-CLEAN.include( 'ChangeLog', 'lib/clevic/ui/*.rb' )
+CLEAN.include( 'ChangeLog' )
+CLOBBER.include( 'ChangeLog', 'pkg', 'lib/clevic/ui/*_ui.rb' )
 
 UI_FILES.each do |ui_file|
   # make tasks to generate _ui.rb files
@@ -50,10 +51,16 @@ namespace :ui do
   end
 end
 
-desc "Runs Clevic in warning mode, with test databases and debug flag on"
+desc "Runs Clevic in normal mode, with live database."
 task :run => :ui do |t|
   ARGV.shift()
-  exec "ruby -w -Ilib bin/clevic -D #{ARGV.join(' ')}"
+  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"
@@ -89,10 +96,12 @@ MODELS_LIST.each do |model_file|
   end
   
   # generate runs
-  desc "run clevic with #{model_file}"
-  task short_model( model_file )  => :ui do |t|
-    ARGV.shift()
-    exec "ruby -w -Ilib bin/clevic -D #{model_file} #{ARGV.join(' ')}"
+  namespace :run do
+    desc "run clevic with #{model_file}"
+    task short_model( model_file )  => :ui do |t|
+      ARGV.shift()
+      exec "ruby -w -Ilib bin/clevic -D #{model_file} #{ARGV.join(' ')}"
+    end
   end
 end
 
@@ -114,3 +123,9 @@ Rake::RDocTask.new(:docs) do |rd|
 
   rd.options << "-t #{title}"
 end
+
+desc "Update History.txt from the SVN log"
+task :history do |t|
+  ARGV.shift
+  exec "svn2cl --break-before-msg -o History.txt #{ARGV.join(' ')}"
+end

data/TODO

@@ -1,12 +1,55 @@
-Times Ctrl-Shift-" should not copy date if it already exists, and should not copy time if it's a different date.
-Times Ctrl-Shift-" after it's done, tab doesn't change fields
-Times look up invoice for project leaves the wrong fields highlighted, and focus in the wrong field.
+Make sure shortcuts don't edit a read-only field
+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
+
+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.
 
 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
-Undo deletes and other commands. Possibly via ActiveRecord callbacks?
 
-Keep a history of changes, ie xy, new. xy, changed. x,y copied etc.
+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
+/-style filtering?
+
+for dates, add year if not specified, with 6 months on either side range. Configurable?
+value formatting not in model
+copy a field from a mouse-selection (ctrl-b maybe)
+hiding of fields
+
+save context menu settings, filter settings, etc
+filtering by various things. http://doc.trolltech.com/4.3/qsortfilterproxymodel.html
+highlighting by various things
+cut and paste (in model format)
+
+drop cached model objects from CacheTable when they're not in use
+
+allow scroll viewport to centre when at end of dataset
+QAbstractItemView::ScrollHint
+
+    \value EnsureVisible  Scroll to ensure that the item is visible.
+    \value PositionAtTop  Scroll to position the item at the top of the viewport.
+    \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.
 
 OSX
 ---
@@ -24,7 +67,6 @@ editing
 -------
 F2 for standard edit, F4 for calendar edit
 Only move for data_changed if field was exited with tab, not enter.
-make sure record is saved when changing tabs
 tooltips for tabs
 Help in general for new data capture people
 Help to right of tabs
@@ -43,54 +85,19 @@ Doing data capture, sort by id, but unfilter reverts to date/id rather than entr
 optional warnings for back-dated entries. Highlighting 
 make sure bsearch easier to install
 
-ORDER BY allow functions, ie lower(project)
 handle db errors
-test with sqlite
 easier way to run models, search LOAD_PATH
 
-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
-
-cache belongs_to associations, during loading, ie don't affect ability to pick up
+cache belongs_to associations, during loading, but don't affect ability to pick up
 changes more or less instantly.
 
-moving of columns
-/-style keyboard search by selected column, or everything if no column selected
-/-style filtering?
-
-for dates, add year if not specified, with 6 months on either side range. Configurable?
-value formatting not in model
-copy a field from a mouse-selection (ctrl-b maybe)
-hiding of fields
-
-save context menu settings, filter settings, etc
-filtering by various things. http://doc.trolltech.com/4.3/qsortfilterproxymodel.html
-highlighting by various things
-cut and paste (in model and csv format)
-
-drop cached model objects from CacheTable when they're not in use
-
-allow scroll viewport to centre when at end of dataset
-QAbstractItemView::ScrollHint
-
-    \value EnsureVisible  Scroll to ensure that the item is visible.
-    \value PositionAtTop  Scroll to position the item at the top of the viewport.
-    \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.
-
-
 preferences
 -----------
 store previous searches, by model & app
 
 maybe
 -----
+Look at DataMapper. Not suitable - need to declare properties.
 use rubigen for creating model definition files
 allow moving of rows
 discontiguous copying of entities/csv
@@ -108,5 +115,8 @@ restricted type for Account Type record
 Times
 -----
 
-warnings on overlap times (in status bar)
-warnings on large intervals (in status bar)
+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)