make_it_searchable 0.0.7.pre

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in make_it_searchable.gemspec
+gemspec

data/README.md

@@ -0,0 +1,20 @@
+# Make It Searchable
+
+간단한 칼럼 filtering, sorting 기능, 아직 마무리 안됨.
+
+
+### Filtering
+```ruby
+  ActiveRecordModel.custom_filter({:column_name => "query_string", :another_column => 'another_query_string'})
+```
+### Sorting
+```ruby
+  ActiveRecordModel.custom_order("#{column_name}_asc")
+  ActiveRecordModel.custom_order("#{column_name}_desc")
+```
+
+### Filtering and Sorting
+```ruby
+  ActiveRecordModel.custom_query({:column_name => "query_string"}, "#{column_name}_desc")
+```
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/make_it_searchable.rb

@@ -0,0 +1,26 @@
+require "active_support"
+require "make_it_searchable/version"
+require "make_it_searchable/class_methods"
+require "make_it_searchable/generate_query"
+
+require "make_it_searchable/validator"
+require 'make_it_searchable/view_helper' 
+
+require "make_it_searchable/railtie" if defined? Rails
+
+module MakeItSearchable
+  def self._extract_column_name_and_query_option(column_and_option)
+    reg = /\A(?<column>(.+))-(?<query_option>(eq|gt|lt|gte|lte|asc|desc))\Z/
+    md = reg.match(column_and_option.to_s)
+  
+    if md
+      column, query_option = md[:column], md[:query_option]
+    else
+      column, query_option = column_and_option, nil
+    end
+  
+    [column, query_option]
+  end
+end
+
+

data/lib/make_it_searchable/class_methods.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module MakeItSearchable::ClassMethods
+  
+  def make_it_search(sort_option, filter_option)
+    make_it_sort(sort_option).make_it_filter(filter_option)
+  end
+  
+  def make_it_filter(options = nil)
+    custom_scope = scoped
+    if options.present?
+      options.each { |key, value| custom_scope = custom_scope._generate_query(key, value) }
+      custom_scope
+    end
+    custom_scope
+  end
+  
+  def make_it_sort(name_and_option, default_order = "created_at DESC")
+    if _valid_sort_option?(name_and_option)
+      column_name, direction = MakeItSearchable._extract_column_name_and_query_option(name_and_option)
+      # direction = "_" if direction.nil?
+      order("#{column_name} #{direction}")
+    else
+      send(:order, default_order)
+    end
+  end
+end

data/lib/make_it_searchable/generate_query.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+module MakeItSearchable::GenerateQuery
+
+  def _generate_query(column_and_option, value)
+    return self.scoped unless value.present?
+    return self.scoped unless _valid_filter_option?(column_and_option)
+
+    column, query_option = MakeItSearchable._extract_column_name_and_query_option(column_and_option)
+
+    custom_scope = self.scoped
+    custom_scope = _add_inner_join(custom_scope, column)
+
+    data_type = self.columns.select {|col| col.name == column.to_s}.first.type rescue nil
+    if data_type == :datetime or data_type == :date
+      value = Time.zone.parse(value)
+      if query_option == "lt" || query_option == 'lte'
+        value = value.end_of_day
+      end
+      value
+    end
+
+    case query_option
+    when 'eq'
+      if value == 'nil'
+        custom_scope = custom_scope.where( column => nil)
+      elsif value == 'true' or value == 'false'
+        custom_scope = custom_scope.where( column => (value == 'true') )
+      else
+        custom_scope = custom_scope.where(column => value)
+      end
+    when 'gt'
+      custom_scope = custom_scope.where("#{column} > ?", value)
+    when 'lt'
+      custom_scope = custom_scope.where("#{column} < ?", value)
+    when 'gte'
+      custom_scope = custom_scope.where("#{column} >= ?", value)
+    when 'lte'
+      custom_scope = custom_scope.where("#{column} <= ?", value)
+    else
+      if value.to_s.match(/([\u3131-\u318E]|[\uAC00-\uD7A3])/) # if Korean
+        custom_scope = custom_scope.where("replace(#{column}, ' ', '') LIKE ?", "%#{value.to_s.gsub(/\s/, '')}%")
+      else
+        custom_scope = custom_scope.where("#{column} LIKE ?", "%#{value}%")
+      end
+    end
+
+    custom_scope
+  end
+
+  def _add_inner_join(custom_scope, column)
+    if column.to_s.include?(".")
+      join_table_name = column.split(".").first
+      associations_name = custom_scope.klass.reflect_on_all_associations.map(&:name)
+
+      if associations_name.include?(join_table_name.to_sym)
+        custom_scope.joins(join_table_name.to_sym)
+      else
+        custom_scope.joins(join_table_name.singularize.to_sym)
+      end
+
+    else
+      custom_scope
+    end
+  end
+end

