mongodb_meilisearch 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f57c18174244b2885536a990a2d602ce833e949dcf205112c78f30567a6eee6a
-  data.tar.gz: bb5bdd6c8cb90a6e1334c4606063a56b71515510f0f45c3e1ae2d817b4497163
+  metadata.gz: 8dcda2174ac28dc1b3e134d90d2fc92b2d43e6815cab31dfc8a2c8954939d658
+  data.tar.gz: 45b658a38a761d8c02bc1ee4d21f82d7762a60e749ba14b8ec53e987284bdc4f
 SHA512:
-  metadata.gz: cb3e4f69dad6365682470020e3acc864492c45d79de54fb65fbab6fb9eaacb0811d8af02414f4df324a9d0cf64278646e0eac3062e7aff1a9873aa2f264d0d64
-  data.tar.gz: 54aa4eea1cfe0b378e9ad93c719eb31a5c35c96c08ef842d975efb8391cf1b55b0ca53e9ca3d8daf98626a02c30ea817e9623c78de0b6ce14ade726473767304
+  metadata.gz: 425ebd155ffec9c67e96cbb8b028be16a27948566d8cd5e64bfb4226a9a3d89551a449cad2bc9c8ecb6dd2261cab702fdf426c603c82a5402d7660de90596149
+  data.tar.gz: 322b9b928ea51c65df41906e872c9497af27b8cda2b2e04e0f1d360348c6ed9d4e7ebfad731d6e97956fa4d3cf0eb3b7b686db8352fcd2285be984690138eade

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.0)
+    mongodb_meilisearch (1.2.1)
       meilisearch
       mongoid (~> 7.0)
       rails

data/README.md

@@ -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.
 
@@ -323,6 +333,16 @@ Be careful to not add documents that are already in the index.
   WARNING: if you think you should use this, you're probably 
   mistaken. 
 
+#### Indexes 
+By default every model gets its own search index. This means that 
+`Foo.search("some text")` will only search `Foo` objects. To have a
+search cross objects you'll need to use a "Shared Index" (see below).
+
+
+The name of the index isn't important when not using shared indexes.
+By default a model's index is the snake cased form of the class name. 
+For example, data for `MyWidget` models will be stored in the `my_widget` index.
+
 #### Shared indexes
 Imagine you have a `Note` and a `Comment` model, sharing an index so that
 you can perform a single search and have search results for both models
@@ -442,10 +462,14 @@ To invoke any of Meilisearch's custom search options (see [their documentation](
 
 `MyModel.search("search term", options: <my custom options>)`
 
-The Meilisearch-ruby gem should be able to convert keys from snake case to 
+Currently the Meilisearch-ruby gem can convert keys from snake case to 
 camel case. For example `hits_per_page` will become `hitsPerPage`. 
-Meilisearch ultimately wants camel case. Follow their documentation 
-to see what's available and what type of options to pass it. Note that your 
+Meilisearch ultimately wants camel case (`camelCase`) parameter keys, 
+_but_ `meilisearch-ruby` wants snake case (`snake_case`). 
+
+Follow Meilisearch's documentation 
+to see what's available and what type of options to pass it, but convert 
+them to snake case first. Note that your 
 options keys and values must all be simple JSON values.
 
 If for some reason that still isn't enough, you can work with the 

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.0"
+  VERSION = "1.2.1"
 end

data/lib/search/class_methods.rb

@@ -109,6 +109,7 @@ module Search
     # @param filtered_by_class [Boolean] - defaults to filtering results by the class
     #        your searching from. Ex. Foo.search("something") it will
     #        have Meilisearch filter on records where `object_class` == `"Foo"`
+    #        This simplifies working with shared indexes.
     # @return [Hash[String, [Array[String | Document]] a hash with keys corresponding
     # to the classes of objects returned, and a value of an array of ids or
     # Mongoid::Document objects sorted by match strength. It will ALSO have a key named
@@ -135,13 +136,13 @@ module Search
 
       # TODO: break this if/else out into a separate function
       if ids_only
