sequential 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2609635efbc3447c71e04d663d263f6359cf21ac
+  data.tar.gz: 4f44c9a6b326c602bf1d7e99b11738a74c98f1dc
+SHA512:
+  metadata.gz: 18e757fc87760ab370031dc490729c24e352fb5fa22f16476c9cd7d8b3132f66202a07292d90758674f42157158ff6ef2bf1ac1506f6e2b75f07ce1a29fff3a6
+  data.tar.gz: c4d5d2045688e0ae4207b610eab9fd3d5a8ced3c04701dc660306b2d70ba0c15483a35415950a6ea67602bce9800b4744cae125c0515df3402384809852f071f

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sequential_id.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) [year] [fullname]
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Austin Lin
+
+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,48 @@
+# Sequential
+[![Build Status](https://travis-ci.org/austinylin/sequential.png?branch=master)](https://travis-ci.org/austinylin/sequential)
+
+Generates scoped, threadsafe sequences for ActiveRecord models.
+
+Based on [Sequenced](https://github.com/djreimer/sequenced) by 
+[Derrick Reimer](https://github.com/djreimer)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sequential'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequential
+
+## Usage
+
+Setup the database table:
+
+    rails g sequential:setup
+
+Add a column to your model to hold the sequence (by default sequential_id)
+, in a migration:
+
+    add_column :model_name, :sequential_id, :integer
+
+Then run the migrations:
+
+    rake db:migrate
+
+Now add the following to your model:
+
+    sequential scope: :name_of_attribute_to_scope_on
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/rails/generators/sequential/setup/setup_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators/active_record'
+
+module Sequential
+  module Generators
+    class SetupGenerator < ActiveRecord::Generators::Base
+
+      # Ignore the required name param
+      argument :name, type: :string, default: 'random_name'
+      
+      desc 'Creates a migration to create the sequential table'
+
+      source_root File.expand_path("../templates", __FILE__)
+ 
+      def create_migration 
+        migration_template "migration.rb", "db/migrate/create_sequential.rb"
+      end
+    end
+  end
+end

data/lib/rails/generators/sequential/setup/templates/migration.rb

@@ -0,0 +1,12 @@
+class CreateSequential < ActiveRecord::Migration
+  def change
+    create_table(:sequential) do |t|
+      t.string  :model
+      t.string  :column
+      t.string  :scope
+      t.integer :scope_value
+      t.integer :value
+      t.timestamps
+    end
+  end
+end

data/lib/sequential/generator.rb

@@ -0,0 +1,43 @@
+module Sequential
+  class Generator
+    attr_reader :record, :scope, :column, :start_at, :skip
+
+    def initialize(record, options = {})
+      @record   = record
+      @scope    = options[:scope]
+      @column   = (options[:column] || :sequential_id).to_sym
+      @start_at = options[:start_at] || 1
+      @skip     = options[:skip]
+    end
+
+    def set
+      unless id_set? || skip?
+        where_opts = {
+          model:  record.class.name,
+          column: column
+        }
+
+        where_opts.merge!(  scope: scope.to_s,
+                            scope_value: record.send(scope.to_sym),
+                         ) if scope
+
+        sequence = Sequential::Sequence.where(where_opts).
+                                          first_or_create(value: start_at - 1)
+
+        sequence.with_lock do
+          sequence.value += 1
+          record.send(:"#{column}=", sequence.value)
+          sequence.save
+        end
+      end
+    end
+
+    def id_set?
+      !record.send(column).nil?
+    end
+
+    def skip?
+      skip && skip.call(record)
+    end
+  end
+end

data/lib/sequential/sequence.rb

@@ -0,0 +1,5 @@
+module Sequential
+  class Sequence < ActiveRecord::Base
+    self.table_name = 'sequential'
+  end
+end

data/lib/sequential/sequential_include.rb

@@ -0,0 +1,52 @@
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/class/attribute_accessors'
+
+module Sequential
+  module SequentialInclude
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Public: Defines ActiveRecord callbacks to set a sequential ID scoped
+      # on a specific class.
+      #
+      # options - The Hash of options for configuration:
+      #           :scope    - The Symbol representing the columm on which the
+      #                       sequence should be scoped (default: nil)
+      #           :column   - The Symbol representing the column that stores the
+      #                       sequence (default: :sequential_id)
+      #           :start_at - The Integer value at which the sequence should
+      #                       start (default: 1)
+      #           :skip     - Skips the sequence generation when the lambda
+      #                       expression evaluates to nil. Gets passed the
+      #                       model object
+      #
+      # Examples
+      #
+      #   class Answer < ActiveRecord::Base
+      #     belongs_to :question
+      #     sequential scope: :question_id
+      #   end
+      #
+      # Returns nothing.
+      def sequential(options = {})
+        cattr_accessor :sequence_options
+
+        (self.sequence_options ||= []) << options
+
+        before_create :set_sequential_values
+
+        include Sequential::SequentialInclude::InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+      def set_sequential_values
+        self.sequence_options.each do |seq_opts|
+          Sequential::Generator.new(self, seq_opts).set
+        end
+      end
+    end
+  end
+end

data/lib/sequential/version.rb

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

data/lib/sequential.rb

@@ -0,0 +1,6 @@
+require 'sequential/version'
+require 'sequential/generator'
+require 'sequential/sequential_include'
+require 'sequential/sequence'
+
+ActiveRecord::Base.send(:include, Sequential::SequentialInclude)

data/sequential.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequential/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sequential"
+  spec.version       = Sequential::VERSION
+  spec.authors       = ["Austin Lin"]
+  spec.email         = ["austin@austinylin.com"]
+  spec.description   = %q{Generates scoped, threadsafe sequences for 
+                          ActiveRecord models}
+  spec.summary       = %q{Sequential enables the use of scoped, threadsafe 
+                          sequences for ActiveRecord models using a 
+                          seperate sequence table and row-level locking}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rails", ">= 4.0"
+  spec.add_development_dependency "sqlite3"
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,4 @@
+class Comment < ActiveRecord::Base
+  sequential column: :absolute_number
+  sequential scope: :post_id
+end

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

@@ -0,0 +1,5 @@
+class Invoice < ActiveRecord::Base
+
+  sequential scope: :client_id, start_at: 1000
+
+end

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

@@ -0,0 +1,5 @@
+class Post < ActiveRecord::Base
+
+  sequential scope: :author_id
+
+end

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

@@ -0,0 +1,3 @@
+class Product < ActiveRecord::Base
+  sequential scope: :category_id, skip: lambda { |p| p.price == -1 }
+end

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

@@ -0,0 +1,3 @@
+class Story < ActiveRecord::Base
+  sequential column: :story_number
+end

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require 'sequential'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+#Bundler.require(:default, Rails.env)
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# 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:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

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

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

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

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

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

@@ -0,0 +1,36 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end