meilisearch-rails 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ad6c51de59755b283d9371028f127537f8eae862603d65469f3867e7e62b6ec
-  data.tar.gz: a2ef9d38103f8e2750e687f1fae309818b210576b63c6951b913b7856c713598
+  metadata.gz: c0d3aeaf9f6e2549c11cdcd7cf5920fecb819fb1b2f03a25af11c19a5dd09444
+  data.tar.gz: 0af07156e3e3ea69d492745f806751e2213ad7148553f57396528ad54fa3f02a
 SHA512:
-  metadata.gz: 5720f087c6c85aa34b553ba01614968fe4862a416c6e72c1829b4107470862a30db4e4107455d2a45ab94497ff69b084460196f6173c4f584aa1364769a0564a
-  data.tar.gz: 5cebff7daa2d2caf3ed62e9a49fe4f3f17d4ccf2b6dcfed90f92645fdac4c7d8adddea521aff563aca9f454942529b1444c9fea092fd329e2cfda187ef885eba
+  metadata.gz: a49c6d3b48de31033515e61c9fd182842d5d7d7ba90e140b6447339eeb6473139f3de4f1c3428f48a9176f3c36c5080ebc198897f4b53900f74e416bb817eaf1
+  data.tar.gz: 63805d38ba88e0b020a0a147cce244ec35a0fb2a93715ff5b62df77ca87021b2b11581647626b2c76eaddc26ad15ab0a8e9d4e82c7e1895095829b7cce74965c

data/Gemfile

@@ -1,14 +1,13 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
-gem 'json', '~> 2.5', '>= 2.5.1'
-gem 'meilisearch', '~> 0.18.0'
+gemspec
 
 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'
+  gem 'rubocop', '1.27.0'
+  gem 'rubocop-rails', '2.13.2'
+  gem 'rubocop-rspec', '2.9.0'
 end
 
 group :test do

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Meilisearch
+Copyright (c) 2021-2022 Meili SAS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -58,7 +58,7 @@ 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.25.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.25.0).
+This package only guarantees the compatibility with the [version v0.27.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.27.0).
 
 ## 🔧 Installation <!-- omit in toc -->
 
@@ -84,7 +84,7 @@ For example, if you use Docker:
 
 ```bash
 docker pull getmeili/meilisearch:latest # Fetch the latest version of Meilisearch image from Docker Hub
-docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
+docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest meilisearch --master-key=masterKey
 ```
 
 NB: you can also download Meilisearch from **Homebrew** or **APT**.
@@ -170,10 +170,10 @@ Then, as soon as you use the `search` method, the returning results will be pagi
 <%= will_paginate @hits %> # if using will_paginate
 ```
 
-The **number of hits per page defaults to 20**, you can customize it by adding the `hitsPerPage` parameter to your search:
+The **number of hits per page defaults to 20**, you can customize it by adding the `hits_per_page` parameter to your search:
 
 ```ruby
-Book.search('harry potter', hitsPerPage: 10)
+Book.search('harry potter', hits_per_page: 10)
 ```
 
 #### Extra Configuration <!-- omit in toc -->
@@ -228,7 +228,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', attributesToHighlight: ['*'])
+Book.search('Harry', attributes_to_highlight: ['*'])
 ```
 👉 Don't forget that `attributes_to_highlight`, `attributes_to_crop`, and
 `crop_length` can be set up in the `meilisearch` block of your model.
@@ -256,24 +256,36 @@ By default, the **index_uid** will be the class name, e.g. `Book`. You can custo
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch index_uid: 'MyCustomUID' do
-  end
+  meilisearch index_uid: 'MyCustomUID'
 end
 ```
 
 #### Index UID according to the environment <!-- omit in toc -->
 
-You can suffix the index UID with the current Rails environment using the following option:
+You can suffix the index UID with the current Rails environment using one of the following options:
+
+By defining directly in your model:
 
 ```ruby
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch per_environment: true do # The index UID will be "Book_#{Rails.env}"
-  end
+  meilisearch per_environment: true
 end
 ```
 
+Or setting it globally:
+
+```ruby
+MeiliSearch::Rails.configuration = {
+  meilisearch_host: 'YourMeilisearchHost',
+  meilisearch_api_key: 'YourMeilisearchAPIKey',
+  per_environment: true
+}
+```
+
+Both options will make your index name look like this `"Book_#{Rails.env}"`.
+
 ### Index configuration
 
 #### Custom attribute definition
@@ -318,8 +330,7 @@ Note that the primary key must have a **unique value**.
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch primary_key: 'ISBN' do
-  end
+  meilisearch primary_key: 'ISBN'
 end
 ```
 #### Conditional indexing
