pg_search 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d88e1b1a697e2b7c60254e229f05ef8a7e7290fd
-  data.tar.gz: 237578e6b7961e9662d513f246878ad07e27d52e
+  metadata.gz: 8d495a89c4bddfe4c4d367fb1cc8e4c5b1bea048
+  data.tar.gz: 611249f3cddce656579b5f4618a4d8a26ed77f8d
 SHA512:
-  metadata.gz: 8a20e4bccc363bd4625b97d4533fedbb4a2fe22d0be7f28b4498456c7189a4ee34209e6e3f81109a2285680dc693a6cf17946ba301b3d67c7e7c6a4a4dac0e28
-  data.tar.gz: 0e119a3b707bbb3b55272763893eacf8d2857f4171733e114797a68d8d1d506c7b491b6e27eccb9994276f0615911947748c4553dafd9f4a56df0f50c4c9e963
+  metadata.gz: b6bfca34ff32c71bc153173f6cd5ea293ab35bea8aa55cdabd53388b687e56b273402b2b822789994d378fed58e3591a1a91c724cfc91f1085edba9d988773f6
+  data.tar.gz: d03fc9fe66c02fb33744ec86ab12ec97d662c3eaff075da0c1b0f6f994e3c3f4c8da47045d4ce227bb6552e8890d95729d1cc679e80115378aabd9f7fd4b2324

data/.codeclimate.yml

@@ -0,0 +1,2 @@
+languages:
+  Ruby: true

data/.rubocop.yml

@@ -1,8 +1,29 @@
 inherit_from: .rubocop_todo.yml
 
+AllCops:
+  Exclude:
+    - bin/**/*
+
 Style/StringLiterals:
   Enabled: false
 
 AllCops:
   Exclude:
     - bin/**/*
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 21
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+    '%W': '[]'

data/.rubocop_todo.yml

@@ -5,168 +5,15 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 11
-# Cop supports --auto-correct.
-Lint/UnusedBlockArgument:
-  Enabled: false
-
-# Offense count: 12
-Lint/UselessAssignment:
-  Enabled: false
-
-# Offense count: 6
-Metrics/AbcSize:
-  Max: 27
-
-# Offense count: 347
-# Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
-  Max: 304
-
-# Offense count: 9
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 21
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/Alias:
-  Enabled: false
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
-Style/AlignHash:
-  Enabled: false
-
-# Offense count: 42
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/AlignParameters:
-  Enabled: false
-
-# Offense count: 14
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/BarePercentLiterals:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/BlockEndNewline:
-  Enabled: false
-
-# Offense count: 14
-# Cop supports --auto-correct.
-Style/BlockDelimiters:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 # Offense count: 27
 Style/Documentation:
   Enabled: false
 
-# Offense count: 5
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/DotPosition:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/ElseAlignment:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/EmptyLines:
-  Enabled: false
-
-# Offense count: 6
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/EmptyLinesAroundBlockBody:
-  Enabled: false
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/EmptyLinesAroundClassBody:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/EmptyLinesAroundModuleBody:
-  Enabled: false
-
-# Offense count: 2
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Enabled: false
-
-# Offense count: 521
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/HashSyntax:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: MaxLineLength.
-Style/IfUnlessModifier:
-  Enabled: false
-
-# Offense count: 23
-# Cop supports --auto-correct.
-Style/IndentArray:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/IndentationConsistency:
-  Enabled: false
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: Width.
-Style/IndentationWidth:
-  Enabled: false
-
-# Offense count: 10
-Style/Lambda:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/MethodDefParentheses:
-  Enabled: false
-
-# Offense count: 2
-Style/MultilineBlockChain:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/MultilineBlockLayout:
-  Enabled: false
-
 # Offense count: 16
 # Cop supports --auto-correct.
 Style/NumericLiterals:
   MinDigits: 6
 
-# Offense count: 12
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.

data/.travis.yml

@@ -7,6 +7,7 @@ rvm:
   - "2.1"
   - "2.2"
   - jruby-19mode
+  - jruby-9.0.0.0
 
 env:
   - ACTIVE_RECORD_BRANCH="master"
@@ -21,7 +22,6 @@ env:
 
 matrix:
   allow_failures:
-    - rvm: jruby-19mode
     - env: ACTIVE_RECORD_BRANCH="master"
     - env: ACTIVE_RECORD_BRANCH="4-2-stable"
     - env: ACTIVE_RECORD_BRANCH="4-1-stable"
@@ -35,8 +35,14 @@ matrix:
       env: ACTIVE_RECORD_BRANCH="master"
     - rvm: jruby-19mode
       env: ACTIVE_RECORD_BRANCH="master"
