clevic 0.13.0.b5 → 0.13.0.b6

data/History.txt

@@ -1,3 +1,13 @@
+== 0.13.0.b6
+* switch to MrBones
+* All dependencies are now gems. bsearch is a gem. So is qtbindings.
+* dispense with a couple more active_support dependencies
+* make tests work with minitest.
+* Document attributes better
+* Make sure Models based on a SQL view will work
+* Fix Enumerator / Generator issues
+* testing with both ruby-1.8.7 and ruby-1.9.2
+
 == 0.13.0.b5
 * Lots of Bug fixes
 * moved all internals to Sequel::Dataset
@@ -16,7 +26,7 @@
 * use of Dataset allows filtering in TableView to keep previous ordering,
   and filter.
 
-== 0.13.0.b3
+== 0.13.0.b2
 * Squash various buglets as they're found.
 
 == 0.13.0
@@ -52,7 +62,7 @@
 
 == 0.11.1
 * Define views in separate classes (subclass of Clevic::View) while
-	maintaining view definition inside the ActiveRecord::Base subclass.
+  maintaining view definition inside the ActiveRecord::Base subclass.
 * foreground and background color specifiers for fields
 * better handling of virtual fields
 * more tests

data/Manifest.txt

@@ -4,6 +4,7 @@ README.txt
 Rakefile
 TODO
 bin/clevic
+models/examples.rb
 models/accounts_models.rb
 models/minimal_models.rb
 models/times_models.rb
@@ -18,7 +19,6 @@ sql/accounts.sql
 sql/times.sql
 sql/times_sqlite.sql
 tasks/clevic.rake
-tasks/rdoc.rake
 test/test_cache_table.rb
 test/test_helper.rb
 test/test_model_index_extensions.rb
@@ -78,8 +78,6 @@ lib/clevic/qt/combo_delegate.rb
 lib/clevic/qt/browser.rb
 lib/clevic/qt/clipboard.rb
 lib/clevic/qt/text_area_delegate.rb
-lib/clevic/ui/browser_ui.rb
-lib/clevic/ui/search_dialog_ui.rb
 lib/clevic/qt.rb
 lib/clevic/many_field.rb
 lib/clevic/attribute_list.rb

data/README.txt

@@ -2,10 +2,16 @@
 
 http://clevic.rubyforge.org
 
-== DESCRIPTION:
+== Quick Start
 
-Database framework and Model/View GUI for data capture and
-editing of tables in a pre-existing relational DBMS. Works with Qt
+For code examples, see Clevic::Examples.
+
+For documentation, see Clevic::ModelBuilder and Clevic::Field.
+
+== Description
+
+Database framework and Model/View GUI for editing of table data and
+data capture in a pre-existing reblational DBMS. Works with Qt
 and Java Swing. Uses SQL to do sorting and filtering wherever possible.
 
 Based on the idea of a Field, which contains information to display
@@ -20,7 +26,7 @@ Using Qt and Swing means it runs on Linux, Windows and OSX. The Qt
 code is thoroughly tested in Linux, slightly tested in Windows and OSX. Swing 
 is tested in Linux and OSX.
 
-== FEATURES:
+== Features
 
 === User Interface
 
@@ -28,20 +34,24 @@ is tested in Linux and OSX.
 * 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
-* Recursive Filter by current field
+* Multi-level filter by current field
 * search by field contents
-* cut and paste in CSV and paste from HTML in the Java framework.
+* cut and paste in CSV, and paste from HTML in the Java framework.
 
 === Shortcuts:
 
-* Ctrl-' for ditto (copy value from previous record)
+* Ctrl-<tt>'</tt> for ditto (copy value from previous record)
 * Ctrl-; for insert current date
