binarylogic-search 2.0.0

data/rails/init.rb

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

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/associations_spec.rb

@@ -0,0 +1,124 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe "Associations" do
+  before(:each) do
+    @users_join_sql = ["LEFT OUTER JOIN \"users\" ON users.company_id = companies.id"]
+    @orders_join_sql = ["LEFT OUTER JOIN \"users\" ON users.company_id = companies.id", "LEFT OUTER JOIN \"orders\" ON orders.user_id = users.id"]
+  end
+  
+  it "should create a named scope" do
+    Company.users_username_like("bjohnson").proxy_options.should == User.username_like("bjohnson").proxy_options.merge(:joins => @users_join_sql)
+  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 => @orders_join_sql)
+  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_join_sql)
+    Company.users_username_like("thunt").proxy_options.should == User.username_like("thunt").proxy_options.merge(:joins => @users_join_sql)
+  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 => @orders_join_sql)
+    Company.users_orders_total_greater_than(20).proxy_options.should == Order.total_greater_than(20).proxy_options.merge(:joins => @orders_join_sql)
+  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_join_sql)
+  end
+  
+  it "should allow deep aliases" do
+    Company.users_orders_total_gt(10).proxy_options.should == Order.total_gt(10).proxy_options.merge(:joins => @orders_join_sql)
+  end
+  
+  it "should allow ascending" do
+    Company.ascend_by_users_username.proxy_options.should == User.ascend_by_username.proxy_options.merge(:joins => @users_join_sql)
+  end
+  
+  it "should allow descending" do
+    Company.descend_by_users_username.proxy_options.should == User.descend_by_username.proxy_options.merge(:joins => @users_join_sql)
+  end
+  
+  it "should allow deep ascending" do
+    Company.ascend_by_users_orders_total.proxy_options.should == Order.ascend_by_total.proxy_options.merge(:joins => @orders_join_sql)
+  end
+  
+  it "should allow deep descending" do
+    Company.descend_by_users_orders_total.proxy_options.should == Order.descend_by_total.proxy_options.merge(:joins => @orders_join_sql)
+  end
+  
+  it "should include optional associations" do
+    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.ascend_by_users_orders_total.users_orders_taxes_lt(50).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

data/spec/named_scopes/ordering_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe "Ordering" do
+  it "should be dynamically created and then cached" do
+    User.should_not respond_to(:ascend_by_username)
+    User.ascend_by_username
+    User.should respond_to(:ascend_by_username)
+  end
+  
+  it "should have ascending" do
+    %w(bjohnson thunt).each { |username| User.create(:username => username) }
+    User.ascend_by_username.all.should == User.all(:order => "username ASC")
+  end
+  
+  it "should have descending" do
+    %w(bjohnson thunt).each { |username| User.create(:username => username) }
+    User.descend_by_username.all.should == User.all(:order => "username DESC")
+  end
+  
+  it "should have order" do
+    User.order("ascend_by_username").proxy_options.should == User.ascend_by_username.proxy_options
+  end
+end

data/spec/search_spec.rb

