filter_fu 0.5.0 → 0.6.0

data/spec/active_record_spec.rb

@@ -1,159 +1,158 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require File.expand_path(File.dirname(__FILE__) + '/fixtures/employee')
+require 'spec_helper'
 
 describe FilterFu::ActiveRecord do
-  
+
   it "should add a filter_fu class method to ActiveRecord::Base" do
     ActiveRecord::Base.should respond_to(:filter_fu)
   end
 
-  describe "filter_fu" do
-    
+  describe ".filter_fu" do
+
     it "should accept an options hash" do
       lambda { ActiveRecord::Base.filter_fu({}) }.should_not raise_error(ArgumentError)
     end
-    
+
     it "should not require an options hash" do
       lambda { ActiveRecord::Base.filter_fu }.should_not raise_error(ArgumentError)
     end
-    
+
     it "should add a new singleton method called filtered_by" do
       Employee.should respond_to(:filtered_by)
     end
-    
+
     it "should not accept invalid options" do
       lambda { ActiveRecord::Base.filter_fu(:invalid_option => 'some value') }.should raise_error
     end
-    
+
     %w(only except).each do |option|
       it "should accept :#{option} as an option" do
         lambda { ActiveRecord::Base.filter_fu(option => 'some value') }.should_not raise_error
       end
     end
-    
+
     it "should not accept :except and :only option at the same time" do
       lambda { ActiveRecord::Base.filter_fu(:only => 'some value', :except => 'some other value') }.should raise_error(/Use either :only or :except/)
     end
-    
+
   end
-  
-  describe "filtered_by" do
-    
+
+  describe ".filtered_by" do
+
     before(:each) do
       @plain_class = Class.new(Employee)
       @class = @plain_class.clone
       @class.filter_fu if @class.respond_to?(:filter_fu)
     end
-    
+
     it "should require a hash with filter params" do
       lambda { @class.filtered_by }.should raise_error(ArgumentError)
     end
-    
+
     it "should not fail if the hash with filter params is nil" do
       lambda { @class.filtered_by(nil) }.should_not raise_error(NoMethodError)
     end
-    
+
     it "should not filter anything if the hash is nil" do
       @class.filtered_by(nil).should == @class.all
     end
-    
+
     it "should not filter anything if the hash is empty" do
       @class.filtered_by({}).should == @class.all
     end
-    
+
     it "should not return nil if all scopes were skipped" do
       # This is ugly. Is there a better solution to this?
       klass = @plain_class.filter_fu :only => :salary
       klass.filtered_by({ :country => 'Whatever' }).should_not be_nil
     end
-    
+
     it "should handle HashWithIndifferentAccess correctly" do
       @class.filtered_by(HashWithIndifferentAccess.new('salary' => 100000)).should == @class.all(:conditions => 'salary = 100000')
       @class.filtered_by(HashWithIndifferentAccess.new('boss' => true)).should == @class.all(:conditions => "position = 'Boss'")
     end
-    
-    it "should return an instace of ActiveRecord::NamedScope::Scope" do      
-      @class.filtered_by({ :boss => nil }).class.should == ActiveRecord::NamedScope::Scope
+
+    it "should return an instace of ActiveRecord::NamedScope::Scope" do
+      @class.filtered_by({ :boss => nil }).class.should == ActiveRecord::Relation
     end
-        
+
     it "should call named scopes if specified in the filter params" do
       @class.should_receive(:boss)
       @class.filtered_by({ :boss => '' })
     end
-    
+
     it "should pass the value to the named scope" do
       @class.should_receive(:country).with('some value')
       @class.filtered_by({ :country => 'some value'})
     end
-    
+
     it "should only call the specified named scope if it is available" do
       @class.should_not_receive(:unavailable)
       @class.filtered_by({ :unavailable => '' })
     end
-    
+
     it "should allow multiple scopes at once and combine them" do
       @class.filtered_by({ :position => 'Worker', :country => 'Country 1'}).should == @class.all(:conditions => { :position => 'Worker', :country => 'Country 1'})
     end
-    
+
     describe "when the given named scope is not available" do
-      
+
       it "should create an anonymous scope using the filter options as conditions" do
         @class.filtered_by(:salary => 100000).should == @class.all(:conditions => 'salary = 100000')
       end
-    
+
       it "should not create an anonymous scope if there is no column for it" do
         lambda { @class.filtered_by(:non_existing_column => 'some value').all }.should_not raise_error(/no such column/)
       end
