by_star 2.0.0.beta1 → 2.1.0.beta2

data/.travis.yml

@@ -21,3 +21,5 @@ rvm:
   - 1.8.7
   - 1.9.3
   - 1.9.2
+
+services: mongodb

data/Gemfile.lock

@@ -1,85 +1,85 @@
 PATH
   remote: .
   specs:
-    by_star (2.0.0.beta)
-      activerecord (>= 2.0.0)
+    by_star (2.0.0.beta1)
+      activerecord (~> 3.0)
       chronic
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionpack (3.2.1)
-      activemodel (= 3.2.1)
-      activesupport (= 3.2.1)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
-      journey (~> 1.0.1)
+      journey (~> 1.0.4)
       rack (~> 1.4.0)
-      rack-cache (~> 1.1)
+      rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.1.2)
-    activemodel (3.2.1)
-      activesupport (= 3.2.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
       builder (~> 3.0.0)
-    activerecord (3.2.1)
-      activemodel (= 3.2.1)
-      activesupport (= 3.2.1)
-      arel (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.1)
+    activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    arel (3.0.0)
+    arel (3.0.2)
     builder (3.0.0)
-    chronic (0.6.7)
+    chronic (0.7.0)
     diff-lcs (1.1.3)
     erubis (2.7.0)
     hike (1.2.1)
-    i18n (0.6.0)
-    journey (1.0.1)
-    json (1.6.5)
-    multi_json (1.0.4)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.5)
+    multi_json (1.3.6)
     mysql2 (0.3.11)
-    pg (0.13.1)
+    pg (0.14.0)
     rack (1.4.1)
