sequenced 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c19db66c935260344abf853e2e1725a7dc9ef4d
-  data.tar.gz: 27bc38c11839f113839eaf23b8f213f677fa9024
+  metadata.gz: 19469f53054a51802c23c141597b405b2d061b9e
+  data.tar.gz: 86e49028b4e37daf29ef770727d68e0edd096634
 SHA512:
-  metadata.gz: 1f47927ecd09469be6fc26fb30b9a752a8f94bee42cba8c54c5cb44d4e0fafa328e6c3dad9a69529a20b4461add62e1d6cd14a730230b284db904d8bb97da4be
-  data.tar.gz: 9e9707f1c891f16bd0f30a7f0dc001a6f212b9006ef3294549c5c037da817029d850f52b219872e0ac6d7ad8551a140492b28ca2a3d79cdf52117df465791366
+  metadata.gz: 3e98ddf8640a706f049d2295861792cd7b5e10d21e6c4d1591ed46126bf645590fb8ab00e3b9ded0c882bd5530d60deec9e013824f86d539e73e9c56a7fb9af5
+  data.tar.gz: cb58678c8d817b23677162008c60120f564f48b41713d9ecc9a97922ac74c1b7677c3691b5ab1661ce171e9c82c709fefcc48425773c74b5ac4d91caaf619896

data/.travis.yml

@@ -1,4 +1,13 @@
 language: ruby
 rvm:
   - 1.9.3
