clevic 0.5.1

data/Rakefile

@@ -0,0 +1,100 @@
+require 'rubygems'
+require 'rake/clean'
+require 'hoe'
+require 'lib/clevic/version.rb'
+require 'pathname'
+
+Hoe.new( 'clevic', Clevic::VERSION ) do |s|
+	s.author     = "John Anderson"
+	s.email      = "john at semiosix dot com"
+end
+
+# generate a _ui.rb filename from a .ui filename
+def ui_rb_file( ui_file )
+  ui_file.gsub( /\.ui$/, '_ui.rb' )
+end
+
+# list of .ui files
+UI_FILES = FileList.new( 'lib/clevic/ui/*.ui' )
+CLEAN.include( 'ChangeLog', 'lib/clevic/ui/*.rb' )
+
+UI_FILES.each do |ui_file|
+  # make tasks to generate _ui.rb files
+  file ui_rb_file( ui_file ) => [ ui_file ] do |t|
+    sh "rbuic4 #{t.prerequisites} -o #{t.name}" 
+  end
+  
+  # make tasks to start designer when the ui file is named
+  desc "Start Qt designer with #{ui_file}"
+  namespace :ui do |n|
+    task Pathname.new(ui_file).basename.to_s.ext do |t|
+      sh "designer #{ui_file}"
+    end
+  end
+end
+
+desc 'Generate all _ui.rb files'
+task :ui => UI_FILES.map{|x| ui_rb_file( x ) }
+
+namespace :ui do
+  desc 'Start Qt designer with the argument, or all .ui files.'
+  task :design do |t|
+    ARGV.shift()
+    if ARGV.size == 0
+      # start designer with all ui files
+      sh "designer #{UI_FILES.join(' ')}"
+    else
+      # start designer with all files that match an argument
+      sh "designer #{ ARGV.map{|x| UI_FILES.grep( /\/#{x}/ ) }.join(' ') }"
+    end
+    true
+  end
+end
+
+desc "Runs Clevic in warning mode, with test databases and debug flag on"
+task :run => :ui do |t|
+  ARGV.shift()
+  exec "ruby -w -Ilib bin/clevic -D #{ARGV.join(' ')}"
+end
+
+desc "Runs Clevic in debug mode, with test databases"
+task :debug => :ui do |t|
+  ARGV.shift()
+  exec "ruby -w -rdebug -Ilib bin/clevic -D #{ARGV.join(' ')}"
+end
+
+desc "irb in this project's context"
+task :irb do |t|
+  ARGV.shift()
+  ENV['RUBYLIB'] += ":#{File.expand_path('.')}/lib"
+  exec "irb -Ilib -rclevic"
+end
+
+# generate tasks for all model definition files
+MODELS_LIST = FileList.new( '**/*models.rb' )
+
+def short_model( model_file )
+  Pathname.new( model_file ).basename.to_s.gsub( /_models.rb/, '' )
+end
+
+MODELS_LIST.each do |model_file|
+  # generate irb contexts
+  desc "irb with #{model_file}"
+  namespace :irb do
+    task short_model( model_file ) do |t|
+      ARGV.shift()
+      ENV['RUBYLIB'] ||= '.'
+      ENV['RUBYLIB'] += ":#{File.expand_path('.')}/lib"
+      exec "irb -Ilib -rclevic -r#{model_file} -rclevic/db_options.rb"
+    end
+  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(' ')}"
+  end
+end
+
+task :package => :ui

data/TODO

@@ -0,0 +1,131 @@
+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.
+
+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.
+
+OSX
+---
+Check that qtruby4 runs on OSX and so does Clevic. It does. Very slowly on Leilani's Mini.
+
+windows
+-------
+Ctrl-; date formatting goes 07--08 instead of 07-Apr-08. But typing the full month will be OK.
+
+empty database
+--------------
+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
+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
+messages for wrong dates etc
+numeric months
+
+Combos
+------
+shortlist combos by prefix. See Qt Examples.
+turn on/off smart filters for relational delegates. Like selecting only distincts in the last year.
+context menu for delegates, ie sort order, last used, etc
+
+shortcut sets, depending on which OS you're used. use QKeyEvent::matches ( QKeySequence::StandardKey key )
+
+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
+
+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
+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
+-----
+use rubigen for creating apps
+allow moving of rows
+discontiguous copying of entities/csv
+multi-row copying
+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?
+
+Accounts
+--------
+paste of "common" records with different dates
+restricted type for Account Type record
+
+Times
+-----
+
+warnings on overlap times (in status bar)
+warnings on large intervals (in status bar)
+
+db
+--
+
+times
+
+alter table invoices rename column type to billing;
+alter table entries add primary key (id);
+alter table entries alter column id set not null
+select max(id) from entries;
+create sequence entries_id_seq start with 11694;
+alter table entries alter column id set default nextval('entries_id_seq');
+update entries set module = null where module = '';
+update entries set module = 'admin' where module = 'Admin';
+
+alter table projects rename active to old_active;
+alter table projects add column active boolean;
+update projects set active = ( old_active = 1 );
+alter table projects drop column old_active;

