lib/mass_insert/base.rb in mass_insert-0.0.2 vs lib/mass_insert/base.rb in mass_insert-0.0.3

@@ -1,10 +1,13 @@
 module MassInsert
   module Base
 
-    # This method do a mass database insertion. Example...
+    # = MassInsert
     #
+    # This method does a mass database insertion just calling it from your
+    # ActiveRecord model. Example...
+    #
     #   User.mass_insert(values)
     #
     # The values should be an array with the object values in a hash.
     # Example...
     #
@@ -12,25 +15,56 @@
     #     {:name   => "user name", :email  => "user email"},
     #     {:name   => "user name", :email  => "user email"},
     #     {:name   => "user name", :email  => "user email"}
     #   ]
     #
+    # == Options
+    #
+    # And MassInset gem allow you to send it some options as second param
+    # Example...
+    #
+    #   User.mass_insert(values, options)
+    #
+    # === table_name
+    #
+    # Default value is the table name to your model. This options rarely
+    # needs to change but you can do it if you pass a string with the table
+    # name. Example...
+    #
+    #   options = {:table_name => "users"}
+    #
+    # === primary_key
+    #
+    # Default value is :id. You can change the name of primary key column
+    # send it a symbol with the column name.
+    #
+    #   options = {:primary_key => :post_id}
+    #
+    # === primary_key_mode
+    #
+    # Default value is :auto. When is :auto MassInsert knows that database
+    # will generate the value of the primary key column automatically. If
+    # you pass :manual as primary key mode you need to create your value
+    # hashes with the key and value of the primary key column.
+    #
+    #   options = {:primary_key_mode => :manual}
+    #
     # When a class that inherit from ActiveRecord::Base calls this method
     # is going to extend the methods in ClassMethods module. This module
     # contains some methods that provides some necessary functionality.
     #
     # After extends the class with methods in ClassMethods module. The
     # options that were passed by params are sanitized in the method
-    # called mass_insert_options_sanitized to be passed by params to
-    # do ProcessControl instance. The values are passed too.
+    # called mass_insert_options to be passed by params to ProcessControl
+    # class. The record values are passed too.
     def mass_insert values, args = {}
       class_eval do
         extend ClassMethods
       end
 
       options = mass_insert_options(args)
-      @mass_insert_process = MassInsert::ProcessControl.new(values, options)
+      @mass_insert_process = ProcessControl.new(values, options)
       @mass_insert_process.start
     end
 
 
     module ClassMethods
@@ -41,25 +75,20 @@
       def mass_insert_results
         @mass_insert_process.results if @mass_insert_process
       end
 
       private
-
-        def mass_insert_options args = {}
-          # prepare default options that come in the class that invokes the
-          # mass_insert function.
-          args[:class_name] ||= self
-          args[:table_name] ||= self.table_name
-
-          # prepare attributes options that were configured by the user and
-          # if the options weren't passed, they would be initialized with the
-          # default values.
-          args[:primary_key]      ||= :id
-          args[:primary_key_mode] ||= :auto
-
-          # Returns the arguments but sanitized and ready to be used. This
-          # args will be passed by params to ProcessControl class.
-          args
+        # Sanitizes the MassInset options that were passed by params.
+        # Prepares default options that come in the class that invokes the
+        # mass_insert function and attributes options that were configured
+        # and if the options weren't passed, they would be initialized with
+        # the default values.
+        def mass_insert_options options = {}
+          options[:class_name]        ||= self
+          options[:table_name]        ||= self.table_name
+          options[:primary_key]       ||= :id
+          options[:primary_key_mode]  ||= :auto
+          options
         end
 
     end
   end
 end