pg_search_multiple_highlight 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bdd0c8ec85bf0daecf8946a71e289a4fdcfcd3868455e06dbe858fda00e8278f
+  data.tar.gz: f2e3fa6a6c9e56dde6dae516ba78a25d270b3ee310d7018b71083dc3eead90eb
+SHA512:
+  metadata.gz: e5268edfd87e56068b4eff82fd54e3f3a109d51ca8aeb0a7dc47a0a55523384ae3b2dc147f86e88030c941d3875597013029376f7c2c886c9e4c25928b8bf25c
+  data.tar.gz: 55e53e2d7bba07d5f781702267688d062874cb55ba33c79bb67017fed75d09ab3d4cdd2dc5dc2458db41c0132c0a3bf85269aad9e16ccfaaa4a6992e3c58901c

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 20

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-08-08
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at slmusayev@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pg_search_multiple_highlight.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "rubocop", "~> 1.21"
+gem "single_cov", "~> 1.9"
+gem "bundle-audit", "~> 0.1.0"

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    pg_search_multiple_highlight (0.1.0)
+      pg_search (~> 2.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.6)
+      activesupport (= 7.0.6)
+    activerecord (7.0.6)
+      activemodel (= 7.0.6)
+      activesupport (= 7.0.6)
+    activesupport (7.0.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    bundle-audit (0.1.0)
+      bundler-audit
+    bundler-audit (0.9.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    concurrent-ruby (1.2.2)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.19.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    pg_search (2.3.6)
+      activerecord (>= 5.2)
+      activesupport (>= 5.2)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rubocop (1.55.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    single_cov (1.11.0)
+    thor (1.2.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  bundle-audit (~> 0.1.0)
+  minitest (~> 5.0)
+  pg_search_multiple_highlight!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  single_cov (~> 1.9)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Suleyman Musayev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# PgSearchMultipleHighlight
+
+The `pg_search_multiple_highlight` gem extends the functionality of the popular `pg_search`
+gem to overcome its limitation when performing searches against multiple columns and
+attempting to highlight results. The core issue arises when using the `:highlight` option
+within the `:tsearch` scope on multiple columns.
+
+This gem addresses this limitation by introducing the `:multiple_highlight` option,
+offering a comprehensive solution for highlighting results across multiple columns.
+
+## Installation
+To install the gem run the following command in the terminal:
+
+    $ bundle add pg_search_multiple_highlight
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install pg_search_multiple_highlight
+
+## Usage
+
+To extend functionality of the `pg_search` gem, require the gemfile in the same file, where
+a PgSearch module is included:
+```ruby
+require 'pg_search_multiple_highlight'
+
+class Shape < ActiveRecord::Base
+  include PgSearch::Model
+end
+```
+
+Usage of the `:multiple_highlight` is similar to the standard `:highlight`.
+
+Adding `.with_pg_search_multiple_highlight` after the `pg_search_scope` you can access
+`pg_multiple_highlight` attribute for each object.
+
+
+```ruby
+require 'pg_search_multiple_highlight'
+
+class Article < ActiveRecord::Base
+  include PgSearch::Model
+
+  pg_search_scope :search,
+                  against: { title: 'A', description: 'B' },
+                  using: {
+                    tsearch: {
+                      multiple_highlight: {
+                        StartSel: '<b>',
+                        StopSel: '</b>',
+                        MaxWords: 400,
+                        MinWords: 200,
+                        ShortWord: 4,
+                        HighlightAll: true,
+                        MaxFragments: 3,
+                        FragmentDelimiter: '&hellip;'
+                      }
+                    }
+                  }
+end
+
+Article.create!(:title => "Quick brown fox", :description => "The quick brown fox jumps over the lazy dog.")
+
+first_match = Article.search("brown").with_pg_search_multiple_highlight.first
+first_match.pg_search_multiple_highlight
+# => {:id=>1,
+#     :title=>"Quick <b>brown</b> fox",
+#     :description=>"The quick <b>brown</b> fox jumps over the lazy dog."}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/msuliq/pg_search_multiple_highlight.
+
+The best way to contribute would be to fork this repo, create a new branch from main, to merge the branch into main of the fork once the new code is in place and then open a pull request to merge forked main into the main of the present repo.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PgSearchMultipleHighlight project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/msuliq/pg_search_multiple_highlight/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/pg_search_multiple_highlight/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PgSearcMultiplehHighlight
+  class Error < StandardError; end
+end

data/lib/pg_search_multiple_highlight/scope_options.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module PgSearch
+  # Extends standard scope options for pg_search so :multiple_highlight can be used
+  # the same way as other search options
+  class ScopeOptions
+    def apply(scope)
+      scope = include_table_aliasing_for_rank(scope)
+      rank_table_alias = scope.pg_search_rank_table_alias(include_counter: true)
+
+      scope
+        .joins(rank_join(rank_table_alias))
+        .order(Arel.sql("#{rank_table_alias}.rank DESC, #{order_within_rank}"))
+        .extend(WithPgSearchRank)
+        .extend(WithPgSearchHighlight[feature_for(:tsearch)])
+        .extend(WithPgSearchMultipleHighlight[feature_for(:tsearch)])
+    end
+
+    # This a workaround https://github.com/Casecommons/pg_search/issues/336 issue of the pg_search gem that does not
+    # support highlighting results when a tsearch is performed against more than one column
+    module WithPgSearchMultipleHighlight
+      def self.[](tsearch)
+        Module.new do
+          include WithPgSearchMultipleHighlight
+          define_method(:tsearch) { tsearch }
+        end
+      end
+
+      def tsearch
+        raise TypeError, "You need to instantiate this module with []"
+      end
+
+      def with_pg_search_multiple_highlight
+        scope = self
+        scope.select("#{table_name}.*") unless scope.select_values.any?
+
+        tsearch.multiple_highlight
+      end
+    end
+  end
+end

data/lib/pg_search_multiple_highlight/tsearch.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module PgSearch
+  # nodoc
+  module Features
+    # Extends class to enable multiple_ighlight method for the search results
+    class TSearch < Feature
+      def self.valid_options
+        super + %i[multiple_highlight]
+      end
+
+      def multiple_highlight
+        config = @normalizer.instance_variable_get(:@config)
+
+        against_columns = config.instance_variable_get(:@options)[:against].keys
+
+        @model.search(query).map do |result|
+          highlighted_fields = {
+            id: result.id
+          }
+          against_columns.each do |column|
+            highlighted_fields[column] = highlight_multiple_fields(result.send(column), query)
+          end
+
+          highlighted_fields
+        end
+      end
+
+      def highlight_multiple_fields(text, query)
+        tsquery = ActiveRecord::Base.connection.quote(query)
+
+        dictionary = @options[:dictionary] || "simple"
+
+        raw_options = @options[:multiple_highlight]
+
+        scope_options = raw_options.map { |key, value| "#{key}=#{value}" }.join(", ")
+
+        sanitized_sql = ActiveRecord::Base.send(
+          :sanitize_sql_array, [
+            "SELECT ts_headline(
+              ?, to_tsquery('#{dictionary}', ?),
+              '#{scope_options}'
+              ) AS highlighted_text",
+            text, tsquery
+          ]
+        )
+        ActiveRecord::Base.connection.execute(sanitized_sql).first["highlighted_text"]
+      end
+    end
+  end
+end

data/lib/pg_search_multiple_highlight/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PgSearchMultipleHighlight
+  VERSION = "0.1.0"
+end

data/lib/pg_search_multiple_highlight.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "pg_search"
+require_relative "pg_search_multiple_highlight/version"
+require_relative "pg_search_multiple_highlight/error"
+require_relative "pg_search_multiple_highlight/tsearch"
+require_relative "pg_search_multiple_highlight/scope_options"

data/sig/pg_search_multiple_highlight.rbs

@@ -0,0 +1,4 @@
+module PgSearchMultipleHighlight
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: pg_search_multiple_highlight
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Suleyman Musayev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg_search
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: |-
+  The 'pg_search_multiple_highlight' gem extends the functionality of
+     the popular 'pg_search' gem to overcome its limitation when performing searches against
+     multiple columns and attempting to highlight results. The core issue arises when using
+     the ':highlight' option within the ':tsearch' scope on multiple columns. This gem
+     addresses this limitation by introducing the ':multiple_highlight' option, offering a
+     comprehensive solution for highlighting results across multiple columns.
+
+     Key Features:
+     New Scope Option: The gem introduces the ':multiple_highlight' scope option, allowing
+      users to perform searches on multiple columns and highlight matching terms.
+     Enhanced Search Results: The gem enables the extraction of highlighted results from
+      multiple columns, providing a unified view of highlighted content.
+     Usage Convenience: Users can easily integrate the ':multiple_highlight' option into
+      their existing 'pg_search' queries by calling the '.with_pg_search_multiple_highlight'
+      method on the search object.
+     Flexible Customization: The gem's options can be tailored to match specific
+      highlighting requirements, such as custom start and stop markers for highlighting.
+     Comprehensive Documentation: The README file explains the limitations of 'pg_search'
+      regarding highlighting, demonstrates how the ':multiple_highlight' option resolves
+      this issue, and offers clear usage examples for quick integration.
+email:
+- slmusayev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pg_search_multiple_highlight.rb
+- lib/pg_search_multiple_highlight/error.rb
+- lib/pg_search_multiple_highlight/scope_options.rb
+- lib/pg_search_multiple_highlight/tsearch.rb
+- lib/pg_search_multiple_highlight/version.rb
+- sig/pg_search_multiple_highlight.rbs
+homepage: https://github.com/msuliq/pg_search_multiple_highlight
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/msuliq/pg_search_multiple_highlight
+  source_code_uri: https://github.com/msuliq/pg_search_multiple_highlight
+  changelog_uri: https://github.com/msuliq/pg_search_multiple_highlight/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: The 'pg_search_multiple_highlight' gem enhances the 'pg_search' gem by introducing
+  a new scope option, ':multiple_highlight', which enables highlighting of search
+  results across multiple columns, addressing the limitation of 'pg_search' in handling
+  multiple column searches.
+test_files: []