spotlight_search 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcbc12f0614877e2fc4dd201b0885d74c6ae169b4cbb56760ee3db5bc1f11ce4
-  data.tar.gz: c5a8e1299b3b4cc5b2ae8113e66e8afb1e6a08b57cadf526c45780b935b808ba
+  metadata.gz: 2c89b4b5abbf14d2a5f0bd0b32ebe1f969664d6f15a1546d8da52c5350533dd2
+  data.tar.gz: 488483330b4d7884daa56e00b276c916eb1e880cedf17930417c94ad35edc5e9
 SHA512:
-  metadata.gz: 90221663054cdbff4fcdc9293998a272aee5926548912fed9ad98441b8e294a18cb24b5dc871d78cf52eb27e90d5f8b57aa43ab7aaa4143928335ba3add7c56f
-  data.tar.gz: 126fc9efce631043f391d16f23af181963817648f113d230124e80e56e383fb5b4d9dd98fe3d5fc9c65f2da1d076a98186c9ed1d8cb9989e1c6552cc4989e040
+  metadata.gz: 1774df1335f355630535500a67dbecd62a3291aceeb82bd957ee77fcd47664a078a653a0657cca931a22333aed4683fac9107d4219a4a3ec4a6dc7b4d5d7b689
+  data.tar.gz: b52de4cc8d6a3a22e2ed8b4fc76e92f4d5c8e1e71c878bb0b84676dd9f3590e64d848e5eadd2ea2d0b3b4030881a1854840a74ef4c820cdc6b7a49549a02d8e3

data/Gemfile.lock

@@ -1,17 +1,102 @@
 PATH
   remote: .
   specs:
-    spotlight-search (0.1.0)
+    spotlight_search (0.1.1)
+      axlsx
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coffee-script (2.4.1)
-      coffee-script-source
-      execjs
-    coffee-script-source (1.12.2)
+    actioncable (5.0.7.2)
+      actionpack (= 5.0.7.2)
+      nio4r (>= 1.2, < 3.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.7.2)
+      actionpack (= 5.0.7.2)
+      actionview (= 5.0.7.2)
+      activejob (= 5.0.7.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.7.2)
+      actionview (= 5.0.7.2)
+      activesupport (= 5.0.7.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.7.2)
+      activesupport (= 5.0.7.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.7.2)
+      activesupport (= 5.0.7.2)
+      globalid (>= 0.3.6)
+    activemodel (5.0.7.2)
+      activesupport (= 5.0.7.2)
+    activerecord (5.0.7.2)
+      activemodel (= 5.0.7.2)
+      activesupport (= 5.0.7.2)
+      arel (~> 7.0)
+    activesupport (5.0.7.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.4)
+    axlsx (2.0.1)
+      htmlentities (~> 4.3.1)
+      nokogiri (>= 1.4.1)
+      rubyzip (~> 1.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
     diff-lcs (1.3)
-    execjs (2.7.0)
+    erubis (2.7.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    htmlentities (4.3.4)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    method_source (0.9.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.7.2)
+      actioncable (= 5.0.7.2)
+      actionmailer (= 5.0.7.2)
+      actionpack (= 5.0.7.2)
+      actionview (= 5.0.7.2)
+      activejob (= 5.0.7.2)
+      activemodel (= 5.0.7.2)
+      activerecord (= 5.0.7.2)
+      activesupport (= 5.0.7.2)
+      bundler (>= 1.3.0)
+      railties (= 5.0.7.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.0.7.2)
+      actionpack (= 5.0.7.2)
+      activesupport (= 5.0.7.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -26,16 +111,31 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubyzip (1.0.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 2.0)
-  coffee-script (~> 2.2)
+  rails (~> 5.0.7)
   rake (~> 10.0)
   rspec (~> 3.0)
-  spotlight-search!
+  spotlight_search!
 
 BUNDLED WITH
    2.0.1

data/README.md

@@ -1,8 +1,6 @@
 # SpotlightSearch
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/spotlight_search`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+It helps filtering, sorting and exporting tables easier.
 
 ## Installation
 
@@ -16,7 +14,7 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it manually:
 
     $ gem install spotlight_search
 
@@ -86,6 +84,72 @@ If any of the header needs to be sorted, then we will  add the following helper
 th = sortable "name", "Name", @filtered_result.sort[:sort_column], @filtered_result.sort[:sort_direction]
 ```
 
+### Export to file
+
+#### Model
+Enables or disables export and specifies which all columns can be
+exported. Export is disabled for all columns by default.
+
+For enabling export for all columns in all models
+
+```ruby
+  class ApplicationRecord < ActiveRecord::Base
+    export_columns enabled: true
+  end
+```
+
+For disabling export for only specific models
+
+```ruby
+  class Person < ActiveRecord::Base
+    export_columns enabled: false
+  end
+```
+
+For allowing export for only specific columns in a model
+
+```ruby
+  class Person < ActiveRecord::Base
+    export_columns enabled: true, only: [:created_at, :updated_at]
+  end
+```
+
+For excluding only specific columns and allowing all others
+
+```ruby
+  class Person < ActiveRecord::Base
+    export_columns enabled: true, except: [:created_at, :updated_at]
+  end
+```
+
+#### View
+
+Add `exportable email, model_object` in your view to display the export button.
+
+```html+erb
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Email</th>
+  </tr>
+  <td>
+    <% @records.each do |record| %>
+      <tr>
+        <td><%= record.name %></td>
+        <td><%= record.value %></td>
+    <% end %>
+  </td>
+</table>
+
+<%= exportable(current_user.email, current_user.class) %>
+```
+
+This will first show a popup where an option to select the export enabled columns will be listed. This will also apply any filters that has been selected along with a sorting if applied. It then pushes the export to a background job which will send an excel file of the contents to the specified email. You can edit the style of the button using the class `export-to-file-btn`.
+
+**Note**
+
+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.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -94,7 +158,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/spotlight_search. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/commutatus/spotlight_search. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -102,4 +166,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SpotlightSearch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/spotlight_search/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SpotlightSearch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/commutatus/spotlight_search/blob/master/CODE_OF_CONDUCT.md).

data/app/assets/javascripts/spotlight_search.js

@@ -90,5 +90,23 @@ $(document).on('click', '[data-type="anchor-filter"]', function() {
   });
 });
 
