mongodb_meilisearch 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7873b1a21e75522aa4fdaa063231997319faae90ddb9a4774cd814bf18a4afc
-  data.tar.gz: b4f241003a1ff709c1247f6411cec39831459795d8e17c429a9b7b187ff790cd
+  metadata.gz: ff219e5de4c77b4b06515946701f57eee82588691ec7931d963a70011409c79a
+  data.tar.gz: c51b7f234431417abe62fdd5365a106b4d493fe9e49b7802726cdd61a519db48
 SHA512:
-  metadata.gz: 8ad38b1b7f7c14baaee4c12491affeb62c9b9a700ec41d3bddcdf3c095288c084c9bf8f6c9feb28300b441e5fd94380179c9f334c7d2df078d48410221fbc05f
-  data.tar.gz: 5792131d06698d2af16194078e1d5a8bfbf37b9084502f25183d5f3c347d712d2eeac7e604edf0298800a03795e573336adbdc9a5b1d47929691f9288e974027
+  metadata.gz: b21b329983c8ac89de3e8543cccb021e63a7d1411b0cb464885ea3019fe815f7f72de8f408da1bc18d38cc2ebeac929f5491ec643ee3ea5e8a102dde3c582aae
+  data.tar.gz: 4c44d1ae3784917566bd6a1a2bb3993a718fe57d5cf97e7e9af21587a3587fda1d1c77764606ad21dd06b9c8e107eff82e7173d8d019ecd2e18dad46094a19a9

data/CHANGELOG.md

@@ -1,3 +1,52 @@
+## [1.2.0] - 2024-06-19
+
+### Features
+- The value of `SEARCHABLE_ATTRIBUTES` can now optionally
+  include method names, not just field names. 
+  
+  This makes for easier incorporation of dynamically generated index values,
+  because it eliminates many cases where you would have had to define
+  a `search_indexable_hash` method. If you already have one, it'll 
+  continue to work.
+
+## [1.1.1] 2023-11-13
+bug fix
+
+### Fixes
+
+Issue #7 - adding the first document from a new model didn't
+configure the filterable attributes or searchable attributes.
+The lack of the former would cause basic searches to fail
+because of our expectation that "object_class" will always
+be a filterable field unless you've specifically designated
+your model as unfilterable.
+
+
+## [1.1.0] - 2023-09-16
+Sorting & Filtering 
+
+## Additions
+- adds the ability to specify sortable attributes
+  - these default to match the filterable attributes
+  - filterable attributes still default to match
+    searchable attributes
+- `set_filterable_attributes`
+- `set_sortable_attributes`
+- `set_sortable_attributes!`
+- `reindex` and `reindex!` now set searchable attributes
+
+## Fixes
+- `set_filterable_attributes!` is now synchronous as the name implies
+- `reindex_core` correctly honors the user's async request when
+  setting filterable attributes (previously it was always async)
+
+## [1.0.1] - 2023-09-2
+
+ids from `belongs_to` relations are no longer
+indexed by default. You can explicitly specify
+their inclusion if you want.
+
+
 ## [1.0.0] - 2023-07-22
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongodb_meilisearch (1.1.1)
+    mongodb_meilisearch (1.3.0)
       meilisearch
       mongoid (~> 7.0)
       rails

data/README.md

@@ -43,7 +43,7 @@ The url below is the default one Meilisearch uses when run locally.
 
 ```bash
 SEARCH_ENABLED=true
-MEILISEARCH_API_KEY=<your api key here>
+MEILI_MASTER_KEY=<your api key here>
 MEILISEARCH_URL=http://127.0.0.1:7700
 
 ```
@@ -169,16 +169,19 @@ unless you intend to allow users to sort by when a record was created,
 there's no point in recording it's `created_at` in the search index. 
 It'll just waste bandwidth, memory, and disk space. 
 
