spotlight_search 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d8c71e34af7024e41f5d6767ce6b9cc6a4466aed6882997d97b4f45e57c2500
-  data.tar.gz: bd7d756c813e0a0572dd4973e8f795ce5195740811460bd91fa595aafa556080
+  metadata.gz: 54325c91322549c86a04e26eb6dd5872f24aa8d898e9d7310342df5de1a486fb
+  data.tar.gz: 5061e4fcfac405f679a51f5059eb814ee7dfc582a16ccc118e6dff1ad18a0ac5
 SHA512:
-  metadata.gz: 9e83a3b01980d9d3fa0fea02ee9f9f226ec882dfbaaff6b13bf69748b9e37ef8e7cc6b8487cba6a27a4d2d1681864ae06d490628cf01d4746a6fce1c63cc9bf4
-  data.tar.gz: 1fca5cef1d8ced80eb3c9a040152277002758b592b34af18674ba205737fecba884de3f397ac4a4edf74b4104178dcdd1f75b4ae219f52b9b10e0a776adc8907
+  metadata.gz: 7734aa0197053178b3f40492016aa07bc7a5cd72117b976be40cb89bcdfaf8d855c93136bda421bf270e643d441fecb55c669e9f132bc5722a1f87947e2287b8
+  data.tar.gz: f4b3b1ad28f0d9859e9c52a82fe098c61e21c1262b087b537b5df80d8f67d5e91b8ccdbb3f1b6015dc2bf243688ed698e899675d000489559d981debd18b2235

data/Gemfile.lock

@@ -1,103 +1,112 @@
 PATH
   remote: .
   specs:
-    spotlight_search (0.1.1)
+    spotlight_search (0.1.9)
       axlsx
+      zip-zip
 
 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)
+    arel (9.0.0)
     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)
+    builder (3.2.4)
+    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)
+    minitest (5.14.0)
+    nio4r (2.5.2)
     nokogiri (1.10.3)
       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)
@@ -112,30 +121,32 @@ GEM
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
     rubyzip (1.0.0)
-    sprockets (3.7.2)
+    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

@@ -101,6 +101,10 @@ th = sortable "name", "Name", @filtered_result.sort[:sort_column], @filtered_res
 
 ### Export table data to excel
 
+**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.
+
 #### Initializer
 An initializer will have to be created to extend the functionality to ActiveRecord.
 
@@ -116,7 +120,34 @@ A line has to be added to the routes.
 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.
 
@@ -152,33 +183,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
+```
 
-<%= exportable(current_user.email, Person) %>
+All fields will be disabled by default, so you will need to explicitly enable them by passing them to `export_columns`
+
+```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

@@ -2,9 +2,9 @@ require 'axlsx'
 
 module SpotlightSearch
   class ExportJob < ApplicationJob