-// ---
-// generated by coffee-script 1.9.2
+$(document).on('click', '#export-to-file-btn', function(event) {
+  event.preventDefault();
+  $(this).attr('disabled', true);
+  var filter_params, query_string, sort_column, sort_direction;
+  sort_column = $('[data-behaviour="current-page"]').data('sort-column');
+  sort_direction = $('[data-behaviour="current-page"]').data('sort-direction');
+  filter_params = {};
+  $('[data-behaviour="filter"]').each(function(index) {
+    filter_params[$(this).data('scope')] = $(this).val();
+  });
+  body = {
+    filters: filter_params,
+    sort: {
+      sort_column: sort_column,
+      sort_direction: sort_direction
+    }
+  }
+  $('#export-to-file-filters').value(body);
+  $('#export-to-file-form').submit();
+});

data/app/controllers/spotlight_search/export_jobs_controller.rb

@@ -0,0 +1,21 @@
+module SpotlightSearch
+  class ExportJobsController < ApplicationController
+    include SpotlightSearch::Concerns::Exportable
+
+    def export_job
+      begin
+        klass = params[:klass].constantize
+        if klass.validate_exportable_columns(params[:columns])
+          ExportJob.perform_later(params[:email], klass, params[:columns], params[:filters])
+          flash[:success] = 'Successfully queued for export'
+        else
+          flash[:error] = 'Invalid columns found'
+        end
+      rescue
+        flash[:error] = 'No records to import'
+      ensure
+        redirect_back fallback_location: root_path
+      end
+    end
+  end
+end

data/app/jobs/spotlight_search/export_job.rb

