mass_insert 0.0.1

data/lib/mass_insert/adapters/helpers.rb

@@ -0,0 +1,8 @@
+module MassInsert
+  module Adapters
+    module Helpers
+      autoload :Timestamp,  'mass_insert/adapters/helpers/timestamp.rb'
+      autoload :Sanitizer,  'mass_insert/adapters/helpers/sanitizer.rb'
+    end
+  end
+end

data/lib/mass_insert/adapters/helpers/sanitizer.rb

@@ -0,0 +1,17 @@
+module MassInsert
+  module Adapters
+    module Helpers
+      module Sanitizer
+
+        # Update the array with the columns names according to the options
+        # and prepare the columns array with only valid columns.
+        def sanitized_columns
+          columns = table_columns
+          columns.delete(primary_key) if primary_key_mode == :auto
+          columns
+        end
+
+      end
+    end
+  end
+end

data/lib/mass_insert/adapters/helpers/timestamp.rb

@@ -0,0 +1,38 @@
+module MassInsert
+  module Adapters
+    module Helpers
+      module Timestamp
+
+        # Returns true o false if the database table has the
+        # timestamp columns.
+        def timestamp?
+          column_names.include?(:created_at) &&
+            column_names.include?(:updated_at)
+        end
+
+        # Returns timestamp format according to the database adapter. This
+        # function can be overwrite in database adapters classes to put the
+        # correct format to that database.
+        def timestamp_format
+          "%Y-%m-%d %H:%M:%S.%6N"
+        end
+
+        # Returns the timestamp value with specific format according to the
+        # correct timestamp format to that database.
+        def timestamp
+          Time.now.strftime(timestamp_format)
+        end
+
+        # Returns the timestamp values to be merge into row values that
+        # will be saved in the database.
+        def timestamp_values
+          {
+            :created_at => timestamp,
+            :updated_at => timestamp
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/mass_insert/adapters/mysql2_adapter.rb

@@ -0,0 +1,21 @@
+module MassInsert
+  module Adapters
+    class Mysql2Adapter < Adapter
+
+      # 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"
+      end
+
+      # This functions calls the necessary functions to create a complete
+      # mysql query to multiple insertion. The methods are in the Abstract
+      # Sql String module. If some method is too specific to this database
+      # adapter you can overwrite it.
+      def execute
+        "#{begin_string}#{string_columns}#{string_values}"
+      end
+
+    end
+  end
+end

data/lib/mass_insert/adapters/postgresql_adapter.rb

@@ -0,0 +1,15 @@
+module MassInsert
+  module Adapters
+    class PostgreSQLAdapter < Adapter
+
+      # This functions calls the necessary functions to create a complete
+      # postgresql query to multiple insertion. The methods are in the
+      # AbstractQuery module. If some method is too specific to this database
+      # adapter you can overwrite it.
+      def execute
+        "#{begin_string}#{string_columns}#{string_values}"
+      end
+
+    end
+  end
+end

data/lib/mass_insert/adapters/sqlite3_adapter.rb

@@ -0,0 +1,37 @@
+module MassInsert
+  module Adapters
+    class SQLite3Adapter < Adapter
+
+      MAX_VALUES_PER_INSERTION = 500
+
+      # This method is overwrite because the query string to the Sqlite3
+      # adapter is different. Then the method in the AbstractQuery module
+      # is ignored.
+      def string_values
+        "SELECT #{string_rows_values};"
+      end
+
+      # This method is overwrite because the query string to complete the
+      # string rows values is different. The separator to sqlite adapter is
+      # 'UNION SELECT' instead of '), (' in other sql adapters.
+      def string_rows_values
+        values.map{ |row| string_single_row_values(row) }.join(" UNION SELECT ")
+      end
+
+      # This functions calls the necessary functions to create a complete
+      # sqlite3 query to multiple insertion. The methods are in the Abstract
+      # Query module. If some method is too specific to this database adapter
+      # you can overwrite it. The values that the user gave will be treated
+      # in batches of 500 items because sqlite database allows by default
+      # batches of 500.and each batch will generate a query. This method will
+      # generate an array with batch queries.
+      def execute
+        @values.each_slice(MAX_VALUES_PER_INSERTION).map do |slice|
+          @values = slice
+          "#{begin_string}#{string_columns}#{string_values}"
+        end
+      end
+
+    end
+  end
+end

data/lib/mass_insert/adapters/sqlserver_adapter.rb

@@ -0,0 +1,23 @@
+module MassInsert
+  module Adapters
+    class SQLServerAdapter < Adapter
+
+      MAX_VALUES_PER_INSERTION = 1000
+
+      # This functions calls the necessary functions to create a complete
+      # sqlserver query to multiple insertion. The methods are in the Abstract
+      # Query module. If some method is too specific to this database adapter
+      # you can overwrite it. The values that the user gave will be treated
+      # in batches of 500 items because sqlite database allows by default
+      # batches of 500.and each batch will generate a query. This method will
+      # generate an array with batch queries.
+      def execute
+        @values.each_slice(MAX_VALUES_PER_INSERTION).map do |slice|
+          @values = slice
+          "#{begin_string}#{string_columns}#{string_values}"
+        end
+      end
+
+    end
+  end
+end

data/lib/mass_insert/base.rb

@@ -0,0 +1,43 @@
+module MassInsert
+  module Base
+
+    # This method do a mass database insertion. Example...
+    #
+    #   User.mass_insert(values)
+    #
+    # The values should be an array with the object values
+    # in a hash. Example...
+    #
+    #   values = [
+    #     {:name   => "user name", :email  => "user email"},
+    #     {:name   => "user name", :email  => "user email"},
+    #     {:name   => "user name", :email  => "user email"}
+    #   ]
+    #
+    def mass_insert values, args = {}
+      options = mass_insert_options(args)
+      process = MassInsert::ProcessControl.new(values, options)
+      process.execute
+    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
+      end
+
+  end
+end

data/lib/mass_insert/process_control.rb

@@ -0,0 +1,24 @@
+module MassInsert
+  class ProcessControl
+
+    attr_accessor :values, :options
+
+    def initialize values, options
+      @values  = values
+      @options = options
+    end
+
+    # This method is responsible to call all the necessary process to
+    # complete the mass insertion process.
+    def execute
+      QueryExecution.new(query).execute
+    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
+    end
+
+  end
+end

data/lib/mass_insert/query_builder.rb

@@ -0,0 +1,42 @@
+module MassInsert
+  class QueryBuilder
+
+    attr_accessor :values, :options
+
+    def initialize values, options
+      @values  = values
+      @options = options
+    end
+
+    # This function calls the correct adapter class and returns the
+    # sql string ready to be executed and returns it to be execute in
+    # the QueryExecution class.
+    def build
+      adapter_instance_class.execute
+    end
+
+    # Returns a string that contains the adapter type previosly
+    # configured in Rails project usually in the database.yml file.
+    def adapter
+      ActiveRecord::Base.connection.instance_values["config"][:adapter]
+    end
+
+    # Returns an instance of the correct database adapter and this
+    # instance will be called to generate the sql string. The values
+    # and options are passed by params when the correct adapter class
+    # is instanced.
+    def adapter_instance_class
+      case adapter
+      when "mysql2"
+        Adapters::Mysql2Adapter.new(values, options)
+      when "postgresql"
+        Adapters::PostgreSQLAdapter.new(values, options)
+      when "sqlite3"
+        Adapters::SQLite3Adapter.new(values, options)
+      when "sqlserver"
+        Adapters::SQLServerAdapter.new(values, options)
+      end
+    end
+
+  end
+end

data/lib/mass_insert/query_execution.rb

@@ -0,0 +1,29 @@
+module MassInsert
+  # This class is responsible to execute the query string into the
+  # database. Uses the ActiveRecord::Base.connection.execute functionality
+  # to execute the query string directly.
+  class QueryExecution
+
+    attr_accessor :query_container
+
+    # The query string is usually passed by params when the ProcessControl
+    # class instances this class. The query can be a string or an array,
+    # therefore to be sure that the query_container attribute is an array
+    # the param passed to this class is converted to array. The query
+    # container attribute will be iterated in execute method in this class
+    # to execute each query that it contains.
+    def initialize query_container
+      @query_container = Array(query_container)
+    end
+
+    # Saves queries contained in query_container attributes into database.
+    # Use the helper that ActiveRecord provides. Query container attribute
+    # is iterated to save each query that it contains.
+    def execute
+      @query_container.each do |query|
+        ActiveRecord::Base.connection.execute(query)
+      end
+    end
+
+  end
+end

data/lib/mass_insert/version.rb

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

data/mass_insert.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mass_insert/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mass_insert"
+  spec.version       = MassInsert::VERSION
+  spec.authors       = ["Alejandro Gutiérrez"]
+  spec.email         = ["alejandrodevs@gmail.com"]
+  spec.description   = "Mass database insertion in Rails"
+  spec.summary       = "This gem aims to provide an easy and faster way to do single database insertions in Rails."
+  spec.homepage      = "https://github.com/alejandrogutierrez/mass_insert"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/active_record_dummy/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/active_record_dummy/Gemfile

@@ -0,0 +1,40 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.13'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+gem 'mysql2'
+gem 'pg'
+gem 'mass_insert', :git => 'git@github.com:alejandrogutierrez/mass_insert.git', :branch => 'master'
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer', :platforms => :ruby
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'debugger'

data/spec/active_record_dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.