tachyon 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7882de4f67436fff7b522c0be26a0b49689bcd5e
-  data.tar.gz: 92c62b8cebbff5a64a1debed2c43297536fd5890
+  metadata.gz: 7e508417f45cc19402918a4a554f8928cd43919d
+  data.tar.gz: 0f97c7354af65aebbd184ee4f85eb735eb841a01
 SHA512:
-  metadata.gz: 4c634d8836430187401b0e4ccf895c907169f7928a75e55fddf781a82fc9d4a14cc08fd2f113a791eb4d0babd1ed40942c93d6df054fb6e465d168ec688c80b3
-  data.tar.gz: 7e4fa020dc44fb6e4a0259000220c95712b6c6dd8c5a34717b380a7508dca82cf2a5fef06ed147a4e3ad39403ef47f63c8c8cee750f286ebd88eb44a48717d44
+  metadata.gz: 4e1a77ae53773d6c6e7d0aaa81765bf8ede459dfca2cd06120402c8314cade4e7f73e33c4e85149913c5e7304a41bc7a630f6f2ce51a69d74a28287686f0f8dc
+  data.tar.gz: 177c88d41f2809cfd356d4ada6acd192101c28943425d5431d1d337dce1d688c6338a9862ac9ab318a53af9d66bb02d7d7d8dbc63f43fc45c4284ef501386465

data/README.md

@@ -1,41 +1,43 @@
 # Tachyon
 
-Tachyon is a simple library designed to insert rows into any DB managed by ActiveRecord as fast as possible. Tachyon does not do validations. Tachyon does not throw errors on duplicate keys. Tachyon simply gets records into the DB as fast as possible. This is very useful in the case when you need to bulk-insert data for some reason, but it really shouldn't be used to replace your normal ActiveRecord DB operations.
-
-Tachyon is roughly as fast as executing raw SQL statements, but with a much more readable syntax. Tachyon uses Arel to geneate the SQL statements and to manage type-casting, this helps to avoid the fragility that can come with manually generating SQL.
+Tachyon is a simple library designed to insert rows into any DB managed by ActiveRecord as fast as possible. Tachyon does not do validations, and only does minimal typescasting. Tachyon simply gets records into the DB as fast as possible. This is very useful in the case when you need to bulk-insert data for some reason, but it really shouldn't be used to replace your normal ActiveRecord DB operations.
 
 ## How fast is it?
 
-The goal is to be roughly as fast as executing raw SQL via `ActiveRecord::Base.connection`. Tachyon still falls a little short of this mark, but future optimizations will close the gap.
+Tachyon is as fast (or faster) than executing raw SQL via `ActiveRecord::Base.connection`:
 
 ```
-Benchmark Results (inserting 5,000 rows):
--------------------------------------------
-User.create()               : 4.461711 secs
-Raw SQL                     : 0.597918 secs
-Tachyon.insert(User, Hash)  : 1.127233 secs
-Tachyon.insert(User, Array) : 1.078880 secs
+Benchmark Results (Inserting 10,000 rows):
+------------------------------------------------
+User.create(Hash)                 : 7.72 seconds
+Raw SQL (w/ string interpolation) : 1.01 seconds
+Tachyon.insert(User, Hash)        : 1.00 seconds
 ```
 
-## Usage
+## Features
 
-To insert a single row, simply supply the model class along with a hash of attributes:
+* As fast (or faster!) than generating SQL via string interpolation, but with a much nicer syntax!
+* Suppresses duplicate key errors, which makes life easier when doing bulk data imports
+* Allows you to dump records from the database in a useful format via `Tachyon.dump_record`
+* Compatible with MySQL, PostgreSQL and SQLite3
 
-```ruby
-Tachyon.insert(Article, id: 13, title: "Brand new article")
-```
+## Caveats
+
+* Tachyon does not perform validations
+* Tachyon only does minimal typecasting
+
+## Typecasting
 
