pg_search 1.0.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55ed2cdc0eaecdb0dcb05ee5fcf7e7460556669d
-  data.tar.gz: 8ff17add1a0a7c7a16dd6501b6335e5d364b07b4
+  metadata.gz: a541ca99e3c5e843e83463598bcde7b5feb486c3
+  data.tar.gz: 1160f97900fbe7db8d4d0a1b1198340a3c0ccc99
 SHA512:
-  metadata.gz: 1acf5bc208de87a781c1c2ddaa3b44b33609afb8927cd8bbbb256a9a9caf099f3c2507232a0d9f2a9ad45acaf997e3590bbcbac6d3cb4936515e6874c3cb4ea1
-  data.tar.gz: d569da3e3f8aa7b205596fbce5d1bd72e0db4dab9576ac9331b810b4dbcefd80f77918a8ce51cfb3e944f63520f4166e86bd5db883b01c0e2b8f97e3bff7018d
+  metadata.gz: a874920bde65876f83b3a7522bdc2ff0e11debc4852d9cebd186cb791c5ed3b6400dd0c891b7cd4cf3970251c06af4543cfe9e68503a423585e81247b6938857
+  data.tar.gz: d332008d1cc19b96004451112d9d7923d2af4a6fe1af6d5cfbd4535e1b8d1a80d9d20b3c977d2f409572ade279c17b4ae8697a9abc3ecc6e9738cdf87f433ae2

data/.codeclimate.yml

@@ -1,2 +1,16 @@
-languages:
-  Ruby: true
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+        - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+    - "**.rb"
+exclude_paths:
+  - "spec/"

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
+.idea/
 .rbx
 .yardoc
 /bin/

data/.rubocop.yml

@@ -23,7 +23,25 @@ Style/AlignParameters:
 Style/HashSyntax:
   Enabled: false
 
+Style/NumericPredicate:
+  Enabled: false
+
 Style/PercentLiteralDelimiters:
   PreferredDelimiters:
     '%w': '[]'
     '%W': '[]'
+
+Style/GuardClause:
+  Enabled: false
+
+Style/VariableNumber:
+  EnforcedStyle: snake_case
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Bundler/DuplicatedGem:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded

data/.travis.yml

@@ -2,42 +2,36 @@ language: ruby
 sudo: false
 
 rvm:
-  - "2.3.1"
-  - "2.2"
-  - "2.1"
-  - "2.0"
-  - "1.9"
-  - jruby-19mode
-  - jruby-9.0.0.0
+  - "2.3.3"
+  - "2.2.6"
+  - "2.1.10"
+  - jruby-9.1.6.0
 
 env:
   - ACTIVE_RECORD_BRANCH="master"
+  - ACTIVE_RECORD_BRANCH="5-0-stable"
   - ACTIVE_RECORD_BRANCH="4-2-stable"
-  - ACTIVE_RECORD_BRANCH="4-1-stable"
-  - ACTIVE_RECORD_BRANCH="4-0-stable"
+  - ACTIVE_RECORD_VERSION="~> 5.0.0"
   - ACTIVE_RECORD_VERSION="~> 4.2.0"
-  - ACTIVE_RECORD_VERSION="~> 4.1.0"
-  - ACTIVE_RECORD_VERSION="~> 4.0.0"
-  - ACTIVE_RECORD_VERSION="~> 3.2.0"
-  - ACTIVE_RECORD_VERSION="~> 3.1.0"
 
 matrix:
   allow_failures:
     - env: ACTIVE_RECORD_BRANCH="master"
+    - env: ACTIVE_RECORD_BRANCH="5-0-stable"
     - env: ACTIVE_RECORD_BRANCH="4-2-stable"
-    - env: ACTIVE_RECORD_BRANCH="4-1-stable"
-    - env: ACTIVE_RECORD_BRANCH="4-0-stable"
   exclude:
-    - rvm: "1.9"
+    - rvm: "2.1.10"
       env: ACTIVE_RECORD_BRANCH="master"
-    - rvm: "2.0"
-      env: ACTIVE_RECORD_BRANCH="master"
-    - rvm: "2.1"
-      env: ACTIVE_RECORD_BRANCH="master"
-    - rvm: jruby-19mode
-      env: ACTIVE_RECORD_BRANCH="master"
-    - rvm: jruby-9.0.0.0
+    - rvm: "2.1.10"
+      env: ACTIVE_RECORD_BRANCH="5-0-stable"
+    - rvm: "2.1.10"
+      env: ACTIVE_RECORD_VERSION="~> 5.0.0"
+    - rvm: jruby-9.1.6.0
       env: ACTIVE_RECORD_BRANCH="master"
