clevic 0.13.0.b3 → 0.13.0.b5

data/lib/clevic/delegates/distinct_delegate.rb

@@ -0,0 +1,48 @@
+require 'clevic/delegates/combo_delegate.rb'
+
+module Clevic
+
+# Provide a list of all values in this field,
+# and allow new values to be entered.
+# :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.
+  # TODO and the current item is in the list, even if it's older
+  # we only use the first column, so use the second
+  # column to sort by, since SQL requires the order by clause
+  # to be in the select list where distinct is involved
+  def dataset
+    base_dataset =
+    unless field.find_options.empty?
+      puts "conditions and order are deprecated. Use dataset instead."
+      require 'clevic/ar_methods'
+      field.entity_class.plugin :ar_methods
+      field.entity_class.translate( field.find_options )
+    else
+      field.dataset_roller.dataset
+    end
+    
+    # now pull out the field and the distinct values
+    base_dataset. \
+      distinct. \
+      select( field.attribute ). \
+      order( field.attribute ). \
+      naked
+  end
+  
+  def population
+    dataset.map( field.attribute )
+  end
+  
+end
+
+end

data/lib/clevic/delegates/relational_delegate.rb

@@ -0,0 +1,59 @@
+require 'clevic/delegates/combo_delegate'
+require 'clevic/dataset_roller.rb'
+
+module Clevic
+
+# Display a collection of possible related entities in the combo box.
+# TODO this should be a module
+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 )
+    # but that would put current entity in the list somewhere
+    # other than the top, which seems to be the most sensible
+    # place for it. Could also create a special enumerator
+    # which gives back the entity first, followed by the dataset.
+    dataset.all.with do |values|
+      # make sure there's only one instance of the current value,
+      # and make sure it's at the top of the list
+      values.delete( attribute_value )
+      values.unshift( attribute_value )
+    end
+  end
+  
+  # don't allow new values
+  def restricted?; true; end
+
+protected
+  # Return an instance of the ORM dataset,
+  # right now that's Sequel::Dataset.
+  # This exists because convincing this functionality to
+  # coexist in the same method as dataset would be tricky.
+  def dataset
+    unless field.find_options.empty?
+      require 'clevic/ar_methods'
+      field.related_class.plugin :ar_methods
+      field.related_class.translate( field.find_options )
+    else
+      field.dataset_roller.dataset
+    end
+  end
+  
+end
+
+end

data/lib/clevic/delegates/set_delegate.rb

@@ -0,0 +1,31 @@
+require 'clevic/delegates/combo_delegate.rb'
+
+module Clevic
+
+# A Combo box which allows a set of values. May or may not
+# be restricted to the set.
+# TODO this should be a module
+class SetDelegate
+  # options must contain a :set => [ ... ] to specify the set of values.
+  def initialize( field )
+    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
+  def population
+    field.set_for( entity )
+  end
+end
+
+end

data/lib/clevic/field.rb

@@ -1,6 +1,8 @@
 require 'gather'
 require 'clevic/sampler.rb'
 require 'clevic/generic_format.rb'
+require 'clevic/dataset_roller.rb'
+require 'clevic/many_field.rb'
 
 module Clevic
 
@@ -136,7 +138,7 @@ class Field
   # 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.
-  # If it's a proc, it must return an Enumerable as above.
+  # If it's a proc, that must return an Enumerable as above.
   property :set
   
   ##
@@ -150,6 +152,7 @@ class Field
   # 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).
+  # FIXME re-implement this with Dataset
   property :frequency, :description
   
   ##
@@ -160,7 +163,8 @@ class Field
   
   ##
   # The property used for finding the field, ie by TableModel#field_column.
-  # Defaults to the attribute.
+  # 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
   
   ##
@@ -168,11 +172,26 @@ class Field
   # Either a proc( clevic_view, table_view, model_index ) or a symbol
   # for a method( view, model_index ) on the Clevic::View object.
   property :notify_data_changed