data/lib/make_it_searchable/railtie.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module MakeItSearchable
+  class Railtie < Rails::Railtie
+
+    initializer 'make_it_searchable' do
+      ActiveSupport.on_load :active_record do
+        extend ClassMethods
+        extend Validator
+        extend GenerateQuery
+      end
+    end
+    
+    initializer 'make_it_searchable.view_helper' do
+      ActionView::Base.send :include, ViewHelper
+    end
+    
+  end
+end

data/lib/make_it_searchable/validator.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module MakeItSearchable::Validator
+  def _valid_sort_option?(name_and_option)
+    if name_and_option.present?
+      column_name, direction = MakeItSearchable._extract_column_name_and_query_option(name_and_option)
+      ["asc", "desc", nil].include?(direction) && column_names.include?(column_name.to_s)
+    else
+      false
+    end
+  end
+  
+  def _valid_filter_option?(name_and_option)
+    if name_and_option.present?
+      column_name, option = MakeItSearchable._extract_column_name_and_query_option(name_and_option)
+      column_names.include?(column_name.to_s) or column_name.to_s.include?(".")
+    else
+      false
+    end
+  end
+end
+

data/lib/make_it_searchable/version.rb

@@ -0,0 +1,3 @@
+module MakeItSearchable
+  VERSION = "0.0.7.pre"
+end

data/lib/make_it_searchable/view_helper.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module MakeItSearchable::ViewHelper
+  def get_direction(column_name, a_string)
+    reg = /\A(?<column_name>(.+))-(?<direction>(asc|desc))\Z/
+    md = reg.match(a_string)
+    
+    if md && md[:column_name] == column_name && md[:direction]
+      md[:direction]
+    end
+  end
+  
+  def toggle_direction(a_string)
+    reg = /-(?<direction>(asc|desc))\Z/
+    md = reg.match(a_string)
+    
+    if md && md[:direction] == "asc"
+      a_string.sub(reg, "-desc")
+    elsif md && md[:direction] == "desc"
+      a_string.sub(reg, "-asc")
+    else
+      a_string
+    end
+  end
+end

data/make_it_searchable.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "make_it_searchable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "make_it_searchable"
+  s.version     = MakeItSearchable::VERSION
+  s.authors     = ["KunHa"]
+  s.email       = ["potato9@gmail.com"]
+  s.homepage    = "https://github.com/bayja/make_it_searchable"
+  s.summary     = %q{simple column filtering and sorting}
+  s.description = %q{simple column filtering and sorting.}
+
+  s.rubyforge_project = "make_it_searchable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "activerecord"
+  s.add_development_dependency "guard"
+end

data/spec/make_it_searchable/class_methods_spec.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+require 'spec_helper'
+
+class LectureReview < ActiveRecord::Base
+  extend MakeItSearchable::ClassMethods
+end
+
+describe MakeItSearchable::ClassMethods do
+  context "filtering and sorting" do
+    before :each do
+      LectureReview.destroy_all
+      @review_01 = LectureReview.create(:lecture_id => 3, :region_id => 2, :title => '이것은 제목입니다.', :body => "질럿이 짱 먹는다 1")
+      @review_02 = LectureReview.create(:lecture_id => 2, :region_id => 1, :title => '두번째 제목입니다. 정말로', :body => "뮤탈리스크 2")
+      @review_03 = LectureReview.create(:lecture_id => 1, :region_id => 3, :title => '세번째 제목입니다. 정말로', :body => "우리집 강아지 이름은 가루. 밀가루의 가루. 가루가 짱먹는다 3")
+    end
+    
+    it 'should search title' do
+      LectureReview.make_it_filter('lecture_id-eq' => '2').should == [@review_02]
+      LectureReview.make_it_filter('region_id-eq' => '3').should == [@review_03]
+      
+      
+      LectureReview.make_it_filter(:title => '제목').count.should == 3
+      LectureReview.make_it_filter(:title => '정말로').count.should == 2
+    end
+    
+    it 'should search with multiple search options' do
+      @review_03_1 = LectureReview.create(:lecture_id => 1, :region_id => 3, :title => '새로운 리뷰', :body => "3-1")
+      @review_03_2 = LectureReview.create(:lecture_id => 1, :region_id => 9, :title => '새로운 리뷰2', :body => "3-2")
+      
+      LectureReview.make_it_filter('region_id-eq' => '3').count.should == 2
+      LectureReview.make_it_filter('region_id-eq' => '3', 'title' => '새로운').count.should == 1
+    end
+    
+    it 'should ignoring white space when searching korean' do
+      LectureReview.make_it_filter(:title => '번째제목').count.should == 2
+    end
+    
+    it 'should search title and body' do
+      LectureReview.make_it_filter(:title => '정말로', :body => '뮤탈리스크').count.should == 1
+      LectureReview.make_it_filter(:title => '제목', :body => '짱먹는다').count.should == 2
+    end
+  
+    it 'should sort by region_id' do
+      LectureReview.make_it_sort("region_id-asc").should == [@review_02, @review_01, @review_03]
+      LectureReview.make_it_sort("region_id-desc").should == [@review_03, @review_01, @review_02]
+      LectureReview.make_it_sort("lecture_id-asc").should == [@review_03, @review_02, @review_01]
+    end
+    
+    it 'should sort to asc if no direction is provided' do
+      LectureReview.make_it_sort("region_id").should == [@review_02, @review_01, @review_03]
+    end
+  end
+  
+end

