searchgasm 0.9.0

data/searchgasm.gemspec

@@ -0,0 +1,124 @@
+
+# Gem::Specification for Searchgasm-0.9.0
+# Originally generated by Echoe
+
+--- !ruby/object:Gem::Specification 
+name: searchgasm
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Ben Johnson of Binary Logic
+autorequire: 
+bindir: bin
+
+date: 2008-09-01 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Makes ActiveRecord searching easier, robust, and powerful. Automatic conditions, pagination support, object based searching, and more.
+email: bjohnson@binarylogic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/searchgasm/active_record/associations.rb
+- lib/searchgasm/active_record/base.rb
+- lib/searchgasm/active_record/protection.rb
+- lib/searchgasm/helpers.rb
+- lib/searchgasm/search/base.rb
+- lib/searchgasm/search/condition.rb
+- lib/searchgasm/search/conditions.rb
+- lib/searchgasm/search/utilities.rb
+- lib/searchgasm/version.rb
+- lib/searchgasm.rb
+- README.mdown
+files: 
+- CHANGELOG
+- init.rb
+- lib/searchgasm/active_record/associations.rb
+- lib/searchgasm/active_record/base.rb
+- lib/searchgasm/active_record/protection.rb
+- lib/searchgasm/helpers.rb
+- lib/searchgasm/search/base.rb
+- lib/searchgasm/search/condition.rb
+- lib/searchgasm/search/conditions.rb
+- lib/searchgasm/search/utilities.rb
+- lib/searchgasm/version.rb
+- lib/searchgasm.rb
+- Manifest
+- MIT-LICENSE
+- Rakefile
+- README.mdown
+- test/fixtures/accounts.yml
+- test/fixtures/orders.yml
+- test/fixtures/users.yml
+- test/libs/acts_as_tree.rb
+- test/libs/rexml_fix.rb
+- test/test_active_record_associations.rb
+- test/test_active_record_base.rb
+- test/test_active_record_protection.rb
+- test/test_helper.rb
+- test/test_searchgasm_base.rb
+- test/test_searchgasm_condition.rb
+- test/test_searchgasm_conditions.rb
+- searchgasm.gemspec
+has_rdoc: true
+homepage: http://github.com/binarylogic/searchgasm
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Searchgasm
+- --main
+- README.mdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - "="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: searchgasm
+rubygems_version: 1.2.0
+specification_version: 2
+summary: Orgasmic ActiveRecord searching
+test_files: 
+- test/test_active_record_associations.rb
+- test/test_active_record_base.rb
+- test/test_active_record_protection.rb
+- test/test_helper.rb
+- test/test_searchgasm_base.rb
+- test/test_searchgasm_condition.rb
+- test/test_searchgasm_conditions.rb

data/test/fixtures/accounts.yml

@@ -0,0 +1,15 @@
+binary_logic:
+  id: 1
+  name: "Binary Logic"
+  active: true
+  
+neco:
+  id: 2
+  name: "NECO"
+  active: false
+  
+binary_fun:
+  id: 3
+  name: "Binary Fun"
+  active: true
+  

data/test/fixtures/orders.yml

@@ -0,0 +1,14 @@
+bens_order:
+  id: 1
+  user_id: 1
+  total: 500.23
+  description: A bunch of apple products, etc.
+  receipt: some binary text
+  
+drews_order:
+  id: 2
+  user_id: 2
+  total: 2.12
+  description: Some more apple projects, ipod, etc
+  receipt: some more binary text
+  

data/test/fixtures/users.yml

@@ -0,0 +1,27 @@
+ben:
+  id: 1
+  account_id: 1
+  parent_id: null
+  first_name: Ben
+  last_name: Johnson
+  active: true
+  bio: Totally awesome!
+  
+drew:
+  id: 2
+  account_id: 2
+  parent_id: 1
+  first_name: Drew
+  last_name: Mills
+  active: false
+  bio: Totally not awesome!
+  
+jennifer:
+  id: 3
+  account_id: 1
+  parent_id: 2
+  first_name: Jennifer
+  last_name: Hopkins
+  active: false
+  bio: Totally not awesome at all!
+  

data/test/libs/acts_as_tree.rb