+    - rvm: jruby-9.0.0.0
+      env: ACTIVE_RECORD_BRANCH="master"
 
 before_script:
   - "psql -c 'create database pg_search_test;' -U postgres >/dev/null"
 
 script: "bin/rake"
+
+addons:
+  code_climate:
+    repo_token: 0a0e3e45118bc447e677d52c21d056a5471c4921d54f96ed7b2550d9fc5043ea

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # pg_search changelog
 
+## 1.0.5
+
+*   Clean up rank table aliasing (Adam Milligan)
+*   Fix issue when using `#with_pg_search_rank` across a join (Reid Lynch)
+
 ## 1.0.4
 
 *   Assert valid options for features. (Janko Marohnić)

data/Gemfile

@@ -10,9 +10,7 @@ if ENV['ACTIVE_RECORD_BRANCH']
   gem 'arel', :git => 'https://github.com/rails/arel.git' if ENV['ACTIVE_RECORD_BRANCH'] == 'master'
 end
 
-if ENV['ACTIVE_RECORD_VERSION']
-  gem 'activerecord', ENV['ACTIVE_RECORD_VERSION']
-end
+gem 'activerecord', ENV['ACTIVE_RECORD_VERSION'] if ENV['ACTIVE_RECORD_VERSION']
 
 group :development do
   gem 'guard-rspec', :require => false
@@ -20,3 +18,7 @@ group :development do
   gem 'rb-fsevent', :require => false
   gem 'rb-fchange', :require => false
 end
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+end

data/README.md

@@ -1,8 +1,9 @@
 # [pg_search](http://github.com/Casecommons/pg_search/)
 