@@ -331,8 +342,7 @@ As soon as you use those constraints, `add_documents` and `delete_documents` cal
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch if: :published?, unless: :premium? do
-  end
+  meilisearch if: :published?, unless: :premium?
 
   def published?
     # [...]
@@ -369,6 +379,7 @@ class Book < ActiveRecord::Base
   end
 
   private
+
   def public?
     released? && !premium?
   end
@@ -383,10 +394,10 @@ You may want to share an index between several models. You'll need to ensure you
 class Cat < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch index_uid: 'Animals', primary_key: :ms_id do
-  end
+  meilisearch index_uid: 'Animals', primary_key: :ms_id
 
   private
+
   def ms_id
     "cat_#{primary_key}" # ensure the cats & dogs primary_keys are not conflicting
   end
@@ -395,10 +406,10 @@ end
 class Dog < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch index_uid: 'Animals', primary_key: :ms_id do
-  end
+  meilisearch index_uid: 'Animals', primary_key: :ms_id
 
   private
+
   def ms_id
     "dog_#{primary_key}" # ensure the cats & dogs primary_keys are not conflicting
   end
@@ -413,8 +424,7 @@ You can configure the auto-indexing & auto-removal process to use a queue to per
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch enqueue: true do # ActiveJob will be triggered using a `meilisearch` queue
-  end
+  meilisearch enqueue: true # ActiveJob will be triggered using a `meilisearch` queue
 end
 ```
 
@@ -458,16 +468,16 @@ With [**Sidekiq**](https://github.com/mperham/sidekiq):
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch enqueue: :trigger_sidekiq_worker do
+  meilisearch enqueue: :trigger_sidekiq_job do
     attribute :title, :author, :description
   end
 
-  def self.trigger_sidekiq_worker(record, remove)
-    MySidekiqWorker.perform_async(record.id, remove)
+  def self.trigger_sidekiq_job(record, remove)
+    MySidekiqJob.perform_async(record.id, remove)
   end
 end
 
-class MySidekiqWorker
+class MySidekiqJob
   def perform(id, remove)
     if remove
       # The record has likely already been removed from your database so we cannot
@@ -586,8 +596,7 @@ You can strip all HTML tags from your attributes with the `sanitize` option.
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch sanitize: true do
-  end
+  meilisearch sanitize: true
 end
 ```
 
@@ -599,8 +608,7 @@ You can force the UTF-8 encoding of all your attributes using the `force_utf8_en
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch force_utf8_encoding: true do
-  end
+  meilisearch force_utf8_encoding: true
 end
 ```
 
@@ -652,8 +660,7 @@ class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
   # Only raise exceptions in development environment.
-  meilisearch raise_on_failure: Rails.env.development? do
-  end
+  meilisearch raise_on_failure: Rails.env.development?
 end
 ```
 
@@ -667,8 +674,7 @@ You can force indexing and removing to be synchronous by setting the following o
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch synchronous: true do
-  end
+  meilisearch synchronous: true
 end
 ```
 🚨 This is only recommended for testing purposes, the gem will call the `wait_for_task` method that will stop your code execution until the asynchronous task has been processed by MeilSearch.
@@ -681,8 +687,7 @@ You can disable auto-indexing and auto-removing setting the following options:
 class Book < ActiveRecord::Base
   include MeiliSearch::Rails
 
