├── test ├── dummy │ ├── log │ │ └── .keep │ ├── lib │ │ ├── assets │ │ │ └── .keep │ │ └── tasks │ │ │ └── .keep │ ├── public │ │ ├── favicon.ico │ │ ├── robots.txt │ │ ├── 500.html │ │ ├── 422.html │ │ └── 404.html │ ├── app │ │ └── models │ │ │ ├── post.rb │ │ │ ├── story.rb │ │ │ ├── invoice.rb │ │ │ ├── product.rb │ │ │ └── comment.rb │ ├── bin │ │ ├── rake │ │ ├── bundle │ │ └── rails │ ├── config.ru │ ├── config │ │ ├── initializers │ │ │ ├── session_store.rb │ │ │ ├── filter_parameter_logging.rb │ │ │ ├── mime_types.rb │ │ │ ├── backtrace_silencers.rb │ │ │ ├── wrap_parameters.rb │ │ │ ├── secret_token.rb │ │ │ └── inflections.rb │ │ ├── environment.rb │ │ ├── boot.rb │ │ ├── database.yml │ │ ├── locales │ │ │ └── en.yml │ │ ├── application.rb │ │ ├── environments │ │ │ ├── development.rb │ │ │ ├── test.rb │ │ │ └── production.rb │ │ └── routes.rb │ ├── db │ │ ├── migrate │ │ │ ├── 20131104000033_create_posts.rb │ │ │ ├── 20131104000212_create_invoices.rb │ │ │ ├── 20131104015719_create_stories.rb │ │ │ ├── 20131104003505_create_products.rb │ │ │ ├── 20131104020142_create_comments.rb │ │ │ └── 20131126174222_create_sequential.rb │ │ ├── seeds.rb │ │ └── schema.rb │ ├── Rakefile │ └── README.rdoc ├── test_helper.rb └── sequential_include_test.rb ├── lib ├── sequential │ ├── version.rb │ ├── sequence.rb │ ├── generator.rb │ └── sequential_include.rb ├── sequential.rb └── rails │ └── generators │ └── sequential │ └── setup │ ├── templates │ └── migration.rb │ └── setup_generator.rb ├── .travis.yml ├── Gemfile ├── .gitignore ├── Rakefile ├── LICENSE.md ├── LICENSE.txt ├── README.md └── sequential.gemspec /test/dummy/log/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/dummy/lib/assets/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/dummy/lib/tasks/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/dummy/public/favicon.ico: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /lib/sequential/version.rb: -------------------------------------------------------------------------------- 1 | module Sequential 2 | VERSION = "0.2" 3 | end 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: ruby 2 | rvm: 3 | - 1.9.3 4 | - 2.0.0 5 | - ruby-head 6 | -------------------------------------------------------------------------------- /test/dummy/app/models/post.rb: -------------------------------------------------------------------------------- 1 | class Post < ActiveRecord::Base 2 | 3 | sequential scope: :author_id 4 | 5 | end 6 | -------------------------------------------------------------------------------- /test/dummy/app/models/story.rb: -------------------------------------------------------------------------------- 1 | class Story < ActiveRecord::Base 2 | sequential column: :story_number 3 | end 4 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | # Specify your gem's dependencies in sequential_id.gemspec 4 | gemspec 5 | -------------------------------------------------------------------------------- /test/dummy/bin/rake: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | require_relative '../config/boot' 3 | require 'rake' 4 | Rake.application.run 5 | -------------------------------------------------------------------------------- /test/dummy/app/models/invoice.rb: -------------------------------------------------------------------------------- 1 | class Invoice < ActiveRecord::Base 2 | 3 | sequential scope: :client_id, start_at: 1000 4 | 5 | end 6 | -------------------------------------------------------------------------------- /lib/sequential/sequence.rb: -------------------------------------------------------------------------------- 1 | module Sequential 2 | class Sequence < ActiveRecord::Base 3 | self.table_name = 'sequential' 4 | end 5 | end 6 | -------------------------------------------------------------------------------- /test/dummy/app/models/product.rb: -------------------------------------------------------------------------------- 1 | class Product < ActiveRecord::Base 2 | sequential scope: :category_id, skip: lambda { |p| p.price == -1 } 3 | end 4 | -------------------------------------------------------------------------------- /test/dummy/app/models/comment.rb: -------------------------------------------------------------------------------- 1 | class Comment < ActiveRecord::Base 2 | sequential column: :absolute_number 3 | sequential scope: :post_id 4 | end 5 | -------------------------------------------------------------------------------- /test/dummy/bin/bundle: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__) 3 | load Gem.bin_path('bundler', 'bundle') 4 | -------------------------------------------------------------------------------- /test/dummy/bin/rails: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | APP_PATH = File.expand_path('../../config/application', __FILE__) 3 | require_relative '../config/boot' 4 | require 'rails/commands' 5 | -------------------------------------------------------------------------------- /test/dummy/config.ru: -------------------------------------------------------------------------------- 1 | # This file is used by Rack-based servers to start the application. 2 | # 3 | require ::File.expand_path('../config/environment', __FILE__) 4 | run Rails.application 5 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/session_store.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | Dummy::Application.config.session_store :cookie_store, key: '_dummy_session' 4 | -------------------------------------------------------------------------------- /test/dummy/config/environment.rb: -------------------------------------------------------------------------------- 1 | # Load the Rails application. 2 | require File.expand_path('../application', __FILE__) 3 | 4 | # Initialize the Rails application. 5 | Dummy::Application.initialize! 6 | -------------------------------------------------------------------------------- /lib/sequential.rb: -------------------------------------------------------------------------------- 1 | require 'sequential/version' 2 | require 'sequential/generator' 3 | require 'sequential/sequential_include' 4 | require 'sequential/sequence' 5 | 6 | ActiveRecord::Base.send(:include, Sequential::SequentialInclude) 7 | -------------------------------------------------------------------------------- /test/dummy/config/boot.rb: -------------------------------------------------------------------------------- 1 | require 'rubygems' 2 | gemfile = File.expand_path('../../../../Gemfile', __FILE__) 3 | 4 | if File.exist?(gemfile) 5 | ENV['BUNDLE_GEMFILE'] = gemfile 6 | require 'bundler' 7 | Bundler.setup 8 | end 9 | -------------------------------------------------------------------------------- /test/dummy/db/migrate/20131104000033_create_posts.rb: -------------------------------------------------------------------------------- 1 | class CreatePosts < ActiveRecord::Migration 2 | def change 3 | create_table :posts do |t| 4 | t.integer :author_id 5 | t.integer :sequential_id 6 | end 7 | end 8 | end 9 | -------------------------------------------------------------------------------- /test/dummy/public/robots.txt: -------------------------------------------------------------------------------- 1 | # See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file 2 | # 3 | # To ban all spiders from the entire site uncomment the next two lines: 4 | # User-agent: * 5 | # Disallow: / 6 | -------------------------------------------------------------------------------- /test/dummy/db/migrate/20131104000212_create_invoices.rb: -------------------------------------------------------------------------------- 1 | class CreateInvoices < ActiveRecord::Migration 2 | def change 3 | create_table :invoices do |t| 4 | t.integer :client_id 5 | t.integer :sequential_id 6 | end 7 | end 8 | end 9 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/filter_parameter_logging.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Configure sensitive parameters which will be filtered from the log file. 4 | Rails.application.config.filter_parameters += [:password] 5 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/mime_types.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Add new mime types for use in respond_to blocks: 4 | # Mime::Type.register "text/richtext", :rtf 5 | # Mime::Type.register_alias "text/html", :iphone 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.gem 2 | *.rbc 3 | .bundle 4 | .config 5 | .yardoc 6 | Gemfile.lock 7 | InstalledFiles 8 | _yardoc 9 | coverage 10 | doc/ 11 | lib/bundler/man 12 | pkg 13 | rdoc 14 | spec/reports 15 | test/tmp 16 | test/version_tmp 17 | test/dummy/db/*.sqlite3 18 | tmp 19 | -------------------------------------------------------------------------------- /test/dummy/db/migrate/20131104015719_create_stories.rb: -------------------------------------------------------------------------------- 1 | class CreateStories < ActiveRecord::Migration 2 | def change 3 | create_table :stories do |t| 4 | t.string :title 5 | t.integer :story_number 6 | 7 | t.timestamps 8 | end 9 | end 10 | end 11 | -------------------------------------------------------------------------------- /test/dummy/Rakefile: -------------------------------------------------------------------------------- 1 | # Add your own tasks in files placed in lib/tasks ending in .rake, 2 | # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake. 3 | 4 | require File.expand_path('../config/application', __FILE__) 5 | 6 | Dummy::Application.load_tasks 7 | -------------------------------------------------------------------------------- /test/dummy/db/migrate/20131104003505_create_products.rb: -------------------------------------------------------------------------------- 1 | class CreateProducts < ActiveRecord::Migration 2 | def change 3 | create_table :products do |t| 4 | t.integer :price 5 | t.integer :sequential_id 6 | t.integer :category_id 7 | t.timestamps 8 | end 9 | end 10 | end 11 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require "bundler/gem_tasks" 2 | 3 | Bundler::GemHelper.install_tasks 4 | 5 | require 'rake/testtask' 6 | 7 | Rake::TestTask.new(:test) do |t| 8 | t.libs << 'lib' 9 | t.libs << 'test' 10 | t.pattern = 'test/**/*_test.rb' 11 | t.verbose = false 12 | end 13 | 14 | 15 | task :default => :test 16 | -------------------------------------------------------------------------------- /test/dummy/db/migrate/20131104020142_create_comments.rb: -------------------------------------------------------------------------------- 1 | class CreateComments < ActiveRecord::Migration 2 | def change 3 | create_table :comments do |t| 4 | t.string :title 5 | t.integer :absolute_number 6 | t.integer :sequential_id 7 | t.integer :post_id 8 | 9 | t.timestamps 10 | end 11 | end 12 | end 13 | -------------------------------------------------------------------------------- /test/dummy/db/seeds.rb: -------------------------------------------------------------------------------- 1 | # This file should contain all the record creation needed to seed the database with its default values. 2 | # The data can then be loaded with the rake db:seed (or created alongside the db with db:setup). 3 | # 4 | # Examples: 5 | # 6 | # cities = City.create([{ name: 'Chicago' }, { name: 'Copenhagen' }]) 7 | # Mayor.create(name: 'Emanuel', city: cities.first) 8 | -------------------------------------------------------------------------------- /test/dummy/db/migrate/20131126174222_create_sequential.rb: -------------------------------------------------------------------------------- 1 | class CreateSequential < ActiveRecord::Migration 2 | def change 3 | create_table(:sequential) do |t| 4 | t.string :model 5 | t.string :column 6 | t.string :scope 7 | t.string :scope_value 8 | t.integer :value 9 | t.timestamps 10 | end 11 | 12 | add_index :sequential, [:model, :column, :scope, :scope_value], unique: true 13 | end 14 | end 15 | -------------------------------------------------------------------------------- /lib/rails/generators/sequential/setup/templates/migration.rb: -------------------------------------------------------------------------------- 1 | class CreateSequential < ActiveRecord::Migration 2 | def change 3 | create_table(:sequential) do |t| 4 | t.string :model 5 | t.string :column 6 | t.string :scope 7 | t.string :scope_value 8 | t.integer :value 9 | t.timestamps 10 | end 11 | 12 | add_index :sequential, [:model, :column, :scope, :scope_value], unique: true 13 | end 14 | end 15 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/backtrace_silencers.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces. 4 | # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ } 5 | 6 | # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code. 7 | # Rails.backtrace_cleaner.remove_silencers! 8 | -------------------------------------------------------------------------------- /test/test_helper.rb: -------------------------------------------------------------------------------- 1 | #Configure Rails Environment 2 | ENV['RAILS_ENV'] = 'test' 3 | ENV['RAILS_ROOT'] = File.expand_path('../dummy', __FILE__) 4 | 5 | require File.expand_path('../dummy/config/environment.rb', __FILE__) 6 | require 'rails/test_help' 7 | require 'rails/generators' 8 | Rails.backtrace_cleaner.remove_silencers! 9 | 10 | ActiveRecord::Migrator.migrate(File.expand_path('../dummy/db/migrate/', __FILE__)) 11 | 12 | # Load support files 13 | Dir['#{File.dirname(__FILE__)}/support/**/*.rb'].each { |f| require f } 14 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/wrap_parameters.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # This file contains settings for ActionController::ParamsWrapper which 4 | # is enabled by default. 5 | 6 | # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array. 7 | ActiveSupport.on_load(:action_controller) do 8 | wrap_parameters format: [:json] if respond_to?(:wrap_parameters) 9 | end 10 | 11 | # To enable root element in JSON for ActiveRecord objects. 12 | # ActiveSupport.on_load(:active_record) do 13 | # self.include_root_in_json = true 14 | # end 15 | -------------------------------------------------------------------------------- /test/dummy/README.rdoc: -------------------------------------------------------------------------------- 1 | == README 2 | 3 | This README would normally document whatever steps are necessary to get the 4 | application up and running. 5 | 6 | Things you may want to cover: 7 | 8 | * Ruby version 9 | 10 | * System dependencies 11 | 12 | * Configuration 13 | 14 | * Database creation 15 | 16 | * Database initialization 17 | 18 | * How to run the test suite 19 | 20 | * Services (job queues, cache servers, search engines, etc.) 21 | 22 | * Deployment instructions 23 | 24 | * ... 25 | 26 | 27 | Please feel free to use a different markup language if you do not plan to run 28 | rake doc:app. 29 | -------------------------------------------------------------------------------- /lib/rails/generators/sequential/setup/setup_generator.rb: -------------------------------------------------------------------------------- 1 | require 'rails/generators/active_record' 2 | 3 | module Sequential 4 | module Generators 5 | class SetupGenerator < ActiveRecord::Generators::Base 6 | 7 | # Ignore the required name param 8 | argument :name, type: :string, default: 'random_name' 9 | 10 | desc 'Creates a migration to create the sequential table' 11 | 12 | source_root File.expand_path("../templates", __FILE__) 13 | 14 | def create_migration 15 | migration_template "migration.rb", "db/migrate/create_sequential.rb" 16 | end 17 | end 18 | end 19 | end 20 | -------------------------------------------------------------------------------- /test/dummy/config/database.yml: -------------------------------------------------------------------------------- 1 | # SQLite version 3.x 2 | # gem install sqlite3 3 | # 4 | # Ensure the SQLite 3 gem is defined in your Gemfile 5 | # gem 'sqlite3' 6 | development: 7 | adapter: sqlite3 8 | database: db/development.sqlite3 9 | pool: 5 10 | timeout: 5000 11 | 12 | # Warning: The database defined as "test" will be erased and 13 | # re-generated from your development database when you run "rake". 14 | # Do not set this db to the same as development or production. 15 | test: 16 | adapter: sqlite3 17 | database: db/test.sqlite3 18 | pool: 5 19 | timeout: 5000 20 | 21 | production: 22 | adapter: sqlite3 23 | database: db/production.sqlite3 24 | pool: 5 25 | timeout: 5000 26 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/secret_token.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Your secret key is used for verifying the integrity of signed cookies. 4 | # If you change this key, all old signed cookies will become invalid! 5 | 6 | # Make sure the secret is at least 30 characters and all random, 7 | # no regular words or you'll be exposed to dictionary attacks. 8 | # You can use `rake secret` to generate a secure secret key. 9 | 10 | # Make sure your secret_key_base is kept private 11 | # if you're sharing your code publicly. 12 | Dummy::Application.config.secret_key_base = '892235de5e5c09d117a4e66e63f059e8ebddd9baa2ae3bae1ad1eedb1921e938c4a1f48ff5ecf4b56b31162e5e58a834629832fdc16dea3aa465ba53336bafb2' 13 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/inflections.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Add new inflection rules using the following format. Inflections 4 | # are locale specific, and you may define rules for as many different 5 | # locales as you wish. All of these examples are active by default: 6 | # ActiveSupport::Inflector.inflections(:en) do |inflect| 7 | # inflect.plural /^(ox)$/i, '\1en' 8 | # inflect.singular /^(ox)en/i, '\1' 9 | # inflect.irregular 'person', 'people' 10 | # inflect.uncountable %w( fish sheep ) 11 | # end 12 | 13 | # These inflection rules are supported but not enabled by default: 14 | # ActiveSupport::Inflector.inflections(:en) do |inflect| 15 | # inflect.acronym 'RESTful' 16 | # end 17 | -------------------------------------------------------------------------------- /test/dummy/config/locales/en.yml: -------------------------------------------------------------------------------- 1 | # Files in the config/locales directory are used for internationalization 2 | # and are automatically loaded by Rails. If you want to use locales other 3 | # than English, add the necessary files in this directory. 4 | # 5 | # To use the locales, use `I18n.t`: 6 | # 7 | # I18n.t 'hello' 8 | # 9 | # In views, this is aliased to just `t`: 10 | # 11 | # <%= t('hello') %> 12 | # 13 | # To use a different locale, set it with `I18n.locale`: 14 | # 15 | # I18n.locale = :es 16 | # 17 | # This would use the information in config/locales/es.yml. 18 | # 19 | # To learn more, please read the Rails Internationalization guide 20 | # available at http://guides.rubyonrails.org/i18n.html. 21 | 22 | en: 23 | hello: "Hello world" 24 | -------------------------------------------------------------------------------- /test/dummy/config/application.rb: -------------------------------------------------------------------------------- 1 | require File.expand_path('../boot', __FILE__) 2 | 3 | require 'rails/all' 4 | 5 | Bundler.require 6 | require 'sequential' 7 | 8 | # Require the gems listed in Gemfile, including any gems 9 | # you've limited to :test, :development, or :production. 10 | #Bundler.require(:default, Rails.env) 11 | 12 | module Dummy 13 | class Application < Rails::Application 14 | # Settings in config/environments/* take precedence over those specified here. 15 | # Application configuration should go into files in config/initializers 16 | # -- all .rb files in that directory are automatically loaded. 17 | 18 | # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone. 19 | # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC. 20 | # config.time_zone = 'Central Time (US & Canada)' 21 | 22 | # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded. 23 | # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s] 24 | # config.i18n.default_locale = :de 25 | end 26 | end 27 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) [year] [fullname] 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of 6 | this software and associated documentation files (the "Software"), to deal in 7 | the Software without restriction, including without limitation the rights to 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software is furnished to do so, 10 | subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Copyright (c) 2013 Austin Lin 2 | 3 | MIT License 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining 6 | a copy of this software and associated documentation files (the 7 | "Software"), to deal in the Software without restriction, including 8 | without limitation the rights to use, copy, modify, merge, publish, 9 | distribute, sublicense, and/or sell copies of the Software, and to 10 | permit persons to whom the Software is furnished to do so, subject to 11 | the following conditions: 12 | 13 | The above copyright notice and this permission notice shall be 14 | included in all copies or substantial portions of the Software. 15 | 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 19 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 20 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 22 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 23 | -------------------------------------------------------------------------------- /lib/sequential/generator.rb: -------------------------------------------------------------------------------- 1 | module Sequential 2 | class Generator 3 | attr_reader :record, :scope, :column, :start_at, :skip 4 | 5 | def initialize(record, options = {}) 6 | @record = record 7 | @scope = options[:scope] 8 | @column = (options[:column] || :sequential_id).to_sym 9 | @start_at = options[:start_at] || 1 10 | @skip = options[:skip] 11 | end 12 | 13 | def set 14 | unless id_set? || skip? 15 | where_opts = { 16 | model: record.class.name, 17 | column: column 18 | } 19 | 20 | where_opts.merge!( scope: scope.to_s, 21 | scope_value: record.send(scope.to_sym).to_s, 22 | ) if scope 23 | 24 | sequence = Sequential::Sequence.where(where_opts). 25 | first_or_create(value: start_at - 1) 26 | 27 | sequence.with_lock do 28 | sequence.value += 1 29 | record.send(:"#{column}=", sequence.value) 30 | sequence.save 31 | end 32 | end 33 | end 34 | 35 | def id_set? 36 | !record.send(column).nil? 37 | end 38 | 39 | def skip? 40 | skip && skip.call(record) 41 | end 42 | end 43 | end 44 | -------------------------------------------------------------------------------- /test/dummy/config/environments/development.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb. 3 | 4 | # In the development environment your application's code is reloaded on 5 | # every request. This slows down response time but is perfect for development 6 | # since you don't have to restart the web server when you make code changes. 7 | config.cache_classes = false 8 | 9 | # Do not eager load code on boot. 10 | config.eager_load = false 11 | 12 | # Show full error reports and disable caching. 13 | config.consider_all_requests_local = true 14 | config.action_controller.perform_caching = false 15 | 16 | # Don't care if the mailer can't send. 17 | config.action_mailer.raise_delivery_errors = false 18 | 19 | # Print deprecation notices to the Rails logger. 20 | config.active_support.deprecation = :log 21 | 22 | # Raise an error on page load if there are pending migrations 23 | config.active_record.migration_error = :page_load 24 | 25 | # Debug mode disables concatenation and preprocessing of assets. 26 | # This option may cause significant delays in view rendering with a large 27 | # number of complex assets. 28 | config.assets.debug = true 29 | end 30 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Sequential 2 | [![Build Status](https://travis-ci.org/austinylin/sequential.png?branch=master)](https://travis-ci.org/austinylin/sequential) 3 | 4 | Generates scoped, threadsafe sequences for ActiveRecord models. 5 | 6 | Based on [Sequenced](https://github.com/djreimer/sequenced) by 7 | [Derrick Reimer](https://github.com/djreimer) 8 | 9 | ## Installation 10 | 11 | Add this line to your application's Gemfile: 12 | 13 | gem 'sequential' 14 | 15 | And then execute: 16 | 17 | $ bundle 18 | 19 | Or install it yourself as: 20 | 21 | $ gem install sequential 22 | 23 | ## Usage 24 | 25 | Setup the database table: 26 | 27 | rails g sequential:setup 28 | 29 | Add a column to your model to hold the sequence (by default sequential_id) 30 | , in a migration: 31 | 32 | add_column :model_name, :sequential_id, :integer 33 | 34 | Then run the migrations: 35 | 36 | rake db:migrate 37 | 38 | Now add the following to your model: 39 | 40 | sequential scope: :name_of_attribute_to_scope_on 41 | 42 | ## Contributing 43 | 44 | 1. Fork it 45 | 2. Create your feature branch (`git checkout -b my-new-feature`) 46 | 3. Commit your changes (`git commit -am 'Add some feature'`) 47 | 4. Push to the branch (`git push origin my-new-feature`) 48 | 5. Create new Pull Request 49 | -------------------------------------------------------------------------------- /sequential.gemspec: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | lib = File.expand_path('../lib', __FILE__) 3 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) 4 | require 'sequential/version' 5 | 6 | Gem::Specification.new do |spec| 7 | spec.name = "sequential" 8 | spec.version = Sequential::VERSION 9 | spec.authors = ["Austin Lin", "Shalev NessAiver"] 10 | spec.email = ["austin@austinylin.com", "pugiox@gmail.com"] 11 | spec.description = %q{Generates scoped, threadsafe sequences for 12 | ActiveRecord models} 13 | spec.summary = %q{Sequential enables the use of scoped, threadsafe 14 | sequences for ActiveRecord models using a 15 | seperate sequence table and row-level locking} 16 | spec.homepage = "" 17 | spec.license = "MIT" 18 | 19 | spec.files = `git ls-files`.split($/) 20 | spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) } 21 | spec.test_files = spec.files.grep(%r{^(test|spec|features)/}) 22 | spec.require_paths = ["lib"] 23 | 24 | spec.add_development_dependency "bundler", "~> 1.3" 25 | spec.add_development_dependency "rake" 26 | spec.add_development_dependency "rails", ">= 4.0" 27 | spec.add_development_dependency "sqlite3" 28 | end 29 | -------------------------------------------------------------------------------- /test/dummy/public/500.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | We're sorry, but something went wrong (500) 5 | 48 | 49 | 50 | 51 | 52 |
53 |

