lore 0.4.7 → 0.4.8

data/History.txt

@@ -1,3 +1,9 @@
+
+=== 0.4.8 / 2008-01-08
+
+* Using Aurita::GUI (gem: aurita-gui) for 
+  form generation. 
+
 === 0.4.7 / 2008-12-29
 
 * Extended configuration (especially logging). 

data/custom_models.rb

@@ -1,153 +0,0 @@
-
-require('lore/model') 
-
-module Some
-module App
-
-  class New_Model < Lore::Model 
-    table :new_model, :public
-    primary_key :model_id, :model_id_seq
-    has_attribute :name, Lore::Type.integer
-    has_attribute :created, Lore::Type.timestamp
-    has_attribute :model_id, Lore::Type.integer
-
-
-  end
-end
-end
-
-module Some
-module App
-
-  class New_Model < Lore::Model 
-    table :new_model, :public
-    primary_key :model_id, :model_id_seq
-    has_attribute :name, Lore::Type.integer
-    has_attribute :created, Lore::Type.timestamp
-    has_attribute :model_id, Lore::Type.integer
-
-
-  end
-end
-end
-
-module Some
-module App
-
-  class New_Model < Lore::Model 
-    table :new_model, :public
-    primary_key :model_id, :model_id_seq
-    has_attribute :name, Lore::Type.integer
-    has_attribute :created, Lore::Type.timestamp
-    has_attribute :model_id, Lore::Type.integer
-
-
-  end
-end
-end
-
-module Some
-module App
-
-  class New_Model < Lore::Model 
-    table :new_model, :public
-    primary_key :model_id, :model_id_seq
-    has_attribute :name, Lore::Type.integer
-    has_attribute :created, Lore::Type.timestamp
-    has_attribute :model_id, Lore::Type.integer
-
-
-  end
-end
-end
-
-module Some
-module App
-
-  class New_Model < Lore::Model 
-    table :new_model, :public
-    primary_key :model_id, :model_id_seq
-    has_attribute :name, Lore::Type.integer
-    has_attribute :created, Lore::Type.timestamp
-    has_attribute :model_id, Lore::Type.integer
-
-
-  end
-end
-end
-
-module Some
-module App
-
-  class New_Model < Lore::Model 
-    table :new_model, :public
-    primary_key :model_id, :model_id_seq
-    has_attribute :name, Lore::Type.integer
-    has_attribute :created, Lore::Type.timestamp
-    has_attribute :model_id, Lore::Type.integer
-
-
-  end
-end
-end
-
-module Some
-module App
-
-  class New_Model < Lore::Model 
-    table :new_model, :public
-    primary_key :model_id, :model_id_seq
-    has_attribute :name, Lore::Type.integer
-    has_attribute :created, Lore::Type.timestamp
-    has_attribute :model_id, Lore::Type.integer
-
-
-  end
-end
-end
-
-module Some
-module App
-
-  class New_Model < Lore::Model 
-    table :new_model, :public
-    primary_key :model_id, :model_id_seq
-    has_attribute :name, Lore::Type.integer
-    has_attribute :created, Lore::Type.timestamp
-    has_attribute :model_id, Lore::Type.integer
-
-
-  end
-end
-end
-
-module Some
-module App
-
-  class New_Model < Lore::Model 
-    table :new_model, :public
-    primary_key :model_id, :model_id_seq
-    has_attribute :name, Lore::Type.integer
-    has_attribute :created, Lore::Type.timestamp
-    has_attribute :model_id, Lore::Type.integer
-
-
-  end
-end
-end
-
-module Some
-module App
-
-  class New_Model < Lore::Model 
-    table :new_model, :public
-    primary_key :model_id, :model_id_seq
-    has_attribute :name, Lore::Type.integer
-    has_attribute :created, Lore::Type.timestamp
-    has_attribute :model_id, Lore::Type.integer
-
-
-  end
-end
-end
-

data/lib/lore/behaviours/lockable.rb

@@ -5,37 +5,51 @@ module Behaviours
   module Lockable
 
     # Defines which attribute to use for locking. 
-    # Default is 'lock'.
     # Usage: 
     #
-    # If a block is given, a lock is only set when it 
-    # evaluates to true: 
+    #   class My_Model < Lore::Model
+    #   extend Lockable
+    #   include Lockable_Entity
+    #     
+    #     # ...
+    #     lock_by(:lock_field)
     #
