meilisearch-rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1562941b9f5cf4cb5a13085147f5b9b9ba1b3ea04587f6d1c520239ae5362236
-  data.tar.gz: 57106ef19a839131d89e45bbb3d01f6aeef6fca623f3d803ade4f63282c2221d
+  metadata.gz: 9e05e5ed1e5210587bd2797412b0f5509b77151a620b79e4e8047c6c1722c3fb
+  data.tar.gz: cfb5a6a39cf21caa0532ae40d005a8c7fd3fff30dbbfa02c90dd1f31f63259df
 SHA512:
-  metadata.gz: 2d33ff75ad9c5dc9eeab0c602bdfc5fa8f80b1d14d3a025105cf04c7c2e644a1309e68cbff56452eeea5c1801e13fc58d11f8dd529b02bd6ac14e3baf4c30d20
-  data.tar.gz: 02720ef33a1a0da9cc309f04c24129c87b9f1d885e9d8ff4386ba0873f1aec14e88373bbabe8eae279627a76e573046d4ae445ac1837efffda39b7a458e33fa3
+  metadata.gz: 7a3e738a240fcbdc903d3a58acc9d5d68992a5e1adb56401fcd30a03e81c1fddbcc2024bed1338934de84d366ef58cc9e069243ad6ab5ca78c1330414e4a90b9
+  data.tar.gz: 88228f931aafcbdd69fa483594c3842aaf7603dac277333107dc8629656e96f2fb0b0b57d84039b81b922f95cc9ef6322fb5745a4626058f135357779e227e0c

data/Gemfile

@@ -1,31 +1,38 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 gem 'json', '~> 2.5', '>= 2.5.1'
-gem 'meilisearch', '~> 0.15.3'
+gem 'meilisearch', '~> 0.17.0'
 
-if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
-  gem 'rubysl', '~> 2.0', :platform => :rbx
+gem 'rubysl', '~> 2.0', platform: :rbx if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+
+group :development do
+  gem 'rubocop', '~> 1.22'
+  gem 'rubocop-rails'
+  gem 'rubocop-rspec'
 end
 
 group :test do
-  rails_version = ENV["RAILS_VERSION"] || '5.2'
-  gem 'rails', "~> #{rails_version}"
+  rails_version = ENV['RAILS_VERSION'] || '5.2'
+  sequel_version = ENV['SEQUEL_VERSION'] ? "~> #{ENV['SEQUEL_VERSION']}" : '>= 4.0'
+
   gem 'active_model_serializers'
+  gem 'rails', "~> #{rails_version}"
+  gem 'sequel', sequel_version
+
   if Gem::Version.new(rails_version) >= Gem::Version.new('6.0')
-    gem 'sqlite3', '~> 1.4.0', :platform => [:rbx, :ruby]
+    gem 'sqlite3', '~> 1.4.0', platform: %i[rbx ruby]
   else
-    gem 'sqlite3', '< 1.4.0', :platform => [:rbx, :ruby]
+    gem 'sqlite3', '< 1.4.0', platform: %i[rbx ruby]
   end
+
+  gem 'activerecord-jdbc-adapter', platform: :jruby
+  gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+  gem 'jdbc-sqlite3', platform: :jruby
   gem 'rspec', '>= 2.5.0', '< 3.0'
-  gem 'jdbc-sqlite3', :platform => :jruby
-  gem 'activerecord-jdbc-adapter', :platform => :jruby
-  gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
 
-  sequel_version = ENV['SEQUEL_VERSION'] ? "~> #{ENV['SEQUEL_VERSION']}" : '>= 4.0'
-  gem 'sequel', sequel_version
+  gem 'byebug'
+  gem 'dotenv', '~> 2.7', '>= 2.7.6'
   gem 'faker', '~> 2.17'
-  gem 'will_paginate', '>= 2.3.15'
   gem 'kaminari'