data/spec/make_it_searchable/generate_query_spec.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+require 'spec_helper'
+
+class LectureReview < ActiveRecord::Base
+  extend MakeItSearchable::GenerateQuery
+  extend MakeItSearchable::Validator
+  belongs_to :lecture
+end
+
+class Lecture < ActiveRecord::Base
+  extend MakeItSearchable::GenerateQuery
+  extend MakeItSearchable::Validator
+  has_many :lecture_reviews
+end
+
+describe MakeItSearchable::GenerateQuery do
+
+  context 'translate query option' do
+    it 'should generate filter query' do
+      LectureReview._generate_query("lecture_id-eq", 2).to_sql.should == (
+        LectureReview.where(:lecture_id => 2).to_sql
+      )
+      LectureReview._generate_query("lecture_id-gte", 2).to_sql.should == (
+        LectureReview.where("lecture_id >= ?", "2").to_sql
+      )
+      LectureReview._generate_query("region_id-lt", 10).to_sql.should == (
+        LectureReview.where("region_id < ?", "10").to_sql
+      )
+      LectureReview._generate_query("title", '보리 출판사').to_sql.should == (
+        LectureReview.where("replace(title, ' ', '') LIKE ?", "%보리출판사%").to_sql
+      )
+      LectureReview._generate_query("title", 'English').to_sql.should == (
+        LectureReview.where("title LIKE ?", "%English%").to_sql
+      )
+      LectureReview._generate_query("won-eq", 'true').to_sql.should == (
+        LectureReview.where(:won => true).to_sql
+      )
+      LectureReview._generate_query("won-eq", 'false').to_sql.should == (
+        LectureReview.where(:won => false).to_sql
+      )
+      LectureReview._generate_query("region_id-eq", 'nil').to_sql.should == (
+        LectureReview.where(:region_id => nil).to_sql
+      )
+      LectureReview._generate_query("created_at-gt", '2011-1-1').to_sql.should == (
+        # LectureReview.where("created_at > ?", Time.zone.parse('2011-1-1')).to_sql
+      )      
+    end
+
+    it 'should fall back to default scope when invalid filter option provied' do
+      LectureReview._generate_query("wrong_column_name", 2).to_sql.should == (
+        LectureReview.scoped.to_sql
+      )
+    end
+
+    it 'should fall back to default scope when no value has provided' do
+      LectureReview._generate_query("title", '').to_sql.should == (
+        LectureReview.scoped.to_sql
+      )
+    end
+  end
+  
+  context 'translate join query options' do
+    it 'should generate join filter query' do
+      LectureReview._generate_query("lectures.title-eq", 2).to_sql.should == (
+        LectureReview.joins(:lecture).where("lectures.title" => 2).to_sql
+      )
+    end
+  end
+
+  context 'add inner join' do
+    it 'should add inner join query with sigular association name' do
+      LectureReview._add_inner_join(LectureReview.scoped, 'lectures.title').to_sql.should == (
+        LectureReview.scoped.joins(:lecture).to_sql
+      )
+    end
+
+    it 'should add inner join query with plural association name' do
+      Lecture._add_inner_join(Lecture.scoped, 'lecture_reviews.title').to_sql.should == (
+        Lecture.scoped.joins(:lecture_reviews).to_sql
+      )
+    end
+  end
+  
+end
+
+
+