-    #   lock_by(:lock) { |me|
-    #     me.user_id != $user.user_id
-    #   }
+    #   end
     #
-    def lock_by(attrib, &block)
-      @lock_proc = block
+    #   my_model_entity.lock! 
+    #   # same as
+    #   My_Model.lock!(my_model_entity)
+    #
+    def lock_by(attrib)
       @lock_attr = attrib
       @lock_attr_name = attrib.to_s.split('.')[-1].intern
     end
     
     def lock!(inst)
-      inst[@lock_attr] = true
+      inst.attr[@lock_attr] = true
       commit
     end # def
-
     def release!(inst)
-      inst[@lock_attr] = false
+      inst.attr[@lock_attr] = false
       commit
     end # def
-    
     def locked?(inst)
-      (inst[@lock_attr] == true) || (inst[@lock_attr] == 't')
+      (inst.attr[@lock_attr] == true) || (inst.attr[@lock_attr] == 't')
     end # def
 
   end # module
 
+  module Lockable_Entity
+    def lock!
+      self.class.lock!(self)
+    end
+    def release!
+      self.class.release!(self)
+    end
+    def locked?
+      self.class.locked?(self)
+    end
+  end
+
 end # module
 end # module

data/lib/lore/behaviours/movable.rb

@@ -2,23 +2,40 @@
 module Lore
 module Behaviours
 
+  # Move an entity within a given criteria range, 
+  # e.g. within nodes of a tree. 
+  #
+  # Usage: 
+  #  
+  #   class My_Model < Lore::Model
+  #   extend Lore::Behaviours::Movable
+  #   include Lore::Behaviours::Movable_Entity
+  #    # ...
+  #    ordered_by(:position)
+  #   end
+  #
+  #   # Will move entity to position 12 within child entries
+  #   # of node with id 2: 
+  #   my_model_entity.move_to(12, (My_Model.parent_id == 2))
+  #   # Same as
+  #   My_Model.move(my_model_entity, 12, (My_Model.parent_id == 2))
+  #
   module Movable
 
-    def ordered_by(attr)
-      @order_attr = attr
-      @order_attr_name = attr.to_s.split('.')[-1].intern
+    def ordered_by(attrib)
+      @order_attr = attrib
+      @order_attr_name = attrib.to_s.split('.')[-1].intern
     end
     
     def move(inst, sortpos, criteria)
-
       sortpos = sortpos.to_i
       return if sortpos < 1
-      
+
+      criteria ||= Lore::Clause.new()
       sortpos_old = inst.attr[@order_attr_name].to_i
 
       # move down: 
       if sortpos.to_i > sortpos_old then
-        
         self.update { |na|
           na.set({@order_attr_name => @order_attr-1}).where(
             (criteria) &
@@ -26,9 +43,8 @@ module Behaviours
             (@order_attr > sortpos_old)
           )
         }
-
+      # move up: 
       elsif sortpos.to_i < sortpos_old then
-        
         self.update { |na|
           na.set({@order_attr_name => @order_attr+1}).where(
             (criteria) &
@@ -36,19 +52,21 @@ module Behaviours
             (@order_attr < sortpos_old)
           )
         }
-        
       end
-
+      # In case we actually had to move the entity: 
       if sortpos != sortpos_old then
-        
         inst.set_attribute_value(@order_attr_name, sortpos)
         inst.commit()
-
       end
-
     end # def
     
   end # module
 
+  module Movable_Entity
+    def move_to(position, criteria=nil)
+      self.class.move(self, position, criteria)
+    end
+  end
+
 end # module
 end # module

data/lib/lore/behaviours/paginated.rb

@@ -0,0 +1,31 @@
+
+module Lore
+module Behaviours
+
+
+  # Usage: 
+  #
+  #   class My_Model < Lore::Model
+  #   extend Lore::Behaviours::Paginated
+  #   
+  #     def self.search(search, page)
+  #       paginate(:per_page => 10, 
+  #                :page => page, 
+  #                :filter => all_with(search).order_by(:name, :desc))
+  #     end
+  #
+  #   end
+  #
+  #   first_page_entities => My_Model.search((My_Model.attribute == 'foo'), 1)
+  #
+  module Paginated
+  
+    def paginate(params)
+      entities = params[:filter].limit(params[:per_page], params[:page]).entities
+    end
+  
+  end
+
+end
+end
+

data/lib/lore/behaviours/versioned.rb

