mass_insert 0.0.1 → 0.0.2

data/README.md

@@ -41,10 +41,61 @@ The array of values:
       }
     ]
 
-And call mass_insert method:
+And call mass_insert method from your model:
 
     User.mass_insert(values)
 
+
+## Results
+
+Sometimes after MassInsert process you need to see some necessary information about the process. MassInsert gem provides a simple way to do it. Only call the next methods from your model after MassInsert execution.
+
+    User.mass_insert_results.records                    # => 120000
+
+Some result options are...
+
+1. `records` : Returns the amount of records that were persisted.
+2. `time` : Returns the time that took to do all the MassInsert process.
+3. `build_time` : Returns the time that took to create the query string that was persisted.
+4. `execute_time` : Returns the time that took to execute the query string that was persisted.
+
+
+## Options
+
+MassInsert accepts options hash by second param when you call `mass_insert` from your model. This options allow you to configure the way that the records will be created. Example...
+
+    options = {
+      :primary_key => :user_id,
+      :primary_key_mode => :manual
+    }
+
+    User.mass_insert(values, options)
+
+OR directly
+
+    User.mass_insert(values, :primary_key => :user_id, :primary_key_mode => :manual)
+
+Some options that you can include are...
+
+1. `: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"}
+
+2. `: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}
+
+3. `:primary_key_mode` : Default value is `:auto`. When is `:auto` MassInsert knows that the 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}
+
+
+## Advantages
+
+Faster. It's depending of the computer but these are some results...
+
+* PostgreSQL - Saving 10,000 records in 0.84s
+
 ## Attention
 
 Since this is a single database insertion your model validation will be ignored, then if you use this gem you need to be sure that information is OK to be persisted.

data/Rakefile

