spotlight_search 0.1.8 → 0.3.0

data/lib/spotlight_search/exceptions.rb

@@ -1,7 +1,7 @@
 module SpotlightSearch
   module Exceptions
     class InvalidColumns < StandardError
-      def initialize(columns: [])
+      def initialize(columns = [])
         message = 'Invalid columns found: ' + columns.map(&:to_s).join(', ')
         super(message)
       end

data/lib/spotlight_search/exportable_columns.rb

@@ -28,35 +28,30 @@ module SpotlightSearch
       #     export_columns enabled: true, except: [:created_at, :updated_at]
       #   end
       #
-      def export_columns(enabled: false, only: nil, except: nil)
-        begin
-          unless ActiveRecord::Base.connection.migration_context.needs_migration?
-            if enabled
-              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
-                self.enabled_columns = only
-              else
-                self.enabled_columns = all_columns
-              end
-              if except.present?
-                unless (valid_columns = except & all_columns).size == except.size
-                  invalid_columns = except - valid_columns
-                  raise SpotlightSearch::Exceptions::InvalidColumns.new(nil, invalid_columns)
-                end
-                self.enabled_columns = self.enabled_columns - except
-              end
-            else
-              self.export_enabled = false
-              self.enabled_columns = nil
-            end
+      def export_columns(enabled: false, only: nil, except: nil, associated: nil)
+        ActiveRecord::Base.connection.migration_context.needs_migration? && return
+        return unless enabled
+
+        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, invalid_columns
+          end
+          self.enabled_columns = only
+        else
+          self.enabled_columns = all_columns
+        end
+        if except.present?
+          unless (valid_columns = except & all_columns).size == except.size
+            invalid_columns = except - valid_columns
+            raise SpotlightSearch::Exceptions::InvalidColumns, invalid_columns
           end
-        rescue ActiveRecord::NoDatabaseError
+          self.enabled_columns = self.enabled_columns - except
         end
+      rescue ActiveRecord::NoDatabaseError
+        Rails.logger.info("No database error")
       end
 
       # Validates whether the selected columns are allowed for export
@@ -72,8 +67,8 @@ module SpotlightSearch
     end
 
     included do
-      class_attribute :enabled_columns, instance_accessor: false
-      class_attribute :export_enabled, instance_accessor: false
+      class_attribute :enabled_columns, instance_accessor: false, default: nil
+      class_attribute :export_enabled, instance_accessor: false, default: false
     end
   end
 end

data/lib/spotlight_search/exportable_columns_v2.rb

@@ -0,0 +1,90 @@
+module SpotlightSearch
+  module ExportableColumnsV2
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Enables or disables export and specifies which all columns can be
+      # exported. For enabling export for all columns in all models
+      #
+      #   class ApplicationRecord < ActiveRecord::Base
+      #     export_columns enabled: true
+      #   end
+      #
+      # For disabling export for only specific models
+      #
+      #   class Person < ActiveRecord::Base
+      #     export_columns enabled: false
+      #   end
+      #
+      # For allowing export for only specific columns in a model
+      #
+      #   class Person < ActiveRecord::Base
+      #     export_columns enabled: true, only: [:created_at, :updated_at]
+      #   end
+      #
+      # For excluding only specific columns and allowing all others
+      #
+      #   class Person < ActiveRecord::Base
+      #     export_columns enabled: true, except: [:created_at, :updated_at]
+      #   end
+      #
+      def export_columns(*record_fields, **associated_fields)
+        self.enabled_columns = [*record_fields, **associated_fields]
+      end
+
+      def _model_exportable_columns(klass, *record_fields, **associated_fields)
+        # Gets all the valid columns of a model
+        # If any column is invalid, it also returns it
+        raise SpotlightSearch::Exceptions::InvalidValue, "Expected ActiveRecord::Base, Received #{klass}" unless klass < ActiveRecord::Base
+
+        valid_columns = []
+        invalid_columns = []
+
+        # Base case: verify all the columns that belong to this record
+        record_fields.each do |field|
+          klass.new.respond_to?(field) ? valid_columns << field : invalid_columns << field
+        end
+
+        # Recursive case: check all associations and verify that they are all valid too
+        associated_fields.each do |association, association_record_fields|
+          reflection = klass.reflect_on_association(association)
+          invalid_columns << association && next unless reflection # Add whole association to invalid columns if it doesn't exist
+
+          case reflection
+          when ActiveRecord::Reflection::BelongsToReflection, ActiveRecord::Reflection::HasOneReflection
+            if reflection.polymorphic?
+              # We cannot process them further, so we'll assume it works and call it a day
+              valid_columns << { association => association_record_fields }
+            else
+              columns_hash = _model_exportable_columns(reflection.klass, *association_record_fields)
+              valid_columns << { association => columns_hash[:valid_columns] }
+              invalid_columns << { association => columns_hash[:invalid_columns] } if columns_hash[:invalid_columns].size.positive?
+            end
+          else
+            # one to many relationshops cannot be supported
+            invalid_columns << association
+            next
+          end
+        end
+
+        # return all the valid and invalid columns in a hash
+        {
+          valid_columns: valid_columns,
+          invalid_columns: invalid_columns
+        }
+      end
+
+      # Validates whether the selected columns are allowed for export
+      def validate_exportable_columns(columns)
+        unless columns.is_a? Array
+          raise SpotlightSearch::Exceptions::InvalidValue, 'Expected Array. Invalid type received'
+        end
+        (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
+    end
+  end
+end

data/lib/spotlight_search/helpers.rb

@@ -11,10 +11,10 @@ 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)
-      tag.div do
-        concat tag.button "Export as excel", class: "modal-btn", data: {toggle: "modal", target: "#exportmodal"}
-        concat column_pop_up(email, klass)
+    def exportable(email, klass, html_class: [])
+      tag.a "Export as excel", class: html_class.append("filter-btn modal-btn mr-2"), data: {toggle: "modal", target: "#exportmodal"} do
+        concat tag.i class: 'fa fa-download'
+        concat tag.span " Excel"
       end
     end
 
@@ -46,16 +46,29 @@ 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'
-          concat hidden_field_tag 'klass', klass.to_s, id: 'export-to-file-klass'
-          concat checkbox_row(klass)
-          concat submit_tag 'Export as excel', class: 'btn btn-bordered export-to-file-btn'
+          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)
+          when :v2
+            concat checkbox_row_v2(klass)
+          end
+          concat tag.hr
+          concat submit_tag 'Export as excel', class: 'btn btn-primary btn-bordered export-to-file-btn'
         end
       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|
@@ -67,30 +80,83 @@ module SpotlightSearch
     def create_checkbox(column_name)
       tag.div class: "col-md-4" do
         concat check_box_tag "columns[]", column_name.to_s
-        concat column_name.to_s
+        concat column_name.to_s.humanize
+      end
+    end
+
+    def filter_wrapper(data_behaviours, classes=nil)
+      tag.div class: "filter-wrapper d-flex filters #{classes}", data: data_behaviours do
+        yield
+      end
+    end
+
+    def cm_filter_tag(input_type, scope_name, value, classes = nil, placeholder = nil)
+      case input_type
+      when 'input'
+        tag.div class: 'filter-field' do
+          concat text_field_tag scope_name, '', class: "#{classes}", data: {behaviour: "filter", scope: scope_name, type: "input-filter"}, placeholder: "#{placeholder}"
+          concat tag.span class: 'fa fa-search search-icon'
+        end
+      when 'single-select'
+        tag.div class: 'filter-field' do
+          select_tag scope_name, options_for_select(value), class: "#{classes} select2-single", data: {behaviour: "filter", scope: scope_name, type: "select-filter"}, include_blank: "#{placeholder}"
+        end
+      when 'multi-select'
+        tag.div class: 'filter-field' do
+          select_tag scope_name, options_for_select(value), class: "#{classes} select2-single", data: {behaviour: "filter", scope: scope_name, type: "select-filter"}, include_blank: "#{placeholder}", multiple: true
+        end
+      when 'datetime'
+        tag.div class: 'filter-field' do
+          concat text_field_tag scope_name, '', class: "#{classes}", data: {behaviour: "filter", scope: scope_name, type: "input-filter", provide: "datepicker"}, placeholder: "#{placeholder}"
+          concat tag.span class: 'fa fa-search search-icon'
+        end
+      when 'daterange'
+        tag.div class: 'filter-field' do
+          concat text_field_tag scope_name, '', class: "#{classes} filter-rangepicker", data: {behaviour: "filter", scope: scope_name, type: "input-filter"}, placeholder: "#{placeholder}"
+          concat tag.span class: 'fa fa-search search-icon'
+        end
+      end
+    end
+
+    def clear_filters(clear_path, classes=nil, data_behaviours=nil, clear_text=nil)
+      link_to "#{clear_text}", clear_path, class: "#{classes}", data: data_behaviours
+    end
+
+    def checkbox_row_v2(klass)
+      tag.div class: "row" do
+        SpotlightSearch::Utils.serialize_csv_columns(*klass.enabled_columns).each do |column_path|
+          concat create_checkbox_v2(column_path)
+        end
+      end
+    end
+
+    def create_checkbox_v2(column_path)
+      tag.div class: "col-md-4" do
+        concat check_box_tag "columns[]", column_path, id: column_path.to_s.gsub('/', '-')
+        concat " " + column_path.to_s.gsub('/', '_').humanize
       end
     end
 
     def cm_paginate(facets)
-      tag.div class: 'text-center' do
+      tag.div class: 'cm-pagination' do
         tag.div class: 'nav navbar navbar-inner' do
           tag.ul class: 'pagination' do
             if facets.previous_page != false
               previous_page = tag.li do
-                tag.button class: 'btn btn-bordered', data: { behaviour: 'previous-page'} do
+                tag.button class: 'cm-pagination__item', data: { behaviour: 'previous-page'} do
                   tag.span "Previous"
                 end
               end
             end
             current_page = content_tag :li do