@@ -0,0 +1,98 @@
+module ActiveRecord
+  module Acts
+    module Tree
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      # Specify this +acts_as+ extension if you want to model a tree structure by providing a parent association and a children
+      # association. This requires that you have a foreign key column, which by default is called +parent_id+.
+      #
+      #   class Category < ActiveRecord::Base
+      #     acts_as_tree :order => "name"
+      #   end
+      #
+      #   Example:
+      #   root
+      #    \_ child1
+      #         \_ subchild1
+      #         \_ subchild2
+      #
+      #   root      = Category.create("name" => "root")
+      #   child1    = root.children.create("name" => "child1")
+      #   subchild1 = child1.children.create("name" => "subchild1")
+      #
+      #   root.parent   # => nil
+      #   child1.parent # => root
+      #   root.children # => [child1]
+      #   root.children.first.children.first # => subchild1
+      #
+      # In addition to the parent and children associations, the following instance methods are added to the class
+      # after calling <tt>acts_as_tree</tt>:
+      # * <tt>siblings</tt> - Returns all the children of the parent, excluding the current node (<tt>[subchild2]</tt> when called on <tt>subchild1</tt>)
+      # * <tt>self_and_siblings</tt> - Returns all the children of the parent, including the current node (<tt>[subchild1, subchild2]</tt> when called on <tt>subchild1</tt>)
+      # * <tt>ancestors</tt> - Returns all the ancestors of the current node (<tt>[child1, root]</tt> when called on <tt>subchild2</tt>)
+      # * <tt>root</tt> - Returns the root of the current node (<tt>root</tt> when called on <tt>subchild2</tt>)
+      module ClassMethods
+        # Configuration options are:
+        #
+        # * <tt>foreign_key</tt> - specifies the column name to use for tracking of the tree (default: +parent_id+)
+        # * <tt>order</tt> - makes it possible to sort the children according to this SQL snippet.
+        # * <tt>counter_cache</tt> - keeps a count in a +children_count+ column if set to +true+ (default: +false+).
+        def acts_as_tree(options = {})
+          configuration = { :foreign_key => "parent_id", :order => nil, :counter_cache => nil }
+          configuration.update(options) if options.is_a?(Hash)
+
+          belongs_to :parent, :class_name => name, :foreign_key => configuration[:foreign_key], :counter_cache => configuration[:counter_cache]
+          has_many :children, :class_name => name, :foreign_key => configuration[:foreign_key], :order => configuration[:order], :dependent => :destroy
+
+          class_eval <<-EOV
+            include ActiveRecord::Acts::Tree::InstanceMethods
+
+            def self.roots
+              find(:all, :conditions => "#{configuration[:foreign_key]} IS NULL", :order => #{configuration[:order].nil? ? "nil" : %Q{"#{configuration[:order]}"}})
+            end
+
+            def self.root
+              find(:first, :conditions => "#{configuration[:foreign_key]} IS NULL", :order => #{configuration[:order].nil? ? "nil" : %Q{"#{configuration[:order]}"}})
+            end
+          EOV
+        end
+      end
+
+      module InstanceMethods
+        # Returns list of ancestors, starting from parent until root.
+        #
+        #   subchild1.ancestors # => [child1, root]
+        def ancestors
+          node, nodes = self, []
+          nodes << node = node.parent while node.parent
+          nodes
+        end
+
+        # Returns the root node of the tree.
+        def root
+          node = self
+          node = node.parent while node.parent
+          node
+        end
+
+        # Returns all siblings of the current node.
+        #
+        #   subchild1.siblings # => [subchild2]
+        def siblings
+          self_and_siblings - [self]
+        end
+
+        # Returns all siblings and a reference to the current node.
+        #
+        #   subchild1.self_and_siblings # => [subchild1, subchild2]
+        def self_and_siblings
+          parent ? parent.children : self.class.roots
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActiveRecord::Acts::Tree

data/test/libs/rexml_fix.rb

@@ -0,0 +1,14 @@
+module REXML
+  module Formatters
+    class Pretty < Default
+      private
+      def wrap(string, width)
+        # Recursivly wrap string at width.
+        return string if string.length <= width
+        place = string.rindex(/\s+/, width) # Position in string with last ' ' before cutoff
+        return string if place.nil?
+        return string[0,place] + "\n" + wrap(string[place+1..-1], width)
+      end
+    end
+  end
+end

data/test/test_active_record_associations.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestActiveRecordAssociations < Test::Unit::TestCase
+  fixtures :accounts, :users, :orders
+  
+  def setup
+    setup_db
+    load_fixtures
+  end
+  
+  def teardown
+    teardown_db
+  end
+  
+  def test_build_search
+    search = Account.find(1).users.build_search
+    assert_kind_of BinaryLogic::Searchgasm::Search::Base, search
+    assert_equal User, search.klass
+    assert_equal "\"users\".account_id = 1", search.conditions.scope
+    
+    search.conditions.first_name_contains = "Ben"
+    assert_equal({:conditions => ["(\"users\".\"first_name\" LIKE ?) AND (\"users\".account_id = 1)", "%Ben%"]}, search.sanitize)
+  end
+  
+  def test_searching
+    assert_equal [User.find(1)], Account.find(1).users.all(:conditions => {:first_name_begins_with => "Ben"})
+    assert_equal [User.find(1)], Account.find(1).users.find(:all, :conditions => {:first_name_begins_with => "Ben"})
+    assert_equal User.find(1), Account.find(1).users.first(:conditions => {:first_name_begins_with => "Ben"})
+    assert_equal User.find(1), Account.find(1).users.find(:first, :conditions => {:first_name_begins_with => "Ben"})
+    assert_equal [], Account.find(1).users.all(:conditions => {:first_name_begins_with => "Ben"}, :per_page => 20, :page => 5)
+  end
+  
+  def test_calculations
+    assert_equal 1, Account.find(1).users.count(:conditions => {:first_name_begins_with => "Ben"})
+    assert_equal 1, Account.find(1).users.sum("id", :conditions => {:first_name_begins_with => "Ben"})
+    assert_equal 1, Account.find(1).users.average("id", :conditions => {:first_name_begins_with => "Ben"})
+  end
+end

data/test/test_active_record_base.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestActiveRecordBase < Test::Unit::TestCase
+  fixtures :accounts, :users, :orders
+  
+  def setup
+    setup_db
+    load_fixtures
+  end
+  
+  def teardown
+    teardown_db
+  end
+  
+  def test_valid_find_options
+    assert_equal [ :conditions, :include, :joins, :limit, :offset, :order, :select, :readonly, :group, :from, :lock ], ActiveRecord::Base.valid_find_options
+  end
+  
+  def test_build_search
+    search = Account.build_search(:conditions => {:name_keywords => "awesome"}, :page => 2, :per_page => 15)
+    assert_kind_of BinaryLogic::Searchgasm::Search::Base, search
+    assert_equal Account, search.klass
+    assert_equal "awesome", search.conditions.name_keywords
+    assert_equal 2, search.page
+    assert_equal 15, search.per_page
+  end
+  
+  def test_searching
+    assert_equal Account.find(1, 3), Account.all(:conditions => {:name_contains => "Binary"})
+    assert_equal [Account.find(1)], Account.all(:conditions => {:name_contains => "Binary", :users => {:first_name_starts_with => "Ben"}})
+    assert_equal [], Account.all(:conditions => {:name_contains => "Binary", :users => {:first_name_starts_with => "Ben", :last_name => "Mills"}})
+    
+    read_only_accounts = Account.all(:conditions => {:name_contains => "Binary"}, :readonly => true)
+    assert read_only_accounts.first.readonly?
+    
+    assert_equal Account.find(1, 3), Account.all(:conditions => {:name_contains => "Binary"}, :page => 2)
+    assert_equal [], Account.all(:conditions => {:name_contains => "Binary"}, :page => 2, :per_page => 20)
+  end
+  
+  def test_counting
+    assert_equal 2, Account.count(:conditions => {:name_contains => "Binary"})
+    assert_equal 1, Account.count(:conditions => {:name_contains => "Binary", :users => {:first_name_contains => "Ben"}})
+  end
+  
+  def test_scoping
+    assert_equal({}, Account.send(:scope, :find))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,78 @@
+require "test/unit"
+require "rubygems"
+require "activerecord"
+require File.dirname(__FILE__) + '/libs/acts_as_tree'
+require File.dirname(__FILE__) + '/libs/rexml_fix'
+require File.dirname(__FILE__) + '/../lib/searchgasm'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+
+class Account < ActiveRecord::Base
+  has_many :users, :dependent => :destroy
+  has_many :orders, :through => :users
+end
+
+class User < ActiveRecord::Base
+  acts_as_tree
+  belongs_to :account
+  has_many :orders, :dependent => :destroy
+end
+
+class Order < ActiveRecord::Base
+  belongs_to :user
+end
+
+class Test::Unit::TestCase
+  def self.fixtures(*fixtures)
+    @fixtures ||= []
+    @fixtures += [fixtures].flatten
+  end
+  
+  def setup_db
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :accounts do |t|
+        t.datetime  :created_at    
+        t.datetime  :updated_at
+        t.string    :name
+        t.boolean   :active
+      end
+
+      create_table :users do |t|
+        t.datetime  :created_at      
+        t.datetime  :updated_at
+        t.integer   :account_id
+        t.integer   :parent_id
+        t.string    :first_name
+        t.string    :last_name
+        t.boolean   :active
+        t.text      :bio
+      end
+
+      create_table :orders do |t|
+        t.datetime  :created_at      
+        t.datetime  :updated_at
+        t.integer   :user_id
+        t.float     :total
+        t.text      :description
+        t.binary    :receipt
+      end
+    end
+  end
+  
+  def load_fixtures
+    self.class.fixtures.each do |fixture|
+      records = YAML.load(File.read(File.dirname(__FILE__) + "/fixtures/#{fixture.to_s}.yml"))
+      records.each do |name, attributes|
+        record = fixture.to_s.singularize.classify.constantize.new
+        attributes.each { |k, v| record.send("#{k}=", v) }
+        record.save!
+      end
+    end
+  end
+  
+  def teardown_db
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+end

data/test/test_searchgasm_base.rb

@@ -0,0 +1,116 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestSearchgasmBase < Test::Unit::TestCase
+  fixtures :accounts, :users, :orders
+  
+  def setup
+    setup_db
+    load_fixtures
+  end
+  
+  def teardown
+    teardown_db
+  end
+  
+  def test_initialize
+    search = BinaryLogic::Searchgasm::Search::Base.new(Account, :conditions => {:name_like => "binary"}, :page => 2, :limit => 10, :readonly => true)
+    assert_equal Account, search.klass
+    assert_equal "binary", search.conditions.name_like
+    assert_equal 2, search.page
+    assert_equal 10, search.limit
+    assert_equal true, search.readonly
+  end
+  
+  def test_setting_first_level_options
+    search = BinaryLogic::Searchgasm::Search::Base.new(Account)
+    
+    search.include = :users
+    assert_equal :users, search.include
+    
+    search.joins = "test"
+    assert_equal "test", search.joins
+    
+    search.page = 5
+    assert_equal 1, search.page # haven't set a limit yet
+    assert_equal nil, search.offset
+    
+    search.limit = 20
+    assert_equal search.limit, 20
+    assert_equal search.per_page, 20
+    assert_equal search.page, 5
+    assert_equal search.offset, 100
+    
+    search.offset = 50
+    assert_equal search.offset, 50
+    assert_equal search.page, 3
+    
+    search.per_page = 2
+    assert_equal search.per_page, 2
+    assert_equal search.limit, 2
+    assert_equal search.page, 25
+    assert_equal search.offset, 50
+    
+    search.order = "name ASC"
+    assert_equal search.order, "name ASC"
+    
+    search.select = "name"
+    assert_equal search.select, "name"
+    
+    search.readonly = true
+    assert_equal search.readonly, true
+    
+    search.group = "name"
+    assert_equal search.group, "name"
+    
+    search.from = "accounts"
+    assert_equal search.from, "accounts"
+    
+    search.lock = true
+    assert_equal search.lock, true
+  end
+  
+  def test_conditions
+    search = BinaryLogic::Searchgasm::Search::Base.new(Account)
+    assert_kind_of BinaryLogic::Searchgasm::Search::Conditions, search.conditions
+    assert_equal search.conditions.klass, Account
+    
+    search.conditions = {:name_like => "Binary"}
+    assert_kind_of BinaryLogic::Searchgasm::Search::Conditions, search.conditions
+  end
+  
+  def test_sanitize
+    search = BinaryLogic::Searchgasm::Search::Base.new(Account)
+    search.per_page = 2
+    search.conditions.name_like = "Binary"
+    search.conditions.users.id_greater_than = 2
+    search.page = 3
+    search.readonly = true
+    assert_equal search.sanitize, {:include => :users, :offset => 6, :readonly => true, :conditions => ["(\"accounts\".\"name\" LIKE ?) AND (\"users\".\"id\" > ?)", "%Binary%", 2], :limit => 2 }
+  end
+  
+  def test_searching
+    search = BinaryLogic::Searchgasm::Search::Base.new(Account)
+    search.conditions.name_like = "Binary"
+    assert_equal search.all, [Account.find(1), Account.find(3)]
+    assert_equal search.find(:all), [Account.find(1), Account.find(3)]
+    assert_equal search.first, Account.find(1)
+    assert_equal search.find(:first), Account.find(1)
+    
+    search.per_page = 20
+    search.page = 2
+    
+    assert_equal search.all, []
+    assert_equal search.find(:all), []
+    assert_equal search.first, nil
+    assert_equal search.find(:first), nil
+        
+    search.per_page = 0
+    search.page = nil
+    search.conditions.users.first_name_contains = "Ben"
+    search.conditions.users.orders.description_keywords = "products, &*ap#ple $%^&*"
+    assert_equal search.all, [Account.find(1)]
+    assert_equal search.find(:all), [Account.find(1)]
+    assert_equal search.first, Account.find(1)
+    assert_equal search.find(:first), Account.find(1)
+  end
+end