date_range_scopes 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Nick Ragaz
+
+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,15 @@
+DateRangeScopes
+===============
+
+Automatically add scopes for day, week, month and year ranges to Active Record models. See [date_range_scopes.rb](https://github.com/nragaz/date_range_scopes/blob/master/lib/date_range_scopes.rb) for a full example.
+
+Usage
+-----
+
+    class User < ActiveRecord::Base
+      include DateRangeScopes
+    end
+    
+    # => User.created_on
+    # => User.created_in_week(5.weeks.ago)
+    # => User.created_in_year

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DateRangeScopes'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/date_range_scopes.rb

@@ -0,0 +1,65 @@
+module DateRangeScopes
+  extend ActiveSupport::Concern
+  
+  # Include this module in an Active Record class to add the following scopes
+  # for every column ending in _at or _on (e.g. updated_at):
+  #
+  #   > #{updated}_on
+  #   > #{updated}_in_week
+  #   > #{updated}_in_month
+  #   > #{updated}_in_year
+  #
+  # These scopes accept a date or time to define the period. e.g. if you pass a
+  # date on a Wednesday, `#{updated}_in_week` will return records with dates
+  # between the beginning and end of that week.
+  #
+  # The default is always today / now.
+  #
+  # Convenience aliases:
+  #   > #{updated}_today -> same as #{updated}_on(Date.today)
+  #   > today(date) -> same as created_on(date)
+  included do
+    date_columns = column_names.select { |col| col =~ /((_at)|(_on))\z/ }
+    
+    date_columns.each do |col|
+      key = col.slice(0..-4)
+      full_name = "#{table_name}.#{col}"
+      
+      scope "#{key}_on", lambda { |time=nil|
+        time ||= Time.zone.now
+        time = time.respond_to?(:to_time_in_current_zone) ?
+          time.to_time_in_current_zone : time
+        
+        where(
+          "#{full_name} >= ? AND #{full_name} <= ?",
+          time.beginning_of_day,
+          time.end_of_day
+        )
+      }
+      
+      scope "#{key}_today", send("#{key}_on")
+      
+      %w( week month year ).each do |period|
+        scope "#{key}_in_#{period}", lambda { |time=nil|
+          time ||= Time.zone.now
+          time = time.respond_to?(:to_time_in_current_zone) ?
+            time.to_time_in_current_zone : time
+          
+          where(
+            "#{full_name} >= ? AND #{full_name} <= ?",
+            time.send("beginning_of_#{period}"),
+            time.send("end_of_#{period}")
+          )
+        }
+        
+        scope "#{key}_this_#{period}", send("#{key}_in_#{period}")
+      end
+    end
+  end
+  
+  module ClassMethods
+    def today(date=nil)
+      created_on(date)
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: date_range_scopes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nick Ragaz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-29 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2157626560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157626560
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2157626160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157626160
+description: Automatically add scopes for day, week, month and year ranges to Active
+  Record models.
+email: nick.ragaz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/date_range_scopes.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: http://github.com/nragaz/date_range_scopes
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Automatically add scopes for day, week, month and year ranges to Active Record
+  models.
+test_files: []