by_star 2.2.0 → 2.2.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTIzYTk4N2IwY2ExNjIwNGNhNGRmODNiNjA3NGQ5YmQyYWI1ODkyZQ==
+    MWNiZTk1NWIxMjM1ZTY5ZDk1NWMzZjY5MWQ0ODM1NTU2MGU3YzRmZA==
   data.tar.gz: !binary |-
-    Zjg5MDgwZDMzMTcyOThlZGE4N2M4OTg5MmMzNDMxNzE0MGUyYjhlMg==
+    ZGI4N2RhZmViNWU3NzdjNTc5M2ZjYmU2ZDZlYTA1MzU0YjZmYzE4ZQ==
 SHA512:
   metadata.gz: !binary |-
-    MmU1OTgwYWY3YTBmMjQwMzgyYmI0YWNkMTkxM2I5NGMxZTQzYTI2MmEyYTIw
-    OTZjMmJiZmNkZjk4YTUyMmNkOTcxN2IyYjZjZjc4ZGFkMjE5YmNmNjUwNzhj
-    MzEyYTdlZTcyN2QwMjE1YzFjODIyYTA4ZTFkOTQ2ODVjMjJkZTI=
+    ZDYyMDZmNTFmYWYzMDg3OWNjZTU1YzNmMmRmNDYyNWRmOGYxNjJjOWE1ZTk5
+    OWExODkxZDA2ZGNjMDBlNDUwOTA0ZDZkMDMzMTE5MTMzYWYxMjkzYzE0NjFk
+    NjBhOThhMWMwNDMzYWU1NmYwOTlkMTI4ZDExZGU2YmRiOTUyY2U=
   data.tar.gz: !binary |-
-    YzVhM2U3YzRlZTE5ZWY4ZTdjZDc2MDc3MDI4YTVlMWU4OWY4MjNiM2Q3Y2Fk
-    N2JmNTdmN2M2YmNjYjY1MjJkZGUxMGVmNTdlNzA0OTBiNjJlZWRjN2RhOTcy
-    YWVhMzIwZmUxMjdjNWEwNmI2NjdiYWNiNGE4NjZhMjdjMmE1NDM=
+    ZTZiYzg5YWFmNzNkNmI2OTg4NTcwN2RkMDU3YjgwNDAyNTg0NzZmZTk5ZjNl
+    ZDIyYzM0YzgwZWM0Y2NiMzQzYTA1YjQ2ODliMzQ5NTNjZDhlZjAwYjJjOTEy
+    Y2QxYzY2NDVjMzUyZmVjYzczODNkMzMzM2E2MDM0ZDZiNzIyOGI=

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v2.2.1 - 2014-04-21
+
+* Allow `previous` and `next` to take the current record in their scope - @pnomolos / @johnnyshields
+* Alias `Date#in_time_zone` to `#to_time_in_current_zone` if not already defined (e.g. for Rails <= 3) - @jcypret / @johnnyshields
+* Add `oldest` and `newest` methods
+
 ## v2.2.0 - 2014-04-01
 
 * Add `:scope` parameter support on all finders - @pnomolos / @johnnyshields

data/README.md

