sequenced 1.4.0 → 1.5.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjQwMmU1NzFiNzlmNDk3NDczOGJhOWY4NDhjODZhNmZjNjQ0NTllMA==
+  data.tar.gz: !binary |-
+    MGQ5Y2M4MjVkMGMzZWQ2MzA0MmE4Zjg4OTk2NzJmZTIyNDgwYTYwMQ==
+SHA512:
+  metadata.gz: !binary |-
+    NjA5OGJkMDc5MTM3MTY0Y2EwNDY2YTBkODk4YzA3YTY4MjUxNTdiNWQ2YzI5
+    ZjhjNjFkM2JlZWRhODc2ODc0MDEwZDFlMzQ1ZGZmODRkNWYzZWQyMWM5NDlm
+    NDIxMTA5ZDNhMmIwYjdhYzMyZWI2YTc2NzNjZWU2NmVkNjRmZWY=
+  data.tar.gz: !binary |-
+    OGU4MjNkMWY5Y2ZmMzRmNTY5NGQwOGQwNjE3YzhlYzg2YTZkNTUxOTVjMmFl
+    OWYzZjUxNmFhMzI3NGEwNTUzMzZjODgzNmNmZmFkMTRiNDIxNjU3NDgzYTBl
+    Mzc0MWQ2MjIxOTc4ZWE0Y2MyNDIyMGViMDM0Yzc1OWIwMTYzMTI=

data/.gitignore

