sequenced 1.3.0 → 1.4.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+1.4.0 (July 15, 2013)
+---------------------
+
+* Remove hard dependency on Rails 3 in the test suite
+* Add skip option to sequence generation
+
 1.3.0 (April 11, 2013)
 ----------------------
 

data/README.md

@@ -23,7 +23,7 @@ end
 
 class Answer < ActiveRecord::Base
   belongs_to :question
-  acts_as_sequenced :scope => :question_id
+  acts_as_sequenced scope: :question_id
 end
 ```
 
@@ -51,18 +51,18 @@ Then, call the `acts_as_sequenced` macro in your model class:
 ```ruby
 class Answer < ActiveRecord::Base
   belongs_to :question
-  acts_as_sequenced :scope => :question_id
+  acts_as_sequenced scope: :question_id
 end
 ```
 
-The `:scope` option can be any attribute, but will typically be the foreign
+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
   belongs_to :questionable, :polymorphic => true
-  acts_as_sequenced :scope => [:questionable_id, :questionable_type]
+  acts_as_sequenced scope: [:questionable_id, :questionable_type]
 end
 ```
 
@@ -72,19 +72,19 @@ end
 
 By default, Sequenced uses the `sequential_id` column and assumes it already 
 exists. If you wish to store the sequential ID in different integer column, 
-simply specify the column name with the `:column` option:
+simply specify the column name with the `column` option:
 
 ```ruby
-acts_as_sequenced :scope => :question_id, :column => :my_sequential_id
+acts_as_sequenced scope: :question_id, column: :my_sequential_id
 ```
 
 ### Starting the sequence at a specific number
 
 By default, Sequenced begins sequences with 1. To start at a different 
-integer, simply set the `:start_at` option:
+integer, simply set the `start_at` option:
 
 ```ruby
-acts_as_sequenced :scope => :question_id, :start_at => 1000
+acts_as_sequenced start_at: 1000
 ```
 
 ### Indexing the sequential ID column
@@ -92,6 +92,15 @@ acts_as_sequenced :scope => :question_id, :start_at => 1000
 For optimal performance, it's a good idea to index the sequential ID column
 on sequenced models.
 
+### Skipping sequential ID generation
+
+If you'd like to skip generating a sequential ID under certain conditions,
+you may pass a lambda to the `skip` option:
+
+```ruby
+acts_as_sequenced skip: lambda { |r| r.score == 0 }
+```
+
 ## Example
 
 Suppose you have a question model that has many answers. This example 
@@ -107,7 +116,7 @@ end
 # app/models/answer.rb
 class Answer < ActiveRecord::Base
   belongs_to :question
-  acts_as_sequenced :scope => :question_id
+  acts_as_sequenced scope: :question_id
   
   # Automatically use the sequential ID in URLs
   def to_param
@@ -123,7 +132,7 @@ end
 # app/controllers/answers_controller.rb
 class AnswersController < ApplicationController
   before_filter :load_question
-  before_filter :load_answer, :only => [:show, :edit, :update, :destroy]
+  before_filter :load_answer, only: [:show, :edit, :update, :destroy]
   
 private
 
@@ -147,7 +156,7 @@ instead of by their primary keys:
 
 ## License
 
-Copyright &copy; 2012 Derrick Reimer
+Copyright &copy; 2012-2013 Derrick Reimer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/sequenced/acts_as_sequenced.rb

@@ -18,6 +18,9 @@ module Sequenced
       #                       sequential ID (default: :sequential_id)
       #           :start_at - The Integer value at which the sequence should
       #                       start (default: 1)
+      #           :skip     - Skips the sequential ID generation when the lambda
+      #                       expression evaluates to nil. Gets passed the
+      #                       model object
       #
       # Examples
       #   
@@ -29,11 +32,12 @@ module Sequenced
       # Returns nothing.
       def acts_as_sequenced(options = {})
         # Remove extraneous options
-        options.slice!(:scope, :column, :start_at)
+        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
@@ -58,6 +62,7 @@ module Sequenced
       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"
@@ -66,6 +71,10 @@ module Sequenced
         # 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) }

data/lib/sequenced/version.rb

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

data/sequenced.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
   s.test_files = Dir["test/**/*"]
 
-  s.add_dependency "activesupport", "~> 3.0"
-  s.add_dependency "activerecord", "~> 3.0"
-  s.add_development_dependency "rails", "~> 3.1"
+  s.add_dependency "activesupport", ">= 3.0"
+  s.add_dependency "activerecord", ">= 3.0"
+  s.add_development_dependency "rails", ">= 3.1"
   s.add_development_dependency "sqlite3"
 end

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