-  gem 'dotenv', '~> 2.7', '>= 2.7.6'
-  gem 'byebug'
+  gem 'will_paginate', '>= 2.3.15'
 end

data/README.md

@@ -29,33 +29,26 @@
 
 - [📖 Documentation](#-documentation)
 - [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
-- [🔧 Installation](#-installation)
-- [🔩 Settings](#-settings)
+- [🚀 Getting Started](#-getting-started)
+- [⚙️ Settings](#️-settings)
 - [🔍 Custom search](#-custom-search)
 - [🪛 Options](#-options)
-  - [MeiliSearch configuration & environment](#meilisearch-configuration-&-environment)
-    - [Custom index_uid](#custom-index_uid)
-    - [Per-environment index_uid](#per-environment-index_uid)
+  - [MeiliSearch configuration & environment](#meilisearch-configuration--environment)
   - [Index configuration](#index-configuration)
     - [Custom attribute definition](#custom-attribute-definition)
     - [Custom primary key](#custom-primary-key)
     - [Conditional indexing](#conditional-indexing)
-      - [Target multiple indexes](#target-multiple-indexes)
     - [Share a single index](#share-a-single-index)
-    - [Queues & background jobs](#queues-&-background-jobs)
+    - [Queues & background jobs](#queues--background-jobs)
     - [Relations](#relations)
     - [Sanitize attributes](#sanitize-attributes)
     - [UTF-8 encoding](#utf-8-encoding)
   - [Manual operations](#manual-operations)
-    - [Indexing & deletion](#indexing-&-deletion)
+    - [Indexing & deletion](#indexing--deletion)
     - [Access the underlying index object](#access-the-underlying-index-object)
-  - [Development & testing](#development-&-testing)
-    - [Exceptions](#exceptions)
-    - [Testing](#testing)
-      - [Synchronous testing](#synchronous-testing)
-      - [Disable auto-indexing & auto-removal](#disable-auto-indexing-&-auto-removal)
-- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
-- [👏 Credits](#-credits)
+  - [Development & testing](#development--testing)
+- [⚙️ Development workflow & contributing](#️-development-workflow--contributing)
+- [👏  Credits](#--credits)
 
 ## 📖 Documentation
 
@@ -65,9 +58,9 @@ To learn more about MeiliSearch, check out our [Documentation](https://docs.meil
 
 ## 🤖 Compatibility with MeiliSearch
 
-This package only guarantees the compatibility with the [version v0.20.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.20.0).
+This package only guarantees the compatibility with the [version v0.24.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.24.0).
 
-## 🔧 Installation
+## 🔧 Installation <!-- omit in toc -->
 
 This package requires Ruby version 2.6.0 or later and Rails 5.2 or later.
 
@@ -104,8 +97,8 @@ Create a new file `config/initializers/meilisearch.rb` to setup your `MEILISEARC
 
 ```ruby
 MeiliSearch.configuration = {
-    meilisearch_host: 'YourMeiliSearchHost',
-    meilisearch_api_key: 'YourMeiliSearchAPIKey',
+  meilisearch_host: 'YourMeiliSearchHost', # example: http://localhost:7700
+  meilisearch_api_key: 'YourMeiliSearchAPIKey',
 }
 ```
 
@@ -183,7 +176,21 @@ The **number of hits per page defaults to 20**, you can customize it by adding t
 Book.search('harry potter', hitsPerPage: 10)
 ```
 
-##  ⚙️ Settings
+#### Extra Configuration <!-- omit in toc -->
+
+Requests made to MeiliSearch may timeout and retry. To adapt the behavior to
+your needs, you can change the parameters during configuration:
+
+```ruby
+MeiliSearch.configuration = {
+  meilisearch_host: 'YourMeiliSearchHost',
+  meilisearch_api_key: 'YourMeiliSearchAPIKey',
+  timeout: 2,
+  max_retries: 1,
+}
+```
+
+## ⚙️ Settings
 
 You can configure the index settings by adding them inside the `meilisearch` block as shown below:
 
@@ -193,15 +200,15 @@ class Book < ApplicationRecord
 
   meilisearch do
     searchable_attributes [:title, :author, :publisher, :description]
-    attributes_for_faceting [:genre]
+    filterable_attributes [:genre]
     ranking_rules [
       'proximity',
       'typo',
       'words',
       'attribute',
-      'wordsPosition',
+      'sort',
       'exactness',
-      'desc(publication_year)'
+      'publication_year:desc'
     ]
     synonyms nyc: ['new york']
 
@@ -220,7 +227,7 @@ Check the dedicated section of the documentation, for more information on the [s
 All the supported options are described in the [search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html) section of the documentation.
 
 ```ruby
-Book.search('Harry', filters: 'author = J. K. Rowling')
+Book.search('Harry', attributesToHighlight: ['*'])
 ```
 👉 Don't forget that `attributes_to_highlight`, `attributes_to_crop`, and
 `crop_length` can be set up in the `meilisearch` block of your model.
@@ -229,7 +236,7 @@ Book.search('Harry', filters: 'author = J. K. Rowling')
 
 ### MeiliSearch configuration & environment
 
-#### Custom index_uid
+#### Custom index_uid <!-- omit in toc -->
 
 By default, the **index_uid** will be the class name, e.g. `Book`. You can customize the index_uid by using the `index_uid:` option.
 
@@ -242,7 +249,7 @@ class Book < ActiveRecord::Base
 end
 ```
 
-#### Index UID according to the environment
+#### Index UID according to the environment <!-- omit in toc -->
 
 You can suffix the index UID with the current Rails environment using the following option:
 
@@ -270,13 +277,13 @@ class Author < ApplicationRecord
   meilisearch do
     attribute :first_name, :last_name
     attribute :full_name do
-      '#{first_name} #{last_name}'
+      "#{first_name} #{last_name}"
     end
     add_attribute :full_name_reversed
   end
 
   def full_name_reversed
-    '#{last_name} #{first_name}'
+    "#{last_name} #{first_name}"
   end
 
   def will_save_change_to_full_name?
@@ -328,7 +335,7 @@ class Book < ActiveRecord::Base
   end
 end
 ```
-##### Target multiple indexes
+##### Target multiple indexes <!-- omit in toc -->
 
 You can index a record in several indexes using the `add_index` option:
 
@@ -624,7 +631,7 @@ index = Book.index
 
 ### Development & testing
 
-#### Exceptions
+#### Exceptions <!-- omit in toc -->
 
 You can disable exceptions that could be raised while trying to reach MeiliSearch's API by using the `raise_on_failure` option:
 
@@ -638,9 +645,9 @@ class Book < ActiveRecord::Base
 end
 ```
 
-#### Testing
+#### Testing <!-- omit in toc -->
 
-##### Synchronous testing
+##### Synchronous testing <!-- omit in toc -->
 
 You can force indexing and removing to be synchronous by setting the following option:
 
@@ -654,7 +661,7 @@ end
 ```
 🚨 This is only recommended for testing purposes, the gem will call the `wait_for_pending_update` method that will stop your code execution until the asynchronous task has been processed by MeilSearch.
 
-##### Disable auto-indexing & auto-removal
+##### Disable auto-indexing & auto-removal <!-- omit in toc -->
 
 You can disable auto-indexing and auto-removing setting the following options:
 

data/Rakefile

@@ -2,8 +2,9 @@ require 'rubygems'
 require 'rake'
 
 require 'rdoc/task'
+
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "MeiliSearch Rails #{version}"
@@ -11,7 +12,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-require "rspec/core/rake_task"
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/meilisearch/configuration.rb

@@ -1,15 +1,21 @@
 module MeiliSearch
   module Configuration
     def configuration
-      @@configuration || raise(NotConfigured, "Please configure MeiliSearch. Set MeiliSearch.configuration = {meilisearch_host: 'YOUR_MEILISEARCH_HOST', meilisearch_api_key: 'YOUR_API_KEY'}")
+      raise NotConfigured if @_config.blank?
+
+      @_config
     end
 
     def configuration=(configuration)
-      @@configuration = configuration
+      @_config = configuration
     end
 
     def client
-      ::MeiliSearch::Client.new(@@configuration[:meilisearch_host], @@configuration[:meilisearch_api_key])
+      ::MeiliSearch::Client.new(
+        configuration[:meilisearch_host] || 'http://localhost:7700',
+        configuration[:meilisearch_api_key],
+        configuration.slice(:timeout, :max_retries)
+      )
     end
   end
 end

data/lib/meilisearch/errors.rb

@@ -0,0 +1,12 @@
+module MeiliSearch
+  class NoBlockGiven < StandardError; end
+
+  class BadConfiguration < StandardError; end
+
+  class NotConfigured < StandardError
+    def message
+      'Please configure MeiliSearch. Set MeiliSearch.configuration = ' \
+        "{meilisearch_host: 'YOUR_MEILISEARCH_HOST', meilisearch_api_key: 'YOUR_API_KEY'}"
+    end
+  end
+end

data/lib/meilisearch/pagination/kaminari.rb

@@ -1,23 +1,27 @@
 unless defined? Kaminari
-  raise(MeiliSearch::BadConfiguration, "MeiliSearch: Please add 'kaminari' to your Gemfile to use kaminari pagination backend")
+  raise(MeiliSearch::BadConfiguration,
+        "MeiliSearch: Please add 'kaminari' to your Gemfile to use kaminari pagination backend")
 end
 
-require "kaminari/models/array_extension"
+require 'kaminari/models/array_extension'
 
 module MeiliSearch
   module Pagination
     class Kaminari < ::Kaminari::PaginatableArray
-
       def initialize(array, options)
-        super(array, options)
+        if RUBY_VERSION >= '3'
+          super(array, **options)
+        else
+          super(array, options)
+        end
       end
 
-      def limit(num)
+      def limit(_num)
         # noop
         self
       end
 
-      def offset(num)
+      def offset(_num)
         # noop
         self
       end
@@ -26,12 +30,14 @@ module MeiliSearch
         def create(results, total_hits, options = {})
           offset = ((options[:page] - 1) * options[:per_page])
           array = new results, limit: options[:per_page], offset: offset, total_count: total_hits
-          if array.empty? and !results.empty?
+
+          if array.empty? && !results.empty?
             # since Kaminari 0.16.0, you need to pad the results with nil values so it matches the offset param
             # otherwise you'll get an empty array: https://github.com/amatsuda/kaminari/commit/29fdcfa8865f2021f710adaedb41b7a7b081e34d
             results = ([nil] * offset) + results
             array = new results, offset: offset, limit: options[:per_page], total_count: total_hits
           end
+
           array
         end
       end

data/lib/meilisearch/pagination/will_paginate.rb

@@ -1,14 +1,15 @@
 begin
   require 'will_paginate/collection'
 rescue LoadError
-  raise(MeiliSearch::BadConfiguration, "MeiliSearch: Please add 'will_paginate' to your Gemfile to use will_paginate pagination backend")
+  raise(MeiliSearch::BadConfiguration,
+        "MeiliSearch: Please add 'will_paginate' to your Gemfile to use will_paginate pagination backend")
 end
 
 module MeiliSearch
   module Pagination
     class WillPaginate
       def self.create(results, total_hits, options = {})
-        ::WillPaginate::Collection.create(options[:page], options[:per_page], total_hits) do  |pager|
+        ::WillPaginate::Collection.create(options[:page], options[:per_page], total_hits) do |pager|
           start = (options[:page] - 1) * options[:per_page]
           paginated_results = results[start, options[:per_page]]
           pager.replace paginated_results

data/lib/meilisearch/pagination.rb

@@ -1,19 +1,18 @@
 module MeiliSearch
   module Pagination
-
     autoload :WillPaginate, 'meilisearch/pagination/will_paginate'
     autoload :Kaminari, 'meilisearch/pagination/kaminari'
 
     def self.create(results, total_hits, options = {})
       return results if MeiliSearch.configuration[:pagination_backend].nil?
+
       begin
-        backend = MeiliSearch.configuration[:pagination_backend].to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase } # classify pagination backend name
-        page = Object.const_get(:MeiliSearch).const_get(:Pagination).const_get(backend).create(results, total_hits, options)
-        page
+        backend = MeiliSearch.configuration[:pagination_backend].to_s.classify
+
+        ::MeiliSearch::Pagination.const_get(backend).create(results, total_hits, options)
       rescue NameError
-        raise(BadConfiguration, "Unknown pagination backend")
+        raise(BadConfiguration, 'Unknown pagination backend')
       end
     end
-    
   end
 end

data/lib/meilisearch/railtie.rb

@@ -3,9 +3,10 @@ require 'rails'
 module MeiliSearch
   class Railtie < Rails::Railtie
     rake_tasks do
-      load "meilisearch/tasks/meilisearch.rake"
+      load 'meilisearch/tasks/meilisearch.rake'
     end
   end
+
   class Engine < Rails::Engine
   end
 end

data/lib/meilisearch/tasks/meilisearch.rake

@@ -1,19 +1,17 @@
 namespace :meilisearch do
-
-  desc "Reindex all models"
-  task :reindex => :environment do
+  desc 'Reindex all models'
+  task reindex: :environment do
     MeiliSearch::Utilities.reindex_all_models
   end
 
-  desc "Set settings to all indexes"
-  task :set_all_settings => :environment do
+  desc 'Set settings to all indexes'
+  task set_all_settings: :environment do
     MeiliSearch::Utilities.set_settings_all_models
   end
-  
-  desc "Clear all indexes"
-  task :clear_indexes => :environment do
-    puts "clearing all indexes"
+
+  desc 'Clear all indexes'
+  task clear_indexes: :environment do
+    puts 'clearing all indexes'
     MeiliSearch::Utilities.clear_all_indexes
   end
-
 end

data/lib/meilisearch/utilities.rb

@@ -7,42 +7,38 @@ module MeiliSearch
         elsif Rails.application
           Rails.application.eager_load!
         end
-        MeiliSearch.instance_variable_get :@included_in
+        klasses = MeiliSearch.instance_variable_get(:@included_in)
+        (klasses + klasses.map(&:descendants).flatten).uniq
       end
 
       def clear_all_indexes
-        get_model_classes.each do |klass|
-          klass.clear_index!
-        end
+        get_model_classes.each(&:clear_index!)
       end
 
       def reindex_all_models
         klasses = get_model_classes
 
-        puts ''
-        puts "Reindexing #{klasses.count} models: #{klasses.to_sentence}."
-        puts ''
+        Rails.logger.info "\n\nReindexing #{klasses.count} models: #{klasses.to_sentence}.\n"
 
         klasses.each do |klass|
-          puts klass
-          puts "Reindexing #{klass.count} records..."
-          klass.ms_reindex
+          Rails.logger.info klass
+          Rails.logger.info "Reindexing #{klass.count} records..."
+
+          klass.ms_reindex!
         end
       end
 
       def set_settings_all_models
         klasses = get_model_classes
 
-        puts ''
-        puts "Pushing settings for #{klasses.count} models: #{klasses.to_sentence}."
-        puts ''
+        Rails.logger.info "\n\nPushing settings for #{klasses.count} models: #{klasses.to_sentence}.\n"
 
         klasses.each do |klass|
-          puts "Pushing #{klass} settings..."
+          Rails.logger.info "Pushing #{klass} settings..."
+
           klass.ms_set_settings
         end
       end
     end
   end
 end
-

data/lib/meilisearch/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MeiliSearch
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end