@@ -7,3 +7,4 @@ test/dummy/db/*.sqlite3
 test/dummy/log/*.log
 test/dummy/tmp/
 test/dummy/.sass-cache
+*.gem

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+1.5.0 (December 26, 2013)
+-------------------------
+
+* Add the ability to pass a lambda for the start_at option (Bobby Uhlenbrock)
+* Major internal refactor for cleaner, more modular code
+* Scope by base class when single table inheritance is being used (Adam Becker)
+
 1.4.0 (July 15, 2013)
 ---------------------
 

data/MIT-LICENSE

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

data/README.md

@@ -1,5 +1,8 @@
 # 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)
+
 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 
@@ -87,6 +90,12 @@ integer, simply set the `start_at` option:
 acts_as_sequenced start_at: 1000
 ```
 
+You may also pass a lambda to the `start_at` option:
+
+```ruby
+acts_as_sequenced start_at: lambda { |r| r.computed_start_value }
+```
+
 ### Indexing the sequential ID column
 
 For optimal performance, it's a good idea to index the sequential ID column
@@ -125,7 +134,7 @@ class Answer < ActiveRecord::Base
 end
 
 # config/routes.rb
-resources :questions
+resources :questions do
   resources :answers
 end
 
@@ -175,4 +184,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/sequenced.rb

@@ -1,3 +1,4 @@
+require 'sequenced/generator'
 require 'sequenced/acts_as_sequenced'
 
 ActiveRecord::Base.send(:include, Sequenced::ActsAsSequenced)

data/lib/sequenced/acts_as_sequenced.rb

@@ -6,9 +6,9 @@ module Sequenced
     def self.included(base)
       base.extend ClassMethods
     end
-    
+
     module ClassMethods
-      # Public: Defines ActiveRecord callbacks to set a sequential ID scoped 
+      # Public: Defines ActiveRecord callbacks to set a sequential ID scoped
       # on a specific class.
       #
       # options - The Hash of options for configuration:
@@ -23,7 +23,7 @@ module Sequenced
       #                       model object
       #
       # Examples
-      #   
+      #
       #   class Answer < ActiveRecord::Base
       #     belongs_to :question
       #     acts_as_sequenced :scope => :question_id
@@ -31,124 +31,17 @@ module Sequenced
       #
       # Returns nothing.
       def acts_as_sequenced(options = {})
-        # Remove extraneous options
-        options.slice!(:scope, :column, :start_at, :skip)
-        
-        # Set defaults
-        options[:column]   ||= :sequential_id
-        options[:start_at] ||= 1
-        options[:skip]     ||= nil
-        
-        # Create class accessor for sequenced options
         cattr_accessor :sequenced_options
         self.sequenced_options = options
-        
-        # Specify ActiveRecord callback
+
         before_save :set_sequential_id
         include Sequenced::ActsAsSequenced::InstanceMethods
       end
     end
-    
+
     module InstanceMethods
-      # Internal: Fetches the next sequential ID and assigns it to 
-      # the sequential ID column if the sequential id is not already
-      # defined.
-      #
-      # Returns nothing.
-      # Raises ArgumentError if
-      #   1) The specified scope method is undefined,
-      #   2) The specified scope method returns nil, or
-      #   3) The sequential ID column is undefined.
       def set_sequential_id
-        scope  = self.class.sequenced_options[:scope]
-        column = self.class.sequenced_options[:column]
-        skip   = self.class.sequenced_options[:skip]
-        
-        unless self.respond_to?(column)
-          raise ArgumentError, "Column method ##{column.to_s} is undefined"
-        end
-        
-        # Short-circuit here if the ID is already set
-        return unless self.send(column).nil?
-        
-        if skip.present?
-          return if skip.call(self)
-        end
-        
-        if scope.present?
-          if scope.is_a?(Array)
-            scope.each { |s| verify_scope_method(s) }
-          else
-            verify_scope_method(scope)
-          end
-        end
-        
-        # Fetch the next ID unless it is already defined
-        self.send(:"#{column}=", next_sequential_id) until sequential_id_is_unique?
-      end
-      
-      # Internal: Verify that the given scope method is defined and does not
-      # return nil unexpectedly.
-      #
-      # scope - A Symbol representing the scope method.
-      #
-      # Returns nothing.
-      # Raises an ArgumentError if
-      #   1) The specified scope method is undefined, or
-      #   2) The specified scope method returns nil
-      def verify_scope_method(scope)
-        if !self.respond_to?(scope)
-          raise ArgumentError, "Scope method ##{scope.to_s} is undefined"
-        elsif self.send(scope).nil?
-          raise ArgumentError, "Scope method ##{scope.to_s} returned nil unexpectedly"
-        end
-      end
-      
-      # Internal: Obtain the next sequential ID
-      #
-      # Returns Integer.
-      # Raises ArgumentError if the last sequential ID is not an Integer.
-      def next_sequential_id
-        scope    = self.class.sequenced_options[:scope]
-        column   = self.class.sequenced_options[:column]
-        start_at = self.class.sequenced_options[:start_at]
-        
-        q = self.class.unscoped.where("#{column.to_s} IS NOT NULL").order("#{column.to_s} DESC")
-        
-        if scope.is_a?(Symbol)
-          q = q.where(scope => self.send(scope))
-        elsif scope.is_a?(Array)
-          scope.each { |s| q = q.where(s => self.send(s)) }
-        end
-        
-        return start_at unless last_record = q.first
-        last_id = last_record.send(column)
-        
-        unless last_id.is_a?(Integer)
-          raise ArgumentError, "The sequential ID column must contain Integer values"
-        end
-        
-        last_id + 1 > start_at ? last_id + 1 : start_at
-      end
-      
-      # Internal: Checks the uniqueness of the sequential ID.
-      #
-      # Returns Boolean status of uniqueness.
-      def sequential_id_is_unique?
-        scope  = self.class.sequenced_options[:scope]
-        column = self.class.sequenced_options[:column]
-        return false unless self.send(column).is_a?(Integer)
-        
-        q = self.class.unscoped.where(column => self.send(column))
-        
-        if scope.is_a?(Symbol)
-          q = q.where(scope => self.send(scope))
-        elsif scope.is_a?(Array)
-          scope.each { |s| q = q.where(s => self.send(s)) }
-        end
-
-        q = q.where("NOT id = ?", self.id) if self.persisted?
-        q.count > 0 ? false : true
+        Sequenced::Generator.new(self, self.class.base_class.sequenced_options).set
       end
     end
   end

data/lib/sequenced/generator.rb

@@ -0,0 +1,70 @@
+module Sequenced
+  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
+      record.send(:"#{column}=", next_id) unless id_set? || skip?
+    end
+
+    def id_set?
+      !record.send(column).nil?
+    end
+
+    def skip?
+      skip && skip.call(record)
+    end
+
+    def next_id
+      next_id_in_sequence.tap do |id|
+        id += 1 until unique?(id)
+      end
+    end
+
+    def next_id_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?(id)
+      build_scope(*scope) do
+        rel = base_relation
+        rel = rel.where("NOT id = ?", record.id) if record.persisted?
+        rel.where(column => id)
+      end.count == 0
+    end
+
+  private
+
+    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/sequenced/version.rb

@@ -1,3 +1,3 @@
 module Sequenced
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/sequenced.gemspec

@@ -5,6 +5,7 @@ Gem::Specification.new do |s|
   s.name        = "sequenced"
   s.version     = Sequenced::VERSION
   s.authors     = ["Derrick Reimer"]
+  s.licenses    = ['MIT']
   s.email       = ["derrickreimer@gmail.com"]
   s.homepage    = "https://github.com/djreimer/sequenced"
   s.summary     = "Generate scoped sequential IDs for ActiveRecord models"

data/test/{sequenced_test.rb → acts_as_sequenced_test.rb}

@@ -5,113 +5,128 @@ require 'test_helper'
 #   Answer       - :scope => :question_id
 #   Comment      - :scope => :question_id (with an AR default scope)
 #   Invoice      - :scope => :account_id, :start_at => 1000
+#   Product      - :scope => :account_id, :start_at => lambda { |r| r.computed_start_value }
 #   Order        - :scope => :non_existent_column
 #   User         - :scope => :account_id, :column => :custom_sequential_id
 #   Address      - :scope => :account_id ('sequential_id' does not exist)
 #   Email        - :scope => [:emailable_id, :emailable_type]
 #   Subscription - no options
 #   Rating       - :scope => :comment_id, skip: { |r| r.score == 0 }
+#   Monster      - no options
+#   Zombie       - STI, inherits from Monster
+#   Werewolf     - STI, inherits from Monster
 
-class SequencedTest < ActiveSupport::TestCase
+class ActsAsSequencedTest < ActiveSupport::TestCase
   test "default start_at" do
     question = Question.create
     answer = question.answers.create
     assert_equal 1, answer.sequential_id
   end
-  
+
   test "custom start_at" do
     account = Account.create
     invoice = account.invoices.create
     assert_equal 1000, invoice.sequential_id
-    
+
     another_invoice = account.invoices.create
     assert_equal 1001, another_invoice.sequential_id
   end
-  
+
+  test "lambda start_at" do
+    account = Account.create
+    product = Product.create(:account_id => account.id)
+    assert_equal 3, product.sequential_id
+
+    another_product = Product.create(:account_id => account.id)
+    assert_equal 4, another_product.sequential_id
+  end
+
   test "custom start_at with populated table" do
     account = Account.create
     account.invoices.create(:sequential_id => 1)
     invoice = account.invoices.create
     assert_equal 1000, invoice.sequential_id
   end
-  
+
   test "sequential id increment" do
     question = Question.create
     question.answers.create(:sequential_id => 10)
     another_answer = question.answers.create
     assert_equal 11, another_answer.sequential_id
   end
-  
+
   test "default scope" do
     Subscription.create(:sequential_id => 1)
     subscription = Subscription.create
     assert_equal 2, subscription.sequential_id
   end
-  
+
   test "undefined scope method" do
     account = Account.create
     order = account.orders.build
-    assert_raises(ArgumentError) { order.save }
-  end
-  
-  test "scope method returns nil" do
-    answer = Answer.new
-    assert_raises(ArgumentError) { answer.save }
+    assert_raises(NoMethodError) { order.save }
   end
-  
+
   test "custom sequential id column" do
     account = Account.create
     user = account.users.create
     assert_equal 1, user.custom_sequential_id
   end
-  
+
   test "sequential id remains on save" do
     question = Question.create
     answer = question.answers.create
     assert_equal 1, answer.sequential_id
-    
+
     answer.reload
     answer.body = "Updated body"
     answer.save
     assert_equal 1, answer.sequential_id
   end
-  
+
   test "undefined sequential id column" do
     account = Account.create
     address = account.addresses.build
-    assert_raises(ArgumentError) { address.save }
+    assert_raises(NoMethodError) { address.save }
   end
-  
+
   test "manually setting sequential id" do
     question = Question.create
     answer = question.answers.build(:sequential_id => 10)
     another_answer = question.answers.build(:sequential_id => 10)
     answer.save
     another_answer.save
-    
+
     assert_equal 10, answer.sequential_id
     assert_equal 10, another_answer.sequential_id
   end
-  
+
   test "model with a default scope for sorting" do
     question = Question.create
     (1..3).each { |id| question.comments.create(:sequential_id => id) }
     comment = question.comments.create
     assert_equal 4, comment.sequential_id
   end
-  
+
   test "multi-column scopes" do
     Email.create(:emailable_id => 1, :emailable_type => "User", :sequential_id => 2)
     Email.create(:emailable_id => 1, :emailable_type => "Question", :sequential_id => 3)
     email = Email.create(:emailable_id => 1, :emailable_type => "User")
     assert_equal 3, email.sequential_id
   end
-  
+
   test "skip option" do
     rating = Rating.create(:comment_id => 1, :score => 1)
     assert_equal 1, rating.sequential_id
-    
+
     rating = Rating.create(:comment_id => 1, :score => 0)
     assert_equal nil, rating.sequential_id
   end
+
+  test "STI" do
+    zombie = Zombie.create
+    werewolf = Werewolf.create
+    assert_equal 1, zombie.sequential_id
+    assert_equal 2, werewolf.sequential_id
+  end
 end

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

@@ -0,0 +1,3 @@
+class Monster < ActiveRecord::Base
+  acts_as_sequenced
+end

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

@@ -0,0 +1,8 @@
+class Product < ActiveRecord::Base
+  belongs_to :account
+  acts_as_sequenced :scope => :account_id, :start_at => lambda { |r| r.computed_start_value }
+  
+  def computed_start_value
+    1 + 2
+  end
+end

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

@@ -0,0 +1,2 @@
+class Werewolf < Monster
+end

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

@@ -0,0 +1,2 @@
+class Zombie < Monster
+end

data/test/dummy/db/migrate/20130730004055_create_products.rb

@@ -0,0 +1,9 @@
+class CreateProducts < ActiveRecord::Migration
+  def change
+    create_table :products do |t|
+      t.references :account
+      t.integer :sequential_id
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20131226000000_create_monsters.rb

@@ -0,0 +1,9 @@
+class CreateMonsters < ActiveRecord::Migration
+  def change
+    create_table :monsters do |t|
+      t.integer :sequential_id
+      t.string :type
+      t.timestamps
+    end
+  end
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: sequenced
 version: !ruby/object:Gem::Version
-  version: 1.4.0
-  prerelease: 
+  version: 1.5.0
 platform: ruby
 authors:
 - Derrick Reimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2013-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -84,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
@@ -92,8 +84,10 @@ files:
 - TODO.md
 - lib/sequenced.rb
 - lib/sequenced/acts_as_sequenced.rb
+- lib/sequenced/generator.rb
 - lib/sequenced/version.rb
 - sequenced.gemspec
+- test/acts_as_sequenced_test.rb
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
@@ -108,11 +102,15 @@ files:
 - test/dummy/app/models/comment.rb
 - test/dummy/app/models/email.rb
 - test/dummy/app/models/invoice.rb
+- test/dummy/app/models/monster.rb
 - test/dummy/app/models/order.rb
+- test/dummy/app/models/product.rb
 - test/dummy/app/models/question.rb
 - test/dummy/app/models/rating.rb
 - test/dummy/app/models/subscription.rb
 - test/dummy/app/models/user.rb
+- test/dummy/app/models/werewolf.rb
+- test/dummy/app/models/zombie.rb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
@@ -141,6 +139,8 @@ files:
 - test/dummy/db/migrate/20120220000804_create_comments.rb
 - test/dummy/db/migrate/20130411225444_create_emails.rb
 - test/dummy/db/migrate/20130715002029_create_ratings.rb
+- test/dummy/db/migrate/20130730004055_create_products.rb
+- test/dummy/db/migrate/20131226000000_create_monsters.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/log/.gitkeep
@@ -149,37 +149,37 @@ files:
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/dummy/script/rails
-- test/sequenced_test.rb
 - test/test_helper.rb
 - test/dummy/db/development.sqlite3
 - test/dummy/db/test.sqlite3
 - test/dummy/log/development.log
 - test/dummy/log/test.log
 homepage: https://github.com/djreimer/sequenced
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.1.10
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Generate scoped sequential IDs for ActiveRecord models
 test_files:
+- test/acts_as_sequenced_test.rb
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
@@ -190,11 +190,15 @@ test_files:
 - test/dummy/app/models/comment.rb
 - test/dummy/app/models/email.rb
 - test/dummy/app/models/invoice.rb
+- test/dummy/app/models/monster.rb
 - test/dummy/app/models/order.rb
+- test/dummy/app/models/product.rb
 - test/dummy/app/models/question.rb
 - test/dummy/app/models/rating.rb
 - test/dummy/app/models/subscription.rb
 - test/dummy/app/models/user.rb
+- test/dummy/app/models/werewolf.rb
+- test/dummy/app/models/zombie.rb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
@@ -224,6 +228,8 @@ test_files:
 - test/dummy/db/migrate/20120220000804_create_comments.rb
 - test/dummy/db/migrate/20130411225444_create_emails.rb
 - test/dummy/db/migrate/20130715002029_create_ratings.rb
+- test/dummy/db/migrate/20130730004055_create_products.rb
+- test/dummy/db/migrate/20131226000000_create_monsters.rb
 - test/dummy/db/schema.rb
 - test/dummy/db/test.sqlite3
 - test/dummy/log/development.log
@@ -235,5 +241,4 @@ test_files:
 - test/dummy/Rakefile
 - test/dummy/README.rdoc
 - test/dummy/script/rails
-- test/sequenced_test.rb
 - test/test_helper.rb