+
+  ##
+  # This is the dataset of related objects.
+  # Called in configuration for a field that works with a relationship.
+  #  dataset.filter( :blah => 'etc' ).order( :interesting_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.
-  # TODO remove these? That will destroy the migration path.
+  # TODO deprecate these
+  # 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}
   
@@ -188,6 +207,10 @@ class Field
     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
@@ -243,36 +266,6 @@ EOF
     default_display! if association?
   end
   
-  # x_to_many fields are by definition collections of other entities
-  def many( &block )
-    if block
-      many_view( &block )
-    else
-      many_view do |mb|
-        # TODO should fetch this from one of the field definitions
-        mb.plain related_attribute
-      end
-    end
-  end
-  
-  def many_builder
-    @many_view.builder
-  end
-  
-  def many_fields
-    many_builder.fields
-  end
-  
-  # return an instance of Clevic::View that represents the many items
-  # for this field
-  def many_view( &block )
-    @many_view ||= View.new( :entity_class => related_class, &block )
-  end
-  
-  # The model object (eg TableModel) this field is part of.
-  # Set to TableModel by ModelBuilder#build
-  attr_accessor :model
-  
   # 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 )
@@ -315,13 +308,6 @@ EOF
     entity_class.meta[attribute]
   end
   
-  # return the type of this attribute. Usually one of :string, :integer, :float
-  # or some entity class
-  # TODO remove
-  def attribute_type
-    meta.type
-  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.
@@ -337,7 +323,7 @@ EOF
   # return the class object of a related class if this is a relational
   # field, otherwise nil
   def related_class
-    return nil unless entity_class.meta.has_key?( attribute )
+    return nil unless association? && entity_class.meta.has_key?( attribute )
     @related_class ||= eval( entity_class.meta[attribute].class_name || attribute.to_s.classify )
   end
   
@@ -363,26 +349,24 @@ EOF
     do_generic_format( edit_format, value )
   end
   
-  # Return a sample for the field which can be used to size the UI field widget.
+  # Set or return a sample for the field which can be used to size the UI field widget.
   def sample( *args )
     if !args.empty?
       @sample = args.first
       self
     else
       if @sample.nil?
-        if meta.type == :boolean
-          @sample = self.label
-        else
-          begin
-            @sample ||= Sampler.new( entity_class, attribute, display ) do |value|
-              do_format( value )
-            end.compute
-          rescue
-            puts $!
-          ensure
-            # if we don't know how to figure it out from the data, just return the label size
-            @sample ||= self.label
-          end
+        begin
+          @sample ||= Sampler.new( self ) do |value|
+            do_format( value )
+          end.compute
+        rescue
+          puts "for #{entity_class.name}"
+          puts $!.message
+          puts $!.backtrace
+        ensure
+          # if we don't know how to figure it out from the data, just return the label size
+          @sample ||= self.label
         end
       end
       @sample

data/lib/clevic/field_valuer.rb

@@ -1,6 +1,6 @@
 module Clevic
-  # to be included in something that responds to entity and field
-  # used for getting values from the entity based on the definitions
+  # To be included in something that responds to entity and field methods.
+  # Used for getting values from the entity based on the definitions
   # in the field.
   module FieldValuer
   
@@ -26,13 +26,19 @@ module Clevic
       self.attribute_value =
       case
         # allow flexibility in entering dates. For example
-        # 16jun, 16-jun, 16 jun, 16 jun 2007 would be accepted here
-        # TODO need to be cleverer about which year to use
-        # for when you're entering 16dec and you're in the next
-        # year
+        # 16jun, 16-jun, 16/jun would be accepted here.
+        # Previous year is used  if data capture is in January
+        # or February, and date.month is aug-dec.
         when [:date,:datetime].include?( field.meta.type ) && value =~ %r{^(\d{1,2})[ /-]?(\w{3})$}
