imparcial 0.0.4 → 0.0.5

data/History.txt

@@ -1,5 +1,2 @@
-== 0.0.3 / 2007-09-16
-
-* 1 major enhancement
-  * Birthday!
-
+Tue Sep 18 02:48:45 BRT 2007  antoniolo@gmail.com
+  * initial import

data/Manifest.txt

@@ -1,5 +1,79 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-lib/imparcial.rb
+./Manifest.txt
+./Rakefile
+./History.txt
+./test/unit/base/expression/tc_select.rb
+./test/unit/base/expression/tc_table_diff.rb
+./test/unit/base/expression/tc_constraint.rb
+./test/unit/base/expression/tc_transaction.rb
+./test/unit/base/expression/tc_update.rb
+./test/unit/base/expression/tc_sequence.rb
+./test/unit/base/expression/tc_column.rb
+./test/unit/base/expression/tc_index.rb
+./test/unit/base/expression/tc_insert.rb
+./test/unit/base/expression/tc_table.rb
+./test/unit/base/expression/tc_delete.rb
+./test/unit/base/common/tc_quote.rb
+./test/unit/base/statement/tc_limit.rb
+./test/unit/base/statement/tc_conditions.rb
+./test/unit/base/statement/tc_order.rb
+./test/unit/helper.rb
+./test/unit/mysql/tc_sequence.rb
+./lib/imparcial/extension.rb
+./lib/imparcial/driver/abstract/expression/select.rb
+./lib/imparcial/driver/abstract/expression/record.rb
+./lib/imparcial/driver/abstract/expression/table.rb
+./lib/imparcial/driver/abstract/expression/transaction.rb
+./lib/imparcial/driver/abstract/expression/constraint.rb
+./lib/imparcial/driver/abstract/expression/delete.rb
+./lib/imparcial/driver/abstract/expression/sequence.rb
+./lib/imparcial/driver/abstract/expression/insert.rb
+./lib/imparcial/driver/abstract/expression/index.rb
+./lib/imparcial/driver/abstract/expression/column.rb
+./lib/imparcial/driver/abstract/expression/lock.rb
+./lib/imparcial/driver/abstract/expression/statement.rb
+./lib/imparcial/driver/abstract/expression/update.rb
+./lib/imparcial/driver/abstract/result.rb
+./lib/imparcial/driver/abstract/typemap.rb
+./lib/imparcial/driver/abstract/expression.rb
+./lib/imparcial/driver/abstract/util.rb
+./lib/imparcial/driver/abstract/sql/select.rb
+./lib/imparcial/driver/abstract/sql/record.rb
+./lib/imparcial/driver/abstract/sql/table.rb
+./lib/imparcial/driver/abstract/sql/transaction.rb
+./lib/imparcial/driver/abstract/sql/constraint.rb
+./lib/imparcial/driver/abstract/sql/delete.rb
+./lib/imparcial/driver/abstract/sql/sequence.rb
+./lib/imparcial/driver/abstract/sql/insert.rb
+./lib/imparcial/driver/abstract/sql/index.rb
+./lib/imparcial/driver/abstract/sql/column.rb
+./lib/imparcial/driver/abstract/sql/update.rb
+./lib/imparcial/driver/abstract/sql.rb
+./lib/imparcial/driver/abstract.rb
+./lib/imparcial/driver/postgre.rb
+./lib/imparcial/driver/mysql.rb
+./lib/imparcial/driver/mysql/expression/table.rb
+./lib/imparcial/driver/mysql/result.rb
+./lib/imparcial/driver/mysql/typemap.rb
+./lib/imparcial/driver/mysql/expression.rb
+./lib/imparcial/driver/mysql/util.rb
+./lib/imparcial/driver/mysql/sql/table.rb
+./lib/imparcial/driver/mysql/sql/constraint.rb
+./lib/imparcial/driver/mysql/sql/sequence.rb
+./lib/imparcial/driver/mysql/sql/index.rb
+./lib/imparcial/driver/mysql/sql/column.rb
+./lib/imparcial/driver/mysql/sql.rb
+./lib/imparcial/driver/postgre/result.rb
+./lib/imparcial/driver/postgre/typemap.rb
+./lib/imparcial/driver/postgre/expression.rb
+./lib/imparcial/driver/postgre/util.rb
+./lib/imparcial/driver/postgre/sql/table.rb
+./lib/imparcial/driver/postgre/sql/constraint.rb
+./lib/imparcial/driver/postgre/sql/sequence.rb
+./lib/imparcial/driver/postgre/sql/index.rb
+./lib/imparcial/driver/postgre/sql/column.rb
+./lib/imparcial/driver/postgre/sql.rb
+./lib/imparcial/driver.rb
+./lib/imparcial/initializer.rb
+./lib/imparcial/exception.rb
+./lib/imparcial.rb
+./README.txt