-      
+
       it "should not create an anonymous scope if the value is blank" do
         @class.filtered_by(:salary => '').should == @class.all()
       end
-      
+
       it "should create an anonymous scope that is able to handle an array of possible values for the filter" do
         @class.filtered_by(:salary => [80000, 90000]).should == @class.all(:conditions => 'salary IN (80000, 90000)')
       end
-      
+
     end
 
     it "should not filter by scopes defined in :except option" do
       klass = @plain_class.clone
       klass.filter_fu :except => :dont_access_me
-      klass.named_scope :dont_access_me, {}
-      klass.named_scope :access_me, {}
-      
+      klass.scope :dont_access_me, {}
+      klass.scope :access_me, {}
+
       klass.should_not_receive(:dont_access_me)
       klass.filtered_by(:dont_access_me => '')
     end
-    
+
     it "should filter by scopes not defined in :except option" do
       klass = @plain_class.clone
       klass.filter_fu :except => :dont_access_me
-      klass.named_scope :dont_access_me, {}
-      klass.named_scope :access_me, {}
-      
+      klass.scope :dont_access_me, {}
+      klass.scope :access_me, {}
+
       klass.should_receive(:access_me)
       klass.filtered_by(:access_me => '')
     end
-    
+
     it "should only filter by scopes define in :only option" do
       klass = @plain_class.clone
       klass.filter_fu :only => :only_access_me
-      klass.named_scope :only_access_me, {}
-      klass.named_scope :dont_access_me, {}
-      
+      klass.scope :only_access_me, {}
+      klass.scope :dont_access_me, {}
+
       klass.should_receive(:only_access_me)
       klass.filtered_by(:only_access_me => '')
     end
-    
+
     it "should not filter by scopes not defined in :only option" do
       klass = @plain_class.clone
       klass.filter_fu :only => :only_access_me
-      klass.named_scope :only_access_me, {}
-      klass.named_scope :dont_access_me, {}
-      
+      klass.scope :only_access_me, {}
+      klass.scope :dont_access_me, {}
+
       klass.should_not_receive(:dont_access_me)
       klass.filtered_by(:dont_access_me => '')
     end
   end
-  
+
 end

data/spec/db/database.yml

@@ -1,3 +1,3 @@
 sqlite3:
   database: ":memory:"
-  adapter: sqlite3
+  adapter: sqlite3

data/spec/db/debug.log

