simple_date_scopes 0.1.1 → 0.2.0

data/README.md

@@ -17,17 +17,17 @@ And then execute:
 
     $ bundle
 
-If you want to test that your models are using it properly, you can do:
-
-1. include it in spec_helper.rb
+Your models can now do:
 ```ruby
-require 'date_scopes/spec_support'
+class Widget < ActiveRecord::Base
+  acts_as_date_scopes
+end
 ```
 
-2. and inside your model_spec.rb
+Or alternatively if you want to specify the field for the logic:
 ```ruby
-it_should_behave_like 'shared date scopes' do
-    let(:kind) { MyModelName }
+class OtherWidget < ActiveRecord::Base
+  acts_as_date_scopes_on :produced_at
 end
 ```
 
@@ -41,9 +41,9 @@ Your ActiveRecord based models will now have the following automatic scopes:
 
 There are also utility scopes:
 
-* in\_year\_of
-* in\_month\_of
-* in\_week\_of
+* in\_year\_of [date]
+* in\_month\_of [date]
+* in\_week\_of [date]
 
 This means the following will work:
 
@@ -61,16 +61,26 @@ This means the following will work:
   end
 ```
 
-We can now also take a field to use instead of :created\_at:
+If you want to test that your models are using it properly, you can do:
 
+1. include it in spec\_helper.rb
 ```ruby
