upsert 0.2.0 → 0.2.1

data/CHANGELOG

@@ -0,0 +1,5 @@
+0.2.1 / 2012-06-21
+
+* Enhancements
+
+  * Added support for Ruby 1.8.7

data/README.md

@@ -1,43 +1,53 @@
 # Upsert
 
-Finally, all those SQL MERGE tricks codified so that you can do "upsert" on MySQL, PostgreSQL, and Sqlite.
+Finally, all those SQL MERGE tricks codified so that you can do "upsert" on MySQL, PostgreSQL, and SQLite.
 
-## Usage
+You pass a selector that uniquely identifies a row, whether it exists or not. You pass a set of attributes that should be set on that row. Based on what database is being used, one of a number of SQL MERGE-like tricks are used.
 
-Let's say you have...
+The second argument is currently (mis)named a "document" because this was inspired by [mongo-ruby-driver's update method](http://api.mongodb.org/ruby/1.6.4/Mongo/Collection.html#update-instance_method).
 
-    class Pet < ActiveRecord::Base
-      # col :name
-      # col :breed
-    end
+## Usage
+
+### One by one
 
-### One at a time
+Faster than just doing `Pet.create`... 85% faster on PostgreSQL, for example. But no validations or anything.
 
     upsert = Upsert.new Pet.connection, Pet.table_name
-    selector = {:name => 'Jerry'}
-    document = {:breed => 'beagle'}
-    upsert.row selector, document
+    upsert.row({:name => 'Jerry'}, :breed => 'beagle')
+    upsert.row({:name => 'Pierre'}, :breed => 'tabby')
 
-### Streaming upserts (fastest)
+### Streaming
 
-Rows are buffered in memory until it's efficient to send them to the database.
+Rows are buffered in memory until it's efficient to send them to the database. Currently this only provides an advantage on MySQL because it uses `ON DUPLICATE KEY UPDATE`... but if a similar method appears in PostgreSQL, the same code will still work.
 
     Upsert.stream(Pet.connection, Pet.table_name) do |upsert|
-      # [...]
       upsert.row({:name => 'Jerry'}, :breed => 'beagle')
-      # [...]
       upsert.row({:name => 'Pierre'}, :breed => 'tabby')
-      # [...]
     end
 
-### With a helper method
+### `ActiveRecord::Base.upsert` (optional)
 
 For bulk upserts, you probably still want to use `Upsert.stream`.
 
-    # be sure to require 'upsert/active_record_upsert' - it's not required by default
-    selector = {:name => 'Jerry'}
-    document = {:breed => 'beagle'}
-    Pet.upsert selector, document
+    require 'upsert/active_record_upsert'
+    Pet.upsert({:name => 'Jerry'}, :breed => 'beagle')
+    Pet.upsert({:name => 'Pierre'}, :breed => 'tabby')
+
+### Gotchas
+
+Currently, the first row you pass in determines the columns that will be used. That's useful for mass importing of many rows with the same columns, but is surprising if you're trying to use a single `Upsert` object to add arbitrary data. For example, this won't work:
+
+    Upsert.stream(Pet.connection, Pet.table_name) do |upsert|
+      upsert.row({:name => 'Jerry'}, :breed => 'beagle')
+      upsert.row({:tag_number => 456}, :spiel => 'great cat') # won't work - doesn't use same columns
+    end
+
+You would need to use a new `Upsert` object. On the other hand, this is totally fine:
+
+    Pet.upsert({:name => 'Jerry'}, :breed => 'beagle')
+    Pet.upsert({:tag_number => 456}, :spiel => 'great cat')
+
+Please send in a pull request if you think there's a better way!
 
 ## Real-world usage
 
@@ -204,10 +214,6 @@ You could also use [activerecord-import](https://github.com/zdennis/activerecord
 
 This, however, only works on MySQL and requires ActiveRecord&mdash;and if all you are doing is upserts, `upsert` is tested to be 40% faster. And you don't have to put all of the rows to be upserted into a single huge array - you can stream them using `Upsert.stream`.
 
-### Loosely based on mongo-ruby-driver's upsert functionality
-
-The `selector` and `document` arguments are inspired by the upsert functionality of the [mongo-ruby-driver's update method](http://api.mongodb.org/ruby/1.6.4/Mongo/Collection.html#update-instance_method).
-
 ## Copyright
 
 Copyright 2012 Brighter Planet, Inc.

data/lib/upsert/mysql2_client.rb

@@ -70,8 +70,19 @@ class Upsert
     end
 
     def estimate_variable_sql_bytesize(take)
-      p = (take / 10.0).ceil
-      10.0 * rows.sample(p).inject(0) { |sum, row| sum + row.values_sql_bytesize + 3 }
+      n = (take / 10.0).ceil
+      sample = if RUBY_VERSION >= '1.9'
+        rows.first(take).sample(n)
+      else
+        # based on https://github.com/marcandre/backports/blob/master/lib/backports/1.8.7/array.rb
+        memo = rows.first(take)
+        n.times do |i|
+          r = i + Kernel.rand(take - i)
+          memo[i], memo[r] = memo[r], memo[i]
+        end
+        memo.first(n)
+      end
+      10.0 * sample.inject(0) { |sum, row| sum + row.values_sql_bytesize + 3 }
     end
 
     def sql_bytesize(take)

data/lib/upsert/version.rb

@@ -1,3 +1,3 @@
 class Upsert
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/helper.rb

@@ -50,9 +50,13 @@ MiniTest::Spec.class_eval do
       end
       2000.times do
         selector = ActiveSupport::OrderedHash.new
-        selector[:name] = names.sample(1).first
+        selector[:name] = if RUBY_VERSION >= '1.9'
+          names.sample(1).first
+        else
+          names.choice
+        end
         document = {
-          :lovability => BigDecimal.new(rand(1e11), 2),
+          :lovability => BigDecimal.new(rand(1e11).to_s, 2),
           :tag_number => rand(1e8),
           :spiel => SecureRandom.hex(rand(127)),
           :good => true,

data/test/shared/reserved_words.rb

@@ -27,14 +27,16 @@ shared_examples_for "doesn't blow up on reserved words" do
     nasty.auto_upgrade!
   end
 
-  nasties.each do |nasty, words|
-    it "doesn't die on reserved words #{words.join(',')}" do
-      upsert = Upsert.new connection, nasty.table_name
-      random = rand(1e3).to_s
-      selector = { :fake_primary_key => random, words.first => words.first }
-      document = words[1..-1].inject({}) { |memo, word| memo[word] = word; memo }
-      assert_creates nasty, [selector.merge(document)] do
-        upsert.row selector, document
+  describe "reserved words" do
+    nasties.each do |nasty, words|
+      it "doesn't die on reserved words #{words.join(',')}" do
+        upsert = Upsert.new connection, nasty.table_name
+        random = rand(1e3).to_s
+        selector = { :fake_primary_key => random, words.first => words.first }
+        document = words[1..-1].inject({}) { |memo, word| memo[word] = word; memo }
+        assert_creates nasty, [selector.merge(document)] do
+          upsert.row selector, document
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: upsert
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -182,6 +182,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .yardopts
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md