meilisearch-rails 0.9.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcc344e4fd67e6c871a2bd17a90f9f2ddfd621b455ab25ea4925bd97c797db97
-  data.tar.gz: 6849bd317a751754beab3642c29405d6022da03cb1266fd0b77c6c12e57f5765
+  metadata.gz: cb990c26e799658b655df059ea7a22b4cfc7511a88e7581d72c27841b736f74f
+  data.tar.gz: c2457a258356732877729a9f110a8f392316a98d725d6d052f2dc64824a3ea2f
 SHA512:
-  metadata.gz: a575ccd86876ac883955ec6f660635da5f9927802253d011131e7c16a3e681bd9942740785d16c117cd01e2e919ca036ab7439f84c8d6da609df95dcc3e95afe
-  data.tar.gz: a03067f0ab9e8acfad6ace43421c80e332f118a16b15f8642537e0cc4749aaa04caf7cd33a19064560d0864614cd56807b933b1a06a56f6ceb9a070d4468b2d5
+  metadata.gz: 7499509091a149069f1322e3ceec9c789432c3495d8c2754d258bb17c5cc1d70a410ebcd41e1eb76bcbe50b3c9e301044d0a5e6931e94bdd8779eb290e9eaecf
+  data.tar.gz: 68173b7d7767308144b6987c35c9c2fb75806959a6fcdc3ee3545cab88779d24e013dea0ea0b3b0a3182f8fb9bcd5c7e1634aaf89ecd39f4cb7ad21231b95a0b

data/Gemfile

@@ -13,7 +13,7 @@ group :development do
 end
 
 group :test do
-  rails_version = ENV['RAILS_VERSION'] || '5.2'
+  rails_version = ENV['RAILS_VERSION'] || '6.1'
   sequel_version = ENV['SEQUEL_VERSION'] ? "~> #{ENV['SEQUEL_VERSION']}" : '>= 4.0'
 
   gem 'active_model_serializers'
@@ -31,6 +31,7 @@ group :test do
   gem 'jdbc-sqlite3', platform: :jruby
   gem 'rspec', '~> 3.0'
   gem 'simplecov', require: 'false'
+  gem 'codecov', require: 'false'
   gem 'threads'
 
   gem 'byebug'

data/README.md

@@ -6,17 +6,21 @@
 
 <h4 align="center">
   <a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
+  <a href="https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=integration&utm_medium=meilisearch-rails">Meilisearch Cloud</a> |
   <a href="https://docs.meilisearch.com">Documentation</a> |
   <a href="https://discord.meilisearch.com">Discord</a> |
   <a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
   <a href="https://www.meilisearch.com">Website</a> |
-  <a href="https://docs.meilisearch.com/faq">FAQ</a>
+  <a href="https://www.meilisearch.com/docs/faq">FAQ</a>
 </h4>
 
 <p align="center">
   <a href="https://github.com/meilisearch/meilisearch-rails/actions"><img src="https://github.com/meilisearch/meilisearch-rails/workflows/Tests/badge.svg" alt="Test"></a>
+  <a href="https://app.codecov.io/gh/meilisearch/meilisearch-rails/tree/main" >
+    <img src="https://codecov.io/gh/meilisearch/meilisearch-rails/branch/main/graph/badge.svg?token=9J7LRP11IR"/>
+  </a>
   <a href="https://github.com/meilisearch/meilisearch-rails/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
-  <a href="https://app.bors.tech/repositories/33032"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
+  <a href="https://ms-bors.herokuapp.com/repositories/68"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
 </p>
 
 <p align="center">⚡ The Meilisearch integration for Ruby on Rails 💎</p>
