sequenced 2.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2c19db66c935260344abf853e2e1725a7dc9ef4d
-  data.tar.gz: 27bc38c11839f113839eaf23b8f213f677fa9024
+SHA256:
+  metadata.gz: ac1653ef8238785f146ca84e84e967e36d3c7606ce7a0f51bceb9d78103c2b6c
+  data.tar.gz: 57858eab7e36ca6e02ec5f823ef75873284f5841be580629665ce986d7283067
 SHA512:
-  metadata.gz: 1f47927ecd09469be6fc26fb30b9a752a8f94bee42cba8c54c5cb44d4e0fafa328e6c3dad9a69529a20b4461add62e1d6cd14a730230b284db904d8bb97da4be
-  data.tar.gz: 9e9707f1c891f16bd0f30a7f0dc001a6f212b9006ef3294549c5c037da817029d850f52b219872e0ac6d7ad8551a140492b28ca2a3d79cdf52117df465791366
+  metadata.gz: efc18dd491c36c4c2cc0b5057fb91b4cfde57647ada400d6a3f05bd3726eebe4cc0c62e67a24bf533618339f32a7cd149c38c9eee384a629871b58293a4e4c18
+  data.tar.gz: 3fcd11391e68b818818f76178cfdebb9fe6abac44ee104ef0b53351396497840ac5d914485f0b511ae87b0c891c0dfe9435f406e0d9c1399fe0c72f577226328

data/.github/workflows/ci.yml

@@ -0,0 +1,100 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
+jobs:
+  sqlite:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.7', '3.0', '3.1']
+        gemfile:
+          - rails_5_2
+          - rails_6
+          - rails_6_1
+          - rails_7
+          - rails_master
+        exclude:
+          - ruby: '3.0'
+            gemfile: 'rails_5_2'
+          - ruby: '3.1'
+            gemfile: 'rails_5_2'
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+      BUNDLE_PATH_RELATIVE_TO_CWD: true
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: default
+          bundler-cache: true
+
+      - name: StandardRb check
+        run: bundle exec standardrb
+
+      - name: Run tests
+        env:
+          DATABASE_URL: "sqlite3:test"
+          RAILS_ENV: test
+        run: |
+          bundle exec rails db:test:prepare
+          bundle exec rails test
+
+  postgres:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.7', '3.0', '3.1']
+        gemfile:
+          - rails_5_2
+          - rails_6
+          - rails_6_1
+          - rails_7
+          - rails_master
+        exclude:
+          - ruby: '3.0'
+            gemfile: 'rails_5_2'
+          - ruby: '3.1'
+            gemfile: 'rails_5_2'
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+      BUNDLE_PATH_RELATIVE_TO_CWD: true
+
+    services:
+      postgres:
+        image: postgres:12
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: test
+        ports: ['5432:5432']
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: default
+          bundler-cache: true
+
+      - name: StandardRb check
+        run: bundle exec standardrb
+
+      - name: Run tests
+        env:
+          DATABASE_URL: postgres://postgres:password@localhost:5432/test
+          RAILS_ENV: test
+        run: |
+          bundle exec rails db:test:prepare
+          bundle exec rails test

data/Appraisals