@@ -0,0 +1,251 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+describe "Search" do
+  context "implementation" do
+    it "should create a search proxy" do
+      User.search(:username => "joe").should be_kind_of(Searchlogic::Search)
+    end
+
+    it "should create a search proxy using the same class" do
+      User.search.klass.should == User
+    end
+
+    it "should pass on the current scope to the proxy" do
+      company = Company.create
+      user = company.users.create
+      search = company.users.search
+      search.current_scope.should == company.users.scope(:find)
+    end
+  end
+  
+  context "initialization" do
+    it "should require a class" do
+      lambda { Searchlogic::Search.new }.should raise_error(ArgumentError)
+    end
+  
+    it "should set the conditions" do
+      search = User.search(:username => "bjohnson")
+      search.conditions.should == {:username => "bjohnson"}
+    end
+  end
+  
+  context "conditions" do
+    it "should set the conditions and be accessible individually" do
+      search = User.search
+      search.conditions = {:username => "bjohnson"}
+      search.username.should == "bjohnson"
+    end
+    
+    it "should set the conditions and allow string keys" do
+      search = User.search
+      search.conditions = {"username" => "bjohnson"}
+      search.username.should == "bjohnson"
+    end
+    
+    it "should ignore blank values" do
+      search = User.search
+      search.conditions = {"username" => ""}
+      search.username.should be_nil
+    end
+    
+    it "should ignore blank values in arrays" do
+      search = User.search
+      search.conditions = {"username_equals_any" => [""]}
+      search.username_equals_any.should be_blank
+    end
+  end
+  
+  context "condition accessors" do
+    it "should allow setting exact columns individually" do
+      search = User.search
+      search.username = "bjohnson"
+      search.username.should == "bjohnson"
+    end
+    
+    it "should allow setting local column conditions individually" do
+      search = User.search
+      search.username_gt = "bjohnson"
+      search.username_gt.should == "bjohnson"
+    end
+    
+    it "should allow setting association conditions" do
+      search = User.search
+      search.orders_total_gt = 10
+      search.orders_total_gt.should == 10
+    end
+    
+    it "should allow using custom conditions" do
+      User.named_scope(:four_year_olds, { :conditions => { :age => 4 } })
+      search = User.search
+      search.four_year_olds = true
+      search.four_year_olds.should == true
+      search.proxy_options.should == User.four_year_olds.proxy_options
+    end
+    
+    it "should not merge conflicting conditions into one value" do
+      # This class should JUST be a proxy. It should not do anything more than that.
+      # A user would be allowed to call both named scopes if they wanted.
+      search = User.search
+      search.username_greater_than = "bjohnson1"
+      search.username_gt = "bjohnson2"
+      search.username_greater_than.should == "bjohnson1"
+      search.username_gt.should == "bjohnson2"
+    end
+    
+    it "should allow setting custom conditions individually" do
+      User.named_scope(:four_year_olds, :conditions => {:age => 4})
+      search = User.search
+      search.four_year_olds = true
+      search.four_year_olds.should == true
+    end
+    
+    it "should not allow setting conditions that are not scopes" do
+      search = User.search
+      lambda { search.unknown = true }.should raise_error(Searchlogic::Search::UnknownConditionError)
+    end
+    
+    context "type casting" do
+      it "should be a Boolean given true" do
+        search = User.search
+        search.id_nil = true
+        search.id_nil.should == true
+      end
+      
+      it "should be a Boolean given 'true'" do
+        search = User.search
+        search.id_nil = "true"
+        search.id_nil.should == true
+      end
+      
+      it "should be a Boolean given '1'" do
+        search = User.search
+        search.id_nil = "1"
+        search.id_nil.should == true
+      end
+      
+      it "should be a Boolean given false" do
+        search = User.search
+        search.id_nil = false
+        search.id_nil.should == false
+      end
+      
+      it "should be a Boolean given 'false'" do
+        search = User.search
+        search.id_nil = "false"
+        search.id_nil.should == false
+      end
+      
+      it "should be a Boolean given '0'" do
+        search = User.search
+        search.id_nil = "0"
+        search.id_nil.should == false
+      end
+      
+      it "should be an Integer given 1" do
+        search = User.search
+        search.id_gt = 1
+        search.id_gt.should == 1
+      end
+      
+      it "should be an Integer given '1'" do
+        search = User.search
+        search.id_gt = "1"
+        search.id_gt.should == 1
+      end
+      
+      it "should be a Float given 1.0" do
+        search = Order.search
+        search.total_gt = 1.0
+        search.total_gt.should == 1.0
+      end
+      
+      it "should be a Float given '1'" do
+        search = Order.search
+        search.total_gt = "1"
+        search.total_gt.should == 1.0
+      end
+      
+      it "should be a Float given '1.5'" do
+        search = Order.search
+        search.total_gt = "1.5"
+        search.total_gt.should == 1.5
+      end
+      
+      it "should be a Date given 'Jan 1, 2009'" do
+        search = Order.search
+        search.shipped_on_after = "Jan 1, 2009"
+        search.shipped_on_after.should == Date.parse("Jan 1, 2009")
+      end
+      
+      it "should be a Time given 'Jan 1, 2009'" do
+        search = Order.search
+        search.created_at_after = "Jan 1, 2009"
+        search.created_at_after.should == Time.parse("Jan 1, 2009")
+      end
+      
+      it "should be a Time given 'Jan 1, 2009 9:33AM'" do
+        search = Order.search
+        search.created_at_after = "Jan 1, 2009 9:33AM"
+        search.created_at_after.should == Time.parse("Jan 1, 2009 9:33AM")
+      end
+      
+      it "should be an Array and cast it's values given ['1', '2', '3']" do
+        search = Order.search
+        search.id_equals_any = ["1", "2", "3"]
+        search.id_equals_any.should == [1, 2, 3]
+      end
+      
+      it "should type cast association conditions" do
+        search = User.search
+        search.orders_total_gt = "10"
+        search.orders_total_gt.should == 10
+      end
+      
+      it "should type cast deep association conditions" do
+        search = Company.search
+        search.users_orders_total_gt = "10"
+        search.users_orders_total_gt.should == 10
+      end
+    end
+  end
+  
+  context "taking action" do
+    it "should return all when not given any conditions" do
+      3.times { User.create }
+      User.search.all.length.should == 3
+    end
+    
+    it "should implement the current scope based on an association" do
+      User.create
+      company = Company.create
+      user = company.users.create
+      company.users.search.all.should == [user]
+    end
+    
+    it "should implement the current scope based on a named scope" do
+      User.named_scope(:four_year_olds, :conditions => {:age => 4})
+      (3..5).each { |age| User.create(:age => age) }
+      User.four_year_olds.search.all.should == User.find_all_by_age(4)
+    end
+    
+    it "should call named scopes for conditions" do
+      User.search(:age_less_than => 5).proxy_options.should == User.age_less_than(5).proxy_options
+    end
+    
+    it "should alias exact column names to use equals" do
+      User.search(:username => "joe").proxy_options.should == User.username_equals("joe").proxy_options
+    end
+    
+    it "should recognize conditions with a value of true where the named scope has an arity of 0" do
+      User.search(:username_nil => true).proxy_options.should == User.username_nil.proxy_options
+    end
+    
+    it "should ignore conditions with a value of false where the named scope has an arity of 0" do
+      User.search(:username_nil => false).proxy_options.should == {}
+    end
+    
+    it "should recognize the order condition" do
+      User.search(:order => "ascend_by_username").proxy_options.should == User.ascend_by_username.proxy_options
+    end
+  end
+end