simple-search 0.9.0 → 0.10.0

data/VERSION

@@ -1 +1 @@
-0.9.0
+0.10.0

data/lib/simple_search/active_record.rb

@@ -21,12 +21,11 @@ module SimpleSearch
       def simplesearch(params={})
 
         arel = self.scoped unless self.is_a?(::ActiveRecord::Relation)
-				params, where_params=filtered_params(params)  # validate params
+				other_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 = with_ss_group(arel,other_params['group_by'])
+        arel = with_ss_order(arel,other_params['order_by'])
+        arel = with_ss_limit_offset(arel,other_params)
         arel
       end
 
@@ -36,7 +35,7 @@ module SimpleSearch
 				where_params = {}
 				other_params = {}
         params.each do |key,value|
-					if ["group_by","page_by","page_no","order_by"].include?(key)
+					if ["group_by","page_by","page", "order_by"].include?(key)
 						other_params[key]=value
 					else
 						matches = /(.*)_([a-z]+)$/.match(key)
@@ -95,8 +94,11 @@ module SimpleSearch
 				arel
 			end
 			
-			def with_ss_limit(arel,params={})          
-				# TODO
+			def with_ss_limit_offset(arel,params)          
+				page_num = (params['page'] || 1).to_i
+				page_by  = (params['page_by'] || 50).to_i
+				arel = arel.limit(page_by).offset( (page_num-1)*page_by )
+				arel
 			end
 
 		end # end class methods

data/lib/simple_search/exception.rb

@@ -0,0 +1,3 @@
+module SimpleSearch
+	class Exception < Exception; end
+end

data/lib/simple_search/view_helper.rb

@@ -0,0 +1,123 @@
+module SimpleSearch
+  module ViewHelper
+
+		# Example:
+		#
+		#   <%= order_by :name %>
+		#   <%= order_by :name, 'Company Name' %>
+		#   <%= order_by :name, 'Company Name', :class=>'bold' %>
+		def order_link(attr, name=nil, html_options={})
+			raise Exception, "must be used in a view" unless (request.fullpath && request.parameters)
+
+			# check if order_by is in an url array
+			matches = request.fullpath.match Regexp.new("[\&\?]([a-z_]+)\\[order_by\\]=") # &array[order_by]
+			order_arr_key = (matches && matches.length == 2) ? matches[1] : nil
+
+			# get order_by value
+			order_by_value = order_arr_key ? request.parameters[order_arr_key][:order_by] : request.parameters[:order_by]
+      if order_by_value
+        order_by_col, current_order = order_by_value.split(" ")
+      else
+        order_by_col, current_order = attr, nil
+      end
+
+			# determine next order
+			next_order = {nil=>'asc', 'asc'=>'desc', 'desc'=>'asc'}[current_order]
+		
+			# build new url params
+			new_url_params = if order_arr_key
+				old_arr = request.parameters[order_arr_key]
+				new_arr = old_arr.merge(:order_by => "#{order_by_col} #{next_order}")
+				request.parameters.merge(order_arr_key => new_arr)
+			else
+				request.parameters.merge(:order_by => "#{order_by_col} #{next_order}" )
+			end
+
+			# build link text
+			name ||= attr.to_s.humanize.titleize.strip
+			order_indicator = {nil=>'', 'asc'=>'&#9650;', 'desc'=>'&#9660;'}[current_order]
+			link_text = "#{name} #{order_indicator}".strip
+
+			link_to link_text, new_url_params, html_options
+		end
+
+		# 
+		# Returns page related properties in hash
+		#
+		def page_properties(arel)
+			total_rows = arel.limit(1000000).offset(0).count
+
+			# check if page is in an url array
+			matches = request.fullpath.match Regexp.new("\&([a-z_]+)\\[page|page_by\\]=") # &array[page]
+			page_arr_key = (matches && matches.length == 2) ? matches[1] : nil
+
+			# get current page value 
+			page = page_arr_key ? request.parameters[page_arr_key][:page] : request.parameters[:page]
+			page ||= 1 
+      page = page.to_i
+
+			page_by = page_arr_key ? request.parameters[page_arr_key][:page_by] : request.parameters[:page_by]
+			page_by ||= 30 
+      page_by = page_by.to_i
+
+			last_page = total_rows / page_by.to_i 
+			last_page += 1 if total_rows % page_by.to_i != 0
+			{
+				:total_rows => total_rows,
+				:last_page => last_page,
+				:current_page => (page || 1).to_i,
+				:rows_per_page => (page_by || 30).to_i,
+				:page_arr_key => page_arr_key
+			}
+		end
+
+		# 
+		# Returns a url params in hash for the page number given
+		#
+		def page_params(page_num, page_arr_key=nil)
+			params = if page_arr_key
+				old_arr = request.parameters[page_arr_key].with_indifferent_access
+				request.parameters.merge(page_arr_key => old_arr.merge(:page => page_num) )
+			else
+				request.parameters.merge(:page => page_num )
+			end
+      params.with_indifferent_access
+		end
+
+		# 
+		# Returns page url params in hash with the page number as key
+		#
+		def page_url_params(arel, num_pages=5)
+			page_props = page_properties(arel)
+			num_bf_af = (num_pages-1)/2
+			current_page = page_props[:current_page]
+			last_page    = page_props[:last_page]
+
+			page_numbers = [1, last_page]
+			page_numbers << ([current_page-num_bf_af,1].max..[current_page+num_bf_af,last_page].min).to_a
+			page_numbers << last_page
+			page_numbers = page_numbers.flatten.uniq.sort
+
+			page_url_params = {}
+			for num in page_numbers
+				page_url_params[num] = page_params(num, page_props[:page_arr_key])
+			end
+
+			page_url_params
+		end
+
+		def page_urls(arel, http_options={})
+			page_urls = []
+			prev_page = 0	
+			page_url_params(arel).each { |page, url_params|
+				if page.to_i > (prev_page+1) # page number jumped up, need to have some indicator
+					page_urls << "<span class='filler'>...</span>"
+				end
+				page_urls << link_to(page, url_params, http_options)
+        prev_page = page
+			}
+      page_urls
+		end
+
+	end
+end

