spotlight_search 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 191b3e2e1a54c91a8c1b89722ef097af03e9072055b54ba5d8b0fb050bd6ea1d
-  data.tar.gz: 0bd5fbfe2bde866d094861155e8e2e1ee11282f2f5784165b647855a0696b6ce
+  metadata.gz: fcbc12f0614877e2fc4dd201b0885d74c6ae169b4cbb56760ee3db5bc1f11ce4
+  data.tar.gz: c5a8e1299b3b4cc5b2ae8113e66e8afb1e6a08b57cadf526c45780b935b808ba
 SHA512:
-  metadata.gz: 9c29cb1e8b6d38ea27ea60ca7b8202b68cf586ac6085e0e036538e5dbd61fd0aafda62b57ff42d8e290a4cefc9989bb565fe8f9315e676f1bae4783373e0110d
-  data.tar.gz: 981982dbdd5dc0f8b4bfd9130543f56317b93334af064f6a5f346201144c6f64c252c2d03234edda8f25453baa3cee4cc75b1960fa12d39537b3bd6bc7453010
+  metadata.gz: 90221663054cdbff4fcdc9293998a272aee5926548912fed9ad98441b8e294a18cb24b5dc871d78cf52eb27e90d5f8b57aa43ab7aaa4143928335ba3add7c56f
+  data.tar.gz: 126fc9efce631043f391d16f23af181963817648f113d230124e80e56e383fb5b4d9dd98fe3d5fc9c65f2da1d076a98186c9ed1d8cb9989e1c6552cc4989e040

data/README.md

@@ -22,7 +22,69 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+After installing the gem to the project, there are few places you will have to make changes.
+
+### Controller
+
+**STEP - 1**
+
+First step is to add the search method to the index action.
+
+```
+@filtered_result = @workshop.filter_by(params[:page], filter_params.to_h, sort_params.to_h)
+```
+
+`filter_by` is the search method which accepts 3 arguments. `page`, `filter_params`, `sort_params`.
+All 3 params are sent from the JS which is handled by the gem.
+
+**STEP - 2**
+
+Second Step is to add the permitted params. Since the JS is taking up values from HTML,
+we do not want all params to be accepted. Permit only the scopes that you want to allow.
+
+```
+def filter_params
+  params.require(:filters).permit(:search) if params[:filters]
+end
+
+def sort_params
+  params.require(:sort).permit(:sort_column, :sort_direction) if params[:sort]
+end
+```
+
+### HTML
+**STEP - 1 Search**
+
+First step is to add the input box to search. Here there are few elements that should be placed mandatorily.
+
+```
+.filters.w-100 data-filter-url="/admin/workshops" data-replacement-class="workshops_table"
+	.col-md-4.input-group.search
+		input#workshop-search-filter.form-control.filter-box name=("search_term_for_workshops ") placeholder=("Search Workshops") type="text" data-behaviour="filter" data-scope="search" data-type="input-filter"
+```
+
+The elements that should be placed mandatorily are
+
+  * `.filters` All search input / select filter should be nested inside this class name.
+  * `data-filter-url` Is mandatory, this is the search URL, Mostly this will hit the index action.
+  * `data-replacement-class` After ajax this is the class name where the data will get appended.
+  * `data-behaviour="filter"` If the input behaviour is set to filter then this will get added to ajax
+  * `data-scope="search"` This is the model scope name, The helper method will call this when filter is applied.
+  * `data-type="input-filter"` This is to tell if the element is input or select other value is `data-type="select-filter"`
+
+**STEP - 2 Pagination**
+
+We will add the paginate helper to the bottom of the partial which gets replaced.
+```
+= cm_paginate(@filtered_result.facets)
+```
+
+**STEP - 3 Sort**
+
+If any of the header needs to be sorted, then we will  add the following helper
+```
+th = sortable "name", "Name", @filtered_result.sort[:sort_column], @filtered_result.sort[:sort_direction]
+```
 
 ## Development
 

data/lib/spotlight_search.rb

@@ -14,6 +14,8 @@ module SpotlightSearch
       filtered_result.data = raw_data.page(page).per(30)
       filtered_result.facets = self.paginate(page, raw_data.size)
       filtered_result.sort = sort_params
+      filtered_result.facets.sort = sort_params
+
       return filtered_result
     end
 

data/lib/spotlight_search/version.rb

@@ -1,3 +1,3 @@
 module SpotlightSearch
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spotlight_search
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Anbazhagan Palani