pg_search 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e78424399f49c900c5be4aeb3d427323a8d5cb08
-  data.tar.gz: 5516d8fcc707711c41ebacff2cf013e04a3d0843
+  metadata.gz: 253c1319e785dfac16b15e9ffc72d7d37b60eda5
+  data.tar.gz: 78931e1fac31befac51f12b5ae2c26c13a11994a
 SHA512:
-  metadata.gz: 2b953933148c7c760047cc7ef8d0d88ff1b6f5f79a5fde5899091a7eb8153e5df7162bda5bbac19304d2188f20564bff1da443551db0e7a23de17c27c66a5bc2
-  data.tar.gz: b8507bbc4567a7eedb31fbe9f7bf9f8412360efc1b4a5e52410425f9f59cb5e5f69c40e53c65e3c7789eca00412ffc9c7a04b90cecc320f4a877fd47154d12dc
+  metadata.gz: 53f22f8135d1992271bae14aa8b77cc76fd75d625b60c01075157383f9716c3aee9e1bf6e404e79b21cdbb0a7e611c9b820e3553a05485ba485f3b404a2afa28
+  data.tar.gz: 768c5c7a66b4875cce05f12b4e0bbe50ddd8dc8a6bd3afdcb2acf9db2334ffe1ad1d04d99814a0bf38876a7829320faeda5227886a13b5c81720a33d7438223b

data/.rubocop.yml

@@ -34,7 +34,7 @@ Style/PercentLiteralDelimiters:
 Style/GuardClause:
   Enabled: false
 
-Style/VariableNumber:
+Naming/VariableNumber:
   EnforcedStyle: snake_case
 
 Bundler/OrderedGems:

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # pg_search changelog
 
+## 2.1.1
+
+*   Support snake_case ts_headline options again (with deprecation warning)
+
 ## 2.1.0
 
 *   Allow ts_headline options to be passed to :highlight (Ian Heisters)

data/lib/pg_search/features/tsearch.rb

@@ -1,4 +1,5 @@
 require "active_support/core_ext/module/delegation"
+require 'active_support/deprecation'
 
 module PgSearch
   module Features
@@ -35,11 +36,14 @@ module PgSearch
       def ts_headline_options
         return '' unless options[:highlight].is_a?(Hash)
 
-        headline_options = map_headline_options
-        headline_options.map { |key, value| "#{key} = #{value}" unless value.nil? }.compact.join(", ")
+        headline_options
+          .merge(deprecated_headline_options)
+          .map { |key, value| "#{key} = #{value}" unless value.nil? }
+          .compact
+          .join(", ")
       end
 