@@ -2,20 +2,32 @@
 module Lore
 module Behaviours
 
+  # Usage: 
+  #
+  #   class My_Model < Lore::Model
+  #   extend Lore::Behaviours::Versioned
+  #     # ...
+  #     version_by :version_number
+  #   end
+  #
+  #   my_model_entity.foo = 'bar'
+  #   my_model_entity.commit  # Will create a new version
+  #
   module Versioned
   
     # Defines attribute the version number is stored in. 
     # Default is 'version'. 
-    def version_by(attrib)
+    def version_by(attrib=:version)
       @version_attr = attrib
       @version_attr_name = attrib.to_s.split('.')[-1].intern
     end
     
     # Overloads commit so it increments the version attribute 
-    # before saving instance to database. 
+    # before saving instance to database and creates a new 
+    # entity with incremented version instead. 
     def commit()
       set_attribute_value(@version_attr, self.attr[@version_attr].to_i + 1)
-      super()
+      create(self.attr)
     end
 
   end # module

data/lib/lore/gui/form_generator.rb

@@ -1,151 +1,119 @@
 
-require('lore/types')
-require('lore/gui/form')
+require('aurita')
+Aurita.import_module :gui, :module
+Aurita.import_module :gui, :model_select_field
 
 module Lore
 module GUI
 
+  # A factory rendering Aurita::GUI:Form instances for 
+  # Aurita::Model classes. 
+  #
   # Usage: 
-  # 
-  #   generator = Form_Generator.new(Table_Accessor, Lang, :readonly | :mutable)
-  #   form = generator.generate
-  # 
-  # See documentation of Cuba::GUI::Form for usage of form instances. 
+  #   
+  #   generator = Lore_Form_Generator.new(Some_Lore_Model)
+  #   generator.params = { :action => '/aurita/dispatch', :onsubmit => "alert('submitting'); " }
+  #   generator.generate
+  #   puts generator.form
   #
-  class Form_Generator
+  class Form_Generator 
 
-    def initialize(klass=nil, labels={}, mode=:mutable, custom_elements={}) # {{{
-      
-      @logger          = Lore.logger
-      @form            = Form.new()
-      @labels          = labels
-      @klass           = klass
-      @custom_elements = custom_elements
+    attr_reader :form, :klass
+    attr_accessor :custom_elements, :labels, :params
 
-      Textarea.reset_counter
+    def initialize(klass=nil)
+      @klass           = klass
+      @labels          = {}
+      @params          = {}
+      @custom_elements = {}
+      @form            = false
+    end
 