@@ -0,0 +1,49 @@
+module SpotlightSearch
+  class ExportJob < ApplicationJob
+    def perform(email, klass, columns = nil, filters = nil)
+      records = get_records(klass, filters, columns)
+      file_path = create_excel(records, klass.name)
+      subject = "#{klass.name} export at #{Time.now}"
+      ExportMailer.send_excel_file(email, file_path, subject).deliver_now
+      File.delete(file_path)
+    end
+
+    def get_records(klass, filters, columns)
+      records = klass
+      if filters['filters'].present?
+        filters['filters'].each do |scope, scope_args|
+          if scope_args.is_a?(Array)
+            records = records.send(scope, *scope_args)
+          else
+            records = records.send(scope, scope_args)
+          end
+        end
+      end
+      if filters['sort'].present?
+        records = records.order("#{filters['sort']['sort_column']} #{filters['sort']['sort_direction']}")
+      end
+      columns = columns.map(&:to_sym)
+      records.select(*columns)
+    end
+
+    # Creating excel with the passed records
+    # Keys as headers and values as row
+    def create_excel(records, klass)
+      records = records.as_json
+      headers = records.first.keys
+      size_arr = []
+      headers.size.times { size_arr << 22 }
+      xl = Axlsx::Package.new
+      xl.workbook.add_worksheet do |sheet|
+        sheet.add_row headers, b: true
+        records.each do |record|
+          sheet.add_row record.values
+        end
+        sheet.column_widths *size_arr
+      end
+      file_location = "#{Rails.root}/public/export_#{klass}_#{Time.now.to_s}"
+      xl.serialize(file_location)
+      file_location
+    end
+  end
+end

data/app/mailers/spotlight_search/export_mailer.rb

@@ -0,0 +1,10 @@
+module SpotlightSearch
+  class ExportMailer < ActionMailer::Base
+    default from: "no-reply@#{Rails.application.config.action_mailer.default_url_options[:host]}"
+
+    def send_excel_file(email, file_path, subject)
+      attachments[file_path.split('/').last] = File.read(file_path)
+      mail(to: email, subject: subject)
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+Hi,
+<br>
+Please find attached the exported contents.
+<br>
+Thanks

data/config/routes.rb

@@ -0,0 +1,3 @@
+SpotlightSearch::Engine.routes.draw do
+  post '/export_to_file', to: 'spotlight_search/export_jobs#export_job'
+end

data/lib/spotlight_search/engine.rb

@@ -1,4 +1,4 @@
+require 'rails'
 module SpotlightSearch
-  class Engine < Rails::Engine
-  end
+  class Engine < Rails::Engine; end
 end

data/lib/spotlight_search/exceptions.rb

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

data/lib/spotlight_search/exportable_columns.rb

@@ -0,0 +1,71 @@
+module SpotlightSearch
+  module ExportableColumns
+    cattr_accessor :enabled_columns, :export_enabled
+
+    module ClassMethods
+      # Enables or disables export and specifies which all columns can be
+      # exported. For enabling export for all columns in all models
+      # 
+      #   class ApplicationRecord < ActiveRecord::Base
+      #     export_columns enabled: true
+      #   end
+      #
+      # For disabling export for only specific models
+      #
+      #   class Person < ActiveRecord::Base
+      #     export_columns enabled: false
+      #   end
+      #
+      # For allowing export for only specific columns in a model  
+      #
+      #   class Person < ActiveRecord::Base
+      #     export_columns enabled: true, only: [:created_at, :updated_at]
+      #   end
+      #
+      # For excluding only specific columns and allowing all others
+      #
+      #   class Person < ActiveRecord::Base
+      #     export_columns enabled: true, except: [:created_at, :updated_at]
+      #   end
+      #
+      def export_columns(enabled: false, only: nil, except: nil)
+        if enabled
+          @@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
+            @@enabled_columns = only
+          else
+            @@enabled_columns = all_columns
+          end
+          if except.present?
+            unless (valid_columns = except & all_columns).size == only.size
+              invalid_columns = except - valid_columns
+              raise SpotlightSearch::Exceptions::InvalidColumns.new(nil, invalid_columns)
+            end
+            @@enabled_columns = @@enabled_columns - except
+          end
+        else
+          @@export_enabled = false
+          @@enabled_columns = nil
+        end
+      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')
+        end
+        unless (@@enabled_columns & columns.map(&:to_sym)) == columns.size
+          return false
+        end
+        return true
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend SpotlightSearch::ExportableColumns

