priority_order_scopes 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Nick Ragaz
+
+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,39 @@
+PriorityOrderScopes
+===================
+
+Flip through Active Record models in order, using next and previous scopes and instance methods.
+
+Example
+-------
+
+    create_table "jobs" do |t|
+      t.string "name"
+      t.datetime "started_at"
+    end
+    
+    class Job < ActiveRecord::Base
+      include PriorityOrderScopes
+      
+      priority_order_scopes "started_at"
+    end
+    
+    Job.priority_order # => Job.order("started_at")
+    
+    # by default, next and previous use the priority order (unless there
+    # is a default_scope with an order defined)
+    
+    Job.next(Job.priority_order.first) # => the job that starts second
+    Job.previous(Job.priority_order.first) # => nil
+    Job.previous(second_job) # => Job.priority_order.first
+    
+    # next and previous class methods respect the current scope
+    
+    Job.order('name').next(Job.first) # => the job with the next name
+    
+    # next and previous instance methods always use priority order
+    
+    job = Job.priority_order.first
+    job.next # => the job that starts second
+    
+    job = Job.order('name').first
+    job.previous # => the job that starts before the first job in alpha order

data/Rakefile

@@ -0,0 +1,34 @@
+#!/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    = 'PriorityOrderScopes'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+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/priority_order_scopes.rb

@@ -0,0 +1,70 @@
+module PriorityOrderScopes
+  extend ActiveSupport::Concern
+  
+  module ClassMethods
+    # Include PriorityOrderScopes and call 'priority_order_scopes' with a column
+    # name (and optional direction) to create `priority_order`, `next` and
+    # `previous` scopes.
+    #
+    # `next and `previous` require a record to start from. They will use the
+    # current scope if passed as part of a chain (or if a default scope with 
+    # an order clause is defined), or default to the priority order.
+    #
+    # You can also call instance.next or instance.previous directly. This will
+    # always use the default scope or the priority order.
+    def priority_order_scopes(col, dir=:asc)
+      @priority_order_column = col
+      @priority_order_direction = dir
+      
+      class << self
+        define_method :priority_order do
+          reorder("#{table_name}.#{@priority_order_column} #{@priority_order_direction}")
+        end
+        
+        define_method :next do |current|
+          return unless current
+          
+          # use the current scope's order clause, if any, or the priority order
+          order = scoped.order_clauses[0] || priority_order.order_clauses[0]
+          # turn ["last_name DESC, first_name", "id"] into "last_name"
+          order = order.split(", ")[0]
+          operator = order =~ /desc/i ? '<' : '>'
+          order_column = order.split(" ")[0].split(".").last
+          
+          where(
+            "#{table_name}.#{order_column} #{operator} ?",
+            current.send(order_column)
+          ).
+          limit(1)
+        end
+        
+        define_method :previous do |current|
+          return unless current
+          
+          # use the current scope's order clause, if any, or the priority order
+          order = scoped.order_clauses[0] || priority_order.order_clauses[0]
+          # turn ["last_name DESC, first_name", "id"] into "last_name"
+          order = order.split(", ")[0]
+          
+          operator = order =~ /desc/i ? '>' : '<'
+          order_column = order.split(" ")[0].split(".").last
+          
+          where(
+            "#{table_name}.#{order_column} #{operator} ?",
+            current.send(order_column)
+          ).
+          reverse_order.
+          limit(1)
+        end
+      end
+      
+      define_method :next do
+        self.class.priority_order.next(self).first
+      end
+      
+      define_method :previous do
+        self.class.priority_order.previous(self).first
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: priority_order_scopes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nick Ragaz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-29 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2161869500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161869500
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2161869100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2161869100
+description: Flip through Active Record models in order using next and previous scopes
+  and instance methods.
+email: nick.ragaz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/priority_order_scopes.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: http://github.com/nragaz/priority_order_scopes
+licenses: []
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Flip through Active Record models in order using next and previous scopes
+  and instance methods.
+test_files: []