simple_date_scopes 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--no-drb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in date_scopes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Peter Hoeg
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# DateScopes
+
+A super tiny gem that provides basic year, month and week scopes.
+
+[![Build Status](https://secure.travis-ci.org/speartail/date_scopes.png)](http://travis-ci.org/speartail/date_scopes)
+
+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
+
+If you want to test that your models are using it properly, you can do:
+
+1. include it in spec_helper.rb
+```ruby
+require 'date_scopes/spec_support'
+```
+
+2. and inside your model_spec.rb
+```ruby
+it_should_behave_like 'shared date scopes' do
+    let(:kind) { MyModelName }
+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
+* in\_month\_of
+* in\_week\_of
+
+This means the following will work:
+
+```ruby
+  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
+```
+
+We can now also take a field to use instead of :created\_at:
+
+```ruby
+  Widget.last_month(:start_production_time).limit(4).each do |w|
+    puts w.to_s
+  end
+```
+
+# Changes
+
+## 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

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task default: :spec

data/lib/simple_date_scopes.rb

@@ -0,0 +1,5 @@
+require 'simple_date_scopes/version'
+require 'simple_date_scopes/simple_date_scopes'
+
+module SimpleDateScopes
+end

data/lib/simple_date_scopes/simple_date_scopes.rb

@@ -0,0 +1,46 @@
+require 'active_record'
+
+module SimpleDateScopes
+
+  def self.included(base_class)
+
+    base_class.extend(ClassMethods)
+
+    base_class.class_eval do
+
+      base_class.extend(InstanceMethods)
+
+      scope :in_week_of, ->(d,field = 'created_at') { where("#{field} BETWEEN ? AND ?",
+                                             d.beginning_of_week.beginning_of_day,
+                                             d.end_of_week.end_of_day ) }
+      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 :in_month_of, ->(d,field = 'created_at') { where("#{field} BETWEEN ? AND ?",
+                                             d.beginning_of_month.beginning_of_day,
+                                             d.end_of_month.end_of_day ) }
+      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_year_of, ->(d,field = 'created_at') { where("#{field} BETWEEN ? AND ?",
+                                             d.beginning_of_year.beginning_of_day,
+                                             d.end_of_year.end_of_day ) }
+      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) }
+
+      private
+      def in_x_of(date, field, method)
+      end
+    end
+  end
+
+  module ClassMethods
+  end
+
+  module InstanceMethods
+  end
+
+end

data/lib/simple_date_scopes/spec_support.rb

@@ -0,0 +1,147 @@
+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 }
+    @old_item = kind.first
+    @new_item = kind.last
+  end
+
+  it "should have 4 items" do
+    kind.count.should eq(4)
+  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
+    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
+    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
+    kind.last_week.count.should eq(1)
+    kind.this_week.count.should eq(2)
+    kind.next_week.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
+    end
+
+    it 'should support in_year_of' do
+      kind.in_year_of(date).length.should eq(1)
+    end
+
+    it 'should support in_month_of' do
+      kind.in_month_of(date).length.should eq(1)
+    end
+
+    it 'should support in_week_of' do
+      kind.in_week_of(date).length.should eq(1)
+    end
+
+  end
+
+  describe 'handling weeks' do
+
+    it 'should work in the past' do
+      Timecop.travel(Date.today.beginning_of_week - 1.weeks) do
+        kind.last_week.count.should eq(0)
+        kind.this_week.count.should eq(0)
+        kind.next_week.count.should eq(@count)
+      end
+    end
+
+    it 'should work currently' do
+      Timecop.travel(Date.today.beginning_of_week) do
+        kind.last_week.count.should eq(0)
+        kind.this_week.count.should eq(@count)
+        kind.next_week.count.should eq(0)
+      end
+    end
+
+    it 'should work in the future' do
+      Timecop.travel(Date.today.beginning_of_week + 1.weeks) do
+        kind.last_week.count.should eq(@count)
+        kind.this_week.count.should eq(0)
+        kind.next_week.count.should eq(0)
+      end
+    end
+
+  end
+
+  describe 'handling months' do
+
+    it 'should work in the past' do
+      Timecop.travel(Date.today.beginning_of_month - 1.months) do
+        kind.last_month.count.should eq(0)
+        kind.this_month.count.should eq(0)
+        kind.next_month.count.should eq(@count)
+      end
+    end
+
+    it 'should work currently' do
+      Timecop.travel(Date.today.beginning_of_month) do
+        kind.last_month.count.should eq(0)
+        kind.this_month.count.should eq(@count)
+        kind.next_month.count.should eq(0)
+      end
+    end
+
+    it 'should work in the future' do
+      Timecop.travel(Date.today.beginning_of_month + 1.months) do
+        kind.last_month.count.should eq(@count)
+        kind.this_month.count.should eq(0)
+        kind.next_month.count.should eq(0)
+      end
+    end
+
+  end
+
+  describe 'handling years' do
+
+    it 'should work in the past' do
+      Timecop.travel(Date.today.beginning_of_year - 1.years) do
+        kind.last_year.count.should eq(0)
+        kind.this_year.count.should eq(0)
+        kind.next_year.count.should eq(@count)
+      end
+    end
+
+    it 'should work currently' do
+      Timecop.travel(Date.today.beginning_of_year) do
+        kind.last_year.count.should eq(0)
+        kind.this_year.count.should eq(@count)
+        kind.next_year.count.should eq(0)
+      end
+    end
+
+    it 'should work in the future' do
+      Timecop.travel(Date.today.beginning_of_year + 1.years) do
+        kind.last_year.count.should eq(@count)
+        kind.this_year.count.should eq(0)
+        kind.next_year.count.should eq(0)
+      end
+    end
+
+  end
+end

data/lib/simple_date_scopes/version.rb

@@ -0,0 +1,3 @@
+module SimpleDateScopes
+  VERSION = '0.1.0'
+end

data/simple_date_scopes.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_date_scopes/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "simple_date_scopes"
+  gem.version       = SimpleDateScopes::VERSION
+  gem.authors       = ["Peter Hoeg"]
+  gem.email         = ["peter@speartail.com"]
+  gem.description   = %q{A set of standard date scopes to handle years, months and weeks based on created_at or another field}
+  gem.summary       = %q{A set of standard date scopes to handle years, months and weeks based on created_at or another field}
+  gem.homepage      = "http://speartail.com"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activerecord', '~> 3.0'
+
+  gem.add_development_dependency 'factory_girl'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'timecop', '>= 0.5.1'
+end

data/spec/lib/shared_date_scopes_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'factory_girl'
+require 'timecop'
+
+require 'simplecov'
+SimpleCov.start
+
+require 'simple_date_scopes'
+Dir[File.join(%w[ . spec support ** *.rb])].each {|f| require f}
+require 'simple_date_scopes/spec_support'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.mock_with :rspec
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.include FactoryGirl::Syntax::Methods
+
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+
+end

data/spec/support/database.rb

@@ -0,0 +1,18 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+# migrations
+#ActiveRecord::Migrator.up "db/migrate"
+ActiveRecord::Migration.create_table :widgets do |t|
+  t.timestamps
+end
+
+# add missing helpers
+module ActiveModel::Validations
+  def errors_on(attribute)
+    self.valid?
+    [self.errors[attribute]].flatten.compact
+  end
+  alias :error_on :errors_on
+end

data/spec/support/factories.rb

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

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: simple_date_scopes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Peter Hoeg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+description: A set of standard date scopes to handle years, months and weeks based
+  on created_at or another field
+email:
+- peter@speartail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_date_scopes.rb
+- lib/simple_date_scopes/simple_date_scopes.rb
+- lib/simple_date_scopes/spec_support.rb
+- lib/simple_date_scopes/version.rb
+- simple_date_scopes.gemspec
+- spec/lib/shared_date_scopes_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.rb
+- spec/support/factories.rb
+homepage: http://speartail.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2259891919373961889
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2259891919373961889
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A set of standard date scopes to handle years, months and weeks based on
+  created_at or another field
+test_files:
+- spec/lib/shared_date_scopes_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.rb
+- spec/support/factories.rb