searchlogic 1.6.6 → 2.1.0

data/rails/init.rb

@@ -0,0 +1 @@
+require "searchlogic"

data/searchlogic.gemspec

@@ -0,0 +1,69 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{searchlogic}
+  s.version = "2.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Johnson of Binary Logic"]
+  s.date = %q{2009-06-27}
+  s.email = %q{bjohnson@binarylogic.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG.rdoc",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "init.rb",
+     "lib/searchlogic.rb",
+     "lib/searchlogic/core_ext/object.rb",
+     "lib/searchlogic/core_ext/proc.rb",
+     "lib/searchlogic/named_scopes/alias_scope.rb",
+     "lib/searchlogic/named_scopes/associations.rb",
+     "lib/searchlogic/named_scopes/conditions.rb",
+     "lib/searchlogic/named_scopes/ordering.rb",
+     "lib/searchlogic/rails_helpers.rb",
+     "lib/searchlogic/search.rb",
+     "rails/init.rb",
+     "searchlogic.gemspec",
+     "spec/core_ext/object_spec.rb",
+     "spec/core_ext/proc_spec.rb",
+     "spec/named_scopes/alias_scope_spec.rb",
+     "spec/named_scopes/associations_spec.rb",
+     "spec/named_scopes/conditions_spec.rb",
+     "spec/named_scopes/ordering_spec.rb",
+     "spec/search_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/binarylogic/searchlogic}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{searchlogic}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Searchlogic provides common named scopes and object based searching for ActiveRecord.}
+  s.test_files = [
+    "spec/core_ext/object_spec.rb",
+     "spec/core_ext/proc_spec.rb",
+     "spec/named_scopes/alias_scope_spec.rb",
+     "spec/named_scopes/associations_spec.rb",
+     "spec/named_scopes/conditions_spec.rb",
+     "spec/named_scopes/ordering_spec.rb",
+     "spec/search_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/core_ext/object_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe "Object" do
+  it "should accept and pass the argument to the searchlogic_arg_type" do
+    searchlogic_lambda(:integer) {}.searchlogic_arg_type.should == :integer
+  end
+end

data/spec/core_ext/proc_spec.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe "Proc" do
+  it "should have a searchlogic_arg_type accessor" do
+    p = Proc.new {}
+    p.searchlogic_arg_type = :integer
+    p.searchlogic_arg_type.should == :integer
+  end
+end

data/spec/named_scopes/alias_scope_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe "AliasScope" do
+  it "should allow alias scopes" do
+    User.create(:username => "bjohnson")
+    User.create(:username => "thunt")
+    User.username_has("bjohnson").all.should == User.find_all_by_username("bjohnson")
+  end
+  
+  it "should allow alias scopes from the search object" do
+    search = User.search
+    search.username_has = "bjohnson"
+    search.username_has.should == "bjohnson"
+  end
+end

data/spec/named_scopes/associations_spec.rb

@@ -0,0 +1,120 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe "Associations" do
+  it "should create a named scope" do
+    Company.users_username_like("bjohnson").proxy_options.should == User.username_like("bjohnson").proxy_options.merge(:joins => :users)
+  end
+  
+  it "should create a deep named scope" do
+    Company.users_orders_total_greater_than(10).proxy_options.should == Order.total_greater_than(10).proxy_options.merge(:joins => {:users => :orders})
+  end
+  
+  it "should not allowed named scopes on non existent association columns" do
+    lambda { User.users_whatever_like("bjohnson") }.should raise_error(NoMethodError)
+  end
+  
+  it "should not allowed named scopes on non existent deep association columns" do
+    lambda { User.users_orders_whatever_like("bjohnson") }.should raise_error(NoMethodError)
+  end
+  
+  it "should allow named scopes to be called multiple times and reflect the value passed" do
+    Company.users_username_like("bjohnson").proxy_options.should == User.username_like("bjohnson").proxy_options.merge(:joins => :users)
+    Company.users_username_like("thunt").proxy_options.should == User.username_like("thunt").proxy_options.merge(:joins => :users)
+  end
+  
+  it "should allow deep named scopes to be called multiple times and reflect the value passed" do
+    Company.users_orders_total_greater_than(10).proxy_options.should == Order.total_greater_than(10).proxy_options.merge(:joins => {:users => :orders})
+    Company.users_orders_total_greater_than(20).proxy_options.should == Order.total_greater_than(20).proxy_options.merge(:joins => {:users => :orders})
+  end
+  
+  it "should have an arity of 1 if the underlying scope has an arity of 1" do
+    Company.users_orders_total_greater_than(10)
+    Company.named_scope_arity("users_orders_total_greater_than").should == Order.named_scope_arity("total_greater_than")
+  end
+  
+  it "should have an arity of nil if the underlying scope has an arity of nil" do
+    Company.users_orders_total_null
+    Company.named_scope_arity("users_orders_total_null").should == Order.named_scope_arity("total_null")
+  end
+  
+  it "should have an arity of -1 if the underlying scope has an arity of -1" do
+    Company.users_id_equals_any
+    Company.named_scope_arity("users_id_equals_any").should == User.named_scope_arity("id_equals_any")
+  end
+  
+  it "should allow aliases" do
+    Company.users_username_contains("bjohnson").proxy_options.should == User.username_contains("bjohnson").proxy_options.merge(:joins => :users)
+  end
+  
+  it "should allow deep aliases" do
+    Company.users_orders_total_gt(10).proxy_options.should == Order.total_gt(10).proxy_options.merge(:joins => {:users => :orders})
+  end
+  
+  it "should allow ascending" do
+    Company.ascend_by_users_username.proxy_options.should == User.ascend_by_username.proxy_options.merge(:joins => :users)
+  end
+  
+  it "should allow descending" do
+    Company.descend_by_users_username.proxy_options.should == User.descend_by_username.proxy_options.merge(:joins => :users)
+  end
+  
+  it "should allow deep ascending" do
+    Company.ascend_by_users_orders_total.proxy_options.should == Order.ascend_by_total.proxy_options.merge(:joins => {:users => :orders})
+  end
+  
+  it "should allow deep descending" do
+    Company.descend_by_users_orders_total.proxy_options.should == Order.descend_by_total.proxy_options.merge(:joins => {:users => :orders})
+  end
+  
+  it "should include optional associations" do
+    pending # this is a problem with using inner joins and left outer joins
+    Company.create
+    company = Company.create
+    user = company.users.create
+    order = user.orders.create(:total => 20, :taxes => 3)
+    Company.ascend_by_users_orders_total.all.should == Company.all
+  end
+  
+  it "should not create the same join twice" do
+    company = Company.create
+    user = company.users.create
+    order = user.orders.create(:total => 20, :taxes => 3)
+    Company.users_orders_total_gt(10).users_orders_taxes_lt(5).ascend_by_users_orders_total.all.should == Company.all
+  end
+  
+  it "should not create the same join twice when traveling through the duplicate join" do
+    Company.users_username_like("bjohnson").users_orders_total_gt(100).all.should == Company.all
+  end
+  
+  it "should not create the same join twice when traveling through the duplicate join 2" do
+    Company.users_orders_total_gt(100).users_orders_line_items_price_gt(20).all.should == Company.all
+  end
+  
+  it "should allow the use of :include when a join was created" do
+    company = Company.create
+    user = company.users.create
+    order = user.orders.create(:total => 20, :taxes => 3)
+    Company.users_orders_total_gt(10).users_orders_taxes_lt(5).ascend_by_users_orders_total.all(:include => :users).should == Company.all
+  end
+  
+  it "should allow the use of deep :include when a join was created" do
+    company = Company.create
+    user = company.users.create
+    order = user.orders.create(:total => 20, :taxes => 3)
+    Company.users_orders_total_gt(10).users_orders_taxes_lt(5).ascend_by_users_orders_total.all(:include => {:users => :orders}).should == Company.all
+  end
+  
+  it "should allow the use of :include when traveling through the duplicate join" do
+    company = Company.create
+    user = company.users.create(:username => "bjohnson")
+    order = user.orders.create(:total => 20, :taxes => 3)
+    Company.users_username_like("bjohnson").users_orders_taxes_lt(5).ascend_by_users_orders_total.all(:include => :users).should == Company.all
+  end
+  
+  it "should allow the use of deep :include when traveling through the duplicate join" do
+    company = Company.create
+    user = company.users.create(:username => "bjohnson")
+    order = user.orders.create(:total => 20, :taxes => 3)
+    Company.users_orders_taxes_lt(50).ascend_by_users_orders_total.all(:include => {:users => :orders}).should == Company.all
+  end
+end

data/spec/named_scopes/conditions_spec.rb

@@ -0,0 +1,253 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe "Conditions" do
+  it "should be dynamically created and then cached" do
+    User.should_not respond_to(:age_less_than)
+    User.age_less_than(5)
+    User.should respond_to(:age_less_than)
+  end
+  
+  it "should not allow conditions on non columns" do
+    lambda { User.whatever_equals(2) }.should raise_error(NoMethodError)
+  end
+  
+  context "comparison conditions" do
+    it "should have equals" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_equals(6).all.should == User.find_all_by_age(6)
+    end
+    
+    it "should have does not equal" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_does_not_equal(6).all.should == User.find_all_by_age([5,7])
+    end
+    
+    it "should have less than" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_less_than(6).all.should == User.find_all_by_age(5)
+    end
+    
+    it "should have less than or equal to" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_less_than_or_equal_to(6).all.should == User.find_all_by_age([5, 6])
+    end
+    
+    it "should have greater than" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_greater_than(6).all.should == User.find_all_by_age(7)
+    end
+    
+    it "should have greater than or equal to" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_greater_than_or_equal_to(6).all.should == User.find_all_by_age([6, 7])
+    end
+  end
+  
+  context "wildcard conditions" do
+    it "should have like" do
+      %w(bjohnson thunt).each { |username| User.create(:username => username) }
+      User.username_like("john").all.should == User.find_all_by_username("bjohnson")
+    end
+    
+    it "should have begins with" do
+      %w(bjohnson thunt).each { |username| User.create(:username => username) }
+      User.username_begins_with("bj").all.should == User.find_all_by_username("bjohnson")
+    end
+    
+    it "should have ends with" do
+      %w(bjohnson thunt).each { |username| User.create(:username => username) }
+      User.username_ends_with("son").all.should == User.find_all_by_username("bjohnson")
+    end
+  end
+  
+  context "boolean conditions" do
+    it "should have null" do
+      ["bjohnson", nil].each { |username| User.create(:username => username) }
+      User.username_null.all.should == User.find_all_by_username(nil)
+    end
+    
+    it "should have empty" do
+      ["bjohnson", ""].each { |username| User.create(:username => username) }
+      User.username_empty.all.should == User.find_all_by_username("")
+    end
+  end
+  
+  context "any and all conditions" do
+    it "should do nothing if no arguments are passed" do
+      User.username_equals_any.proxy_options.should == {}
+    end
+    
+    it "should have equals any" do
+      %w(bjohnson thunt dgainor).each { |username| User.create(:username => username) }
+      User.username_equals_any("bjohnson", "thunt").all == User.find_all_by_username(["bjohnson", "thunt"])
+    end
+    
+    it "should have equals all" do
+      %w(bjohnson thunt dainor).each { |username| User.create(:username => username) }
+      User.username_equals_all("bjohnson", "thunt").all == []
+    end
+    
+    it "should have does not equal any" do
+      %w(bjohnson thunt dgainor).each { |username| User.create(:username => username) }
+      User.username_does_not_equal_any("bjohnson", "thunt").all == User.find_all_by_username("dgainor")
+    end
+    
+    it "should have does not equal all" do
+      %w(bjohnson thunt dgainor).each { |username| User.create(:username => username) }
+      User.username_does_not_equal_all("bjohnson", "thunt").all == User.find_all_by_username("dgainor")
+    end
+    
+    it "should have less than any" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_less_than_any(7,6).all == User.find_all_by_age([5, 6])
+    end
+    
+    it "should have less than all" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_less_than_all(7,6).all == User.find_all_by_age(5)
+    end
+    
+    it "should have less than or equal to any" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_less_than_or_equal_to_any(7,6).all == User.find_all_by_age([5, 6, 7])
+    end
+    
+    it "should have less than or equal to all" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_less_than_or_equal_to_all(7,6).all == User.find_all_by_age([5, 6])
+    end
+    
+    it "should have less than any" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_greater_than_any(5,6).all == User.find_all_by_age([6, 7])
+    end
+    
+    it "should have greater than all" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_greater_than_all(5,6).all == User.find_all_by_age(7)
+    end
+    
+    it "should have greater than or equal to any" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_greater_than_or_equal_to_any(5,6).all == User.find_all_by_age([5, 6, 7])
+    end
+    
+    it "should have greater than or equal to all" do
+      (5..7).each { |age| User.create(:age => age) }
+      User.age_greater_than_or_equal_to_all(5,6).all == User.find_all_by_age([6, 7])
+    end
+    
+    it "should have like all" do
+      %w(bjohnson thunt dgainor).each { |username| User.create(:username => username) }
+      User.username_like_all("bjohnson", "thunt").all == []
+      User.username_like_all("n", "o").all == User.find_all_by_username(["bjohnson", "thunt"])
+    end
+    
+    it "should have like any" do
+      %w(bjohnson thunt dgainor).each { |username| User.create(:username => username) }
+      User.username_like_all("bjohnson", "thunt").all == User.find_all_by_username(["bjohnson", "thunt"])
+    end
+    
+    it "should have begins with all" do
+      %w(bjohnson thunt dgainor).each { |username| User.create(:username => username) }
+      User.username_begins_with_all("bjohnson", "thunt").all == []
+    end
+    
+    it "should have begins with any" do
+      %w(bjohnson thunt dgainor).each { |username| User.create(:username => username) }
+      User.username_begins_with_any("bj", "th").all == User.find_all_by_username(["bjohnson", "thunt"])
+    end
+    
+    it "should have ends with all" do
+      %w(bjohnson thunt dgainor).each { |username| User.create(:username => username) }
+      User.username_ends_with_all("n", "r").all == []
+    end
+    
+    it "should have ends with any" do
+      %w(bjohnson thunt dgainor).each { |username| User.create(:username => username) }
+      User.username_ends_with_any("n", "r").all == User.find_all_by_username(["bjohnson", "dgainor"])
+    end
+  end
+  
+  context "alias conditions" do
+    it "should have is" do
+      User.age_is(5).proxy_options.should == User.age_equals(5).proxy_options
+    end
+    
+    it "should have eq" do
+      User.age_eq(5).proxy_options.should == User.age_equals(5).proxy_options
+    end
+    
+    it "should have not_equal_to" do
+      User.age_not_equal_to(5).proxy_options.should == User.age_does_not_equal(5).proxy_options
+    end
+    
+    it "should have is_not" do
+      # This is matching "not" first. How do you give priority in a regex? Because it's matching the
+      # 'not' condition and thinking the column is 'age_is'.
+      pending
+      User.age_is_not(5).proxy_options.should == User.age_does_not_equal(5).proxy_options
+    end
+    
+    it "should have not" do
+      User.age_not(5).proxy_options.should == User.age_does_not_equal(5).proxy_options
+    end
+    
+    it "should have ne" do
+      User.age_ne(5).proxy_options.should == User.age_does_not_equal(5).proxy_options
+    end
+    
+    it "should have lt" do
+      User.age_lt(5).proxy_options.should == User.age_less_than(5).proxy_options
+    end
+    
+    it "should have lte" do
+      User.age_lte(5).proxy_options.should == User.age_less_than_or_equal_to(5).proxy_options
+    end
+    
+    it "should have gt" do
+      User.age_gt(5).proxy_options.should == User.age_greater_than(5).proxy_options
+    end
+    
+    it "should have gte" do
+      User.age_gte(5).proxy_options.should == User.age_greater_than_or_equal_to(5).proxy_options
+    end
+    
+    it "should have contains" do
+      User.username_contains(5).proxy_options.should == User.username_like(5).proxy_options
+    end
+    
+    it "should have contains" do
+      User.username_includes(5).proxy_options.should == User.username_like(5).proxy_options
+    end
+    
+    it "should have bw" do
+      User.username_bw(5).proxy_options.should == User.username_begins_with(5).proxy_options
+    end
+    
+    it "should have ew" do
+      User.username_ew(5).proxy_options.should == User.username_ends_with(5).proxy_options
+    end
+    
+    it "should have nil" do
+      User.username_nil.proxy_options.should == User.username_nil.proxy_options
+    end
+  end
+  
+  context "searchlogic lambda" do
+    it "should be a string" do
+      User.username_like("test")
+      User.named_scope_options(:username_like).searchlogic_arg_type.should == :string
+    end
+    
+    it "should be an integer" do
+      User.id_gt(10)
+      User.named_scope_options(:id_gt).searchlogic_arg_type.should == :integer
+    end
+    
+    it "should be a float" do
+      Order.total_gt(10)
+      Order.named_scope_options(:total_gt).searchlogic_arg_type.should == :float
+    end
+  end
+end