pg_search_scope 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+.idea

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Ivan Efremov, Ilia Ablamonov, Cloud Castle Inc.
+
+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.md

@@ -0,0 +1,56 @@
+### PG Search Scope
+
+PostgreSQL full text search using Rails 3 scopes
+
+## Basic usage
+
+Include `gem pg_search_scope` in your `Gemfile`
+
+In model, use `search_scope_for` class method to create full text search scope.
+
+Examples:
+
+    search_scope_for :name
+    -->
+    search_by_name("Ivan")
+
+
+In migration, use `add_fulltext_index` / `remove_fulltext_index` the same way as `add_index` / `remove_index`
+
+## Advanced usage
+
+You can set additional search options:
+
+    :as - Scope name
+
+    :normalization - Controls rank behaviour, see http://www.postgresql.org/docs/9.0/static/textsearch-controls.html#TEXTSEARCH-RANKING
+
+    :wildcard - Controls search words modification:
+                     true - add :* to ends of each search word
+                     false - do not modify search words
+                     :last - add :* to end of last word
+
+    :operator - Boolean operator (:and or :or) which combines search query
+
+    :select_rank - Include rank in select statement, as {scope_name}_rank
+
+    :language - Search language, e.g. 'simple' (without magic), 'english'
+
+If you use `:language` option, you need to use the same option for `add_fulltext_index`
+
+Examples:
+
+    search_scope_for :name, :address,
+                     :wildcard => :last
+    -->
+    search_by_name_and_address("Ivan, Aurora st.", :select_rank => true)
+
+
+## To do
+
+...
+
+## Copyright
+
+Copyright (c) 2011 Ivan Efremov, Ilia Ablamonov, Cloud Castle Inc.
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/pg_search_scope/migration_helper.rb