-        options.merge!({attributesToRetrieve: [pk.to_s]})
+        options.merge!({attributes_to_retrieve: [pk.to_s]})
       else
         # Don't care what you add, but we need the primary key and object_class
-        options[:attributesToRetrieve] = [] unless options.has_key?(:attributesToRetrieve)
+        options[:attributes_to_retrieve] = [] unless options.has_key?(:attributes_to_retrieve)
         [pk.to_s, "object_class"].each do |attr|
-          unless options[:attributesToRetrieve].include?(attr)
-            options[:attributesToRetrieve] << attr
+          unless options[:attributes_to_retrieve].include?(attr)
+            options[:attributes_to_retrieve] << attr
           end
         end
       end
@@ -260,6 +261,7 @@ module Search
     #    - each document hash is presumed to have been created by way of
     #      search_indexable_hash
     def add_documents(new_documents, async: true)
+      configure_attributes_and_index_if_needed!
       if async
         search_index.add_documents(new_documents, primary_search_key)
       else
@@ -393,17 +395,38 @@ module Search
     # @return [Array] - an array of attributes configured as sortable
     # in the index.
     def meilisearch_sortable_attributes
-      # Search::Client.instance.http_get(
-      search_index.http_get(
-        "/indexes/#{search_index}/settings/sortable-attributes"
-      )
+      @_meilisearch_sortable_attributes ||= search_index.get_sortable_attributes
     end
 
     def meilisearch_filterable_attributes
-      # Search::Client.instance.http_get(
-      search_index.http_get(
-        "/indexes/#{search_index}/settings/filterable-attributes"
-      )
+      @_meilisearch_filterable_attributes ||= search_index.get_filterable_attributes
+    end
+
+    def reset_cached_data!
+      @_meilisearch_filterable_attributes = nil
+      @_filterable_attributes             = nil
+      @_meilisearch_sortable_attributes   = nil
+      @_sortable_attributes               = nil
+    end
+
+    # Guarantees that the filterable attributes have been configured
+    # This should be called before
+    def configure_attributes_and_index_if_needed!
+      return if unfilterable?
+      indexes_filterable_attributes = []
+
+      begin
+        indexes_filterable_attributes = meilisearch_filterable_attributes
+      rescue ::MeiliSearch::ApiError => e
+        # this is expected to happen the first time an instance
+        # of a new model is saved.
+        raise unless e.message.match?(/Index `\S+` not found\./)
+        Search::Client.instance.create_index(search_index_name)
+      end
+
+      return if indexes_filterable_attributes.include?("object_class")
+      set_filterable_attributes
+      set_sortable_attributes
     end
 
     # Updates the filterable attributes in the search index.
@@ -579,7 +602,7 @@ module Search
     def reindex_core(async: true)
       # no point in continuing if this fails...
       delete_all_documents!
-
+      reset_cached_data!
       # this conveniently lines up with the batch size of 100
       # that Mongoid gives us
       documents = []

data/lib/search/client.rb

@@ -30,7 +30,7 @@ module Search
       if @client.respond_to? m.to_sym
         @client.send(m, *args, &block)
       else
-        raise ArgumentError.new("Method `#{m}` doesn't exist.")
+        raise ArgumentError.new("Method `#{m}` doesn't exist in #{@client.inspect}.")
       end
     end
 

data/lib/search/instance_methods.rb

@@ -2,6 +2,7 @@ module Search
   module InstanceMethods
     # Adds this record to the search index asynchronously
     def add_to_search
+      self.class.configure_attributes_and_index_if_needed!
       search_index.add_documents(
         [search_indexable_hash],
         primary_search_key.to_s
@@ -10,6 +11,7 @@ module Search
 
     # Adds this record to the search index synchronously
     def add_to_search!
+      self.class.configure_attributes_and_index_if_needed!
       index     = search_index
       documents = [search_indexable_hash]
       pk        = primary_search_key.to_s
@@ -42,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
@@ -55,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
@@ -67,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.0
+  version: 1.2.1
 platform: ruby
 authors:
 - masukomi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-16 00:00:00.000000000 Z
+date: 2024-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -187,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: MeiliSearch integration for MongoDB