data/README.txt

@@ -1,26 +1,90 @@
-Imparcial-0.0.3
+Imparcial, Database Abstraction Layer
     by Guilherme Antoniolo Ferreira
-    url
 
 == DESCRIPTION:
   
-Database Abstraction Layer for Ruby
+  Imparcial is a Database Abstraction Layer for Ruby. It's designed not only to
+be a connection and result-set wrapping, one can also manipulate databases' 
+mechanisms with ruby structures as well as by using SQL syntaxes.
+Furthermore, Imparcial is primarly intented to be a library for developing
+ORMs, although one can use it in any application as long as that application
+needs an abstraction layer.
 
 == FEATURES/PROBLEMS:
   
-* none
+* API may change;
 
-== SYNOPSIS:
+== SUPPORTED DATABASES:
 
-  none
+* PostgreSQL
+* MySQL
+
+== USAGE:
+
+* Initializing the adapter:
+  adapter = Imparcial::Initializer.adapter(:mysql) do |config|
+
+    config.username = 'batman'
+    config.password = 'joker_suckz'
+    config.database = 'batcave'
+    config.logger   = Logger.new(STDERR)
+
+  end
+
+  adapter.connect
+  
+  And that's all. You may also specify :port, :host
+  
+* Getting Tables from a specific database:
+  abstract_adapter  
+  
+   adapter.get_tables # => ['person', 'invoice', 'product', 'supplier']
+   
+* Creating a Table
+  adapter.create_table :table_name => 'user', :fields => [{:name => :id, :type => :integer},
+  {:name => :name, :type => :string}]
+   
+  adapter.table_exists? :table_name => 'user' # => true
+   
+* Inserting Records
+  adapter.insert :table_name => 'user', :values => {:id => 1, :name => 'robin'}
+  adapter.insert :table_name => 'user', :values => {:id => 2, :name => 'penguim'}
+
+* Deleting Records
+  adapter.delete :table_name => 'user', :conditions => ['id = ?', 1]
+  
+* Selecting Records
+  adapter.select :table_name => 'user'
+  adapter.result.each do |id, name|
+    puts 'displaying info:'
+    puts "#{id.column_name} = #{id.column_value}"
+    puts "#{name.column_name} = "#{name.column_value}"
+  end  
+
+* Dropping a Table
+  adapter.drop_table :table_name => 'user'
+  
+Make sure to check the API for more features!
 
 == REQUIREMENTS:
 
 * facets
+* rake
+* hoe
 
 == INSTALL:
+Always get the lastest version!
+
+Firstly, install the adapter's specific driver.
+* gem install mysql
+
+Secondly, install the dependencies:
+* gem install facets
+* gem install rake
+* gem install hoe
 
-* sudo gem install imparcial
+Now, the lib:
+* gem install imparcial
 
 == LICENSE:
 

data/Rakefile

@@ -41,7 +41,7 @@ Hoe.new('imparcial', Imparcial::VERSION) do |s|
   s.author = 'Guilherme Antoniolo Ferreira'
   s.email  = 'antonio@gmail.com'
   
-  s.extra_deps << 'facets'
+  s.extra_deps << 'facets' << 'rake' << 'hoe'
   s.remote_rdoc_dir = ''
   s.changes = s.paragraphs_of('History.txt', 0..1).join("\n\n")
 

data/lib/imparcial/driver/abstract/expression/column.rb