@@ -0,0 +1,3 @@
+class Rating < ActiveRecord::Base
+  acts_as_sequenced :scope => :comment_id, :skip => lambda { |r| r.score == 0 }
+end

data/test/dummy/db/migrate/20130715002029_create_ratings.rb

@@ -0,0 +1,10 @@
+class CreateRatings < ActiveRecord::Migration
+  def change
+    create_table :ratings do |t|
+      t.references :comment
+      t.integer :score
+      t.integer :sequential_id
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/schema.rb

@@ -9,66 +9,100 @@
 # from scratch. The latter is a flawed and unsustainable approach (the more migrations
 # you'll amass, the slower it'll run and the greater likelihood for issues).
 #
-# It's strongly recommended to check this file into your version control system.
+# It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20120219175744) do
+ActiveRecord::Schema.define(version: 20130715002029) do
 
-  create_table "accounts", :force => true do |t|
+  create_table "accounts", force: true do |t|
     t.string   "name"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
-  create_table "answers", :force => true do |t|
+  create_table "addresses", force: true do |t|
+    t.integer  "account_id"
+    t.string   "city"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "answers", force: true do |t|
     t.integer  "question_id"
     t.text     "body"
     t.integer  "sequential_id"
-    t.datetime "created_at",    :null => false
-    t.datetime "updated_at",    :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
-  add_index "answers", ["question_id"], :name => "index_answers_on_question_id"
-  add_index "answers", ["sequential_id"], :name => "index_answers_on_sequential_id"
+  add_index "answers", ["question_id"], name: "index_answers_on_question_id"
+  add_index "answers", ["sequential_id"], name: "index_answers_on_sequential_id"
+
+  create_table "comments", force: true do |t|
+    t.integer  "question_id"
+    t.text     "body"
+    t.integer  "sequential_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
 
-  create_table "invoices", :force => true do |t|
+  add_index "comments", ["question_id"], name: "index_comments_on_question_id"
+
+  create_table "emails", force: true do |t|
+    t.string   "emailable_type"
+    t.integer  "emailable_id"
+    t.integer  "sequential_id"
+    t.string   "address"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "invoices", force: true do |t|
     t.integer  "amount"
     t.integer  "sequential_id"
     t.integer  "account_id"
-    t.datetime "created_at",    :null => false
-    t.datetime "updated_at",    :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
-  add_index "invoices", ["account_id"], :name => "index_invoices_on_account_id"
+  add_index "invoices", ["account_id"], name: "index_invoices_on_account_id"
 
-  create_table "orders", :force => true do |t|
+  create_table "orders", force: true do |t|
     t.string   "product"
     t.integer  "account_id"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
-  create_table "questions", :force => true do |t|
+  create_table "questions", force: true do |t|
     t.string   "summary"
     t.text     "body"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "ratings", force: true do |t|
+    t.integer  "comment_id"
+    t.integer  "score"
+    t.integer  "sequential_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
-  create_table "subscriptions", :force => true do |t|
+  create_table "subscriptions", force: true do |t|
     t.string   "plan"
     t.integer  "sequential_id"
-    t.datetime "created_at",    :null => false
-    t.datetime "updated_at",    :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
-  create_table "users", :force => true do |t|
+  create_table "users", force: true do |t|
     t.integer  "account_id"
     t.string   "name"
     t.integer  "custom_sequential_id"
-    t.datetime "created_at",           :null => false
-    t.datetime "updated_at",           :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
-  add_index "users", ["account_id"], :name => "index_users_on_account_id"
+  add_index "users", ["account_id"], name: "index_users_on_account_id"
 
 end

data/test/sequenced_test.rb

@@ -10,6 +10,7 @@ require 'test_helper'
 #   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 }
 
 class SequencedTest < ActiveSupport::TestCase
   test "default start_at" do
@@ -105,4 +106,12 @@ class SequencedTest < ActiveSupport::TestCase
     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
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequenced
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-12 00:00:00.000000000 Z
+date: 2013-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
@@ -32,7 +32,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
@@ -40,7 +40,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
@@ -48,7 +48,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
@@ -56,7 +56,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
@@ -110,6 +110,7 @@ files:
 - test/dummy/app/models/invoice.rb
 - test/dummy/app/models/order.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/views/layouts/application.html.erb
@@ -139,6 +140,7 @@ files:
 - 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/migrate/20130715002029_create_ratings.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/log/.gitkeep
@@ -190,6 +192,7 @@ test_files:
 - test/dummy/app/models/invoice.rb
 - test/dummy/app/models/order.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/views/layouts/application.html.erb
@@ -220,6 +223,7 @@ test_files:
 - 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/migrate/20130715002029_create_ratings.rb
 - test/dummy/db/schema.rb
 - test/dummy/db/test.sqlite3
 - test/dummy/log/development.log