sequenced 1.0.0 → 1.2.0

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+1.2.0 (April 11, 2013)
+----------------------
+
+* Accept an array of symbols for the scope attribute to scope by multiple
+  columns.
+
+1.1.0 (July 5, 2012)
+--------------------
+
+* Raise ArgumentError instead of Sequenced::InvalidAttributeError
+* Remove custom exceptions
+* Stop calling it a "plugin"
+
 1.0.0 (March 7, 2012)
 ---------------------
 

data/README.md

@@ -1,13 +1,11 @@
 # Sequenced
 
-Sequenced is a simple Rails 3 plugin that generates scoped sequential IDs for 
+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. This ID is 
+automatically assigns a unique, sequential ID to each record. The sequential ID is 
 not a replacement for the database primary key, but rather adds another way to 
 retrieve the object without exposing the primary key.
 
-Extracted from the [GuideKit](https://guidekit.com) codebase.
-
 ## Purpose
 
 It's generally a bad practice to expose your primary keys to the world 
@@ -58,7 +56,15 @@ end
 ```
 
 The `:scope` option can be any attribute, but will typically be the foreign
-key of an associated parent object.
+key of an associated parent object. You can even scope by multiple columns
+for polymorphic relationships:
+
+```ruby
+class Answer < ActiveRecord::Base
+  belongs_to :questionable, :polymorphic => true
+  acts_as_sequenced :scope => [:questionable_id, :questionable_type]
+end
+```
 
 ## Configuration
 

data/lib/sequenced.rb

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

data/lib/sequenced/acts_as_sequenced.rb

@@ -51,7 +51,7 @@ module Sequenced
       # defined.
       #
       # Returns nothing.
-      # Raises Sequenced::InvalidAttributeError if
+      # 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.
@@ -60,39 +60,60 @@ module Sequenced
         column = self.class.sequenced_options[:column]
         
         if scope.present?
-          if !self.respond_to?(scope)
-            raise Sequenced::InvalidAttributeError.new(":scope method ##{scope.to_s} is undefined")
-          elsif self.send(scope).nil?
-            raise Sequenced::InvalidAttributeError.new(":scope method ##{scope.to_s} returned nil unexpectedly")
+          if scope.is_a?(Array)
+            scope.each { |s| verify_scope_method(s) }
+          else
+            verify_scope_method(scope)
           end
         end
         
         unless self.respond_to?(column)
-          raise Sequenced::InvalidAttributeError.new(":column method ##{column.to_s} is undefined")
+          raise ArgumentError, "Column method ##{column.to_s} is undefined"
         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 Sequenced::InvalidAttributeError if the last sequential ID is not
-      #   an 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")
-        q = q.where(scope => self.send(scope)) if scope.is_a?(Symbol)
+        
+        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 Sequenced::InvalidAttributeError("The sequential ID column must contain Integer values")
+          raise ArgumentError, "The sequential ID column must contain Integer values"
         end
         
         last_id + 1 > start_at ? last_id + 1 : start_at
@@ -107,9 +128,14 @@ module Sequenced
         return false unless self.send(column).is_a?(Integer)
         
         q = self.class.unscoped.where(column => self.send(column))
-        q = q.where(scope => self.send(scope)) if scope.is_a?(Symbol)
-        q = q.where("NOT id = ?", self.id) if self.persisted?
         
+        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
       end
     end

data/lib/sequenced/version.rb

@@ -1,3 +1,3 @@
 module Sequenced
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

data/sequenced.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.email       = ["derrickreimer@gmail.com"]
   s.homepage    = "https://github.com/djreimer/sequenced"
   s.summary     = "Generate scoped sequential IDs for ActiveRecord models"
-  s.description = "Sequenced is a simple Rails 3 plugin that generates scoped sequential IDs for ActiveRecord models"
+  s.description = "Sequenced is a gem that generates scoped sequential IDs for ActiveRecord models."
 
   s.files = `git ls-files`.split("\n")
   s.test_files = Dir["test/**/*"]

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

@@ -0,0 +1,4 @@
+class Email < ActiveRecord::Base
+  belongs_to :emailable, :polymorphic => true
+  acts_as_sequenced :scope => [:emailable_id, :emailable_type]
+end

data/test/dummy/db/migrate/20130411225444_create_emails.rb

@@ -0,0 +1,12 @@
+class CreateEmails < ActiveRecord::Migration
+  def change
+    create_table :emails do |t|
+      t.string :emailable_type
+      t.integer :emailable_id
+      t.integer :sequential_id
+      t.string :address
+
+      t.timestamps
+    end
+  end
+end

data/test/sequenced_test.rb

@@ -8,6 +8,7 @@ require 'test_helper'
 #   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
 
 class SequencedTest < ActiveSupport::TestCase
@@ -49,12 +50,12 @@ class SequencedTest < ActiveSupport::TestCase
   test "undefined scope method" do
     account = Account.create
     order = account.orders.build
-    assert_raises(Sequenced::InvalidAttributeError) { order.save }
+    assert_raises(ArgumentError) { order.save }
   end
   
   test "scope method returns nil" do
     answer = Answer.new
-    assert_raises(Sequenced::InvalidAttributeError) { answer.save }
+    assert_raises(ArgumentError) { answer.save }
   end
   
   test "custom sequential id column" do
@@ -77,7 +78,7 @@ class SequencedTest < ActiveSupport::TestCase
   test "undefined sequential id column" do
     account = Account.create
     address = account.addresses.build
-    assert_raises(Sequenced::InvalidAttributeError) { address.save }
+    assert_raises(ArgumentError) { address.save }
   end
   
   test "manually setting sequential id" do
@@ -97,4 +98,11 @@ class SequencedTest < ActiveSupport::TestCase
     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
 end

metadata

@@ -1,72 +1,88 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sequenced
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.2.0
   prerelease: 
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Derrick Reimer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-07 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
   name: rails
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.1"
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id004
-description: Sequenced is a simple Rails 3 plugin that generates scoped sequential IDs for ActiveRecord models
-email: 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sequenced is a gem that generates scoped sequential IDs for ActiveRecord
+  models.
+email:
 - derrickreimer@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
@@ -76,7 +92,6 @@ files:
 - TODO.md
 - lib/sequenced.rb
 - lib/sequenced/acts_as_sequenced.rb
-- lib/sequenced/exceptions.rb
 - lib/sequenced/version.rb
 - sequenced.gemspec
 - test/dummy/README.rdoc
@@ -91,6 +106,7 @@ files:
 - test/dummy/app/models/address.rb
 - test/dummy/app/models/answer.rb
 - test/dummy/app/models/comment.rb
+- test/dummy/app/models/email.rb
 - test/dummy/app/models/invoice.rb
 - test/dummy/app/models/order.rb
 - test/dummy/app/models/question.rb
@@ -122,6 +138,7 @@ files:
 - test/dummy/db/migrate/20120219175744_create_users.rb
 - test/dummy/db/migrate/20120219232323_create_addresses.rb
 - test/dummy/db/migrate/20120220000804_create_comments.rb
+- test/dummy/db/migrate/20130411225444_create_emails.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/log/.gitkeep
@@ -136,41 +153,31 @@ files:
 - test/dummy/db/test.sqlite3
 - test/dummy/log/development.log
 - test/dummy/log/test.log
-has_rdoc: true
 homepage: https://github.com/djreimer/sequenced
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2873144507435092407
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2873144507435092407
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.1
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Generate scoped sequential IDs for ActiveRecord models
-test_files: 
+test_files:
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
@@ -179,6 +186,7 @@ test_files:
 - test/dummy/app/models/address.rb
 - test/dummy/app/models/answer.rb
 - test/dummy/app/models/comment.rb
+- test/dummy/app/models/email.rb
 - test/dummy/app/models/invoice.rb
 - test/dummy/app/models/order.rb
 - test/dummy/app/models/question.rb
@@ -211,6 +219,7 @@ test_files:
 - test/dummy/db/migrate/20120219175744_create_users.rb
 - test/dummy/db/migrate/20120219232323_create_addresses.rb
 - test/dummy/db/migrate/20120220000804_create_comments.rb
+- test/dummy/db/migrate/20130411225444_create_emails.rb
 - test/dummy/db/schema.rb
 - test/dummy/db/test.sqlite3
 - test/dummy/log/development.log

data/lib/sequenced/exceptions.rb

@@ -1,4 +0,0 @@
-module Sequenced
-  class SequencedError < RuntimeError; end
-  class InvalidAttributeError < SequencedError; end
-end