monogamy 0.0.1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+
+env:
+  - DB=sqlite
+  - DB=mysql
+  - DB=pg
+
+script: bundle exec rake
+
+before_script:
+  - mysql -e 'create database monogamy_test'
+  - psql -c 'create database monogamy_test' -U postgres
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matthew McEachen
+
+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,35 @@
+# Monogamy [![Build Status](https://api.travis-ci.org/mceachen/monogamy.png?branch=master)](https://travis-ci.org/mceachen/monogamy)
+
+Adds table-level locking to ActiveRecord 3.x. MySQL, PostgreSQL, and SQLite are supported.
+
+## Usage
+
+```ruby
+Tag.with_table_lock do
+  Tag.find_or_create_by_name("example")
+end
+```
+
+While your code is inside the block, it will have exclusive read and write access to the model's
+table.
+
+If your block touches other tables, and you use table-level locking on those tables as well,
+read up about [deadlocks](http://en.wikipedia.org/wiki/Deadlock). **You have been warned.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'monogamy'
+```
+
+And then execute:
+
+    $ bundle
+
+## Changelog
+
+### 0.0.1
+
+* First whack

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'README.md']
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.libs.push "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/lib/monogamy.rb

@@ -0,0 +1,8 @@
+require 'monogamy/with_table_lock'
+
+module Monogamy
+  ActiveSupport.on_load :active_record do
+    ActiveRecord::Base.send :extend, Monogamy::WithTableLock
+    ActiveRecord::Base.send :include, Monogamy::WithTableLock
+  end
+end

data/lib/monogamy/mysql.rb

@@ -0,0 +1,15 @@
+module Monogamy
+  module MySQL
+    # See http://dev.mysql.com/doc/refman/5.0/en/lock-tables-and-transactions.html
+    def self.with_table_lock(connection, quoted_table_name, &block)
+      begin
+        connection.transaction do
+          connection.execute("LOCK TABLES #{quoted_table_name} WRITE")
+          yield
+        end
+      ensure
+        connection.execute("UNLOCK TABLES")
+      end
+    end
+  end
+end

data/lib/monogamy/postgresql.rb

@@ -0,0 +1,11 @@
+module Monogamy
+  module PostgreSQL
+    # See http://www.postgresql.org/docs/9.0/static/sql-lock.html
+    def self.with_table_lock(connection, quoted_table_name, &block)
+      connection.transaction do
+        connection.execute("LOCK TABLE #{quoted_table_name} IN ACCESS EXCLUSIVE MODE")
+        yield
+      end
+    end
+  end
+end

data/lib/monogamy/sqlite.rb

@@ -0,0 +1,33 @@
+module Monogamy
+  module SQLite
+    # See http://sqlite.org/lang_transaction.html
+    def self.with_table_lock(connection, quoted_table_name, &block)
+      if connection.open_transactions > 0
+        raise NotImplementedError, "Support for nested transactions within sqlite has not been written"
+      end
+
+      begin
+        connection.execute("BEGIN EXCLUSIVE TRANSACTION")
+      rescue Exception => e
+        if e.message.include? "SQLite3::BusyException" # < Rails wraps BusyException in the message (!!!)
+          sleep 0.2
+          retry
+        else
+          raise e
+        end
+      end
+
+      begin
+        connection.increment_open_transactions
+        yield
+        connection.execute("COMMIT TRANSACTION")
+      rescue Exception => e
+        puts e
+        puts e.backtrace.join("\n")
+        connection.execute("ROLLBACK TRANSACTION")
+      ensure
+        connection.decrement_open_transactions
+      end
+    end
+  end
+end

data/lib/monogamy/version.rb

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

data/lib/monogamy/with_table_lock.rb

@@ -0,0 +1,27 @@
+# Tried desperately to monkeypatch the polymorphic connection object,
+# but rails lazyloading is too clever by half.
+
+# Think of this module as a hipster, using "case" ironically.
+
+require 'monogamy/mysql'
+require 'monogamy/postgresql'
+require 'monogamy/sqlite'
+
+module Monogamy
+  module WithTableLock
+    def with_table_lock(&block)
+      adapter = case (connection.adapter_name.downcase)
+        when "postgresql"
+          Monogamy::PostgreSQL
+        when "mysql", "mysql2"
+          Monogamy::MySQL
+        when "sqlite"
+          Monogamy::SQLite
+        else
+          raise NotImplementedError, "Support for #{connection.adapter_name} has not been written"
+      end
+      adapter.with_table_lock(connection, quoted_table_name, &block)
+    end
+  end
+
+end

data/monogamy.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'monogamy/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "monogamy"
+  gem.version       = Monogamy::VERSION
+  gem.authors       = ["Matthew McEachen"]
+  gem.email         = ["matthew+github@mceachen.org"]
+  gem.description   = %q{Add table-level database locking to ActiveRecord}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.require_paths = %w(lib)
+
+  gem.add_runtime_dependency 'activerecord', '>= 3.0.0'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'mysql2'
+  gem.add_development_dependency 'pg'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'database_cleaner'
+end

data/test/database.yml

@@ -0,0 +1,16 @@
+sqlite:
+  adapter: <%= "jdbc" if defined? JRUBY_VERSION %>sqlite3
+  database: monogamy.sqlite3.db
+  pool: 50
+pg:
+  adapter: postgresql
+  username: postgres
+  database: monogamy_test
+  min_messages: ERROR
+  pool: 50
+mysql:
+  adapter: mysql2
+  host: localhost
+  username: root
+  database: monogamy_test
+  pool: 50

data/test/minitest_helper.rb

@@ -0,0 +1,26 @@
+require 'erb'
+require 'active_record'
+require 'monogamy'
+require 'database_cleaner'
+
+db_config = File.expand_path("database.yml", File.dirname(__FILE__))
+ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(db_config)).result)
+ActiveRecord::Base.establish_connection(ENV["DB"] || "sqlite")
+ActiveRecord::Migration.verbose = false
+
+require 'test_models'
+
+Tag.new # < make sure class has loaded
+
+require 'minitest/autorun'
+
+DatabaseCleaner.strategy = :deletion
+class MiniTest::Spec
+  before :each do
+    DatabaseCleaner.start
+  end
+  after :each do
+    DatabaseCleaner.clean
+  end
+end
+

data/test/monogamy_test.rb

@@ -0,0 +1,61 @@
+require 'minitest_helper'
+
+describe "Monogamy" do
+
+  it "adds with_table_lock to ActiveRecord classes" do
+    assert Tag.respond_to?(:with_table_lock)
+  end
+
+  it "adds with_table_lock to ActiveRecord instances" do
+    assert Tag.new.respond_to?(:with_table_lock)
+  end
+
+  def find_or_create_at_even_second(run_at, with_table_lock)
+    Tag.connection.close
+    sleep(run_at - Time.now.to_f)
+    Tag.connection.reconnect!
+    if with_table_lock
+      Tag.with_table_lock do
+        Tag.find_or_create_by_name(run_at.to_s)
+      end
+    else
+      Tag.find_or_create_by_name(run_at.to_s)
+    end
+  end
+
+  def run_workers(with_table_lock)
+    start_time = Time.now.to_i + 2
+    threads = @workers.times.collect do
+      Thread.new do
+        begin
+          @iterations.times do |ea|
+            find_or_create_at_even_second(start_time + (ea * 2), with_table_lock)
+          end
+        ensure
+          ActiveRecord::Base.connection.close
+        end
+      end
+    end
+    threads.each { |ea| ea.join }
+  end
+
+  before :each do
+    @iterations = 5
+    @workers = 7
+  end
+
+  it "parallel threads create multiple duplicate rows" do
+    run_workers(with_table_lock = false)
+    puts "Created #{Tag.all.size} without lock"
+    if Tag.connection.adapter_name == "SQLite" && RUBY_VERSION == "1.9.3"
+      Tag.all.size.must_equal @iterations # <- sqlite on 1.9.3 doesn't create dupes IKNOWNOTWHY
+    else
+      Tag.all.size.must_be :>, @iterations # <- any duplicated rows will make me happy.
+    end
+  end
+
+  it "parallel threads with_table_lock don't create multiple duplicate rows" do
+    run_workers(with_table_lock = true)
+    Tag.all.size.must_equal @iterations # <- any duplicated rows will NOT make me happy.
+  end
+end

data/test/test_models.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table "tags", :force => true do |t|
+    t.string "name"
+  end
+end
+
+class Tag < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: monogamy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew McEachen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add table-level database locking to ActiveRecord
+email:
+- matthew+github@mceachen.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/monogamy.rb
+- lib/monogamy/mysql.rb
+- lib/monogamy/postgresql.rb
+- lib/monogamy/sqlite.rb
+- lib/monogamy/version.rb
+- lib/monogamy/with_table_lock.rb
+- monogamy.gemspec
+- test/database.yml
+- test/minitest_helper.rb
+- test/monogamy_test.rb
+- test/test_models.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3951791607027416484
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3951791607027416484
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Add table-level database locking to ActiveRecord
+test_files:
+- test/database.yml
+- test/minitest_helper.rb
+- test/monogamy_test.rb
+- test/test_models.rb
+has_rdoc: