spotlight_search 0.1.7 → 0.2.2

data/app/mailers/spotlight_search/export_mailer.rb

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

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

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

data/lib/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.rb

@@ -1,6 +1,8 @@
 require 'spotlight_search/engine'
 require 'spotlight_search/version'
 require 'spotlight_search/exportable_columns'
+require 'spotlight_search/exportable_columns_v2'
+require 'spotlight_search/utils'
 require 'spotlight_search/railtie' if defined?(Rails)
 require 'active_support'
 require 'active_support/rails'
@@ -10,10 +12,17 @@ module SpotlightSearch
 
   autoload :Exceptions, 'spotlight_search/exceptions'
 
+  def self.setup
+    yield self
+  end
+
+  mattr_accessor :exportable_columns_version
+  @@exportable_columns_version = :v1
+
   module ClassMethods
     def filter_by(page, filter_params = {}, sort_params = {})
       filtered_result = OpenStruct.new
-      sort_column = self.column_names.include?(sort_params[:sort_column]) ? sort_params[:sort_column] : "created_at"
+      sort_column = self.column_names.include?(sort_params[:sort_column]) ? sort_params[:sort_column] : "#{self.table_name}.created_at"
       sort_direction = %w[asc desc].include?(sort_params[:sort_direction]) ? sort_params[:sort_direction] : "asc"
       sort_params = {sort_column: sort_column, sort_direction: sort_direction}
       raw_data = self.filter(filter_params).sort_list(sort_column, sort_direction)

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

@@ -5,7 +5,7 @@ module SpotlightSearch
     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
@@ -16,7 +16,7 @@ module SpotlightSearch
       #     export_columns enabled: false
       #   end
       #
-      # For allowing export for only specific columns in a model  
+      # For allowing export for only specific columns in a model
       #
       #   class Person < ActiveRecord::Base
       #     export_columns enabled: true, only: [:created_at, :updated_at]
@@ -28,41 +28,36 @@ 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
       def validate_exportable_columns(columns)
         unless columns.is_a?(Array)
-          raise SpotlightSearch::Exceptions::InvalidValue.new('Excepted Array. Invalid type received')
+          raise SpotlightSearch::Exceptions::InvalidValue.new('Expected Array. Invalid type received')
         end
         unless (self.enabled_columns & columns.map(&:to_sym)) == columns.size
           return false
@@ -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