by_star 1.0.1 → 2.0.0.beta1

data/.travis.yml

@@ -0,0 +1,23 @@
+before_script:
+  - "mysql -e 'create database by_star_test;'"
+  - "psql -c 'create database by_star_test;' -U postgres"
+
+env:
+  - DB=sqlite
+  - DB=mysql
+  - DB=postgres
+
+script: "DISPLAY=:99.0 bundle exec rspec spec/by_star"
+
+notifications:
+  email:
+    - radarlistener@gmail.com
+
+branches:
+  only:
+    - master
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 1.9.2

data/Gemfile

@@ -1,10 +1,4 @@
-source :gemcutter
-
-group :test do
-  gem 'rspec', '~> 2.6.0'
-  gem 'mysql'
-  gem 'sqlite3-ruby'
-end
+source "http://rubygems.org"
 
 # Specify your gem's dependencies in by_star.gemspec
 gemspec

data/Gemfile.lock

@@ -1,39 +1,85 @@
 PATH
   remote: .
   specs:
-    by_star (1.0.0)
+    by_star (2.0.0.beta)
       activerecord (>= 2.0.0)
       chronic
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.7)
-      activesupport (= 3.0.7)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activerecord (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activesupport (3.0.7)
-    arel (2.0.10)
-    builder (2.1.2)
-    chronic (0.3.0)
-    diff-lcs (1.1.2)
-    i18n (0.5.0)
-    mysql (2.8.1)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.3)
-    rspec-expectations (2.6.0)
+    actionpack (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+    activerecord (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      arel (~> 3.0.0)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.0)
+    builder (3.0.0)
+    chronic (0.6.7)
+    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)
+    mysql2 (0.3.11)
+    pg (0.13.1)
+    rack (1.4.1)
+    rack-cache (1.1)
+      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)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    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.6.0)
-    sqlite3-ruby (1.3.1)
-    tzinfo (0.3.27)
+    rspec-mocks (2.8.0)
+    rspec-rails (2.8.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.8.0)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
+    thor (0.14.6)
+    tilt (1.3.3)
+    timecop (0.3.5)
+    tzinfo (0.3.31)
 
 PLATFORMS
   ruby
@@ -41,6 +87,8 @@ PLATFORMS
 DEPENDENCIES
   bundler (>= 1.0.0)
   by_star!
-  mysql
-  rspec (~> 2.6.0)
-  sqlite3-ruby
+  mysql2
+  pg
+  rspec-rails (~> 2.8)
+  sqlite3
+  timecop (~> 0.3)

data/README.markdown

@@ -1,7 +1,7 @@
 # by_*
 
 
-by_* (byStar) 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 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:
 
 * A given year
 * A given month
@@ -14,8 +14,6 @@ by_* (byStar) is a plugin that allows you to find ActiveRecord objects given cer
 * The Past
 * The Future
 * Between certain times
-* As of a certain time
-* Up to a certain time
 * Before a specific record
 * After a specific record
 
@@ -23,47 +21,32 @@ All methods return scopes. I love these. You love these. Everybody loves these.
 
 It also allows you to do nested finds on the records returned which I personally think is the coolest feature of the whole plugin:
 
-    Post.by_month(1) do
-      { :include => "tags", :conditions => ["tags.name = ?", 'ruby'] }
-    end
+    Post.by_month(1).include(:tags).where("tags.name" => "ruby")
 
 If you're not using the standard `created_at` field: don't worry! I've covered that scenario too.
 
 ## Scoping the find
 
-You can treat all `by_*` methods exactly how you would treat `named_scope`s: they are effectively scopes in their own right. This means you are able to call them like this:
+You can treat all `by_*` methods exactly how you would treat normal, every-day ActiveRecord scopes. This is because all `by_*` methods return `ActiveRecord::Relation` objects, with the exception of `previous` and `next`, which return a single record. You can call them like this:
 
-    Post.by_month.my_special_scope
+    Post.by_month.your_scope
 
 Where `my_special_scope` is a `named_scope` you have specified.
 
-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'] } }
-
-or the lengthened:
-
-     Post.by_month(1) do
-       { :include => "tags", :conditions => ["tags.name = ?", 'ruby'] }
-     end
-
-An alternative syntax to this is:
+You can also call typical `ActiveRecord::Relation` methods on the `by_*` methods (like I showed before):
 
-     Post.by_month(1, { :include => "tags", :conditions => ["tags.name = ?", 'ruby'] })
+   Post.by_month.include(:tags).where("tags.name" => "ruby")
 
+Want to count records? Simple:
 
-## count_by* methods
+   Post.by_month.count
 
-`count_by` methods can be scoped to only count those records which have a specific field set, and you do this by specifying the symbol version of the name of the field, e.g;
 
-    Invoice.count_by_year(:value)
-
-If you want to specify further arguments but do not care about the scoped field:
+## By Year (`by_year`)
 
-    Invoice.count_by_year(:all, 2009)
+To find records from the current year, simply call the method without any arguments:
 
-
-## By Year (`by_year`)
+    Post.by_year
 
 To find records based on a year you can pass it a two or four digit number:
 
@@ -80,36 +63,6 @@ You can also specify the full year:
     Post.by_year(2009)
     Post.by_year(1999)
 
-When you specify a year *less than* 1902 and *greater than* 2039 using specific versions of Ruby (i.e. 1.8.6p114) an `ArgumentError` will be raised. We recommend you upgrade Ruby to *at least* 1.8.7 to stop this problem occuring.
-
-## Sum By Year (`sum_by_year`)
-
-To sum records for the current year based on a field:
-
-    Invoice.sum_by_year(:value)
-
-To sum records for a year based on a field:
-
-    Invoice.sum_by_year(:value, 09)
-
-You can also pass it a full year:
-
-    Invoice.sum_by_year(:value, 2009)
-
-## Count By Year (`count_by_year`)
-
-To count the records in the current year regardless of field:
-
-    Invoice.count_by_year
-
-To count records in the current year where only a specific field is set:
-
-    Invoice.count_by_year(:value)
-
-To count records in a different year regardless of field:
-
-    Invoice.count_by_year(:all, :year => 2009)
-
 ## By Month (`by_month`)
 
 If you know the number of the month you want:
@@ -136,52 +89,9 @@ This will perform a find using the column you've specified.
 
 If you have a Time object you can use it to find the posts:
 
-     Post.by_month(Time.local(2008, 11, 24))
-
-This will find all the posts in November 2008.
-
-When you specify a year *less than* 1902 and *greater than* 2039 using specific versions of Ruby (i.e. 1.8.6p114) an `ArgumentError` will be raised. We recommend you upgrade Ruby to *at least* 1.8.7 to stop this problem occuring.
-
-
-## Sum By Month (`sum_by_month`)
-
-To sum records for the current month:
-
-    Invoice.sum_by_month
-
-To sum records for a numbered month based on a field:
-
-    Invoice.sum_by_month(:value, 9)
-
-You can also specify the name of the month:
-
-    Invoice.sum_by_month(:value, "September")
-
-You can also lookup on a different year:
-
-    Invoice.sum_by_year(:value, 9, :year => "2009")
-
-## Count By Month (`count_by_month`)
+     Post.by_month(Time.local(2012, 11, 24))
 
-To count records for the current month regardless of field:
-
-    Invoice.count_by_month
-
-To count records for the current month where only a specific field is set:
-
-    Invoice.count_by_month(:value)
-
-To count records for a different month regardless of field:
-
-    Invoice.count_by_month(:all, 9)
-
-To count records for a different month in the current year:
-
-    Invoice.count_by_month(:number, 9)
-
-To count records for a different month in a different year:
-
-    Invoice.count_by_month(:number, 9, :year => 2008)
+This will find all the posts in November 2012.
 
 ## By Fortnight (`by_fortnight`)
 