-      @logger.debug('CUSTOM ELEMENTS: ' << @custom_elements.inspect)
-      
-      if @klass.nil? then return end
-      @logger.debug('GET_ATTRIBUTES: ' << @klass.inspect)
-      @logger.debug('GET_ATTRIBUTES: ' << @klass.get_attributes.inspect)
-      @klass.get_attributes.each_pair { |table, attributes| 
+    def form
+      generate() unless @form
+      @form
+    end
 
-      # handle attributes passed via attrib_setup: 
-        
-        attributes.each { |attrib|
+    def generate
+      @form = Aurita::GUI::Form.new(@params)
 
-          label_tag = table.gsub('.','--') << '--' << attrib
-          if(@labels[label_tag].to_s != '' && @labels[label_tag] != label_tag) then 
-            label = @labels[label_tag] 
-          else
-            label = attrib.gsub('_',' ').capitalize
-          end
+      @klass.get_attributes.each_pair { |table, attributes|
+        attributes.each { |attribute|
+          label_tag    = table.gsub('.','--') << '--' << attribute
+          label        = @labels[label_tag]
+          label      ||= label_tag
+          full_attrib  = table + '.' << attribute
+          field_name   = full_attrib.gsub('.','_')
+          form_element = false
           
           # @custom_elements is a hash mapping attribute names to
           # Custom_Element instances. 
           if ((@custom_elements[table]) and
-              (@custom_elements[table][attrib])) then
+              (@custom_elements[table][attribute])) then
             
-            form_element = @custom_elements[table][attrib].new(table, attrib, label)
-            form_element.mode = mode
-            @form.add(form_element)
+            form_element = @custom_elements[table][attribute].new(table, attribute, label)
             
-          elsif (@klass.get_primary_keys[table].nil? or
-                 !@klass.get_primary_keys[table].include? attrib) and
-                (@klass.get_implicit_attributes[table].nil? or
-                 !@klass.get_implicit_attributes[table].include? attrib) and
-                (@klass.get_has_a_klasses.nil? or
-                 @klass.get_has_a_klasses[table+'.'+attrib].nil?) and
-                (@klass.get_hidden_attributes[table].nil? or
-                 !@klass.get_hidden_attributes[table].include? attrib)
+          elsif (@klass.get_primary_keys[table].nil? or                      # Ignore primary key attributes
+                 !@klass.get_primary_keys[table].include? attribute) and        
+                (@klass.get_implicit_attributes[table].nil? or               # Ignore implicit attributes
+                 !@klass.get_implicit_attributes[table].include? attribute) and 
+                (@klass.get_has_a_klasses.nil? or                            # Ignore attributes aggregated via has_a associations (added later)
+                 @klass.get_has_a_klasses[table+'.'+attribute].nil?) and        
+                (@klass.get_hidden_attributes[table].nil? or                 # Ignore otherwise hidden attributes
+                 !@klass.get_hidden_attributes[table].include? attribute)
           then
-            
-            case @klass.get_attribute_types[table][attrib]
-              
+          # Attribute has to be added to form, according to data type
+            case @klass.get_attribute_types[table][attribute]
             when Lore::PG_BOOL
-              form_element = Radio.new(table, attrib, label, ['t','f'])
+              form_element = Radio_Field.new(:label => label, 
+                                             :name  => field_name, 
+                                             :options => { 't' => 'yes', 'f' => 'no' } )
               
             when Lore::PG_SMALLINT || Lore::PG_INT
-              form_element = Text.new(table, attrib, label, nil)
-              
+              form_element = Input_Field.new(:label => label, :name => field_name)
             when Lore::PG_VARCHAR
-              form_element = Text.new(table, attrib, label, nil, nil)
-              if (!@klass.get_maxlength.nil? && 
-                  !@klass.get_maxlength[table].nil? && 
-                  !@klass.get_maxlength[table][attrib.intern].nil?) then 
-                form_element.set_length(@klass.get_maxlength[table][attrib.intern])
-              end
-              
+              form_element = Input_Field.new(:label => label, :name => field_name)
             when Lore::PG_TEXT
-              form_element = Textarea.new(table, attrib, label, nil, nil)
-              if (!@klass.get_maxlength.nil? && 
-                  !@klass.get_maxlength[table].nil? && 
-                  !@klass.get_maxlength[table][attrib.intern].nil?) then 
-                form_element.set_length(@klass.get_maxlength[table][attrib.intern])
-              end
-              
+              form_element = Textarea_Field.new(:label => label, :name => field_name)
             when Lore::PG_TIMESTAMP_TIMEZONE
-              form_element = Date.new(table, attrib, label, nil)
-              
+              form_element = Datetime_Field.new(:label => label, :name => field_name, :date_format => 'dmy', :time_format => 'hms', :year_range => (2009..2020))
             when Lore::PG_DATE
-              form_element = Date.new(table, attrib, label, nil)
-              
+              form_element = Date_Field.new(:label => label, :name => field_name, :date_format => 'dmy', :year_range => (2009..2020))
             else
-              form_element = Text.new(table, attrib, label, nil)
+              form_element = Input_Field.new(:label => label, :name => field_name)
             end
-            
-            form_element.set_mode(mode)
-            @form.add(form_element)
-            
+
           elsif (!@klass.get_has_a_klasses.nil? and
-                 !@klass.get_has_a_klasses[table+'.'+attrib].nil?)
+                 !@klass.get_has_a_klasses[full_attrib].nil?)
           then 
-            foreign_klass   = @klass.get_has_a_klasses[table+'.'+attrib]
-            foreign_table   = foreign_klass.table_name
-            
-            form_element    = Klass_Select.new(foreign_klass, table, attrib, label)
-            form_element.set_mode(mode)
-            @form.add(form_element)
-            
+            foreign_klass   = @klass.get_has_a_klasses[full_attrib]
+            form_element    = Model_Select_Field.new(foreign_klass, :label => label, :name => field_name)
+
           elsif (!@klass.get_aggregate_klasses.nil? and
-                 !@klass.get_aggregate_klasses[table+'.'+attrib].nil?)
+                 !@klass.get_aggregate_klasses[full_attrib].nil?)
           then 
-            foreign_klass   = @klass.get_aggregate_klasses[table+'.'+attrib]
-            foreign_table   = foreign_klass.table_name
-            
-            form_element    = Klass_Select.new(foreign_klass, table, attrib, label)
-            form_element.set_mode(mode)
-            @form.add(form_element)
+            foreign_klass   = @klass.get_aggregate_klasses[full_attrib]
+            form_element    = Model_Select_Field.new(foreign_klass, :label => label, :name => field_name)
             
             # Attribute is explixit (expected/required) but not 
             # catched before -> Add attribute as hidden field: 
           elsif (!@klass.get_explicit_attributes[table].nil? and 
-                 @klass.get_explicit_attributes[table].include? attrib)
+                 @klass.get_explicit_attributes[table].include? attribute)
           then
