clevic 0.13.0.b9 → 0.13.0.b10

data/lib/clevic/delegate.rb

@@ -11,37 +11,37 @@ class Delegate
     super()
     @field = field
   end
-  
+
   # This is the ORM entity instance for which this delegate
   # is editing a single field. It needs to be the entire entity
   # so we can set the edited field value on it.
   attr_accessor :entity
-  
+
   # The parent widget of this delegate / this delegate's widget
   attr_accessor :parent
-  
+
   # the Clevic::Field instance which this delegate edits.
   attr_reader :field
-  
+
   def attribute
     field.attribute
   end
-  
+
   def entity_class
     field.entity_class
   end
-  
+
   # assume this is not a combo delegate. That will come later.
   def is_combo?
     false
   end
-  
+
   # change the visual state of the editor to the biggest / most
   # space-consuming it can be. This grew out of combo boxes having
   # a drop-down that can show or hide.
   def full_edit
   end
-  
+
   # change the visual state of the editor to the smallest / least
   # space-consuming it can be. This grew out of combo boxes having
   # a drop-down that can show or hide.

data/lib/clevic/delegates/combo_delegate.rb

@@ -12,23 +12,23 @@ class ComboDelegate
   # in some cases.
   # if editor is a combo it must support no_insert=( bool )
   attr_reader :editor
-  
+
   # Return a string to be shown to the user.
   # model_value is an item stored in the combo box model.
   def display_for( model_value )
     field.transform_attribute( model_value )
   end
-  
+
   # Some GUIs (Qt) can just set this. Swing can't.
   def configure_prefix
   end
-  
+
   # TODO kinda redundant because all combos must be editable
   # to support prefix matching
   def configure_editable
     editor.editable = true
   end
-  
+
   # this will create the actual combo box widget
   framework_responsibility :create_combo_box
 
@@ -38,13 +38,13 @@ class ComboDelegate
   # to the combo box without having to deal with events triggered
   # by setup code.
   framework_responsibility :framework_setup
-  
+
   # This is called by the combo box to convert an item
   # to something that the combo can insert into
   # itself. Usually this will be a display value
   # and a storage value.
   framework_responsibility :item_to_editor
-  
+
   # This is called by the combo box when it needs to convert a
   # storage value to an item, which is something that the delegate
   # will understand.
@@ -59,26 +59,26 @@ class ComboDelegate
     if needs_combo?
       @editor = create_combo_box( *args )
       @editor.delegate = self
- 
+
       # add all entries from population
       population.each do |item|
         editor << item
       end
-      
+
       # create a nil entry if necessary
       if allow_null? && !editor.include?( nil )
         editor << nil
       end
-      
+
       # don't allow inserts if the delegate is restricted
       editor.no_insert = restricted?
-      
+
       # set the correct value in the list
       editor.selected_item = entity.nil? ? nil : attribute_value      
-      
+
       # set up prefix matching when typing in the editor
       configure_prefix
-      
+
       framework_setup( *args )
     else
       @editor =
@@ -93,26 +93,26 @@ class ComboDelegate
     end
     editor
   end
-  
+
   # open the combo box, just like if F4 was pressed
   framework_responsibility :full_edit
-  
+
   # show only the text editor part, not the drop-down
   def minimal_edit
     editor.hide_popup if is_combo?
   end
-  
+
   # returns true if the editor allows values outside of a predefined
   # range, false otherwise.
   def restricted?
     false
   end
-  
+
   # TODO fetch this from the model definition
   def allow_null?
     true
   end
-  
+
   # Subclasses should override this to prove a list of
   # values to be used by the combo box. Values could
   # be pretty much anything, depending on the delegate.
@@ -120,7 +120,7 @@ class ComboDelegate
   # of entity objects, most other delegates will have collections
   # of strings.
   subclass_responsibility :population
-  
+
   # Return true if this delegate needs a combo, false otherwise
   # ie if there are no values yet and it's not restricted, then a
   # full combo doesn't make sense
@@ -129,23 +129,23 @@ class ComboDelegate
   # return true if this delegate has/needs a combo widget
   # or false if it's a plain text field.
   framework_responsibility :is_combo?
-  
+
   # return true if this field has no data (needs_combo? is false)
   # and is at the same time restricted (ie needs data from somewhere else)
   def empty_set?
     !needs_combo? && restricted?
   end
-  
+
   # the message to display if the set is empty, and
   # the delegate is restricted to a predefined set.
   subclass_responsibility :empty_set_message