@@ -0,0 +1,22 @@
+module PgSearchScope
+  module MigrationHelper
+    def add_fulltext_index table_name, column_name, options = {}
+      options[:language] ||= PgSearchScope::ModelHelper::DEFAULT_OPTIONS[:language]
+      column_names = Array.wrap(column_name)
+      index_name = options[:name].presence || index_name(table_name, :column => column_names) + '_ftx'
+      execute(<<-"eosql".strip)
+      CREATE INDEX #{index_name} ON #{table_name}
+      USING GIN(TO_TSVECTOR('#{options[:language]}', #{column_names.map { |name| "COALESCE(\"#{table_name}\".\"#{name}\", '')" }.join(" || ' ' || ")}))
+      eosql
+    end
+
+    def remove_fulltext_index table_name, options = {}
+      index_name = index_name(table_name, options) + '_ftx'
+      execute(<<-"eosql".strip)
+      DROP INDEX IF EXISTS #{index_name}
+      eosql
+    end
+  end
+end
+
+ActiveRecord::Migration.send :extend, PgSearchScope::MigrationHelper

data/lib/pg_search_scope/model_helper.rb

@@ -0,0 +1,90 @@
+module PgSearchScope
+  module ModelHelper
+    DEFAULT_OPTIONS = {
+        :as => nil,
+        :wildcard => true,
+        :operator => :and,
+        :normalization => 0,
+        :select_rank => false,
+        :language => 'simple'
+    }
+    OPERATORS = {
+        :and => '&',
+        :or => '|'
+    }
+
+      # Creates fulltext search scope
+      #
+      # == Options
+      #
+      # * <tt>:as</tt> - Scope name
+      #
+      # * <tt>:normalization</tt> - Controls rank behaviour, see http://www.postgresql.org/docs/9.0/static/textsearch-controls.html#TEXTSEARCH-RANKING
+      #
+      # * <tt>:wildcard</tt> - Controls search words modification:
+      #                        true - add :* to ends of each search word
+      #                        false - do not modify search words
+      #                        :last - add :* to end of last word
+      #
+      # * <tt>:operator</tt> - Boolean operator (:and or :or) which combines search query
+      #
+      # * <tt>:select_rank</tt> - Include rank in select statement, as {scope_name}_rank
+      #
+      # * <tt>:language</tt> - Search language, e.g. 'simple' (without magic), 'english'
+      #
+      # == Usage
+      #
+      #   search_scope_for :name
+      #   -->
+      #   search_by_name("Ivan")
+      #
+      #   search_scope_for :name, :address,
+      #                    :wildcard => :last
+      #   -->
+      #   search_by_name_and_address("Ivan, Aurora st.", :select_rank => true)
+      #
+    def search_scope_for *column_names
+      scope_options = DEFAULT_OPTIONS.merge column_names.extract_options!
+
+      scope_name = scope_options[:as] || "search_by_#{column_names.join('_and_')}"
+
+      scope scope_name, Proc.new { |search_string, options|
+        options = scope_options.merge(options || {})
+        search_string ||= ''
+
+        terms = search_string.strip.split(/[^\w\d\.']+/).map { |s| s.gsub /'/, "''" }
+
+        if terms.present?
+          prefix = arel_table.table_alias || arel_table.name
+          document = column_names.map { |n| "coalesce(#{prefix}.#{n}, '')" }.join(" || ' ' || ")
+
+          case options[:wildcard]
+            when true then
+              terms.map! { |s| "#{s}:*" }
+            when :last then
+              terms[-1] = "#{terms[-1]}:*"
+          end
+
+          tsvector = "to_tsvector('#{options[:language]}', #{document})"
+          tsquery = "to_tsquery('#{options[:language]}', '#{terms.join(" #{OPERATORS[options[:operator]]} ")}')"
+
+          rank = "ts_rank(#{tsvector}, #{tsquery}, #{options[:normalization]})"
+
+          search_scope = scoped
+
+          if options[:select_rank]
+            search_scope = search_scope.select("#{rank} #{scope_name}_rank")
+          end
+
+          search_scope.where("#{tsvector} @@ #{tsquery}").order("#{rank} DESC")
+        else
+          if options[:select_rank]
+            scoped.select("0 #{scope_name}_rank")
+          end
+        end
+      }
+    end
+  end
+end
+
+ActiveRecord::Base.send :extend, PgSearchScope::ModelHelper

data/lib/pg_search_scope/version.rb

@@ -0,0 +1,3 @@
+module PgSearchScope
+  VERSION = "0.1.0"
+end

data/lib/pg_search_scope.rb

@@ -0,0 +1,6 @@
+require 'pg_search_scope/version'
+require 'pg_search_scope/model_helper'
+require 'pg_search_scope/migration_helper'
+
+module PgSearchScope
+end

data/pg_search_scope.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pg_search_scope/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pg_search_scope"
+  s.version     = PgSearchScope::VERSION
+  s.authors     = ["Ivan Efremov, Ilia Ablamonov, Cloud Castle Inc."]
+  s.email       = ["ilia@flamefork.ru", "st8998@gmail.com"]
+  s.homepage    = "https://github.com/cloudcastle/pg_search_scope"
+  s.summary     = %q{PostgreSQL full text search using Rails 3 scopes}
+  s.description = %q{}
+
+  s.rubyforge_project = "pg_search_scope"
+
+  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"]
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: pg_search_scope
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ivan Efremov, Ilia Ablamonov, Cloud Castle Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-11 00:00:00.000000000 +04:00
+default_executable: 
+dependencies: []
+description: ''
+email:
+- ilia@flamefork.ru
+- st8998@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pg_search_scope.rb
+- lib/pg_search_scope/migration_helper.rb
+- lib/pg_search_scope/model_helper.rb
+- lib/pg_search_scope/version.rb
+- pg_search_scope.gemspec
+has_rdoc: true
+homepage: https://github.com/cloudcastle/pg_search_scope
+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: '0'
+requirements: []
+rubyforge_project: pg_search_scope
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: PostgreSQL full text search using Rails 3 scopes
+test_files: []