-              tag.a class: 'btn btn-bordered mx-2', data: {sort_column: facets.sort[:sort_column], sort_direction: facets.sort[:sort_direction], page: facets.current_page, behaviour: 'current-page' } do
+              tag.button class: 'cm-pagination__item', data: {sort_column: facets.sort[:sort_column], sort_direction: facets.sort[:sort_direction], page: facets.current_page, behaviour: 'current-page' } do
                 "Showing #{facets.current_page} of #{facets.total_pages} pages"
               end
             end
 
             if facets.next_page != false
               next_page = tag.li do
-                tag.button class: 'btn btn-bordered', data: { behaviour: 'next-page'} do
+                tag.button class: 'cm-pagination__item', data: { behaviour: 'next-page'} do
                   tag.span "Next"
                 end
               end

data/lib/spotlight_search/utils.rb

@@ -0,0 +1,69 @@
+
+
+module SpotlightSearch::Utils
+  class << self
+    def serialize_csv_columns(*columns, **hashes)
+      # 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.map(&:to_s) + hashes.map do |key, value|
+        serialize_csv_columns(*value).map do |column|
+          "#{key}/#{column}"
+        end
+      end.reduce([], :+)
+    end
+
+    def deserialize_csv_columns(list, method)
+      # Does the opposite operation of the above
+      list.reduce(recursive_hash) do |acc, item|
+        tokens = item.to_s.split('/')
+        send(method, acc, tokens.shift, tokens)
+      end
+    end
+
+    def base(hash, key, tokens) # recursive
+      hash.empty? && hash = { columns: [], associations: recursive_hash }
+      if tokens.empty?
+        # base case
+        hash[:columns] << key
+      else
+        # recursive case
+        # hash[:associations] ||= {}
+        hash[:associations][key] = base(hash[:associations][key], tokens.shift, tokens)
+      end
+      hash
+    end
+
+    def as_json_params(hash, key, tokens)
+      hash.empty? && hash = { only: [], methods: [], include: recursive_hash }
+      if tokens.empty?
+        # base case
+        hash[:methods] << key
+      else
+        # recursive case
+        # hash[:associations] ||= {}
+        hash[:include][key] = as_json_params(hash[:include][key], tokens.shift, tokens)
+      end
+      hash
+    end
+
+    def recursive_hash
+      func = ->(h, k) { h[k] = Hash.new(&func) }
+      # This hash creates a new hash, infinitely deep, whenever a value is not found
+      # recursive_hash[:a][:b][:c][:d] will never fail
+      Hash.new(&func)
+    end
+
+    def flatten_hash(hash, prefix="", separator="_")
+      hash.reduce({}) do |acc, item|
+        case item[1]
+        when Hash
+          acc.merge(flatten_hash(item[1], "#{prefix}#{item[0]}#{separator}"))
+        else
+          acc.merge("#{prefix}#{item[0]}" => item[1])
+        end
+      end
+    end
+
+  end
+end

data/lib/spotlight_search/version.rb

@@ -1,3 +1,3 @@
 module SpotlightSearch
-  VERSION = "0.1.8"
+  VERSION = "0.3.0"
 end

data/spotlight_search.gemspec

@@ -24,9 +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'
+  s.add_runtime_dependency 'caxlsx', "~> 3.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spotlight_search
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.3.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
@@ -67,33 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: axlsx
+  name: caxlsx
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: zip-zip
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.1
 description: |-
   This gem should help reduce the efforts in the admin panel.
     It has search, sort and pagination included
@@ -115,16 +101,31 @@ 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
 - config/routes.rb
+- lib/generators/spotlight_search/filter_generator.rb
+- lib/generators/spotlight_search/install_generator.rb
+- lib/generators/spotlight_search/templates/application.css.scss
+- lib/generators/spotlight_search/templates/application.js
+- lib/generators/spotlight_search/templates/coffee.js
+- lib/generators/spotlight_search/templates/controller.rb.erb
+- lib/generators/spotlight_search/templates/environment.js
+- lib/generators/spotlight_search/templates/filters.html.erb
+- lib/generators/spotlight_search/templates/scaffolds.coffee
+- lib/generators/spotlight_search/templates/spotlight_search.rb
+- lib/generators/spotlight_search/templates/webpacker.yml
+- lib/generators/spotlight_search/templates/webpacker_gem_assets.rb
 - lib/spotlight_search.rb
 - lib/spotlight_search/engine.rb
 - lib/spotlight_search/exceptions.rb
 - lib/spotlight_search/exportable_columns.rb
+- lib/spotlight_search/exportable_columns_v2.rb
 - lib/spotlight_search/helpers.rb
 - lib/spotlight_search/railtie.rb
+- lib/spotlight_search/utils.rb
 - lib/spotlight_search/version.rb
 - spotlight_search.gemspec
 homepage: https://github.com/commutatus/spotlight-search