-            form_element    = Hidden.new(table, attrib)
-            @form.add(form_element)
-            
+            form_element    = Hidden_Field.new(:name => field_name)
+
           elsif (!@klass.get_implicit_attributes[table].nil? and 
-                 @klass.get_implicit_attributes[table].include? attrib)
+                 @klass.get_implicit_attributes[table].include? attribute)
           then
-            @logger.debug(attrib+' is implicit')
-            
+            # Implicit field, ignored
           end
-          
+
+          @form.add(form_element) if form_element
         }
       }
-    end # }}}
+    end
     
-    # Returns instance of Cuba::GUI::Form configured 
-    # for klass passed in constructor: 
-    def generate() # {{{
-      return @form
-    end # }}}
-
   end # class
 
-  
 end # module
 end # module
-

data/lib/lore/gui/lore_model_select_field.rb

@@ -0,0 +1,59 @@
+
+require('aurita-gui/form/select_field')
+
+module Aurita
+module GUI
+
+  class Lore_Model_Select_Field < Select_Field
+
+    def initialize(model, params, &block)
+      @model        = model
+      @filter       = params[:filter]
+      @filter     ||= true
+      if block_given? then
+        @select_block = block
+      else
+        @select_block = Proc.new { |clause| clause.where(@filter) }
+      end
+      params.delete(:filter)
+      super(params)
+    end
+
+    def option_elements
+      elements = []
+      options  = []
+
+      foreign_table = @model.table_name
+      selectables = @model.select(&@select_block)
+      selectables.each { |foreign| 
+        foreign_label = ''
+        if @model.get_labels.nil? then
+          raise Aurita::GUI::Form_Error.new('Specify a label for has_a - related model klasses (here: ' << @model.to_s + ') via "use_label".')
+        end
+        @model.get_labels.each { |label_attrib|
+          foreign_label << foreign.get_attribute_values[foreign_table][label_attrib.split('.')[-1]].to_s << ' '
+        }
+
+        @model.get_primary_keys[foreign_table].uniq.each { |keys|
+          key_string = ''
+          keys.each { |key|
+            # concatenate combined primary keys like 'id--id2' -> '3--4'
+            if key_string != '' then key_string << '--' end
+            key_string << foreign.get_attribute_values[foreign_table][key]
+          }
+          options << { key_string => foreign_label }
+        }
+      }
+      
+      options.each { |map| 
+        map.each_pair { |k,v|
+          elements << HTML.option(:value => k) { v }
+        }
+      }
+      elements
+    end
+
+  end # class
+
+end
+end

data/lore.gemspec

@@ -16,12 +16,13 @@ spec = Gem::Specification.new { |s|
     high coverage of native SQL functions and features. 
     Lore is currently using PostgreSQL as database backend. 
   EOF
-  s.version = '0.4.7'
+  s.version = '0.4.8'
   s.author = 'Tobias Fuchs'
   s.email = 'fuchs@atomnode.net'
   s.date = Time.now
   s.files = '*.rb'
   s.add_dependency('postgres', '>= 0.1')
+  s.add_dependency('aurita-gui', '>= 0.1')
   s.files = FileList['*', 
                      'lib/*', 
                      'lib/lore/*', 
@@ -36,8 +37,8 @@ spec = Gem::Specification.new { |s|
 
   s.has_rdoc = true
   s.rdoc_options << '--title' << 'Lore ORM' <<
-                     '--main' << 'Lore::Model' <<
-                     '--line-numbers'
+                    '--main' << 'Lore::Model' <<
+                    '--line-numbers'
 
   s.homepage = 'http://lore.rubyforge.org'