-  
+
   # if this delegate has an empty set, return the message, otherwise
   # return nil.
   def if_empty_message
     empty_set_message if empty_set?
   end
-  
+
   # the value represented by the combo, ie either
   # the current attribute_value of the field
   # this combo is editing, or an object that could

data/lib/clevic/delegates/distinct_delegate.rb

@@ -7,12 +7,12 @@ module Clevic
 # :frequency can be set as an option. Boolean. If it's true
 # the options are sorted in order of most frequently used first.
 class DistinctDelegate
-  
+
   def needs_combo?
     # works except when there is a null in the column
     dataset.count > 0
   end
-  
+
   # TODO move away from ar_methods. Partly done.
   # TODO ordering by either recentness, or frequency. OR both.
   # TODO make sure nil is in the list. And the current item is at the top.
@@ -31,7 +31,7 @@ class DistinctDelegate
     else
       field.dataset_roller.dataset
     end
-    
+
     # now pull out the field and the distinct values
     base_dataset. \
       distinct. \
@@ -39,11 +39,11 @@ class DistinctDelegate
       order( field.attribute ). \
       naked
   end
-  
+
   def population
     dataset.map( field.attribute )
   end
-  
+
 end
 
 end

data/lib/clevic/delegates/relational_delegate.rb

@@ -9,18 +9,18 @@ class RelationalDelegate
   def needs_combo?
     dataset.count > 0
   end
-  
+
   def empty_set_message
     "There must be records in #{field.related_class} for this field to be editable."
   end
-  
+
   def population
     # dataset contains the set of all possible related entities,
-    
+
     # dataset is defined in Delegate
     # entity is set in init_component
     # field and entity are used by FieldValuer
-    
+
     # including the current entity.
     # Could also use
     #  dataset.or( entity_class.primary_key => entity_key.pk )
@@ -35,7 +35,7 @@ class RelationalDelegate
       values.unshift( attribute_value )
     end
   end
-  
+
   # don't allow new values
   def restricted?; true; end
 
@@ -53,7 +53,7 @@ protected
       field.dataset_roller.dataset
     end
   end
-  
+
 end
 
 end

data/lib/clevic/delegates/set_delegate.rb

@@ -11,15 +11,15 @@ class SetDelegate
     raise "SetDelegate must have a :set in options" if field.set.nil?
     super
   end
-  
+
   def needs_combo?
     true
   end
-  
+
   def restricted?
     field.restricted || false
   end
-  
+
   # Items here could either be single values,
   # or two-value arrays (from a hash-like set), so use key as db value
   # and value as display value

data/lib/clevic/dirty.rb

@@ -46,7 +46,7 @@ module ActiveRecord
     end
 
     private
-    
+
     # Map of change attr => original value.
     def changed_attributes
       @changed_attributes ||= {}

data/lib/clevic/emitter.rb

@@ -6,14 +6,14 @@ module Clevic
     def self.included( base )
       base.extend( ClassMethods )
     end
-    
+
     module ClassMethods
       def emitter( emitter_name )
         line, st = __LINE__, <<-EOF
           def #{emitter_name}_listeners
             @#{emitter_name}_listeners ||= Set.new
           end
-          
+
           # If msg is provided, yield to stored block.
           # If block is provided, store it for later.
           def emit_#{emitter_name}( *args, &notifier_block )
@@ -26,7 +26,7 @@ module Clevic
               end
             end
           end
-          
+
           def remove_#{emitter_name}( &notifier_block )
             #{emitter_name}_listeners.delete( notifier_block )
           end

data/lib/clevic/extensions.rb

@@ -9,7 +9,7 @@ class Object
       value.nil? ? nil : value.send( att )
     end
   end
-  
+
   # pass self to the block and return the results of the block.
   def with( &block )
     yield( self )
@@ -59,7 +59,7 @@ class Array
       index if include?( index )
     end
   end
-  
+
   def section
     return [] if empty?
     rv = [first]
@@ -69,7 +69,7 @@ class Array
     end
     rv
   end
-  
+
   # group by ascending values
   def group
     parts = []
@@ -81,7 +81,7 @@ class Array
       parts + self[section.size..-1].group
     end
   end
-  
+
   def range
     first..last
   end

data/lib/clevic/field.rb

@@ -19,10 +19,10 @@ will allow
 
   # reader
   instance.ixnay
-  
+
   # writer
   instance.ixnay = 'nix, baby'
-  
+
   # writer
   instance.ixnay 'nix baby'
 
@@ -42,10 +42,10 @@ And so it the #-- above.
 class Field
   # For defining properties
   include Gather