data/lib/simple_search.rb

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

data/simple-search.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "simple-search"
-  s.version = "0.9.0"
+  s.version = "0.10.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.date = "2012-03-14"
   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 = [
@@ -25,10 +25,13 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/simple_search.rb",
     "lib/simple_search/active_record.rb",
+    "lib/simple_search/exception.rb",
+    "lib/simple_search/view_helper.rb",
     "simple-search.gemspec",
     "test/helper.rb",
     "test/tables_models.rb",
-    "test/test_simple_search.rb"
+    "test/test_active_record.rb",
+    "test/test_view_helper.rb"
   ]
   s.homepage = "http://github.com/bighostkim/simple-search"
   s.licenses = ["MIT"]

data/test/tables_models.rb

@@ -10,6 +10,7 @@ ActiveRecord::Base.establish_connection(
 # drop tables
 ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'posts'")
 ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'comments'")
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'post_likes'")
 
 # create tables
 ActiveRecord::Base.connection.create_table(:posts) do |t|
@@ -21,6 +22,23 @@ ActiveRecord::Base.connection.create_table(:comments) do |t|
     t.text   :body
 		t.boolean :spam_flag
 end
+ActiveRecord::Base.connection.create_table(:post_likes) do |t|
+    t.string :post_id
+		t.boolean :like
+end
+
+# models
+class Post < ActiveRecord::Base
+	has_many :comments
+	has_many :post_likes
+end
+class Comment < ActiveRecord::Base
+	belongs_to :post
+  has_many :votes
+end
+class PostLike < ActiveRecord::Base
+	belongs_to :post
+end
 
 # insert tables
 ActiveRecord::Base.connection.execute("INSERT INTO posts (id,subject,body) VALUES (1, 'subject foo','body foo') ")
@@ -33,10 +51,10 @@ ActiveRecord::Base.connection.execute("INSERT INTO comments (id,post_id,body) VA
 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
+Post.all.each do |post|
+  for n in 1..100
+    post_like = PostLike.new(:post => post, :like=> rand(2))
+    post_like.save
+  end
 end
+

data/test/{test_simple_search.rb → test_active_record.rb}

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestSimpleSearch < Test::Unit::TestCase
+class TestActiveRecord < Test::Unit::TestCase
 
   should "work with arel where conditions" do
 		posts_comments = Post.select('posts.*, comments.body as comment').joins(:comments)
@@ -57,8 +57,19 @@ class TestSimpleSearch < Test::Unit::TestCase
 		assert_equal 32, result.first.comment_id
   end
 
-  should "work with arel limit conditions" do
-		true
+  should "work with arel limit and offset 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', 'page_by'=>2)
+		assert_equal [11,12], result.map {|r| r.comment_id}
+
+		result = posts_comments.simplesearch('order_by'=>'comment_id', 'page'=> 1, 'page_by'=>2)
+		assert_equal [11,12], result.map {|r| r.comment_id}
+
+		result = posts_comments.simplesearch('order_by'=>'comment_id', 'page'=> 2, 'page_by'=>2)
+		assert_equal [21,22], result.map {|r| r.comment_id}
+
+		result = posts_comments.simplesearch('order_by'=>'comment_id', 'page'=> 3, 'page_by'=>2)
+		assert_equal [31,32], result.map {|r| r.comment_id}
   end
 
 end

data/test/test_view_helper.rb

@@ -0,0 +1,97 @@
+require 'helper'
+require 'action_view/test_case'
+
+class TestViewHelper < Test::Unit::TestCase
+  class MyView < ActionView::Base
+    include SimpleSearch::ViewHelper
+  end
+
+  def setup
+    @view = MyView.new 
+    router = ActionDispatch::Routing::RouteSet.new
+    router.draw do
+      match ':controller(/:action(/:id(.:format)))'
+    end
+    @view.instance_variable_set(:@_routes, router)
+  end
+
+  should "generate order by link" do
+    @view.request = ActionController::TestRequest.new({"SCRIPT_NAME"=>"/tests",
+        "QUERY_STRING"=>"controller=tests&a=1&b=2"})
+    assert_match "order_by=foo+asc", @view.order_link(:foo)
+    assert_match ">Foo Bar<", @view.order_link(:foo_bar)
+    assert_match ">Custom Name<", @view.order_link(:foo, "Custom Name")
+    assert_match "class=\"bar\"", @view.order_link(:foo, "Name", :class=>:bar)
+
+    @view.request = ActionController::TestRequest.new({"SCRIPT_NAME"=>"/tests",
+        "QUERY_STRING"=>"controller=tests&order_by=foo+asc&a=1&b=2"})
+    assert_match "order_by=foo+desc", @view.order_link(:foo)
+    assert_match ">Foo &amp;#9650;<", @view.order_link(:foo)
+
+    @view.request = ActionController::TestRequest.new({"SCRIPT_NAME"=>"/tests",
+        "QUERY_STRING"=>"controller=tests&order_by=foo+desc&a=1&b=2"})
+    assert_match "order_by=foo+asc", @view.order_link(:foo)
+    assert_match ">Foo &amp;#9660;<", @view.order_link(:foo)
+    
+    @view.request = ActionController::TestRequest.new({"SCRIPT_NAME"=>"/tests",
+        "QUERY_STRING"=>"controller=tests&ss[order_by]=foo+desc&a=1&b=2"})
+    assert_match "ss%5Border_by%5D=foo+asc", @view.order_link(:foo)
+    assert_match ">Foo &amp;#9660;<", @view.order_link(:foo)
+  end
+  
+  should "generate page properties" do
+    @view.request = ActionController::TestRequest.new({"SCRIPT_NAME"=>"/tests",
+        "QUERY_STRING"=>"controller=tests&page_by=2"})
+    arel = Post.select('posts.*, comments.*').joins(:comments).simplesearch(:page_by=>2)
+
+    @view.page_properties(arel)
+    assert_equal ({ :total_rows => 6, :last_page => 3, :current_page => 1,
+				:rows_per_page => 2, :page_arr_key => nil }), @view.page_properties(arel)
+
+    @view.request = ActionController::TestRequest.new({"SCRIPT_NAME"=>"/tests",
+        "QUERY_STRING"=>"controller=tests&ss[page_by]=2"})
+    assert_equal ({ :total_rows => 6, :last_page => 3, :current_page => 1,
+				:rows_per_page => 2, :page_arr_key => "ss" }), @view.page_properties(arel)
+  end
+
+  should "generate url params for single page" do
+    @view.request = ActionController::TestRequest.new({"SCRIPT_NAME"=>"/tests",
+        "QUERY_STRING"=>"controller=tests&page_by=2"})
+    params = @view.page_params(3)
+    assert_equal 2, params[:page_by].to_i
+    assert_equal 3, params[:page]
+    
+    @view.request = ActionController::TestRequest.new({"SCRIPT_NAME"=>"/tests",
+        "QUERY_STRING"=>"controller=tests&ss[page_by]=2"})
+    params = @view.page_params(3, "ss")
+    assert_equal 2, params[:ss][:page_by].to_i
+    assert_equal 3, params[:ss][:page]
+  end
+
+  should "generate url params for many pages" do
+    arel = Post.select('posts.*, post_likes.*').joins(:post_likes).simplesearch(:page_by=>30)
+    @view.request = ActionController::TestRequest.new({"SCRIPT_NAME"=>"/tests",
+        "QUERY_STRING"=>"controller=tests&page=5&page_by=10"})
+    url_params = @view.page_url_params(arel)
+    assert_equal [1,3,4,5,6,7,30], url_params.keys
+    assert_equal 10, url_params[5][:page_by].to_i 
+    assert_equal 5, url_params[5][:page].to_i 
+
+    @view.request = ActionController::TestRequest.new({"SCRIPT_NAME"=>"/tests",
+        "QUERY_STRING"=>"controller=tests&ss[page_by]=2"})
+    url_params = @view.page_url_params(arel)
+    assert_equal 2, url_params[1][:ss][:page_by].to_i 
+    assert_equal 1, url_params[1][:ss][:page].to_i 
+  end
+
+  should "generate page urls" do
+    arel = Post.select('posts.*, post_likes.*').joins(:post_likes).simplesearch(:page_by=>30)
+    @view.request = ActionController::TestRequest.new({"SCRIPT_NAME"=>"/tests",
+        "QUERY_STRING"=>"controller=tests&page=5&page_by=10"})
+    page_urls = @view.page_urls(arel)
+    assert_equal 9, page_urls.length # 1 ... 3 4 5 6 7 ... 10
+    assert_equal "<span class='filler'>...</span>", page_urls[1]
+    assert_equal "<span class='filler'>...</span>", page_urls[7]
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: simple-search
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors: 
 - Allen Kim
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-10 00:00:00 Z
+date: 2012-03-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -132,10 +132,13 @@ files:
 - VERSION
 - lib/simple_search.rb
 - lib/simple_search/active_record.rb
+- lib/simple_search/exception.rb
+- lib/simple_search/view_helper.rb
 - simple-search.gemspec
 - test/helper.rb
 - test/tables_models.rb
-- test/test_simple_search.rb
+- test/test_active_record.rb
+- test/test_view_helper.rb
 homepage: http://github.com/bighostkim/simple-search
 licenses: 
 - MIT
@@ -149,7 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2459026480116491864
+      hash: -3264573546871737364
       segments: 
       - 0
       version: "0"