scoped_traversal 0.1

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.bundle
+.tm_properties

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## v0.1
+
+* Initial release
+* No tests! Sorry. with_model wasn't working and I am lazy.

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in scoped_traversal.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    scoped_traversal (0.1.alpha)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  scoped_traversal!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Wil Gieseler
+
+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,59 @@
+# Scoped Traversal
+
+A simple way to define next and previous relationships in an ActiveRecord model.
+
+For example, if you have a list of `articles`, and you want to be able to traverse them with `article.next` and `article.previous`.
+
+## Installation
+
+Add to your Gemfile and run the `bundle` command to install it.
+
+ ```ruby
+ gem "scoped_traversal"
+ ```
+
+**Requires Ruby 1.9.2 or later.**
+
+## Usage
+
+In your model, call rank_by and pass in a column name.
+
+ ```ruby
+ class User < ActiveRecord::Base
+ 	traverse_by :score
+ end
+ ```
+
+You can then traverse them with the following methods:
+
+ ```ruby
+@user.next
+@user.previous
+ ```
+ 
+### Namespaces
+
+You can also add an optional namespace, like so:
+
+ ```ruby
+class User < ActiveRecord::Base
+	traverse_by :score, :namespace => true
+	traverse_by :created_at, :namespace => :oldest
+end
+ ```
+
+You can then traverse them with the following methods:
+
+ ```ruby
+ @user.next_score
+ @user.previous_score
+    
+ @user.next_oldest
+ @user.previous_oldest
+ ```
+ 
+## Development
+
+Questions or problems? Please post them on the [issue tracker](https://github.com/supapuerco/scoped_traversal/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests passing by running `bundle` and `rake`.
+
+This gem is created by Wil Gieseler and is under the MIT License.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/scoped_traversal.rb

@@ -0,0 +1,3 @@
+require "scoped_traversal/version"
+require "scoped_traversal/model_additions"
+require "scoped_traversal/railtie" if defined? Rails

data/lib/scoped_traversal/model_additions.rb

@@ -0,0 +1,30 @@
+module ScopedTraversal
+  module ModelAdditions
+
+    def traverse_by(scope, options = {})
+        
+      if options[:namespace] == true
+        next_method_name       = "next_#{scope}"
+        previous_method_name   = "previous_#{scope}"
+      elsif options[:namespace]
+        next_method_name       = "next_#{options[:namespace]}"
+        previous_method_name   = "next_#{options[:namespace]}"
+      else
+        next_method_name       = "next"
+        previous_method_name   = "previous"
+      end
+
+      define_method next_method_name do
+        list = self.class.try(scope.to_sym).all
+        list[list.index(self) + 1]
+      end
+    
+      define_method previous_method_name do
+        list = self.class.try(scope.to_sym).all
+        list[list.index(self) - 1]
+      end
+    
+    end 
+
+  end
+end

data/lib/scoped_traversal/railtie.rb

@@ -0,0 +1,9 @@
+module ScopedTraversal
+  class Railtie < Rails::Railtie
+    initializer 'scoped_traversal.model_additions' do
+      ActiveSupport.on_load :active_record do
+        extend ModelAdditions
+      end
+    end
+  end
+end

data/lib/scoped_traversal/version.rb

@@ -0,0 +1,3 @@
+module ScopedTraversal
+  VERSION = "0.1"
+end

data/scoped_traversal.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "scoped_traversal/version"
+
+Gem::Specification.new do |s|
+  s.name        = "scoped_traversal"
+  s.version     = ScopedTraversal::VERSION
+  s.authors     = ["Wil Gieseler"]
+  s.email       = ["supapuerco@gmail.com"]
+  s.homepage    = "https://github.com/supapuerco/scoped_traversal"
+  s.summary     = %q{A simple way to traverse ActiveRecord models by an ordered column.}
+  s.description = %q{A simple way to traverse ActiveRecord models by an ordered column.}
+
+  s.rubyforge_project = "scoped_traversal"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rake"
+  # s.add_development_dependency "with_model"
+  s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/spec/scoped_traversal/model_additions_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'spec_helper'
+
+# class User < SuperModel::Base
+#   attributes :position
+#   
+#   scope :position, order(:position)
+#   
+#   ## Put in the shit!
+#   extend ScopedTraversal::ModelAdditions
+#   traverse_by :position
+# end
+
+describe ScopedTraversal::ModelAdditions do
+  
+  before(:each) do
+    @user1 = User.create!(position: 1)
+    @user2 = User.create!(position: 2)
+    @user3 = User.create!(position: 3)
+  end
+  
+  it "adds object#next to traverse forward" do
+    @user1.next.should eq(@user2)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'scoped_traversal'
+# require 'with_model'
+# 
+# RSpec.configure do |config|
+#   config.extend WithModel
+# end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: scoped_traversal
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.1"
+platform: ruby
+authors: 
+- Wil Gieseler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A simple way to traverse ActiveRecord models by an ordered column.
+email: 
+- supapuerco@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/scoped_traversal.rb
+- lib/scoped_traversal/model_additions.rb
+- lib/scoped_traversal/railtie.rb
+- lib/scoped_traversal/version.rb
+- scoped_traversal.gemspec
+- spec/scoped_traversal/model_additions_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/supapuerco/scoped_traversal
+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: scoped_traversal
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A simple way to traverse ActiveRecord models by an ordered column.
+test_files: 
+- spec/scoped_traversal/model_additions_spec.rb
+- spec/spec_helper.rb