spotlight_search 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8928a9f036ae75254d0b39e31260ee6191c4c84a61a49e83a48db7b67947a5f
-  data.tar.gz: 379cd6fbf3f8ab91c0f90655aa92ac6190cd93250d61a22861bb0099736e107d
+  metadata.gz: b8d70a1928ef9bfa68c81817f7ab8ba5bb70848ab5c68223ad52294f2cc0e41b
+  data.tar.gz: 0e87e9608d99ffb50b6b6239f7af51e01f1b916919062a97b086466b8403caa5
 SHA512:
-  metadata.gz: 6d0c131c7f697024d7ed1b94c3f0777c880ac93316be16eda6c542f408d39d40a692eebd3dc581b69fe248e00d7e03c233e315aa8765cd0896fb2bc7fd4c4688
-  data.tar.gz: 52a2fd7c087b4a27c3f3b3a6169a247e8bdb822ebc6e65380d722ba58fd99d3139dc23059f3de75ef7eb9c0a48da5012413fe3200a3c9f06db9e58ca820eff5f
+  metadata.gz: ddd8e03cad7ed5f110c5b9e158f2f40a4efe5551371da46caf92cf3b1c57b6b2b405aee83dabf0050f732e571c7ff891407c5a65906095bddce904771772e63e
+  data.tar.gz: 4b3b4880334b8b5a55fb0224e4878da2673bbaade2c221194c9e178e3cd2d633dd5275bfb60ce8c353de072003ac5d2999beb92613820112aa1909736e462a2d

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,30 @@ 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 search:input order_status:multi_select status:select
+
+The install generator does the following
+
+* Copies the filter partial and the controller with necessary changes
+
+Filter arguments can be passed as an array and the format is `filter_scope:type_of_filter_input`
+
 
 ## Usage
 
@@ -66,24 +96,20 @@ end
 #### View
 Please note that the below code is in haml.
 
-**STEP - 1 Search**
+**STEP - 1 Filters**
 
-First step is to add the input box to search. Here there are few elements that should be placed mandatorily.
+**Filter Wrapper, Select-tags and Inputs**
 
-```
-.filters.w-100 data-filter-url="/admin/workshops" data-replacement-class="workshops_table"
-	.col-md-4.input-group.search
-		input#workshop-search-filter.form-control.filter-box name=("search_term_for_workshops ") placeholder=("Search Workshops") type="text" data-behaviour="filter" data-scope="search" data-type="input-filter"
-```
-
-The elements that should be placed mandatorily are
+| Generator                                                                        | *Mandatory(Data Attributes, Select options)                                                                            | *Optional(Classes, Placeholders)                                                       |
+|----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
+| `= filter_wrapper(data_behaviours, classes=nil)`                                 | `{filter_url: '/users', replacement_class: 'users-table'}`                                                             | "filter-classes"                                                                       |
+|                                                                                  |                                                                                                                        |                                                                                        |
+| `= cm_select_tag(select_options, data_behaviours, classes=nil, placeholder=nil)` | `{behaviour: "filter", scope: "status", type: "select-filter}` , User.all.map {\|user\| [user.name.titleize, user.id]} | `"user-select"`, placeholder = `"Users"`                                               |
+|                                                                                  |                                                                                                                        |                                                                                        |
+| `= cm_textfield_tag(data_behaviours, classes=nil, placeholder=nil)`              | `{behaviour: "filter", scope: "search", type: "input-filter}`                                                          | `"user-search"`, placeholder = `"Search"`                                              |
+|                                                                                  |                                                                                                                        |                                                                                        |
+| `= clear_filters(clear_path, classes=nil, data_behaviours=nil, clear_text=nil)`  | clear_path = `users_path`                                                                                              | `"clear-filter"`, data_behaviours = `{behaviour: 'clear'}`, clear_text = `"Clear all"` |
 
-  * `.filters` All search input / select filter should be nested inside this class name.
-  * `data-filter-url` Is mandatory, this is the search URL, Mostly this will hit the index action.
-  * `data-replacement-class` After ajax this is the class name where the data will get appended.
-  * `data-behaviour="filter"` If the input behaviour is set to filter then this will get added to ajax
-  * `data-scope="search"` This is the model scope name, The helper method will call this when filter is applied.
-  * `data-type="input-filter"` This is to tell if the element is input or select other value is `data-type="select-filter"`
 
 **STEP - 2 Pagination**
 
@@ -105,20 +131,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/lib/generators/spotlight_search/filter_generator.rb

@@ -0,0 +1,18 @@
+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?
+          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,31 @@
+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'
+        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
+        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
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+// 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')
+
+import jQuery from 'jquery';
+window.$ = jQuery
+window.jQuery = jQuery
+import 'select2';

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 %>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 %> = Profile.new
+  end
+
+  # GET /<%= model %>/1/edit
+  def edit
+  end
+
+  # POST /<%= model %>
+  # POST /<%= model %>.json
+  def create
+    @<%= model.singularize %> = Profile.new(<%= model.singularize %>_params)
+
+    respond_to do |format|
+      if @<%= model.singularize %>.save
+        format.html { redirect_to @<%= model.singularize %>, notice: 'Profile 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 @<%= model.singularize %>, notice: 'Profile 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 <%= model.singularize %>s_url, notice: 'Profile 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 %> = Profile.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,19 @@
+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')
+  })
+)
+
+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,12 @@
+= 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")

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

@@ -0,0 +1,6 @@
+$(document).on "turbolinks:load", () ->
+  $('.select2-multiple').select2()
+  $('.select2-single').select2(
+    allowClear: true
+  )
+  

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

@@ -0,0 +1 @@
+ActiveRecord::Base.include SpotlightSearch::ExportableColumns

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/helpers.rb

@@ -83,6 +83,28 @@ 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_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}"   
+    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|

data/lib/spotlight_search/version.rb

@@ -1,3 +1,3 @@
 module SpotlightSearch
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

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