-  meilisearch auto_index: false, auto_remove: false do
-  end
+  meilisearch auto_index: false, auto_remove: false
 end
 ```
 

data/lib/meilisearch/rails/version.rb

@@ -2,6 +2,6 @@
 
 module MeiliSearch
   module Rails
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
   end
 end

data/lib/meilisearch-rails.rb

@@ -105,7 +105,7 @@ module MeiliSearch
       end
 
       def sequel?(document)
-        defined?(::Sequel) && document.class < ::Sequel::Model
+        defined?(::Sequel::Model) && document.class < ::Sequel::Model
       end
 
       def active_record?(document)
@@ -224,7 +224,7 @@ module MeiliSearch
     if defined?(::ActiveJob::Base)
       # lazy load the ActiveJob class to ensure the
       # queue is initialized before using it
-      autoload :MSJob, 'meilisearch/ms_job'
+      autoload :MSJob, 'meilisearch/rails/ms_job'
     end
 
     # this class wraps an MeiliSearch::Index document ensuring all raised exceptions
@@ -319,8 +319,12 @@ module MeiliSearch
 
         attr_accessor :formatted
 
+        if options.key?(:per_environment)
+          raise BadConfiguration, ':per_environment option should be defined globally on MeiliSearch::Rails.configuration block.'
+        end
+
         if options[:synchronous] == true
-          if defined?(::Sequel) && self < Sequel::Model
+          if defined?(::Sequel::Model) && self < Sequel::Model
             class_eval do
               copy_after_validation = instance_method(:after_validation)
               define_method(:after_validation) do |*args|
@@ -352,7 +356,7 @@ module MeiliSearch
           end
         end
         unless options[:auto_index] == false
-          if defined?(::Sequel) && self < Sequel::Model
+          if defined?(::Sequel::Model) && self < Sequel::Model
             class_eval do
               copy_after_validation = instance_method(:after_validation)
               copy_before_save = instance_method(:before_save)
@@ -399,7 +403,7 @@ module MeiliSearch
           end
         end
         unless options[:auto_remove] == false
-          if defined?(::Sequel) && self < Sequel::Model
+          if defined?(::Sequel::Model) && self < Sequel::Model
             class_eval do
               copy_after_destroy = instance_method(:after_destroy)
 
@@ -653,8 +657,11 @@ module MeiliSearch
 
       def ms_index_uid(options = nil)
         options ||= meilisearch_options
+        global_options ||= MeiliSearch::Rails.configuration
+
         name = options[:index_uid] || model_name.to_s.gsub('::', '_')
-        name = "#{name}_#{::Rails.env}" if options[:per_environment]
+        name = "#{name}_#{::Rails.env}" if global_options[:per_environment]
+
         name
       end
 
@@ -674,6 +681,7 @@ module MeiliSearch
           [options[:if], options[:unless]].each do |condition|
             case condition
             when nil
+              return false
             when String, Symbol
               return true if ms_attribute_changed?(document, condition)
             else
@@ -820,7 +828,7 @@ module MeiliSearch
       def ms_find_in_batches(batch_size, &block)
         if (defined?(::ActiveRecord) && ancestors.include?(::ActiveRecord::Base)) || respond_to?(:find_in_batches)
           find_in_batches(batch_size: batch_size, &block)
-        elsif defined?(::Sequel) && self < Sequel::Model
+        elsif defined?(::Sequel::Model) && self < Sequel::Model
           dataset.extension(:pagination).each_page(batch_size, &block)
         else
           # don't worry, mongoid has its own underlying cursor/streaming mechanism
@@ -902,7 +910,7 @@ module MeiliSearch
         # ms_must_reindex flag is reset after every commit as part. If we must reindex at any point in
         # a transaction, keep flag set until it is explicitly unset
         @ms_must_reindex ||=
-          if defined?(::Sequel) && is_a?(Sequel::Model)
+          if defined?(::Sequel::Model) && is_a?(Sequel::Model)
             new? || self.class.ms_must_reindex?(self)
           else
             new_record? || self.class.ms_must_reindex?(self)

data/meilisearch-rails.gemspec

@@ -1,19 +1,21 @@
-require File.join(File.dirname(__FILE__), 'lib', 'meilisearch', 'rails', 'version')
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'date'
+require 'meilisearch/rails/version'
 
 Gem::Specification.new do |s|
   s.name = 'meilisearch-rails'
   s.version = MeiliSearch::Rails::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.authors = ['Meili']
-  s.description = 'Meilisearch integration for Ruby on Rails. See https://github.com/meilisearch/meilisearch'
   s.email = 'bonjour@meilisearch.com'
-  s.homepage = 'http://github.com/meilisearch/meilisearch-rails'
-  s.licenses = ['MIT']
-  s.require_paths = ['lib']
+
+  s.description = 'Meilisearch integration for Ruby on Rails. See https://github.com/meilisearch/meilisearch'
+  s.homepage = 'https://github.com/meilisearch/meilisearch-rails'
   s.summary = 'Meilisearch integration for Ruby on Rails.'
+  s.licenses = 'MIT'
+
+  s.require_paths = ['lib']
 
   s.extra_rdoc_files = [
     'LICENSE',
@@ -31,6 +33,6 @@ Gem::Specification.new do |s|
   ]
 
   s.required_ruby_version = '>= 2.6.0'
-  s.add_dependency('json', ['>= 1.5.1'])
-  s.add_dependency('meilisearch', ['>= 0.15.4'])
+
+  s.add_dependency 'meilisearch', '~> 0.18'
 end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-08 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: meilisearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.4
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.4
+        version: '0.18'
 description: Meilisearch integration for Ruby on Rails. See https://github.com/meilisearch/meilisearch
 email: bonjour@meilisearch.com
 executables: []
@@ -63,7 +49,7 @@ files:
 - lib/meilisearch/rails/utilities.rb
 - lib/meilisearch/rails/version.rb
 - meilisearch-rails.gemspec
-homepage: http://github.com/meilisearch/meilisearch-rails
+homepage: https://github.com/meilisearch/meilisearch-rails
 licenses:
 - MIT
 metadata: {}