-  Widget.last_month(:start_production_time).limit(4).each do |w|
-    puts w.to_s
-  end
+require 'date_scopes/spec_support'
+```
+
+2. and inside your model\_spec.rb
+```ruby
+it_should_behave_like 'shared date scopes' do
+    let(:kind) { MyModelName }
+    let(:field) { :created_at }
+end
 ```
 
 # Changes
 
+## 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
 

data/lib/simple_date_scopes/simple_date_scopes.rb

@@ -1,43 +1,63 @@
 require 'active_record'
 
-module SimpleDateScopes
+module ActiveRecord
+  module Acts
+    module SimpleDateScopes
 
-  def self.included(base_class)
+      DEFAULT_FIELD = :created_at
 
-    base_class.extend(ClassMethods)
+      def self.included(base_class)
+        base_class.extend(ClassMethods)
+      end
 
-    base_class.class_eval do
+      module ClassMethods
 
-      base_class.extend(InstanceMethods)
+        def acts_as_date_scopes_on(field = DEFAULT_FIELD)
 
-      scope :in_week_of, ->(d,field = 'created_at') { in_x_of(d, field, :week) }
-      scope :last_week, ->(f = 'created_at') { in_week_of(Date.today - 7.days, f) }
-      scope :this_week, ->(f = 'created_at') { in_week_of(Date.today, f) }
-      scope :next_week, ->(f = 'created_at') { in_week_of(Date.today + 7.days, f) }
+          scope :yesterday, -> { in_x_of(Date.today - 1.day, field, :day) }
+          scope :today,     -> { in_x_of(Date.today, field, :day) }
+          scope :tomorrow,  -> { in_x_of(Date.today + 1.day, field, :day) }
 
-      scope :in_month_of, ->(d,field = 'created_at') { in_x_of(d, field, :month) }
-      scope :last_month, ->(f = 'created_at') { in_month_of(Date.today - 1.months, f) }
-      scope :this_month, ->(f = 'created_at') { in_month_of(Date.today, f) }
-      scope :next_month, ->(f = 'created_at') { in_month_of(Date.today + 1.months, f) }
+          scope :in_week_of, ->(date) { in_x_of(date, field, :week) }
+          scope :last_week, -> { in_week_of(Date.today - 7.days) }
+          scope :this_week, -> { in_week_of(Date.today) }
+          scope :next_week, -> { in_week_of(Date.today + 7.days) }
 
-      scope :in_year_of, ->(d,field = 'created_at') { in_x_of(d, field, :year) }
-      scope :last_year, ->(f = 'created_at') { in_year_of(Date.today - 1.years, f) }
-      scope :this_year, ->(f = 'created_at') { in_year_of(Date.today, f) }
-      scope :next_year, ->(f = 'created_at') { in_year_of(Date.today + 1.years, f) }
+          scope :in_month_of, ->(date) { in_x_of(date, field, :month) }
+          scope :last_month, -> { in_month_of(Date.today - 1.months) }
+          scope :this_month, -> { in_month_of(Date.today) }
+          scope :next_month, -> { in_month_of(Date.today + 1.months) }
 
-    end
-  end
+          scope :in_year_of, ->(date) { in_x_of(date, field, :year) }
+          scope :last_year, -> { in_year_of(Date.today - 1.years) }
+          scope :this_year, -> { in_year_of(Date.today) }
+          scope :next_year, -> { in_year_of(Date.today + 1.years) }
 
-  module ClassMethods
-    private
-    def in_x_of(date, field, method)
-      where("#{field} BETWEEN ? AND ?",
-            date.send("beginning_of_#{method.to_s}".to_sym).beginning_of_day,
-            date.send("end_of_#{method.to_s}".to_sym).end_of_day)
-    end
-  end
+          # extend SimpleDateScopes::SingletonMethods
+          # include SimpleDateScopes::InstanceMethods
 
-  module InstanceMethods
-  end
+        end
+
+        def acts_as_date_scopes
+          acts_as_date_scopes_on DEFAULT_FIELD
+        end
 
+        private
+        def in_x_of(date, field, method)
+          where("#{field.to_s} BETWEEN ? AND ?",
+                date.send("beginning_of_#{method.to_s}".to_sym).beginning_of_day,
+                date.send("end_of_#{method.to_s}".to_sym).end_of_day)
+        end
+      end
+
+      # module InstanceMethods
+      # end
+
+      # module SingletonMethods
+      # end
+
+    end
+  end
 end
+
+ActiveRecord::Base.send(:include, ActiveRecord::Acts::SimpleDateScopes)

data/lib/simple_date_scopes/spec_support.rb

@@ -1,9 +1,5 @@
 shared_examples_for 'simple date scopes' do
 
-  def debug_kind(kind)
-    kind.all.each { |i| p "#{i.id} #{i.created_at}" }
-  end
-
   before :each do
     @count = 4
     @count.times { FactoryGirl.create kind.name.underscore.to_sym }
@@ -16,35 +12,43 @@ shared_examples_for 'simple date scopes' do
   end
 
   it 'should support last_year, this_year and next_year' do
-    @old_item.update_attribute :created_at, Time.now - 1.years
-    @new_item.update_attribute :created_at, Time.now + 1.years
+    @old_item.update_attribute field, Time.now - 1.years
+    @new_item.update_attribute field, Time.now + 1.years
     kind.last_year.count.should eq(1)
     kind.this_year.count.should eq(2)
     kind.next_year.count.should eq(1)
   end
 
   it 'should support last_month, this_month and next_month' do
-    @old_item.update_attribute :created_at, Time.now - 1.months
-    @new_item.update_attribute :created_at, Time.now + 1.months
+    @old_item.update_attribute field, Time.now - 1.months
+    @new_item.update_attribute field, Time.now + 1.months
     kind.last_month.count.should eq(1)
     kind.this_month.count.should eq(2)
     kind.next_month.count.should eq(1)
   end
 
   it 'should support last_week, this_week and next_week' do
-    @old_item.update_attribute :created_at, Time.now - 1.weeks
-    @new_item.update_attribute :created_at, Time.now + 1.weeks
+    @old_item.update_attribute field, Time.now - 1.weeks
+    @new_item.update_attribute field, Time.now + 1.weeks
     kind.last_week.count.should eq(1)
     kind.this_week.count.should eq(2)
     kind.next_week.count.should eq(1)
   end
 
+  it 'should support yesterday, today and tomorrow' do
+    @old_item.update_attribute field, Time.now - 1.day
+    @new_item.update_attribute field, Time.now + 1.day
+    kind.yesterday.count.should eq(1)
+    kind.today.count.should eq(2)
+    kind.tomorrow.count.should eq(1)
+  end
+
   describe 'in_(week|month|year)_of' do
 
     let(:date) { Date.today - 3.years }
 
     before :each do
-      @old_item.update_attribute :created_at, date
+      @old_item.update_attribute field, date
     end
 
     it 'should support in_year_of' do
@@ -61,6 +65,34 @@ shared_examples_for 'simple date scopes' do
 
   end
 
+  describe 'handling days' do
+
+    it 'should work in the past' do
+      Timecop.travel(Date.today.beginning_of_day - 1.day) do
+        kind.yesterday.count.should eq(0)
+        kind.today.count.should eq(0)
+        kind.tomorrow.count.should eq(@count)
+      end
+    end
+
+    it 'should work currently' do
+      Timecop.travel(Date.today.beginning_of_day) do
+        kind.yesterday.count.should eq(0)
+        kind.today.count.should eq(@count)
+        kind.tomorrow.count.should eq(0)
+      end
+    end
+
+    it 'should work in the future' do
+      Timecop.travel(Date.today.beginning_of_day + 1.day) do
+        kind.yesterday.count.should eq(@count)
+        kind.today.count.should eq(0)
+        kind.tomorrow.count.should eq(0)
+      end
+    end
+
+  end
+
   describe 'handling weeks' do
 
     it 'should work in the past' do

data/lib/simple_date_scopes/version.rb

@@ -1,3 +1,3 @@
 module SimpleDateScopes
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/spec/lib/shared_date_scopes_spec.rb

@@ -1,13 +1,23 @@
 require 'spec_helper'
 
 class Widget < ActiveRecord::Base
-  include ::SimpleDateScopes
+  acts_as_date_scopes_on :updated_at
+end
+
+class DefaultWidget < ActiveRecord::Base
+  acts_as_date_scopes
 end
 
 describe 'Simple Date Scopes' do
 
   it_should_behave_like 'simple date scopes' do
     let(:kind) { Widget }
+    let(:field) { :updated_at }
+  end
+
+  it_should_behave_like 'simple date scopes' do
+    let(:kind) { DefaultWidget }
+    let(:field) { :created_at }
   end
 
 end

data/spec/spec_helper.rb

@@ -4,7 +4,10 @@ require 'factory_girl'
 require 'timecop'
 
 require 'simplecov'
-SimpleCov.start
+SimpleCov.start do
+  add_filter '/spec/support/'
+  add_filter 'spec_support.rb'
+end
 
 require 'simple_date_scopes'
 Dir[File.join(%w[ . spec support ** *.rb])].each {|f| require f}

data/spec/support/database.rb

@@ -7,6 +7,9 @@ ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
 ActiveRecord::Migration.create_table :widgets do |t|
   t.timestamps
 end
+ActiveRecord::Migration.create_table :default_widgets do |t|
+  t.timestamps
+end
 
 # add missing helpers
 module ActiveModel::Validations

data/spec/support/factories.rb

@@ -1,5 +1,6 @@
 FactoryGirl.define do
 
   factory :widget do ; end
+  factory :default_widget do ; end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_date_scopes
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-25 00:00:00.000000000 Z
+date: 2012-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -160,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2204942028803521934
+      hash: 4116473862507397523
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2204942028803521934
+      hash: 4116473862507397523
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23