attr_sequence 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5dd41bbcae7b5ff5580d666c830057a8e2d78506
+  data.tar.gz: cd9e7655afcc288c665ba4217749f8d875b52d84
+SHA512:
+  metadata.gz: ac2121044636d2bbf40bc85869d1e65e3e48cda41f144e5d5656cbbd838618c70331f68434318811b8e5885c52c3ca324ee72c4f06aa686c3bc3a6f132ef7ece
+  data.tar.gz: 2be94b1269c7a4c3a3d3caee6f1b640525752ca25182fd56e406ba5ef976f03bc6a941357c4257b4bc3d893ae8c128ac49c0c534786cc5ceea8006d02ad6dac8

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change Log
+
+## v1.0.0
+- Initial release.

data/MIT-LICENSE.md

@@ -0,0 +1,20 @@
+Copyright 2018 Brightcommerce, Inc. All rights reserved.
+
+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,235 @@
+# AttrSequence
+
+AttrSequence is an ActiveRecord concern that generates scoped sequential numbers for models. This gem provides an `attr_sequence` macro that automatically assigns a unique, sequential number to each record. The sequential number is not a replacement for the database primary key, but rather adds another way to retrieve the object without exposing the primary key.
+
+AttrSequence has been extracted from the Brightcommerce platform and is now used in multiple other software projects.
+
+## Installation
+
+To install add the line to your `Gemfile`:
+
+``` ruby
+gem 'attr_sequence'
+```
+
+And run `bundle install`.
+
+The following configuration defaults are used by AttrSequence:
+
+``` ruby
+AttrSequence.configure do |config|
+  config.column = :number
+  config.start_at = 1
+end
+```
+
+You can override them by generating an initializer using the following command:
+
+``` bash
+rails generate attr_sequence:initializer
+```
+
+This will generate an initializer file in your project's `config/initializers` called `attr_sequence.rb` directory.
+
+## Usage
+
+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 this with AttrSequence:
+
+``` ruby
+class Question < ActiveRecord::Base
+  has_many :answers
+end
+
+class Answer < ActiveRecord::Base
+  include AttrSequence
+  belongs_to :question
+  attr_sequence scope: :question_id
+end
+```
+
+To autoload AttrSequence for all models, add the following to an initializer:
+
+``` ruby
+require 'attr_sequence/active_record'
+```
+
+You then don't need to `include AttrSequence` in any model.
+
+To add a sequential number to a model, first add an integer column called `:number` to the model (or you many name the column anything you like and override the default). For example:
+
+``` bash
+rails generate migration add_number_to_answers number:integer
+rake db:migrate
+```
+
+Then, include the concern module and call the `attr_sequence` macro in your model class:
+
+``` ruby
+class Answer < ActiveRecord::Base
+  include AttrSequence
+  belongs_to :question
+  attr_sequence scope: :question_id
+end
+```
+
+The scope option can be any attribute, but will typically be the foreign key of an associated parent object. You can even scope by multiple columns for polymorphic relationships:
+
+``` ruby
+class Answer < ActiveRecord::Base
+  include AttrSequence
+  belongs_to :questionable, polymorphic: true
+  attr_sequence scope: [:questionable_id, :questionable_type]
+end
+```
+
+Multiple sequences can be defined by using the macro multiple times:
+
+``` ruby
+class Answer < ActiveRecord::Base
+  include AttrSequence
+  belongs_to :account
+  belongs_to :question
+
+  attr_sequence column: :question_answer_number, scope: :question_id
+  attr_sequence 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 number column (or a multicolumn unique index on sequential number and scope columns, if you are using scopes). This will ensure that you can never have duplicate sequential numbers 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 number column as well if you never intend to skip it.
+
+Here is an example migration for an `Answer` model that has a `:number` scoped to a `Question`:
+
+``` ruby
+# app/db/migrations/20180101000000_create_answers.rb
+class CreateAnswers < ActiveRecord::Migration
+  def change
+    create_table :answers do |table|
+      table.references :question
+      table.column :number, :integer, null: false
+      table.index [:number, :question_id], unique: true
+    end
+  end
+end
+```
+
+## Configuration
+
+### Overriding the default sequential ID column
+
+By default, AttrSequence uses the `number` column and assumes it already exists. If you wish to store the sequential number in different integer column, simply specify the column name with the `:column` option:
+
+``` ruby
+attr_sequence scope: :question_id, column: :my_sequential_id
+```
+
+### Starting the sequence at a specific number
+
+By default, AttrSequence begins sequences with 1. To start at a different integer, simply set the `start_at` option:
+
+``` ruby
+attr_sequence start_at: 1000
+```
+
+You may also pass a lambda to the `start_at` option:
+
+``` ruby
+attr_sequence start_at: lambda { |r| r.computed_start_value }
+```
+
+### Indexing the sequential number column
+
+For optimal performance, it's a good idea to index the sequential number column on sequenced models.
+
+### Skipping sequential ID generation
+
+If you'd like to skip generating a sequential number under certain conditions, you may pass a lambda to the `skip` option:
+
+``` ruby
+attr_sequence skip: lambda { |r| r.score == 0 }
+```
+
+## Example
+
+Suppose you have a question model that has many answers. This example demonstrates how to use AttrSequence to enable access to the nested answer resource via its sequential number.
+
+``` ruby
+# app/models/question.rb
+class Question < ActiveRecord::Base
+  has_many :answers
+end
+
+# app/models/answer.rb
+class Answer < ActiveRecord::Base
+  include AttrSequence
+  belongs_to :question
+  attr_sequence scope: :question_id
+
+  # Automatically use the sequential number in URLs
+  def to_param
+    self.number.to_s
+  end
+end
+
+# config/routes.rb
+resources :questions do
+  resources :answers
+end
+
+# app/controllers/answers_controller.rb
+class AnswersController < ApplicationController
+  def show
+    @question = Question.find(params[:question_id])
+    @answer = @question.answers.find_by(number: params[:id])
+  end
+end
+```
+
+Now, answers are accessible via their sequential numbers:
+
+```
+http://example.com/questions/5/answers/1  # Good
+```
+
+instead of by their primary keys:
+
+```
+http://example.com/questions/5/answer/32454  # Bad
+```
+
+## Dependencies
+
+AttrSequence gem has the following runtime dependencies:
+- activerecord >= 5.1.4
+- activesupport >= 5.1.4
+
+## Compatibility
+
+Tested with MRI 2.4.2 against Rails 5.2.2.
+
+## 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
+
+## Credit
+
+This gem was written and is maintained by [Jurgen Jocubeit](https://github.com/JurgenJocubeit), CEO and President Brightcommerce, Inc.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Copyright
+
+Copyright 2018 Brightcommerce, Inc.

data/lib/attr_sequence/active_record.rb

@@ -0,0 +1 @@
+ActiveRecord::Base.send :include, AttrSequence

data/lib/attr_sequence/attr_sequence.rb

@@ -0,0 +1,68 @@
+require_relative './generator'
+require 'active_support/concern'
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/class/attribute_accessors'
+
+module AttrSequence
+  extend ActiveSupport::Concern
+
+  SequenceColumnExists = Class.new(StandardError)
+
+  class_methods do
+    # Public: Defines ActiveRecord callbacks to set a sequential number scoped
+    # on a specific class.
+    #
+    # Can be called multiple times to add hooks for different column names.
+    #
+    # options - The Hash of options for configuration:
+    #           :scope    - The Symbol representing the columm on which the
+    #                       number should be scoped (default: nil)
+    #           :column   - The Symbol representing the column that stores the
+    #                       number (default: :number)
+    #           :start_at - The Integer value at which the sequence should
+    #                       start (default: 1)
+    #           :skip     - Skips the number generation when the lambda
+    #                       expression evaluates to nil. Gets passed the
+    #                       model object
+    #
+    # Examples
+    #
+    #   class Answer < ActiveRecord::Base
+    #     include AttrSequence
+    #     belongs_to :question
+    #     attr_sequence scope: :question_id
+    #   end
+    #
+    # Returns nothing.
+    def attr_sequence(options = {})
+      unless defined?(sequence_options)
+        mattr_accessor :sequence_options, instance_accessor: false
+        self.sequence_options = []
+
+        before_save :set_numbers
+      end
+
+      default_options = {column: AttrSequence.column, start_at: AttrSequence.start_at}
+      options = default_options.merge(options)
+      column_name = options[:column]
+
+      if sequence_options.any? {|options| options[:column] == column_name}
+        raise(SequenceColumnExists, <<-MSG.squish)
+          Tried to set #{column_name} as a sequence but there was already a
+          definition here. Did you accidentally call attr_sequence multiple
+          times on the same column?
+        MSG
+      else
+        sequence_options << options
+      end
+    end
+  end
+
+  private
+
+  def set_numbers
+    self.class.base_class.sequence_options.each do |options|
+      AttrSequence::Generator.new(self, options).set
+    end
+  end
+end

data/lib/attr_sequence/configuration.rb

@@ -0,0 +1,19 @@
+module AttrSequence
+  class Configuration
+    def column
+      @column ||= :number
+    end
+
+    def column=(value)
+      @column = value
+    end
+
+    def start_at
+      @start_at ||= 1
+    end
+
+    def start_at=(value)
+      @start_at = value
+    end
+  end
+end

data/lib/attr_sequence/generator.rb

@@ -0,0 +1,82 @@
+module AttrSequence
+  class Generator
+    attr_reader :record, :scope, :column, :start_at, :skip
+
+    def initialize(record, options = {})
+      @record = record
+      @scope = options[:scope]
+      @column = options[:column].to_sym
+      @start_at = options[:start_at]
+      @skip = options[:skip]
+    end
+
+    def set
+      return if number_set? || skip?
+      lock_table
+      record.send(:"#{column}=", next_number)
+    end
+
+    def number_set?
+      !record.send(column).nil?
+    end
+
+    def skip?
+      skip && skip.call(record)
+    end
+
+    def next_number
+      next_number_in_sequence.tap do |number|
+        number += 1 until unique?(number)
+      end
+    end
+
+    def next_number_in_sequence
+      start_at = self.start_at.respond_to?(:call) ? self.start_at.call(record) : self.start_at
+      return start_at unless last_record = find_last_record
+      max(last_record.send(column) + 1, start_at)
+    end
+
+    def unique?(number)
+      build_scope(*scope) do
+        rel = base_relation
+        rel = rel.where("NOT number = ?", record.number) if record.persisted?
+        rel.where(column => number)
+      end.count == 0
+    end
+
+  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
+
+    def find_last_record
+      build_scope(*scope) do
+        base_relation.
+        where("#{column.to_s} IS NOT NULL").
+        order("#{column.to_s} DESC")
+      end.first
+    end
+
+    def build_scope(*columns)
+      rel = yield
+      columns.each { |c| rel = rel.where(c => record.send(c.to_sym)) }
+      rel
+    end
+
+    def max(*values)
+      values.to_a.max
+    end
+  end
+end

data/lib/attr_sequence/version.rb

@@ -0,0 +1,16 @@
+module AttrSequence
+  module Version
+    Major       = 1
+    Minor       = 0
+    Revision    = 0
+    Prerelease  = nil
+    Compact     = [Major, Minor, Revision, Prerelease].compact.join('.')
+    Summary     = "AttrSequence v#{Compact}"
+    Description = "An ActiveRecord concern that generates scoped sequential IDs for models."
+    Author      = "Jurgen Jocubeit"
+    Email       = "support@brightcommerce.com"
+    Homepage    = "https://github.com/brightcommerce/attr_sequence"
+    Metadata    = {'copyright' => 'Copyright 2018 Brightcommerce, Inc. All Rights Reserved.'}
+    License     = "MIT"
+  end
+end

data/lib/attr_sequence.rb

@@ -0,0 +1,35 @@
+require 'attr_sequence/attr_sequence'
+require 'attr_sequence/configuration'
+require 'attr_sequence/version'
+
+module AttrSequence
+  extend ActiveSupport::Autoload
+
+  @@configuration = nil
+
+  def self.configure
+    @@configuration = Configuration.new
+    yield(configuration) if block_given?
+    configuration
+  end
+
+  def self.configuration
+    @@configuration || configure
+  end
+
+  def self.method_missing(method_sym, *arguments, &block)
+    if configuration.respond_to?(method_sym)
+      configuration.send(method_sym)
+    else
+      super
+    end
+  end
+
+  def self.respond_to?(method_sym, include_private = false)
+    if configuration.respond_to?(method_sym, include_private)
+      true
+    else
+      super
+    end
+  end
+end

data/lib/generators/attr_sequence/initializer/initializer_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+
+module AttrSequence
+  class InitializerGenerator < ::Rails::Generators::Base
+
+    namespace "attr_sequence:initializer"
+    source_root File.join(File.dirname(__FILE__), 'templates')
+
+    def create_initializer_file
+      template 'initializer.rb', 'config/initializers/attr_sequence.rb'
+    end
+
+  end
+end

data/lib/generators/attr_sequence/initializer/templates/initializer.rb

@@ -0,0 +1,4 @@
+AttrSequence.configure do |config|
+  # config.column = :number
+  # config.start_at = 1
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: attr_sequence
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jurgen Jocubeit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+description: An ActiveRecord concern that generates scoped sequential IDs for models.
+email: support@brightcommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE.md
+- README.md
+- lib/attr_sequence.rb
+- lib/attr_sequence/active_record.rb
+- lib/attr_sequence/attr_sequence.rb
+- lib/attr_sequence/configuration.rb
+- lib/attr_sequence/generator.rb
+- lib/attr_sequence/version.rb
+- lib/generators/attr_sequence/initializer/initializer_generator.rb
+- lib/generators/attr_sequence/initializer/templates/initializer.rb
+homepage: https://github.com/brightcommerce/attr_sequence
+licenses:
+- MIT
+metadata:
+  copyright: Copyright 2018 Brightcommerce, Inc. All Rights Reserved.
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: AttrSequence v1.0.0
+test_files: []