solidus_searchkick 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca0b78287e2633baa26f6c7ddeff14b16dc00af3
-  data.tar.gz: 6b2053d60718e3636b27e2b40259cc74a03a084b
+  metadata.gz: 90df6ecb12ebe3bdeda6688bb4bab35b26d2eee0
+  data.tar.gz: c9fb6dfa763c7aea5935f4a8d653893867fb0b05
 SHA512:
-  metadata.gz: a9a69a01475029299acc03e1b6df00f26a812404984b789271b4568c6698c8db787907681725383d3fc26b127530d389996a146d5e187d7a6683aec6d741f799
-  data.tar.gz: c90fb75cbd91aebb1e2b4124c81eb8e0d37ce4e31abc910ad0d4c40cc50ba22987aaecbca1812b9de5728f4183bd3bab78846d3f35b97b12a715cf4cfa87f956
+  metadata.gz: fcfa5acdc15df06161dae6a1e1db00811ce9a34cbb4121dbe4fe04a44ccb16bbcd05399bc3c0c4e26d5740923f5c604a2b08408a4b3e5612aaa21ce90962c35c
+  data.tar.gz: a5752bc91281f15e81e0307b432bfd61a9991b1a13451082aa991b79c6c45c05b88fb403ca905827caf76a290bade2b296ce364b0e86cc47925d21022759ce1f

data/README.md

@@ -110,6 +110,10 @@ The `conds` for `SearchkickFilters` are similar to the `ProductFilters` in the d
   end
   ```
 
+Advanced Filtering
+------------------
+Checkout out the wiki page [here](https://github.com/elevatorup/solidus_searchkick/wiki/Advanced-Filtering).
+
 Autocomplete
 ------------
 By default, SolidusSearchkick provides autocomplete for the `name` field of your products. In order to get this working, all you need to do is add the following lines to the corresponding files:
@@ -147,6 +151,18 @@ Spree::Product.class_eval do
 end
 ```
 
+Fields and Boosting
+-------------------
+With SolidusSearchkick, you can include a list of fields that you would like to search on. This list can also include boosted fields the same way that Searchkick can. You can learn more about Searchkick boosting [here](https://github.com/ankane/searchkick#boosting).
+
+In order to add the fields, pass in an array of the fields:
+
+```
+fields = ['name^99', :description, ...]
+searcher = build_searcher(params.merge(fields: fields))
+@products = searcher.retrieve_products
+```
+
 Searchkick Options
 ------------------
 Since SolidusSearchkick uses Searchkick to interact with ElasticSearch, it also accepts all of the Searchkick options.
@@ -205,45 +221,6 @@ searcher = build_searcher(query: query)
 ```
 
 
-Overriding and Extending Default Methods
-----------------------------------------
-
-By creating an initializer, you have the ability to override or extend any of the default methods provided by SolidusSearchkick.
-
-### Overriding a Default Method
-
-In order to override a method, simply add that method to the initializer.
-
-_(Take care when overriding methods, as you may loose some functionality if not careful)_
-```
-# config/initializers/solidus_searchkick.rb
-Spree::Search::Searchkick.class_eval do
-  def where_clause
-    # Default items for where_clause
-    where_clause = {
-      active: true
-    }
-    where_clause.merge!({taxon_ids: taxon.id}) if taxon
-
-    # Add search attributes from params[:search]
-    add_search_attributes(where_clause)
-  end
-end
-```
-
-### Extending a Default Method
-
-In order to extend a method, alias the original method, then call the aliased method when defining the new method.
-```
-# config/initializers/solidus_searchkick.rb
-Spree::Search::Searchkick.class_eval do
-  alias_method :original_where_clause, :where_clause
-  def where_clause
-    original_where_clause.merge(param1: param1, param2: param2)
-  end
-end
-```
-
 Testing
 -------
 
@@ -268,3 +245,12 @@ Special Thanks
 --------------
 
 SolidusSearchkick was heavily inspired by [spree_searchkick](https://github.com/ronzalo/spree_searchkick), which was used as a starting point to getting Solidus to work nicely with Searchkick.
+
+Contributing
+------------
+
+1. Fork it ( https://github.com/elevatorup/solidus_searchkick/fork )
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a new Pull Request

data/lib/solidus_searchkick/version.rb

@@ -1,3 +1,3 @@
 module SolidusSearchkick
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

data/lib/spree/search/searchkick.rb

@@ -38,6 +38,7 @@ module Spree::Search
           per_page: per_page,
         }
 
+        search_options.merge!(fields: fields) if fields
         search_options.merge!(searchkick_options)
         search_options.deep_merge!(includes: includes_clause)
 
@@ -127,6 +128,7 @@ module Spree::Search
     def prepare(params)
       @properties[:query] = params[:query].blank? ? nil : params[:query]
       @properties[:filters] = params[:filter].blank? ? nil : params[:filter]
+      @properties[:fields] = params[:fields].blank? ? nil : params[:fields]
       @properties[:searchkick_options] = params[:searchkick_options].blank? ? {} : params[:searchkick_options].deep_symbolize_keys
       params = params.deep_symbolize_keys
       super

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_searchkick
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Jim Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solidus
@@ -289,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - none
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Add searchkick to Solidus