@@ -4,8 +4,6 @@ namespace :spec do
   desc "Prepares the environment to use the gem"
   task :prepare do
     system("
-      bundle install
-      cd spec/active_record_dummy/
       bundle install
       rake db:drop db:create db:migrate RAILS_ENV=mysql2
       rake db:drop db:create db:migrate RAILS_ENV=postgresql

data/lib/mass_insert/adapters/mysql2_adapter.rb

@@ -5,7 +5,7 @@ module MassInsert
       # This method is overwrite because the timestamp format to this
       # database engine does not need precision in nanoseconds.
       def timestamp_format
-        "%Y-%m-%d %H:%M:%S"
+        @timestamp_format ||= "%Y-%m-%d %H:%M:%S"
       end
 
       # This functions calls the necessary functions to create a complete

data/lib/mass_insert/base.rb

@@ -5,8 +5,8 @@ module MassInsert
     #
     #   User.mass_insert(values)
     #
-    # The values should be an array with the object values
-    # in a hash. Example...
+    # The values should be an array with the object values in a hash.
+    # Example...
     #
     #   values = [
     #     {:name   => "user name", :email  => "user email"},
@@ -14,30 +14,53 @@ module MassInsert
     #     {:name   => "user name", :email  => "user email"}
     #   ]
     #
+    # 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.
     def mass_insert values, args = {}
+      class_eval do
+        extend ClassMethods
+      end
+
       options = mass_insert_options(args)
-      process = MassInsert::ProcessControl.new(values, options)
-      process.execute
+      @mass_insert_process = MassInsert::ProcessControl.new(values, options)
+      @mass_insert_process.start
     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
+    module ClassMethods
+      # Returns an OpenStruc instance where is possible to see the
+      # results of MassInsert process. This method calls results method
+      # in ProcessControl class. Returns nil if there is not a instance
+      # variable with the MassInset process.
+      def mass_insert_results
+        @mass_insert_process.results if @mass_insert_process
+      end
+
+      private
 
-        # 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
+        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
 
-        # Returns the arguments but sanitized and ready to be used. This
-        # args will be passed by params to ProcessControl class.
-        args
-      end
+          # 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
+        end
+
+    end
   end
 end

data/lib/mass_insert/process_control.rb

@@ -1,3 +1,6 @@
+require 'benchmark'
+require 'ostruct'
+
 module MassInsert
   class ProcessControl
 
@@ -9,15 +12,36 @@ module MassInsert
     end
 
     # This method is responsible to call all the necessary process to
-    # complete the mass insertion process.
-    def execute
-      QueryExecution.new(query).execute
+    # complete the mass insertion process and save the time each method
+    # takes being executed.
+    def start
+      # Calls the method that build the query.
+      @build_time   = Benchmark.measure{ build_query }
+      # Calls the method that execute the query.
+      @execute_time = Benchmark.measure{ execute_query }
     end
 
     # Returns the correct query string  according to database adapter
     # previosly configured usually in database.yml in Rails project.
-    def query
-      QueryBuilder.new(values, options).build
+    def build_query
+      @query = QueryBuilder.new(values, options).build
+    end
+
+    # This method does a QueryExecution instance where the query will be
+    # execute. The query string is the instance variable @query.
+    def execute_query
+      QueryExecution.new(@query).execute if @query
+    end
+
+    # Provides an OpenStruc instance to see the process results. This
+    # method is usually called from mass_insert_results in Base module.
+    def results
+      result = OpenStruct.new
+      result.time         = @build_time.total + @execute_time.total
+      result.records      = values.count
+      result.build_time   = @build_time.total
+      result.execute_time = @execute_time.total
+      result
     end
 
   end

data/lib/mass_insert/version.rb

@@ -1,3 +1,3 @@
 module MassInsert
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/active_record_dummy/config/database.yml

@@ -12,7 +12,7 @@ mysql2:
   adapter: mysql2
   database: mysql2_test
   user: root
-  password: D3s4rr0ll0$.
+  password: D3s4rr0ll0
   pool: 5
   timeout: 5000
   encoding: utf8

data/spec/active_record_models/model_spec.rb

@@ -23,10 +23,10 @@ describe "Model" do
       User.count.should eq(5)
     end
 
-    it "should save if values cointains 1500 records" do
-      1500.times{ @values << @value_hash }
+    it "should save if values cointains 1200 records" do
+      1200.times{ @values << @value_hash }
       User.mass_insert(@values, @options)
-      User.count.should eq(1500)
+      User.count.should eq(1200)
     end
   end
 

data/spec/mass_insert/base_spec.rb

@@ -6,7 +6,7 @@ describe MassInsert::Base do
   describe "class methods" do
     describe ".mass_insert" do
       before :each do
-        MassInsert::ProcessControl.any_instance.stub(:execute => true)
+        MassInsert::ProcessControl.any_instance.stub(:start => true)
       end
 
       it "should respond to mass_insert class method" do
@@ -30,7 +30,7 @@ describe MassInsert::Base do
 
       it "should call execute ProcessControl method" do
         process = MassInsert::ProcessControl.any_instance
-        process.should_receive(:execute).exactly(1).times
+        process.should_receive(:start).exactly(1).times
         Test.mass_insert([], {})
       end
 
@@ -41,6 +41,22 @@ describe MassInsert::Base do
       end
     end
 
+    describe ".mass_insert_results" do
+      it "should respond to mass_insert_results class method" do
+        Test.respond_to?(:mass_insert_results).should be_true
+      end
+
+      context "when mass_insert_process instance variable exists" do
+        it "should call results method in ProcessControl class" do
+          process = MassInsert::ProcessControl
+          process.any_instance.stub(:results).and_return(true)
+          process.any_instance.should_receive(:results).exactly(1).times
+          Test.mass_insert([], {})
+          Test.mass_insert_results
+        end
+      end
+    end
+
     describe ".mass_insert_options" do
       describe "class_name" do
         it "returns class name that call if that option doesn't exist" do

data/spec/mass_insert/process_control_spec.rb

@@ -27,30 +27,106 @@ describe MassInsert::ProcessControl do
       end
     end
 
-    describe "#execute" do
-      it "should respond to execute method" do
-        subject.respond_to?(:execute).should be_true
+    describe "#start" do
+      before :each do
+        subject.stub(:build_query).and_return(true)
+        subject.stub(:execute_query).and_return(true)
+      end
+
+      it "should respond to start method" do
+        subject.respond_to?(:start).should be_true
+      end
+
+      it "should call build_query" do
+        subject.should_receive(:build_query).exactly(1).times
+        subject.start
+      end
+
+      it "should define instance variable @build_time" do
+        subject.start
+        subject.instance_variables.include?(:@build_time).should be_true
+      end
+
+      it "should call execute_query" do
+        subject.should_receive(:execute_query).exactly(1).times
+        subject.start
+      end
+
+      it "should define instance variable @execute_time" do
+        subject.start
+        subject.instance_variables.include?(:@execute_time).should be_true
+      end
+    end
+
+    describe "#execute_query" do
+      it "should respond to execute_query method" do
+        subject.respond_to?(:execute_query).should be_true
+      end
+
+      context "when query instance variable exists" do
+        it "should instance and call QueryExecution class" do
+          subject.instance_variable_set(:@query, "query")
+          execution = MassInsert::QueryExecution.any_instance
+          execution.stub(:execute).and_return("executed")
+          execution.should_receive(:execute).exactly(1).times
+          subject.execute_query
+        end
       end
 
-      it "should instance and call QueryExecution class" do
-        subject.stub(:query).and_return("query")
-        execution = MassInsert::QueryExecution.any_instance
-        execution.stub(:execute).and_return("executed")
-        execution.should_receive(:execute).exactly(1).times
-        subject.execute
+      context "when query instance variable does not exists" do
+        it "should instance and call QueryExecution class" do
+          subject.instance_variable_set(:@query, nil)
+          execution = MassInsert::QueryExecution.any_instance
+          execution.stub(:execute).and_return("executed")
+          execution.should_not_receive(:execute)
+          subject.execute_query
+        end
       end
     end
 
-    describe "#query" do
-      it "should respond to query method" do
-        subject.respond_to?(:query).should be_true
+    describe "#build_query" do
+      it "should respond to build_query method" do
+        subject.respond_to?(:build_query).should be_true
       end
 
       it "should instance and call QueryBuilder class" do
         builder = MassInsert::QueryBuilder.any_instance
         builder.stub(:build).and_return("query")
-        subject.query.should eq("query")
+        subject.build_query.should eq("query")
       end
+
+      it "should set query instance variable" do
+        builder = MassInsert::QueryBuilder.any_instance
+        builder.stub(:build).and_return("query")
+        subject.build_query
+        subject.instance_variables.include?(:@query).should be_true
+      end
+    end
+  end
+
+  describe "#results" do
+    before :each do
+      subject.stub(:values).and_return([{}, {}])
+      a = Benchmark.measure{}
+      a.stub(:total).and_return(10.0)
+      subject.instance_variable_set(:@build_time, a)
+      subject.instance_variable_set(:@execute_time, a)
+    end
+
+    it "should return total time in results" do
+      subject.results.time.should eql(20.0)
+    end
+
+    it "should return records persisted in results" do
+      subject.results.records.should eql(2)
+    end
+
+    it "should return build time in results" do
+      subject.results.build_time.should eql(10.0)
+    end
+
+    it "should return execute time in results" do
+      subject.results.execute_time.should eql(10.0)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mass_insert
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,7 +162,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4363220921701306027
+      hash: -391143887748903532
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -171,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4363220921701306027
+      hash: -391143887748903532
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25