data/spec/make_it_searchable/validator_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require 'spec_helper'
+
+class LectureReview < ActiveRecord::Base
+  extend MakeItSearchable::Validator
+end
+
+describe MakeItSearchable::Validator do
+  it 'should validate sort option' do
+    LectureReview._valid_sort_option?("region_id-asc").should be_true
+    LectureReview._valid_sort_option?("lecture_id-desc").should be_true
+    LectureReview._valid_sort_option?("lecture_id-aeae").should be_false
+    LectureReview._valid_sort_option?("wrong_column_name-asc").should be_false
+
+    LectureReview._valid_sort_option?("region_id").should be_true # rails default
+  end
+  
+  it 'should validate filter option' do
+    LectureReview._valid_filter_option?("lecture_id-eq").should be_true
+    LectureReview._valid_filter_option?("lecture_id-gt").should be_true
+    LectureReview._valid_filter_option?("lecture_id").should be_true
+    
+    LectureReview._valid_filter_option?("wrong_column_name").should be_false
+  end
+end

data/spec/make_it_searchable/view_helper_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+class Object
+  include MakeItSearchable::ViewHelper
+end
+
+describe MakeItSearchable::ViewHelper do
+  before :each do
+    @view = Object.new
+  end
+  
+  it 'should toggle direction' do
+    @view.toggle_direction('column_name-asc').should == "column_name-desc"
+    @view.toggle_direction('asc_asc-asc').should == "asc_asc-desc"
+    @view.toggle_direction('column_name-desc').should == "column_name-asc"
+  end
+  
+  it "should do nothing to the string" do
+    @view.toggle_direction('column_name').should == "column_name"
+  end
+  
+  it 'should extract direction if column_name matches' do
+    @view.get_direction("column_name", "column_name-asc").should == "asc"
+    @view.get_direction("diffrent_column", "column_name-asc").should == nil
+  end
+end

data/spec/make_it_searchable_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe MakeItSearchable do
+  it 'should extract column name and option from a string' do
+    MakeItSearchable._extract_column_name_and_query_option("region_id-gt").should == ['region_id', 'gt']
+    MakeItSearchable._extract_column_name_and_query_option("region_id-eq").should == ['region_id', 'eq']
+    MakeItSearchable._extract_column_name_and_query_option("my_column_name-asc").should == ['my_column_name', 'asc']
+    MakeItSearchable._extract_column_name_and_query_option("my_column_name").should == ['my_column_name', nil]
+  end
+  
+  it 'should extract join table options too' do
+    MakeItSearchable._extract_column_name_and_query_option("lectures.name-eq").should == ['lectures.name', 'eq']
+    MakeItSearchable._extract_column_name_and_query_option("lectures.name").should == ['lectures.name', nil]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'make_it_searchable'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3", 
+  :database => "make_it_searchable.sqlite3"
+)
+
+class CreateTestData < ActiveRecord::Migration
+  def self.up
+    create_table :lecture_reviews do |t|
+      t.integer :lecture_id
+      t.integer :region_id
+      t.string :title
+      t.string :body
+      t.boolean :won
+      t.boolean :best_review     
+      
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+    
+    create_table :lectures do |t|
+      t.string :title
+      t.text  :body
+    end
+  end
+end
+
+# CreateTestData.up

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: make_it_searchable
+version: !ruby/object:Gem::Version
+  version: 0.0.7.pre
+  prerelease: 6
+platform: ruby
+authors:
+- KunHa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: simple column filtering and sorting.
+email:
+- potato9@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/make_it_searchable.rb
+- lib/make_it_searchable/class_methods.rb
+- lib/make_it_searchable/generate_query.rb
+- lib/make_it_searchable/railtie.rb
+- lib/make_it_searchable/validator.rb
+- lib/make_it_searchable/version.rb
+- lib/make_it_searchable/view_helper.rb
+- make_it_searchable.gemspec
+- make_it_searchable.sqlite3
+- spec/make_it_searchable/class_methods_spec.rb
+- spec/make_it_searchable/generate_query_spec.rb
+- spec/make_it_searchable/validator_spec.rb
+- spec/make_it_searchable/view_helper_spec.rb
+- spec/make_it_searchable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bayja/make_it_searchable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: make_it_searchable
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: simple column filtering and sorting
+test_files:
+- spec/make_it_searchable/class_methods_spec.rb
+- spec/make_it_searchable/generate_query_spec.rb
+- spec/make_it_searchable/validator_spec.rb
+- spec/make_it_searchable/view_helper_spec.rb
+- spec/make_it_searchable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: