spotlight_search 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8d70a1928ef9bfa68c81817f7ab8ba5bb70848ab5c68223ad52294f2cc0e41b
-  data.tar.gz: 0e87e9608d99ffb50b6b6239f7af51e01f1b916919062a97b086466b8403caa5
+  metadata.gz: db095dee4fcbb232c1f7eddd83dfdfe279243415f3f6e54636740c2abbbe9ac3
+  data.tar.gz: c93d9955d07504a7aecca13cca15d1655fa847d0c13b1dc3643414ceeab39cb3
 SHA512:
-  metadata.gz: ddd8e03cad7ed5f110c5b9e158f2f40a4efe5551371da46caf92cf3b1c57b6b2b405aee83dabf0050f732e571c7ff891407c5a65906095bddce904771772e63e
-  data.tar.gz: 4b3b4880334b8b5a55fb0224e4878da2673bbaade2c221194c9e178e3cd2d633dd5275bfb60ce8c353de072003ac5d2999beb92613820112aa1909736e462a2d
+  metadata.gz: 67fc0b1c020ee49f59dbf539bf7854fcf65a8d8ce393b6315450c07812bec38020ace65fd29c36d76fb7408ddee3a6296c92ebf94dddc13026bc000660e26651
+  data.tar.gz: f4b76130d03a78c7fefdf61feffa8a61712097bd9807b479e3d9f41246fa69ed45bed3071a4df6b59ca94f5a3ea03dc0f1ecbdf74fdc701c6b845b92354b3123

data/Gemfile.lock

@@ -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

@@ -42,14 +42,17 @@ The install generator does the following
 * 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
 
-    $ 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.
 
-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`
+Following filter type are supported
+* input
+* single-select
+* multi-select
+* datetime
+* daterange
 
 
 ## Usage

data/lib/generators/spotlight_search/filter_generator.rb

@@ -8,6 +8,9 @@ module SpotlightSearch
 
       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

data/lib/generators/spotlight_search/install_generator.rb

@@ -11,19 +11,15 @@ module SpotlightSearch
         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")
-        system("yarn add coffeescript")
-        system("yarn add select2")
-        inject_into_file 'app/assets/stylesheets/application.css.scss', before: " */" do
-          " *= require select2\n"
-        end
+        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', '~> 1.2.1' unless File.readlines("Gemfile").grep(/kaminari/).size > 0
+        gem 'kaminari'
       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

@@ -7,9 +7,13 @@
 require("@rails/ujs").start()
 require("turbolinks").start()
 require("@rails/activestorage").start()
-require('spotlight_search')
+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/controller.rb.erb

@@ -1,4 +1,4 @@
-class Admin::<%= model.titleize %>Controller < ApplicationController
+class Admin::<%= model.titleize.gsub(' ', '') %>Controller < ApplicationController
   before_action :set_<%= model.singularize %>, only: [:show, :edit, :update, :destroy]
 
   # GET /<%= model %>
@@ -22,7 +22,7 @@ class Admin::<%= model.titleize %>Controller < ApplicationController
 
   # GET /<%= model %>/new
   def new
-    @<%= model.singularize %> = Profile.new
+    @<%= model.singularize %> = <%= model.singularize.titleize.gsub(' ', '') %>.new
   end
 
   # GET /<%= model %>/1/edit
@@ -32,11 +32,11 @@ class Admin::<%= model.titleize %>Controller < ApplicationController
   # POST /<%= model %>
   # POST /<%= model %>.json
   def create
-    @<%= model.singularize %> = Profile.new(<%= model.singularize %>_params)
+    @<%= model.singularize %> = <%= model.singularize.titleize.gsub(' ', '') %>.new(<%= model.singularize %>_params)
 
     respond_to do |format|
       if @<%= model.singularize %>.save
-        format.html { redirect_to @<%= model.singularize %>, notice: 'Profile was successfully created.' }
+        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 }
@@ -50,7 +50,7 @@ class Admin::<%= model.titleize %>Controller < ApplicationController
   def update
     respond_to do |format|
       if @<%= model.singularize %>.update(<%= model.singularize %>_params)
-        format.html { redirect_to @<%= model.singularize %>, notice: 'Profile was successfully updated.' }
+        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 }
@@ -64,7 +64,7 @@ class Admin::<%= model.titleize %>Controller < ApplicationController
   def destroy
     @<%= model.singularize %>.destroy
     respond_to do |format|
-      format.html { redirect_to <%= model.singularize %>s_url, notice: 'Profile was successfully destroyed.' }
+      format.html { redirect_to admin_<%= model %>_path, notice: '<%= model.singularize.titleize.gsub(' ', '') %> was successfully destroyed.' }
       format.json { head :no_content }
     end
   end
@@ -73,7 +73,7 @@ class Admin::<%= model.titleize %>Controller < ApplicationController
 
   # Use callbacks to share common setup or constraints between actions.
   def set_<%= model.singularize %>
-    @<%= model.singularize %> = Profile.find(params[:id])
+    @<%= model.singularize %> = <%= model.singularize.titleize.gsub(' ', '') %>.find(params[:id])
   end
 
   # Only allow a list of trusted parameters through.
@@ -83,7 +83,7 @@ class Admin::<%= model.titleize %>Controller < ApplicationController
 
   def filter_params
     params.require(:filters).permit(<%= @options.filters.map{ |f| ':' + f.split(':')[0] }.join(', ') %>) if params[:filters]
-    end
+  end
 
   def sort_params
     params.require(:sort).permit(:sort_column, :sort_direction) if params[:sort]

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

@@ -5,7 +5,8 @@ const webpack = require('webpack')
 environment.plugins.prepend('Provide',
   new webpack.ProvidePlugin({
     $: require.resolve('jquery'),
-    jQuery: require.resolve('jquery')
+    jQuery: require.resolve('jquery'),
+    Popper: ['popper.js', 'default']
   })
 )
 

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

@@ -1,12 +1,10 @@
-= filter_wrapper({filter_url: '/admin/<%= model %>', replacement_class: "<%= model %>-table"})
-<%- @options.filters.each do |filter| -%>
-<%- filter_arr = filter.split(':') -%>
-<%- if filter_arr[1].eql?('input') -%>
-  = cm_textfield_tag({behaviour: "filter", scope: "<%= filter_arr[0] %>", type: "input-filter"}, nil, "<%= filter_arr[0].titleize %>")
-<%- elsif filter_arr[1].eql?('select') -%>
-  = cm_select_tag([["<%= model.titleize %>", "<%= model %>"]], {behaviour: 'filter', scope: "<%= filter_arr[0] %>", type: 'select-filter', placeholder: ''}, "select2-single")
-<%- elsif filter_arr[1].eql?('multi_select') -%>
-  = cm_multi_select_tag([["<%= model.titleize %>", "<%= model %>"]], {behaviour: 'filter', scope: "<%= filter_arr[0] %>", type: 'select-filter', placeholder: ''}, "select2-multiple")
-<%- end -%>
-<%- end -%>
-  = clear_filters(admin_<%= model %>_path, nil, nil, "Clear all")
+.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

@@ -3,4 +3,9 @@ $(document).on "turbolinks:load", () ->
   $('.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

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

data/lib/spotlight_search/helpers.rb

@@ -12,9 +12,9 @@ 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
 
@@ -57,7 +57,8 @@ 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
@@ -89,16 +90,32 @@ module SpotlightSearch
       end
     end
 
-    def cm_single_select_tag(select_options, data_behaviours, classes=nil, placeholder=nil)
-      select_tag data_behaviours[:scope], options_for_select(select_options), class: "#{classes}", data: data_behaviours, include_blank: "#{placeholder}"
-    end
-
-    def cm_multi_select_tag(select_options, data_behaviours, classes=nil, placeholder=nil)
-      select_tag data_behaviours[:scope], options_for_select(select_options), class: "#{classes}", data: data_behaviours, include_blank: "#{placeholder}", multiple: true
-    end    
-
-    def cm_textfield_tag(data_behaviours, classes=nil, placeholder=nil)
-      text_field_tag data_behaviours[:scope], '', class: "#{classes}", data: data_behaviours, placeholder: "#{placeholder}"   
+    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)
@@ -116,30 +133,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.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spotlight_search
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Anbazhagan Palani
@@ -108,6 +108,7 @@ files:
 - 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