meilisearch-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd9fd3dfd135348e2daea1797697e8b879f08705e2878b3683e59b28d51676c7
-  data.tar.gz: 7226660145964ae88bac72436690aad1a890e76cacd8d4c3fa1e1d3a1d3036e0
+  metadata.gz: 1562941b9f5cf4cb5a13085147f5b9b9ba1b3ea04587f6d1c520239ae5362236
+  data.tar.gz: 57106ef19a839131d89e45bbb3d01f6aeef6fca623f3d803ade4f63282c2221d
 SHA512:
-  metadata.gz: 66a1950a5b9bf12469f40053ee01bae86f1379f8a6437de2dff7cc65e55ef64ead442cccc23b39a9d609b4693a1ced987ae51136671fe2d1a53f494fa1ee66dd
-  data.tar.gz: 1e8e5b33d6cb193a432ae09c10f9611ff709a2e9d744fad40e069c7098f39db582b250e8d33288b2beb4ccc72d740a6b9e6f3b439163b6d271e250897e836ea8
+  metadata.gz: 2d33ff75ad9c5dc9eeab0c602bdfc5fa8f80b1d14d3a025105cf04c7c2e644a1309e68cbff56452eeea5c1801e13fc58d11f8dd529b02bd6ac14e3baf4c30d20
+  data.tar.gz: 02720ef33a1a0da9cc309f04c24129c87b9f1d885e9d8ff4386ba0873f1aec14e88373bbabe8eae279627a76e573046d4ae445ac1837efffda39b7a458e33fa3

data/Gemfile

@@ -27,4 +27,5 @@ group :test do
   gem 'will_paginate', '>= 2.3.15'
   gem 'kaminari'
   gem 'dotenv', '~> 2.7', '>= 2.7.6'
+  gem 'byebug'
 end

data/README.md

