solidus_searchkick 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dde9afab1926dc0020b1be0f2da90e1cf8b9b0f
-  data.tar.gz: a9f8973fe592d1c42e88e1c74307b21e9a8cf780
+  metadata.gz: a48395a245488a882a67f7bee409c2eaeff6b855
+  data.tar.gz: 4ac9f30e6eae2780a141fc18b728986aaaed5866
 SHA512:
-  metadata.gz: baa94632a4d4afee378e4725730590eeb5d492065f426703e3e99aa3de5735913342a921f3969dcb7ac9645f657ef0b78e48009d08a96f90236325d21a0dc81f
-  data.tar.gz: 1c12aa84ed1687d4a915b0d38163e65744ba9bdad0933f2b63ce3cba00bf045be9798c7f48ae9f1b2525ee56ed4064c61b65228fe2571a8840b6416d72a483d6
+  metadata.gz: 0189386d284fe34353291c98a18ae786ad429967ee258a0a0f73044b1f03d68dbcf61f8c74b51af33e18e6c957c93a01c42bec573cd7e2e5fff85d956cdbff2c
+  data.tar.gz: 05d1f38bac4599b7f12588d68545cef348fb92e8c1c9ca806e71f042df9ea014f3d583bbd3d5dcaab751945194ed3582cddb5038d763929b6e94fa428df2f4e1

data/README.md

@@ -41,20 +41,30 @@ Searchkick Integration
 
 By default, Searchkick is initialized on the Product model in SolidusSearchkick's `product_decorator` with:
 ```
-searchkick word_start: [:name]
+searchkick index_name: ..., word_start: [:name]
 ```
 
 If you need to modify this, you can do so in your own `product_decorator`, by adding something like:
 ```
 # app/models/spree/product_decorator.rb
 Spree::Product.class_eval do
-  searchkick word_start: [:name], callbacks: :async unless Spree::Product.try(:searchkick_options)
+  searchkick index_name: ..., word_start: [:name], callbacks: :async unless Spree::Product.try(:searchkick_options)
   ...
 end
 ```
 In this example, the `unless Spree::product.try(:searchkick_options)` conditional is needed, since, by default, the development environment does not cache classes and will reload them.
 Adding this condition prevents Rails from throwing an error when reloading the product decorator and trying to add searchkick multiple times.
 
+#### Index Name
+In version 0.3.1, the index_name option was added. It defaults to
+```
+"#{Rails.application.class.parent_name.parameterize.underscore}_spree_products_#{Rails.env}"
+```
+
+If you need are upgrading from a version of SolidusSearchkick prior to version 0.3.1, you will need to either:
+- reindex all of your products (which will build the index with the new name)
+- update your product_decorator to use the index_name currently being used
+
 
 Search Parameters
 -----------------

data/app/models/spree/product_decorator.rb

@@ -3,7 +3,7 @@ Spree::Product.class_eval do
   Rails.application.config.after_initialize do
     # Check if searchkick_options have been set by the application using this gem
     # If they have, then do not initialize searchkick on the model. If they have not, then set the defaults
-    searchkick word_start: [:name] unless Spree::Product.try(:searchkick_options)
+    searchkick index_name: "#{Rails.application.class.parent_name.parameterize.underscore}_spree_products_#{Rails.env}", word_start: [:name] unless Spree::Product.try(:searchkick_options)
   end
 
   def search_data

data/changelog.md

@@ -0,0 +1,4 @@
+# 0.3.1
+Versioin 0.3.1 introduced a breaking change related to the index_name. If using a previous version of solidus_searchkick, you will need to either:
+- reindex all of your products (which will build the index with the new name)
+- update your product_decorator to use the index_name currently being used

data/lib/solidus_searchkick/version.rb

@@ -1,3 +1,3 @@
 module SolidusSearchkick
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solidus_searchkick
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Jim Smith
@@ -244,6 +244,7 @@ files:
 - app/models/spree/product_decorator.rb
 - app/views/spree/shared/_filters.html.erb
 - bin/rails
+- changelog.md
 - config/locales/en.yml
 - config/routes.rb
 - lib/generators/solidus_searchkick/install/install_generator.rb