lore 0.4.2

data/gui/form_generator.rb

@@ -0,0 +1,151 @@
+
+require('lore/types')
+require('lore/gui/form')
+
+module Lore
+module GUI
+
+  # Usage: 
+  # 
+  #   generator = Form_Generator.new(Table_Accessor, Lang, :readonly | :mutable)
+  #   form = generator.generate
+  # 
+  # See documentation of Cuba::GUI::Form for usage of form instances. 
+  #
+  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
+
+      Textarea.reset_counter
+
+      @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| 
+
+      # handle attributes passed via attrib_setup: 
+        
+        attributes.each { |attrib|
+
+          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
+          
+          # @custom_elements is a hash mapping attribute names to
+          # Custom_Element instances. 
+          if ((@custom_elements[table]) and
+              (@custom_elements[table][attrib])) then
+            
+            form_element = @custom_elements[table][attrib].new(table, attrib, label)
+            form_element.mode = mode
+            @form.add(form_element)
+            
+          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)
+          then
+            
+            case @klass.get_attribute_types[table][attrib]
+              
+            when Lore::PG_BOOL
+              form_element = Radio.new(table, attrib, label, ['t','f'])
+              
+            when Lore::PG_SMALLINT || Lore::PG_INT
+              form_element = Text.new(table, attrib, label, nil)
+              
+            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
+              
+            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
+              
+            when Lore::PG_TIMESTAMP_TIMEZONE
+              form_element = Date.new(table, attrib, label, nil)
+              
+            when Lore::PG_DATE
+              form_element = Date.new(table, attrib, label, nil)
+              
+            else
+              form_element = Text.new(table, attrib, label, nil)
+            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?)
+          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)
+            
+          elsif (!@klass.get_aggregate_klasses.nil? and
+                 !@klass.get_aggregate_klasses[table+'.'+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)
+            
+            # 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)
+          then
+            form_element    = Hidden.new(table, attrib)
+            @form.add(form_element)
+            
+          elsif (!@klass.get_implicit_attributes[table].nil? and 
+                 @klass.get_implicit_attributes[table].include? attrib)
+          then
+            @logger.debug(attrib+' is implicit')
+            
+          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/gui/templates/button.rhtml

@@ -0,0 +1,2 @@
+
+<input <%= tag_attributes(attributes) %> />

data/gui/templates/checkbox.rhtml

@@ -0,0 +1,3 @@
+
+<%= label %>
+<input type="checkbox" <%= tag_attributes(attributes) %> />

data/gui/templates/checkbox_row.rhtml

@@ -0,0 +1 @@
+<div class="lore_checkbox_row"><%= checkboxes %></div>

data/gui/templates/file.rhtml

@@ -0,0 +1,2 @@
+
+<input class="lore_file" type="file" <%= tag_attributes(attributes) %> />

data/gui/templates/file_readonly.rhtml

@@ -0,0 +1,3 @@
+<div class="lore_readonly_wrap" <%= tag_attributes(attributes) %> >
+  <%= attributes[:value] %>
+</div>

data/gui/templates/form_element.rhtml

@@ -0,0 +1,5 @@
+	    <li class="form_attribute_row" id="<%= element_obj.attribute_id %>_wrap">
+        <%= label %>
+        <%= element %>
+        <div id="<%= element_obj.attribute_id %>_message" style="display: none" class="lore_form_element_message" ></div>
+      </li>

data/gui/templates/form_element_horizontal.rhtml

@@ -0,0 +1,3 @@
+        <td height="20" valign="top" class="lore_form_element_horizontal">
+            <%= element %>
+        </td>

data/gui/templates/form_element_listed.rhtml

@@ -0,0 +1,8 @@
+<tr align="left" valign="middle">
+	<td valign="top" class="lore_form_element_listed left">
+      <b><%= label %></b>
+	</td>
+  <td valign="top" class="lore_form_element_listed right">
+    <%= element %>
+  </td>
+</tr>

data/gui/templates/form_table.rhtml

@@ -0,0 +1,3 @@
+<ul class="form_elements">
+	  <%= form %>
+</ul>

data/gui/templates/form_table_blank.rhtml

@@ -0,0 +1,3 @@
+
+	  <%= form %>
+

data/gui/templates/form_table_horizontal.rhtml

@@ -0,0 +1,8 @@
+
+<div class="form_table">
+	<table border="0" cellspacing="0" cellpadding="0">
+	<tr>
+	  <%= form %>
+ 	</tr>
+  	</table>
+</div>

data/gui/templates/password.rhtml

@@ -0,0 +1,2 @@
+
+<input type="password" <%= tag_attributes(attributes) %> />

data/gui/templates/password_readonly.rhtml

@@ -0,0 +1,3 @@
+<div class="lore_readonly_wrap" <%= tag_attributes(attributes) %> >
+  *********
+</div>

data/gui/templates/radio.rhtml

@@ -0,0 +1 @@
+<nobr><font style="width: 120px; "><input type="radio" <%= tag_attributes(attributes) %> /> <%= attributes[:label] %> </font></nobr>

data/gui/templates/radio_row.rhtml

@@ -0,0 +1 @@
+<div class="lore_radio_row"><%= radios %></div>

data/gui/templates/select.rhtml

@@ -0,0 +1,23 @@
+<div class="lore_select_wrap">
+<select <%= tag_attributes(attributes) %> >
+<%=
+  option_index = 0
+  options = "\n"
+  
+  range.each { |attrib|
+    attrib = attrib.to_s
+    
+    if value.to_s == attrib.to_s then 
+      selected = 'selected' 
+    else selected = '' end
+    
+    options += '<option value="'+attrib.to_s+'" '+selected+' >'
+    options += labels[option_index].to_s
+    options += '</options>'
+    
+    option_index += 1
+  }
+  options
+%>
+</select>
+</div>

data/gui/templates/text.rhtml

@@ -0,0 +1,2 @@
+
+<input type="text" <%= tag_attributes(attributes) %> />

data/gui/templates/text_readonly.rhtml

@@ -0,0 +1,3 @@
+<div class="lore_readonly_wrap" <%= tag_attributes(attributes) %> >
+  <%= attributes[:value] %>
+</div>

data/gui/templates/textarea.rhtml

@@ -0,0 +1,3 @@
+<div class="lore_textarea_wrap">
+<textarea <%= tag_attributes(attributes) %> ><%= value %></textarea>
+</div>

data/gui/templates/textarea_readonly.rhtml

@@ -0,0 +1,4 @@
+
+<div class="textarea_lore_readonly">
+  <%= value.gsub('</p>', "\n\n").gsub('<br />',"\n").gsub(/<[^>]+>/,'')[0..1000].gsub("\n", '<br />') %>
+</div>

data/lore.gemspec

@@ -0,0 +1,40 @@
+
+require 'rake'
+
+spec = Gem::Specification.new { |s|
+
+  s.name = 'lore' 
+  s.rubyforge_project = 'lore'
+  s.summary = 'A flexible ORM based on PostgreSQL'
+  s.description = <<-EOF
+    Lore is an object-relational mapping (ORM) implementation 
+    providing many features like prepared statements, 
+    (multiple) inheritance, a comfortable query syntax, 
+    highly customizable automated form generation, 
+    and result caching using memory mapping (MMap). 
+    Lore is currently using PostgreSQL as database backend. 
+  EOF
+  s.version = '0.4.2'
+  s.author = 'Tobias Fuchs'
+  s.email = 'fuchs@atomnode.net'
+  s.date = Time.now
+  s.files = '*.rb'
+  s.add_dependency('mmap', '>= 0.1')
+  s.add_dependency('postgres', '>= 0.1')
+  s.files = FileList['*', 
+                        'behaviours/*', 
+                        'test/*', 
+                        'cache/*', 
+                        'validation/*', 
+                        'gui/*', 
+                        'gui/templates/*', 
+                        'exception/*'].to_a
+
+  s.has_rdoc = true
+  s.rdoc_options << '--title' << 'Lore ORM' <<
+                       '--main' << 'README' <<
+                       '--line-numbers'
+
+  s.homepage = 'http://lore.rubyforge.org'
+
+}

data/lore.rb

@@ -0,0 +1,94 @@
+
+require('logger')
+
+module Lore
+
+  @logfile = '/var/log/lore/query.log'
+  def self.logfile
+    @logfile
+  end
+  def self.logfile=(file)
+    @logger = Logger.new(file)
+  end
+  def self.logger
+    @logger
+  end
+  @logger = Logger.new(Lore.logfile)
+
+  def self.log(&log_block)
+    return if Lore.logging_disabled?  
+    Lore.logger.debug(&log_block)
+  end
+
+  def self.log_queries? 
+    true
+  end
+  def self.logging_disabled? 
+    false
+  end
+
+  @cache_entities = false
+
+  @logins = { 
+  }
+
+  def self.set_login_data(login_hash)
+    @logins = login_hash
+  end
+  def self.add_login_data(login_hash)
+    @logins.update(login_hash)
+  end
+
+  def self.path
+    File.expand_path(File.dirname(__FILE__)) + '/'
+  end
+
+  @pg_server = 'localhost'
+  @pg_port = 5432
+
+  def self.pg_server
+    @pg_server
+  end
+  def self.pg_port
+    @pg_port
+  end
+  def self.pg_server=(s)
+    @pg_server = s
+  end
+  def self.pg_port=(p)
+    @pg_port = p
+  end
+
+  def self.user_for(dbname)
+    begin
+      @logins[dbname.to_s][0].to_s
+    rescue ::Exception => excep
+      raise ::Exception.new('Unable to resolve user for database ' << dbname.inspect)
+    end
+  end
+  def self.pass_for(dbname)
+    @logins[dbname.to_s][1].to_s
+  end
+
+  def self.disable_cache
+    @cache_entities = false
+  end
+
+  def self.enable_cache
+    @cache_entities = true
+  end
+
+  def self.cache_enabled? 
+    @cache_entities
+  end
+
+  def self.on_connect_commands()
+    "set client_encoding to Unicode; set datestyle to 'European'"
+  end
+
+end
+
+require('lore/validation/parameter_validator')
+require('lore/exception/invalid_parameter')
+require('lore/exception/invalid_klass_parameters')
+require('lore/connection')

data/migration.rb

@@ -0,0 +1,48 @@
+
+module Lore
+
+
+  # Usage: 
+  # 
+  # Using auto-bootstrap of models: 
+  #
+  #   class My_Model < Lore::Model
+  #   extend Lore::Migration
+  # 
+  #     table :my_model, :public
+  #     primary_key :key_a, :key_a_seq
+  #     primary_key :key_b
+  #
+  #     has_attributes { 
+  #       :foo, Lore::Type.integer, { :unique => true, :default => 1 } 
+  #       :bar, Lore::Type.integer, { :not_null => true, :check => 'bar < 1000' }
+  #     }
+  #
+  #     def self.up
+  #       bootstrap()
+  #       My_Model.create(:foo => 23, :bar => 123)
+  #     end
+  #
+  #   end
+  #
+  module Migration
+
+    def has_attributes(attrib_hash)
+      @model_schema = attrib_hash
+    end
+
+    def update_schema
+      @factory = Model_Factory.new(self.class.to_s)
+      @model_schema.each_pair { |attrib_name, attrib_props|
+        @factory.add_attribute(attrib_name.to_s, attrib_props)
+      }
+    end
+
+    def bootstrap
+      @factory.build_table
+    end
+
+  end
+
+end
+

data/model.rb

@@ -0,0 +1,139 @@
+
+require('logger')
+
+require('lore/aspect');
+require('lore/table_selector');
+require('lore/table_inserter');
+require('lore/table_updater');
+require('lore/table_deleter');
+require('lore/table_instance');
+require('lore/query_shortcuts');
+require('lore/validation');
+require('lore/migration');
+require('lore/validation/parameter_validator');
+require('lore/exception/invalid_parameter');
+require('lore/exception/invalid_klass_parameters');
+require('lore/cache/cacheable');
+require('lore/table_accessor.rb')
+
+module Lore
+
+  # For API details see Lore::Table_Accessor
+  #
+  #
+  # =How to define models
+  #
+  # Example: 
+  #
+  #   require 'lore/model'
+  #
+  #   class Vehicle < Lore::Model
+  #   end
+  #
+  #   class Car < Vehicle
+  #   end
+  #
+  # Sets following defaults: 
+  #  
+  #   class Vehicle
+  #     table :vehicle, :vehicle_id
+  #     primary_key :id              # or :vehicle_id if :id is not present
+  #   end
+  #
+  #   class Car < Vehicle
+  #     table :car, :public
+  #     primary_key :id              # or :car_id if :id is not present
+  #     is_a Vehicle, :vehicle_id 
+  #   end
+  #
+  # = How to use models
+  # 
+  # == Creating entities (INSERTs)
+  #   
+  #   manuf_1 = Manufacturer.create(:name => 'Audi')
+  #   manuf_2 = Manufacturer.create(:name => 'BMW')
+  #   car     = Car.create(:manufacturer => manuf, :name => 'TT')
+  #
+  # == Changing entities (UPDATEs)
+  #
+  #   car['name'] = 'BMW318i'
+  #   car.manufacturer = manuf_2  # same as car[:manufacturer_id] = manuf_2.manufacturer_id
+  #   car.commit
+  #
+  # == Deleting entities (DELETEs)
+  #
+  #   car.delete!
+  # is the same as
+  #   Car.delete.where(Car.car_id == car.car_id).perform
+  # is the same as
+  #   Lore.perform Car.delete.where(Car.car_id == car.car_id) 
+  # is the same as
+  #   Car.delete { |c|
+  #     c.where(c.car_id = car.car_id)
+  #   }
+  #
+  # =How to disable/enable features
+  #
+  # Lore::Model extends 
+  # * Lore::Cache::Cacheable
+  # * Lore::Query_Shortcuts
+  # * Lore::Validation
+  # * Lore::Aspect
+  # 
+  # Each of them is optional. If you want, for example, a minimalistic 
+  # version of Lore::Model with comfortable query interfaces you can define 
+  # your own Model class that extends the Lore::Query_Shortcuts module only: 
+  #
+  #   class Slim_Model < Lore::Table_Accessor
+  #     extend Lore::Query_Shortcuts
+  #   end
+  #
+  # You can use it as base class for other Model classes, too: 
+  #
+  #   class Cache_Model < Slim_Model
+  #     extend Lore::Query_Shortcuts
+  #     extend Lore::Cacheable
+  #   end
+  #
+  # You also can define this differently for every model by deriving them
+  # from Lore::Table_Accessor and extending every single one of them: 
+  #
+  #   class User < Lore::Table_Accessor
+  #   extend Lore::Query_Shortcuts
+  #   extend Lore::Aspect
+  #   extend Lore::Validation
+  #     
+  #     table :user, :public
+  #     primary_key :user_id
+  #     
+  #   end
+  #
+  # =How to use Lore::Model in a Rails app
+  #
+  # By default, Lore::Model doesn't extend Rails interface bridges. You 
+  # either can define your own Model base class (see: How to disable/enable 
+  # features) and extend it by Lore::Rails::Model
+  #
+  #   class My_Model < Lore::Model
+  #     extend Lore::Rails::Model
+  #   end
+  #
+  # ... or extend Lore::Model directly: 
+  #
+  #   Lore::Model.extend Lore::Rails_Bridge
+  #
+  # In this case, every Model in your app will include Rails interfaces. 
+  #
+  class Model < Table_Accessor
+    extend Lore::Cache::Cacheable
+    extend Lore::Query_Shortcuts
+    extend Lore::Validation
+    extend Lore::Aspect
+    extend Lore::Migration
+
+    def by_id(pkey_id)
+      _by_id(pkey_id).first # Auto-defined in Lore::Table_Accessor.primary_key
+    end
+  end
+
+end