-      def map_headline_options
+      def headline_options
         indifferent_options = options.with_indifferent_access
 
         %w[
@@ -48,20 +52,47 @@ module PgSearch
           hash.tap do
             value = indifferent_options[:highlight][key]
 
-            hash[key] = case value
-                        when String
-                          %("#{value.gsub('"', '""')}")
-                        when true
-                          "TRUE"
-                        when false
-                          "FALSE"
-                        else
-                          value
-                        end
+            hash[key] = ts_headline_option_value(value)
           end
         end
       end
 
+      def deprecated_headline_options
+        indifferent_options = options.with_indifferent_access
+
+        %w[
+          start_sel stop_sel max_fragments max_words min_words short_word fragment_delimiter highlight_all
+        ].reduce({}) do |hash, deprecated_key|
+          hash.tap do
+            value = indifferent_options[:highlight][deprecated_key]
+
+            unless value.nil?
+              key = deprecated_key.camelize
+
+              ActiveSupport::Deprecation.warn(
+                "pg_search 3.0 will no longer accept :#{deprecated_key} as an argument to :ts_headline, " \
+                "use :#{key} instead."
+              )
+
+              hash[key] = ts_headline_option_value(value)
+            end
+          end
+        end
+      end
+
+      def ts_headline_option_value(value)
+        case value
+        when String
+          %("#{value.gsub('"', '""')}")
+        when true
+          "TRUE"
+        when false
+          "FALSE"
+        else
+          value
+        end
+      end
+
       DISALLOWED_TSQUERY_CHARACTERS = /['?\\:]/
 
       def tsquery_for_term(unsanitized_term) # rubocop:disable Metrics/AbcSize

data/lib/pg_search/scope_options.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 require "active_support/core_ext/module/delegation"
 
 module PgSearch

data/lib/pg_search/version.rb

@@ -1,3 +1,3 @@
 module PgSearch
-  VERSION = "2.1.0".freeze
+  VERSION = "2.1.1".freeze
 end

data/pg_search.gemspec

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'pg_search/version'
 

data/spec/lib/pg_search/configuration/association_spec.rb

@@ -48,7 +48,7 @@ describe PgSearch::Configuration::Association do
 
     describe "#join" do
       let(:expected_sql) do
-        <<-EOS.gsub(/\s+/, ' ').strip
+        <<-SQL.gsub(/\s+/, ' ').strip
           LEFT OUTER JOIN
             (SELECT model_id AS id,
                     #{column_select} AS #{association.columns.first.alias}
@@ -56,7 +56,7 @@ describe PgSearch::Configuration::Association do
             INNER JOIN \"#{association.table_name}\"
             ON \"#{association.table_name}\".\"user_id\" = \"#{User.table_name}\".\"id\") #{association.subselect_alias}
           ON #{association.subselect_alias}.id = model_id
-        EOS
+        SQL
       end
       let(:column_select) do
         "\"#{association.table_name}\".\"url\"::text"
@@ -79,7 +79,7 @@ describe PgSearch::Configuration::Association do
 
     describe "#join" do
       let(:expected_sql) do
-        <<-EOS.gsub(/\s+/, ' ').strip
+        <<-SQL.gsub(/\s+/, ' ').strip
           LEFT OUTER JOIN
             (SELECT model_id AS id,
                     #{column_select} AS #{association.columns.first.alias}
@@ -87,7 +87,7 @@ describe PgSearch::Configuration::Association do
             INNER JOIN \"#{association.table_name}\"
             ON \"#{association.table_name}\".\"id\" = \"#{User.table_name}\".\"site_id\") #{association.subselect_alias}
           ON #{association.subselect_alias}.id = model_id
-        EOS
+        SQL
       end
       let(:column_select) do
         "\"#{association.table_name}\".\"title\"::text"
@@ -110,7 +110,7 @@ describe PgSearch::Configuration::Association do
 
     describe "#join" do
       let(:expected_sql) do
-        <<-EOS.gsub(/\s+/, ' ').strip
+        <<-SQL.gsub(/\s+/, ' ').strip
           LEFT OUTER JOIN
             (SELECT model_id AS id,
                     string_agg(\"#{association.table_name}\".\"name\"::text, ' ') AS #{association.columns.first.alias}
@@ -119,7 +119,7 @@ describe PgSearch::Configuration::Association do
             ON \"#{association.table_name}\".\"site_id\" = \"#{Site.table_name}\".\"id\"
             GROUP BY model_id) #{association.subselect_alias}
           ON #{association.subselect_alias}.id = model_id
-        EOS
+        SQL
       end
 
       it "returns the correct SQL join" do

data/spec/lib/pg_search/features/tsearch_spec.rb

@@ -1,4 +1,5 @@
 require "spec_helper"
+require "active_support/deprecation"
 
 describe PgSearch::Features::TSearch do
   describe "#rank" do
@@ -201,6 +202,35 @@ describe PgSearch::Features::TSearch do
 
         expect(feature.highlight.to_sql).to eq(expected_sql)
       end
+
+      it "passes deprecated options to ts_headline" do
+        query = "query"
+        columns = [
+          PgSearch::Configuration::Column.new(:name, nil, Model)
+        ]
+        options = {
+          highlight: {
+            start_sel: '<start class="search">',
+            stop_sel: '<stop>',
+            max_words: 123,
+            min_words: 456,
+            short_word: 4,
+            highlight_all: false,
+            max_fragments: 3,
+            fragment_delimiter: '&hellip;'
+          }
+        }
+
+        config = double(:config, :ignore => [])
+        normalizer = PgSearch::Normalizer.new(config)
+
+        feature = described_class.new(query, options, columns, Model, normalizer)
+
+        highlight_sql = ActiveSupport::Deprecation.silence { feature.highlight.to_sql }
+        expected_sql = %{(ts_headline('simple', (coalesce(#{Model.quoted_table_name}."name"::text, '')), (to_tsquery('simple', ''' ' || 'query' || ' ''')), 'StartSel = "<start class=""search"">", StopSel = "<stop>", MaxFragments = 3, MaxWords = 123, MinWords = 456, ShortWord = 4, FragmentDelimiter = "&hellip;", HighlightAll = FALSE'))}
+
+        expect(highlight_sql).to eq(expected_sql)
+      end
     end
   end
 end

data/spec/lib/pg_search_spec.rb

@@ -223,7 +223,7 @@ describe PgSearch do
           @multisearch_enabled_inside = PgSearch.multisearch_enabled?
           raise
         end
-      rescue
+      rescue # rubocop:disable Lint/RescueWithoutErrorClass
       end
 
       @multisearch_enabled_after = PgSearch.multisearch_enabled?

data/spec/support/database.rb

@@ -42,7 +42,7 @@ def install_extension(name)
   extension = connection.execute "SELECT * FROM pg_catalog.pg_extension WHERE extname = '#{name}';"
   return unless extension.none?
   connection.execute "CREATE EXTENSION #{name};"
-rescue => exception
+rescue => exception # rubocop:disable Lint/RescueWithoutErrorClass
   at_exit do
     puts "-" * 80
     puts "Please install the #{name} extension"
@@ -54,7 +54,7 @@ end
 def install_extension_if_missing(name, query, expected_result)
   result = ActiveRecord::Base.connection.select_value(query)
   raise "Unexpected output for #{query}: #{result.inspect}" unless result.downcase == expected_result.downcase
-rescue
+rescue # rubocop:disable Lint/RescueWithoutErrorClass
   install_extension(name)
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_search
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Grant Hutchins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-29 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -241,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: PgSearch builds Active Record named scopes that take advantage of PostgreSQL's