-          Date.parse( "#$1 #$2 #{Time.now.year.to_s}" )
-        
+          today = Date.today
+          date = Date.parse( "#$1 #$2 #{Time.now.year.to_s}" )
+          
+          # change year to last year
+          if (1..2).include?( today.month ) and (8..12).include?( date.month )
+            date = Date.civil( Date.today.year - 1, date.month, date.day )
+          end
+          date
+          
         # if a digit only is entered, fetch month and year from
         # previous row
         when [:date,:datetime].include?( field.meta.type ) && value =~ %r{^(\d{1,2})$}
@@ -44,8 +50,10 @@ module Clevic
             value
           end
         
-        # this one is mostly to fix date strings that have come
+        # Mostly to fix date strings that have come
         # out of the db and been formatted
+        # Accepts dd mmm yy.
+        # Assumes 20 as the century.
         when [:date,:datetime].include?( field.meta.type ) && value =~ %r{^(\d{2})[ /-](\w{3})[ /-](\d{2})$}
           Date.parse( "#$1 #$2 20#$3" )
         
@@ -60,6 +68,7 @@ module Clevic
           # do various transforms
           case
             # accept a space or a comma instead of a . for floats
+            # as long as there are only 2 decimal places
             when value =~ /(.*?)(\d)[ ,](\d{2})$/
               "#$1#$2.#$3"
             else
@@ -72,7 +81,7 @@ module Clevic
     end
     
     def find_related( attribute, value )
-      candidates = field.related_class.adaptor.find( :all, :conditions => {attribute => value} )
+      candidates = field.related_class.filter( attribute.to_sym => value ).all
       if candidates.size != 1
         raise "#{candidates.size} != 1 candidates for #{value}: #{candidates.inspect}"
       end
@@ -152,6 +161,10 @@ module Clevic
       end
     end
     
+    def valuer( entity )
+      Valuer.new(field,entity)
+    end
+    
     def self.valuer( field, entity )
       Valuer.new(field,entity)
     end

data/lib/clevic/filter_command.rb

@@ -1,41 +1,32 @@
 module Clevic
   class FilterCommand
-    # TODO seems like either filter_indexes, filter_conditions can be
-    # passed. Better docs needed, and better api.
-    def initialize( table_view, filter_indexes, filter_conditions )
+    # filter_block will be passed a Dataset to filter.
+    # filter_message will be displayed.
+    def initialize( table_view, message, &filter_block )
       @table_view = table_view
-      @filter_conditions = filter_conditions
-      @filter_indexes = filter_indexes
-      
-      # Better make the status message now, before the indexes become invalid
-      @status_message =
-      if filter_indexes.empty?
-        # no indexes, so use filter_conditions.
-        "Filtered on #{filter_conditions.inspect}"
-      else
-        "Filtered on #{filter_indexes.first.field.label} = #{filter_indexes.first.display_value}"
-      end
+      @message = message
+      @filter_block = filter_block
     end
     
+    attr_reader :message
+    
     # Do the filtering. Return true if successful, false otherwise.
     def doit
-      begin
-        # store current AR conditions
-        @stored_conditions = @table_view.model.cache_table.find_options
-        
-        # store auto_new
-        @auto_new = @table_view.model.auto_new
-        
-        # reload cache table with new conditions
-        @table_view.model.auto_new = false
-        @table_view.model.reload_data( @filter_conditions )
-      rescue Exception => e
-        puts
-        puts e.message
-        puts e.backtrace
-        false
-      end
+      # store current dataset
+      @previous_dataset = @table_view.model.cache_table.dataset
+      
+      # store auto_new
+      @auto_new = @table_view.model.auto_new
+      
+      # reload cache table with new conditions
+      @table_view.model.auto_new = false
+      @table_view.model.reload_data( &@filter_block )
       true
+    rescue Exception => e
+      puts
+      puts e.message
+      puts e.backtrace
+      false
     end
     
     def undo
@@ -43,12 +34,7 @@ module Clevic
       @table_view.model.auto_new = @auto_new
       
       # reload cache table with stored AR conditions
-      @table_view.model.reload_data( @stored_conditions )
-    end
-    
-    # return a message based on the conditions
-    def status_message
-      @status_message
+      @table_view.model.reload_data( @previous_dataset )
     end
   end
 end