spotlight_search 0.2.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54325c91322549c86a04e26eb6dd5872f24aa8d898e9d7310342df5de1a486fb
-  data.tar.gz: 5061e4fcfac405f679a51f5059eb814ee7dfc582a16ccc118e6dff1ad18a0ac5
+  metadata.gz: '099ecfc87e93555a16a5e494f3b88f69cbe8688c967444b5fac831dc62b5b650'
+  data.tar.gz: 5d3853b623df2045aadb98b70f69dfd9faf9b8d0878a4cb080bdeccaf6f5f396
 SHA512:
-  metadata.gz: 7734aa0197053178b3f40492016aa07bc7a5cd72117b976be40cb89bcdfaf8d855c93136bda421bf270e643d441fecb55c669e9f132bc5722a1f87947e2287b8
-  data.tar.gz: f4b3b1ad28f0d9859e9c52a82fe098c61e21c1262b087b537b5df80d8f67d5e91b8ccdbb3f1b6015dc2bf243688ed698e899675d000489559d981debd18b2235
+  metadata.gz: 651ec6f74e9c8d4bae5678be1636a157e13fa2420446ce50e4f0f7d68a438c0247d3f682f1759aedeed5d99095e5bd4a39957e99cad62ea38d747ad17dd8a068
+  data.tar.gz: 909f5d9e9a2472bd63d4d7db9ecd77e9c0007f4b10072eb1106ff7f411b45bf103c47de44dd9e03c1c64d8099bf85aa5cd21780287881036a5c4880ce03a7ab4

data/Gemfile.lock

@@ -2,8 +2,7 @@ PATH
   remote: .
   specs:
     spotlight_search (0.1.9)
-      axlsx
-      zip-zip
+      caxlsx (~> 3.0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -50,11 +49,12 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (9.0.0)
-    axlsx (2.0.1)
-      htmlentities (~> 4.3.1)
-      nokogiri (>= 1.4.1)
-      rubyzip (~> 1.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)
@@ -77,7 +77,7 @@ GEM
     mini_portile2 (2.4.0)
     minitest (5.14.0)
     nio4r (2.5.2)
-    nokogiri (1.10.3)
+    nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
     rack (2.2.2)
     rack-test (1.1.0)
@@ -120,7 +120,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubyzip (1.0.0)
+    rubyzip (2.3.0)
     sprockets (4.0.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -134,9 +134,7 @@ GEM
       thread_safe (~> 0.1)
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
-    zip-zip (0.3)
-      rubyzip (>= 1.0.0)
+    websocket-extensions (0.1.5)
 
 PLATFORMS
   ruby

data/README.md

@@ -4,6 +4,13 @@
 
 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:
@@ -20,7 +27,33 @@ Or install it manually:
 
     $ gem install spotlight_search
 
-Include the spotlight_search javascript by adding the line `//= require spotlight_search` to your `app/assets/javascripts/application.js`
+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 scope_name:filter_type
+    $ rails g spotlight_search filter orders --filters search:input order_status:multi_select status:select
+
+scope_name is the model scope name, scope can written after running this generator, it won't throw any error that it has to be present.
+
+Following filter type are supported
+* input
+* single-select
+* multi-select
+* datetime
+* daterange
+
 
 ## Usage
 
@@ -66,24 +99,20 @@ end
 #### 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.
+**STEP - 1 Filters**
 
-```
-.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"
-```
+**Filter Wrapper, Select-tags and Inputs**
 
-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**
 
@@ -105,20 +134,6 @@ th = sortable "name", "Name", @filtered_result.sort[:sort_column], @filtered_res
 
 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.
-
-```ruby
-  # config/initializers/spotlight_search.rb
-  ActiveRecord::Base.include SpotlightSearch::ExportableColumns
-```
-
-#### Routes
-A line has to be added to the routes.
-
-```ruby
-mount SpotlightSearch::Engine => '/spotlight_search'
-```
 
 #### <a name="export-view"></a>View
 

data/app/assets/javascripts/spotlight_search.js

@@ -74,6 +74,15 @@ $(document).on('keyup', '[data-type="input-filter"]', function() {
   });
 });
 