@@ -82,16 +82,24 @@ and do not strictly end/begin evenly on a calendar week/month/year (unlike `by_*
 * `next_month` Subsequent 30-day period from current time
 * `next_year` Subsequent 365-day period from current time
 
+### Superlative Finders
+
+Find the oldest or newest records. Returns an object instance (not a relation):
+
+* `newest`
+* `oldest`
+
 ### Instance Methods
 
-In addition, ByStar adds instance methods to return the next / previous record in the timewise sequence:
+In addition, ByStar adds instance methods to return the next / previous record in the timewise sequence.
+Returns an object instance (not a relation):
 
 * `object.next`
 * `object.previous`
 
 ### Kernel Extensions
 
-Lastly, ByStar extends the kernel `Date`, `Time`, and `DateTime` objects with the following instance methods,
+ByStar extends the kernel `Date`, `Time`, and `DateTime` objects with the following instance methods,
 which mirror the ActiveSupport methods `beginning_of_day`, `end_of_week`, etc:
 
 * `beginning_of_weekend`
@@ -101,6 +109,8 @@ which mirror the ActiveSupport methods `beginning_of_day`, `end_of_week`, etc:
 * `beginning_of_calendar_month`
 * `end_of_calendar_month`
 
+Lastly, ByStar aliases Rails 3 `Date#to_time_in_current_zone` to the Rails 4 syntax `#in_time_zone`, if it has not already been defined.
+
 ## Usage
 
 ### Setting the Query Field
@@ -122,7 +132,8 @@ Alternatively, you may set a default in your model using the `by_star_field` mac
 
 ### Scoping the Find
 
-All ByStar methods (except `previous` and `next`) return `ActiveRecord::Relation` and/or `Mongoid::Criteria` objects, which can be daisy-chained with other scopes/finder methods:
+All ByStar methods (except `oldest`, `newest`, `previous`, `next`) return `ActiveRecord::Relation` and/or
+`Mongoid::Criteria` objects, which can be daisy-chained with other scopes/finder methods:
 
 ```ruby
    Post.by_month.your_scope
@@ -144,9 +155,15 @@ You may pass a `:scope` option as a Relation or Proc to all ByStar methods like
    @post.next(scope: ->{ where(category: 'blog') })
 ```
 
-This is particularly useful for `previous` and `next`, which return a model instance rather than
+This is particularly useful for `oldest`, `newest`, `previous`, `next` which return a model instance rather than
 a Relation and hence cannot be daisy-chained with other scopes.
 
+`previous` and `next` support a special feature that the `:scope` option may take the subject record as an argument:
+
+```ruby
+   @post.next(scope: ->(record){ where(category: record.category) })
+```
+
 You may also set a default scope in the `by_star_field` macro. (It is recommended this be a Proc):
 
 ```ruby

data/UPGRADING

@@ -1,7 +1,7 @@
-Upgrading to ByStar 2.2.0
--------------------------
+Upgrading ByStar
+----------------
 
-* ActiveRecord: the `between` method has been deprecated as of version 2.2.0, and will be removed in version 3.3.0.
+* ActiveRecord: the `between` method has been deprecated as of version 2.2.0, and will be removed in version 3.0.0.
 Please use `between_times` instead.
 
 * Mongoid: the `between` method has been removed as of version 2.2.0, as it conflicts with the native Mongoid `between`

data/lib/by_star.rb

@@ -1,4 +1,5 @@
-require 'by_star/kernel'
+require 'by_star/kernel/time'
+require 'by_star/kernel/date'
 require 'by_star/normalization'
 require 'by_star/between'
 require 'by_star/directional'

data/lib/by_star/base.rb

@@ -38,8 +38,10 @@ module ByStar
       if scope.is_a?(Proc)
         if scope.arity == 0
           return instance_exec(&scope)
+        elsif options[:scope_args]
+          return instance_exec(*Array(options[:scope_args]), &scope)
         else
-          return instance_exec(self, &scope)
+          raise 'ByStar :scope does not accept arguments'
         end
       else
         return scope

data/lib/by_star/directional.rb

@@ -17,5 +17,17 @@ module ByStar
       end
     end
     alias_method :after_now, :after
+
+    def oldest(*args)
+      with_by_star_options(*args) do |time, options|
+        oldest_query(options)
+      end
+    end
+
+    def newest(*args)
+      with_by_star_options(*args) do |time, options|
+        newest_query(options)
+      end
+    end
   end
 end

data/lib/by_star/kernel/date.rb

@@ -0,0 +1,19 @@
+module ByStar
+
+  module Kernel
+
+    module Date
+      extend ActiveSupport::Concern
+
+      included do
+
+        # Shim to alias Rails 3 #to_time_in_current_zone to Rails 4 name #in_time_zone
+        if method_defined?(:to_time_in_current_zone) && !method_defined?(:in_time_zone)
+          alias_method :in_time_zone, :to_time_in_current_zone
+        end
+      end
+    end
+  end
+end
+
+::Date.__send__(:include, ByStar::Kernel::Date)

data/lib/by_star/normalization.rb

@@ -8,9 +8,9 @@ module ByStar
 
       def time(value)
         case value
-          when String then time_string(value)
+          when String   then time_string(value)
           when DateTime then value.to_time
-          when Date then value.to_time_in_current_zone
+          when Date     then value.in_time_zone
           else value
         end
       end

data/lib/by_star/orm/active_record/by_star.rb

@@ -42,18 +42,28 @@ module ByStar
         field = by_star_start_field(options)
         by_star_scope(options).where("#{field} >= ?", time)
       end
+
+      def oldest_query(options={})
+        field = by_star_start_field(options)
+        by_star_scope(options).reorder("#{field} ASC").first
+      end
+
+      def newest_query(options={})
+        field = by_star_start_field(options)
+        by_star_scope(options).reorder("#{field} DESC").first
+      end
     end
 
     def previous(options={})
       field = self.class.by_star_start_field
       value = self.send(field.split(".").last)
-      self.class.by_star_scope(options).where("#{field} < ?", value).reorder("#{field} DESC").first
+      self.class.by_star_scope(options.merge(scope_args: self)).where("#{field} < ?", value).reorder("#{field} DESC").first
     end
 
     def next(options={})
       field = self.class.by_star_start_field
       value = self.send(field.split(".").last)
-      self.class.by_star_scope(options).where("#{field} > ?", value).reorder("#{field} ASC").first
+      self.class.by_star_scope(options.merge(scope_args: self)).where("#{field} > ?", value).reorder("#{field} ASC").first
     end
   end
 end

data/lib/by_star/orm/mongoid/by_star.rb

@@ -48,16 +48,26 @@ module Mongoid
         field = by_star_start_field(options)
         by_star_scope(options).gte(field => time)
       end
+
+      def oldest_query(options={})
+        field = by_star_start_field(options)
+        by_star_scope(options).order_by(field => :asc).first
+      end
+
+      def newest_query(options={})
+        field = by_star_start_field(options)
+        by_star_scope(options).order_by(field => :desc).first
+      end
     end
 
     def previous(options={})
       field = self.class.by_star_start_field
-      self.class.by_star_scope(options).lt(field => self.send(field)).desc(field).first
+      self.class.by_star_scope(options.merge(scope_args: self)).lt(field => self.send(field)).desc(field).first
     end
 
     def next(options={})
       field = self.class.by_star_start_field
-      self.class.by_star_scope(options).gt(field => self.send(field)).asc(field).first
+      self.class.by_star_scope(options.merge(scope_args: self)).gt(field => self.send(field)).asc(field).first
     end
   end
 end

data/lib/by_star/version.rb

@@ -1,3 +1,3 @@
 module ByStar
-  VERSION = '2.2.0'
+  VERSION = '2.2.1'
 end

data/spec/integration/shared/by_direction.rb

@@ -78,6 +78,44 @@ shared_examples_for 'by direction' do
     end
   end
 
+  describe '#oldest and #newest' do
+
+    context 'point-in-time' do
+      it { Post.newest.created_at.should eq Time.zone.parse('2014-04-15 17:00:00') }
+      it { Post.oldest.created_at.should eq Time.zone.parse('2013-11-01 17:00:00') }
+    end
+
+    context 'timespan' do
+      it { Event.newest.created_at.should eq Time.zone.parse('2014-04-15 17:00:00') }
+      it { Event.oldest.created_at.should eq Time.zone.parse('2013-11-01 17:00:00') }
+    end
+
+    context 'timespan strict' do
+      it { Event.newest(strict: true).created_at.should eq Time.zone.parse('2014-04-15 17:00:00') }
+      it { Event.oldest(strict: true).created_at.should eq Time.zone.parse('2013-11-01 17:00:00') }
+    end
+
+    context 'alternative field' do
+      it { Event.newest(field: 'created_at').created_at.should eq Time.zone.parse('2014-04-15 17:00:00') }
+      it { Event.oldest(field: 'created_at').created_at.should eq Time.zone.parse('2013-11-01 17:00:00') }
+    end
+
+    context 'with default scope' do
+      it { Appointment.newest(field: 'created_at').created_at.should eq Time.zone.parse('2014-04-01 17:00:00') }
+      it { Appointment.oldest(field: 'created_at').created_at.should eq Time.zone.parse('2013-11-01 17:00:00') }
+    end
+
+    context 'with scope as a query criteria' do
+      it { Post.newest(field: 'created_at', scope: Post.where(day_of_month: 5)).created_at.should eq Time.zone.parse('2014-01-05 17:00:00') }
+      it { Post.oldest(field: 'created_at', scope: Post.where(day_of_month: 5)).created_at.should eq Time.zone.parse('2013-12-05 17:00:00') }
+    end
+
+    context 'with scope as a proc' do
+      it { Post.newest(field: 'created_at', scope: ->{ where(day_of_month: 5) }).created_at.should eq Time.zone.parse('2014-01-05 17:00:00') }
+      it { Post.oldest(field: 'created_at', scope: ->{ where(day_of_month: 5) }).created_at.should eq Time.zone.parse('2013-12-05 17:00:00') }
+    end
+  end
+
   describe '#previous and #next' do
 
     context 'point-in-time' do
@@ -107,8 +145,9 @@ shared_examples_for 'by direction' do
     context 'with scope as a proc' do
       subject { Post.where(created_at: Time.zone.parse('2014-01-05 17:00:00')).first }
       it{ subject.previous({ scope: Proc.new{ where(day_of_month: 5) } }).created_at.should eq Time.zone.parse('2013-12-05 17:00:00') }
+      it{ subject.previous({ scope: Proc.new{|record| where(day_of_month: record.day_of_month) } }).created_at.should eq Time.zone.parse('2013-12-05 17:00:00') }
       it{ subject.next({ scope: ->{ where(day_of_month: 1) } }).created_at.should eq Time.zone.parse('2014-02-01 17:00:00') }
-      it{ subject.next({ scope: ->(klass){ klass.where(day_of_month: 1) } }).created_at.should eq Time.zone.parse('2014-02-01 17:00:00') }
+      it{ subject.next({ scope: ->(record){ where(day_of_month: record.day_of_month - 4) } }).created_at.should eq Time.zone.parse('2014-02-01 17:00:00') }
     end
   end
 end

data/spec/integration/shared/scope_parameter.rb

@@ -19,11 +19,26 @@ shared_examples_for 'scope parameter' do
       its(:count) { should eq 14 }
     end
 
-    context 'between_times with scope override as a Proc' do
+    context 'between_times with scope override as a Lambda' do
       subject { Appointment.between_times(Date.parse('2013-12-01'), Date.parse('2014-02-01'), scope: ->{ unscoped }) }
       its(:count) { should eq 14 }
     end
 
+    context 'between_times with scope override as a Lambda' do
+      subject { Appointment.between_times(Date.parse('2013-12-01'), Date.parse('2014-02-01'), scope: ->(x){ unscoped }) }
+      it{ ->{subject}.should raise_error }
+    end
+
+    context 'between_times with scope override as a Proc with arguments' do
+      subject { Appointment.between_times(Date.parse('2013-12-01'), Date.parse('2014-02-01'), scope: Proc.new{ unscoped }) }
+      its(:count) { should eq 14 }
+    end
+
+    context 'between_times with scope override as a Proc with arguments' do
+      subject { Appointment.between_times(Date.parse('2013-12-01'), Date.parse('2014-02-01'), scope: Proc.new{|x,y| unscoped }) }
+      it{ ->{subject}.should raise_error }
+    end
+
     context 'by_month with default scope' do
       subject { Appointment.by_month(Date.parse('2014-01-01')) }
       its(:count) { should eq 2 }
@@ -34,9 +49,24 @@ shared_examples_for 'scope parameter' do
       its(:count) { should eq 6 }
     end
 
-    context 'by_month with scope override as a Proc' do
+    context 'by_month with scope override as a Lambda' do
       subject { Appointment.by_month(Date.parse('2014-01-01'), scope: ->{ unscoped }) }
       its(:count) { should eq 6 }
     end
+
+    context 'by_month with scope override as a Lambda with arguments' do
+      subject { Appointment.by_month(Date.parse('2014-01-01'), scope: ->(x){ unscoped }) }
+      it{ ->{subject}.should raise_error }
+    end
+
+    context 'by_month with scope override as a Proc' do
+      subject { Appointment.by_month(Date.parse('2014-01-01'), scope: Proc.new{ unscoped }) }
+      its(:count) { should eq 6 }
+    end
+
+    context 'by_month with scope override as a Proc with arguments' do
+      subject { Appointment.by_month(Date.parse('2014-01-01'), scope: Proc.new{|x| unscoped }) }
+      it{ ->{subject}.should raise_error }
+    end
   end
 end

data/spec/unit/kernel_date_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Date do
+
+  describe '#in_time_zone' do
+
+    subject { Date.new }
+
+    before do
+      stub_const('Date', Class.new)
+      Date.any_instance.stub(:to_time_in_current_zone)
+    end
+
+    context 'when #in_time_zone is already defined' do
+      before do
+        Date.any_instance.should_receive(:in_time_zone)
+      end
+
+      context 'when ByStar::Kernel::Date included' do
+        before do
+          ::Date.__send__(:include, ByStar::Kernel::Date)
+        end
+
+        it 'should not be aliased to #to_time_in_current_zone' do
+          subject.should_not_receive(:to_time_in_current_zone)
+          subject.in_time_zone
+        end
+      end
+
+      context 'when ByStar::Kernel::Date not included' do
+
+        it 'should not be aliased to #to_time_in_current_zone' do
+          subject.should_not_receive(:to_time_in_current_zone)
+          subject.in_time_zone
+        end
+      end
+    end
+
+    context 'when #in_time_zone is not defined' do
+
+      context 'when ByStar::Kernel::Date included' do
+        before do
+          ::Date.__send__(:include, ByStar::Kernel::Date)
+        end
+
+        it 'should be aliased to #to_time_in_current_zone' do
+          subject.should_receive(:to_time_in_current_zone)
+          subject.in_time_zone
+        end
+      end
+
+      context 'when ByStar::Kernel::Date not included' do
+
+        it 'should raise NoMethodError' do
+          ->{ subject.in_time_zone }.should raise_error(NoMethodError)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: by_star
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Ryan Bigg
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-01 00:00:00.000000000 Z
+date: 2014-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -186,7 +186,8 @@ files:
 - lib/by_star/base.rb
 - lib/by_star/between.rb
 - lib/by_star/directional.rb
-- lib/by_star/kernel.rb
+- lib/by_star/kernel/date.rb
+- lib/by_star/kernel/time.rb
 - lib/by_star/normalization.rb
 - lib/by_star/orm/active_record/by_star.rb
 - lib/by_star/orm/mongoid/by_star.rb
@@ -211,19 +212,20 @@ files:
 - spec/integration/shared/relative.rb
 - spec/integration/shared/scope_parameter.rb
 - spec/spec_helper.rb
+- spec/unit/kernel_date_spec.rb
 - spec/unit/kernel_time_spec.rb
 - spec/unit/normalization_spec.rb
 - tmp/.gitignore
 homepage: http://github.com/radar/by_star
 licenses: []
 metadata: {}
-post_install_message: ! 'Upgrading to ByStar 2.2.0
+post_install_message: ! 'Upgrading ByStar
 
-  -------------------------
+  ----------------
 
 
   * ActiveRecord: the `between` method has been deprecated as of version 2.2.0, and
-  will be removed in version 3.3.0.
+  will be removed in version 3.0.0.
 
   Please use `between_times` instead.
 
@@ -283,6 +285,7 @@ test_files:
 - spec/integration/shared/relative.rb
 - spec/integration/shared/scope_parameter.rb
 - spec/spec_helper.rb
+- spec/unit/kernel_date_spec.rb
 - spec/unit/kernel_time_spec.rb
 - spec/unit/normalization_spec.rb
 has_rdoc: