psql_autocomplete 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c00b62cae4be42b29cd6f279791b58bf724c6b31
+  data.tar.gz: 950a7a92233398a80bbed8f1d1ef82818830162b
+SHA512:
+  metadata.gz: aad2450706d4933ea4a9d68ce3ec33f221849c9ee45db216805de9295d8af186b8bf320a343c9b46cbe5cc7389789d2dacd9a7f4b70058fec9963157e5ea278c
+  data.tar.gz: e4c1b56ea0dc46170e2d178d783ec537189ff0f53bd6d1a141f71d52de9e893ceed4c7df7ffa28c38f75908f782fbc60efefd7528cdcc32a3b39ca3b4b5cf3bc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,52 @@
+# PsqlAutocomplete
+
+This gem introduces a mixin allowing you to run autocomplete queries with the PostgreSQL full text search
+
+It runs a prefix autocomplete on one or multiple fields of your model
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'psql_autocomplete'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install psql_autocomplete
+
+## Usage
+
+```
+# Query generation
+class Contact < ActiveRecord::Base
+  extend PsqlAutocomplete
+end
+
+# > Contact.autocomplete_query('John', [:first_name, :last_name])
+# => "to_tsvector('simple', coalesce(first_name,'') || ' ' || coalesce(last_name,'')) @@ to_tsquery('simple', 'John:*')"
+
+# Actual search
+class Contact < ActiveRecord::Base
+  extend PsqlAutocomplete
+
+  def self.autocomplete(query)
+    where(autocomplete_query(query, [:first_name, :last_name]))
+  end
+end
+
+# > Contact.autocomplete('Jules')
+# => [#<Contact:0x0x007fd2be761220>, #<Contact:0x007fd2be760938>, ...]
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "psql_autocomplete"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/psql_autocomplete.rb

@@ -0,0 +1,21 @@
+require 'psql_autocomplete/version'
+
+# Helper mixin for generating autocomplete queries
+# on the postgresql full text search engine
+module PsqlAutocomplete
+  # Returns a postgres FTS query injectable in a where clause
+  def autocomplete_query(sentence, fields)
+    "to_tsvector('simple', #{tsvector(fields)}) @@ #{tsquery(sentence)}"
+  end
+
+  private
+
+  def tsvector(fields)
+    fields.map { |field| "coalesce(#{field},'')" }.join(" || ' ' || ")
+  end
+
+  def tsquery(sentence)
+    words = sentence.split(' ').map(&:strip).compact.map { |q| "#{q}:*" }.join(' & ')
+    sanitize_sql_array ["to_tsquery('simple', ?)", words]
+  end
+end

data/lib/psql_autocomplete/version.rb

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

data/psql_autocomplete.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'psql_autocomplete/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "psql_autocomplete"
+  spec.version       = PsqlAutocomplete::VERSION
+  spec.authors       = ["JobTeaser"]
+  spec.email         = ["mru2@users.noreply.github.com"]
+
+  spec.summary       = %q{Allow the generation of autocomplete queries with postgres.}
+  spec.description   = %q{Allow the generation of autocomplete queries with postgres.}
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: psql_autocomplete
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JobTeaser
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Allow the generation of autocomplete queries with postgres.
+email:
+- mru2@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".psql_autocomplete.gemspec.swp"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/psql_autocomplete.rb
+- lib/psql_autocomplete/version.rb
+- psql_autocomplete.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: Allow the generation of autocomplete queries with postgres.
+test_files: []