-  
+
   # for formatting values
   include GenericFormat
-  
+
   ##
   # :attr:
   # The value to be displayed after being optionally format-ed
@@ -62,33 +62,33 @@ class Field
   #
   # Defaults to nil, in other words the value of the attribute for this 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 
-  # by % (for everything else). It can also be a Proc that has one parameter - 
+  # Generally the string is something
+  # that can be understood by strftime (for time and date fields) or understood
+  # by % (for everything else). It can also be a Proc that has one parameter -
   # the current entity. There are sensible defaults for common field types.
   property :format
-  
+
   ##
   # :attr:
   # This is just like format, except that it's used to format the value just
@@ -96,12 +96,12 @@ class Field
   # but edit them with a 4 digit year.
   # Defaults to a sensible value for some fields, for others it will default to the value of :format.
   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
@@ -111,12 +111,12 @@ class Field
   # doesn't always work properly. So we
   # have the option to override that if we wish.
   property :sample
-  
+
   ##
   # :attr:
   # Takes a boolean. Set the field to read-only.
   property :read_only
-  
+
   ##
   # :attr:
   # The foreground and background colors.
@@ -125,10 +125,10 @@ class Field
   # - A String is treated as a constant which may be one of the string constants understood by Qt::Color
   # - A symbol is treated as a method to be call on an entity
   #
-  # The result can be a Qt::Color, or one of the strings in 
+  # The result can be a Qt::Color, or one of the strings in
   # http://www.w3.org/TR/SVG/types.html#ColorKeywords.
   property :foreground, :background
-  
+
   ##
   # :attr:
   # Can take a Proc, a string, or a symbol.
@@ -136,7 +136,7 @@ class Field
   # - A String is treated as a constant
   # - A symbol is treated as a method to be call on an entity
   property :tooltip
-  
+
   ##
   # :attr:
   # An Enumerable of allowed values for restricted fields. If each yields
@@ -144,7 +144,7 @@ class Field
   # first will be stored in the db, and the second displayed in the UI.
   # If it's a proc, that must return an Enumerable as above.
   property :set
-  
+
   ##
   # :attr:
   # When this is true, only the values in the combo may be entered.
@@ -152,7 +152,7 @@ class Field
   # non-listed values. Default is true if a set is explicitly specified.
   # Otherwise depends on the field type.
   property :restricted
-  
+
   ##
   # :attr:
   # Only for the distinct field type. The values will be sorted either with the
@@ -160,21 +160,21 @@ class Field
   # alphabetical order (:description => true).
   # FIXME re-implement this with Dataset
   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.
@@ -189,13 +189,13 @@ class Field
   def dataset
     dataset_roller
   end
-  
+
   # TODO Still getting the Builder/Built conflict
   def dataset_roller
     # related class if it's an association, entity_class otherwise
     @dataset_roller ||= DatasetRoller.new( ( association? ? related_class : entity_class ).dataset )
   end
-  
+
   # The list of properties for ActiveRecord options.
   # There are actually from ActiveRecord::Base.VALID_FIND_OPTIONS, but it's protected.
   # Each element becomes a property.
@@ -203,7 +203,7 @@ class Field
   # TODO warn or raise if these are used together with a dataset call
   AR_FIND_OPTIONS = [ :conditions, :include, :joins, :limit, :offset, :order, :select, :readonly, :group, :from, :lock ]
   AR_FIND_OPTIONS.each{|x| property x}
-  
+
   # Return a list of find options and their values, but only
   # if the values are not nil
   def find_options
@@ -215,25 +215,25 @@ class Field
       ha
     end
   end
-  
+
   # The model object (eg TableModel) this field is part of.
   # Set to TableModel by ModelBuilder#build
   attr_accessor :model
-    
+
   # The UI delegate class for the field. The delegate class knows how to create a UI
   # for this field using whatever GUI toolkit is selected
   attr_accessor :delegate
-  
+
   # 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 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
-  
+
   # The Object Relational Model this field uses to get data from.
   attr_reader :entity_class
-  
+
   # Create a new Field object that displays the contents of a database field in
   # the UI using the given parameters.
   # - attribute is the symbol for the attribute on the entity_class.
@@ -244,11 +244,11 @@ class Field
     unless attribute.is_a?( Symbol )
       raise "attribute #{attribute.inspect} must be a symbol"
     end
-    
+
     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
@@ -256,20 +256,20 @@ class Field
 #{entity_class.attribute_names.inspect}
 EOF
     end
-    
+
     # instance variables
     @attribute = attribute
     # default to attribute, can be overwritten later
     @id = attribute
     @entity_class = entity_class
     @visible = true
