spotlight_search 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c89b4b5abbf14d2a5f0bd0b32ebe1f969664d6f15a1546d8da52c5350533dd2
-  data.tar.gz: 488483330b4d7884daa56e00b276c916eb1e880cedf17930417c94ad35edc5e9
+  metadata.gz: ebb484f3b104c1ed0b34ed7e4ba4dac94e2632b36911cf3697fa3f30d23330b3
+  data.tar.gz: 6ffabe8806b83e10a7f86bb959fec8d17e508f6f11d2508a93da0be9f4cc49e3
 SHA512:
-  metadata.gz: 1774df1335f355630535500a67dbecd62a3291aceeb82bd957ee77fcd47664a078a653a0657cca931a22333aed4683fac9107d4219a4a3ec4a6dc7b4d5d7b689
-  data.tar.gz: b52de4cc8d6a3a22e2ed8b4fc76e92f4d5c8e1e71c878bb0b84676dd9f3590e64d848e5eadd2ea2d0b3b4030881a1854840a74ef4c820cdc6b7a49549a02d8e3
+  metadata.gz: 58e302960d4d8d7ac6ee92f3341f322929cd2a005367fa03f5ae71f8ed6b8516aa59640bfe96618e66bd59504c9ae02347ba58895ec76e6703d2886e1f214785
+  data.tar.gz: 7acb7215272cb8c7aca91d51f80867ae658d95fbed6adba0179768a331bff8e52f87386a6a9a69f7008a2cd3d1c9071cde3bb2acad6da46e5862af8eb13de94e

data/README.md

@@ -20,9 +20,17 @@ Or install it manually:
 
 ## Usage
 
-After installing the gem to the project, there are few places you will have to make changes.
+1. [Filtering, Sorting and Pagination](#filtering-sorting-and-pagination)
+  * [Controller](#controller)
+  * [View](#view)
+2. [Export table data to excel](#export-table-data-to-excel)
+  * [Initializer](#initializer)
+  * [Model](#model)
+  * [View](#export-view)
 
-### Controller
+### Filtering, Sorting and Pagination
+
+#### Controller
 
 **STEP - 1**
 
@@ -50,7 +58,9 @@ def sort_params
 end
 ```
 
-### HTML
+#### View
+Please note that the below code is in haml.
+
 **STEP - 1 Search**
 
 First step is to add the input box to search. Here there are few elements that should be placed mandatorily.
@@ -79,12 +89,20 @@ We will add the paginate helper to the bottom of the partial which gets replaced
 
 **STEP - 3 Sort**
 
-If any of the header needs to be sorted, then we will  add the following helper
+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]
 ```
 
-### Export to file
+### Export table data to excel
+
+#### Initializer
+An initializer will have to be created to extend the functionality to ActiveRecord.
+
+```ruby
+  # config/initializers/spotlight_search.rb
+  ActiveRecord::Base.include SpotlightSearch::ExportableColumns
+```
 
 #### Model
 Enables or disables export and specifies which all columns can be
@@ -122,7 +140,7 @@ For excluding only specific columns and allowing all others
   end
 ```
 
-#### View
+#### <a name="export-view"></a>View
 
 Add `exportable email, model_object` in your view to display the export button.
 

data/lib/spotlight_search/exportable_columns.rb

@@ -1,6 +1,6 @@
 module SpotlightSearch
   module ExportableColumns
-    cattr_accessor :enabled_columns, :export_enabled
+    extend ActiveSupport::Concern
 
     module ClassMethods
       # Enables or disables export and specifies which all columns can be
@@ -30,27 +30,27 @@ module SpotlightSearch
       #
       def export_columns(enabled: false, only: nil, except: nil)
         if enabled
-          @@export_enabled = true
+          self.export_enabled = true
           all_columns = self.column_names.map(&:to_sym)
           if only.present?
             unless (valid_columns = only & all_columns).size == only.size
               invalid_columns = only - valid_columns
               raise SpotlightSearch::Exceptions::InvalidColumns.new(nil, invalid_columns)
             end
-            @@enabled_columns = only
+            self.enabled_columns = only
           else
-            @@enabled_columns = all_columns
+            self.enabled_columns = all_columns
           end
           if except.present?
-            unless (valid_columns = except & all_columns).size == only.size
+            unless (valid_columns = except & all_columns).size == except.size
               invalid_columns = except - valid_columns
               raise SpotlightSearch::Exceptions::InvalidColumns.new(nil, invalid_columns)
             end
-            @@enabled_columns = @@enabled_columns - except
+            self.enabled_columns = self.enabled_columns - except
           end
         else
-          @@export_enabled = false
-          @@enabled_columns = nil
+          self.export_enabled = false
+          self.enabled_columns = nil
         end
       end
 
@@ -59,13 +59,16 @@ module SpotlightSearch
         unless columns.is_a?(Array)
           raise SpotlightSearch::Exceptions::InvalidValue.new('Excepted Array. Invalid type received')
         end
-        unless (@@enabled_columns & columns.map(&:to_sym)) == columns.size
+        unless (self.enabled_columns & columns.map(&:to_sym)) == columns.size
           return false
         end
         return true
       end
     end
+
+    included do
+      class_attribute :enabled_columns, instance_accessor: false
+      class_attribute :export_enabled, instance_accessor: false
+    end
   end
 end
-
-ActiveRecord::Base.extend SpotlightSearch::ExportableColumns

data/lib/spotlight_search/version.rb

@@ -1,3 +1,3 @@
 module SpotlightSearch
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/spotlight_search.rb

@@ -1,12 +1,14 @@
 require 'spotlight_search/engine'
 require 'spotlight_search/version'
+require 'spotlight_search/exportable_columns'
 require 'spotlight_search/railtie' if defined?(Rails)
+require 'active_support'
+require 'active_support/rails'
 
 module SpotlightSearch
   extend ActiveSupport::Concern
 
   autoload :Exceptions, 'spotlight_search/exceptions'
-  autoload :ExportableColumns, 'spotlight_search/exportable_columns'
 
   module ClassMethods
     def filter_by(page, filter_params = {}, sort_params = {})
@@ -62,5 +64,4 @@ module SpotlightSearch
       return facets
     end
   end
-
 end

metadata

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