+$(document).on('change', '[data-type="range-filter"]', function() {
+  var thisObj;
+  thisObj = $(this);
+  return $(function() {
+    return get_paginated_list(1, thisObj);
+  });
+});
+
+
 $(document).on('change', '[data-type="select-filter"]', function() {
   var thisObj;
   thisObj = $(this);

data/app/controllers/spotlight_search/export_jobs_controller.rb

@@ -4,7 +4,9 @@ module SpotlightSearch
       begin
         klass = params[:class_name].constantize
         if klass.validate_exportable_columns(params[:columns])
-          ExportJob.perform_later(klass.name, params[:email], params[:columns], params[:filters], params[:sort])
+          (filter_params = params[:filters].permit!) if params[:filters].present?
+          (sort_params = params[:sort].permit!) if params[:sort].present?
+          ExportJob.perform_later(klass.name, params[:email], params[:columns], filter_params, sort_params)
           notice = 'Successfully queued for export'
         else
           notice = 'Invalid columns found'

data/app/jobs/spotlight_search/export_job.rb

@@ -1,4 +1,4 @@
-require 'axlsx'
+require 'caxlsx'
 
 module SpotlightSearch
   class ExportJob < ApplicationJob
@@ -15,7 +15,7 @@ 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)
+    rescue StandardError => e
       ExportMailer.send_error_message(email, e).deliver_now
     end
 
@@ -26,6 +26,11 @@ module SpotlightSearch
           records = records.send(scope, scope_args)
         end
       end
+      if klass.default_filters.present?
+        klass.default_filters.each do |scope|
+          records = records.send(scope)
+        end
+      end
       if sort.present?
         records = records.order("#{sort['sort_column']} #{sort['sort_direction']}")
       end
@@ -37,7 +42,9 @@ module SpotlightSearch
         columns = columns.map(&:to_sym)
         records.select(*columns)
       when :v2
-        records.as_json(SpotlightSearch::Utils.deserialize_csv_columns(columns, :as_json_params))
+        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
 
@@ -66,7 +73,7 @@ module SpotlightSearch
       columns.size.times { size_arr << 22 }
       xl = Axlsx::Package.new
       xl.workbook.add_worksheet do |sheet|
-        sheet.add_row columns, b: true
+        sheet.add_row columns&.map(&:titleize), b: true
         flattened_records.each do |record|
           sheet.add_row(columns.map { |column| record[column] })
         end

data/lib/generators/spotlight_search/filter_generator.rb

@@ -0,0 +1,21 @@
+module SpotlightSearch
+  module Generators
+    class FilterGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      argument :model,                type: :string, required: true, desc: "Pass a model name"
+      class_option :filters,          aliases: "-f", type: :array, desc: "Pass filters and scopes as an array. E.x: date_filter:datetime search:input"
+
+      def copy_filter_contents_to_app
+        if @options.filters?
+          inject_into_file "app/models/#{model.singularize}.rb", after: "ApplicationRecord" do
+            "\n  include SpotlightSearch\n"
+          end
+          template 'filters.html.erb', "app/views/admin/#{model}/_filters.html.slim"
+          template 'controller.rb.erb', "app/controllers/admin/#{model}_controller.rb"
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/spotlight_search/install_generator.rb

@@ -0,0 +1,27 @@
+require 'yaml'
+
+module SpotlightSearch
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_webpacker_gem_assets
+        copy_file 'webpacker_gem_assets.rb', 'config/initializers/webpacker_gem_assets.rb'
+        copy_file 'webpacker.yml', 'config/webpacker.yml'
+        copy_file 'environment.js', 'config/webpack/environment.js'
+        copy_file 'coffee.js', 'config/webpack/loaders/coffee.js'
+        copy_file 'spotlight_search.rb', 'config/initializers/spotlight_search.rb'
+        copy_file 'application.css.scss', 'app/assets/stylesheets/application.css.scss'
+        route "mount SpotlightSearch::Engine => '/spotlight_search'"
+      end
+
+      def add_essentials
+        system("yarn add jquery coffeescript coffee-loader select2 popper.js daterangepicker bootstrap-datepicker")
+        template "application.js", "app/javascript/packs/application.js"
+        template 'scaffolds.coffee', "app/javascript/application/coffee_scripts/scaffolds.coffee"
+        gem 'kaminari'
+      end
+
+    end
+  end
+end

data/lib/generators/spotlight_search/templates/application.css.scss

@@ -0,0 +1,26 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require font-awesome
+ *= require 'select2'
+ *= require bootstrap/dist/css/bootstrap
+ *= require bootstrap-datepicker/dist/css/bootstrap-datepicker3
+ *= require daterangepicker
+ */
+
+$fa-font-path: '@fortawesome/fontawesome-free/webfonts';
+@import '@fortawesome/fontawesome-free/scss/fontawesome';
+@import '@fortawesome/fontawesome-free/scss/solid';
+@import '@fortawesome/fontawesome-free/scss/regular';
+@import '@fortawesome/fontawesome-free/scss/brands';
+@import '@fortawesome/fontawesome-free/scss/v4-shims';

data/lib/generators/spotlight_search/templates/application.js

@@ -0,0 +1,19 @@
+// This file is automatically compiled by Webpack, along with any other files
+// present in this directory. You're encouraged to place your actual application logic in
+// a relevant structure within app/javascript and only use these pack files to reference
+// that code so it'll be compiled.
+
+
+require("@rails/ujs").start()
+require("turbolinks").start()
+require("@rails/activestorage").start()
+require("spotlight_search")
+require("daterangepicker")
+
+import jQuery from 'jquery';
+window.$ = jQuery
+window.jQuery = jQuery
+import 'select2';
+import 'bootstrap/dist/js/bootstrap'
+import 'bootstrap-datepicker/dist/js/bootstrap-datepicker.js';
+import '../application/coffee_scripts/scaffolds.coffee';

data/lib/generators/spotlight_search/templates/coffee.js

@@ -0,0 +1,6 @@
+module.exports = {
+  test: /\.coffee(\.erb)?$/,
+  use: [{
+    loader: 'coffee-loader'
+  }]
+}

data/lib/generators/spotlight_search/templates/controller.rb.erb

@@ -0,0 +1,91 @@
+class Admin::<%= model.titleize.gsub(' ', '') %>Controller < ApplicationController
+  before_action :set_<%= model.singularize %>, only: [:show, :edit, :update, :destroy]
+
+  # GET /<%= model %>
+  # GET /<%= model %>.json
+  def index
+    @filtered_result = <%= model.classify %>.all.filter_by(params[:page], filter_params.to_h, sort_params.to_h)
+    respond_to do |format|
+      if request.xhr?
+        format.html { render partial: 'table' }
+        format.json
+      else
+        format.html
+      end
+    end
+  end
+
+  # GET /<%= model %>/1
+  # GET /<%= model %>/1.json
+  def show
+  end
+
+  # GET /<%= model %>/new
+  def new
+    @<%= model.singularize %> = <%= model.singularize.titleize.gsub(' ', '') %>.new
+  end
+
+  # GET /<%= model %>/1/edit
+  def edit
+  end
+
+  # POST /<%= model %>
+  # POST /<%= model %>.json
+  def create
+    @<%= model.singularize %> = <%= model.singularize.titleize.gsub(' ', '') %>.new(<%= model.singularize %>_params)
+
+    respond_to do |format|
+      if @<%= model.singularize %>.save
+        format.html { redirect_to admin_<%= model.singularize %>_path(@<%= model.singularize %>), notice: '<%= model.singularize.titleize.gsub(' ', '') %> was successfully created.' }
+        format.json { render :show, status: :created, location: @<%= model.singularize %> }
+      else
+        format.html { render :new }
+        format.json { render json: @<%= model.singularize %>.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PATCH/PUT /<%= model %>/1
+  # PATCH/PUT /<%= model %>/1.json
+  def update
+    respond_to do |format|
+      if @<%= model.singularize %>.update(<%= model.singularize %>_params)
+        format.html { redirect_to admin_<%= model.singularize %>_path(@<%= model.singularize %>), notice: '<%= model.singularize.titleize.gsub(' ', '') %> was successfully updated.' }
+        format.json { render :show, status: :ok, location: @<%= model.singularize %> }
+      else
+        format.html { render :edit }
+        format.json { render json: @<%= model.singularize %>.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /<%= model %>/1
+  # DELETE /<%= model %>/1.json
+  def destroy
+    @<%= model.singularize %>.destroy
+    respond_to do |format|
+      format.html { redirect_to admin_<%= model %>_path, notice: '<%= model.singularize.titleize.gsub(' ', '') %> was successfully destroyed.' }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+
+  # Use callbacks to share common setup or constraints between actions.
+  def set_<%= model.singularize %>
+    @<%= model.singularize %> = <%= model.singularize.titleize.gsub(' ', '') %>.find(params[:id])
+  end
+
+  # Only allow a list of trusted parameters through.
+  def <%= model.singularize %>_params
+    params.require(:<%= model.singularize %>).permit()
+  end
+
+  def filter_params
+    params.require(:filters).permit(<%= @options.filters.map{ |f| ':' + f.split(':')[0] }.join(', ') %>) if params[:filters]
+  end
+
+  def sort_params
+    params.require(:sort).permit(:sort_column, :sort_direction) if params[:sort]
+  end
+end

data/lib/generators/spotlight_search/templates/environment.js

@@ -0,0 +1,20 @@
+const { environment } = require('@rails/webpacker')
+const coffee = require('./loaders/coffee')
+
+const webpack = require('webpack')
+environment.plugins.prepend('Provide',
+  new webpack.ProvidePlugin({
+    $: require.resolve('jquery'),
+    jQuery: require.resolve('jquery'),
+    Popper: ['popper.js', 'default']
+  })
+)
+
+const { add_paths_to_environment } = require(
+  // `${environment.plugins.get('Environment').defaultValues["PWD"]}/config/environments/_add_gem_paths`
+  `/tmp/_add_gem_paths`
+)
+add_paths_to_environment(environment)
+
+environment.loaders.prepend('coffee', coffee)
+module.exports = environment

data/lib/generators/spotlight_search/templates/filters.html.erb

@@ -0,0 +1,10 @@
+.filter-section
+  .filter-section__lhs
+    = filter_wrapper({filter_url: '/admin/<%= model %>', replacement_class: "<%= model %>-table"})
+    <%- @options.filters.each do |filter| -%>
+    <%- filter_arr = filter.split(':') -%>
+      = cm_filter_tag("<%= filter_arr[1] %>", "<%= filter_arr[0] %>", "", 'field-area', "<%= filter_arr[0].titleize %>")
+    <%- end -%>
+      = clear_filters(admin_<%= model %>_path, nil, nil, "Clear all")
+  .filter-section__rhs
+    = link_to 'Add', <%= "new_admin_" + model.singularize + "_path" %>, class: 'filter-btn'

data/lib/generators/spotlight_search/templates/scaffolds.coffee

@@ -0,0 +1,11 @@
+$(document).on "turbolinks:load", () ->
+  $('.select2-multiple').select2()
+  $('.select2-single').select2(
+    allowClear: true
+  )
+  $('.filter-rangepicker').daterangepicker()
+  $('.datepicker').datepicker({
+    format: 'dd/mm/yyyy',
+    todayHighlight: true,
+    autoclose: true,
+  })

data/lib/generators/spotlight_search/templates/spotlight_search.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Base.include SpotlightSearch::ExportableColumnsV2
+
+SpotlightSearch.setup do |config|
+  config.exportable_columns_version = :v2
+end

data/lib/generators/spotlight_search/templates/webpacker.yml

@@ -0,0 +1,102 @@
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+
+default: &default
+  source_path: app/javascript
+  source_entry_path: packs
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/cache/webpacker
+  check_yarn_integrity: false
+  webpack_compile_output: true
+
+  # Additional paths webpack should lookup modules
+  # ['app/assets', 'engine/foo/app/assets']
+  resolved_paths: []
+  resolved_gems_output_path: '/tmp/_add_gem_paths.js'
+  resolved_gems: [
+    'spotlight_search'
+  ]
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  # Extract and emit a css file
+  extract_css: false
+
+  static_assets_extensions:
+    - .jpg
+    - .jpeg
+    - .png
+    - .gif
+    - .tiff
+    - .ico
+    - .svg
+    - .eot
+    - .otf
+    - .ttf
+    - .woff
+    - .woff2
+
+  extensions:
+    - .coffee
+    - .mjs
+    - .js
+    - .sass
+    - .scss
+    - .css
+    - .module.sass
+    - .module.scss
+    - .module.css
+    - .png
+    - .svg
+    - .gif
+    - .jpeg
+    - .jpg
+
+development:
+  <<: *default
+  compile: true
+
+  # Verifies that correct packages and versions are installed by inspecting package.json, yarn.lock, and node_modules
+  check_yarn_integrity: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    # Inline should be set to true if using HMR
+    inline: true
+    overlay: true
+    compress: true
+    disable_host_check: true
+    use_local_ip: false
+    quiet: false
+    pretty: false
+    headers:
+      'Access-Control-Allow-Origin': '*'
+    watch_options:
+      ignored: '**/node_modules/**'
+
+
+test:
+  <<: *default
+  compile: true
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+  webpack_compile_output: true
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Extract and emit a css file
+  extract_css: true
+
+  # Cache manifest.json for performance
+  cache_manifest: true

data/lib/generators/spotlight_search/templates/webpacker_gem_assets.rb

@@ -0,0 +1,55 @@
+# config/initializers/webpacker_gem_assets.rb
+
+def default_assets_path
+  'app/assets/javascripts'
+end
+
+def output_path
+  Webpacker.config.send(:data)[:resolved_gems_output_path] || '/tmp/_add_gem_paths.js'
+end
+
+def resolve_gem_path(gem)
+  if gem.present?
+    gem_path = Gem.loaded_specs[gem]&.full_gem_path
+    if gem_path.present?
+      return "#{gem_path}/#{default_assets_path}"
+    end
+  end
+  abort("Gem '#{gem}' not found, please check webpacker config (#{Webpacker.config.config_path})")
+end
+
+buffer = []
+buffer << "
+/*
+ * THIS IS A GENERATED FILE.
+ * DO NOT CHECK IT INTO SOURCE CONTROL
+ */
+function add_paths_to_environment(environment) {".strip
+
+resolved_gems = Webpacker.config.send(:data)[:resolved_gems]
+if resolved_gems.any?
+  buffer << "\n  environment.resolvedModules.add(\n"
+  buffer << resolved_gems.map do |gem|
+    "    { key: 'gem-#{gem}', value: '#{resolve_gem_path(gem)}' }"
+  end.join(",\n")
+  buffer << "\n  )\n"
+end
+
+buffer << "}\nexports.add_paths_to_environment = add_paths_to_environment\n"
+
+File.write(
+  output_path,
+  buffer.join
+)
+
+module WebpackerGemAssets
+  def resolved_paths
+    self.send(:data)[:resolved_gems].map do |gem|
+      resolve_gem_path gem
+    end.compact.concat(super)
+  end
+end
+
+class Webpacker::Configuration
+  prepend WebpackerGemAssets
+end

data/lib/spotlight_search/exportable_columns_v2.rb

@@ -32,6 +32,10 @@ module SpotlightSearch
         self.enabled_columns = [*record_fields, **associated_fields]
       end
 
+      def default_scopes_for_export(*filter_scopes)
+        self.default_filters = filter_scopes
+      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
@@ -85,6 +89,7 @@ module SpotlightSearch
 
     included do
       class_attribute :enabled_columns, instance_accessor: false, default: nil
+      class_attribute :default_filters, instance_accessor: false, default: nil
     end
   end
 end

data/lib/spotlight_search/helpers.rb

@@ -12,26 +12,26 @@ module SpotlightSearch
     end
 
     def exportable(email, klass, html_class: [])
-      tag.div do
-        concat tag.button "Export as excel", class: html_class.append("modal-btn"), data: {toggle: "modal", target: "#exportmodal"}
-        concat column_pop_up(email, klass)
+      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
 
-    def column_pop_up(email, klass)
+    def column_pop_up(email, klass, required_filters = nil)
       tag.div class: "modal fade", id: "exportmodal", tabindex: "-1", role: "dialog", aria: {labelledby: "exportModal"} do
         tag.div class: "modal-dialog modal-lg", role: "document" do
           tag.div class: "modal-content" do
-            concat pop_ups(email, klass)
+            concat pop_ups(email, klass, required_filters)
           end
         end
       end
     end
 
-    def pop_ups(email, klass)
+    def pop_ups(email, klass, required_filters)
       tag.div do
         concat pop_up_header
-        concat pop_up_body(email, klass)
+        concat pop_up_body(email, klass, required_filters)
       end
     end
 
@@ -44,11 +44,12 @@ module SpotlightSearch
       end
     end
 
-    def pop_up_body(email, klass)
+    def pop_up_body(email, klass, required_filters)
       tag.div class: "modal-body" 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 'class_name', klass.to_s, id: 'export-to-file-klass'
+          filters_to_post_helper(required_filters) if required_filters
           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
@@ -57,11 +58,18 @@ module SpotlightSearch
           when :v2
             concat checkbox_row_v2(klass)
           end
-          concat submit_tag 'Export as excel', class: 'btn btn-bordered export-to-file-btn'
+          concat tag.hr
+          concat submit_tag 'Export as excel', class: 'btn btn-primary btn-bordered export-to-file-btn'
         end
       end
     end
 
+    def filters_to_post_helper(required_filters)
+      URI.decode_www_form(required_filters.to_param).each do |param|
+        concat hidden_field_tag "filters[#{param[0]}]", param[1]
+      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]
@@ -83,6 +91,44 @@ module SpotlightSearch
       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: "range-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|
@@ -94,30 +140,30 @@ module SpotlightSearch
     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
+        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/version.rb

@@ -1,3 +1,3 @@
 module SpotlightSearch
-  VERSION = "0.2.0"
+  VERSION = "0.3.2"
 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", ">= 12.3.3"
+  s.add_development_dependency "rake", "~> 13.0.1"
   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.2.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Anbazhagan Palani
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rails
   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
@@ -120,6 +106,18 @@ files:
 - 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