DateScopes

A super tiny gem that provides basic year, month and week scopes.

Build Status

Something like this already existed in various forms but I simply wanted to do my own thing instead.

Installation

Add this line to your application's Gemfile:

gem 'date_scopes'

And then execute:

$ bundle

Your models can now do:

class Widget < ActiveRecord::Base
  acts_as_date_scopes
end

Or alternatively if you want to specify the field for the logic:

class OtherWidget < ActiveRecord::Base
  acts_as_date_scopes_on :produced_at
end

Usage

Your ActiveRecord based models will now have the following automatic scopes:

  • last_year, this_year, next_year
  • last_month, this_month, next_month
  • last_week, this_week, next_week

There are also utility scopes:

  • in_year_of [date]
  • in_month_of [date]
  • in_week_of [date]

This means the following will work:

Widget.this_month.each do |w|
  puts w.to_s
end

Widget.last_month.limit(4).each do |w|
  puts w.to_s
end

Widget.in_month_of(Date.new(2012, 2, 7)).each do |w|
  puts w.to_s
end

If you want to test that your models are using it properly, you can do:

  1. include it in spec_helper.rb

    require 'date_scopes/spec_support'

  2. and inside your model_spec.rb

    it_should_behave_like 'shared date scopes' do
let(:kind) { MyModelName }
let(:field) { :created_at }
end

Changes

0.3.0

  • Changed the API again for specs, so we do not have to specify the field. Just skip 0.2.0.

0.2.0

  • Use class methods instead so we can just specify the data field once

0.1.1

  • Refactoring to use a common private method instead of 3 almost identical methods

0.1.0

  • Renamed to simple_date_scopes so we can push to rubygems

0.0.5-0.0.7

  • Cleanups

0.0.4

  • Fixed a nasty bug that made the scopes ignore records created on the current date
  • Make the specs run properly when included
  • Added support for specifying another field instead of :created_at

0.0.2/3

  • More specs

0.0.1

  • Initial version

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request