@@ -0,0 +1,42 @@
+# Logfile created on Thu Dec 09 17:00:27 +0100 2010 by logger.rb/22285
+  SQL (0.1ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 1', 'Employee 0', 100000, 'Boss')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 2', 'Employee 1', 20000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 3', 'Employee 2', 30000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 4', 'Employee 3', 40000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 5', 'Employee 4', 0, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 6', 'Employee 5', 10000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 7', 'Employee 6', 20000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 8', 'Employee 7', 30000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 9', 'Employee 8', 40000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 10', 'Employee 9', 0, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 1', 'Employee 10', 10000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 2', 'Employee 11', 20000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 3', 'Employee 12', 30000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 4', 'Employee 13', 40000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 5', 'Employee 14', 0, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 6', 'Employee 15', 10000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 7', 'Employee 16', 20000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 8', 'Employee 17', 30000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 9', 'Employee 18', 40000, 'Worker')
+  AREL (0.1ms)  INSERT INTO "employees" ("country", "name", "salary", "position") VALUES ('Country 10', 'Employee 19', 0, 'Worker')
+   Load (0.6ms)  SELECT "employees".* FROM "employees"
+   Load (0.6ms)  SELECT "employees".* FROM "employees"
+   Load (0.6ms)  SELECT "employees".* FROM "employees"
+   Load (0.6ms)  SELECT "employees".* FROM "employees"
+   Load (0.2ms)  SELECT "employees".* FROM "employees" WHERE (salary = 100000)
+   Load (0.2ms)  SELECT "employees".* FROM "employees" WHERE ("employees"."salary" = 100000)
+   Load (0.2ms)  SELECT "employees".* FROM "employees" WHERE (position = 'Boss')
+   Load (0.2ms)  SELECT "employees".* FROM "employees" WHERE (position = 'Boss')
+   Load (0.2ms)  SELECT "employees".* FROM "employees" WHERE ("employees"."country" = 'Country 1') AND ("employees"."position" = 'Worker')
+   Load (0.3ms)  SELECT "employees".* FROM "employees" WHERE (country = 'Country 1') AND ("employees"."position" = 'Worker')
+   Load (0.2ms)  SELECT "employees".* FROM "employees" WHERE (salary = 100000)
+   Load (0.2ms)  SELECT "employees".* FROM "employees" WHERE ("employees"."salary" = 100000)
+   Load (0.5ms)  SELECT "employees".* FROM "employees"
+   Load (0.6ms)  SELECT "employees".* FROM "employees"
+   Load (0.6ms)  SELECT "employees".* FROM "employees"
+   Load (0.2ms)  SELECT "employees".* FROM "employees" WHERE (salary IN (80000, 90000))
+   Load (0.2ms)  SELECT "employees".* FROM "employees" WHERE ("employees"."salary" IN (80000, 90000))

data/spec/db/schema.rb

@@ -6,5 +6,5 @@ ActiveRecord::Schema.define(:version => 0) do
     t.string  :position
     t.integer :salary
   end
-  
-end
+
+end

data/spec/filter_fu_spec.rb

@@ -1,13 +1,13 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe FilterFu do
-  
+
   it "should include FilterFu::ViewHelper into ActionView::Base" do
     ActionView::Base.ancestors.should include(FilterFu::ViewHelper)
   end
-  
+
   it "should include FilterFu::ActiveRecord into ActiveRecord::Base" do
     ActiveRecord::Base.ancestors.should include(FilterFu::ActiveRecord)
   end
-  
+
 end

data/spec/helpers/view_helper_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe FilterFu::ViewHelper do
+
+  before(:each) do
+    helper.controller = DummyController.new
+  end
+
+  it "should provide a filter_form_for method" do
+    helper.should respond_to(:filter_form_for)
+  end
+
+  it "should prodive a filter_form method as an alias for filter_form" do
+    helper.should respond_to(:filter_form)
+  end
+
+  it "should require a block" do
+    expect { helper.filter_form_for }.to raise_error(ArgumentError, /Missing block/)
+  end
+
+  it "should accept options" do
+    expect { helper.filter_form_for({}) {} }.to_not raise_error(ArgumentError)
+  end
+
+  it "should not require options" do
+    expect { helper.filter_form_for() {} }.to_not raise_error(ArgumentError)
+  end
+
+  it "should accept a name together with options" do
+    expect { helper.filter_form_for(:other, {}) {} }.to_not raise_error(ArgumentError)
+  end
+
+  it "should call the associated block" do
+    expect {
+      helper.filter_form_for() { throw :done }
+    }.to throw_symbol(:done)
+  end
+
+  it "should pass a ActionView::Helpers::FormBuilder to the block" do
+    helper.filter_form_for { |f| f.should be_kind_of(ActionView::Helpers::FormBuilder) }
+  end
+
+  it "should include the erb of the block" do
+    html = helper.filter_form_for { "<div>Some random HTML</div>" }
+    html.should contain('Some random HTML')
+  end
+
+  it "should include a form tag" do
+    html = helper.filter_form_for { }
+    html.should have_selector('form')
+  end
+
+  it "should set the form method attribute to GET" do
+    html = helper.filter_form_for { }
+    html.should have_selector('form', :method => 'get')
+  end
+
+  it "should set the form action attribute to the current url" do
+    html = helper.filter_form_for { }
+    html.should have_selector('form', :action => '/foo/bar')
+  end
+
+  it "should use :filter as the default namespace in form fields" do
+    html = helper.filter_form_for { |f| f.text_field :name }
+    html.should have_selector('input', :name => 'filter[name]')
+  end
+
+  it "should use another name as namespace if it's provided as the first argument" do
+    html = helper.filter_form_for(:other) { |f| f.text_field :name }
+    html.should have_selector('input', :name => 'other[name]')
+  end
+
+  it "should pass options to the form_for helper" do
+    html = helper.filter_form_for(:html => { :class => 'filter' }) { }
+    html.should have_selector('form', :class => 'filter')
+  end
+
+  it "should preserve the page's parameters with hidden fields" do
+    helper.params.merge!({ :some_param => 'some value', :some_other_param => 'some other value' })
+    html = helper.filter_form_for() { }
+    html.should have_selector('input', :type => 'hidden', :name => 'some_param', :value => 'some value')
+    html.should have_selector('input', :type => 'hidden', :name => 'some_other_param', :value => 'some other value')
+  end
+
+  it "should preserve the page's nested parameters with hidden fields" do
+    helper.params.merge!({ :some_param => 'some value', :nested => { :some_other_param => 'some other value', :deeply_nested => { :down_here => 'yet another value' } } })
+    html = helper.filter_form_for() { }
+    html.should have_selector('input', :type => 'hidden', :name => 'some_param', :value => 'some value')
+    html.should have_selector('input', :type => 'hidden', :name => 'nested[some_other_param]', :value => 'some other value')
+    html.should have_selector('input', :type => 'hidden', :name => 'nested[deeply_nested][down_here]', :value => 'yet another value')
+  end
+
+  it "should not preserve the page's parameters for the current filter" do
+    helper.params.merge!({ :other => { :name => 'some value' }})
+    html = helper.filter_form_for(:other) { }
+    html.should_not have_selector('input', :type => 'hidden', :name => 'other')
+    html.should_not have_selector('input', :type => 'hidden', :name => 'other[name]', :value => 'some value')
+  end
+
+  it "should not preserve the controller and action params" do
+    helper.params.merge!({ :controller => 'foo', :action => 'bar' })
+    html = helper.filter_form_for() { }
+    html.should_not have_selector('input', :type => 'hidden', :name => 'controller', :value => 'foo')
+    html.should_not have_selector('input', :type => 'hidden', :name => 'action', :value => 'bar')
+  end
+
+  it "should not preserve params specified in :ignore_parameters" do
+    helper.params.merge!({ :some_param => 'some value', :some_other_param => 'some other value' })
+    html = helper.filter_form_for(:ignore_parameters => [:some_other_param]) { }
+    html.should have_selector('input', :type => 'hidden', :name => 'some_param', :value => 'some value')
+    html.should_not have_selector('input', :type => 'hidden', :name => 'some_other_param', :value => 'some other value')
+  end
+
+  it "should use the current filter params as defaults for the form" do
+    helper.params.merge!({ :filter => { :some_param => 'some value' } })
+    html = helper.filter_form_for() { |f| f.text_field :some_param }
+    html.should have_selector('input', :type => 'text', :name => 'filter[some_param]', :value => 'some value')
+  end
+end

data/spec/spec_helper.rb

@@ -1,20 +1,16 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-
-begin
-  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
-rescue LoadError
-  puts "You need to install rspec in your base app"
-  exit
-end
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+ENV["RAILS_ENV"] ||= 'test'
 
+require 'rubygems'
+require 'rails/all'
 require 'filter_fu'
 
-Spec::Runner.configure do |config|
+require File.dirname(__FILE__) + "/../tmp/sandbox/config/environment"
 
-end
+require 'rspec/rails'
 
-ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), 'debug.log'))
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), 'db', 'debug.log'))
 
 configuration = YAML.load_file(File.join(File.dirname(__FILE__), 'db', 'database.yml'))
 ActiveRecord::Base.establish_connection(configuration[ENV["DB"] || "sqlite3"])
