arel_date_scopes 0.0.2

data/.gitignore

@@ -0,0 +1,2 @@
+spec/tmp/*/**
+pkg

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    arel_date_scopes (0.0.2)
+      activerecord (~> 3.0.0)
+      activesupport (~> 3.0.0)
+      arel (>= 2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    tzinfo (0.3.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  arel_date_scopes!
+  rspec
+  sqlite3-ruby

data/README.rdoc

@@ -0,0 +1,51 @@
+= Arel Date Scopes
+
+This gem is useful when you want to navigate through your records by years, months or days - for example, at news archive page.
+
+* AREL 2 date functions (DATE(), YEAR(), DAYOFMONTH() for MySQL, CAST(STRFTIME(...)) for SQLite)
+* AR 3 scopes.
+
+= Installation
+
+Put following line in your Gemfile:
+
+  gem 'arel_date_scopes'
+  
+= Pure AREL example:
+
+Let the users table have created_at field.
+
+  users = Table[:users]
+  users.where(users[:created_at].year.eq(2009))
+  users.where(users[:created_at].month.gt(2))
+  users.where(users[:created_at].dayofmonth.in(1..20))
+  
+= AR example:
+
+Let the news table have created_at field and contain news for two years: 2008 and 2009.
+
+  class News < ActiveRecord::Base
+    date_scopes_for :created_at # Creates scopes for created_at field.
+  end
+
+The News model gets the following scopes:
+
+* created_at_year_eq
+* created_at_month_eq  
+* created_at_day_eq
+* created_at_years
+* created_at_months
+* created_at_days
+* ascend_by_created_at
+* descend_by_created_at
+
+Usage example:
+
+  News.created_at_year_eq(2009).all
+  News.created_at_year_eq(2009).created_at_month_eq(5).all
+  News.descend_by_created_at.created_at_years.all.first['created_at_year']     # 2009
+  News.ascend_by_created_at.created_at_years.all_column                        # [2008, 2009]
+  
+= TODO:
+
+* Create scopes through method_missing like searchlogic.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'arel_date_scopes'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/arel_date_scopes.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+$:.push File.expand_path("../lib", __FILE__)
+require "arel_date_scopes/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{arel_date_scopes}
+  s.version = ArelDateScopes::VERSION
+
+  s.authors = ["Victor Sokolov"]
+  s.description = %q{SQL date functions for AREL 2 + AR 3 scopes (such as created_at_year_eq)}
+  s.email = %q{gzigzigzeo@gmail.com}
+  s.homepage = %q{http://github.com/gzigzigzeo/arel_date_scopes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.summary = %q{SQL date functions for AREL 2 + AR 3 date scopes (such as created_at_year_eq)}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency 'arel', '>= 2'  
+  s.add_dependency 'activerecord', '~> 3.0.0'
+  s.add_dependency 'activesupport', '~> 3.0.0'  
+
+  s.add_development_dependency('sqlite3-ruby')
+  s.add_development_dependency('rspec')  
+end

data/lib/arel_date_scopes.rb

@@ -0,0 +1,6 @@
+module ArelDateScopes
+  require 'arel_date_scopes/version'    
+  require 'arel_date_scopes/arel'
+  require 'arel_date_scopes/active_record'
+  require 'arel_date_scopes/railtie' if defined?(Rails)
+end

data/lib/arel_date_scopes/active_record.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'active_support/concern'
+
+module ArelDateScopes
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def date_scopes_for(field)
+        scope :"#{field}_year_eq", lambda { |year|
+          t = arel_table
+          where(t[field].year.eq(year))
+        }
+        
+        scope :"#{field}_month_eq", lambda { |month|
+          t = arel_table
+          where(t[field].month.eq(month))
+        }
+
+        scope :"#{field}_day_eq", lambda { |day|
+          t = arel_table
+          where(t[field].dayofmonth.eq(day))
+        }
+        
+        scope :"#{field}_years", lambda {
+          t = arel_table
+          select(t[field].year.as("#{field}_year")).group(t[field].year)
+        }
+
+        scope :"#{field}_months", lambda {
+          t = arel_table
+          select(t[field].month.as("#{field}_month")).group(t[field].month)
+        }
+
+        scope :"#{field}_days", lambda {
+          t = arel_table
+          select(t[field].dayofmonth.as("#{field}_day")).group(t[field].dayofmonth)
+        }
+        
+        scope :"descend_by_#{field}", order("#{field} DESC")
+        scope :"ascend_by_#{field}", order("#{field} ASC")        
+      end
+      
+      def all_column(field = nil)
+        rows = scoped.all
+        return [] if rows.empty?
+        field ||= rows.first.attributes.keys.first
+        rows.map { |row| row[field] }
+      end
+    end
+  end
+end

data/lib/arel_date_scopes/arel.rb

@@ -0,0 +1,83 @@
+require 'arel'
+
+module ArelDateScopes
+  # Workaround for Rails. Rails tries to threat left operands of == as Attribute object, but it can be
+  # a function like YEAR(). Fake #name should return "#{field}_#{function}" to resolve field conflicts.
+  module ArelAttributeEmulation
+    def name; self.expressions.first.name.to_s + '_' + self.class.name.underscore; end      
+    def relation; self.expressions.first; end          
+  end
+end
+
+module Arel
+  module Nodes
+    class Year < Arel::Nodes::Function
+      include Arel::Predications
+      include ArelDateScopes::ArelAttributeEmulation
+    end
+
+    class Month < Arel::Nodes::Function
+      include Arel::Predications
+      include ArelDateScopes::ArelAttributeEmulation      
+    end
+
+    class DayOfMonth < Arel::Nodes::Function
+      include Arel::Predications
+      include ArelDateScopes::ArelAttributeEmulation      
+    end
+  end
+
+  module Attributes
+    class Time
+      def year
+        Nodes::Year.new [self]
+      end
+
+      def month
+        Nodes::Month.new [self]
+      end
+
+      def dayofmonth
+        Nodes::DayOfMonth.new [self]
+      end
+    end    
+  end
+
+  module Visitors
+    class SQLite
+      private
+      def visit_Arel_Nodes_Year o
+        "CAST(STRFTIME('%Y', #{o.expressions.map { |x|
+          visit x }.join(', ')}) AS INTEGER)#{o.alias ? " AS #{visit o.alias}" : ''}"
+      end      
+
+      def visit_Arel_Nodes_Month o
+        "CAST(STRFTIME('%m', #{o.expressions.map { |x|
+          visit x }.join(', ')}) AS INTEGER)#{o.alias ? " AS #{visit o.alias}" : ''}"
+      end
+
+      def visit_Arel_Nodes_DayOfMonth o
+        "CAST(STRFTIME('%d', #{o.expressions.map { |x|
+          visit x }.join(', ')}) AS INTEGER)#{o.alias ? " AS #{visit o.alias}" : ''}"
+      end        
+    end
+    
+    class MySQL
+      private
+      def visit_Arel_Nodes_Year o
+        "YEAR(#{o.expressions.map { |x|
+          visit x }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
+      end      
+
+      def visit_Arel_Nodes_Month o
+        "MONTH(#{o.expressions.map { |x|
+          visit x }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
+      end
+  
+      def visit_Arel_Nodes_DayOfMonth o
+        "DAYOFMONTH(#{o.expressions.map { |x|
+          visit x }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
+      end        
+    end
+  end
+end

data/lib/arel_date_scopes/railtie.rb

@@ -0,0 +1,9 @@
+module ArelDateScopes
+  class Railtie < Rails::Railtie
+    initializer 'arel_date_scopes.insert_into_active_record' do
+      ActiveSupport.on_load :active_record do
+        ::ActiveRecord::Base.send(:include, ArelDateScopes::ActiveRecord)
+      end
+    end
+  end
+end

data/lib/arel_date_scopes/version.rb

@@ -0,0 +1,3 @@
+module ArelDateScopes
+  VERSION = '0.0.2'
+end

data/spec/arel_date_scopes/date_scopes_arel_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe "date_scopes AREL extensions" do
+  before(:each) { @table = Arel::Table.new(:users) }
+  
+  context("for MySQL") do
+    before(:each) do
+      @visitor = Arel::Visitors::MySQL.new(Arel::Sql::Engine.new(FakeRecord::Base.new('mysql')))
+    end
+  
+    it "should correctly transform to_sql DATE, MONTH, DAYOFMONTH" do
+      @visitor.accept(@table[:created_at].year.eq(2009)).should eq('YEAR("users"."created_at") = 2009')
+      @visitor.accept(@table[:created_at].month.in(1..12)).should eq('MONTH("users"."created_at") BETWEEN 1 AND 12')  
+      @visitor.accept(@table[:created_at].dayofmonth.gt(10)).should eq('DAYOFMONTH("users"."created_at") > 10')        
+      @table.project(@table[:created_at].year).group(@table[:created_at].year).to_sql.should 
+        eq('SELECT YEAR("users"."created_at") FROM "users" GROUP BY YEAR("users"."created_at")')
+    end
+  end
+
+  context("for SQLite") do
+    before(:each) do      
+      @visitor = Arel::Visitors::SQLite.new(Arel::Sql::Engine.new(FakeRecord::Base.new('sqlite')))
+    end
+  
+    it "should correctly transform to_sql DATE, MONTH, DAYOFMONTH" do
+      @visitor.accept(@table[:created_at].year.eq(2009)).should eq('CAST(STRFTIME(\'%Y\', "users"."created_at") AS INTEGER) = 2009')
+      @visitor.accept(@table[:created_at].month.in(1..12)).should eq('CAST(STRFTIME(\'%m\', "users"."created_at") AS INTEGER) BETWEEN 1 AND 12')  
+      @visitor.accept(@table[:created_at].dayofmonth.gt(10)).should eq('CAST(STRFTIME(\'%d\', "users"."created_at") AS INTEGER) > 10')        
+      @table.project(@table[:created_at].year).group(@table[:created_at].year).to_sql.should 
+        eq('SELECT CAST(STRFTIME(\'%Y\', "users"."created_at") AS INTEGER) FROM "users" GROUP BY CAST(STRFTIME(\'%Y\', "users"."created_at") AS INTEGER)')
+    end
+  end
+end

data/spec/arel_date_scopes/date_scopes_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe "date_scopes AR specs" do
+  before(:each) do
+    User.destroy_all
+    @users = [
+      User.create(:created_at => Date.new(2009, 1, 29)),
+      User.create(:created_at => Date.new(2008, 1, 1))  
+    ]  
+  end
+  
+  it "have working *_eq" do    
+    @by_year = User.created_at_year_eq(2009)
+    @by_year.count.should == 1
+    @by_year.first.should == @users.first
+    
+    @by_month = User.created_at_month_eq(1)
+    @by_month.count.should == 2
+    @by_month.should include(@users.first)
+    @by_month.should include(@users.second)    
+
+    @by_month = User.created_at_day_eq(29)
+    @by_month.count.should == 1
+    @by_month.first.should == @users.first
+  end
+  
+  it "have working *_years/*_months scopes" do
+    @years = User.order('created_at DESC').created_at_years.all
+    @years.count.should == 2
+    @years.first['created_at_year'].should == 2009
+    @years.last['created_at_year'].should == 2008
+
+    @months = User.order('created_at DESC').created_at_years.created_at_months.all
+    @months.count.should == 2
+    @months.first['created_at_month'].should == 1
+    @months.last['created_at_month'].should == 1
+
+    @days = User.order('created_at DESC').created_at_days.all
+    @days.count.should == 2
+    @days.first['created_at_day'].should == 29
+    @days.last['created_at_day'].should == 1
+  end
+
+  it "have working ascend_*/descend_* scopes" do
+    User.ascend_by_created_at.all.should eq(@users.reverse)
+    User.descend_by_created_at.all.should eq(@users)
+  end
+  
+  it "gets column value with all_column" do
+    User.ascend_by_created_at.created_at_years.all_column.should == [2008, 2009]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+$LOAD_PATH << "." unless $LOAD_PATH.include?(".")
+
+require 'logger'
+require "bundler"
+
+begin
+  Bundler.setup
+  Bundler.require
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run `bundle install`?"
+end
+
+require 'active_record'
+require 'support/fake_record'
+
+# Fake connection to supress ConnectionNotEstablished on AR tests
+ActiveRecord::Base.establish_connection(
+  "adapter" => "sqlite3", 
+  "database" => ":memory:"
+)
+
+ActiveRecord::Base.logger = Logger.new(nil)
+ActiveRecord::Base.send(:include, ArelDateScopes::ActiveRecord)
+
+ActiveRecord::Schema.define :version => 0 do
+  create_table "users", :force => true do |t|
+    t.datetime :created_at
+  end
+end
+
+class User < ActiveRecord::Base
+  set_table_name 'users'
+  date_scopes_for :created_at
+end
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')

