meilisearch-rails 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd9b1257d27f252b6dc5caf4dcc3316d6b8e2a026b6266e4aec67eb05106ace0
-  data.tar.gz: 356acde3b6a894b8a3e8c2e2206c04527b5927968a33030a6f73e0d807f709af
+  metadata.gz: 25c4de2cc918a39c265d31b9191302e42e66a80f1b9d4b9e07c89074bb9e8eec
+  data.tar.gz: d6572c3e463044c8401d0916aed8c396ac7559e980e5be03ba874af9d10ab54b
 SHA512:
-  metadata.gz: a813264676828158494dd04f5192ab902fd735e3ef0bbc17960b9a8f54fdc581139ec528cd87c0883be6bc96becdce8d455c0055d31b0464f9ba0d53cfbf0751
-  data.tar.gz: 0b5c4276212a365b038de5492a606be125902bac3bb9417a7cdf279c6e8bccdc146eb84b991b3c8e55928ee99c99510934da0cbbe958813709b6af6725fd7922
+  metadata.gz: bf2356509509b70d9ebe00715faa680cd76b58802643712f5447d8d2de93aaae934f7b0048da2eaeb69fcee549654d5e80e24be5a5e71ee2a92c3b5a2c6a5280
+  data.tar.gz: 1f99790e054f917bc3c79df3eacb0471e7883dd414a8e03631d1382ef9b186eb53dffb2c1178e4625577231a03534c9348c4114f93b80655e9f242c60bf94de4

data/README.md

@@ -7,7 +7,7 @@
 <h4 align="center">
   <a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
   <a href="https://docs.meilisearch.com">Documentation</a> |
-  <a href="https://slack.meilisearch.com">Slack</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>
@@ -62,7 +62,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.30.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.30.0).
+This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/meilisearch-rails/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.
 
 ## 🔧 Installation <!-- omit in toc -->
 
@@ -185,6 +185,7 @@ class Book < ApplicationRecord
     attributes_to_highlight ['*']
     attributes_to_crop [:description]
     crop_length 10
+    faceting max_values_per_facet: 2000
     pagination max_total_hits: 1000
   end
 end
@@ -199,6 +200,13 @@ All the supported options are described in the [search parameters](https://docs.
 ```ruby
 Book.search('Harry', attributes_to_highlight: ['*'])
 ```
+
+Then it's possible to retrieve the highlighted or cropped value by using the `formatted` method available in the object.
+
+```ruby
+harry_book.formatted # => {"id"=>"1", "name"=>"<em>Harry</em> Potter", "description"=>…
+```
+
 👉 Don't forget that `attributes_to_highlight`, `attributes_to_crop`, and
 `crop_length` can be set up in the `meilisearch` block of your model.
 

data/lib/meilisearch/rails/version.rb

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

data/lib/meilisearch-rails.rb

@@ -60,9 +60,11 @@ module MeiliSearch
         attributesToCrop
         cropLength
         pagination
+        faceting
+        typoTolerance
       ].freeze
 
-      CAMELIZE_OPTIONS = %i[pagination].freeze
+      CAMELIZE_OPTIONS = %i[pagination faceting typoTolerance].freeze
 
       OPTIONS.each do |option|
         define_method option do |value|
@@ -198,6 +200,10 @@ module MeiliSearch
         instance_variable_get("@#{name}")
       end
 
+      def camelize_keys(hash)
+        hash.transform_keys { |key| key.to_s.camelize(:lower) }
+      end
+
       def to_settings
         settings = {}
         OPTIONS.each do |k|
@@ -205,7 +211,12 @@ module MeiliSearch
           next if v.nil?
 
           settings[k] = if CAMELIZE_OPTIONS.include?(k) && v.is_a?(Hash)
-                          v.transform_keys { |key| key.to_s.camelize(:lower) }
+                          v = camelize_keys(v)
+
+                          # camelize keys of nested hashes
+                          v.each do |key, value|
+                            v[key] = camelize_keys(value) if value.is_a?(Hash)
+                          end
                         else
                           v
                         end
@@ -587,13 +598,6 @@ module MeiliSearch
       end
 
       module AdditionalMethods
-        def self.extended(base)
-          class << base
-            alias_method :raw_answer, :ms_raw_answer unless method_defined? :raw_answer
-            alias_method :facets_distribution, :ms_facets_distribution unless method_defined? :facets_distribution
-          end
-        end
-
         def ms_raw_answer
           @ms_json
         end
@@ -602,6 +606,9 @@ module MeiliSearch
           @ms_json['facetDistribution']
         end
 
+        alias raw_answer ms_raw_answer unless method_defined? :raw_answer
+        alias facets_distribution ms_facets_distribution unless method_defined? :facets_distribution
+
         private
 
         def ms_init_raw_answer(json)

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.21.0'
+  s.add_dependency 'meilisearch', '~> 0.22.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-01 00:00:00.000000000 Z
+date: 2023-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: meilisearch
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
 description: Meilisearch integration for Ruby on Rails. See https://github.com/meilisearch/meilisearch
 email: bonjour@meilisearch.com
 executables: []