data/accounts_models.rb

@@ -0,0 +1,122 @@
+require 'clevic.rb'
+
+# db connection options
+$options ||= {}
+$options[:database] ||= $options[:debug] ? 'accounts_test' : 'accounts'
+$options[:adapter]  ||= 'postgresql'
+$options[:host] ||= 'localhost'
+$options[:username] ||= 'panic'
+$options[:password] ||= ''
+
+class Entry < ActiveRecord::Base
+  include ActiveRecord::Dirty
+  belongs_to :debit, :class_name => 'Account', :foreign_key => 'debit_id'
+  belongs_to :credit, :class_name => 'Account', :foreign_key => 'credit_id'
+
+  # define how fields will be displayed
+  def self.ui( parent )
+    Clevic::TableView.new( self, parent ).create_model do
+      plain       :date, :sample => '88-WWW-99'
+      distinct    :description, :conditions => "now() - date <= '1 year'", :sample => 'm' * 26, :frequency => true
+      relational  :debit, 'name', :class_name => 'Account', :conditions => 'active = true', :order => 'lower(name)', :sample => 'Leilani Member Loan'
+      relational  :credit, 'name', :class_name => 'Account', :conditions => 'active = true', :order => 'lower(name)', :sample => 'Leilani Member Loan'
+      plain       :amount, :sample => 999999.99
+      distinct    :category
+      plain       :cheque_number
+      plain       :active, :sample => 'WW'
+      plain       :vat, :label => 'VAT', :sample => 'WW', :tooltip => 'Does this include VAT?'
+      
+      records     :order => 'date, id'
+    end
+  end
+  
+  # called when data is changed in the UI
+  def self.data_changed( top_left, bottom_right, view )
+    if top_left == bottom_right
+      update_credit_debit( top_left, view )
+    else
+      puts "top_left: #{top_left.inspect}"
+      puts "bottom_right: #{bottom_right.inspect}"
+      puts "can't do data_changed for a range"
+    end
+  end
+  
+  # check that the current field is :descriptions, then
+  # copy the values for the credit and debit fields
+  # from the previous similar entry
+  def self.update_credit_debit( current_index, view )
+    return if !current_index.valid?
+    current_field = current_index.attribute
+    if current_field == :description
+      # most recent entry, ordered in reverse
+      similar = self.find(
+        :first,
+        :conditions => ["#{current_field} = ?", current_index.attribute_value],
+        :order => 'date desc'
+      )
+      if similar != nil
+        # set the values
+        current_index.entity.debit = similar.debit
+        current_index.entity.credit = similar.credit
+        current_index.entity.category = similar.category
+        
+        # emit signal to update view from top_left to bottom_right
+        model = current_index.model
+        top_left_index = model.create_index( current_index.row, 0 )
+        bottom_right_index = model.create_index( current_index.row, view.builder.fields.size )
+        view.dataChanged( top_left_index, bottom_right_index )
+        
+        # move edit cursor to amount field
+        view.selection_model.clear
+        view.override_next_index( model.create_index( current_index.row, view.builder.index( :amount ) ) )
+      end
+    end
+  end
+end
+
+class Account < ActiveRecord::Base
+  include ActiveRecord::Dirty
+  has_many :debits, :class_name => 'Entry', :foreign_key => 'debit_id'
+  has_many :credits, :class_name => 'Entry', :foreign_key => 'credit_id'
+  
+  # define how fields are displayed
+  def self.ui( parent )
+    Clevic::TableView.new( self, parent ).create_model do
+      plain       :name
+      restricted  :vat, :label => 'VAT', :set => %w{ yes no all }
+      plain       :account_type
+      plain       :pastel_number, :alignment => Qt::AlignRight, :label => 'Pastel'
+      plain       :fringe, :format => "%.1f"
+      plain       :active
+      
+      records  :order => 'name,account_type'
+    end
+  end
+end
+
+# order of tab display
+$options[:models] = [ Entry, Account ]
+
+# This is a read-only view, which is currently not implemented
+#~ class Values < ActiveRecord::Base
+  #~ include ActiveRecord::Dirty
+  #~ set_table_name 'values'
+  #~ has_many :debits, :class_name => 'Entry', :foreign_key => 'debit_id'
+  #~ has_many :credits, :class_name => 'Entry', :foreign_key => 'credit_id'
+  #~ def self.ui( parent )
+    #~ Clevic::TableView.new( self, parent ).create_model do
+      #~ readonly
+      #~ plain       :date
+      #~ plain       :description
+      #~ plain       :debit
+      #~ plain       :credit
+      #~ plain       :pre_vat_amount
+      #~ plain       :cheque_number
+      #~ plain       :vat, :label => 'VAT'
+      #~ plain       :financial_year
+      #~ plain       :month
+      
+      #~ records :order => 'date'
+    #~ end
+  #~ end
+#~ end