@@ -0,0 +1,313 @@
+module Imparcial
+  module Driver
+    module AbstractExpression
+      module Column
+        
+        ###########################################
+        #                                         #
+        #             Column Dropping             #
+        #                                         #
+        ###########################################        
+      
+        private
+        
+        def expected_options_for_dropping_columns
+          
+          {:table_name => :required, :fields => :required}
+          
+        end
+
+        public
+        
+        # === Description
+        # Drop some columns.
+        #
+        # === Usage
+        # abstract_adapter.drop_columns :table_name => 'person', :fields => ['id','name']
+        #
+        # === Options
+        # * :table_name
+        # * :fields
+        #
+        # === Returning
+        # nothing        
+              
+        def drop_columns ( options = {} )
+          
+          check_options expected_options_for_dropping_columns, options
+          
+          sql = sql_for_dropping_columns( options )
+          
+          logger.warn sql if @column_logging
+          
+          query sql
+          
+        rescue adapter_specific_exception => ex
+   
+          raise ColumnDropError.new(ex.message)          
+          
+        end            
+
+        ###########################################
+        #                                         #
+        #             Column Creation             #
+        #                                         #
+        ###########################################        
+        
+        private
+
+        def expected_options_for_adding_columns
+          
+          {:table_name => :required, :fields => :required}
+          
+        end
+
+        public
+
+        # === Description
+        # Add some columns without dropping any table.
+        #
+        # === Usage
+        # abstract_adapter.add_columns :table_name => 'person', 
+        # :fields => [{:name => :age, :type => :integer]
+        #
+        # === Options
+        # * :table_name
+        # * :fields
+        #
+        # === Returning
+        # nothing 
+
+        def add_columns ( options = {} )
+  
+          check_options expected_options_for_adding_columns, options
+  
+          sql = sql_for_adding_columns( options )
+          
+          logger.warn sql if @column_logging
+          
+          query sql
+
+        rescue adapter_specific_exception => ex
+   
+          raise ColumnCreateError.new(ex.message)
+      
+        end             
+        
+        ###########################################
+        #                                         #
+        #            Column Listing               #
+        #                                         #
+        ###########################################
+        
+        private
+        
+        def expected_options_for_getting_columns_information
+          
+          {:table_name => :required}
+          
+        end        
+        
+        public
+    
+        # === Description
+        # Get name,type and size from every column in a given table.
+        #
+        # === Usage
+        # abstract_adapter.get_columns_information :table_name => 'person'
+        #
+        # === Options
+        # * :table_name
+        #
+        # === Returning
+        # an array with hashes.
+        # * :name
+        # * :type
+        # * :size
+    
+        def get_columns_information ( options = {} )
+
+          check_options expected_options_for_getting_columns_information, options
+
+          sql = sql_for_getting_columns_information( options )
+          
+          logger.warn sql if @column_logging          
+          
+          query sql
+            
+          fields = []
+
+          result.fetch do |name, type, size|
+
+            field = column_to_field :name => name.value, :type => type.value, :size => size.value
+        
+            fields << field
+          
+          end
+
+          fields
+          
+        rescue adapter_specific_exception => ex
+          
+          raise ColumnListError.new(ex.message)
+
+        end  
+        
+        private
+        
+        def expected_options_for_getting_column_information
+          
+          {:table_name => :required, :field_name => :required}
+          
+        end
+        
+        public
+        
+        # === Description
+        # Get name,type and size from a column in a given table.
+        # See :get_columns_information
+        
+        def get_column_information ( options = {} )
+          
+          check_options expected_options_for_getting_column_information, options
+          
+          sql = sql_for_getting_column_information options
+          
+          logger.warn sql if @column_logging
+          
+          query sql
+          
+          name, type, size = result.fetch_first_row
+          
+          column_to_field :name => name.value, :type => type.value, :size => size.value
+          
+        end
+        
+        ###########################################
+        #                                         #
+        #             Column Renaming             #
+        #                                         #
+        ###########################################          
+        
+        private
+        
+        def expected_options_for_renaming_column
+          
+          {:table_name => :required, :field => :required}
+          
+        end
+
+        public
+        
+        # === Description
+        # Rename a column.
+        #
+        # === Usage
+        # abstract_adapter.rename_column :table_name => 'person', :field => {:id => :super_id}
+        #
+        # === Options
+        # * :table_name
+        # * :fields
+        #
+        # === Returning
+        # nothing         
+              
+        def rename_column ( options = {} )
+          
+          check_options expected_options_for_renaming_column, options
+          
+          sql = sql_for_renaming_column( options )
+          
+          logger.warn sql if @column_logging
+          
+          query sql
+          
+        rescue adapter_specific_exception => ex
+   
+          raise ColumnRenameError.new(ex.message)          
+          
+        end  
+                
+        private
+        
+        def expected_options_for_renaming_columns
+          
+          {:table_name => :required, :fields => :required}
+          
+        end
+
+        public
+        
+        # === Description
+        # Rename a bunch of columns. See :rename_column for further info.
+              
+        def rename_columns ( options = {} )
+          
+          check_options expected_options_for_renaming_columns, options
+          
+          options[:fields].each do |old_field,new_field|
+            
+            sql = sql_for_renaming_column( :table_name => options[:table_name], :field => {old_field => new_field})
+
+            logger.warn sql if @column_logging
+            
+            query sql
+            
+          end
+          
+        rescue adapter_specific_exception => ex
+   
+          raise ColumnRenameError.new(ex.message)          
+          
+        end  
+        
+        ###########################################
+        #                                         #
+        #          Column Modification            #
+        #                                         #
+        ###########################################          
+             
+        private
+        
+        def expected_options_for_modifying_columns
+          
+          {:table_name => :required, :fields => :required}
+          
+        end
+
+        public
+        
+        # === Description
+        # Modify column type and size if needed.
+        #
+        # === Usage
+        # abstract_adapter.modify_columns :table_name => 'person', 
+        # :fields => [{:name => :id, :type => :float}]
+        #
+        # === Options
+        # * :table_name
+        # * :fields
+        #
+        # === Returning
+        # nothing         
+        
+        def modify_columns ( options = {} )
+          
+          check_options expected_options_for_modifying_columns, options
+          
+          sql = sql_for_modifying_columns( options )
+          
+          logger.warn sql if @column_logging
+          
+          query sql
+          
+        rescue adapter_specific_exception => ex
+        
+          raise ColumnUpdateError.new(ex.message)
+          
+        end                        
+        
+      end
+    end
+  end
+end