+    - rvm: jruby-9.1.6.0
+      env: ACTIVE_RECORD_BRANCH="5-0-stable"
+    - rvm: jruby-9.1.6.0
+      env: ACTIVE_RECORD_VERSION="~> 5.0.0"
 
 before_script:
   - "psql -c 'create database pg_search_test;' -U postgres >/dev/null"

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # pg_search changelog
 
+## 2.0.0
+*   Drop support for PostgreSQL < 9.2. 
+*   Drop support for Active Record < 4.2.
+*   Drop support for Ruby < 2.2.
+*   Improve performance of has_one and belongs_to associations. (Peter Postma)
+
 ## 1.0.6
+
 *   Add support for highlighting the matching portion of a search result. (Jose Galisteo)
 *   Add `:update_if` option to control when PgSearch::Document gets updated. (Adam Becker)
 *   Add `:additional_attributes` option for adding additional attributes to PgSearch::Document

data/Gemfile

@@ -11,7 +11,3 @@ if ENV['ACTIVE_RECORD_BRANCH']
 end
 
 gem 'activerecord', ENV['ACTIVE_RECORD_VERSION'] if ENV['ACTIVE_RECORD_VERSION']
-
-group :test do
-  gem "codeclimate-test-reporter", require: nil
-end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010–2015 Case Commons, LLC
+Copyright (c) 2010-2016 Case Commons, Inc. <http://casecommons.org>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -18,54 +18,24 @@ Read the blog post introducing PgSearch at http://blog.pivotal.io/labs/labs/pg-s
 
 ## REQUIREMENTS
 