-    
+
     # initialise
     @value_cache = {}
-    
+
     # handle options
     gather( options, &block )
-    
+
     # set various sensible defaults. They're not lazy accessors because
     # they might stay nil, and we don't want to keep evaluating them.
     default_label!
@@ -278,7 +278,7 @@ EOF
     default_alignment!
     default_display! if association?
   end
-  
+
   # Return the attribute value for the given Object Relational Model instance, or nil
   # if entity is nil. Will call transform_attribute.
   def value_for( entity )
@@ -290,7 +290,7 @@ EOF
       puts e.backtrace
     end
   end
-  
+
   # Apply the value of the display property to the given
   # attribute value. Otherwise just return the
   # attribute_value itself.
@@ -299,47 +299,47 @@ EOF
     case display
       when Proc
         display.call( attribute_value )
-        
+
       when String
         attribute_value.evaluate_path( display.split( '.' ) )
-      
+
       when Symbol
         attribute_value.send( display )
-      
+
       else
         attribute_value
     end
   end
-  
+
   # return true if this is a field for a related table, false otherwise.
   def association?
     meta.andand.association?
   end
-  
+
   # Clevic::ModelColumn object
   def meta
     entity_class.meta[attribute] || ModelColumn.new( attribute, {} )
   end
-  
+
   # return true if this field can be used in a filter
   # virtual fields (ie those that don't exist in this field's
   # table) can't be used to filter on.
   def filterable?
     !meta.nil?
   end
-  
+
   # return the result of the attribute + the path
   def column
     [attribute.to_s, path].compact.join('.')
   end
-  
+
   # 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
@@ -347,23 +347,23 @@ EOF
     pieces.concat( display.to_s.split( '.' ) ) unless display.is_a? Proc
     pieces.map{|x| x.to_sym}
   end
-  
+
   # Return true if the field is read-only. Defaults to false.
   def read_only?
     @read_only || false
   end
-  
+
   # Called by Clevic::FieldValuer (and others) to format the display value.
   def do_format( value )
     do_generic_format( format, value )
   end
-  
+
   # 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.
@@ -389,7 +389,7 @@ EOF
       @sample
     end
   end
-  
+
   # Called by Clevic::TableModel to get the tooltip value
   def tooltip_for( entity )
     cache_value_for( :tooltip, entity )
@@ -399,22 +399,22 @@ EOF
   def decoration_for( entity )
     nil
   end
-  
+
   # Called by Clevic::TableModel to get the foreground color value
   def foreground_for( entity )
     cache_value_for( :foreground, entity ) {|x| string_or_color(x)}
   end
-  
+
   # Called by Clevic::TableModel to get the background color value
   def background_for( entity )
     cache_value_for( :background, entity ) {|x| string_or_color(x)}
   end
-  
+
   # called when a new entity object is created to set default values
   # specified by the default property.
   def set_default_for( entity )
     begin
-      entity[attribute] = 
+      entity[attribute] =
       case default
         when String
           default
@@ -426,31 +426,31 @@ EOF
       puts e.backtrace
     end
   end
-  
+
   # fetch the permitted set of values for a restricted field.
   def set_for( entity )
     case set
       when Proc
         # the Proc should return an enumerable
         set.call( entity )
-        
+
       when Symbol
         entity.send( set )
-        
+
       else
         # assume its an Enumerable
         set
     end
   end
-  
+
   def to_s
     "#{entity_class}.#{id}"
   end
-  
+
   def inspect
     "#<Clevic::Field #{entity_class} id=#{id} attribute=#{attribute}>"
   end
-  
+
 protected
 
   # call the conversion_block with the value, or just return the
@@ -462,7 +462,7 @@ protected
       conversion_block.call( value )
     end
   end
-  
+
   # symbol is the property name to fetch a value for.
   # It can be a Proc, a symbol, or a value responding to to_s.
   # In all cases, conversion block will be called
@@ -478,10 +478,10 @@ protected
       else; @value_cache[symbol] ||=convert_or_identity( value, &conversion_block )
     end
   end
-  
+
   # the label if it's not defined. Based on the attribute.
   def default_label!
-    @label ||= attribute.to_s.humanize
+    @label ||= ( id || attribute ).to_s.humanize
   end
 
   # sensible display format defaults if they're not defined.
@@ -494,7 +494,7 @@ protected
       when :decimal, :float; "%.2f"
     end
   end
-  
+
   # sensible edit format defaults if they're not defined.
   def default_edit_format!
     @edit_format ||=