by_star 0.6.4 → 0.7.0

data/README.markdown

@@ -32,7 +32,7 @@ You can treat all `by_*` methods exactly how you would treat `named_scope`s: the
     
 Where `my_special_scope` is a `named_scope` you have specified.
 
-All the `by_*` methods take a block which will then scope the find based on the options passed into it. You can also specify these options for each method, but the syntax may differ. The supported options are the same options that are supported by `find` from ActiveRecord. Please note that if you want to use conditions you *have* to use this syntax:
+All the `by_*` methods, with the exception of `previous` and `next`, take a block which will then scope the find based on the options passed into it. You can also specify these options for each method, but the syntax may differ. The supported options are the same options that are supported by `find` from ActiveRecord. Please note that if you want to use conditions you *have* to use this syntax:
 
      Post.by_month(1) { { :include => "tags", :conditions => ["tags.name = ?", 'ruby'] } }
 
@@ -361,6 +361,26 @@ To find records up to a certain time from the current time:
 
     Post.up_to_6_weeks_from_now
 
+## Previous (`previous`)
+
+To find the record prior to this one call `previous` on any model instance:
+
+    Post.last.previous
+  
+You can specify a field also:
+
+    Post.last.previous("published_at")
+
+## Next (`next`)
+
+To find the record after this one call `next` on any model instance:
+
+    Post.last.next
+
+You can specify a field also:
+
+    Post.last.next("published_at")
+
 ## Not using created_at? No worries!
 
 If your database uses something other than `created_at` for storing a timestamp, you can specify the field option like this:

data/VERSION

@@ -1 +1 @@
-0.6.4
+0.7.0

data/by_star.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{by_star}
-  s.version = "0.6.4"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Bigg", "Mislav Marohni\304\207"]
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
      "lib/calculations.rb",
      "lib/calculations/count.rb",
      "lib/calculations/sum.rb",
+     "lib/neighbours.rb",
      "lib/range_calculations.rb",
      "lib/shared.rb",
      "lib/time_ext.rb",

data/lib/by_star.rb

@@ -3,6 +3,7 @@ require 'shared'
 require 'range_calculations'
 require 'time_ext'
 require 'vanilla'
+require 'neighbours'
 
 Dir[File.dirname(__FILE__) + '/calculations/*.rb'].each { |file| require file }
 require 'calculations'
@@ -10,6 +11,7 @@ module ByStar
 
   def self.included(base)
     base.extend ClassMethods
+    base.send(:include, InstanceMethods)
   end
 
   module ClassMethods
@@ -18,6 +20,10 @@ module ByStar
     include Vanilla
     include Calculations
   end
+  
+  module InstanceMethods
+    include Neighbours
+  end
 
   class ParseError < Exception; end
   class MonthNotFound < Exception; end

data/lib/neighbours.rb

@@ -0,0 +1,13 @@
+module ByStar
+  module Neighbours
+    # Find the previous record to this.
+    def previous(field="created_at")
+      self.class.past(self.send(field)) { { :order => "#{field} DESC" }}.first
+    end
+    
+    # Find the next record to this.
+    def next(field="created_at")
+      self.class.future(self.send(field)) { { :order => "#{field} ASC" }}.first
+    end
+  end
+end

data/spec/by_star_spec.rb

@@ -641,6 +641,23 @@ describe Post do
 
     end
     
+    describe "directional finders" do
+      subject { Post.today.first }
+      
+      describe "previous" do
+        it "should find the post previous to it" do
+          subject.previous.text.should eql("Yesterday's post")
+        end
+      end
+    
+    
+      describe "next" do
+        it "should find the post next to it" do
+          subject.next.text.should eql("Tomorrow's post")
+        end
+      end
+    end
+    
     describe "chaining of methods" do
       # a by_star and a by_direction method, in that order
       it "should be able to chain today and past" do
@@ -653,7 +670,7 @@ describe Post do
       end
       
     end
-
+    
     describe "edge cases" do
       # This method previously generated sql like: `day_entries`.`spent_at`.`spent_at`.`spent_at`.`spent_at`
       # Which is *obviously* incorrect and #omg worthy.

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 4
-  version: 0.6.4
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Ryan Bigg
@@ -65,6 +65,7 @@ files:
 - lib/calculations.rb
 - lib/calculations/count.rb
 - lib/calculations/sum.rb
+- lib/neighbours.rb
 - lib/range_calculations.rb
 - lib/shared.rb
 - lib/time_ext.rb