-  - ruby-head
+  - 2.2.3
+
+env:
+  - DB=sqlite
+  - DB=postgresql
+
+before_script:
+  - rake db:create
+
+sudo: false

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+3.0.0 (November 28, 2015)
+-------------------------
+
+* Make this gem thread-safe for PostgreSQL
+  (samphilipd, [#16](https://github.com/djreimer/sequenced/pull/16)) 
+
 2.0.0 (October 24, 2014)
 ------------------------
 

data/Gemfile

@@ -8,6 +8,12 @@ gemspec
 # jquery-rails is used by the dummy application
 gem "jquery-rails"
 
+group :development, :test do
+  gem 'sqlite3'
+  # gem 'mysql2'
+  gem 'pg'
+end
+
 # Declare any dependencies that are still in development here instead of in
 # your gemspec. These might include edge Rails or gems from your path or
 # Git. Remember to move these dependencies to your gemspec before releasing

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2011-2014 Derrick Reimer
+Copyright 2015 Derrick Reimer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -4,20 +4,20 @@
 [![Code Climate](https://codeclimate.com/github/djreimer/sequenced.png)](https://codeclimate.com/github/djreimer/sequenced)
 [![Gem Version](https://badge.fury.io/rb/sequenced.png)](http://badge.fury.io/rb/sequenced)
 
-Sequenced is a simple gem that generates scoped sequential IDs for 
-ActiveRecord models. This gem provides an `acts_as_sequenced` macro that 
-automatically assigns a unique, sequential ID to each record. The sequential ID is 
-not a replacement for the database primary key, but rather adds another way to 
+Sequenced is a simple gem that generates scoped sequential IDs for
+ActiveRecord models. This gem provides an `acts_as_sequenced` macro that
+automatically assigns a unique, sequential ID to each record. The sequential ID is
+not a replacement for the database primary key, but rather adds another way to
 retrieve the object without exposing the primary key.
 
 ## Purpose
 
-It's generally a bad practice to expose your primary keys to the world 
-in your URLs. However, it is often appropriate to number objects in sequence 
+It's generally a bad practice to expose your primary keys to the world
+in your URLs. However, it is often appropriate to number objects in sequence
 (in the context of a parent object).
 
 For example, given a Question model that has many Answers, it makes sense
-to number answers sequentially for each individual question. You can achieve 
+to number answers sequentially for each individual question. You can achieve
 this with Sequenced in one line of code:
 
 ```ruby
@@ -34,7 +34,7 @@ end
 ## Installation
 
 Add the gem to your Gemfile:
-   
+
     gem 'sequenced'
 
 Install the gem with bundler:
@@ -70,12 +70,36 @@ class Answer < ActiveRecord::Base
 end
 ```
 
+## Schema and data integrity
+
+**This gem is only concurrent-safe for PostgreSQL databases**. For other database systems, unexpected behavior may occur if you attempt to create records concurrently.
+
+You can mitigate this somewhat by applying a unique index to your sequential ID column (or a multicolumn unique index on sequential ID and scope columns, if you are using scopes). This will ensure that you can never have duplicate sequential IDs within a scope, causing concurrent updates to instead raise a uniqueness error at the database-level.
+
+It is also a good idea to apply a not-null constraint to your sequential ID column as well if you never intend to skip it.
+
+Here is an example migration for a model that has a `sequential_id` scoped to a `burrow_id`:
+
+```ruby
+# app/db/migrations/20151120190645_create_badgers.rb
+class CreateBadgers < ActiveRecord::Migration
+  def change
+    create_table :badgers do |t|
+      t.integer :sequential_id, null: false
+      t.integer :burrow_id
+    end
+
+    add_index :badgers, [:sequential_id, :burrow_id], unique: true
+  end
+end
+```
+
 ## Configuration
 
 ### Overriding the default sequential ID column
 
-By default, Sequenced uses the `sequential_id` column and assumes it already 
-exists. If you wish to store the sequential ID in different integer column, 
+By default, Sequenced uses the `sequential_id` column and assumes it already
+exists. If you wish to store the sequential ID in different integer column,
 simply specify the column name with the `column` option:
 
 ```ruby
@@ -84,7 +108,7 @@ acts_as_sequenced scope: :question_id, column: :my_sequential_id
 
 ### Starting the sequence at a specific number
 
-By default, Sequenced begins sequences with 1. To start at a different 
+By default, Sequenced begins sequences with 1. To start at a different
 integer, simply set the `start_at` option:
 
 ```ruby
@@ -113,7 +137,7 @@ acts_as_sequenced skip: lambda { |r| r.score == 0 }
 
 ## Example
 
-Suppose you have a question model that has many answers. This example 
+Suppose you have a question model that has many answers. This example
 demonstrates how to use Sequenced to enable access to the nested answer
 resource via its sequential ID.
 
@@ -127,7 +151,7 @@ end
 class Answer < ActiveRecord::Base
   belongs_to :question
   acts_as_sequenced scope: :question_id
-  
+
   # Automatically use the sequential ID in URLs
   def to_param
     self.sequential_id
@@ -141,48 +165,25 @@ end
 
 # app/controllers/answers_controller.rb
 class AnswersController < ApplicationController
-  before_filter :load_question
-  before_filter :load_answer, only: [:show, :edit, :update, :destroy]
-  
-private
-
-  def load_question
+  def show
     @question = Question.find(params[:question_id])
-  end
-  
-  def load_answer
-    @answer = @question.answers.where(:sequential_id => params[:id]).first
+    @answer = @question.answers.find_by(sequential_id: params[:id])
   end
 end
 ```
 
 Now, answers are accessible via their sequential IDs:
 
-    http://example.com/questions/5/answers/1    # Good
+    http://example.com/questions/5/answers/1  # Good
 
 instead of by their primary keys:
 
     http://example.com/questions/5/answer/32454  # Bad
 
-## License
-
-Copyright &copy; 2011-2014 Derrick Reimer
-
-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.
+## Contributing
 
-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.
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -31,5 +31,29 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task :default => :test
+
+namespace :db do
+  task :create do
+    # File.expand_path is executed directory of generated Rails app
+    rakefile = File.expand_path('Rakefile', 'test/dummy/')
+    command = "rake -f '%s' db:create" % rakefile
+    sh(command)
+  end
+
+  task :drop do
+    # File.expand_path is executed directory of generated Rails app
+    rakefile = File.expand_path('Rakefile', 'test/dummy/')
+    command = "rake -f '%s' db:drop" % rakefile
+    sh(command)
+  end
+
+  namespace :test do
+    task :prepare do
+      # File.expand_path is executed directory of generated Rails app
+      rakefile = File.expand_path('Rakefile', 'test/dummy/')
+      command = "rake -f '%s' db:test:prepare" % rakefile
+      sh(command)
+    end
+  end
+end

data/lib/sequenced/generator.rb

@@ -11,7 +11,9 @@ module Sequenced
     end
 
     def set
-      record.send(:"#{column}=", next_id) unless id_set? || skip?
+      return if id_set? || skip?
+      lock_table
+      record.send(:"#{column}=", next_id)
     end
 
     def id_set?
@@ -44,6 +46,17 @@ module Sequenced
 
   private
 
+    def lock_table
+      if postgresql?
+        record.class.connection.execute("LOCK TABLE #{record.class.table_name} IN EXCLUSIVE MODE")
+      end
+    end
+
+    def postgresql?
+      defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter) &&
+        record.class.connection.instance_of?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+    end
+
     def base_relation
       record.class.base_class.unscoped
     end
@@ -67,4 +80,4 @@ module Sequenced
     end
 
   end
-end
+end

data/lib/sequenced/version.rb

@@ -1,3 +1,3 @@
 module Sequenced
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 end

data/sequenced.gemspec

@@ -17,5 +17,4 @@ Gem::Specification.new do |s|
   s.add_dependency "activesupport", ">= 3.0"
   s.add_dependency "activerecord", ">= 3.0"
   s.add_development_dependency "rails", ">= 3.1"
-  s.add_development_dependency "sqlite3"
 end

data/test/concurrency_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+# Test Models:
+#
+#   Answer       - :scope => :question_id
+#   Comment      - :scope => :question_id (with an AR default scope)
+#   Invoice      - :scope => :account_id, :start_at => 1000
+#   Product      - :scope => :account_id, :start_at => lambda { |r| r.computed_start_value }
+#   Order        - :scope => :non_existent_column
+#   User         - :scope => :account_id, :column => :custom_sequential_id
+#   Address      - :scope => :account_id ('sequential_id' does not exist)
+#   Email        - :scope => [:emailable_id, :emailable_type]
+#   Subscription - no options
+#   Rating       - :scope => :comment_id, skip: { |r| r.score == 0 }
+#   Monster      - no options
+#   Zombie       - STI, inherits from Monster
+#   Werewolf     - STI, inherits from Monster
+
+#   ConcurrentBadger - scope: :concurrent_burrow_id,
+#                      NOT NULL constraint on sequential_id,
+#                      UNIQUE constraint on sequential_id within concurrent_burrow_id scope
+
+if ENV['DB'] == 'postgresql'
+  class ConcurrencyTest < ActiveSupport::TestCase
+    self.use_transactional_fixtures = false
+
+    def setup
+      ConcurrentBadger.delete_all
+    end
+
+    def teardown
+      ConcurrentBadger.delete_all
+    end
+
+    test "creates records concurrently without data races" do
+      Thread.abort_on_exception = true
+      range = (1..50)
+
+      threads = []
+      range.each do
+        threads << Thread.new do
+          ConcurrentBadger.create!(burrow_id: 1)
+        end
+      end
+
+      threads.each(&:join)
+
+      sequential_ids = ConcurrentBadger.pluck(:sequential_id)
+      assert_equal range.to_a, sequential_ids
+    end
+
+    test "does not affect saving multiple records within a transaction" do
+      range = (1..10)
+
+      ConcurrentBadger.transaction do
+        range.each do
+          ConcurrentBadger.create!(burrow_id: 1)
+        end
+      end
+
+      sequential_ids = ConcurrentBadger.pluck(:sequential_id)
+      assert_equal range.to_a, sequential_ids
+    end
+
+    test "does not affect saving multiple records within nested transactons" do
+      range = (1..10)
+
+      ConcurrentBadger.transaction do
+        ConcurrentBadger.transaction do
+          ConcurrentBadger.transaction do
+            range.each do
+              ConcurrentBadger.create!(burrow_id: 1)
+            end
+          end
+        end
+      end
+
+      sequential_ids = ConcurrentBadger.pluck(:sequential_id)
+      assert_equal range.to_a, sequential_ids
+    end
+  end
+end

data/test/dummy/app/models/concurrent_badger.rb

@@ -0,0 +1,3 @@
+class ConcurrentBadger < ActiveRecord::Base
+  acts_as_sequenced scope: :burrow_id
+end

data/test/dummy/config/database.yml

@@ -1,25 +1,29 @@
-# SQLite version 3.x
-#   gem install sqlite3
-#
-#   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
-development:
-  adapter: sqlite3
-  database: db/development.sqlite3
-  pool: 5
-  timeout: 5000
-
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
-test:
+# example_travisci_multi/config/database.yml
+sqlite: &sqlite
   adapter: sqlite3
   database: db/test.sqlite3
-  pool: 5
-  timeout: 5000
 
-production:
-  adapter: sqlite3
-  database: db/production.sqlite3
-  pool: 5
+mysql: &mysql
+  adapter: mysql2
+  username: root
+  password:
+
+postgresql: &postgresql
+  adapter: postgresql
+  username: postgres
+  password:
+  min_messages: ERROR
+
+defaults: &defaults
+  pool: 100
   timeout: 5000
+  host: localhost
+  <<: *<%= ENV['DB'] || "sqlite" %>
+
+development:
+  database: sequenced_test
+  <<: *defaults
+
+test:
+  database: sequenced_test
+  <<: *defaults

data/test/dummy/config/environments/development.rb

@@ -22,16 +22,12 @@ Dummy::Application.configure do
   # Only use best-standards-support built into browsers
   config.action_dispatch.best_standards_support = :builtin
 
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
-
-  # Log the query plan for queries taking more than this (works
-  # with SQLite, MySQL, and PostgreSQL)
-  config.active_record.auto_explain_threshold_in_seconds = 0.5
-
   # Do not compress assets
   config.assets.compress = false
 
   # Expands the lines which load the assets
   config.assets.debug = true
+
+  # Required for Rails >= 4.2
+  config.eager_load = true
 end

data/test/dummy/config/environments/test.rb

@@ -35,4 +35,7 @@ Dummy::Application.configure do
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr
+
+  # Required for Rails >= 4.2
+  config.eager_load = true
 end

data/test/dummy/db/migrate/20151120190645_create_concurrent_badgers.rb

@@ -0,0 +1,10 @@
+class CreateConcurrentBadgers < ActiveRecord::Migration
+  def change
+    create_table :concurrent_badgers do |t|
+      t.integer :sequential_id, null: false
+      t.integer :burrow_id
+    end
+
+    add_index :concurrent_badgers, [:sequential_id, :burrow_id], unique: true, name: 'unique_concurrent'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequenced
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Derrick Reimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-24 00:00:00.000000000 Z
+date: 2015-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,20 +52,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  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: Sequenced is a gem that generates scoped sequential IDs for ActiveRecord
   models.
 email:
@@ -81,13 +67,13 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- TODO.md
 - lib/sequenced.rb
 - lib/sequenced/acts_as_sequenced.rb
 - lib/sequenced/generator.rb
 - lib/sequenced/version.rb
 - sequenced.gemspec
 - test/acts_as_sequenced_test.rb
+- test/concurrency_test.rb
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
@@ -100,6 +86,7 @@ files:
 - test/dummy/app/models/address.rb
 - test/dummy/app/models/answer.rb
 - test/dummy/app/models/comment.rb
+- test/dummy/app/models/concurrent_badger.rb
 - test/dummy/app/models/email.rb
 - test/dummy/app/models/invoice.rb
 - test/dummy/app/models/monster.rb
@@ -144,6 +131,7 @@ files:
 - test/dummy/db/migrate/20130730004055_create_products.rb
 - test/dummy/db/migrate/20131226000000_create_monsters.rb
 - test/dummy/db/migrate/20140404195334_create_policemen.rb
+- test/dummy/db/migrate/20151120190645_create_concurrent_badgers.rb
 - test/dummy/db/schema.rb
 - test/dummy/db/test.sqlite3
 - test/dummy/lib/assets/.gitkeep
@@ -182,6 +170,7 @@ specification_version: 4
 summary: Generate scoped sequential IDs for ActiveRecord models
 test_files:
 - test/acts_as_sequenced_test.rb
+- test/concurrency_test.rb
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
@@ -190,6 +179,7 @@ test_files:
 - test/dummy/app/models/address.rb
 - test/dummy/app/models/answer.rb
 - test/dummy/app/models/comment.rb
+- test/dummy/app/models/concurrent_badger.rb
 - test/dummy/app/models/email.rb
 - test/dummy/app/models/invoice.rb
 - test/dummy/app/models/monster.rb
@@ -234,6 +224,7 @@ test_files:
 - test/dummy/db/migrate/20130730004055_create_products.rb
 - test/dummy/db/migrate/20131226000000_create_monsters.rb
 - test/dummy/db/migrate/20140404195334_create_policemen.rb
+- test/dummy/db/migrate/20151120190645_create_concurrent_badgers.rb
 - test/dummy/db/schema.rb
 - test/dummy/db/test.sqlite3
 - test/dummy/log/development.log
@@ -246,3 +237,4 @@ test_files:
 - test/dummy/README.rdoc
 - test/dummy/script/rails
 - test/test_helper.rb
+has_rdoc: 

data/TODO.md

@@ -1,7 +0,0 @@
-TODO
-====
-
-* Add extensions for other ORM/ODMs
-  * Mongoid
-  * Mongomapper
-  * Datamapper