-To do a bulk insert, supply the model class and an array of attribute hashes. Tachyon will wrap multiple inserts in a transaction for an extra speed boost:
+Tachyon does extremely minimal typecasting. Integers and Floats are passed through as literals, nils are converted to NULLs, pretty much all other types should be supplied as strings where appropriate.
+
+## Usage
+
+Simply supply the model class along with a hash of attributes:
 
 ```ruby
-Tachyon.insert(Comment, [
-  {id: 1, article_id: 34, title: "Super comment"},
-  {id: 2, article_id: 12, title: "Another one"},
-  {id: 3, article_id: 90, title: "Comment duex"},
-])
+Tachyon.insert(Article, id: 13, title: "Brand new article")
 ```
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -52,8 +54,6 @@ Or install it yourself as:
 
     $ gem install tachyon
 
-
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/tachyon.rb

@@ -1,29 +1,67 @@
 require "tachyon/version"
 
 class Tachyon
+
+  @@sql_cache = {}
+  @@connection_cache = {}
+
   def self.insert(klass, data)
-    raise ArgumentError, "data must be a hash or array" unless data.is_a?(Array) || data.is_a?(Hash)
-    raise ArgumentError, "klass must inherit from ActiveRecord::Base" unless klass < ActiveRecord::Base
+    self.connection_for(klass).execute(self.sql_for(klass, data))
+  rescue ActiveRecord::RecordNotUnique
+    # NO OP
+  end
 
-    if data.is_a?(Array)
-      self.insert_records(klass, data)
-    elsif data.is_a?(Hash)
-      self.insert_record(klass, data)
-    end
+  def self.connection_for(klass)
+    return @@connection_cache[klass] if @@connection_cache.has_key?(klass)
+    @@connection_cache[klass] = klass.connection
   end
 
-  def self.insert_record(klass, data)
-    begin
-        klass.new(data).save(validate: false)
-    rescue ActiveRecord::RecordNotUnique
+  def self.sql_for(klass, data)
+    self.sql_template_for(klass) % self.quote_data(data)
+  rescue KeyError => e
+    raise "Data was not supplied for all columns - " + e.to_s
+  end
+
+  def self.sql_template_for(klass)
+    return @@sql_cache[klass] if @@sql_cache.has_key?(klass)
+
+    columns = klass.columns.map(&:name)
+    table_name = klass.table_name
+    columns_string = columns.map {|x| "`#{x}`" }.join(", ")
+    values_string = columns.map {|x| "%{#{x}}" }.join(", ")
+
+    sql = "INSERT INTO `#{table_name}` (#{columns_string}) VALUES (#{values_string})"
+
+    @@sql_cache[klass] = sql
+  end
+
+  def self.quote_data(data)
+    data.map do |key, value|
+      [key, self.quote_value(value)]
+    end.to_h
+  end
+
+  def self.quote_value(value)
+    case value
+    when String then "'#{value.gsub("'", "''")}'"
+    when NilClass then "NULL"
+    else value
     end
   end
 
-  def self.insert_records(klass, data)
-    klass.connection.transaction do
-      data.each do |record|
-        self.insert_record(klass, record)
-      end
+  def self.dump_record(record)
+    record.attributes_before_type_cast.map do |key, value|
+      [key.to_sym, self.dump_attribute(value)]
+    end.to_h
+  end
+
+  def self.dump_attribute(attribute)
+    case attribute
+    when Time then attribute.to_s(:db)
+    when Date then attribute.to_s(:db)
+    when TrueClass then 1
+    when FalseClass then 0
+    else attribute
     end
   end
 end

data/lib/tachyon/version.rb

@@ -1,3 +1,3 @@
 class Tachyon
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/tachyon.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "activerecord", "~> 5.1.1"
   spec.add_development_dependency "activesupport", "~> 5.1.1"
   spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "ruby-prof"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tachyon
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Aaron Gough
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-15 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Create records in a DB managed by ActiveRecord as fast as possible.
 email:
 - aaron@aarongough.com