data/lib/spotlight_search/helpers.rb

@@ -9,6 +9,37 @@ module SpotlightSearch
       content_tag("a","Title", class: css_class, data: {sort_column: column, sort_direction: direction, behaviour: 'sort', type: 'anchor-filter'})
     end
 
+    def exportable(email, klass)
+      tag.button "Export as excel", class: "modal-btn", data: {toggle: "modal", target: "#exportmodal"}
+      tag.div class: "modal fade", id: "exportmodal", tabindex: "-1", role: "dialog", aria: {labelledby: "exportModal"} do
+        tag.div class: "modal-dialog", role: "document" do
+          tag.div class: "modal-content" do
+            tag.div class: "modal-header" do
+              tag.button type: "button", class: "close", data: {dismiss: "modal"}, aria: {label: "Close"} do
+                tag.span "X", aria: {hidden: "true"}
+              end
+              tag.h4 "Select columns to export", class: "modal-title", id: "exportModal"
+            end
+            tag.div class: "modal-body" do
+              form_tag '/export_to_file', id: 'export-to-file-form' do
+                hidden_field_tag 'email', email, id: 'export-to-file-email'
+                hidden_field_tag 'filters', nil, id: 'export-to-file-filters'
+                hidden_field_tag 'klass', klass.to_s, id: 'export-to-file-klass'
+                klass.enabled_columns.each do |column_name|
+                  tag.div class: "row" do
+                    tag.div class: "col-md-4" do
+                      check_box_tag "columns[]", column_name
+                    end
+                  end
+                end
+                submit_tag 'Export as excel', class: 'btn btn-bordered export-to-file-btn'
+              end
+            end
+          end
+        end
+      end
+    end
+
     def cm_paginate(facets)
       tag.div class: 'text-center' do
         tag.div class: 'nav navbar navbar-inner' do

data/lib/spotlight_search/version.rb

@@ -1,3 +1,3 @@
 module SpotlightSearch
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/spotlight_search.rb

@@ -4,6 +4,10 @@ require 'spotlight_search/railtie' if defined?(Rails)
 
 module SpotlightSearch
   extend ActiveSupport::Concern
+
+  autoload :Exceptions, 'spotlight_search/exceptions'
+  autoload :ExportableColumns, 'spotlight_search/exportable_columns'
+
   module ClassMethods
     def filter_by(page, filter_params = {}, sort_params = {})
       filtered_result = OpenStruct.new

data/spotlight_search.gemspec

@@ -1,5 +1,6 @@
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# Dir.glob("./**/**/*.rb").each { |path| require path }
 require "spotlight_search/version"
 
 Gem::Specification.new do |s|
@@ -24,5 +25,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "bundler", "~> 2.0"
   s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rails", "~> 5.0.7"
   s.add_development_dependency "rspec", "~> 3.0"
+  s.add_runtime_dependency 'axlsx'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spotlight_search
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Anbazhagan Palani
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.7
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: axlsx
+  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'
 description: |-
   This gem should help reduce the efforts in the admin panel.
     It has search, sort and pagination included
@@ -70,10 +98,17 @@ files:
 - app/.DS_Store
 - app/assets/javascripts/spotlight_search.js
 - app/assets/javascripts/spotlight_search_main.js
+- app/controllers/spotlight_search/export_jobs_controller.rb
+- app/jobs/spotlight_search/export_job.rb
+- app/mailers/spotlight_search/export_mailer.rb
+- app/views/spotlight_search/export_mailer/send_excel_file.html.erb
 - bin/console
 - bin/setup
+- config/routes.rb
 - lib/spotlight_search.rb
 - lib/spotlight_search/engine.rb
+- lib/spotlight_search/exceptions.rb
+- lib/spotlight_search/exportable_columns.rb
 - lib/spotlight_search/helpers.rb
 - lib/spotlight_search/railtie.rb
 - lib/spotlight_search/version.rb