@@ -0,0 +1,19 @@
+appraise "rails-5-2" do
+  gem "rails", "~> 5.2.0"
+end
+
+appraise "rails-6" do
+  gem "rails", "~> 6.0.0"
+end
+
+appraise "rails-6-1" do
+  gem "rails", "~> 6.1.0"
+end
+
+appraise "rails-7" do
+  gem "rails", "~> 7.0.0"
+end
+
+appraise "rails-master" do
+  gem "rails", github: "rails/rails", branch: "main"
+end

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+4.0.0 (August 16, 2022)
+------------------------
+
+* Drop official support Ruby 2.6 or older
+* Drop official support Rails 5.1 or older
+* Migrate from Travis CI to GitHub Actions
+* Include Sequenced when ActiveRecord loads ([#52](https://github.com/derrickreimer/sequenced/pull/52))
+
+3.2.0 (January 29, 2020)
+------------------------
+
+* Support non-default primary key columns (set via `primary_key=`) ([#41](https://github.com/derrickreimer/sequenced/pull/41))
+* Fix issue with Postgres adapter check when using a subclassed adapter ([#42](https://github.com/derrickreimer/sequenced/pull/42))
+
+3.1.1 (January 30, 2016)
+-------------------------
+
+* Rails 3 compatibility
+  (samphilipd, [#22](https://github.com/derrickreimer/sequenced/pull/22))
+
+3.1.0 (January 23, 2016)
+-------------------------
+
+* Allow multiple sequences on one record
+  (samphilipd, [#19](https://github.com/derrickreimer/sequenced/pull/19))
+
+3.0.0 (November 28, 2015)
+-------------------------
+
+* Make this gem thread-safe for PostgreSQL
+  (samphilipd, [#16](https://github.com/derrickreimer/sequenced/pull/16))
+
 2.0.0 (October 24, 2014)
 ------------------------
 

data/Gemfile

@@ -1,12 +1,21 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Declare your gem's dependencies in sequenced.gemspec.
 # Bundler will treat runtime dependencies like base dependencies, and
 # development dependencies will be added by default to the :development group.
 gemspec
 
-# jquery-rails is used by the dummy application
-gem "jquery-rails"
+gem "appraisal"
+gem "standardrb"
+
+group :development, :test do
+  gem "sqlite3", "~> 1.4.4"
+  # gem 'mysql2'
+  gem "pg"
+  gem "net-imap"
+  gem "net-pop"
+  gem "net-smtp"
+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

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2011-2014 Derrick Reimer
+Copyright 2012-2020 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

@@ -1,23 +1,23 @@
 # Sequenced
 
-[![Build Status](https://travis-ci.org/djreimer/sequenced.png)](https://travis-ci.org/djreimer/sequenced)
-[![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 
+[![.github/workflows/ci.yml](https://github.com/derrickreimer/sequenced/actions/workflows/ci.yml/badge.svg)](https://github.com/derrickreimer/sequenced/actions/workflows/ci.yml)
+[![Code Climate](https://codeclimate.com/github/djreimer/sequenced.svg)](https://codeclimate.com/github/djreimer/sequenced)
+[![Gem Version](https://badge.fury.io/rb/sequenced.svg)](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
 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,75 @@ class Answer < ActiveRecord::Base
 end
 ```
 
+Multiple sequences can be defined by using the macro multiple times:
+
+```ruby
+class Answer < ActiveRecord::Base
+  belongs_to :account
+  belongs_to :question
+
+  acts_as_sequenced column: :question_answer_number, scope: :question_id
+  acts_as_sequenced column: :account_answer_number, scope: :account_id
+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
+```
+
+If you are adding a sequenced column to an existing table, you need to account for that in your migration.
+
+Here is an example migration that adds and sets the `sequential_id` column based on the current database records:
+```ruby
+# app/db/migrations/20151120190645_add_sequental_id_to_badgers.rb
+class AddSequentalIdToBadgers < ActiveRecord::Migration
+  add_column :badgers, :sequential_id, :integer
+
+  execute <<~SQL
+    UPDATE badgers
+    SET sequential_id = old_badgers.next_sequential_id
+    FROM (
+      SELECT id, ROW_NUMBER()
+      OVER(
+        PARTITION BY burrow_id
+        ORDER BY id
+      ) AS next_sequential_id
+      FROM badgers
+    ) old_badgers
+    WHERE badgers.id = old_badgers.id
+  SQL
+
+  change_column :badgers, :sequential_id, :integer, null: false
+  add_index :badgers, [:sequential_id, :burrow_id], unique: true
+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 +147,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 +176,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,10 +190,10 @@ 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
+    self.sequential_id.to_s
   end
 end
 
@@ -141,48 +204,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

@@ -1,35 +1,59 @@
 #!/usr/bin/env rake
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 begin
-  require 'rdoc/task'
+  require "rdoc/task"
 rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
+  require "rdoc/rdoc"
+  require "rake/rdoctask"
   RDoc::Task = Rake::RDocTask
 end
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Sequenced'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "Sequenced"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 
+task default: :test
 
-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/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "standardrb"
+gem "rails", "~> 5.2.0"
+
+group :development, :test do
+  gem "sqlite3", "~> 1.4.4"
+  gem "pg"
+  gem "net-imap"
+  gem "net-pop"
+  gem "net-smtp"
+end
+
+gemspec path: "../"