mass_insert 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p392@mass_insert"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.19.1 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mass_insert.gemspec
+gemspec
+
+gem "rails", "3.2.13"
+gem "mysql2"
+gem "sqlite3"
+gem "pg"
+
+gem "rspec"
+gem "simplecov"
+gem "rake"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# MassInsert [![Build Status](https://travis-ci.org/alejandrogutierrez/mass_insert.png?branch=master)](https://travis-ci.org/alejandrogutierrez/mass_insert)
+
+This gem aims to provide an easy and faster way to do single database insertions in Rails.
+Support Mysql, PostgreSQL, SQLite3 and SQLServer adapters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mass_insert'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself with:
+
+    $ gem install mass_insert
+
+## Basic Usage
+
+To use MassInsert gem you need to call mass_insert method from your ActiveRecord model and pass it an array with the values that you want to persist into the database.
+
+The array of values:
+
+    values = [
+      {
+        :name   => "Jay",
+        :email  => "tremendous_gamer@gmail.com",
+        :age    => 15
+      },
+      {
+        :name   => "Beverly",
+        :email  => "nippy_programmer@gmail.com",
+        :age    => 24
+      },
+      {
+        :name   => "Scottie",
+        :email  => "angry_programmer@gmail.com",
+        :age    => 32
+      }
+    ]
+
+And call mass_insert method:
+
+    User.mass_insert(values)
+
+## 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.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,45 @@
+require "bundler/gem_tasks"
+
+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
+      rake db:drop db:create db:migrate RAILS_ENV=sqlite3
+    ")
+  end
+
+  desc "Runs all unit tests"
+  task :all do
+    system("echo '\e[00;32m\033[1mRunning all unit tests...\e[00m'")
+    system("bundle exec rspec spec/mass_insert_spec.rb spec/mass_insert")
+  end
+  
+  desc "Runs all the mysql2 specs"
+  task :mysql2 do
+    ENV["RAILS_ENV"] = "mysql2"
+    system("echo '\e[00;32m\033[1mRunning the Mysql2 adapter tests...\e[00m'")
+    system("bundle exec rspec spec/active_record_models")
+  end
+
+  desc "Runs all the Postgresql specs"
+  task :postgresql do
+    ENV["RAILS_ENV"] = "postgresql"
+    system("echo '\e[00;32m\033[1mRunning the Postgresql adapter tests...\e[00m'")
+    system("bundle exec rspec spec/active_record_models")
+  end
+
+  desc "Runs all the Sqlite3 specs"
+  task :sqlite3 do
+    ENV["RAILS_ENV"] = "sqlite3"
+    system("echo '\e[00;32m\033[1mRunning the Sqlite3 adapter tests...\e[00m'")
+    system("bundle exec rspec spec/active_record_models")
+  end
+end
+
+
+task default: ['spec:mysql2', 'spec:postgresql', 'spec:sqlite3', 'spec:all']

data/lib/mass_insert.rb

@@ -0,0 +1,13 @@
+require "mass_insert/version"
+
+module MassInsert
+  autoload :Adapters,         'mass_insert/adapters.rb'
+  autoload :Base,             'mass_insert/base.rb'
+  autoload :ProcessControl,   'mass_insert/process_control.rb'
+  autoload :QueryBuilder,     'mass_insert/query_builder.rb'
+  autoload :QueryExecution,   'mass_insert/query_execution.rb'
+end
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend MassInsert::Base
+end

data/lib/mass_insert/adapters.rb

@@ -0,0 +1,12 @@
+module MassInsert
+  module Adapters
+    autoload :Adapter,            'mass_insert/adapters/adapter.rb'
+    autoload :AbstractQuery,      'mass_insert/adapters/abstract_query.rb'
+    autoload :ColumnValue,        'mass_insert/adapters/column_value.rb'
+    autoload :Helpers,            'mass_insert/adapters/helpers.rb'
+    autoload :Mysql2Adapter,      'mass_insert/adapters/mysql2_adapter.rb'
+    autoload :PostgreSQLAdapter,  'mass_insert/adapters/postgresql_adapter.rb'
+    autoload :SQLite3Adapter,     'mass_insert/adapters/sqlite3_adapter.rb'
+    autoload :SQLServerAdapter,   'mass_insert/adapters/sqlserver_adapter.rb'
+  end
+end

data/lib/mass_insert/adapters/abstract_query.rb

@@ -0,0 +1,47 @@
+module MassInsert
+  module Adapters
+    module AbstractQuery
+
+      # Returns a begin string to a basic mysql query insertion. Include
+      # the class table_name and it's included in the string.
+      def begin_string
+        "INSERT INTO #{table_name} "
+      end
+
+      # Returns a string  with the column names to the class table name
+      # and divided by commmas.
+      def string_columns
+        "(#{column_names.join(", ")}) "
+      end
+
+      # Returns the string with all the row values that will be included
+      # in the sql string.
+      def string_values
+        "VALUES (#{string_rows_values});"
+      end
+
+      # Gives the correct format to the values string to all rows. This
+      # functions calls a function that will generate a single string row
+      # and at the end all the strings are concatenated.
+      def string_rows_values
+        values.map{ |row| string_single_row_values(row) }.join("), (")
+      end
+
+      def string_single_row_values row
+        # Prepare the single row to be included in the sql string.
+        row.merge!(timestamp_values) if timestamp?
+
+        # Generates the values to this row that will be included according
+        # to the type column and values.
+        column_names.map{ |col| string_single_value(row, col) }.join(", ")
+      end
+
+      # Returns a single column string value with the correct format and
+      # according to the database configuration, column type and presence.
+      def string_single_value row, column
+        ColumnValue.new(row, column, options).build
+      end
+
+    end
+  end
+end