@@ -126,6 +126,8 @@ 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.
+
 #### Basic Backend Search <!-- omit in toc -->
 
 We **strongly recommend the use of front-end search** through our [JavaScript API Client](https://github.com/meilisearch/meilisearch-js/) or [Instant Meilisearch plugin](https://github.com/meilisearch/instant-meilisearch)
@@ -143,15 +145,18 @@ end
 
 #### Backend Pagination <!-- omit in toc -->
 
-We support both [kaminari](https://github.com/amatsuda/kaminari) and [will_paginate](https://github.com/mislav/will_paginate).
+This gem supports:
+- [kaminari](https://github.com/amatsuda/kaminari)
+- [pagy](https://github.com/ddnexus/pagy)
+- [will_paginate](https://github.com/mislav/will_paginate).
 
 Specify the `:pagination_backend` in the configuration file:
 
 ```ruby
 MeiliSearch.configuration = {
-    meilisearch_host: 'YourMeiliSearchHost',
-    meilisearch_api_key: 'YourMeiliSearchAPIKey',
-    pagination_backend: :kaminari #:will_paginate
+  meilisearch_host: 'YourMeiliSearchHost',
+  meilisearch_api_key: 'YourMeiliSearchAPIKey',
+  pagination_backend: :kaminari #:will_paginate
 }
 ```
 
@@ -187,22 +192,23 @@ class Book < ApplicationRecord
   include MeiliSearch
 
   meilisearch do
-    searchableAttributes ['title', 'author', 'publisher', 'description']
-    attributesForFaceting ['genre']
-    rankingRules [
-        "proximity",
-        "typo",
-        "words",
-        "attribute",
-        "wordsPosition",
-        "exactness",
-        "desc(publication_year)"
+    searchable_attributes [:title, :author, :publisher, :description]
+    attributes_for_faceting [:genre]
+    ranking_rules [
+      'proximity',
+      'typo',
+      'words',
+      'attribute',
+      'wordsPosition',
+      'exactness',
+      'desc(publication_year)'
     ]
     synonyms nyc: ['new york']
-    // The following parameters are applied when calling the search() method:
-    attributesToHighlight ['*']
-    attributesToCrop ['description']
-    cropLength 10
+
+    # The following parameters are applied when calling the search() method:
+    attributes_to_highlight ['*']
+    attributes_to_crop [:description]
+    crop_length 10
   end
 end
 ```
@@ -214,9 +220,10 @@ 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', filters: 'author = J. K. Rowling')
 ```
-👉 Don't forget that `attributesToHighlight`, `attributesToCrop`, and `cropLength` can be set up in the `meilisearch` block of your model.
+👉 Don't forget that `attributes_to_highlight`, `attributes_to_crop`, and
+`crop_length` can be set up in the `meilisearch` block of your model.
 
 ## 🪛 Options
 
@@ -224,12 +231,13 @@ Book.search('Harry', { filters: 'author = J. K. Rowling' })
 
 #### Custom index_uid
 
-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.
+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.
 
 ```ruby
 class Book < ActiveRecord::Base
   include MeiliSearch
-  meilisearch :index_uid => 'MyCustomUID' do
+
+  meilisearch index_uid: 'MyCustomUID' do
   end
 end
 ```
@@ -241,6 +249,7 @@ You can suffix the index UID with the current Rails environment using the follow
 ```ruby
 class Book < ActiveRecord::Base
   include MeiliSearch
+
   meilisearch per_environment: true do # The index UID will be "Book_#{Rails.env}"
   end
 end
@@ -282,27 +291,28 @@ end
 
 #### Custom primary key
 
-By default, the `primary key` is based on your record's id. You can change this behavior specifying the `:primary_key` option.
+By default, the primary key is based on your record's id. You can change this behavior by specifying the `primary_key:` option.
 
 Note that the primary key must have a **unique value**.
 
 ```ruby
 class Book < ActiveRecord::Base
   include MeiliSearch
-  meilisearch :primary_key => 'ISBN' do
+
+  meilisearch primary_key: 'ISBN' do
   end
 end
 ```
 #### Conditional indexing
 
-You can control if a record must be indexed by using the `:if` or `:unless` options.<br>
+You can control if a record must be indexed by using the `if:` or `unless:` options.<br>
 As soon as you use those constraints, `add_documents` and `delete_documents` calls will be performed in order to keep the index synced with the DB. To prevent this behavior, you can create a `will_save_change_to_#{attr_name}?` method.
 
 ```ruby
 class Book < ActiveRecord::Base
   include MeiliSearch
 
-  meilisearch :if published?, :unless premium? do
+  meilisearch if: :published?, unless: :premium? do
   end
 
   def published?
@@ -314,7 +324,7 @@ class Book < ActiveRecord::Base
   end
 
   def will_save_change_to_published?
-  # return true only if you know that the 'published' state changed
+    # return true only if you know that the 'published' state changed
   end
 end
 ```
@@ -324,7 +334,6 @@ You can index a record in several indexes using the `add_index` option:
 
 ```ruby
 class Book < ActiveRecord::Base
-
   include MeiliSearch
 
   PUBLIC_INDEX_UID = 'Books'
@@ -332,17 +341,17 @@ class Book < ActiveRecord::Base
 
   # store all books in index 'SECURED_INDEX_UID'
   meilisearch index_uid: SECURED_INDEX_UID do
-    searchableAttributes [:title, :author]
+    searchable_attributes [:title, :author]
 
     # store all 'public' (released and not premium) books in index 'PUBLIC_INDEX_UID'
     add_index PUBLIC_INDEX_UID, if: :public? do
-      searchableAttributes [:title, :author]
+      searchable_attributes [:title, :author]
     end
   end
 
   private
   def public?
-    released && !premium
+    released? && !premium?
   end
 end
 ```
@@ -394,18 +403,31 @@ end
 
 In this case you can bypass loading the record from **ActiveRecord** and just communicate with the index directly.
 
+With **ActiveJob**:
+
 ```ruby
+class Book < ActiveRecord::Base
+  include MeiliSearch
+
+  meilisearch enqueue: :trigger_job do
+    attribute :title, :author, :description
+  end
+
+  def self.trigger_job(record, remove)
+    MyActiveJob.perform_later(record.id, remove)
+  end
+end
+
 class MyActiveJob < ApplicationJob
   def perform(id, remove)
     if remove
-      # the record has likely already been removed from your database so we cannot
-      # use ActiveRecord#find to load it
-      # We access the underlying MeiliSearch index object
+      # The record has likely already been removed from your database so we cannot
+      # use ActiveRecord#find to load it.
+      # We access the underlying MeiliSearch index object.
       Book.index.delete_document(id)
     else
-      # the record should be present
-      c = Book.find(id)
-      c.index!
+      # The record should be present.
+      Book.find(id).index!
     end
   end
 end
@@ -429,14 +451,13 @@ end
 class MySidekiqWorker
   def perform(id, remove)
     if remove
-      # the record has likely already been removed from your database so we cannot
-      # use ActiveRecord#find to load it
-      # We access the underlying MeiliSearch index object
-      index = Book.index.delete_document(id)
+      # The record has likely already been removed from your database so we cannot
+      # use ActiveRecord#find to load it.
+      # We access the underlying MeiliSearch index object.
+      Book.index.delete_document(id)
     else
-      # the record should be present
-      c = Contact.find(id)
-      c.index!
+      # The record should be present.
+      Book.find(id).index!
     end
   end
 end
@@ -466,7 +487,7 @@ end
 
 Extend a change to a related record.
 
-**With Active Record**, you'll need to use `touch` and `after_touch`.
+**With ActiveRecord**, you'll need to use `touch` and `after_touch`.
 
 ```ruby
 class Author < ActiveRecord::Base
@@ -546,7 +567,7 @@ You can strip all HTML tags from your attributes with the `sanitize` option.
 class Book < ActiveRecord::Base
   include MeiliSearch
 
-  meilisearch :sanitize => true do
+  meilisearch sanitize: true do
   end
 end
 ```
@@ -559,7 +580,7 @@ You can force the UTF-8 encoding of all your attributes using the `force_utf8_en
 class Book < ActiveRecord::Base
   include MeiliSearch
 
-  meilisearch :force_utf8_encoding => true do
+  meilisearch force_utf8_encoding: true do
   end
 end
 ```
@@ -568,7 +589,7 @@ end
 
 #### Indexing & deletion
 
-You can manually index a record by using the `index!` instance method and remove it by using the `remove_from_index!` instance method
+You can manually index a record by using the `index!` instance method and remove it by using the `remove_from_index!` instance method.
 
 ```ruby
 book = Book.create!(title: 'The Little Prince', author: 'Antoine de Saint-Exupéry')
@@ -603,7 +624,6 @@ index = Book.index
 
 ### Development & testing
 
-
 #### Exceptions
 
 You can disable exceptions that could be raised while trying to reach MeiliSearch's API by using the `raise_on_failure` option:
@@ -612,14 +632,16 @@ You can disable exceptions that could be raised while trying to reach MeiliSearc
 class Book < ActiveRecord::Base
   include MeiliSearch
 
-  # only raise exceptions in development environment
-  meilisearch :raise_on_failure => Rails.env.development? do
+  # Only raise exceptions in development environment.
+  meilisearch raise_on_failure: Rails.env.development? do
   end
 end
 ```
 
 #### Testing
+
 ##### Synchronous testing
+
 You can force indexing and removing to be synchronous by setting the following option:
 
 ```ruby
@@ -649,7 +671,8 @@ You can temporarily disable auto-indexing using the without_auto_index scope:
 
 ```ruby
 Book.without_auto_index do
-  1.upto(10000) { Book.create! attributes } # inside this block, auto indexing task will not run.
+  # Inside this block, auto indexing task will not run.
+  1.upto(10000) { Book.create! attributes }
 end
 ```
 

data/lib/meilisearch-rails.rb

@@ -52,16 +52,25 @@ module MeiliSearch
 
     # MeiliSearch settings
     OPTIONS = [
-      :searchableAttributes, :attributesForFaceting, :displayedAttributes, :distinctAttribute,
-      :synonyms, :stopWords, :rankingRules,
+      :searchableAttributes,
+      :attributesForFaceting,
+      :displayedAttributes,
+      :distinctAttribute,
+      :synonyms,
+      :stopWords,
+      :rankingRules,
       :attributesToHighlight,
-      :attributesToCrop, :cropLength
+      :attributesToCrop,
+      :cropLength,
     ]
 
-    OPTIONS.each do |k|
-      define_method k do |v|
-        instance_variable_set("@#{k}", v)
+    OPTIONS.each do |option|
+      define_method option do |value|
+        instance_variable_set("@#{option}", value)
       end
+
+      underscored_name = option.to_s.gsub(/(.)([A-Z])/, '\1_\2').downcase
+      alias_method underscored_name, option if underscored_name != option
     end
 
     def initialize(options, &block)
@@ -315,7 +324,7 @@ module MeiliSearch
 
     def meilisearch(options = {}, &block)
       self.meilisearch_settings = IndexSettings.new(options, &block)
-      self.meilisearch_options = { :type => ms_full_const_get(model_name.to_s), :per_page => meilisearch_settings.get_setting(:hitsPerPage) || 20, :page => 1 }.merge(options)
+      self.meilisearch_options = { type: ms_full_const_get(model_name.to_s), per_page: meilisearch_settings.get_setting(:hitsPerPage) || 20, page: 1 }.merge(options)
 
       attr_accessor :formatted
 
@@ -552,8 +561,6 @@ module MeiliSearch
         params[:cropLength] = meilisearch_settings.get_setting(:cropLength) if !meilisearch_settings.get_setting(:cropLength).nil?
       end
       index = ms_index(index_uid)
-      # index = ms_index(ms_index_uid)
-      # index.search(q, Hash[params.map { |k,v| [k.to_s, v.to_s] }])
       index.search(q, Hash[params.map { |k,v| [k, v] }])
     end
 
@@ -590,14 +597,6 @@ module MeiliSearch
         params[:limit] = 200
       end
 
-      if !meilisearch_settings.get_setting(:attributesToHighlight).nil?
-        params[:attributesToHighlight] = meilisearch_settings.get_setting(:attributesToHighlight)
-      end
-
-      if !meilisearch_settings.get_setting(:attributesToCrop).nil?
-        params[:attributesToCrop] = meilisearch_settings.get_setting(:attributesToCrop)
-        params[:cropLength] = meilisearch_settings.get_setting(:cropLength) if !meilisearch_settings.get_setting(:cropLength).nil?
-      end
       # Returns raw json hits as follows:
       # {"hits"=>[{"id"=>"13", "href"=>"apple", "name"=>"iphone"}], "offset"=>0, "limit"=>|| 20, "nbHits"=>1, "exhaustiveNbHits"=>false, "processingTimeMs"=>0, "query"=>"iphone"}
       json = ms_raw_search(q, params)
@@ -632,7 +631,7 @@ module MeiliSearch
       hits_per_page ||= 20
       page ||= 1
 
-      res = MeiliSearch::Pagination.create(results, total_hits, meilisearch_options.merge({ :page =>  page , :per_page => hits_per_page }))
+      res = MeiliSearch::Pagination.create(results, total_hits, meilisearch_options.merge({ page:  page , per_page: hits_per_page }))
       res.extend(AdditionalMethods)
       res.send(:ms_init_raw_answer, json)
       res
@@ -823,7 +822,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)
+        find_in_batches(batch_size: batch_size, &block)
       elsif defined?(::Sequel) && self < Sequel::Model
         dataset.extension(:pagination).each_page(batch_size, &block)
       else

data/lib/meilisearch/pagination/kaminari.rb

@@ -25,12 +25,12 @@ module MeiliSearch
       class << self
         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
+          array = new results, limit: options[:per_page], offset: offset, total_count: total_hits
           if array.empty? and !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
+            array = new results, offset: offset, limit: options[:per_page], total_count: total_hits
           end
           array
         end

data/lib/meilisearch/version.rb

@@ -1,3 +1,3 @@
 module MeiliSearch
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/spec_helper.rb

@@ -18,7 +18,7 @@ Thread.current[:meilisearch_hosts] = nil
 
 RSpec.configure do |c|
   c.mock_with :rspec
-  c.filter_run :focus => true
+  c.filter_run focus: true
   c.run_all_when_everything_filtered = true
   c.formatter = 'documentation'
 

data/spec/utilities_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 
-MeiliSearch.configuration = { :meilisearch_host => ENV['MEILISEARCH_HOST'], :meilisearch_api_key => ENV['MEILISEARCH_API_KEY'] }
+MeiliSearch.configuration = { meilisearch_host: ENV['MEILISEARCH_HOST'], meilisearch_api_key: ENV['MEILISEARCH_API_KEY'] }
 
 describe MeiliSearch::Utilities do
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json