-    def perform(email, klass, columns = [], filters = {})
-      klass = klass.constantize
-      records = get_records(klass, filters, 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
@@ -15,24 +15,21 @@ module SpotlightSearch
       subject = "#{klass.name} export at #{Time.now}"
       ExportMailer.send_excel_file(email, file_path, subject).deliver_now
       File.delete(file_path)
+    rescue StandsrdError(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.empty?
-        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
+      if filters.present?
+        filters.each do |scope, scope_args|
+          records = records.send(scope, scope_args)
         end
-        if filters['sort'].present?
-          records = records.order("#{filters['sort']['sort_column']} #{filters['sort']['sort_direction']}")
-        end
-      else
+      end
+      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

data/app/mailers/spotlight_search/export_mailer.rb

@@ -6,5 +6,11 @@ module SpotlightSearch
       attachments[file_path.split('/').last] = File.read(file_path)
       mail(to: email, subject: subject)
     end
+
+    def send_error_message(email, err)
+      @error_message = err.message
+      mail(to: email, subject: "Error generating CSV file")
+      Rollbar.error(err)
+    end
   end
 end

data/app/views/spotlight_search/export_mailer/send_error_message.html.erb

@@ -0,0 +1,7 @@
+Hi,
+<br>
+There was an error autoexporting the CSV file:
+<%= @error_message %>
+Please find attached the exported contents.
+<br>
+Thanks

data/lib/spotlight_search/exportable_columns_v2.rb

@@ -29,17 +29,7 @@ module SpotlightSearch
       #   end
       #
       def export_columns(*record_fields, **associated_fields)
-        ActiveRecord::Base.connection.migration_context.needs_migration? && return
-
-        # Check that all record fields are valid accessible. Error if it doesn't.
-        # for each association, check that if its a valid association, and take the recursive step with that association
-        # End result is setting up in self, enabled columns and enabled associated columns
-        columns_hash = _model_exportable_columns(self, *record_fields, **associated_fields)
-
-        raise SpotlightSearch::Exceptions::InvalidColumns, columns_hash[:invalid_columns] if columns_hash[:invalid_columns].size.positive?
         self.enabled_columns = [*record_fields, **associated_fields]
-      rescue ActiveRecord::NoDatabaseError
-        Rails.logger.info("No database error")
       end
 
       def _model_exportable_columns(klass, *record_fields, **associated_fields)
@@ -86,17 +76,15 @@ module SpotlightSearch
 
       # Validates whether the selected columns are allowed for export
       def validate_exportable_columns(columns)
-        unless columns.is_a?(Array)
+        unless columns.is_a? Array
           raise SpotlightSearch::Exceptions::InvalidValue, 'Expected Array. Invalid type received'
         end
-
-        true
+        (columns & SpotlightSearch::Utils.serialize_csv_columns(*enabled_columns)).size == columns.size # returns true if all columns are valid
       end
     end
 
     included do
       class_attribute :enabled_columns, instance_accessor: false, default: nil
-      class_attribute :enabled_associated_columns, instance_accessor: false, default: nil
     end
   end
 end

data/lib/spotlight_search/helpers.rb

@@ -11,9 +11,9 @@ module SpotlightSearch
       content_tag("a", title, class: css_class, data: {sort_column: column, sort_direction: direction, behaviour: 'sort', type: 'anchor-filter'})
     end
 
-    def exportable(email, klass)
+    def exportable(email, klass, html_class: [])
       tag.div do
-        concat tag.button "Export as excel", class: "modal-btn", data: {toggle: "modal", target: "#exportmodal"}
+        concat tag.button "Export as excel", class: html_class.append("modal-btn"), data: {toggle: "modal", target: "#exportmodal"}
         concat column_pop_up(email, klass)
       end
     end
@@ -46,10 +46,11 @@ module SpotlightSearch
 
     def pop_up_body(email, klass)
       tag.div class: "modal-body" do
-        form_tag '/spotlight_search/export_to_file', id: 'export-to-file-form', style: "width: 100%;" do
+        form_tag '/spotlight_search/export_to_file', id: 'export-to-file-form', style: "width: 100%;", class:"spotlight-csv-export-form" do
           concat hidden_field_tag 'email', email, id: 'export-to-file-email'
-          concat hidden_field_tag 'filters', nil, id: 'export-to-file-filters' # Filters are not being sent
-          concat hidden_field_tag 'klass', klass.to_s, id: 'export-to-file-klass'
+          concat hidden_field_tag 'class_name', klass.to_s, id: 'export-to-file-klass'
+          params_to_post_helper(filters: controller.filter_params) if controller.filter_params
+          params_to_post_helper(sort: controller.sort_params) if controller.sort_params
           case SpotlightSearch.exportable_columns_version
           when :v1
             concat checkbox_row(klass)
@@ -61,6 +62,12 @@ module SpotlightSearch
       end
     end
 
+    def params_to_post_helper(params)
+      URI.decode_www_form(params.to_param).each do |param|
+        concat hidden_field_tag param[0], param[1]
+      end
+    end
+
     def checkbox_row(klass)
       tag.div class: "row" do
         klass.enabled_columns.each do |column_name|
@@ -86,8 +93,8 @@ module SpotlightSearch
 
     def create_checkbox_v2(column_path)
       tag.div class: "col-md-4" do
-        concat check_box_tag "columns[]", column_path
-        concat column_path.to_s.split('/').join('_').humanize
+        concat check_box_tag "columns[]", column_path, id: column_path.to_s.gsub('/', '-')
+        concat column_path.to_s.gsub('/', '_').humanize
       end
     end
 

data/lib/spotlight_search/utils.rb

@@ -6,7 +6,7 @@ module SpotlightSearch::Utils
       # Turns an arbitrary list of args and kwargs into a list of params to be used in a form
       # For example, turns SpotlightSearch::Utils.serialize_csv_columns(:a, :b, c: [:d, e: :h], f: :g)
       # into [:a, :b, "c/d", "c/e/h", "f/g"]
-      columns + hashes.map do |key, value|
+      columns.map(&:to_s) + hashes.map do |key, value|
         serialize_csv_columns(*value).map do |column|
           "#{key}/#{column}"
         end

data/lib/spotlight_search/version.rb

@@ -1,3 +1,3 @@
 module SpotlightSearch
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

data/spotlight_search.gemspec

@@ -24,8 +24,8 @@ Gem::Specification.new do |s|
   # s.require_paths = ["lib"]
 
   s.add_development_dependency "bundler", "~> 2.0"
-  s.add_development_dependency "rake", "~> 10.0"
-  s.add_development_dependency "rails", "~> 5.0.7"
+  s.add_development_dependency "rake", ">= 12.3.3"
+  s.add_development_dependency "rails", "~> 5.2.4.2"
   s.add_development_dependency "rspec", "~> 3.0"
   s.add_runtime_dependency 'axlsx'
   s.add_runtime_dependency 'zip-zip'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spotlight_search
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Anbazhagan Palani
@@ -28,30 +28,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.7
+        version: 5.2.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.7
+        version: 5.2.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +115,7 @@ files:
 - app/controllers/spotlight_search/export_jobs_controller.rb
 - app/jobs/spotlight_search/export_job.rb
 - app/mailers/spotlight_search/export_mailer.rb
+- app/views/spotlight_search/export_mailer/send_error_message.html.erb
 - app/views/spotlight_search/export_mailer/send_excel_file.html.erb
 - bin/console
 - bin/setup