data/lib/mass_insert/adapters/adapter.rb

@@ -0,0 +1,56 @@
+module MassInsert
+  module Adapters
+    # This class provides some helper methods to build the sql string that
+    # be executed. The methods here provides a functionality that be required
+    # in all the adapters.
+    class Adapter
+      include AbstractQuery
+      include Helpers::Timestamp
+      include Helpers::Sanitizer
+
+      attr_accessor :values, :options, :column_names
+
+      def initialize values, options
+        @values  = values
+        @options = options
+      end
+
+      # Returns the class like a constant that invokes the mass insert.
+      # Should be a class that inherits from ActiveRecord::Base.
+      def class_name
+        options[:class_name]
+      end
+
+      # Returns a string with the database table name where all the records
+      # will be saved.
+      def table_name
+        options[:table_name]
+      end
+
+      # Returns an array with the column names in the database table like
+      # a symbols.
+      def table_columns
+        class_name.column_names.map(&:to_sym)
+      end
+
+      # Returns the array with the column names valid to be included into the
+      # query string according to the options.
+      def column_names
+        @column_names ||= sanitized_columns
+      end
+
+      # Returns the primary_key column that was configured by the user.
+      # Default primary_key it's id
+      def primary_key
+        options[:primary_key]
+      end
+
+      # Returns the primary key mode according to the user configuration.
+      # Default primary key mode it's automatic.
+      def primary_key_mode
+        options[:primary_key_mode]
+      end
+
+    end
+  end
+end

data/lib/mass_insert/adapters/column_value.rb

@@ -0,0 +1,107 @@
+module MassInsert
+  module Adapters
+    class ColumnValue
+
+      attr_accessor :row, :column, :options
+
+      def initialize row, column, options
+        @row     = row
+        @column  = column
+        @options = options
+      end
+
+      # Returns the class that invokes the mass insert process. The class
+      # is in the options hash.
+      def class_name
+        options[:class_name]
+      end
+
+      # Returns a symbol with the column type in the database. The column or
+      # attribute should belongs to the class that invokes the mass insert.
+      def column_type
+        class_name.columns_hash[@column.to_s].type
+      end
+
+      # Returns the value to this column in the row hash. The value is
+      # finding by symbol or string key to be most flexible.
+      def column_value
+        row[column.to_sym]
+      end
+
+      # Returns the string with the database adapter name usually in the
+      # database.yml file in your Rails project.
+      def adapter
+        ActiveRecord::Base.connection.instance_values["config"][:adapter]
+      end
+
+      # Returns the default value string to be included in query string.
+      # This default value is added to the query if the row hash does not
+      # contains the database column value.
+      def default_value
+        default_db_value ? default_db_value.to_s : "null"
+      end
+
+      # Return the database default value using methods that ActiveRecord
+      # provides to see database columns settings.
+      def default_db_value
+        class_name.columns_hash[@column.to_s].default
+      end
+
+      # Returns a single column string value with the correct format and
+      # according to the database configuration, column type and presence.
+      def build
+        self.send "column_value_#{column_type}".to_sym
+      end
+
+      # Returns the correct value when the column value is string, text,
+      # date, time, datetime, timestamp. There are alias method to the
+      # other column types that need a similar query value.
+      def column_value_string
+        column_value.nil? ? default_value : "'#{column_value}'"
+      end
+      alias :column_value_text      :column_value_string
+      alias :column_value_date      :column_value_string
+      alias :column_value_time      :column_value_string
+      alias :column_value_datetime  :column_value_string
+      alias :column_value_timestamp :column_value_string
+      alias :column_value_binary    :column_value_string
+
+      # Returns the correct value to column value is integer. If the row
+      # hash does not include the value to this column return the default
+      # value according to database configuration.
+      def column_value_integer
+        column_value.nil? ? default_value : column_value.to_i.to_s
+      end
+
+      # Returns the correct value to column value is decimal. There is an
+      # alias method to float type. If the row hash does not include the
+      # value to this column return the default value according to database
+      # configuration.
+      def column_value_decimal
+        column_value.nil? ? default_value : column_value.to_f.to_s
+      end
+      alias :column_value_float :column_value_decimal
+
+      # Returns the correct value to column value is boolean. If the row
+      # hash does not include the value to this column return the default
+      # value according to database configuration.
+      def column_value_boolean
+        case adapter
+        when "mysql2", "postgresql", "sqlserver"
+          if column_value.nil?
+            default_value
+          else
+            column_value ? "true" : "false"
+          end
+        when "sqlite3"
+          if column_value.nil?
+            default_value
+          else
+            column_value ? "1" : "0"
+          end
+        end
+      end
+
+    end
+  end
+end