data/lib/imparcial/driver/abstract/expression/constraint.rb

@@ -0,0 +1,149 @@
+module Imparcial
+  module Driver
+    module AbstractExpression
+      module Constraint
+        
+        ###########################################
+        #                                         #
+        #               Primary Key               #
+        #                                         #
+        ###########################################             
+        
+        private
+        
+        def expected_options_for_adding_primary_key
+          
+          {:table_name => :required, :fields => :required}
+          
+        end
+        
+        public
+      
+        # === Description
+        # Make a bunch of fields primary key.
+        #
+        # === Usage
+        # abstract_adapter.primary_key :table_name => 'person', 
+        # :fields => ['id','name']
+        #
+        # === Options
+        # * :table_name
+        # * :fields
+        #
+        # === Returning
+        # nothing        
+      
+        def add_primary_key ( options = {} )
+          
+          check_options expected_options_for_adding_primary_key, options
+
+          sql = sql_for_adding_primary_key( options )
+          
+          logger.warn sql if @column_logging
+          
+          query sql
+          
+        rescue adapter_specific_exception => ex
+        
+          raise ColumnConstraintError.new(ex.message)
+          
+        end
+        
+        ###########################################
+        #                                         #
+        #               Auto Increment            #
+        #                                         #
+        ###########################################         
+        
+        private
+        
+        def expected_options_for_adding_auto_increment
+          
+          {:table_name => :required, :field => :required}
+          
+        end
+        
+        public
+        
+        # === Description
+        # Make a bunch of fields auto increment.
+        #
+        # === Usage
+        # abstract_adapter.add_auto_increment :table_name => 'person', 
+        # :fields => ['id','name']
+        #
+        # === Options
+        # * :table_name
+        # * :fields
+        #
+        # === Returning
+        # nothing            
+        
+        def add_auto_increment ( options = {} )
+          
+          check_options expected_options_for_adding_auto_increment, options
+
+          add_primary_key :table_name => options[:table_name], :fields => [options[:field]]
+          sql = sql_for_adding_auto_increment( options )          
+          
+          logger.warn sql if @column_logging
+          
+          query sql
+          
+        rescue adapter_specific_exception => ex
+        
+          raise ColumnConstraintError.new(ex.message)
+          
+        end          
+        
+        ###########################################
+        #                                         #
+        #               Default Value             #
+        #                                         #
+        ###########################################         
+        
+        private
+        
+        def expected_options_for_adding_default_value
+          
+          {:table_name => :required, :fields => :required}
+          
+        end
+        
+        public
+        
+        # === Description
+        # Add default value for some fields.
+        #
+        # === Usage
+        # abstract_adapter.add_default_value :table_name => 'person', 
+        # :fields => {:id => 1, :name => 'jota'}
+        #
+        # === Options
+        # * :table_name
+        # * :fields
+        #
+        # === Returning
+        # nothing            
+        
+        def add_default_value ( options = {} )
+          
+          check_options expected_options_for_adding_default_value, options
+
+          sql = sql_for_adding_default_value( options ) 
+          
+          logger.warn sql if @column_logging
+          
+          query sql
+          
+        rescue adapter_specific_exception => ex
+        
+          raise ColumnConstraintError.new(ex.message)
+          
+        end
+        
+      end
+    end
+  end
+end
+