-*   Ruby 1.9.2, 2.0, or later
-*   Active Record 3.1, 3.2, 4.0 or later
-*   PostgreSQL
-*   [PostgreSQL contrib packages for certain
-    features](https://github.com/Casecommons/pg_search/wiki/Installing-Postgres-Contrib-Modules)
-
+*   Ruby 2.1+
+*   ActiveRecord 4.2+
+*   PostgreSQL 9.2+
+*   [PostgreSQL extensions](https://github.com/Casecommons/pg_search/wiki/Installing-PostgreSQL-Extensions) for certain features
 
 ## INSTALL
 
-```bash
+```
 $ gem install pg_search
 ```
 
-### Rails 3.1, 3.2, 4.0 or later, Ruby 1.9.2, 2.0, or later
-
-In Gemfile
+or add this line to your Gemfile:
 
 ```ruby
 gem 'pg_search'
 ```
 
-### Rails 3.0
-
-The newest versions of PgSearch no longer support Rails 3.0. However, the 0.5
-series still works. It's not actively maintained, but submissions are welcome
-for backports and bugfixes.
-
-```ruby
-gem 'pg_search', "~> 0.5.7"
-```
-
-The 0.5 branch lives at
-https://github.com/Casecommons/pg_search/tree/0.5-stable
-
-### Rails 2
-
-The newest versions of PgSearch no longer support Rails 2. However, the 0.2
-series still works. It's not actively maintained, but submissions are welcome
-for backports and bugfixes.
-
-```ruby
-gem 'pg_search', "~> 0.2.0"
-```
-
-The 0.2 branch lives at
-https://github.com/Casecommons/pg_search/tree/0.2-stable
-
-### Other Active Record projects
+### Non-Rails projects
 
 In addition to installing and requiring the gem, you may want to include the
 PgSearch rake tasks in your Rakefile. This isn't necessary for Rails projects,
@@ -75,19 +45,6 @@ which gain the Rake tasks via a Railtie.
 load "pg_search/tasks.rb"
 ```
 
-### Ruby 1.8.7 or earlier
-
-The newest versions of PgSearch no longer support Ruby 1.8.7. However, the 0.6
-series still works. It's not actively maintained, but submissions are welcome
-for backports and bugfixes.
-
-```ruby
-gem 'pg_search', "~> 0.6.4"
-```
-
-The 0.6 branch lives at
-https://github.com/Casecommons/pg_search/tree/0.6-stable
-
 ## USAGE
 
 To add PgSearch to an Active Record model, simply include the PgSearch module.
@@ -287,7 +244,17 @@ To regenerate the documents for a given class, run:
 PgSearch::Multisearch.rebuild(Product)
 ```
 
-This is also available as a Rake task, for convenience.
+The ```rebuild``` method will delete all the documents for the given class
+before regenerating them. In some situations this may not be desirable,
+such as when you're using single-table inheritance and ```searchable_type```
+is your base class. You can prevent ```rebuild``` from deleting your records
+like so:
+
+```ruby
+PgSearch::Multisearch.rebuild(Product, false)
+```
+
+Rebuild is also available as a Rake task, for convenience.
 
     $ rake pg_search:multisearch:rebuild[BlogPost]
 
@@ -439,15 +406,6 @@ It is possible to search columns on associated models. Note that if you do
 this, it will be impossible to speed up searches with database indexes.
 However, it is supported as a quick way to try out cross-model searching.
 
-In PostgreSQL 8.3 and earlier, you must install a utility function into your
-database. To generate and run a migration for this, run:
-
-    $ rails g pg_search:migration:associated_against
-    $ rake db:migrate
-
-This migration is safe to run against newer versions of PostgreSQL as well. It
-will essentially do nothing.
-
 You can pass a Hash into the :associated_against option to set up searching
 through associations. The keys are the names of the associations and the value
 works just like an :against option for the other model. Right now, searching
@@ -505,11 +463,10 @@ end
 
 The currently implemented features are
 
-*   :tsearch - [Full text search](http://www.postgresql.org/docs/current/static/textsearch-intro.html) 
-    (built-in with 8.3 and later, available as a contrib package for some earlier versions)
+*   :tsearch - [Full text search](http://www.postgresql.org/docs/current/static/textsearch-intro.html), which is built-in to PostgreSQL
 *   :trigram - [Trigram search](http://www.postgresql.org/docs/current/static/pgtrgm.html), which
-    requires the trigram contrib package
-*   :dmetaphone - [Double Metaphone search](http://www.postgresql.org/docs/9.0/static/fuzzystrmatch.html#AEN124771), which requires the fuzzystrmatch contrib package
+    requires the trigram extension
+*   :dmetaphone - [Double Metaphone search](http://www.postgresql.org/docs/current/static/fuzzystrmatch.html#AEN177521), which requires the fuzzystrmatch extension
 
 
 #### :tsearch (Full Text Search)
@@ -736,7 +693,7 @@ one_close = Person.create!(:name => 'leigh heinz')
 Person.search('ash hines') # => [exact, one_exact_one_close, one_exact]
 ```
 
-##### :highlight (PostgreSQL 9.0 and newer only)
+##### :highlight
 
 Adding .with_pg_search_highlight after the pg_search_scope you can access to
 `pg_highlight` attribute for each object.
@@ -749,8 +706,10 @@ class Person < ActiveRecord::Base
                   :against => :bio,
                   :using => {
                     :tsearch => {
-                      :start_sel => '<b>',
-                      :stop_sel => '</b>'
+                      :highlight => {
+                        :start_sel => '<b>',
+                        :stop_sel => '</b>'
+                      }
                     }
                   }
 end
@@ -773,10 +732,10 @@ Currently, this is not a true double-metaphone, as only the first metaphone is
 used for searching.
 
 Double Metaphone support is currently available as part of the [fuzzystrmatch
-contrib package](http://www.postgresql.org/docs/current/static/fuzzystrmatch.html)
+extension](http://www.postgresql.org/docs/current/static/fuzzystrmatch.html)
 that must be installed before this feature can be used. In addition to the
-contrib package, you must install a utility function into your database. To
-generate and run a migration for this, run:
+extension, you must install a utility function into your database. To generate 
+and run a migration for this, run:
 
     $ rails g pg_search:migration:dmetaphone
     $ rake db:migrate
@@ -810,9 +769,9 @@ Trigram search works by counting how many three-letter substrings (or
 Trigram search has some ability to work even with typos and misspellings in
 the query or text.
 
-Trigram support is currently available as part of the [pg_trgm contrib
-package](http://www.postgresql.org/docs/current/static/pgtrgm.html) that must
-be installed before this feature can be used.
+Trigram support is currently available as part of the 
+[pg_trgm extension](http://www.postgresql.org/docs/current/static/pgtrgm.html) that must be installed before this
+feature can be used.
 
 ```ruby
 class Website < ActiveRecord::Base
@@ -902,15 +861,14 @@ Image.combined_search('reasonable') # found with tsearch
 Image.combined_search('foo') # found with trigram
 ```
 
-### Ignoring accent marks (PostgreSQL 9.0 and newer only)
+### Ignoring accent marks
 
 Most of the time you will want to ignore accent marks when searching. This
 makes it possible to find words like "piñata" when searching with the query
 "pinata". If you set a pg_search_scope to ignore accents, it will ignore
 accents in both the searchable text and the query terms.
 
-Ignoring accents uses the [unaccent contrib
-package](http://www.postgresql.org/docs/current/static/unaccent.html) that
+Ignoring accents uses the [unaccent extension](http://www.postgresql.org/docs/current/static/unaccent.html) that
 must be installed before this feature can be used.
 
 ```ruby
@@ -930,8 +888,8 @@ SpanishQuestion.gringo_search("Cüåñtô") # => [how_many]
 ```
 
 Advanced users may wish to add indexes for the expressions that pg_search
-generates. Unfortunately, the unaccent function supplied by this contrib
-package is not indexable (as of PostgreSQL 9.1). Thus, you may want to write
+generates. Unfortunately, the unaccent function supplied by this extension
+is not indexable (as of PostgreSQL 9.1). Thus, you may want to write
 your own wrapper function and use it instead. This can be configured by
 calling the following code, perhaps in an initializer.
 
@@ -968,7 +926,7 @@ To use this functionality you'll need to do a few things:
                       tsearch: {
                         dictionary: 'english',
                         tsvector_column: 'tsvector_content_tsearch'
-                      }
+                      },
                       trigram: {} # trigram does not use tsvectors
                     }
     ```
@@ -1123,4 +1081,5 @@ Please read our [CONTRIBUTING guide](https://github.com/Casecommons/pg_search/bl
 
 ## LICENSE
 
-MIT
+Copyright © 2010–2016 [Case Commons, Inc](http://casecommons.org).
+Licensed under the MIT license, see [LICENSE](/LICENSE) file.

data/Rakefile

@@ -5,6 +5,12 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 require "rubocop/rake_task"
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new do |t|
+  t.options = %w[--display-cop-names]
+end
 
-task :default => %w[ spec rubocop ]
+task :codeclimate do
+  sh 'bin/codeclimate-test-reporter' if ENV['CODECLIMATE_REPO_TOKEN']
+end
+
+task :default => %w[spec codeclimate rubocop]

data/lib/pg_search.rb

@@ -3,9 +3,7 @@ require "active_support/concern"
 require "active_support/core_ext/module/attribute_accessors"
 require "active_support/core_ext/string/strip"
 
-require "pg_search/compatibility"
 require "pg_search/configuration"
-require "pg_search/extensions/arel"
 require "pg_search/features"
 require "pg_search/multisearch"
 require "pg_search/multisearchable"
@@ -92,8 +90,6 @@ module PgSearch
     end
   end
 
-  class NotSupportedForPostgresqlVersion < StandardError; end
-
   class PgSearchRankNotSelected < StandardError
     def message
       "You must chain .with_pg_search_rank after the pg_search_scope to access the pg_search_rank attribute on returned records" # rubocop:disable Metrics/LineLength

data/lib/pg_search/configuration.rb

@@ -71,10 +71,6 @@ module PgSearch
       options[:order_within_rank]
     end
 
-    def postgresql_version
-      model.connection.send(:postgresql_version)
-    end
-
     private
 
     attr_reader :options

data/lib/pg_search/configuration/association.rb

@@ -28,20 +28,33 @@ module PgSearch
       private
 
       def selects
-        postgresql_version = @model.connection.send(:postgresql_version)
+        if singular_association?
+          selects_for_singular_association
+        else
+          selects_for_multiple_association
+        end
+      end
+
+      def selects_for_singular_association
+        columns.map do |column|
+          "#{column.full_name}::text AS #{column.alias}"
+        end.join(", ")
+      end
 
+      def selects_for_multiple_association
         columns.map do |column|
-          case postgresql_version
-          when 0..90000
-            "array_to_string(array_agg(#{column.full_name}::text), ' ') AS #{column.alias}"
-          else
-            "string_agg(#{column.full_name}::text, ' ') AS #{column.alias}"
-          end
+          "string_agg(#{column.full_name}::text, ' ') AS #{column.alias}"
         end.join(", ")
       end
 
       def relation(primary_key)
-        @model.unscoped.joins(@name).select("#{primary_key} AS id, #{selects}").group(primary_key)
+        result = @model.unscoped.joins(@name).select("#{primary_key} AS id, #{selects}")
+        result = result.group(primary_key) unless singular_association?
+        result
+      end
+
+      def singular_association?
+        [:has_one, :belongs_to].include?(@model.reflect_on_association(@name).macro)
       end
     end
   end