sequenced 0.1.0

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+.rvmrc
+Gemfile.lock
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in sequenced.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Derrick Reimer
+
+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,163 @@
+# Sequenced
+
+Sequenced is a simple Rails 3 plugin 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 
+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 
+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 Sequenced in one line of code:
+
+```ruby
+class Question < ActiveRecord::Base
+  has_many :answers
+end
+
+class Answer < ActiveRecord::Base
+  belongs_to :question
+  acts_as_sequenced :scope => :question_id
+end
+```
+
+## Installation
+
+Add the gem to your Gemfile:
+   
+    gem 'sequenced'
+
+Install the gem with bundler:
+
+    bundle install
+
+## Usage
+
+To add a sequential ID to a model, first add an integer column called
+`sequential_id` to the model (or you many name the column anything you
+like and override the default). For example:
+
+    rails generate migration add_sequential_id_to_answers sequential_id:integer
+    rake db:migrate
+
+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
+end
+```
+
+The `:scope` option can be any attribute, but will typically be the foreign
+key of an associated parent object.
+
+## Configuration
+
+### Overriding the default sequential ID column
+
+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:
+
+```ruby
+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:
+
+```ruby
+acts_as_sequenced :scope => :question_id, :start_at => 1000
+```
+
+### Indexing the sequential ID column
+
+For optimal performance, it's a good idea to index the sequential ID column
+on sequenced models.
+
+## Example
+
+Suppose you have a question model that has many answers. This example 
+demonstrates how to use Sequenced to enable access to the nested answer
+resource via its sequential ID.
+
+```ruby
+# app/models/question.rb
+class Question < ActiveRecord::Base
+  has_many :answers
+end
+
+# app/models/answer.rb
+class Answer < ActiveRecord::Base
+  belongs_to :question
+  acts_as_sequenced :scope => :question_id
+  
+  # Automatically use the sequential ID in URLs
+  def to_param
+    self.sequential_id
+  end
+end
+
+# config/routes.rb
+resources :questions
+  resources :answers
+end
+
+# app/controllers/answers_controller.rb
+class AnswersController < ApplicationController
+  before_filter :load_question
+  before_filter :load_answer, :only => [:show, :edit, :update, :destroy]
+  
+private
+
+  def load_question
+    @question = Question.find(params[:question_id])
+  end
+  
+  def load_answer
+    @answer = @question.answers.where(:sequential_id => params[:id]).first
+  end
+end
+```
+
+Now, answers are accessible via their sequential IDs:
+
+    http://example.com/questions/5/answers/1    # Good
+
+instead of by their primary keys:
+
+    http://example.com/questions/5/answer/32454  # Bad
+
+## License
+
+Copyright &copy; 2012 Derrick Reimer
+
+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/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Sequenced'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+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/sequenced.rb

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

data/lib/sequenced/acts_as_sequenced.rb

@@ -0,0 +1,117 @@
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/class/attribute_accessors'
+
+module Sequenced
+  module ActsAsSequenced
+    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
+      #                       sequential ID should be scoped (default: nil)
+      #           :column   - The Symbol representing the column that stores the
+      #                       sequential ID (default: :sequential_id)
+      #           :start_at - The Integer value at which the sequence should
+      #                       start (default: 1)
+      #
+      # Examples
+      #   
+      #   class Answer < ActiveRecord::Base
+      #     belongs_to :question
+      #     acts_as_sequenced :scope => :question_id
+      #   end
+      #
+      # Returns nothing.
+      def acts_as_sequenced(options = {})
+        # Remove extraneous options
+        options.slice!(:scope, :column, :start_at)
+        
+        # Set defaults
+        options[:column]   ||= :sequential_id
+        options[:start_at] ||= 1
+        
+        # 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 Sequenced::InvalidAttributeError 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]
+        
+        if scope.present?
+          if !self.respond_to?(scope)
+            raise Sequenced::InvalidAttributeError.new("Method ##{scope.to_s} is undefined")
+          elsif self.send(scope).nil?
+            raise Sequenced::InvalidAttributeError.new("Method ##{scope.to_s} returned nil unexpectedly")
+          end
+        end
+        
+        unless self.respond_to?(column)
+          raise Sequenced::InvalidAttributeError.new("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: Obtain the next sequential ID
+      #
+      # Returns Integer.
+      # Raises Sequenced::InvalidAttributeError 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)
+        
+        return start_at unless last_record = q.first
+        last_id = last_record.send(column)
+        
+        unless last_id.is_a?(Integer)
+          raise Sequenced::InvalidAttributeError("Last sequential ID is not an Integer")
+        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))
+        q = q.where(scope => self.send(scope)) if scope.is_a?(Symbol)
+        q = q.where("NOT id = ?", self.id) if self.persisted?
+        
+        q.count > 0 ? false : true
+      end
+    end
+  end
+end

data/lib/sequenced/exceptions.rb

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

data/lib/sequenced/version.rb

@@ -0,0 +1,3 @@
+module Sequenced
+  VERSION = "0.1.0"
+end

data/sequenced.gemspec

@@ -0,0 +1,20 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "sequenced/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sequenced"
+  s.version     = Sequenced::VERSION
+  s.authors     = ["Derrick Reimer"]
+  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 engine that generates scoped sequential IDs for ActiveRecord models"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = Dir["test/**/*"]
+
+  s.add_dependency "activesupport", ">= 3.0.0"
+  s.add_dependency "activerecord", ">= 3.0.0"
+  s.add_development_dependency "rails", ">= 3.1.0"
+  s.add_development_dependency "sqlite3"
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.