spotlight_search 0.1.7 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c0ea70816711ee5ddc92a80692e72fba928b39161c2d24deb08b4ab58484f16
-  data.tar.gz: 27427b059ab99ac747e3239b5bf5e3675924966f724eecac804185c8b7198132
+  metadata.gz: b8d70a1928ef9bfa68c81817f7ab8ba5bb70848ab5c68223ad52294f2cc0e41b
+  data.tar.gz: 0e87e9608d99ffb50b6b6239f7af51e01f1b916919062a97b086466b8403caa5
 SHA512:
-  metadata.gz: b898869bc37e815628e98a1851e63cdb854b5f5a3b5056cefca336aef92430fbb6755d07f22c33fde9cb43635ac25d88a9298e8c4b90dbd6c7b96f688acaa92f
-  data.tar.gz: 0e740359d3610928b62382c6eecf38f81faff3e82039236c63e6c3909e82ce8e0536ee96e313b610417650888f7f1ac9955284177a4fa5051435c66f4492abeb
+  metadata.gz: ddd8e03cad7ed5f110c5b9e158f2f40a4efe5551371da46caf92cf3b1c57b6b2b405aee83dabf0050f732e571c7ff891407c5a65906095bddce904771772e63e
+  data.tar.gz: 4b3b4880334b8b5a55fb0224e4878da2673bbaade2c221194c9e178e3cd2d633dd5275bfb60ce8c353de072003ac5d2999beb92613820112aa1909736e462a2d

data/Gemfile.lock

@@ -1,103 +1,112 @@
 PATH
   remote: .
   specs:
-    spotlight_search (0.1.1)
-      axlsx
+    spotlight_search (0.1.9)
+      caxlsx (~> 3.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.0.7.2)
-      actionpack (= 5.0.7.2)
-      nio4r (>= 1.2, < 3.0)
-      websocket-driver (~> 0.6.1)
-    actionmailer (5.0.7.2)
-      actionpack (= 5.0.7.2)
-      actionview (= 5.0.7.2)
-      activejob (= 5.0.7.2)
+    actioncable (5.2.4.2)
+      actionpack (= 5.2.4.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.4.2)
+      actionpack (= 5.2.4.2)
+      actionview (= 5.2.4.2)
+      activejob (= 5.2.4.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.0.7.2)
-      actionview (= 5.0.7.2)
-      activesupport (= 5.0.7.2)
-      rack (~> 2.0)
-      rack-test (~> 0.6.3)
+    actionpack (5.2.4.2)
+      actionview (= 5.2.4.2)
+      activesupport (= 5.2.4.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.7.2)
-      activesupport (= 5.0.7.2)
+    actionview (5.2.4.2)
+      activesupport (= 5.2.4.2)
       builder (~> 3.1)
-      erubis (~> 2.7.0)
+      erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.0.7.2)
-      activesupport (= 5.0.7.2)
+    activejob (5.2.4.2)
+      activesupport (= 5.2.4.2)
       globalid (>= 0.3.6)