-* Ctrl-] for copy previous record, one field right
-* Ctrl-[ for copy previous record, one field left
+* Ctrl-] for copy from previous record, one field right
+* Ctrl-[ for copy from previous record, one field left
 * Ctrl-f to find a record
 * Ctrl-l to add a filter (by current selection)
 * Ctrl-k to remove a filter
 * cursor keys, PgUp PgDown etc for movement
+* shift with movement keys to extend selection
+* Ctrl-Tab and Ctrl-Shift-Tab to move next/previous table views
+* F2 to edit a field
+* F4 to display a combo box for a field, where appropriate
 
 === Model definition:
 
@@ -51,13 +61,6 @@ that includes the Clevic::Record module will provide a minimally functional UI.
 Beyond that, the framework provides a DSL for defining more complex and useful behaviour
 (see Clevic::ModelBuilder).
 
-=== Examples
-
-In the models/ subdirectory, start with minimal_models.rb. account_models.rb 
-and times_models.rb provide definitions for real-world examples. Associated 
-SQL schemas are in the sql subdirectory. For implementation and more extensive 
-comments, see Clevic::ModelBuilder.
-
 === Framework
 
 * uses Sequel for data access.
@@ -67,44 +70,29 @@ comments, see 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.
 
-== PROBLEMS:
+== Problems
 
 There are some tests for algorithmic code, but Clevic needs a comprehensive testing framework.
 
-== SYNOPSIS:
+== Synopsis
 
-	clevic [ --qt | --swing ] model_definition_file.rb
+	clevic model_definition_file.rb
 	
-== REQUIREMENTS:
-
-=== Gems
-* Sequel
-* fastercsv
-* qtext
-* hashery (for ruby-1.8.x)
-* qtbindings
-* gather
-
-=== Libraries
-* qtruby4 >= 2.0.3
-* bsearch (http://0xcc.net/ruby-bsearch)
+== Requirements
+
 * db driver (ie pg)
 * rdbms (ie postgres)
 
-== INSTALL:
+== Install
 
-	Get bsearch from http://0xcc.net/ruby-bsearch
-	
-	Install qt bindings from https://github.com/ryanmelt/qtbindings
-	
-	sudo gem install
+	sudo gem install clevic
 
-== THANKS:
+== Thanks
 
 * Michelle Riley for help debugging under windows
 * Jacob Buys for pointing out the qtbindings gem
 
-== LICENSE:
+== License
 
 (The GPL-2 License)
 

data/Rakefile

@@ -1,35 +1,73 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/clevic/version.rb'
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('clevic', Clevic::VERSION::STRING) do |p|
-  p.developer('John Anderson', 'panic@semiosix.com')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.rubyforge_name       = p.name # TODO this is default value
-  p.description          = "SQL table GUI with Qt / Java Swing and Sequel"
-  p.extra_deps         = [
-    ['activesupport','>= 2.0.2'],
-    ['fastercsv', '>=1.2.3'],
-    ['gather', '>=0.0.6'],
-    ['qtext', '>=0.6.6'],
-    ['hashery', '>=1.3.0'],
-    ['andand', '>= 1.3.0'],
-    ['sequel', '>= 3.8.0'],
-    ['hpricot', '>= 0.8.1'],
-    ['io-like', '>= 0.3.0'],
-    #['qtbindings', '>=4.6.3']
-    # bsearch can't be installed from gems
-  ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
+#~ %w[rake rake/clean fileutils].each { |f| require f }
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+#~ task :default => 'test:run'
+#~ task 'gem:release' => 'test:run'
+
+ensure_in_path 'lib'
+require 'clevic/version.rb'
+
+# rake bones:help |less
+
+Bones do
+  name  'clevic'
+  authors  'John Anderson'
+  email  'panic@semiosix.com'
+  url  'http://clevic.rubyforge.org'
+  version  Clevic::VERSION::STRING
+  description "SQL table GUI with Qt / Java Swing and Sequel"
+  
+  gem.need_tar false
+  
+  depend_on 'fastercsv', '>=1.2.3'
+  depend_on 'gather', '>=0.0.6'
+  depend_on 'andand', '>= 1.3.0'
+  depend_on 'sequel', '>= 3.8.0'
+  depend_on 'bsearch', '>=1.5.0'
+  # for html paste parsing
+  depend_on 'hpricot', '>= 0.8.1'
+  
+  # for 1.8
+  depend_on 'hashery', '>=1.3.0'
+
+  # for JRuby clipboard handling
+  depend_on 'io-like', '>= 0.3.0'
+  
+  # for Qt
+  depend_on 'qtbindings', '>=4.6.3'
+  depend_on 'qtext', '>=0.6.7'
+  
+  depend_on 'test-unit', :development => true
+  depend_on 'shoulda', :development => true
+  depend_on 'faker', :development => true
+  
+  # read file list from Manifest.txt
+  gem.files File.new('Manifest.txt').to_a.map( &:chomp )
+
+  # List of files to generate rdoc from
+  # Not the same as the rdoc -i which is list of files
+  # to search for include directives
+  rdoc.include %w{README.txt ^lib/clevic/.*\.rb$ models/examples.rb History.txt TODO}
+  
+  # List of Regexs to exclude from rdoc processing
+  rdoc.exclude %w{^pkg.*}
+  
+  # Include URL for git browser in rdoc output
+  rdoc.opts %w{-W http://gitweb.semiosix.com/gitweb.cgi?p=clevic;a=blob;f=%s;hb=HEAD}
+
+  rdoc.main 'README.txt'
+  #~ rdoc.external true
 end
 
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
+  #~ p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  #~ path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  #~ p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  #~ p.rsync_args = '-av --delete --ignore-errors'
+#~ end
+
+#~ Dir['tasks/**/*.rake'].each { |t| load t }

data/TODO

@@ -1,3 +1,8 @@
+sorting by header:
+  - See void QAbstractItemModel::sort ( int column, Qt::SortOrder order = Qt::AscendingOrder )
+  - layoutChanged
+
+change instance_methods.include? to method_defined?
 override_next_index broken again, on ditto
 Sort out the whole /bin/clevic vs gem 'clevic', '~> 0.12.0' thing.
 Meta should be related to ModelColumn somehow. Which is pretty messy itself.
@@ -31,8 +36,6 @@ 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
 
 undo
 - could possibly handle this in the TableModel

data/bin/clevic

@@ -49,6 +49,7 @@ if RUBY_PLATFORM == 'java'
 else
   require 'clevic/qt'
 end
+require 'clevic'
 
 if $options[:debug]
   require 'pp'

data/lib/clevic.rb

@@ -8,8 +8,15 @@ end
 
 # TODO should this really be here?
 # There are other inflection gems.
-# JRuby-1.5.2 raises exception if this require has a .rb on the 
-require 'active_support/inflector'
+
+# for camelize and friends
+# TODO JRuby-1.5.2 raises exception if this require has a .rb on the 
+require 'sequel/core'
+require 'sequel/extensions/inflector'
+
+# for demodulize, tableize, humanize
+require 'sequel'
+require 'sequel/extensions/inflector'
 
 require 'clevic/framework'
 require 'clevic/sequel_length_validation.rb'

data/lib/clevic/extensions.rb

@@ -74,10 +74,10 @@ def Range
   end
 end
 
-# workaround for the date freeze issue, if it exists
 begin
   Date.new.freeze.to_s
 rescue TypeError
+  # Workaround for the date freeze issue, if it exists.
   class Date
     def freeze
       self

data/lib/clevic/field.rb

@@ -7,12 +7,11 @@ require 'clevic/many_field.rb'
 module Clevic
 
 =begin rdoc
+
 This defines a field in the UI, and how it hooks up to a field in the DB.
 
-Many attributes are DSL-style accessors, where the value can be
-set with either an assignment or by passing a parameter. Unfortunately
-rdoc seems to have lost the ability to display these nicely. Anyway, here's
-an example
+Some attributes are DSL-style accessors, where the value can be
+set with either an assignment or by passing a parameter. For example:
 
   property :ixnay
 
@@ -36,17 +35,10 @@ Generally properties are for options that can be passed to the field creation
 method in ModelBuilder, whereas ruby attributes are for the internal workings.
 
 #--
-TODO decide whether value_for type methods take an entity and do_something methods
-take a value.
-
-TODO the xxx_for methods are in here because their return values don't change
-by entity. Well, maybe sometimes they do. Anyway, need to find a better location
-for these and a better caching strategy.
-
-TODO this class is a bit confused about whether it handles metadata or record data, or both.
-
-TODO meta needs to handle virtual fields better.
+Yes, the blank line before class Field is really necessary.
+And so it the #-- above.
 =end
+
 class Field
   # For defining properties
   include Gather
@@ -55,6 +47,7 @@ class Field
   include GenericFormat
   
   ##
+  # :attr:
   # The value to be displayed after being optionally format-ed
   #
   # Takes a String, a Symbol, or a Proc.
@@ -71,20 +64,24 @@ class Field
   property :display
   
   ##
+  # :attr:
   # The label to be displayed in the column headings. Defaults to the humanised field name.
   property :label
   
   ##
+  # :attr:
   # One of the alignment specifiers - :left, :centre, :right or :justified.
   # Defaults to right for numeric fields, centre for boolean, and left for
   # other values.
   property :alignment
   
   ##
+  # :attr:
   # something to do with the icon that Qt displays. Not implemented yet.
   property :decoration
   
   ##
+  # :attr:
   # This defines how to format the value returned by :display. It takes a string or a Proc.
   # Generally the string is something 
   # that can be understood by strftime (for time and date fields) or understood 
@@ -93,6 +90,7 @@ class Field
   property :format
   
   ##
+  # :attr:
   # This is just like format, except that it's used to format the value just
   # before it's edited. A good use of this is to display dates with a 2-digit year
   # but edit them with a 4 digit year.
@@ -100,10 +98,12 @@ class Field
   property :edit_format
   
   ##
+  # :attr:
   # Whether the field is currently visible or not.
   property :visible
   
   ##
+  # :attr:
   # Sample is used if the programmer wishes to provide a value (that will be converted
   # using to_s) that can be used
   # as the basis for calculating the width of the field. By default this will be
@@ -113,10 +113,12 @@ class Field
   property :sample
   
   ##
+  # :attr:
   # Takes a boolean. Set the field to read-only.
   property :read_only
   
   ##
+  # :attr:
   # The foreground and background colors.
   # Can take a Proc, a string, or a symbol.
   # - A Proc is called with an entity
@@ -128,6 +130,7 @@ class Field
   property :foreground, :background
   
   ##
+  # :attr:
   # Can take a Proc, a string, or a symbol.
   # - A Proc is called with an entity
   # - A String is treated as a constant
@@ -135,6 +138,7 @@ class Field
   property :tooltip
   
   ##
+  # :attr:
   # An Enumerable of allowed values for restricted fields. If each yields
   # two values (like it does for a Hash), the
   # first will be stored in the db, and the second displayed in the UI.
@@ -142,6 +146,7 @@ class Field
   property :set
   
   ##
+  # :attr:
   # When this is true, only the values in the combo may be entered.
   # Otherwise the text-entry part of the combo can be used to enter
   # non-listed values. Default is true if a set is explicitly specified.
@@ -149,6 +154,7 @@ class Field
   property :restricted
   
   ##
+  # :attr:
   # Only for the distinct field type. The values will be sorted either with the
   # most used values first (:frequency => true) or in
   # alphabetical order (:description => true).
@@ -156,18 +162,21 @@ class Field
   property :frequency, :description
   
   ##
+  # :attr:
   # Default value for this field for new records.
   # Can be a Proc or a value. A value will just be
   # set, a proc will be executed with the entity as a parameter.
   property :default
   
   ##
+  # :attr:
   # The property used for finding the field, ie by TableModel#field_column.
   # Defaults to the attribute. If there are several display fields based on
   # one db field, their attribute will be the same, but their id must be different.
   property :id
   
   ##
+  # :attr:
   # Called when the data in this field changes.
   # Either a proc( clevic_view, table_view, model_index ) or a symbol
   # for a method( view, model_index ) on the Clevic::View object.
@@ -215,9 +224,9 @@ class Field
   # for this field using whatever GUI toolkit is selected
   attr_accessor :delegate
   
-  # The attribute on the AR entity that forms the basis for this field.
+  # The attribute on the entity that forms the basis for this field.
   # Accessing the returned attribute (using send, or the [] method on an entity)
-  # will give a simple value, or another AR entity in the case of relational fields.
+  # will give a simple value, or another entity in the case of relational fields.
   # In other words, this is *not* the same as the name of the field in the DB, which
   # would normally have an _id suffix for relationships.
   attr_accessor :attribute
@@ -236,12 +245,16 @@ class Field
       raise "attribute #{attribute.inspect} must be a symbol"
     end
     
-    unless ( entity_class.is_a?( Clevic.base_entity_class ) and entity_class.has_attribute?( attribute ) ) or entity_class.instance_methods.include?( attribute.to_s )
-      msg = <<EOF
-#{attribute} not found in #{entity_class.name}. Possibilities are:
-#{entity_class.attribute_names.join("\n")}
+    unless entity_class.ancestors.include?( Clevic.base_entity_class )
+      raise "#{entity_class} is not a Clevic.base_entity_class: #{Clevic.base_entity_class}"
+    end
+    
+    # TODO this comes down to method_defined, really
+    unless entity_class.has_attribute?( attribute ) or entity_class.method_defined?( attribute )
+      raise <<EOF
+#{attribute.inspect} not found in #{entity_class.name}. Possibilities are:
+#{entity_class.attribute_names.inspect}
 EOF
-      raise msg
     end
     
     # instance variables
@@ -303,7 +316,7 @@ EOF
     meta.andand.association?
   end
   
-  # ModelColumn object
+  # Clevic::ModelColumn object
   def meta
     entity_class.meta[attribute]
   end
@@ -320,14 +333,15 @@ EOF
     [attribute.to_s, path].compact.join('.')
   end
   
-  # return the class object of a related class if this is a relational
-  # field, otherwise nil
+  # Return the class object of a related class if this is a relational
+  # field, otherwise nil.
   def related_class
     return nil unless association? && entity_class.meta.has_key?( attribute )
     @related_class ||= eval( entity_class.meta[attribute].class_name || attribute.to_s.classify )
   end
   
   # return an array of the various attribute parts
+  # TODO not used much. Deprecate and remove.
   def attribute_path
     pieces = [ attribute.to_s ]
     pieces.concat( display.to_s.split( '.' ) ) unless display.is_a? Proc
@@ -339,17 +353,20 @@ EOF
     @read_only || false
   end
   
-  # Called by Clevic::Model to format the display value.
+  # Called by Clevic::FieldValuer (and others) to format the display value.
   def do_format( value )
     do_generic_format( format, value )
   end
   
-  # Called by Clevic::Model to format the edit value.
+  # Called by Clevic::FieldValuer to format the field to a string value
+  # that can be used for editing.
   def do_edit_format( value )
     do_generic_format( edit_format, value )
   end
   
   # Set or return a sample for the field which can be used to size the UI field widget.
+  # If this is called as an accessor, and there is no value yet, a Clevic::Sampler
+  # instance is created to compute a sample.
   def sample( *args )
     if !args.empty?
       @sample = args.first
@@ -426,8 +443,12 @@ EOF
     end
   end
   
+  def to_s
+    "#{entity_class}.#{id}"
+  end
+  
   def inspect
-    "#<Clevic::Field id=#{id.inspect}>"
+    "#<Clevic::Field #{entity_class} id=#{id} attribute=#{attribute}>"
   end
   
 protected
@@ -494,10 +515,11 @@ protected
   end
 
   # try to find a sensible display method
+  # TODO this code shows up in the default UI builder as well.
   def default_display!
     candidates = %W{#{entity_class.name.downcase} name title username to_s}
     @display ||= candidates.find do |m|
-      related_class.column_names.include?( m ) || related_class.instance_methods.include?( m )
+      related_class.column_names.include?( m ) || related_class.method_defined?( m )
     end || raise( "Can't find one of #{candidates.inspect} in #{related_class.name}" )
   end