+[![Gem Version](https://img.shields.io/gem/v/pg_search.svg?style=flat)](https://rubygems.org/gems/pg_search)
 [![Build Status](https://secure.travis-ci.org/Casecommons/pg_search.svg?branch=master)](https://travis-ci.org/Casecommons/pg_search)
 [![Code Climate](https://img.shields.io/codeclimate/github/Casecommons/pg_search.svg?style=flat)](https://codeclimate.com/github/Casecommons/pg_search)
-[![Gem Version](https://img.shields.io/gem/v/pg_search.svg?style=flat)](https://rubygems.org/gems/pg_search)
+[![Test Coverage](https://codeclimate.com/github/Casecommons/pg_search/badges/coverage.svg)](https://codeclimate.com/github/Casecommons/pg_search/coverage)
 [![Dependency Status](https://img.shields.io/gemnasium/Casecommons/pg_search.svg?style=flat)](https://gemnasium.com/Casecommons/pg_search)
 [![Inline docs](http://inch-ci.org/github/Casecommons/pg_search.svg?branch=master&style=flat)](http://inch-ci.org/github/Casecommons/pg_search)
 [![Join the chat at https://gitter.im/Casecommons/pg_search](https://img.shields.io/badge/gitter-join%20chat-blue.svg)](https://gitter.im/Casecommons/pg_search?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -12,7 +13,7 @@
 PgSearch builds named scopes that take advantage of PostgreSQL's full text
 search.
 
-Read the blog post introducing PgSearch at http://pivotallabs.com/pg-search/
+Read the blog post introducing PgSearch at http://blog.pivotal.io/labs/labs/pg-search
 
 ## REQUIREMENTS
 
@@ -1038,21 +1039,38 @@ descending by updated_at, to rank the most recently updated records first.
 pg_search_scope :search_and_break_ties_by_latest_update,
                 :against => [:title, :content],
                 :order_within_rank => "blog_posts.updated_at DESC"
-````
+```
 
 #### PgSearch#pg_search_rank (Reading a record's rank as a Float)
 
 It may be useful or interesting to see the rank of a particular record. This
 can be helpful for debugging why one record outranks another. You could also
 use it to show some sort of relevancy value to end users of an application.
-Just call .pg_search_rank on a record returned by a pg_search_scope.
+
+To retrieve the rank, call `.with_pg_search_rank` on a scope, and then call
+`.pg_search_rank` on a returned record.
 
 ```ruby
-shirt_brands = ShirtBrand.search_by_name("Penguin")
+shirt_brands = ShirtBrand.search_by_name("Penguin").with_pg_search_rank
 shirt_brands[0].pg_search_rank #=> 0.0759909
 shirt_brands[1].pg_search_rank #=> 0.0607927
 ```
 
+#### Search rank and chained scopes
+
+Each PgSearch scope generates a named subquery for the search rank.  If you
+chain multiple scopes then PgSearch will generate a ranking query for each
+scope, so the ranking queries must have unique names.  If you need to reference
+the ranking query (e.g. in a GROUP BY clause) you can regenerate the subquery
+name with the `PgScope::Configuration.alias` method by passing the name of the
+queried table.
+
+```ruby
+shirt_brands = ShirtBrand.search_by_name("Penguin")
+  .joins(:shirt_sizes)
+  .group_by('shirt_brands.id, #{PgSearch::Configuration.alias('shirt_brands')}.rank')
+```
+
 ## ATTRIBUTIONS
 
 PgSearch would not have been possible without inspiration from texticle (now renamed

data/lib/pg_search.rb

@@ -30,20 +30,14 @@ module PgSearch
                        unless options.respond_to?(:merge)
                          raise ArgumentError, "pg_search_scope expects a Hash or Proc"
                        end
-                       lambda { |query| {:query => query}.merge(options) }
+                       ->(query) { {:query => query}.merge(options) }
                      end
 
-      method_proc = lambda do |*args|
+      define_singleton_method(name) do |*args|
         config = Configuration.new(options_proc.call(*args), self)
         scope_options = ScopeOptions.new(config)
         scope_options.apply(self)
       end
-
-      if respond_to?(:define_singleton_method)
-        define_singleton_method name, &method_proc
-      else
-        (class << self; self; end).send :define_method, name, &method_proc
-      end
     end
 
     def multisearchable(options = {})
@@ -93,10 +87,10 @@ module PgSearch
     end
   end
 
-
   class NotSupportedForPostgresqlVersion < StandardError; end
 
   class PgSearchRankNotSelected < StandardError
+    # rubocop:disable Metrics/LineLength
     def message
       "You must chain .with_pg_search_rank after the pg_search_scope to access the pg_search_rank attribute on returned records"
     end

data/lib/pg_search/configuration.rb

@@ -4,7 +4,6 @@ require "pg_search/configuration/foreign_column"
 
 module PgSearch
   class Configuration
-
     attr_reader :model
 
     def initialize(options, model)

data/lib/pg_search/document.rb

@@ -8,7 +8,7 @@ module PgSearch
     belongs_to :searchable, :polymorphic => true
 
     before_validation :update_content,
-                      :unless => Proc.new { |doc| doc.searchable.nil? }
+      :unless => Proc.new { |doc| doc.searchable.nil? }
 
     # The logger might not have loaded yet.
     # https://github.com/Casecommons/pg_search/issues/26

data/lib/pg_search/extensions/arel.rb

@@ -4,7 +4,7 @@ require "arel/visitors/depth_first"
 # Based on the solution from https://github.com/ernie/squeel/issues/122
 Arel::Visitors::DepthFirst.class_eval do
   unless method_defined?(:visit_Arel_Nodes_InfixOperation)
-    alias :visit_Arel_Nodes_InfixOperation :binary
+    alias_method :visit_Arel_Nodes_InfixOperation, :binary
   end
 end
 

data/lib/pg_search/features/tsearch.rb

@@ -11,7 +11,7 @@ module PgSearch
       def initialize(*args)
         super
 
-        if options[:prefix] && model.connection.send(:postgresql_version) < 80400
+        if options[:prefix] && model.connection.send(:postgresql_version) < 80400 # rubocop:disable Style/GuardClause
           raise PgSearch::NotSupportedForPostgresqlVersion.new(<<-MESSAGE.strip_heredoc)
             Sorry, {:using => {:tsearch => {:prefix => true}}} only works in PostgreSQL 8.4 and above.")
           MESSAGE
@@ -32,7 +32,7 @@ module PgSearch
 
       DISALLOWED_TSQUERY_CHARACTERS = /['?\\:]/
 
-      def tsquery_for_term(unsanitized_term)
+      def tsquery_for_term(unsanitized_term) # rubocop:disable Metrics/AbcSize
         if options[:negation] && unsanitized_term.start_with?("!")
           unsanitized_term[0] = ''
           negated = true

data/lib/pg_search/multisearch.rb

@@ -2,7 +2,6 @@ require "pg_search/multisearch/rebuilder"
 
 module PgSearch
   module Multisearch
-
     class << self
       def rebuild(model, clean_up=true)
         model.transaction do

data/lib/pg_search/multisearch/rebuilder.rb

@@ -42,7 +42,7 @@ module PgSearch
       end
 
       def rebuild_sql_template
-         <<-SQL.strip_heredoc
+        <<-SQL.strip_heredoc
           INSERT INTO :documents_table (searchable_type, searchable_id, content, created_at, updated_at)
             SELECT :base_model_name AS searchable_type,
                    :model_table.#{primary_key} AS searchable_id,
@@ -78,9 +78,7 @@ module PgSearch
       end
 
       def content_expressions
-        columns.map { |column|
-          %Q{coalesce(:model_table.#{column}::text, '')}
-        }.join(" || ' ' || ")
+        columns.map { |column| %{coalesce(:model_table.#{column}::text, '')} }.join(" || ' ' || ")
       end
 
       def columns