dynamic_default_scoping 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+*.swp
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format documentation
+--fail-fast

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,53 @@
+= Dynamic Default Scoping
+
+== What is the library for?
+
+Well, at the moment ActiveRecord (3.0.3) does not allow to pass
+procs and lambdas to +default_scope+. That's strange, isn't it?
+Because +scope+ successfully handles arguments of those types,
+so why +default_scope+ does not?
+
+== How to use?
+
+Here is an example:
+
+  class Post < ActiveRecord::Base
+    include DynamicDefaultScoping
+
+    default_scope :language, lambda { |*args|
+      case locale = (args[0].presence || I18n.locale).to_s
+      when 'any', 'all'
+        where :locale => I18n.available_locales.map(&:to_s)
+      else
+        where :locale => locale
+      end
+    }
+  end
+
+You can overwrite the default value for the locale attribute
+calling the scope by name and passing another value.
+
+== What are the constrains?
+
+Because of the internal implementation of ActiveRecord and friends,
+the library *should be included only after* all calls to
+the regular +default_scope+ and +scope+, especially when they use
+new aRel syntax like +where+, +order+, +limit+, etc.
+
+Here is how it should be:
+
+  class Article < ActiveRecord::Base
+    default_scope order(:created_at).reverse_order
+
+    scope :published, where(:published => true)
+
+    include DynamicDefaultScoping
+
+    default_scope :recent, lambda {
+      where [ 'created_at > ?', Time.now - 5.days ]
+    }
+  end
+
+== When there will be a normal implementation of this feature?
+
+http://rails.lighthouseapp.com/projects/8994/tickets/1812-default_scope-cant-take-procs

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+Bundler.setup
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+Rspec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/dynamic_default_scoping.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dynamic_default_scoping/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dynamic_default_scoping"
+  s.version     = DynamicDefaultScoping::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ivan Ukhov"]
+  s.email       = ["uvsoft@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Make ActiveRecord::Base.default_scope take a proc and have a name.}
+  s.description = %q{Being included in a model, the library patches ActiveRecord::Base.default_scope to take a proc and have an optional name.}
+
+  s.rubyforge_project = "dynamic_default_scoping"
+
+  s.add_development_dependency 'mysql2', '~> 0.2.6'
+  s.add_development_dependency 'rspec', '~> 2.4.0'
+
+  s.add_dependency 'rails', '3.0.3'
+
+  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"]
+end

data/lib/dynamic_default_scoping.rb

@@ -0,0 +1,69 @@
+module DynamicDefaultScoping
+  extend ActiveSupport::Concern
+
+  included do
+    @relation = nil
+  end
+
+  module ClassMethods
+    def default_scope name, options = nil
+      if options.present?
+        scope name, options
+      else
+        name, options = nil, name
+      end
+
+      reset_scoped_methods
+
+      scoping = self.default_scoping.dup
+      last = scoping.pop
+
+      scope = if last.respond_to?(:call) || options.respond_to?(:call)
+        lambda do
+          construct_finder_arel \
+            options.respond_to?(:call) ? options.call : options,
+            last.respond_to?(:call)    ? last.call    : last
+        end
+      else
+        construct_finder_arel options, last
+      end
+
+      self.default_scoping = scoping << scope
+    end
+
+    def scoped options = nil
+      if options
+        scoped.apply_finder_options options
+      else
+        last = current_scoped_methods
+        last ? relation.merge(last) : relation.clone
+      end
+    end
+
+    protected
+
+    def current_scoped_methods
+      method = scoped_methods.last
+      method.kind_of?(Proc) ? unscoped(&method) : method
+    end
+
+    private
+
+    def relation
+      @relation ||= DynamicDefaultScoping::Relation.new self, arel_table
+      finder_needs_type_condition? ? @relation.where(type_condition) : @relation
+    end
+  end
+
+  class Relation < ::ActiveRecord::Relation
+    protected
+
+    def method_missing method, *args, &block
+      if @klass.scopes[method].present?
+        merge @klass.unscoped { @klass.send method, *args, &block }
+      else
+        super
+      end
+    end
+  end
+end

data/lib/dynamic_default_scoping/version.rb

@@ -0,0 +1,3 @@
+module DynamicDefaultScoping
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'active_support/all'
+require 'active_record'
+require 'dynamic_default_scoping'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Post.unscoped.delete_all
+  end
+end
+
+ActiveRecord::Base.establish_connection \
+  :adapter => 'mysql2',
+  :hostname => 'localhost',
+  :database => 'dynamic_default_scoping',
+  :username => 'root',
+  :password => ''
+
+connection = ActiveRecord::Base.connection
+connection.drop_table 'posts' if connection.table_exists? 'posts'
+connection.create_table 'posts' do |table|
+  table.string :locale
+  table.timestamps
+end
+
+LOCALES = [ :en, :ru ]
+
+class Post < ActiveRecord::Base
+  scope :recent, limit(5)
+
+  include DynamicDefaultScoping
+
+  default_scope :language, lambda { |*args|
+    case locale = (args[0].presence || I18n.locale).to_s
+    when 'any', 'all'
+      where :locale => LOCALES.map(&:to_s)
+    else
+      where :locale => locale
+    end
+  }
+end

data/spec/unit/dynamic_default_scoping_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+describe DynamicDefaultScoping do
+  def should_have_valid_locale *args
+    options = args.extract_options!
+    locale = (options[:locale].presence || I18n.locale).to_s
+    args.flatten.all?{ |post| post.locale == locale }.should be_true
+  end
+
+  let(:locales) { LOCALES }
+  let(:per_locale) do
+    hash = {}
+    locales.each_with_index { |locale, i| hash[locale] = 3 + i }
+    hash
+  end
+
+  describe 'when switching between locales' do
+    before do
+      locales.each do |locale|
+        per_locale[locale].times do
+          Post.create! :locale => locale.to_s
+        end
+      end
+    end
+
+    around do |block|
+      locales.each do |locale|
+        I18n.locale = locale
+        block.call
+      end
+    end
+
+    context 'when the locale is not specified' do
+      it 'finds records only in the current locale' do
+        should_have_valid_locale Post.first, Post.all
+      end
+
+      it 'counts records only in the current locale' do
+        Post.count.should == per_locale[I18n.locale]
+      end
+    end
+
+    context 'when the locale is specified' do
+      shared_examples_for 'well localized class' do
+        it 'generates correct query' do
+          sql = @scoped.to_sql
+          sql.should include %[`locale` = '#{ @locale }']
+        end
+
+        it 'finds records in the specified locale' do
+          all = @scoped.all
+          all.length.should == per_locale[@locale]
+          should_have_valid_locale all, :locale => @locale
+        end
+
+        it 'counts records in the specified locale' do
+          @scoped.count.should == per_locale[@locale]
+        end
+      end
+
+      context 'when there is another scope before' do
+        around do |block|
+          locales.each do |locale|
+            @locale = locale
+            @scoped = Post.recent.language(locale)
+            block.call
+          end
+        end
+
+        it_behaves_like 'well localized class'
+      end
+
+      context 'when there is another scope after' do
+        around do |block|
+          locales.each do |locale|
+            @locale = locale
+            @scoped = Post.language(locale).recent
+            block.call
+          end
+        end
+
+        it_behaves_like 'well localized class'
+      end
+
+      context 'when there is no another scope' do
+        around do |block|
+          locales.each do |locale|
+            @locale = locale
+            @scoped = Post.language(locale)
+            block.call
+          end
+        end
+
+        it_behaves_like 'well localized class'
+      end
+    end
+
+    context 'when we are interested in all locales' do
+      let(:scoped) { Post.language :any }
+
+      it 'finds all records' do
+        sql = scoped.to_sql
+        locales.each do |locale|
+          sql.should =~ %r[`locale` IN \(.*'#{ locale }'.*\)]
+        end
+        scoped.length.should == per_locale.values.sum
+      end
+
+      it 'counts all records' do
+        scoped.count.should == per_locale.values.sum
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: dynamic_default_scoping
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ivan Ukhov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-30 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 2
+        - 6
+        version: 0.2.6
+  type: :development
+  requirement: *id001
+  name: mysql2
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  requirement: *id002
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  requirement: *id003
+  name: rails
+description: Being included in a model, the library patches ActiveRecord::Base.default_scope to take a proc and have an optional name.
+email: 
+- uvsoft@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.rdoc
+- Rakefile
+- dynamic_default_scoping.gemspec
+- lib/dynamic_default_scoping.rb
+- lib/dynamic_default_scoping/version.rb
+- spec/spec_helper.rb
+- spec/unit/dynamic_default_scoping_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: dynamic_default_scoping
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Make ActiveRecord::Base.default_scope take a proc and have a name.
+test_files: 
+- spec/spec_helper.rb
+- spec/unit/dynamic_default_scoping_spec.rb