data/spec/support/fake_record.rb

@@ -0,0 +1,90 @@
+# Mock to make AREL work without regular database.
+module FakeRecord
+  class Column < Struct.new(:name, :type)
+  end
+
+  class Connection
+    attr_reader :tables
+
+    def initialize
+      @tables = %w{ users }
+      @columns = {
+        'users' => [
+          Column.new('id', :integer),
+          Column.new('created_at', :date)
+        ]
+      }
+      @primary_keys = {
+        'users' => 'id'
+      }
+    end
+
+    def primary_key name
+      @primary_keys[name.to_s]
+    end
+
+    def table_exists? name
+      @tables.include? name.to_s
+    end
+
+    def columns name, message = nil
+      @columns[name.to_s]
+    end
+
+    def quote_table_name name
+      "\"#{name.to_s}\""
+    end
+
+    def quote_column_name name
+      "\"#{name.to_s}\""
+    end
+
+    def quote thing, column = nil
+      if column && column.type == :integer
+        return 'NULL' if thing.nil?
+        return thing.to_i
+      end
+
+      case thing
+      when true
+        "'t'"
+      when false
+        "'f'"
+      when nil
+        'NULL'
+      when Numeric
+        thing
+      else
+        "'#{thing}'"
+      end
+    end
+  end
+
+  class ConnectionPool
+    class Spec < Struct.new(:config)
+    end
+
+    attr_reader :spec, :connection
+
+    def initialize(adapter)
+      @spec = Spec.new(adapter)
+      @connection = Connection.new
+    end
+
+    def with_connection
+      yield connection
+    end
+  end
+
+  class Base
+    attr_accessor :connection_pool
+
+    def initialize(adapter)
+      @connection_pool = ConnectionPool.new(adapter)
+    end
+
+    def connection
+      connection_pool.connection
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification 
+name: arel_date_scopes
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Victor Sokolov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-30 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: arel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: SQL date functions for AREL 2 + AR 3 scopes (such as created_at_year_eq)
+email: gzigzigzeo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- arel_date_scopes.gemspec
+- lib/arel_date_scopes.rb
+- lib/arel_date_scopes/active_record.rb
+- lib/arel_date_scopes/arel.rb
+- lib/arel_date_scopes/railtie.rb
+- lib/arel_date_scopes/version.rb
+- spec/arel_date_scopes/date_scopes_arel_spec.rb
+- spec/arel_date_scopes/date_scopes_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_record.rb
+has_rdoc: true
+homepage: http://github.com/gzigzigzeo/arel_date_scopes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.0
+signing_key: 
+specification_version: 3
+summary: SQL date functions for AREL 2 + AR 3 date scopes (such as created_at_year_eq)
+test_files: 
+- spec/arel_date_scopes/date_scopes_arel_spec.rb
+- spec/arel_date_scopes/date_scopes_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_record.rb