We're sorry, but something went wrong.

54 |
55 |

If you are the application owner check the logs for more information.

56 | 57 | 58 | -------------------------------------------------------------------------------- /test/dummy/public/422.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The change you wanted was rejected (422) 5 | 48 | 49 | 50 | 51 | 52 |
53 |

The change you wanted was rejected.

54 |

Maybe you tried to change something you didn't have access to.

55 |
56 |

If you are the application owner check the logs for more information.

57 | 58 | 59 | -------------------------------------------------------------------------------- /test/dummy/public/404.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The page you were looking for doesn't exist (404) 5 | 48 | 49 | 50 | 51 | 52 |
53 |

The page you were looking for doesn't exist.

54 |

You may have mistyped the address or the page may have moved.

55 |
56 |

If you are the application owner check the logs for more information.

57 | 58 | 59 | -------------------------------------------------------------------------------- /test/dummy/config/environments/test.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb. 3 | 4 | # The test environment is used exclusively to run your application's 5 | # test suite. You never need to work with it otherwise. Remember that 6 | # your test database is "scratch space" for the test suite and is wiped 7 | # and recreated between test runs. Don't rely on the data there! 8 | config.cache_classes = true 9 | 10 | # Do not eager load code on boot. This avoids loading your whole application 11 | # just for the purpose of running a single test. If you are using a tool that 12 | # preloads Rails for running tests, you may have to set it to true. 13 | config.eager_load = false 14 | 15 | # Configure static asset server for tests with Cache-Control for performance. 16 | config.serve_static_assets = true 17 | config.static_cache_control = "public, max-age=3600" 18 | 19 | # Show full error reports and disable caching. 20 | config.consider_all_requests_local = true 21 | config.action_controller.perform_caching = false 22 | 23 | # Raise exceptions instead of rendering exception templates. 24 | config.action_dispatch.show_exceptions = false 25 | 26 | # Disable request forgery protection in test environment. 27 | config.action_controller.allow_forgery_protection = false 28 | 29 | # Tell Action Mailer not to deliver emails to the real world. 30 | # The :test delivery method accumulates sent emails in the 31 | # ActionMailer::Base.deliveries array. 32 | config.action_mailer.delivery_method = :test 33 | 34 | # Print deprecation notices to the stderr. 35 | config.active_support.deprecation = :stderr 36 | end 37 | -------------------------------------------------------------------------------- /test/dummy/config/routes.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.routes.draw do 2 | # The priority is based upon order of creation: first created -> highest priority. 3 | # See how all your routes lay out with "rake routes". 4 | 5 | # You can have the root of your site routed with "root" 6 | # root 'welcome#index' 7 | 8 | # Example of regular route: 9 | # get 'products/:id' => 'catalog#view' 10 | 11 | # Example of named route that can be invoked with purchase_url(id: product.id) 12 | # get 'products/:id/purchase' => 'catalog#purchase', as: :purchase 13 | 14 | # Example resource route (maps HTTP verbs to controller actions automatically): 15 | # resources :products 16 | 17 | # Example resource route with options: 18 | # resources :products do 19 | # member do 20 | # get 'short' 21 | # post 'toggle' 22 | # end 23 | # 24 | # collection do 25 | # get 'sold' 26 | # end 27 | # end 28 | 29 | # Example resource route with sub-resources: 30 | # resources :products do 31 | # resources :comments, :sales 32 | # resource :seller 33 | # end 34 | 35 | # Example resource route with more complex sub-resources: 36 | # resources :products do 37 | # resources :comments 38 | # resources :sales do 39 | # get 'recent', on: :collection 40 | # end 41 | # end 42 | 43 | # Example resource route with concerns: 44 | # concern :toggleable do 45 | # post 'toggle' 46 | # end 47 | # resources :posts, concerns: :toggleable 48 | # resources :photos, concerns: :toggleable 49 | 50 | # Example resource route within a namespace: 51 | # namespace :admin do 52 | # # Directs /admin/products/* to Admin::ProductsController 53 | # # (app/controllers/admin/products_controller.rb) 54 | # resources :products 55 | # end 56 | end 57 | -------------------------------------------------------------------------------- /lib/sequential/sequential_include.rb: -------------------------------------------------------------------------------- 1 | require 'active_support/core_ext/hash/slice' 2 | require 'active_support/core_ext/module/attribute_accessors' 3 | 4 | module Sequential 5 | module SequentialInclude 6 | def self.included(base) 7 | base.extend ClassMethods 8 | end 9 | 10 | module ClassMethods 11 | # Public: Defines ActiveRecord callbacks to set a sequential ID scoped 12 | # on a specific class. 13 | # 14 | # options - The Hash of options for configuration: 15 | # :scope - The Symbol representing the columm on which the 16 | # sequence should be scoped (default: nil) 17 | # :column - The Symbol representing the column that stores the 18 | # sequence (default: :sequential_id) 19 | # :start_at - The Integer value at which the sequence should 20 | # start (default: 1) 21 | # :skip - Skips the sequence generation when the lambda 22 | # expression evaluates to nil. Gets passed the 23 | # model object 24 | # 25 | # Examples 26 | # 27 | # class Answer < ActiveRecord::Base 28 | # belongs_to :question 29 | # sequential scope: :question_id 30 | # end 31 | # 32 | # Returns nothing. 33 | def sequential(options = {}) 34 | cattr_accessor :sequence_options 35 | 36 | (self.sequence_options ||= []) << options 37 | 38 | before_create :set_sequential_values 39 | 40 | include Sequential::SequentialInclude::InstanceMethods 41 | end 42 | end 43 | 44 | module InstanceMethods 45 | def set_sequential_values 46 | self.sequence_options.each do |seq_opts| 47 | Sequential::Generator.new(self, seq_opts).set 48 | end 49 | end 50 | end 51 | end 52 | end 53 | -------------------------------------------------------------------------------- /test/dummy/db/schema.rb: -------------------------------------------------------------------------------- 1 | # encoding: UTF-8 2 | # This file is auto-generated from the current state of the database. Instead 3 | # of editing this file, please use the migrations feature of Active Record to 4 | # incrementally modify your database, and then regenerate this schema definition. 5 | # 6 | # Note that this schema.rb definition is the authoritative source for your 7 | # database schema. If you need to create the application database on another 8 | # system, you should be using db:schema:load, not running all the migrations 9 | # from scratch. The latter is a flawed and unsustainable approach (the more migrations 10 | # you'll amass, the slower it'll run and the greater likelihood for issues). 11 | # 12 | # It's strongly recommended that you check this file into your version control system. 13 | 14 | ActiveRecord::Schema.define(version: 20131126174222) do 15 | 16 | create_table "comments", force: true do |t| 17 | t.string "title" 18 | t.integer "absolute_number" 19 | t.integer "sequential_id" 20 | t.integer "post_id" 21 | t.datetime "created_at" 22 | t.datetime "updated_at" 23 | end 24 | 25 | create_table "invoices", force: true do |t| 26 | t.integer "client_id" 27 | t.integer "sequential_id" 28 | end 29 | 30 | create_table "posts", force: true do |t| 31 | t.integer "author_id" 32 | t.integer "sequential_id" 33 | end 34 | 35 | create_table "products", force: true do |t| 36 | t.integer "price" 37 | t.integer "sequential_id" 38 | t.integer "category_id" 39 | t.datetime "created_at" 40 | t.datetime "updated_at" 41 | end 42 | 43 | create_table "sequential", force: true do |t| 44 | t.string "model" 45 | t.string "column" 46 | t.string "scope" 47 | t.string "scope_value" 48 | t.integer "value" 49 | t.datetime "created_at" 50 | t.datetime "updated_at" 51 | end 52 | 53 | add_index "sequential", ["model", "column", "scope", "scope_value"], name: "index_sequential_on_model_and_column_and_scope_and_scope_value", unique: true 54 | 55 | create_table "stories", force: true do |t| 56 | t.string "title" 57 | t.integer "story_number" 58 | t.datetime "created_at" 59 | t.datetime "updated_at" 60 | end 61 | 62 | end 63 | -------------------------------------------------------------------------------- /test/sequential_include_test.rb: -------------------------------------------------------------------------------- 1 | require 'test_helper' 2 | 3 | # Test Models: 4 | # 5 | # Post - scope: :author_id 6 | # Invoice - scope: :client_id, start_at: 1000 7 | # Product - scope: :category_id, skip: lambda { |p| p.price == -1 } 8 | # Story - column: :story_number 9 | # Comment - column: :absolute_number | scope: :post_id 10 | 11 | 12 | class SequentialIncludeTest < ActiveSupport::TestCase 13 | test 'basic scoped operation' do 14 | p = Post.create(author_id: 1) 15 | assert_equal 1, p.sequential_id 16 | 17 | p = Post.create(author_id: 1) 18 | assert_equal 2, p.sequential_id 19 | 20 | p = Post.create(author_id: 2) 21 | assert_equal 1, p.sequential_id 22 | end 23 | 24 | test 'start_at' do 25 | i = Invoice.create(client_id: 1) 26 | assert_equal 1000, i.sequential_id 27 | 28 | i = Invoice.create(client_id: 1) 29 | assert_equal 1001, i.sequential_id 30 | 31 | i = Invoice.create(client_id: 2) 32 | assert_equal 1000, i.sequential_id 33 | end 34 | 35 | test 'skip' do 36 | p = Product.create(category_id: 1) 37 | assert_equal 1, p.sequential_id 38 | 39 | p = Product.create(category_id: 1) 40 | assert_equal 2, p.sequential_id 41 | 42 | p = Product.create(category_id: 1, price: -1) 43 | assert_nil p.sequential_id 44 | sequence = Sequential::Sequence.where( 45 | model: 'Product', 46 | scope: 'category_id', 47 | scope_value: 1 48 | ).first.value 49 | assert_equal 2, sequence 50 | 51 | p = Product.create(category_id: 2) 52 | assert_equal 1, p.sequential_id 53 | end 54 | 55 | test 'custom sequential column' do 56 | s = Story.create 57 | assert_equal 1, s.story_number 58 | 59 | s = Story.create 60 | assert_equal 2, s.story_number 61 | end 62 | 63 | test 'multiple sequential columns' do 64 | c = Comment.create(post_id: 1) 65 | assert_equal 1, c.absolute_number 66 | assert_equal 1, c.sequential_id 67 | 68 | c = Comment.create(post_id: 1) 69 | assert_equal 2, c.absolute_number 70 | assert_equal 2, c.sequential_id 71 | 72 | c = Comment.create(post_id: 2) 73 | assert_equal 3, c.absolute_number 74 | assert_equal 1, c.sequential_id 75 | end 76 | 77 | end 78 | -------------------------------------------------------------------------------- /test/dummy/config/environments/production.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb. 3 | 4 | # Code is not reloaded between requests. 5 | config.cache_classes = true 6 | 7 | # Eager load code on boot. This eager loads most of Rails and 8 | # your application in memory, allowing both thread web servers 9 | # and those relying on copy on write to perform better. 10 | # Rake tasks automatically ignore this option for performance. 11 | config.eager_load = true 12 | 13 | # Full error reports are disabled and caching is turned on. 14 | config.consider_all_requests_local = false 15 | config.action_controller.perform_caching = true 16 | 17 | # Enable Rack::Cache to put a simple HTTP cache in front of your application 18 | # Add `rack-cache` to your Gemfile before enabling this. 19 | # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid. 20 | # config.action_dispatch.rack_cache = true 21 | 22 | # Disable Rails's static asset server (Apache or nginx will already do this). 23 | config.serve_static_assets = false 24 | 25 | # Compress JavaScripts and CSS. 26 | config.assets.js_compressor = :uglifier 27 | # config.assets.css_compressor = :sass 28 | 29 | # Do not fallback to assets pipeline if a precompiled asset is missed. 30 | config.assets.compile = false 31 | 32 | # Generate digests for assets URLs. 33 | config.assets.digest = true 34 | 35 | # Version of your assets, change this if you want to expire all your assets. 36 | config.assets.version = '1.0' 37 | 38 | # Specifies the header that your server uses for sending files. 39 | # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache 40 | # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx 41 | 42 | # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. 43 | # config.force_ssl = true 44 | 45 | # Set to :debug to see everything in the log. 46 | config.log_level = :info 47 | 48 | # Prepend all log lines with the following tags. 49 | # config.log_tags = [ :subdomain, :uuid ] 50 | 51 | # Use a different logger for distributed setups. 52 | # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new) 53 | 54 | # Use a different cache store in production. 55 | # config.cache_store = :mem_cache_store 56 | 57 | # Enable serving of images, stylesheets, and JavaScripts from an asset server. 58 | # config.action_controller.asset_host = "http://assets.example.com" 59 | 60 | # Precompile additional assets. 61 | # application.js, application.css, and all non-JS/CSS in app/assets folder are already added. 62 | # config.assets.precompile += %w( search.js ) 63 | 64 | # Ignore bad email addresses and do not raise email delivery errors. 65 | # Set this to true and configure the email server for immediate delivery to raise delivery errors. 66 | # config.action_mailer.raise_delivery_errors = false 67 | 68 | # Enable locale fallbacks for I18n (makes lookups for any locale fall back to 69 | # the I18n.default_locale when a translation can not be found). 70 | config.i18n.fallbacks = true 71 | 72 | # Send deprecation notices to registered listeners. 73 | config.active_support.deprecation = :notify 74 | 75 | # Disable automatic flushing of the log to improve performance. 76 | # config.autoflush_log = false 77 | 78 | # Use default logging formatter so that PID and timestamp are not suppressed. 79 | config.log_formatter = ::Logger::Formatter.new 80 | end 81 | --------------------------------------------------------------------------------