-    activemodel (5.0.7.2)
-      activesupport (= 5.0.7.2)
-    activerecord (5.0.7.2)
-      activemodel (= 5.0.7.2)
-      activesupport (= 5.0.7.2)
-      arel (~> 7.0)
-    activesupport (5.0.7.2)
+    activemodel (5.2.4.2)
+      activesupport (= 5.2.4.2)
+    activerecord (5.2.4.2)
+      activemodel (= 5.2.4.2)
+      activesupport (= 5.2.4.2)
+      arel (>= 9.0)
+    activestorage (5.2.4.2)
+      actionpack (= 5.2.4.2)
+      activerecord (= 5.2.4.2)
+      marcel (~> 0.3.1)
+    activesupport (5.2.4.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (7.1.4)
-    axlsx (2.0.1)
-      htmlentities (~> 4.3.1)
-      nokogiri (>= 1.4.1)
-      rubyzip (~> 1.0.0)
-    builder (3.2.3)
-    concurrent-ruby (1.1.5)
-    crass (1.0.4)
+    arel (9.0.0)
+    builder (3.2.4)
+    caxlsx (3.0.1)
+      htmlentities (~> 4.3, >= 4.3.4)
+      mimemagic (~> 0.3)
+      nokogiri (~> 1.10, >= 1.10.4)
+      rubyzip (>= 1.3.0, < 3)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
     diff-lcs (1.3)
-    erubis (2.7.0)
+    erubi (1.9.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     htmlentities (4.3.4)
-    i18n (1.6.0)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    loofah (2.2.3)
+    loofah (2.4.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    method_source (0.9.2)
-    mini_mime (1.0.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nio4r (2.3.1)
-    nokogiri (1.10.3)
+    minitest (5.14.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    rack (2.0.7)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (5.0.7.2)
-      actioncable (= 5.0.7.2)
-      actionmailer (= 5.0.7.2)
-      actionpack (= 5.0.7.2)
-      actionview (= 5.0.7.2)
-      activejob (= 5.0.7.2)
-      activemodel (= 5.0.7.2)
-      activerecord (= 5.0.7.2)
-      activesupport (= 5.0.7.2)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.4.2)
+      actioncable (= 5.2.4.2)
+      actionmailer (= 5.2.4.2)
+      actionpack (= 5.2.4.2)
+      actionview (= 5.2.4.2)
+      activejob (= 5.2.4.2)
+      activemodel (= 5.2.4.2)
+      activerecord (= 5.2.4.2)
+      activestorage (= 5.2.4.2)
+      activesupport (= 5.2.4.2)
       bundler (>= 1.3.0)
-      railties (= 5.0.7.2)
+      railties (= 5.2.4.2)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.0.7.2)
-      actionpack (= 5.0.7.2)
-      activesupport (= 5.0.7.2)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.4.2)
+      actionpack (= 5.2.4.2)
+      activesupport (= 5.2.4.2)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (10.5.0)
+      thor (>= 0.19.0, < 2.0)
+    rake (13.0.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -111,31 +120,33 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubyzip (1.0.0)
-    sprockets (3.7.2)
+    rubyzip (2.3.0)
+    sprockets (4.0.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.2.1)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (0.20.3)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
-    websocket-driver (0.6.5)
+    websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)
+    zip-zip (0.3)
+      rubyzip (>= 1.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 2.0)
-  rails (~> 5.0.7)
-  rake (~> 10.0)
+  rails (~> 5.2.4.2)
+  rake (>= 12.3.3)
   rspec (~> 3.0)
   spotlight_search!
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README.md

@@ -1,7 +1,16 @@
+[![Gem Version](https://badge.fury.io/rb/spotlight_search.svg)](https://badge.fury.io/rb/spotlight_search)
+
 # SpotlightSearch
 
 It helps filtering, sorting and exporting tables easier.
 
+First create a new rails project with the following command. If you are adding to existing project skip this
+
+```
+rails new blog -m https://raw.githubusercontent.com/commutatus/cm-rails-template/devise_integration/template.rb
+```
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,6 +27,31 @@ Or install it manually:
 
     $ gem install spotlight_search
 
+Generator that installs mandatory files and gems to application
+
+    $ rails g spotlight_search:install
+
+The install generator does the following
+
+* `require spotlight_search` added to application.js
+
+* Copies required files for the spotlight_search to work, Such as gemassets.rb, webpacker.yml, environment.js
+
+* Copies initializer file
+
+* Adds a line in route for mounting.
+
+Generator that installs filter and table files to application
+
+    $ rails g spotlight_search:filter orders --filters search:input order_status:multi_select status:select
+
+The install generator does the following
+
+* Copies the filter partial and the controller with necessary changes
+
+Filter arguments can be passed as an array and the format is `filter_scope:type_of_filter_input`
+
+
 ## Usage
 
 1. [Filtering, Sorting and Pagination](#filtering-sorting-and-pagination)
@@ -62,24 +96,20 @@ end
 #### View
 Please note that the below code is in haml.
 
-**STEP - 1 Search**
+**STEP - 1 Filters**
 
-First step is to add the input box to search. Here there are few elements that should be placed mandatorily.
+**Filter Wrapper, Select-tags and Inputs**
 
-```
-.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
+| Generator                                                                        | *Mandatory(Data Attributes, Select options)                                                                            | *Optional(Classes, Placeholders)                                                       |
+|----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
+| `= filter_wrapper(data_behaviours, classes=nil)`                                 | `{filter_url: '/users', replacement_class: 'users-table'}`                                                             | "filter-classes"                                                                       |
+|                                                                                  |                                                                                                                        |                                                                                        |
+| `= cm_select_tag(select_options, data_behaviours, classes=nil, placeholder=nil)` | `{behaviour: "filter", scope: "status", type: "select-filter}` , User.all.map {\|user\| [user.name.titleize, user.id]} | `"user-select"`, placeholder = `"Users"`                                               |
+|                                                                                  |                                                                                                                        |                                                                                        |
+| `= cm_textfield_tag(data_behaviours, classes=nil, placeholder=nil)`              | `{behaviour: "filter", scope: "search", type: "input-filter}`                                                          | `"user-search"`, placeholder = `"Search"`                                              |
+|                                                                                  |                                                                                                                        |                                                                                        |
+| `= clear_filters(clear_path, classes=nil, data_behaviours=nil, clear_text=nil)`  | clear_path = `users_path`                                                                                              | `"clear-filter"`, data_behaviours = `{behaviour: 'clear'}`, clear_text = `"Clear all"` |
 
-  * `.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**
 
@@ -97,22 +127,39 @@ th = sortable "name", "Name", @filtered_result.sort[:sort_column], @filtered_res
 
 ### Export table data to excel
 
-#### Initializer
-An initializer will have to be created to extend the functionality to ActiveRecord.
+**Note**
 
-```ruby
-  # config/initializers/spotlight_search.rb
-  ActiveRecord::Base.include SpotlightSearch::ExportableColumns
-```
+You will need to have a background job processor such as `sidekiq`, `resque`, `delayed_job` etc as the file will be generated in the background and will be sent to the email passed. If you need to use any other service for sending emails, you will need to override `ExportMailer` class.
 
-#### Routes
-A line has to be added to the routes.
 
-```ruby
-mount SpotlightSearch::Engine => '/spotlight_search'
+#### <a name="export-view"></a>View
+
+Add `exportable email, model_object` in your view to display the export button.
+
+```html+erb
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Email</th>
+  </tr>
+  <td>
+    <% @records.each do |record| %>
+      <tr>
+        <td><%= record.name %></td>
+        <td><%= record.value %></td>
+    <% end %>
+  </td>
+</table>
+
+<%= exportable(current_user.email, Person) %>
 ```
 
+This will first show a popup where an option to select the export enabled columns will be listed. This will also apply any filters that has been selected along with a sorting if applied. It then pushes the export to a background job which will send an excel file of the contents to the specified email. You can edit the style of the button using the class `export-to-file-btn`.
+
 #### Model
+
+##### V1
+
 Enables or disables export and specifies which all columns can be
 exported. Export is disabled for all columns by default.
 
@@ -148,33 +195,33 @@ For excluding only specific columns and allowing all others
   end
 ```
 
-#### <a name="export-view"></a>View
+##### V2
 
-Add `exportable email, model_object` in your view to display the export button.
+To use version two of column export, which supports model methods and nested associations, set it up in the spotlight initializer like this:
+```ruby
+# config/initializers/spotlight_search.rb
+ActiveRecord::Base.include SpotlightSearch::ExportableColumns
 
-```html+erb
-<table>
-  <tr>
-    <th>Name</th>
-    <th>Email</th>
-  </tr>
-  <td>
-    <% @records.each do |record| %>
-      <tr>
-        <td><%= record.name %></td>
-        <td><%= record.value %></td>
-    <% end %>
-  </td>
-</table>
+SpotlightSearch.setup do |config|
+  config.exportable_columns_version = :v2
+end
+```
+
+All fields will be disabled by default, so you will need to explicitly enable them by passing them to `export_columns`
 
-<%= exportable(current_user.email, current_user.class) %>
+```ruby
+class Person < ActiveRecord::Base
+  export_columns :created_at, :formatted_amount, :preferred_month, :orderable_type, :payment_type, :status, customer: [:full_name, :email, :mobile_number, :city, :college], orderable: :orderable_display_name, seller: [:full_name]
+end
 ```
 
-This will first show a popup where an option to select the export enabled columns will be listed. This will also apply any filters that has been selected along with a sorting if applied. It then pushes the export to a background job which will send an excel file of the contents to the specified email. You can edit the style of the button using the class `export-to-file-btn`.
+Nested association fields should go at the end of `export_columns`, following Ruby's standard syntax of placing keyword arguments at the end
+
+**Notes**
+- You will need to make `filter_params` and `sort_params` in your controller public, or the rendering of the form will fail
+- Be careful with methods that return a hash, as the algorithm will recursively create one column for every key inside that hash. One example is `Money` fields from the `money-rails` gem
 
-**Note**
 
-You will need to have a background job processor such as `sidekiq`, `resque`, `delayed_job` etc as the file will be generated in the background and will be sent to the email passed. If you need to use any other service for sending emails, you will need to override `ExportMailer` class.
 
 ## Development
 

data/app/controllers/spotlight_search/export_jobs_controller.rb

@@ -2,17 +2,17 @@ module SpotlightSearch
   class ExportJobsController < ApplicationController
     def export_job
       begin
-        klass = params[:klass].constantize
+        klass = params[:class_name].constantize
         if klass.validate_exportable_columns(params[:columns])
-          ExportJob.perform_later(params[:email], klass.to_s, params[:columns], params[:filters])
-          flash[:success] = 'Successfully queued for export'
+          ExportJob.perform_later(klass.name, params[:email], params[:columns], params[:filters], params[:sort])
+          notice = 'Successfully queued for export'
         else
-          flash[:error] = 'Invalid columns found'
+          notice = 'Invalid columns found'
         end
-      rescue
-        flash[:error] = 'No records to import'
+      rescue StandardError => e
+        notice = e.message
       ensure
-        redirect_back fallback_location: root_path
+        redirect_back fallback_location: root_path, notice: notice
       end
     end
   end

data/app/jobs/spotlight_search/export_job.rb

@@ -1,34 +1,46 @@
-require 'axlsx'
+require 'caxlsx'
 
 module SpotlightSearch
   class ExportJob < ApplicationJob
-    def perform(email, klass, columns = [], filters = {})
-      klass = klass.constantize
-      records = get_records(klass, filters, columns)
-      file_path = create_excel(records, klass.name, columns)
+    def perform(klass_name, email, columns = [], filters = {}, sort = {})
+      klass = klass_name.constantize
+      records = get_records(klass, columns, filters, sort)
+      file_path =
+        case SpotlightSearch.exportable_columns_version
+        when :v1
+          create_excel(records, klass.name, columns)
+        when :v2
+          create_excel_v2(records, klass.name)
+        end
       subject = "#{klass.name} export at #{Time.now}"
       ExportMailer.send_excel_file(email, file_path, subject).deliver_now
       File.delete(file_path)
+    rescue StandardError => e
+      ExportMailer.send_error_message(email, e).deliver_now
     end
 
-    def get_records(klass, filters, columns)
+    def get_records(klass, columns, filters, sort)
       records = klass
-      if filters
-        if filters['filters'].present?
-          filters['filters'].each do |scope, scope_args|
-            if scope_args.is_a?(Array)
-              records = records.send(scope, *scope_args)
-            else
-              records = records.send(scope, scope_args)
-            end
-          end
-        end
-        if filters['sort'].present?
-          records = records.order("#{filters['sort']['sort_column']} #{filters['sort']['sort_direction']}")
+      if filters.present?
+        filters.each do |scope, scope_args|
+          records = records.send(scope, scope_args)
         end
       end
-      columns = columns.map(&:to_sym)
-      records.select(*columns)
+      if sort.present?
+        records = records.order("#{sort['sort_column']} #{sort['sort_direction']}")
+      end
+      if filters.blank? && sort.blank?
+        records = records.all
+      end
+      case SpotlightSearch.exportable_columns_version
+      when :v1
+        columns = columns.map(&:to_sym)
+        records.select(*columns)
+      when :v2
+        deserialized_columns = SpotlightSearch::Utils.deserialize_csv_columns(columns, :as_json_params)
+        # This includes isn't recursve, a full solution should be recursive
+        records.includes(deserialized_columns[:include].keys).find_each.as_json(deserialized_columns)
+      end
     end
 
     # Creating excel with the passed records
@@ -48,5 +60,23 @@ module SpotlightSearch
       xl.serialize(file_location)
       file_location
     end
+
+    def create_excel_v2(records, class_name)
+      flattened_records = records.map { |record| SpotlightSearch::Utils.flatten_hash(record) }
+      columns = flattened_records[0].keys
+      size_arr = []
+      columns.size.times { size_arr << 22 }
+      xl = Axlsx::Package.new
+      xl.workbook.add_worksheet do |sheet|
+        sheet.add_row columns, b: true
+        flattened_records.each do |record|
+          sheet.add_row(columns.map { |column| record[column] })
+        end
+        sheet.column_widths(*size_arr)
+      end
+      file_location = "#{Rails.root}/public/export_#{class_name}_#{Time.now.to_s}.xls"
+      xl.serialize(file_location)
+      file_location
+    end
   end
 end