-Define a `SEARCHABLE_ATTRIBUTES` constant with an array of strings to limit things. 
-By default these will _also_ be the fields you can filter on. Note that 
-Meilisearch requires there to be an `id` field and it must be a string. 
+Define a `SEARCHABLE_ATTRIBUTES` constant with an array of strings to limit things.
+These are the field names, and/or names of methods you wish to have indexed.
+
+By default these will _also_ be the fields you can filter on. 
+
+Note that Meilisearch requires there to be an `id` field and it must be a string. 
 If you don't define one it will use string version of the `_id` your 
 document's `BSON::ObjectId`. 
 
 ```ruby
   # explicitly define the fields you want to be searchable
   # this should be an array of symbols
-  SEARCHABLE_ATTRIBUTES = %i[title body]
+  SEARCHABLE_ATTRIBUTES = %w[title body]
   # OR explicitly define the fields you DON'T want searchable 
   SEARCHABLE_ATTRIBUTES = searchable_attributes - [:created_at]
 ```
@@ -194,9 +197,16 @@ exclude any fields that are `Mongoid::Fields::ForeignKey` objects.
 
 #### Getting Extra Specific
 If your searchable data needs to by dynamically generated instead of 
-just taken directly from the `Mongoid::Document`'s attributes you can
-define a `search_indexable_hash` method on your class. This method 
-must return a hash, and that hash must include the following keys:
+just taken directly from the `Mongoid::Document`'s attributes or 
+existing methods you can define a `search_indexable_hash` method on your class. 
+
+Before you do, please note that as of v1.1 your `SEARCHABLE_ATTRIBUTES` 
+constant can contain fields and method names in its array of values. Making
+a method for each thing dynamically generated thing you want in the search 
+and then including it in SEARCHABLE_ATTRIBUTES is going to be 
+the easiest way of accomplishing this.
+
+Your `search_indexable_hash` must return a hash, and that hash must include the following keys:
 - `"id"` - a string that uniquely identifies the record
 - `"object_class"` the name of the class that this record corresponds to.
 

data/lib/mongodb_meilisearch/version.rb

@@ -5,5 +5,5 @@ module MongodbMeilisearch
   # @note This library will adhere to strict semantic versioning.
   # See https://semver.org/
   #
-  VERSION = "1.1.1"
+  VERSION = "1.3.0"
 end

data/lib/search/client.rb

@@ -8,7 +8,8 @@ module Search
     def initialize
       if ENV.fetch("SEARCH_ENABLED", "true") == "true"
         url = ENV.fetch("MEILISEARCH_URL")
-        api_key = ENV.fetch("MEILISEARCH_API_KEY")
+        # MEILISEARCH_API_KEY is for mongodb_meilisearch v1.2.1 & earlier
+        api_key = ENV.fetch("MEILI_MASTER_KEY") || ENV.fetch("MEILISEARCH_API_KEY")
         timeout = ENV.fetch("MEILISEARCH_TIMEOUT", 10).to_i
         max_retries = ENV.fetch("MEILISEARCH_MAX_RETRIES", 2).to_i
         if url.present? && api_key.present?

data/lib/search/instance_methods.rb

@@ -44,6 +44,10 @@ module Search
       search_index.delete_document!(send(primary_search_key).to_s)
     end
 
+    def searchable_attributes
+      self.class.searchable_attributes
+    end
+
     # returns a hash of all the attributes
     # if searchable_attributes method is defined
     # it is assumed to return a list of symbols
@@ -57,9 +61,10 @@ module Search
     # in returned results
     def search_indexable_hash
       klass = self.class
-      hash = attributes
-        .to_h
-        .slice(* klass.searchable_attributes.map { |a| a.to_s })
+      # the to_s & to_sym is just safety in case someone
+      # defined searchable_attributes as an array of strings
+      hash = {}
+      searchable_attributes.each { |a| hash[a.to_s] = send(a.to_sym) }
 
       # Meilisearch doesn't like a primary key of _id
       # but Mongoid ids are _id
@@ -69,7 +74,7 @@ module Search
         id = hash.delete("_id").to_s
         new_id = (!klass.has_class_prefixed_search_ids?) ? id : "#{self.class.name}_#{id}"
         hash["id"] = new_id
-      elsif hash.has_key?("id") && !hash[id].is_a?(String)
+      elsif hash.has_key?("id") && !hash["id"].is_a?(String)
         # this is mostly in case it's a BSON::ObjectId
         hash["id"] = hash["id"].to_s
       elsif !hash.has_key?("id")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongodb_meilisearch
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - masukomi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-13 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails