search_redux 0.0.4 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 05db95b0f1118f55c5e23b538d535fd045c1f423
-  data.tar.gz: 37ecb95b3b84d3e6654561f917529c8f7455aed7
+SHA256:
+  metadata.gz: 2e38a9e09ad47bb9223780ed4b5abe6f6dba9c1d3436e79942fa92b82787e241
+  data.tar.gz: 0caf36ef1c0d6cdd2acadc8e2edefebf3c3264f644d4c8960ccacd5c51e5de6d
 SHA512:
-  metadata.gz: f83575ea4ced7d460ab58edd6ab1a2651e586e48d717da44ad1af4a7af3b5048646cb436e2295f6a5017a2012773f29a59f49464d814e35ea62825142c40d578
-  data.tar.gz: bf3d3f9024b2e449e73125da20cd223df7478201008d6ed98691f4304285a9717f8b852c7b464bd93d57efc766e5018223c14d9d2c6df28da160071927ce6054
+  metadata.gz: 28b3fdad95a054363fd2608a845f70c0a4f2d11b55b8e97fa5f747bc5f70b5e81f386e434b07cecad761c7560c1fcfbf52de60bcb8eed49fbaf1abf40dfed2db
+  data.tar.gz: 7cf80dae2a11c2497451ce5e1170b0884a623a854c40c9b84ab35d6f8569d77822c457297d2cf31acbef35e2ba2f9d6321f000bf37f154cd64c4cbbf96df6f6e

data/.gitignore

@@ -1,2 +1,3 @@
-*.gem
-*.swp
+*.gem
+*.swp
+*.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -1,3 +1,9 @@
-source 'https://rubygems.org'
-
-gemspec
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'factory_girl'
+  gem 'rspec'
+  gem 'guard-rspec'
+end

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end
+

data/README.md

@@ -1,27 +1,46 @@
-# Full text search redux
-
-The current version is just a code extract of a simple text search logic using  Postgres [functionality](http://www.postgresql.org/docs/8.3/static/textsearch.html) and a simple fallback for other RDBMs (e.g. Mysql)
-
-For now the usage is limited, it expects a `title` and a `content` column.
-
-## Installation
-
-Include the gem in your Gemfile:
-
-```ruby
-gem 'search_redux'
-```
-
-## Quick start
-
-```ruby
-class MyModel
-  act_as_searchable
-end
-
-class MyController
-  def index
-    an_article = MyModel.text_search 'query phrase'
-  end
-end
-```
+# Search redux
+
+A simple way to add full text search to your Rails models. Currently supported RDBMs are [Postgres](http://www.postgresql.org/docs/8.3/static/textsearch.html) anda simple fallback for other RDBMs (e.g. Mysql).
+
+## Requirements
+
+Search redux requires at least Ruby >= 1.9.2 and Rails >= 3.0.0 and Postgres >= 9.2.
+
+## Installation
+
+Include the gem in your Gemfile:
+
+```ruby
+gem 'search_redux'
+```
+
+## Quick start
+
+In your model call the `act_as_searchable` with the columns that you want to search and the column for rank-based ordering.
+
+```ruby
+class MyModel
+  act_as_searchable :columns => %w(title content), :rank => 'title'
+end
+```
+
+You can easily search via the `text_search` method.
+
+```ruby
+class MyController
+  def index
+    an_article = MyModel.text_search 'query phrase'
+  end
+end
+```
+
+## License (MIT) 
+
+Copyright (c) 2022 Marian Posaceanu 
+
+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/lib/search_redux/errors.rb

@@ -1,9 +1,9 @@
-module SearchRedux
-  class Error < StandardError; end
-
-  module Errors
-    class ActAsSearchableUnintialized < SearchRedux::Error; end
-
-    class NoQuery < SearchRedux::Error; end
-  end
-end
+module SearchRedux
+  class Error < StandardError; end
+
+  module Errors
+    class ActAsSearchableUnintialized < SearchRedux::Error; end
+
+    class NoQuery < SearchRedux::Error; end
+  end
+end

data/lib/search_redux/glue.rb

@@ -1,7 +1,7 @@
-module SearchRedux
-  module Glue
-    def self.included(base)
-      base.extend ClassMethods
-    end
-  end
-end
+module SearchRedux
+  module Glue
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  end
+end

data/lib/search_redux/helpers.rb

@@ -1,16 +1,16 @@
-module SearchRedux
-  module Helpers
-    def select_best_query_strategy(adapter, query)
-      case adapter
-      when /mysql.*/i
-        SearchRedux::Mysql.compatible_search(query)
-      when /postgres.*/i
-        SearchRedux::Postgres.compatible_search(query)
-      end
-    end
-
-    def db_adapter
-      ActiveRecord::Base::connection.adapter_name
-    end
-  end
-end
+module SearchRedux
+  module Helpers
+    def select_best_query_strategy(adapter, query)
+      case adapter
+      when /mysql.*/i
+        SearchRedux::Mysql.compatible_search(query)
+      when /postgres.*/i
+        SearchRedux::Postgres.compatible_search(query)
+      end
+    end
+
+    def db_adapter
+      ActiveRecord::Base::connection.adapter_name
+    end
+  end
+end

data/lib/search_redux/railtie.rb

@@ -1,20 +1,17 @@
-module SearchRedux
-  require 'rails'
-
-  class Railtie < Rails::Railtie
-    initializer 'search_redux.insert_into_active_record' do |app|
-      SearchRedux::Railtie.insert
-    end
-
-    # rake_tasks { load 'tasks/search_redux.rake' }
-  end
-
-  class Railtie
-    def self.insert
-      if defined? ActiveRecord
-        # do the dew
-        ActiveRecord::Base.send(:include, SearchRedux::Glue)
-      end
-    end
-  end
-end
+module SearchRedux
+  require 'rails'
+
+  class Railtie < Rails::Railtie
+    initializer 'search_redux.insert_into_active_record' do |app|
+      SearchRedux::Railtie.insert
+    end
+  end
+
+  class Railtie
+    def self.insert
+      if defined? ActiveRecord
+        ActiveRecord::Base.send(:include, SearchRedux::Glue)
+      end
+    end
+  end
+end

data/lib/search_redux/rdbms/mysql.rb

@@ -1,7 +1,7 @@
-module SearchRedux
-  class Mysql
-    def self.compatible_search(query)
-      ->(obj) { obj.where("title like :q or content like :q", q: "%#{query}%") }
-    end
-  end
-end
+module SearchRedux
+  class Mysql
+    def self.compatible_search(query)
+      ->(obj) { obj.where("title like :q or content like :q", q: "%#{query}%") }
+    end
+  end
+end

data/lib/search_redux/rdbms/postgres.rb

@@ -1,30 +1,31 @@
-module SearchRedux
-  class Postgres
-    class << self
-      attr_accessor :sanitized_query
-
-      def compatible_search(options)
-        query           = options[:query]
-
-        rank_query      = rank_sql options[:rank], query
-        search_query    = search_sql options[:columns]
-
-        ->(obj) { obj.where(search_query, q: query).order(rank_query) }
-      end
-
-      def rank_sql(rank_column, query)
-        sanitized_query = ActionController::Base.helpers.sanitize(query)
-
-        "ts_rank(to_tsvector(#{rank_column}), plainto_tsquery('#{sanitized_query}')) desc"
-      end
-
-      def search_sql(columns)
-        template = ->(column_name) {
-          return "to_tsvector('english', #{column_name}) @@ plainto_tsquery(:q)"
-        }
-
-        columns.map { |c| template.call(c) }.join(' OR ')
-      end
-    end
-  end
-end
+module SearchRedux
+  class Postgres
+    class << self
+      attr_accessor :sanitized_query
+
+      def compatible_search(options)
+        query        = to_ts_query(options[:query])
+        rank_query   = rank_sql(options[:rank], query)
+        search_query = search_sql(options[:columns])
+
+        ->(obj) { obj.where(Arel.sql(search_query), q: Arel.sql(query)).order(Arel.sql(rank_query)) }
+      end
+
+      def to_ts_query(query)
+        query.split.map { |ts| "#{ts}:*" }.join(" & ")
+      end
+
+      def rank_sql(rank_column, query)
+        "ts_rank(to_tsvector(#{rank_column}), to_tsquery('#{query}')) desc"
+      end
+
+      def search_sql(columns)
+        template = ->(column_name) {
+          return "to_tsvector('english', #{column_name}) @@ to_tsquery(:q)"
+        }
+
+        columns.map { |c| template.call(c) }.join(' OR ')
+      end
+    end
+  end
+end

data/lib/search_redux/searchable.rb

@@ -1,35 +1,35 @@
-module SearchRedux
-  extend Helpers
-
-  class Searchable
-    attr_accessor :columns
-    attr_accessor :rank
-    attr_reader   :options
-
-    def self.default_options
-      @default_options ||= {
-        :columns => %w(title content),
-        :rank    => 'title'
-      }
-    end
-
-    def initialize(options = {})
-      options = self.class.default_options.merge(options)
-
-      @options = options
-    end
-
-    def full_text_search(query, active_record_instance)
-      if query.present?
-        @options.merge! :query => query
-
-        adapter  = SearchRedux.db_adapter
-        strategy = SearchRedux.select_best_query_strategy(adapter, @options)
-
-        strategy.call(active_record_instance)
-      else
-        active_record_instance.scoped
-      end
-    end
-  end
-end
+module SearchRedux
+  extend Helpers
+
+  class Searchable
+    attr_accessor :columns
+    attr_accessor :rank
+    attr_reader   :options
+
+    def self.default_options
+      @default_options ||= {
+        :columns => %w(title content),
+        :rank    => 'title'
+      }
+    end
+
+    def initialize(options = {})
+      options = self.class.default_options.merge(options)
+
+      @options = options
+    end
+
+    def full_text_search(query, active_record_instance)
+      if query.present?
+        @options.merge! :query => query
+
+        adapter  = SearchRedux.db_adapter
+        strategy = SearchRedux.select_best_query_strategy(adapter, @options)
+
+        strategy.call(active_record_instance)
+      else
+        active_record_instance.scoped
+      end
+    end
+  end
+end

data/lib/search_redux/version.rb

@@ -1,3 +1,3 @@
-module SearchRedux
-  VERSION = '0.0.4' unless defined? SearchRedux::VERSION
-end
+module SearchRedux
+  VERSION = '1.0.2' unless defined? SearchRedux::VERSION
+end

data/lib/search_redux.rb

@@ -1,27 +1,27 @@
-require 'search_redux/version'
-require 'search_redux/errors'
-require 'search_redux/helpers'
-require 'search_redux/glue'
-require 'search_redux/searchable'
-require 'search_redux/rdbms/mysql'
-require 'search_redux/rdbms/postgres'
-
-require 'search_redux/railtie'
-
-module SearchRedux
-  extend Helpers
-
-  module ClassMethods
-    def act_as_searchable(options = {})
-      attr_accessor :searchable
-
-      @searchable = SearchRedux::Searchable.new options
-    end
-
-    def text_search(query)
-      raise(Errors::ActAsSearchableUnintialized, 'Use act_as_searchable') unless @searchable
-
-      @searchable.full_text_search(query, self)
-    end
-  end
-end
+require 'search_redux/version'
+require 'search_redux/errors'
+require 'search_redux/helpers'
+require 'search_redux/glue'
+require 'search_redux/searchable'
+require 'search_redux/rdbms/mysql'
+require 'search_redux/rdbms/postgres'
+
+require 'search_redux/railtie'
+
+module SearchRedux
+  extend Helpers
+
+  module ClassMethods
+    def act_as_searchable(options = {})
+      attr_accessor :searchable
+
+      @searchable = SearchRedux::Searchable.new options
+    end
+
+    def text_search(query)
+      raise(Errors::ActAsSearchableUnintialized, 'Use act_as_searchable') unless @searchable
+
+      @searchable.full_text_search(query, self)
+    end
+  end
+end

data/search_redux.gemspec

@@ -1,22 +1,23 @@
-$LOAD_PATH.push File.expand_path("../lib", __FILE__)
-require 'search_redux/version'
-
-Gem::Specification.new do |s|
-  s.name          = 'search_redux'
-  s.version       = SearchRedux::VERSION
-  s.platform      = Gem::Platform::RUBY
-  s.summary       = 'Add a text_search method to your models.'
-  s.description   = 'Simple ActiveRecord full text search.'
-  s.author        = 'Marian Posaceanu'
-  s.email         = 'contact@marianposaceanu.com'
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.require_paths = ['lib']
-  s.homepage      = 'https://github.com/dakull/search_redux'
-
-  s.required_ruby_version = '>= 1.9.2'
-
-  s.add_dependency('activerecord', '>= 3.0.0')
-  s.add_dependency('activemodel', '>= 3.0.0')
-  s.add_dependency('activesupport', '>= 3.0.0')
-end
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require 'search_redux/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'search_redux'
+  s.version       = SearchRedux::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.licenses      = ['MIT']
+  s.summary       = 'Add a text_search method to your models.'
+  s.description   = 'Simple ActiveRecord full text search.'
+  s.author        = 'Marian Posaceanu'
+  s.email         = 'contact@marianposaceanu.com'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage      = 'https://github.com/dakull/search_redux'
+
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.add_runtime_dependency 'activerecord', '>= 5.0.0'
+  s.add_runtime_dependency 'activemodel', '>= 5.0.0'
+  s.add_runtime_dependency 'activesupport', '>= 5.0.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,65 +1,67 @@
 --- !ruby/object:Gem::Specification
 name: search_redux
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.2
 platform: ruby
 authors:
 - Marian Posaceanu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-05-19 00:00:00.000000000 Z
+date: 2023-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0
 description: Simple ActiveRecord full text search.
 email: contact@marianposaceanu.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
 - Gemfile
+- Guardfile
 - README.md
 - lib/search_redux.rb
 - lib/search_redux/errors.rb
@@ -71,27 +73,29 @@ files:
 - lib/search_redux/searchable.rb
 - lib/search_redux/version.rb
 - search_redux.gemspec
+- spec/spec_helper.rb
 homepage: https://github.com/dakull/search_redux
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.0
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Add a text_search method to your models.
-test_files: []
+test_files:
+- spec/spec_helper.rb