-    rack-cache (1.1)
+    rack-cache (1.2)
       rack (>= 0.4)
     rack-ssl (1.3.2)
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    railties (3.2.1)
-      actionpack (= 3.2.1)
-      activesupport (= 3.2.1)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
-      thor (~> 0.14.6)
+      thor (>= 0.14.6, < 2.0)
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
-    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)
-    rspec-rails (2.8.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    rspec-rails (2.11.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec (~> 2.8.0)
-    sprockets (2.1.2)
+      rspec (~> 2.11.0)
+    sprockets (2.1.3)
       hike (~> 1.2)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.5)
-    thor (0.14.6)
+    sqlite3 (1.3.6)
+    thor (0.16.0)
     tilt (1.3.3)
-    timecop (0.3.5)
-    tzinfo (0.3.31)
+    timecop (0.4.5)
+    tzinfo (0.3.33)
 
 PLATFORMS
   ruby

data/README.markdown

@@ -1,7 +1,31 @@
 # by_*
 
 
-by_* (by_star) is a plugin that allows you to find ActiveRecord objects given certain date objects. This was originally crafted for only finding objects within a given month, but now has extended out to much more. It now supports finding objects for:
+by_* (by_star) is a plugin that allows you to find ActiveRecord and/or Mongoid objects given certain date objects.
+
+## Installation
+
+Install this gem by adding this to your Gemfile:
+
+```ruby
+gem 'by_star', :git => "git://github.com/radar/by_star"
+```
+
+Then run `bundle install`.
+
+If you are using ActiveRecord, you're done!
+
+Mongoid users, please include the Mongoid::ByStar module for each model you wish to use the functionality. This is the convention among Mongoid plugins.
+
+```ruby
+class MyModel
+  include Mongoid::Document
+  include Mongoid::ByStar
+```
+
+## What it does
+
+This was originally crafted for only finding objects within a given month, but now has extended out to much more. It now supports finding objects for:
 
 * A given year
 * A given month
@@ -9,6 +33,8 @@ by_* (by_star) is a plugin that allows you to find ActiveRecord objects given ce
 * A given week
 * A given weekend
 * A given day
+* A given quarter
+* The weeks of a given month as shown on a calendar
 * The current weekend
 * The current work week
 * The Past
@@ -93,6 +119,14 @@ If you have a Time object you can use it to find the posts:
 
 This will find all the posts in November 2012.
 
+## By Calendar Month (`by_calendar_month`)
+
+Finds records for a given month as shown on a calendar. Includes all the results of `by_month`, plus any results which fall in the same week as the first and last of the month. Useful for working with UI calendars which show rows of weeks.
+
+    Post.by_calendar_month
+
+Parameter behavior is otherwise the same as `by_month`
+
 ## By Fortnight (`by_fortnight`)
 
 Fortnight numbering starts at 0. The beginning of a fortnight is Monday, 12am.
@@ -127,11 +161,11 @@ To find records based on a week, you can pass in a number (representing the week
 
     Post.by_week(36)
 
-This will return all posts in the 36th week of the current year.
+This will return all posts in the 37th week of the current year (remember week numbering starts at 0).
 
     Post.by_week(36, :year => 2012)
 
-This will return all posts in the 36th week of 2012.
+This will return all posts in the 37th week of 2012.
 
     Post.by_week(Time.local(2012,1,1))
 
@@ -160,6 +194,28 @@ You can also pass a string:
 
 This will return all posts for the given day.
 
+## By Quarter (`by_quarter`)
+
+Finds records by 3-month quarterly period of year. Quarter numbering starts at 1. The four quarters of the year begin on Jan 1, Apr 1, Jul 1, and Oct 1 respectively.
+
+To find records from the current quarter:
+
+    Post.by_quarter
+
+To find records based on a quarter, you can pass in a number (representing the quarter number) or a time object:
+
+    Post.by_quarter(4)
+
+This will return all posts in the 4th quarter of the current year.
+
+    Post.by_quarter(2, :year => 2012)
+
+This will return all posts in the 2nd quarter of 2012.
+
+    Post.by_week(Time.local(2012,1,1))
+
+This will return all posts from the first quarter of 2012.
+
 ## Tomorrow (`tomorrow`)
 
 *This method has been shown to be shifty when passed a `Date` object, it is recommended that you pass it an `ActiveSupport::TimeWithZone` object instead.*
@@ -194,37 +250,37 @@ You can also pass a string:
 
     Post.yesterday("next tuesday")
 
-## Past (`past`)
+## Before (`before`)
 
 To find all posts before the current time:
 
-    Post.past
+    Post.before
 
 To find all posts before certain time or date:
 
-    Post.past(Date.today + 2)
-    Post.past(Time.now + 5.days)
+    Post.before(Date.today + 2)
+    Post.before(Time.now + 5.days)
 
 You can also pass a string:
 
-    Post.past("next tuesday")
+    Post.before("next tuesday")
 
-## Future (`future`)
+## After (`after`)
 
 To find all posts after the current time:
 
-    Post.future
+    Post.after
 
 To find all posts after certain time or date:
 
-    Post.future(Date.today + 2)
-    Post.future(Time.now + 5.days)
+    Post.after(Date.today + 2)
+    Post.after(Time.now + 5.days)
 
 You can also pass a string:
 
-    Post.future("next tuesday")
+    Post.after("next tuesday")
 
-## Between (`between`)
+## Between (`between` or `between_times`)
 
 To find records between two times:
 
@@ -234,6 +290,10 @@ Also works with dates:
 
     Post.between(date1, date2)
 
+`between_times` is an alias for `between`:
+
+    Post.between_times(time1, time2)  #=> results identical to above
+
 ## Previous (`previous`)
 
 To find the record prior to this one call `previous` on any model instance:
@@ -268,6 +328,10 @@ Or if you're doing it all the time on your model, then it's best to use `by_star
       by_star_field :something_else
     end
 
+## Mongoid
+
+Mongoid is only tested/supported on version 3.0+
+
 ## Collaborators
 
 Thanks to Thomas Sinclair for the original bump for implementing it. I would like to thank #rubyonrails for their support and the following people:

data/by_star.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Ryan Bigg"]
   s.email       = ["radarlistener@gmail.com"]
-  s.homepage    = "http://rubygems.org/gems/by_star"
+  s.homepage    = "http://github.com/radar/by_star"
   s.summary     = "ActiveRecord extension for easier date scopes and time ranges"
   s.description = "ActiveRecord extension for easier date scopes and time ranges"
 
@@ -20,8 +20,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency "mysql2"
   s.add_development_dependency "rspec-rails", "~> 2.8"
   s.add_development_dependency "timecop", "~> 0.3"
+  s.add_development_dependency "mongoid", "~> 3.0" if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
 
-  s.add_dependency "activerecord", ">= 2.0.0"
+  s.add_dependency "activerecord", "~> 3.0"
   s.add_dependency "chronic"
 
   s.files        = `git ls-files`.split("\n")

data/lib/by_star.rb

@@ -10,12 +10,13 @@ require 'by_star/by_fortnight'
 require 'by_star/by_week'
 require 'by_star/by_weekend'
 require 'by_star/by_day'
+require 'by_star/by_quarter'
 
 module ByStar
 
   def by_star_field(field=nil)
     @by_star_field ||= field
-    @by_star_field || "created_at"
+    @by_star_field || "#{self.table_name}.created_at"
   end
 
   include ByDirection
@@ -25,6 +26,7 @@ module ByStar
   include ByWeek
   include ByWeekend
   include ByDay
+  include ByQuarter
 
   class ParseError < StandardError
 
@@ -40,6 +42,7 @@ module ByStar
     scope = scope.order(options[:order]) if options[:order]
     scope
   end
+  alias_method :between_times, :between
 
   private
 
@@ -57,7 +60,12 @@ module ByStar
 
 end
 
-ActiveRecord::Base.send :extend, ByStar
-ActiveRecord::Relation.send :extend, ByStar
+if defined?(ActiveRecord)
+  ActiveRecord::Base.send :extend, ByStar
+  ActiveRecord::Relation.send :extend, ByStar
+  ActiveRecord::Base.send :include, ByStar::InstanceMethods
+end
 
-ActiveRecord::Base.send :include, ByStar::InstanceMethods
+if defined?(Mongoid)
+  require 'mongoid/by_star'
+end

data/lib/by_star/by_day.rb

@@ -25,6 +25,10 @@ module ByStar
     def by_day_Time(time, options)
       between(time.beginning_of_day, time.end_of_day, options)
     end
+    alias_method :by_day_Date, :by_day_Time
 
+    def by_day_String(string, options)
+      by_day_Time(Time.parse(string), options)
+    end
   end
 end

data/lib/by_star/by_fortnight.rb

@@ -23,6 +23,10 @@ module ByStar
       between(start_time, (start_time + 2.weeks).end_of_day, options)
     end
 
+    def by_fortnight_Date(date, options={})
+      by_fortnight_Time(date.to_time, options)
+    end
+
     def by_fortnight_String_or_Fixnum(weeks, options={})
       weeks = weeks.to_i
       current_time = Time.zone.local(options[:year] || Time.zone.now.year)

data/lib/by_star/by_month.rb

@@ -6,30 +6,42 @@ module ByStar
     def by_month(*args)
       options = args.extract_options!
       time = args.first || Time.zone.now
-      send("by_month_#{time_klass(time)}", time, options)
+      send("by_month_#{time_klass(time)}", time, false, options)
+    end
+
+    def by_calendar_month(*args)
+      options = args.extract_options!
+      time = args.first || Time.zone.now
+      send("by_month_#{time_klass(time)}", time, true, options)
     end
 
     private
 
-    def by_month_Time(time, options={})
-      between(time.beginning_of_month, time.end_of_month, options)
+    def by_month_Time(time, is_calendar=false, options={})
+      if is_calendar
+        between(time.beginning_of_month.beginning_of_week, time.end_of_month.end_of_week, options)
+      else
+        between(time.beginning_of_month, time.end_of_month, options)
+      end
+    end
+
+    def by_month_Date(date, is_calendar=false, options={})
+      by_month_Time(date.to_time, is_calendar, options)
     end
 
-    def by_month_String_or_Fixnum(month, options={})
-      if valid_month?(month)
+    def by_month_String_or_Fixnum(month, is_calendar=false, options={})
+      begin
         year = options[:year] || Time.zone.now.year
-        by_month_Time("#{year}-#{month}-01".to_time, options)
-      else
+        date = Date.parse("#{year}-#{month}-01").to_time
+        by_month_Time(date, is_calendar, options)
+
+      rescue
         raise ParseError, "Month must be a number between 1 and 12 or the full month name (e.g. 'January', 'Feburary', etc.)"
       end
     end
+
     alias_method :by_month_String, :by_month_String_or_Fixnum
     alias_method :by_month_Fixnum, :by_month_String_or_Fixnum
 
-
-    def valid_month?(month)
-      (1..12).include?(month) || Date::MONTHNAMES.include?(month)
-    end
-
   end
 end

data/lib/by_star/by_quarter.rb

@@ -0,0 +1,32 @@
+module ByStar
+  module ByQuarter
+    # For reasoning why I use *args rather than variables here,
+    # please see the by_year method comments in lib/by_star/by_year.rb
+
+    def by_quarter(*args)
+      options = args.extract_options!.symbolize_keys!
+      time = args.first
+      time ||= Time.zone.local(options[:year], 1, 1) if options[:year]
+      time ||= Time.zone.now
+      send("by_quarter_#{time_klass(time)}", time, options)
+    end
+
+    private
+
+    def by_quarter_Time(time, options={})
+      between(time.beginning_of_quarter, time.end_of_quarter, options)
+    end
+
+    def by_quarter_Date(date, options={})
+      by_quarter_Time(date.to_time, options)
+    end
+
+    def by_quarter_Fixnum(quarter, options={})
+      raise 'Quarter must be a number between 1 and 4' unless quarter >= 1 && quarter <= 4
+      time = Time.zone.local(options[:year], 1, 1) if options[:year]
+      time ||= Time.zone.now
+      start_time = time.beginning_of_year + ((quarter.to_i - 1) * 3).months
+      between(start_time, start_time.end_of_quarter, options)
+    end
+  end
+end