effective_search 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bec49baf4ca011a578402ee1ea21d618d1a4a5a9cd169f3ead349a19a8957d8
-  data.tar.gz: 9feaacfd570da93b5ccc1d4dd5c11f13e372c4c71bbc4c338d9d8a69fffd6b1d
+  metadata.gz: 83d826d688fa3d81c054904cb345337677d2be1ba45d16114c774be17c4d7034
+  data.tar.gz: 51895c70ac58d0d5972e44e0cd97491924b8f537cbb32320ffec60705f3fc7cb
 SHA512:
-  metadata.gz: 42cbc5f549c28d8f0ea19f6cb5b91e1175171e2518936aca2c89fabeb010cea5225e2e5a2f4c0698d74e4837258bba2d76626087717dfe6f13974c58ebfcd389
-  data.tar.gz: d6a3bbe5359e1daa77e87227f781888146b05aefd8fef1a2abb521e5eb16a4c93b54e6b3adc0c124828ec752b32fe33577faee1ff320f3835d1d918aa971cafb
+  metadata.gz: 2c5a18018ad7a3501a00316107ddfb27d5d518081021e927b2a853ccc7cac7091f09b7401981284c2deb054e1131a2ab4e91e8a93a1085f14b1c9217ebbfa737
+  data.tar.gz: b4257f2cd361ba2a71d78966ec7cb779bfbcd2f24d7d599f9f42a47aff406df2dea3c63d2757538c7016a3d7a3b4f7e2b04c280fa44b59ff54779a0a046afef1

data/app/controllers/effective/search_controller.rb

@@ -14,15 +14,21 @@ module Effective
       @search.search!
 
       if @search.present?
-        @search_count = @search.results.limit(nil).offset(nil).count
+        @search_page = EffectiveResources.normalize_page(params[:page])
+        raise ActiveRecord::RecordNotFound, "Page #{params[:page].inspect} is invalid" unless @search_page
 
-        @search_page = EffectiveResources.validate_page!(
-          params[:page],
-          collection_count: @search_count,
-          per_page: @search.per_page
-        )
+        results = @search.results(page: @search_page)
+          .limit(@search.per_page + 1)
+          .with_pg_search_highlight
+          .load
+          .to_a
 
-        @page_title = "Search results for ‘#{@search}’".html_safe
+        raise ActiveRecord::RecordNotFound, "Page #{@search_page} does not exist" if @search_page > 1 && results.empty?
+
+        @search_has_next_page = (results.length > @search.per_page)
+        @search_results = results.first(@search.per_page)
+
+        @page_title = "Search results for ‘#{@search}’"
       else
         @page_title = "Search"
       end

data/app/helpers/effective_search_helper.rb

@@ -1,5 +1,37 @@
 module EffectiveSearchHelper
 
+  def effective_search_paginate(page:, has_next_page:, url: nil)
+    return unless page > 1 || has_next_page
+
+    uri = URI(url || request.fullpath)
+    query = Rack::Utils.parse_nested_query(uri.query)
+    path = uri.path + '?'
+
+    previous = content_tag(:li, class: ['page-item', ('disabled' if page <= 1)].compact.join(' ')) do
+      if page > 1
+        link_to('Previous', path + query.merge('page' => page - 1).to_query,
+          class: 'page-link', 'aria-label': 'Previous', title: 'Previous', rel: 'prev'
+        )
+      else
+        content_tag(:span, 'Previous', class: 'page-link', 'aria-disabled': 'true')
+      end
+    end
+
+    following = content_tag(:li, class: ['page-item', ('disabled' unless has_next_page)].compact.join(' ')) do
+      if has_next_page
+        link_to('Next', path + query.merge('page' => page + 1).to_query,
+          class: 'page-link', 'aria-label': 'Next', title: 'Next', rel: 'next'
+        )
+      else
+        content_tag(:span, 'Next', class: 'page-link', 'aria-disabled': 'true')
+      end
+    end
+
+    content_tag(:nav, class: 'd-flex justify-content-center', 'aria-label': 'Search results pages') do
+      content_tag(:ul, safe_join([previous, following]), class: 'pagination')
+    end
+  end
+
   def effective_search_nav_item
     if EffectiveResources.authorized?(self, :index, EffectiveSearch.Search)
       render('effective/search/form_nav_item')

data/app/models/concerns/effective_search_search.rb

@@ -6,6 +6,8 @@
 module EffectiveSearchSearch
   extend ActiveSupport::Concern
 
+  MAX_LENGTH = 200
+
   module ClassMethods
     def effective_search_search?; true; end
   end
@@ -15,9 +17,22 @@ module EffectiveSearchSearch
 
     attr_accessor :current_user
     attr_accessor :view_context
-
     attr_accessor :term
-    validates :term, length: { minimum: 3, allow_blank: true }
+
+    validate do
+      value = term.to_s
+
+      unless value.valid_encoding?
+        errors.add(:term, 'must use UTF-8 encoding')
+        next
+      end
+
+      next if value.blank?
+
+      errors.add(:term, 'contains an invalid null byte') if value.include?("\0")
+      errors.add(:term, :too_short, count: 3) if value.length < 3
+      errors.add(:term, :too_long, count: MAX_LENGTH) if value.length > MAX_LENGTH
+    end
   end
 
   def to_s
@@ -40,15 +55,14 @@ module EffectiveSearchSearch
   end
 
   def present?