data/bin/clevic

@@ -0,0 +1,64 @@
+#! /usr/bin/ruby
+
+require 'clevic/browser.rb'
+require 'ruby-debug'
+
+# fetch command line options
+require 'optparse'
+
+# 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.on( '-H', '--host HOST', 'RDBMS host', String ) { |o| $options[:host] = o }
+oparser.on( '-u', '--user USERNAME', String ) { |o| $options[:user] = o }
+oparser.on( '-p', '--pass PASSWORD', String ) { |o| $options[:password] = 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 }
+oparser.on( '-v', '--verbose' ) { |o| $options[:verbose] = true }
+oparser.on( '-h', '-?', '--help' ) do |o|
+  puts oparser.to_s
+  exit( 0 )
+end
+
+args = oparser.parse( ARGV )
+
+if args.size > 0
+  $options[:definition] = args.shift
+  require_if "#{$options[:definition]}_models"
+  require_if $options[:definition]
+else
+  raise "no model definition file specified"
+end
+
+app = Qt::Application.new( args )
+
+if $options[:debug]
+  require 'pp'
+  #~ puts "$options: #{$options.inspect}"
+  #~ puts args.inspect
+end
+
+if !$options.has_key?( :database )
+  raise "Please define $options[:database]"
+end
+
+# connect to db
+require 'clevic/db_options.rb'
+
+puts "using database #{ActiveRecord::Base.connection.raw_connection.db}" if $options[:debug]
+
+# show UI
+main_window = Qt::MainWindow.new
+browser = Clevic::Browser.new( main_window )
+browser.open
+# this must come after Clevic::Browser.new
+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

data/lib/active_record/dirty.rb

@@ -0,0 +1,87 @@
+module ActiveRecord
+  # Track unsaved changes.
+  module Dirty
+    def self.included(base)
+      base.attribute_method_suffix '_changed?', '_change', '_original'
+      base.alias_method_chain :read_attribute,  :dirty
+      base.alias_method_chain :write_attribute, :dirty
+      base.alias_method_chain :save,            :dirty
+    end
+
+    # Do any attributes have unsaved changes?
+    #   person.changed? # => false
+    #   person.name = 'bob'
+    #   person.changed? # => true
+    def changed?
+      !changed_attributes.empty?
+    end
+
+    # List of attributes with unsaved changes.
+    #   person.changed # => []
+    #   person.name = 'bob'
+    #   person.changed # => ['name']
+    def changed
+      changed_attributes.keys
+    end
+
+    # Map of changed attrs => [original value, new value]
+    #   person.changes # => {}
+    #   person.name = 'bob'
+    #   person.changes # => { 'name' => ['bill', 'bob'] }
+    def changes
+      changed.inject({}) { |h, attr| h[attr] = attribute_change(attr); h }
+    end
+
+
+    # Clear changed attributes after they are saved.
+    def save_with_dirty(*args) #:nodoc:
+      save_without_dirty(*args)
+    ensure
+      changed_attributes.clear
+    end
+
+    private
+      # Map of change attr => original value.
+      def changed_attributes
+        @changed_attributes ||= {}
+      end
+
+
+      # Wrap read_attribute to freeze its result.
+      def read_attribute_with_dirty(attr)
+        read_attribute_without_dirty(attr).freeze
+      end
+
+      # Wrap write_attribute to remember original attribute value.
+      def write_attribute_with_dirty(attr, value)
+        attr = attr.to_s
+
+        # The attribute already has an unsaved change.
+        unless changed_attributes.include?(attr)
+          old = read_attribute(attr)
+
+          # Remember the original value if it's different.
+          changed_attributes[attr] = old unless old == value
+        end
+
+        # Carry on.
+        write_attribute_without_dirty(attr, value)
+      end
+
+
+      # Handle *_changed? for method_missing.
+      def attribute_changed?(attr)
+        changed_attributes.include?(attr)
+      end
+
+      # Handle *_change for method_missing.
+      def attribute_change(attr)
+        [changed_attributes[attr], __send__(attr)] if attribute_changed?(attr)
+      end
+
+      # Handle *_original for method_missing.
+      def attribute_original(attr)
+        attribute_changed?(attr) ? changed_attributes[attr] : __send__(attr)
+      end
+  end
+end