clevic 0.13.0.b3 → 0.13.0.b5

data/lib/clevic/framework.rb

@@ -0,0 +1,37 @@
+=begin rdoc
+  To handle multiple GUI frameworks, Clevic makes use of 
+  Ruby's open classes. Whenever there is a class that
+  interacts with a GUI framework (say Qt, or Java Swing)
+  the framework-specific part of the class is loaded
+  first to get access to the framework's inheritance
+  hierarchy, then the file with the framework-neutral
+  code is loaded. The code below helps to check
+  that the relevant methods from framework-neutral code
+  are already defined by the time the framework-neutral
+  class definition is executed.
+=end
+class Class
+  
+  # method_name can be a symbol or a string.
+  # 
+  # If a method of this name doesn't already exist
+  # add it, so that if when it's called later it raises
+  # and exception. Otherwise if the named method already
+  # exists, just leave it alone.
+  def framework_responsibility( method_name )
+    unless instance_methods.include?( method_name.to_s )
+      define_method method_name do
+        raise "Framework-specific code has not defined for for #{self.class}##{method_name}"
+      end
+    end
+  end
+  
+  def subclass_responsibility( method_name )
+    unless instance_methods.include?( method_name.to_s )
+      define_method( method_name ) do
+        raise "#{method_name} is subclass responsibility for #{self.class}"
+      end
+    end
+  end
+  
+end

data/lib/clevic/generic_format.rb

@@ -1,6 +1,9 @@
 module Clevic
 
-#includers must provide meta and display
+# Format values for display / edit. Essentially a common interface
+# for % for Strings and strftime for Dates and Times.
+#
+# includers must provide meta and display
 module GenericFormat
   # Return true if the field is a date, datetime, time or timestamp.
   # If display is nil, the value is calculated, so we need
@@ -38,6 +41,7 @@ module GenericFormat
         value
       end
     rescue Exception => e
+      puts "self: #{self.inspect}"
       puts "format: #{format.inspect}"
       puts "value.class: #{value.class.inspect}"
       puts "value: #{value.inspect}"

data/lib/clevic/many_field.rb

@@ -1,7 +1,32 @@
 module Clevic
 
-# Field for the other end of a one-to-many, or maybe also a many-to-many.
-class ManyField < Field
-end
+  # Preliminary code for multi-valued fields. Not working yet.
+  module ManyField
+    # 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
+  end
 
 end

data/lib/clevic/model_builder.rb

@@ -513,15 +513,17 @@ class ModelBuilder
     field.delegate = BooleanDelegate.new( field )
   end
   
-  # mostly used in the new block to define the set of records
-  # for the TableModel, but may also be
-  # used as an accessor for records.
-  def records( args = {} )
-    if args.size == 0
-      get_records
-    else
-      set_records( args )
-    end
+  # specify the dataset but just calling and chaining, thusly
+  #  dataset.order( :some_field ).filter( :active => true )
+  def dataset
+    @dataset_roller = DatasetRoller.new( entity_class.dataset )
+  end
+  
+  def records( *args )
+    puts "ModelBuilder#records is deprecated. Use ModelBuilder#dataset instead"
+    require 'clevic/sequel_ar_adapter.rb'
+    entity_class.plugin :ar_methods
+    @cache_table = CacheTable.new( entity_class, entity_class.translate( args.first ) )
   end
 
   # Tell this field not to show up in the UI.
@@ -560,7 +562,15 @@ class ModelBuilder
     entity_class.attributes.each do |column,model_column|
       begin
         if model_column.association?