-    term.present?
+    valid? && term.to_s.present?
   end
 
   # Search and assigns the collection
   # Assigns the entire collection() if there are no search terms
   # Otherwise validate the search terms
   def search!
-    @search_results = build_collection()
-    @search_results = @search_results.none if present? && !valid?
+    @search_results = valid? ? build_collection() : PgSearch::Document.none
     @search_results
   end
 
@@ -120,7 +134,7 @@ module EffectiveSearchSearch
 
   protected
 
-  # Returns an ActiveRecord collection of PgSearch::Document 
+  # Returns an ActiveRecord collection of PgSearch::Document
   def build_collection
     raise('expected pg_search gem') unless defined?(PgSearch)
 

data/app/views/effective/search/_search.html.haml

@@ -2,7 +2,6 @@
   = render('effective/search/form', search: search)
 
   - if search.present?
-    - results = search.results(page: @search_page)
     - search_contents = search.search_contents.select { |resource| search.authorized?(resource) }
     - permalinks = search.permalinks.select { |resource| search.authorized?(resource) }
 
@@ -20,12 +19,11 @@
 
       -# Search results
       %div{class: (permalinks.present? ? 'col-xl-8 col-lg-7' : 'col')}
-        - if results.length == 0
+        - if @search_results.empty?
           .alert.alert-info There are no results for your search. Please try again.
 
-        - if results.length > 0
-          - collection = results.with_pg_search_highlight.select { |result| search.authorized?(result) }
+        - if @search_results.any?
+          - collection = @search_results.select { |result| search.authorized?(result) }
           = render(collection: collection, partial: 'effective/search/result', locals: { search: search })
 
-        %nav.d-flex.justify-content-center
-          = bootstrap_paginate(results, per_page: search.per_page, collection_count: @search_count)
+        = effective_search_paginate(page: @search_page, has_next_page: @search_has_next_page)

data/db/migrate/102_upgrade_effective_search_zero_eight.rb

@@ -0,0 +1,38 @@
+class UpgradeEffectiveSearchZeroEight < ActiveRecord::Migration[7.0]
+  disable_ddl_transaction!
+
+  def up
+    return unless connection.adapter_name == 'PostgreSQL'
+
+    unless column_exists?(:pg_search_documents, :search_vector)
+      execute(<<~SQL.squish)
+        ALTER TABLE pg_search_documents
+        ADD COLUMN search_vector tsvector
+        GENERATED ALWAYS AS (
+          to_tsvector('simple'::regconfig, coalesce(content, ''::text))
+        ) STORED
+      SQL
+    end
+
+    add_index(
+      :pg_search_documents,
+      :search_vector,
+      using: :gin,
+      algorithm: :concurrently,
+      if_not_exists: true
+    )
+  end
+
+  def down
+    return unless connection.adapter_name == 'PostgreSQL'
+
+    remove_index(
+      :pg_search_documents,
+      :search_vector,
+      algorithm: :concurrently,
+      if_exists: true
+    )
+
+    remove_column(:pg_search_documents, :search_vector) if column_exists?(:pg_search_documents, :search_vector)
+  end
+end

data/lib/effective_search/action_text_search_index.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module EffectiveSearch
+  module ActionTextSearchIndex
+    extend ActiveSupport::Concern
+
+    included do
+      after_commit :refresh_pg_search_document, on: [:create, :update, :destroy]
+    end
+
+    private
+
+    def refresh_pg_search_document
+      searchable = record
+      return unless searchable&.persisted?
+      return unless searchable.respond_to?(:update_pg_search_document)
+
+      options = searchable.class.try(:pg_search_multisearchable_options)
+      return unless Array(options.try(:[], :against)).map(&:to_s).include?(name.to_s)
+      return if persisted? && previous_changes.exclude?('body')
+
+      association_name = "rich_text_#{name}"
+
+      if searchable.class.reflect_on_association(association_name)
+        searchable.association(association_name).reset
+      elsif searchable.class.reflect_on_association(:rich_texts)
+        searchable.association(:rich_texts).reset
+      end
+
+      searchable.update_pg_search_document
+    end
+  end
+end

data/lib/effective_search/engine.rb

@@ -7,5 +7,11 @@ module EffectiveSearch
       eval File.read("#{config.root}/config/effective_search.rb")
     end
 
+    initializer 'effective_search.action_text' do
+      ActiveSupport.on_load(:action_text_rich_text) do
+        include EffectiveSearch::ActionTextSearchIndex
+      end
+    end
+
   end
 end

data/lib/effective_search/version.rb

@@ -1,3 +1,3 @@
 module EffectiveSearch
-  VERSION = '0.7.0'.freeze
+  VERSION = '0.8.0'.freeze
 end

data/lib/effective_search.rb

@@ -1,4 +1,5 @@
 require 'effective_resources'
+require 'effective_search/action_text_search_index'
 require 'effective_search/engine'
 require 'effective_search/version'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: effective_search
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Code and Effect
@@ -57,14 +57,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.42.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.42.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -229,8 +229,10 @@ files:
 - config/effective_search.rb
 - config/routes.rb
 - db/migrate/101_create_effective_search.rb
+- db/migrate/102_upgrade_effective_search_zero_eight.rb
 - db/seeds.rb
 - lib/effective_search.rb
+- lib/effective_search/action_text_search_index.rb
 - lib/effective_search/engine.rb
 - lib/effective_search/version.rb
 - lib/generators/effective_search/install_generator.rb