@@ -197,13 +107,13 @@ To find records based on a fortnight, you can pass in a number (representing the
 
 This will return all posts in the 18th fortnight of the current year.
 
-    Post.by_fortnight(18, :year => 2008)
+    Post.by_fortnight(18, :year => 2012)
 
-This will return all posts in the 18th fortnight week of 2008.
+This will return all posts in the 18th fortnight week of 2012.
 
-    Post.by_fortnight(Time.local(2008,1,1))
+    Post.by_fortnight(Time.local(2012,1,1))
 
-This will return all posts from the first fortnight of 2008.
+This will return all posts from the first fortnight of 2012.
 
 ## By Week (`by_week`)
 
@@ -219,13 +129,13 @@ To find records based on a week, you can pass in a number (representing the week
 
 This will return all posts in the 36th week of the current year.
 
-    Post.by_week(36, :year => 2008)
+    Post.by_week(36, :year => 2012)
 
-This will return all posts in the 36th week of 2008.
+This will return all posts in the 36th week of 2012.
 
-    Post.by_week(Time.local(2008,1,1))
+    Post.by_week(Time.local(2012,1,1))
 
-This will return all posts from the first week of 2008.
+This will return all posts from the first week of 2012.
 
 ## By Weekend (`by_weekend`)
 
@@ -242,7 +152,7 @@ To find records for today:
 
 To find records for a certain day:
 
-    Post.by_day(Time.local(2008, 1, 1))
+    Post.by_day(Time.local(2012, 1, 1))
 
 You can also pass a string:
 
@@ -250,33 +160,9 @@ You can also pass a string:
 
 This will return all posts for the given day.
 
-## Sum By Day (`sum_by_day`)
-
-
-To sum records for the current day:
-
-    Event.sum_by_day
-
-The `sum_by_day` method's second argument works in the same was as `by_day`, accepting Time, String, Date and chronicable strings:
-
-    Event.sum_by_day(:value, Time.now)
-    Event.sum_by_day(:value, Date.today)
-
-
-## Current Weekend (`by_current_weekend`)
-
-If you are currently in a weekend (between 3pm Friday and 3am Monday) this will find all records starting at 3pm the previous Friday up until 3am, Monday.
-
-If you are not in a weekend (between 3am Monday and 3pm Friday) this will find all records from the next Friday 3pm to the following Monday 3am.
-
-## Current Work Week (`by_current_work_week`)
-
-If you are currently in a work week (between 3am Monday and 3pm Friday) this will find all records in that range. If you are currently in a weekend (between 3pm Friday and 3am Monday) this will return all records in the upcoming work week.
-
-
 ## Tomorrow (`tomorrow`)
 
-*This method has been shown to be shifty when passed a `Date` object, it is recommended that you pass it a `Time` object instead.*
+*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.*
 
 To find all posts from the day after the current date:
 
@@ -293,7 +179,7 @@ You can also pass a string:
 
 ## Yesterday (`yesterday`)
 
-*This method has been shown to be shifty when passed a `Date` object, it is recommended that you pass it a `Time` object instead.*
+*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.*
 
 To find all posts from the day before the current date:
 
@@ -348,24 +234,6 @@ Also works with dates:
 
     Post.between(date1, date2)
 
-And with strings:
-
-    Post.between("last tuesday", "next wednesday")
-
-## As of (`as_of_<dynamic>`)
-
-To find records as of a certain date up until the current time:
-
-    Post.as_of_2_weeks_ago
-
-This uses the Chronic "human mind reading" (read: it's really good at determining what time you mean using written English) library to work it out.
-
-## Up to (`up_to_<dynamic>`)
-
-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:
@@ -400,29 +268,17 @@ 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
 
-## Ordering records
-
-To order the returned set of records you may specify an `:order` option which works the same was as a standard AR `:order` option:
-
-     Item.by_month(1, :order => "position DESC")
-
-
-## "Chronicable string"
-
-This means a string that can be parsed with the Chronic gem.
-
 ## Collaborators
 
-Unfortunately I forget who exactly prompted me to write the plugin, but I would like to thank #rubyonrails for their support and the following people:
+Thanks to Thomas Sinclair for the original bump for implementing it. I would like to thank #rubyonrails for their support and the following people:
 
 * Mislav Marohnic
 * August Lilleas (leethal)
 * gte351s
-* Thomase Sinclair (anathematic)
-* Sam Elliott (lenaryg)
-* The dude(s) & gal(s) who created Chronic
+* Sam Elliott (lenary)
+* The people who created Chronic
 * Erik Fonselius
 
 ## Suggestions?
 
-If you have suggestions, please contact me at radarlistener@gmail.com
+If you have suggestions, please contact me at radarlistener@gmail.com