-          relational column
+          relational column do |f|
+            # TODO this should be tableize or equivalent
+            %W{#{model_column.related_class.name.downcase} name title username}.each do |name|
+              if model_column.related_class.instance_methods.include?( name )
+                f.display = name.to_sym
+                break
+              end
+            end
+          end
         else
           plain column
         end
@@ -572,7 +582,6 @@ class ModelBuilder
         plain column
       end
     end
-    records :order => entity_class.primary_key
   end
   
   # return the named Clevic::Field object
@@ -605,7 +614,7 @@ class ModelBuilder
     end
     
     # the data
-    @model.collection = records
+    @model.collection = create_cache_table
     
     @model
   end
@@ -632,34 +641,20 @@ protected
       when entity_class.instance_methods.include?( attribute.to_s )
         # read-only if there's no setter for the attribute
         !entity_class.instance_methods.include?( "#{attribute.to_s}=" )
+        
       else
         # default to not read-only
         false
     end
   end
 
-  # The collection of model objects to display in a table
-  # arg can either be a Hash, in which case a new CacheTable
-  # is created, or it can be an array.
-  # Called by records( *args )
-  def set_records( arg )
-    if arg.class == Hash
-      # need to defer this until all fields are collected
-      @find_options = arg
-    else
-      @records = arg
+  def create_cache_table
+    if @dataset_roller
+      @cache_table = CacheTable.new( entity_class, @dataset_roller.dataset )
     end
+    # otherwise just default it
+    @cache_table ||= CacheTable.new( entity_class )
   end
-
-  # Return a collection of records. Usually this will be a CacheTable.
-  # Called by records( *args )
-  def get_records
-    if @records.nil?
-      @records = CacheTable.new( entity_class, @find_options )
-    end
-    @records
-  end
-  
 end
 
 end

data/lib/clevic/ordered_dataset.rb

@@ -0,0 +1,45 @@
+module Clevic
+  
+  # Provides a nice way of getting to Sequel::Dataset's
+  # opts[:order] information
+  #
+  # Including class must call dataset= before calling order_attributes
+  module OrderedDataset
+  
+    # returns a collection of [ attribute, (1|-1) ]
+    # where 1 is forward/asc (>) and -1 is backward/desc (<)
+    def order_attributes
+      if @order_attributes.nil?
+        @order_attributes =
+        dataset.opts[:order].map do |order_expr|
+          case order_expr
+          when Symbol
+            [ order_expr, 1 ]
+            
+          when Sequel::SQL::OrderedExpression
+            [ order_expr.expression, order_expr.descending ? -1 : 1 ]
+            
+          else
+            raise "unknown order_expr: #{order_expr.inspect}"
+          end
+        end
+      end
+      @order_attributes
+    end
+  
+    attr_reader :dataset
+    
+    # Set default dataset ordering to primary key if it doesn't
+    # already have an order.
+    def dataset=( other )
+      @dataset =
+      if other.opts[:order].nil?
+        other.order( other.model.primary_key )
+      else
+        other
+      end
+    end
+  
+  end
+
+end

data/lib/clevic/qt.rb

@@ -2,13 +2,16 @@
   Require this file to do Clevic in Qt
 =end
 
-require 'pathname'
+require 'clevic/framework'
+
+require 'Qt4'
 
 # require these first, so TableModel and TableView get the correct ancestors
 require 'clevic/qt/table_model.rb'
 require 'clevic/qt/table_view.rb'
 
 # all other files in the qt subdirectory
+require 'pathname'
 ( Pathname.new( __FILE__ ).parent + 'qt' ).children.grep( /.rb$/ ).each do |child|
   require child.to_s
 end

data/lib/clevic/qt/action_builder.rb

@@ -35,7 +35,15 @@ module ActionBuilder
       unless block.nil?
         action_triggered do
           qt_action.connect SIGNAL( signal_name ) do |active|
-            yield( active )
+            # need this rescue here because otherwise Qt
+            # doesn't catch it and the whole app comes down
+            begin
+              yield( active )
+            rescue
+              # TODO how to display this in the UI?
+              puts $!.message
+              puts $!.backtrace
+            end
           end
         end
       end

data/lib/clevic/qt/browser.rb

@@ -154,7 +154,7 @@ class Browser < Qt::Widget
         # handle filter status changed, so we can provide a visual indication
         tab.connect SIGNAL( 'filter_status_signal(bool)' ) do |status|
           # update the tab, so there's a visual indication of filtering
-          filter_title = ( tab.filtered ? '| ' : '' ) + translate( tab.title )
+          filter_title = ( tab.filtered? ? '| ' : '' ) + translate( tab.title )
           tables_tab.set_tab_text( tables_tab.current_index, filter_title )
         end
       rescue Exception => e

data/lib/clevic/qt/clipboard.rb

@@ -24,9 +24,9 @@ module Clevic
       system.mime_data.has_html
     end
     
-    # TODO figure out why Qt never has anything other than text
-    # could be because the event loop isn't running when testing
-    # from irb
+    # TODO figure out why Qt never has anything other than text.
+    # Could be because the event loop isn't running when testing
+    # from irb.
     def html
       system.mime_data.html
     end

data/lib/clevic/qt/combo_delegate.rb

@@ -1,4 +1,5 @@
-require 'clevic/qt/item_delegate.rb'
+require 'clevic/qt/delegate.rb'
+require 'clevic/qt/qt_combo_box.rb'
 
 module Clevic
 
@@ -8,12 +9,9 @@ because ComboBox stupidly doesn't.
 
 Generally these will be created using a Clevic::ModelBuilder.
 =end
-class ComboDelegate < Clevic::ItemDelegate
-  def initialize( field )
-    super
-  end
-  
+class ComboDelegate < Clevic::Delegate
   # Convert Qt:: constants from the integer value to a string value.
+  # TODO this really shouldn't be here. qtext, or extensions.rb
   def hint_string( hint )
     hs = String.new
     Qt::AbstractItemDelegate.constants.each do |x|
@@ -38,102 +36,38 @@ class ComboDelegate < Clevic::ItemDelegate
   
   # open the combo box, just like if f4 was pressed
   def full_edit
-    if is_combo?( @editor )
-      @editor.show_popup
-    end
-  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 fill the combo box
-  # list with values.
-  def populate( editor, model_index )
-    raise "subclass responsibility"
+    editor.show_popup if is_combo?( editor )
   end
   
-  # return true if this delegate needs a combo, false otherwise
-  def needs_combo?
-    raise "subclass responsibility"
-  end
-
   def is_combo?( editor )
-    editor.class == Qt::ComboBox
-  end
-  
-  # 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?
+    editor.is_a?( Qt::ComboBox )
   end
   
-  # the message to display if the set is empty, and
-  # the delegate is restricted to a predefined set.
-  def empty_set_message
-    raise "subclass responsibility"
-  end
-  
-  # if this delegate has an empty set, return the message, otherwise
-  # return nil.
-  def if_empty_message
-    if empty_set?
-      empty_set_message
+  def create_combo_box( *args )
+    Qt::ComboBox.new( parent ).tap do |combo|
+      # all combos are editable so that prefix matching will work
+      combo.editable = true
     end
   end
   
-  def populate_current( editor, model_index )
-    # add the current entry, if it isn't there already
-    # TODO add it in the correct order
-    if ( editor.find_data( model_index.display_value.to_variant ) == -1 )
-      editor.add_item( model_index.display_value, model_index.display_value.to_variant )
-    end
+  # Override the Qt method. Create a ComboBox widget and fill it with the possible values.
+  def createEditor( parent_widget, style_option_view_item, model_index )
+    self.parent = parent_widget
+    self.entity = model_index.entity
+    init_component( parent_widget, style_option_view_item, model_index )
+    editor.delegate = self
+    editor
   end
 
-  def add_nil_item( editor )
-    if ( editor.find_data( nil.to_variant ) == -1 )
-      editor.add_item( '', nil.to_variant )
-    end
+  def line_editor( edit_value )
+    @line_editor ||= Qt::LineEdit.new( edit_value, parent )
   end
   
-  # Override the Qt method. Create a ComboBox widget and fill it with the possible values.
-  def createEditor( parent_widget, style_option_view_item, model_index )
-    if needs_combo?
-      @editor = Qt::ComboBox.new( parent_widget )
-      
-      # subclasses fill in the rest of the entries
-      populate( @editor, model_index )
-      
-      # add the current item, if it isn't there already
-      populate_current( @editor, model_index )
-      
-      # create a nil entry
-      add_nil_item( @editor ) if allow_null?
-      
-      # allow prefix matching from the keyboard
-      @editor.editable = true
-      
-      # don't insert if restricted
-      @editor.insert_policy = Qt::ComboBox::NoInsert if restricted?
-    else
-      @editor =
-      if restricted?
-        emit parent.status_text( empty_set_message )
-        nil
-      else
-        Qt::LineEdit.new( model_index.edit_value, parent_widget )
-      end
-    end
-    @editor
+  def framework_setup( *args )
+    # don't need to do anything here
+    # might need to once prefix-matching is implemented
   end
-  
+
   # Override the Qt::ItemDelegate method.
   def updateEditorGeometry( editor, style_option_view_item, model_index )
     rect = style_option_view_item.rect
@@ -196,3 +130,5 @@ class ComboDelegate < Clevic::ItemDelegate
 end
 
 end
+
+require 'clevic/delegates/combo_delegate'