imparcial 0.0.1 → 0.0.2

data/lib/imparcial/driver/{base → abstract}/expression/base.rb

@@ -1,11 +1,16 @@
 module Imparcial
   module Driver
-    module ExpressionBase
+    module AbstractExpression
       module Base
         
-        private
-                
-        # Basically it validates every user's entered option.
+        public
+        
+        # In order to make things easier to develop, we've adopted hashes
+        # as parameter. Furthermore, single parameters, like drop_table,
+        # must be in hashes too.
+        # By doing that, we can provide as many features as we want without
+        # blowing up the interface.
+        # Also, we can use this following method to apply some validations.
  
         def check_options ( expected_options , user_options )
 
@@ -98,6 +103,8 @@ module Imparcial
               
         end        
       
+        module_function :check_options
+      
       end
     end
   end

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
+        

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

@@ -0,0 +1,88 @@
+module Imparcial
+  module Driver
+    module AbstractExpression
+      module Delete
+   
+        private
+        
+        def expected_options_for_deleting
+          
+          {:table_name => :required, :conditions => :required}
+          
+        end
+                   
+        public
+        
+        # === Description
+        # Delete some records. Besides, this function demands deleting
+        # with some conditions.
+        #
+        # === Usage
+        # abstract_adapter.delete :table_name => 'person', :conditions =>
+        # ['id = ?',1]
+        #
+        # === Options
+        # * :table_name
+        # * :conditions
+        #
+        # === Returning
+        # nothing        
+   
+        def delete ( options = {} )
+                  
+          check_options expected_options_for_deleting, options        
+                  
+          sql = sql_for_deleting( options )
+          
+          logger.warn sql if @delete_logging
+          
+          query sql
+          
+        rescue adapter_specific_exception => ex
+        
+          raise DeleteError.new(ex.message)                       
+      
+        end
+        
+        private
+        
+        def expected_options_for_deleting_all
+          
+          {:table_name => :required}
+          
+        end        
+        
+        public
+        
+        # === Description
+        # Delete some records. Besides, this function demands no conditions.
+        #
+        # === Usage
+        # abstract_adapter.delete_all :table_name => 'person'
+        #
+        # === Options
+        # * :table_name
+        #
+        # === Returning
+        # nothing         
+    
+        def delete_all ( options = {} )
+      
+          check_options expected_options_for_deleting_all, options
+               
+          sql = sql_for_deleting( options )
+          
+          logger.warn sql if @delete_logging
+          
+          query sql 
+          
+        rescue adapter_specific_exception => ex
+        
+          raise DeleteError.new(ex.message)
+ 
+        end
+                        
+      end 
+    end
+  end
+end