simple-search 0.9.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+source :rubygems
+
+gem "activerecord", "~> 3.1"
+gem "activesupport", "~> 3.1"
+gem "actionpack", "~> 3.1"
+
+group :development do
+  gem "shoulda", ">= 2.11"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "rcov", ">= 0"
+	gem 'sqlite3', '1.3.4'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Allen Kim
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= simple-search
+
+Description goes here.
+
+== Contributing to simple-search
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Allen Kim. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "simple-search"
+  gem.homepage = "http://github.com/bighostkim/simple-search"
+  gem.license = "MIT"
+  gem.summary =  %Q{ActiveRecord searching/paging/sorting/grouping from url}
+  gem.description = %Q{
+		Translates url commands for searching, paging, sorting, groupion against ActiveRecord and its associations.
+		Provides view helpers including links for order and urls for search, group, and page.
+	} 
+  gem.email = "bighostkim@gmail.com"
+  gem.authors = ["Allen Kim"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simple-search #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.9.0

data/lib/simple_search.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+require 'active_support'
+require 'action_view'
+require 'action_controller'
+require 'simple_search/active_record'
+
+ActiveRecord::Base.send(:include, SimpleSearch::ActiveRecord)
+#ActionController::Base.helper(MetaSearch::Helpers::UrlHelper)

data/lib/simple_search/active_record.rb

@@ -0,0 +1,104 @@
+module SimpleSearch
+  OP_MAP = { :gt=>">", :ge=>">=", :lt=>"<", :le=>"<=", :eq=>"=", :ne=>"<>", :in=>"IN", 
+    :bt=>"BETWEEN",    :between => "BETWEEN",
+    :sw=>"LIKE",       :startswith => "LIKE",
+    :ew=>"LIKE",       :endswith => "LIKE",
+    :ct=>"LIKE",       :contains => "LIKE",    :like => "LIKE",
+    :nc=>"NOT LIKE",   :notcontains => "NOT LIKE", :notlike=>"NOT LIKE",
+    :is=>"IS", 
+    :it=> 'IS NOT',    :isnot => "IS NOT"
+  }
+
+  class Error < Exception; end
+
+  module ActiveRecord
+    
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def simplesearch(params={})
+
+        arel = self.scoped unless self.is_a?(::ActiveRecord::Relation)
+				params, where_params=filtered_params(params)  # validate params
+        arel = with_ss_where(arel,where_params)
+        arel = with_ss_group(arel,params['group_by'])
+        arel = with_ss_order(arel,params['order_by'])
+        #arel = with_ss_limit(arel,params)
+        #arel = with_ss_order(arel,params)
+        arel
+      end
+
+      alias_method :ss, :simplesearch unless respond_to?(:ss)
+		
+			def filtered_params(params)
+				where_params = {}
+				other_params = {}
+        params.each do |key,value|
+					if ["group_by","page_by","page_no","order_by"].include?(key)
+						other_params[key]=value
+					else
+						matches = /(.*)_([a-z]+)$/.match(key)
+						if matches.length==3
+							all, col, op = matches.to_a
+							operands = SimpleSearch::OP_MAP.keys
+							if operands.include?(op.to_sym)
+								where_params[key]=value
+							else
+								logger.warning("SimpleSearch ignored #{key}. operand must be one of #{operands}") unless logger.nil?
+							end
+						else
+							logger.warning("SimpleSearch ignored #{key}. it requires to end with _<operands>") unless logger.nil?
+						end
+					end
+				end
+				[other_params, where_params]
+			end
+
+      def with_ss_where(arel,params={})          
+        params.each do |key,value|
+					matches = /(.*)_([a-z]+)$/.match(key)
+          all, col, op = matches.to_a
+					where_col =  col =~ /\./ ? col : "#{arel.table_name}.#{col}" #if no table name, the add it
+          where_value = case op.to_sym
+            when :gt,:ge,:lt,:le,:eq,:ne  then value
+            when :sw       then "#{value}%"  # LIKE
+            when :ew       then "%#{value}"  # LIKE
+            when :ct,:contains,:like then "%#{value}%" # LIKE
+            when :nc,:notcontains,:notlike then "%#{value}%" # NOT LIKE
+            when :is, :isnot, :it
+              if    ["NULL","null"].include?(value)   then nil
+              elsif ["TRUE","true"].include?(value)   then true
+              elsif ["FALSE","false"].include?(value) then false
+              end
+          end
+					if op.to_sym==:in
+						arel = arel.where("#{where_col}"=>value.split(','))
+					elsif [:bt, :between].include? op.to_sym
+            first,second = value.split('..')
+						arel = arel.where("#{where_col}"=>Range.new(first,second))
+					else
+						arel = arel.where("#{where_col} #{SimpleSearch::OP_MAP[op.to_sym]} ?", where_value)
+					end
+        end
+        arel
+      end
+
+			def with_ss_group(arel,group_by)          
+				arel= arel.group(group_by) if group_by
+				arel
+			end
+
+			def with_ss_order(arel,order_by)          
+				arel= arel.order(order_by) if order_by
+				arel
+			end
+			
+			def with_ss_limit(arel,params={})          
+				# TODO
+			end
+
+		end # end class methods
+  end # end module ActiveRecord
+end  # end module SimpleSearch

data/simple-search.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "simple-search"
+  s.version = "0.9.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Allen Kim"]
+  s.date = "2012-03-10"
+  s.description = "\n\t\tTranslates url commands for searching, paging, sorting, groupion against ActiveRecord and its associations.\n\t\tProvides view helpers including links for order and urls for search, group, and page.\n\t"
+  s.email = "bighostkim@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/simple_search.rb",
+    "lib/simple_search/active_record.rb",
+    "simple-search.gemspec",
+    "test/helper.rb",
+    "test/tables_models.rb",
+    "test/test_simple_search.rb"
+  ]
+  s.homepage = "http://github.com/bighostkim/simple-search"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "ActiveRecord searching/paging/sorting/grouping from url"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.1"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.1"])
+      s.add_runtime_dependency(%q<actionpack>, ["~> 3.1"])
+      s.add_development_dependency(%q<shoulda>, [">= 2.11"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, ["= 1.3.4"])
+    else
+      s.add_dependency(%q<activerecord>, ["~> 3.1"])
+      s.add_dependency(%q<activesupport>, ["~> 3.1"])
+      s.add_dependency(%q<actionpack>, ["~> 3.1"])
+      s.add_dependency(%q<shoulda>, [">= 2.11"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, ["= 1.3.4"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["~> 3.1"])
+    s.add_dependency(%q<activesupport>, ["~> 3.1"])
+    s.add_dependency(%q<actionpack>, ["~> 3.1"])
+    s.add_dependency(%q<shoulda>, [">= 2.11"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, ["= 1.3.4"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simple_search'
+require 'tables_models.rb'

data/test/tables_models.rb

@@ -0,0 +1,42 @@
+# setting database tables
+root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3", 
+  :database => "#{root}/simpesearch_gem_test.sqlite3"
+)
+
+#require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+# drop tables
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'posts'")
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'comments'")
+
+# create tables
+ActiveRecord::Base.connection.create_table(:posts) do |t|
+    t.string :subject
+    t.text   :body
+end
+ActiveRecord::Base.connection.create_table(:comments) do |t|
+    t.string :post_id
+    t.text   :body
+		t.boolean :spam_flag
+end
+
+# insert tables
+ActiveRecord::Base.connection.execute("INSERT INTO posts (id,subject,body) VALUES (1, 'subject foo','body foo') ")
+ActiveRecord::Base.connection.execute("INSERT INTO posts (id,subject,body) VALUES (2, 'subject bar','body bar') ")
+ActiveRecord::Base.connection.execute("INSERT INTO posts (id,subject,body) VALUES (3, 'subject fooz','body baz') ")
+ActiveRecord::Base.connection.execute("INSERT INTO comments (id,post_id,body) VALUES (11, 1,'post1 comment foo') ")
+ActiveRecord::Base.connection.execute("INSERT INTO comments (id,post_id,body) VALUES (12, 1,'post1 comment bar') ")
+ActiveRecord::Base.connection.execute("INSERT INTO comments (id,post_id,body) VALUES (21, 2,'post2 comment foo') ")
+ActiveRecord::Base.connection.execute("INSERT INTO comments (id,post_id,body) VALUES (22, 2,'post2 comment bar') ")
+ActiveRecord::Base.connection.execute("INSERT INTO comments (id,post_id,body,spam_flag) VALUES (31, 3,'post3 comment foo', 1) ")
+ActiveRecord::Base.connection.execute("INSERT INTO comments (id,post_id,body,spam_flag) VALUES (32, 3,'post3 comment bar', 0) ")
+
+# models
+class Post < ActiveRecord::Base
+	has_many :comments
+end
+class Comment < ActiveRecord::Base
+	belongs_to :post
+end

data/test/test_simple_search.rb

@@ -0,0 +1,64 @@
+require 'helper'
+
+class TestSimpleSearch < Test::Unit::TestCase
+
+  should "work with arel where conditions" do
+		posts_comments = Post.select('posts.*, comments.body as comment').joins(:comments)
+		result = posts_comments.simplesearch('id_eq'=>1, 'subject_eq'=>'subject foo', 'body_eq'=>'body foo')
+		assert_equal 1, result.first.id
+
+		result = posts_comments.simplesearch('id_gt'=>1, 'id_lt'=>3)
+		assert_equal 2, result.first.id
+
+		result = posts_comments.simplesearch('id_ge'=>1, 'id_le'=>3)
+		assert_equal 6, result.length
+
+		result = posts_comments.simplesearch('id_ne'=>1)
+		assert_equal 4, result.length
+
+		result = posts_comments.simplesearch('id_in'=>'1,2')
+		assert_equal 1, result.first.id
+		assert_equal 2, result.last.id
+
+		result = posts_comments.simplesearch('id_bt'=>'1..3')
+		assert_equal 1, result.first.id
+		assert_equal 3, result.last.id
+
+		result = posts_comments.simplesearch('subject_sw'=>'subject')
+		assert_equal 6, result.length
+
+		result = posts_comments.simplesearch('subject_ew'=>'foo')
+		assert_equal 2, result.length
+
+		result = posts_comments.simplesearch('body_ct'=>'body')
+		assert_equal 6, result.length
+		
+		result = posts_comments.simplesearch('body_nc'=>'foo')
+		assert_equal 4, result.length
+
+		result = posts_comments.simplesearch('comments.spam_flag_is'=>'NULL')
+		assert_equal 4, result.length
+
+		result = posts_comments.simplesearch('comments.spam_flag_isnot'=>'NULL')
+		assert_equal 2, result.length
+	end
+
+  should "work with arel group conditions" do
+		posts_comments = Post.select('posts.*, count(comments.id) as num_comment').joins(:comments)
+		result = posts_comments.simplesearch('group_by'=>'posts.id')
+		assert_equal 3, result.length
+  end
+
+  should "work with arel order conditions" do
+		posts_comments = Post.select('posts.*, comments.id as comment_id, comments.body as comment').joins(:comments)
+		result = posts_comments.simplesearch('order_by'=>'comment_id')
+		assert_equal 11, result.first.comment_id
+		result = posts_comments.simplesearch('order_by'=>'comment_id desc')
+		assert_equal 32, result.first.comment_id
+  end
+
+  should "work with arel limit conditions" do
+		true
+  end
+
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification 
+name: simple-search
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Allen Kim
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.1"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.1"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.1"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.11"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.12"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.3.4
+  type: :development
+  prerelease: false
+  version_requirements: *id009
+description: "\n\
+  \t\tTranslates url commands for searching, paging, sorting, groupion against ActiveRecord and its associations.\n\
+  \t\tProvides view helpers including links for order and urls for search, group, and page.\n\
+  \t"
+email: bighostkim@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/simple_search.rb
+- lib/simple_search/active_record.rb
+- simple-search.gemspec
+- test/helper.rb
+- test/tables_models.rb
+- test/test_simple_search.rb
+homepage: http://github.com/bighostkim/simple-search
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2459026480116491864
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: ActiveRecord searching/paging/sorting/grouping from url
+test_files: []
+