@@ -25,9 +29,10 @@
 
 **Meilisearch** is an open-source search engine. [Learn more about Meilisearch.](https://github.com/meilisearch/meilisearch)
 
-## Table of Contents <!-- omit in toc -->
+## Table of Contents <!-- omit in TOC -->
 
 - [📖 Documentation](#-documentation)
+- [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)
 - [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
 - [🚀 Getting started](#-getting-started)
 - [Compatibility](#-compatibility)
@@ -58,7 +63,11 @@
 
 The whole usage of this gem is detailed in this README.
 
-To learn more about Meilisearch, check out our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).
+To learn more about Meilisearch, check out our [Documentation](https://www.meilisearch.com/docs/learn/tutorials/getting_started.html) or our [API References](https://www.meilisearch.com/docs/reference/api/).
+
+## ⚡ Supercharge your Meilisearch experience
+
+Say goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=integration&utm_medium=meilisearch-rails). No credit card required.
 
 ## 🤖 Compatibility with Meilisearch
 
@@ -66,7 +75,7 @@ This package guarantees compatibility with [version v1.x of Meilisearch](https:/
 
 ## 🔧 Installation <!-- omit in toc -->
 
-This package requires Ruby version 2.6.0 or later and Rails 5.2 or later.
+This package requires Ruby version 2.7.0 or later and Rails 6.1 or later. It may work in older versions but it is not officially supported.
 
 With `gem` in command line:
 ```bash
@@ -82,7 +91,7 @@ gem 'meilisearch-rails'
 
 ### Run Meilisearch <!-- omit in toc -->
 
-There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
+There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/reference/features/installation.html#download-and-launch).
 
 For example, if you use Docker:
 
@@ -101,13 +110,21 @@ Create a new file `config/initializers/meilisearch.rb` to setup your `MEILISEARC
 
 ```ruby
 MeiliSearch::Rails.configuration = {
-  meilisearch_url: 'YourMeilisearchUrl', # example: http://localhost:7700
-  meilisearch_api_key: 'YourMeilisearchAPIKey',
+  meilisearch_url: ENV.fetch('MEILISEARCH_HOST', 'http://localhost:7700'),
+  meilisearch_api_key: ENV.fetch('MEILISEARCH_API_KEY', 'YourMeilisearchAPIKey')
 }
 ```
 
+Or you can run a rake task to create the initializer file for you:
+
+```bash
+bin/rails meilisearch:install
+```
+
 The gem is compatible with [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord), [Mongoid](https://github.com/mongoid/mongoid) and [Sequel](https://github.com/jeremyevans/sequel).
 
+⚠️ Note that even if you want to use all the default options, you must declare an empty `meilisearch` block in your model.  
+
 #### Add documents <!-- omit in toc -->
 
 The following code will create a `Book` index and add search capabilities to your `Book` model.
@@ -123,7 +140,9 @@ class Book < ActiveRecord::Base
 end
 ```
 
-⚠️ Note that even if you want to use all the default options, you must declare an empty `meilisearch` block in your model.
+#### Automatic indexing
+
+As soon as you configure your model as mentioned above, `meilisearch-rails` will keep your database table data in sync with your Meilisearch instance using the `ActiveRecord` callbacks automatically.
 
 #### Basic Backend Search <!-- omit in toc -->
 
@@ -191,11 +210,11 @@ class Book < ApplicationRecord
 end
 ```
 
-Check the dedicated section of the documentation, for more information on the [settings](https://docs.meilisearch.com/reference/features/settings.html).
+Check the dedicated section of the documentation, for more information on the [settings](https://www.meilisearch.com/docs/reference/api/settings#settings_parameters).
 
 ## 🔍 Custom search
 
-All the supported options are described in the [search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html) section of the documentation.
+All the supported options are described in the [search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters) section of the documentation.
 
 ```ruby
 Book.search('Harry', attributes_to_highlight: ['*'])
@@ -310,7 +329,7 @@ Check [`ddnexus/pagy`](https://ddnexus.github.io/pagy/extras/meilisearch) for mo
 
 #### Deactivate Meilisearch in certain moments
 
-By default HTTP connections to the Meilisearch URL is always active, but sometimes you want to disable the HTTP requests in a particular moment or environment.<br>
+By default, HTTP connections to the Meilisearch URL are always active, but sometimes you want to disable the HTTP requests in a particular moment or environment.<br>
 you have multiple ways to achieve this.
 
 By adding `active: false` in the configuration initializer:

data/lib/meilisearch/rails/pagination.rb

@@ -17,7 +17,7 @@ module MeiliSearch
       end
 
       def self.log_pagy_error
-        (::Rails.logger || Logger.new($stdout))
+        MeiliSearch::Rails.logger
           .warning('[meilisearch-rails] Remove `pagination_backend: :pagy` from your initializer, `pagy` it is not required for `pagy`')
       end
 

data/lib/meilisearch/rails/tasks/meilisearch.rake

@@ -19,4 +19,11 @@ namespace :meilisearch do
 
     MeiliSearch::Rails::Utilities.clear_all_indexes
   end
+
+  desc 'Create initializer file'
+  task install: :environment do
+    puts 'Creating initializer file'
+
+    copy_file "#{__dir__}/../templates/initializer.rb", 'config/initializers/meilisearch.rb'
+  end
 end

data/lib/meilisearch/rails/templates/initializer.rb

@@ -0,0 +1,4 @@
+MeiliSearch::Rails.configuration = {
+  meilisearch_url: ENV.fetch('MEILISEARCH_HOST', 'http://localhost:7700'),
+  meilisearch_api_key: ENV.fetch('MEILISEARCH_API_KEY', 'YourMeilisearchAPIKey')
+}

data/lib/meilisearch/rails/version.rb

@@ -2,7 +2,7 @@
 
 module MeiliSearch
   module Rails
-    VERSION = '0.9.1'
+    VERSION = '0.10.2'
 
     def self.qualified_version
       "Meilisearch Rails (v#{VERSION})"

data/lib/meilisearch-rails.rb

@@ -39,6 +39,10 @@ module MeiliSearch
           include InstanceMethods
         end
       end
+
+      def logger
+        @logger ||= (::Rails.logger || Logger.new($stdout))
+      end
     end
 
     class IndexSettings
@@ -48,23 +52,23 @@ module MeiliSearch
 
       # Meilisearch settings
       OPTIONS = %i[
-        searchableAttributes
-        filterableAttributes
-        sortableAttributes
-        displayedAttributes
-        distinctAttribute
+        searchable_attributes
+        filterable_attributes
+        sortable_attributes
+        displayed_attributes
+        distinct_attribute
         synonyms
-        stopWords
-        rankingRules
-        attributesToHighlight
-        attributesToCrop
-        cropLength
+        stop_words
+        ranking_rules
+        attributes_to_highlight
+        attributes_to_crop
+        crop_length
         pagination
         faceting
-        typoTolerance
+        typo_tolerance
       ].freeze
 
-      CAMELIZE_OPTIONS = %i[pagination faceting typoTolerance].freeze
+      CAMELIZE_OPTIONS = %i[pagination faceting typo_tolerance].freeze
 
       OPTIONS.each do |option|
         define_method option do |value|
@@ -265,9 +269,9 @@ module MeiliSearch
       ::MeiliSearch::Index.instance_methods(false).each do |m|
         define_method(m) do |*args, &block|
           if m == :update_settings
-            args[0].delete(:attributesToHighlight) if args[0][:attributesToHighlight]
-            args[0].delete(:attributesToCrop) if args[0][:attributesToCrop]
-            args[0].delete(:cropLength) if args[0][:cropLength]
+            args[0].delete(:attributes_to_highlight) if args[0][:attributes_to_highlight]
+            args[0].delete(:attributes_to_crop) if args[0][:attributes_to_crop]
+            args[0].delete(:crop_length) if args[0][:crop_length]
           end
 
           SafeIndex.log_or_throw(m, @raise_on_failure) do
@@ -304,7 +308,7 @@ module MeiliSearch
         raise e if raise_on_failure
 
         # log the error
-        (::Rails.logger || Logger.new($stdout)).info("[meilisearch-rails] #{e.message}")
+        MeiliSearch::Rails.logger.info("[meilisearch-rails] #{e.message}")
         # return something
         case method.to_s
         when 'search'
@@ -444,6 +448,8 @@ module MeiliSearch
             after_destroy { |searchable| searchable.ms_enqueue_remove_from_index!(ms_synchronous?) }
           end
         end
+
+        warn_searchable_missing_attributes
       end
 
       def ms_without_auto_index(&block)
@@ -581,15 +587,15 @@ module MeiliSearch
       def ms_raw_search(q, params = {})
         index_uid = params.delete(:index) || params.delete('index')
 
-        unless meilisearch_settings.get_setting(:attributesToHighlight).nil?
-          params[:attributesToHighlight] = meilisearch_settings.get_setting(:attributesToHighlight)
+        unless meilisearch_settings.get_setting(:attributes_to_highlight).nil?
+          params[:attributes_to_highlight] = meilisearch_settings.get_setting(:attributes_to_highlight)
         end
 
-        unless meilisearch_settings.get_setting(:attributesToCrop).nil?
-          params[:attributesToCrop] = meilisearch_settings.get_setting(:attributesToCrop)
+        unless meilisearch_settings.get_setting(:attributes_to_crop).nil?
+          params[:attributes_to_crop] = meilisearch_settings.get_setting(:attributes_to_crop)
 
-          unless meilisearch_settings.get_setting(:cropLength).nil?
-            params[:cropLength] = meilisearch_settings.get_setting(:cropLength)
+          unless meilisearch_settings.get_setting(:crop_length).nil?
+            params[:crop_length] = meilisearch_settings.get_setting(:crop_length)
           end
         end
 
@@ -858,6 +864,19 @@ module MeiliSearch
         # We don't know if the attribute has changed, so conservatively assume it has
         true
       end
+
+      def warn_searchable_missing_attributes
+        searchables = meilisearch_settings.get_setting(:searchable_attributes)
+        attrs = meilisearch_settings.get_setting(:attributes)&.keys
+
+        if searchables.present? && attrs.present?
+          (searchables.map(&:to_s) - attrs.map(&:to_s)).each do |missing_searchable|
+            MeiliSearch::Rails.logger.warn(
+              "[meilisearch-rails] #{name}##{missing_searchable} declared in searchable_attributes but not in attributes. Please add it to attributes if it should be searchable."
+            )
+          end
+        end
+      end
     end
 
     # these are the instance methods included

data/meilisearch-rails.gemspec

@@ -34,5 +34,5 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.6.0'
 
-  s.add_dependency 'meilisearch', '~> 0.23.0'
+  s.add_dependency 'meilisearch', '~> 0.26.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: meilisearch
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.26.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.26.0
 description: Meilisearch integration for Ruby on Rails. See https://github.com/meilisearch/meilisearch
 email: bonjour@meilisearch.com
 executables: []
@@ -47,6 +47,7 @@ files:
 - lib/meilisearch/rails/pagination/will_paginate.rb
 - lib/meilisearch/rails/railtie.rb
 - lib/meilisearch/rails/tasks/meilisearch.rake
+- lib/meilisearch/rails/templates/initializer.rb
 - lib/meilisearch/rails/utilities.rb
 - lib/meilisearch/rails/version.rb
 - meilisearch-rails.gemspec
@@ -69,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Meilisearch integration for Ruby on Rails.