postgres-fulltext-search-helper 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in postgres-fulltext-search-helper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Justin Fitzsimmons
+
+MIT License
+
+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,37 @@
+# PostgresFulltextSearchHelper
+
+This is just a quick helper gem for Nulogy's extremely naive full text search powered autocomplete. It abstracts away a lot of the flexibility of the postgres full text search API in favour of a very simple API that fulfills our simple needs.
+
+This gem can be used to sanitize user input for safe queries into postgres's tsquery language, and will generate somewhat predictable results. All characters that are meaningful to the tsquery language are simply filtered out and interpreted as a boolean '&', which we find to be effective enough for the purposes of autocomplete.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'postgres-fulltext-search-helper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install postgres-fulltext-search-helper
+
+## Usage
+
+```PostgresFulltextSearchHelper.format_query_for_fulltext("my query")``` will return a string that is suitable for insertion into a tsquery string for postgres.
+
+If you're using Active Record or another library that implements ```where``` on a scope in a similar manner to Active Record, you can pass the relevant scope, field name, and query into the ```search``` method, like this:
+
+```ruby
+filtered_scope = PostgresFulltextSearchHelper.search(scope, "name", "jus fit")
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/postgres-fulltext-search-helper/version.rb

@@ -0,0 +1,9 @@
+module Postgres
+  module Fulltext
+    module Search
+      module Helper
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/lib/postgres-fulltext-search-helper.rb

@@ -0,0 +1,16 @@
+require "postgres-fulltext-search-helper/version"
+
+module PostgresFulltextSearchHelper
+  extend self
+
+  POSTGRES_TSQUERY_SENSITIVE_CHARACTERS = /[|&!():\* ]/
+
+  def format_query_for_fulltext(query)
+    parts = query.split(POSTGRES_TSQUERY_SENSITIVE_CHARACTERS).delete_if{|x| x.strip.empty? }
+    return parts.map{|token| token + ':*'}.join(' & ')
+  end
+
+  def search(scope, field_name, query)
+    return scope.where("to_tsvector('simple', #{field_name}::text) @@ to_tsquery('simple', ?)", [format_query_for_fulltext(query)])
+  end
+end

data/postgres-fulltext-search-helper.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'postgres-fulltext-search-helper/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "postgres-fulltext-search-helper"
+  gem.version       = Postgres::Fulltext::Search::Helper::VERSION
+  gem.authors       = ["Justin Fitzsimmons", "Arturo Pie"]
+  gem.email         = ["justinf@nulogy.com", "arturop@nulogy.com"]
+  gem.description   = %q{Use postgres' fulltext search with ease}
+  gem.summary       = ""
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+end

data/spec/postgres-fulltext-search-helper_spec.rb

@@ -0,0 +1,30 @@
+require_relative "../lib/postgres-fulltext-search-helper"
+
+Helper = PostgresFulltextSearchHelper
+
+describe PostgresFulltextSearchHelper do
+  it "returns a string that can be used by postgres" do
+    query = "hello"
+
+    expect(Helper.format_query_for_fulltext(query)).to eq("hello:*")
+  end
+
+  it "whitespace is interpreted as &" do
+    query = "hello world"
+
+    expect(Helper.format_query_for_fulltext(query)).to eq("hello:* & world:*")
+  end
+
+  it "handles sensitive characters" do
+    query = "*:hello &(world)!|"
+    expect(Helper.format_query_for_fulltext(query)).to eq("hello:* & world:*")
+  end
+
+  it "adds a filter to a activerecord-style scope" do
+    scope = stub("scope").as_null_object
+
+    scope.should_receive(:where).with("to_tsvector('simple', name::text) @@ to_tsquery('simple', ?)", ["hello:* & world:*"])
+
+    Helper.search(scope, "name", "hello world")
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: postgres-fulltext-search-helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Justin Fitzsimmons
+- Arturo Pie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-27 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'
+description: Use postgres' fulltext search with ease
+email:
+- justinf@nulogy.com
+- arturop@nulogy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/postgres-fulltext-search-helper.rb
+- lib/postgres-fulltext-search-helper/version.rb
+- postgres-fulltext-search-helper.gemspec
+- spec/postgres-fulltext-search-helper_spec.rb
+homepage: ''
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/postgres-fulltext-search-helper_spec.rb