@@ -22,4 +18,23 @@ ActiveRecord::Base.establish_connection(configuration[ENV["DB"] || "sqlite3"])
 ActiveRecord::Base.silence do
   ActiveRecord::Migration.verbose = false
   load(File.join(File.dirname(__FILE__), "db", "schema.rb"))
-end
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # If you'd prefer not to run each of your examples within a transaction,
+  # uncomment the following line.
+  # config.use_transactional_examples false
+end

data/spec/support/dummies.rb

@@ -0,0 +1,13 @@
+# Taken from mislav's will_paginate http://github.com/mislav/will_paginate/tree/master
+
+class DummyController < ActionView::TestCase::TestController
+  def initialize
+    super
+    @params.merge!(:controller => 'foo', :action => 'bar')
+    @request.path_parameters = @params
+  end
+end
+
+Rails.application.routes.draw do
+  match "foo/bar", :controller => 'foo', :action => 'bar'
+end

data/spec/{fixtures → support}/employee.rb

@@ -1,7 +1,7 @@
 class Employee < ActiveRecord::Base
-  
-  named_scope :boss, :conditions => "position = 'Boss'"
-  named_scope :country, lambda { |country| { :conditions => ["country = ?", country] } }
+
+  scope :boss, :conditions => "position = 'Boss'"
+  scope :country, lambda { |country| { :conditions => ["country = ?", country] } }
 
 end
 
@@ -10,5 +10,3 @@ end
   salary    = (n == 0) ? 100000 : (((n+1) % 5) * 10000)
   Employee.create(:name => "Employee #{n}", :country => "Country #{(n % 10) + 1}", :position => position, :salary => salary)
 end
-
-#puts Employee.all.inspect