spree_admin_insights 3.2.0

data/app/assets/javascripts/spree/backend/spree_admin_insights/searcher.js

@@ -0,0 +1,103 @@
+//= require spree/backend/spree_admin_insights/paginator
+
+function Searcher(inputs, reportLoader) {
+  this.$insightsTableList = inputs.insightsDiv;
+  this.$filters = inputs.filterDiv;
+  this.$quickSearchForm = this.$filters.find('#quick-search');
+  this.tableSorter = inputs.tableSorterObject;
+  this.reportLoader = reportLoader;
+  this.$filterForm = null;
+  this.$searchLabelsContainer = this.$filters.find('.table-active-filters');
+}
+
+Searcher.prototype.bindEvents = function(data) {
+  var _this = this;
+  this.$searchLabelsContainer.on("click", ".js-delete-filter", function() {
+    _this.$quickSearchForm[0].reset();
+    $(this).parent().hide();
+  });
+};
+
+Searcher.prototype.refreshSearcher = function($selectedInsight, data) {
+  var requestPath = $selectedInsight.data('url'),
+    _this = this;
+
+  _this.$filters.removeClass('hide');
+  _this.addSearchForm(data);
+  _this.setFormActions(_this.$quickSearchForm, requestPath);
+  _this.setFormActions(_this.$filterForm, requestPath);
+
+  _this.$filterForm.on('submit', function() {
+   var paginated = !_this.reportLoader.removePaginationButton.closest('span').hasClass('hide');
+   _this.addSearchStatus();
+   $.ajax({
+     type: "GET",
+     url: _this.$filterForm.attr('action'),
+     data: _this.$filterForm.serialize() + "&per_page=" + _this.reportLoader.pageSelector.find(':selected').attr('value') + '&paginate=' + paginated,
+     dataType: 'json',
+     success: function(data) {
+      _this.clearFormFields();
+      _this.reportLoader.requestUrl = this.url;
+      _this.populateInsightsData(data);
+      _this.reportLoader.paginatorObject.refreshPaginator(data);
+     }
+   });
+   return false;
+  });
+};
+
+Searcher.prototype.addSearchStatus = function () {
+  var filtersContainer = $(".js-filters");
+  filtersContainer.empty();
+  $(".js-filterable").each(function() {
+   var $this = $(this);
+
+    if ($this.val()) {
+      var ransack_value, filter;
+      var ransack_field = $this.attr("id");
+      var label = $('label[for="' + ransack_field + '"]');
+      if ($this.is("select")) {
+        ransack_value = $this.find('option:selected').text();
+      } else {
+        ransack_value = $this.val();
+      }
+
+      label = label.text() + ': ' + ransack_value;
+      filter = '<span class="js-filter label label-default" data-ransack-field="' + ransack_field + '">' + label + '<span class="icon icon-delete js-delete-filter"></span></span>';
+
+      filtersContainer.append(filter).show();
+    }
+  });
+};
+
+Searcher.prototype.addSearchForm = function(data) {
+  this.$filters.find('#table-filter').empty().append($(tmpl('search-tmpl', data)));
+  this.$filterForm = this.$filters.find('#filter-search');
+  this.$filters.find('.datepicker').datepicker({ dateFormat: 'yy-mm-dd' });
+};
+
+Searcher.prototype.setFormActions = function($form, path) {
+  $form.attr("method", "get");
+  $form.attr("action", path);
+};
+
+Searcher.prototype.populateInsightsData = function(data) {
+  this.reportLoader.populateInsightsData(data);
+};
+
+Searcher.prototype.clearFormFields = function() {
+  this.$filters.find('.filter-well').slideUp();
+};
+
+Searcher.prototype.fillFormFields = function(searchedFields) {
+  $.each(Object.keys(searchedFields), function() {
+    $('#search_' + this).val(searchedFields[this]);
+  });
+  this.addSearchStatus();
+};
+
+Searcher.prototype.clearSearchFields = function() {
+  this.$quickSearchForm[0].reset();
+  var filtersContainer = $(".js-filters");
+  filtersContainer.empty();
+};

data/app/assets/javascripts/spree/backend/spree_admin_insights/table_sorter.js

@@ -0,0 +1,47 @@
+//= require spree/backend/jquery.tablesorter.min
+
+function TableSorter(inputs) {
+  this.$insightsTableList = inputs.$insightsTable;
+  this.reportLoader = inputs.reportLoader;
+  this.paginatorDiv = inputs.paginatorDiv;
+}
+
+TableSorter.prototype.bindEvents = function() {
+  var _this = this;
+  this.$insightsTableList.on('click', '#admin-insight .sortable-link', function() {
+    event.preventDefault();
+    var currentPage = _this.paginatorDiv.find('li.active a').html() - 1,
+      paginated = !_this.reportLoader.removePaginationButton.closest('span').hasClass('hide'),
+      requestPath = $(event.target).attr('href') + '&' + $('#filter-search').serialize() + '&page=' + currentPage + "&per_page=" + _this.reportLoader.pageSelector.find(':selected').attr('value') + '&paginate=' + paginated;
+    _this.reportLoader.requestUrl = requestPath;
+
+    $.ajax({
+      type: 'GET',
+      url: requestPath,
+      dataType: 'json',
+      success: function(data) {
+        _this.populateInsightsData(data);
+      }
+    });
+  });
+};
+
+TableSorter.prototype.populateInsightsData = function(data) {
+  this.reportLoader.populateInsightsData(data);
+};
+
+TableSorter.prototype.fetchSortedAttribute = function() {
+  var attribute, sortOrder;
+  if (this.$insightsTableList.find('.asc').length) {
+    attribute = this.getSortedAttribute('asc');
+    sortOrder = 'asc';
+  } else if(this.$insightsTableList.find('.desc').length) {
+    attribute = this.getSortedAttribute('desc');
+    sortOrder = 'desc';
+  }
+  return [attribute, sortOrder];
+};
+
+TableSorter.prototype.getSortedAttribute = function(order) {
+  return this.$insightsTableList.find('.' + order).data('attribute');
+};

data/app/assets/javascripts/spree/backend/tmpl.js

@@ -0,0 +1,87 @@
+/*
+ * JavaScript Templates 2.4.1
+ * https://github.com/blueimp/JavaScript-Templates
+ *
+ * Copyright 2011, Sebastian Tschan
+ * https://blueimp.net
+ *
+ * Licensed under the MIT license:
+ * http://www.opensource.org/licenses/MIT
+ *
+ * Inspired by John Resig's JavaScript Micro-Templating:
+ * http://ejohn.org/blog/javascript-micro-templating/
+ */
+
+/*jslint evil: true, regexp: true, unparam: true */
+/*global document, define */
+
+(function ($) {
+    "use strict";
+    var tmpl = function (str, data) {
+        var f = !/[^\w\-\.:]/.test(str) ? tmpl.cache[str] = tmpl.cache[str] ||
+                tmpl(tmpl.load(str)) :
+                    new Function(
+                        tmpl.arg + ',tmpl',
+                        "var _e=tmpl.encode" + tmpl.helper + ",_s='" +
+                            str.replace(tmpl.regexp, tmpl.func) +
+                            "';return _s;"
+                    );
+        return data ? f(data, tmpl) : function (data) {
+            return f(data, tmpl);
+        };
+    };
+    tmpl.cache = {};
+    tmpl.load = function (id) {
+        return document.getElementById(id).innerHTML;
+    };
+    tmpl.regexp = /([\s'\\])(?!(?:[^{]|\{(?!%))*%\})|(?:\{%(=|#)([\s\S]+?)%\})|(\{%)|(%\})/g;
+    tmpl.func = function (s, p1, p2, p3, p4, p5) {
+        if (p1) { // whitespace, quote and backspace in HTML context
+            return {
+                "\n": "\\n",
+                "\r": "\\r",
+                "\t": "\\t",
+                " " : " "
+            }[p1] || "\\" + p1;
+        }
+        if (p2) { // interpolation: {%=prop%}, or unescaped: {%#prop%}
+            if (p2 === "=") {
+                return "'+_e(" + p3 + ")+'";
+            }
+            return "'+(" + p3 + "==null?'':" + p3 + ")+'";
+        }
+        if (p4) { // evaluation start tag: {%
+            return "';";
+        }
+        if (p5) { // evaluation end tag: %}
+            return "_s+='";
+        }
+    };
+    tmpl.encReg = /[<>&"'\x00]/g;
+    tmpl.encMap = {
+        "<"   : "&lt;",
+        ">"   : "&gt;",
+        "&"   : "&amp;",
+        "\""  : "&quot;",
+        "'"   : "&#39;"
+    };
+    tmpl.encode = function (s) {
+        /*jshint eqnull:true */
+        return (s == null ? "" : "" + s).replace(
+            tmpl.encReg,
+            function (c) {
+                return tmpl.encMap[c] || "";
+            }
+        );
+    };
+    tmpl.arg = "o";
+    tmpl.helper = ",print=function(s,e){_s+=e?(s==null?'':s):_e(s);}" +
+        ",include=function(s,d){_s+=tmpl(s,d);}";
+    if (typeof define === "function" && define.amd) {
+        define(function () {
+            return tmpl;
+        });
+    } else {
+        $.tmpl = tmpl;
+    }
+}(this));

data/app/assets/javascripts/spree/frontend/spree_admin_insights.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/override_pdf.css

@@ -0,0 +1,71 @@
+.table {
+  border-collapse: collapse !important;
+}
+
+.table td {
+  background-color: #fff !important;
+}
+
+.table-bordered {
+  border: 1px solid #ddd;
+}
+.table-bordered > thead > tr > th,
+.table-bordered > tbody > tr > th,
+.table-bordered > tfoot > tr > th,
+.table-bordered > thead > tr > td,
+.table-bordered > tbody > tr > td,
+.table-bordered > tfoot > tr > td {
+  border: 1px solid #ddd;
+}
+.table-bordered > thead > tr > th,
+.table-bordered > thead > tr > td {
+  border-bottom-width: 2px;
+}
+
+table {
+  background-color: transparent;
+}
+
+th {
+  background-color: #f0f0f0 !important;
+  text-align: left;
+}
+.table {
+  width: 100%;
+  max-width: 100%;
+  margin-bottom: 20px;
+}
+.table > thead > tr > th,
+.table > tbody > tr > th,
+.table > tfoot > tr > th,
+.table > thead > tr > td,
+.table > tbody > tr > td,
+.table > tfoot > tr > td {
+  padding: 8px;
+  line-height: 1.42857143;
+  vertical-align: top;
+  border-top: 1px solid #ddd;
+}
+.table > thead > tr > th {
+  vertical-align: bottom;
+  border-bottom: 2px solid #ddd;
+}
+
+.table > tbody + tbody {
+  border-top: 2px solid #ddd;
+}
+.table .table {
+  background-color: #fff;
+}
+ .logo {
+  width: auto;
+  height: 20px;
+ }
+
+.spree-head {
+  padding: 20px 0px 20px 20px;
+  width: 100%;
+  max-width: 100%;
+  background: #162e40;
+  height: 50;
+}

data/app/assets/stylesheets/spree/backend/spree_admin_insights.css

@@ -0,0 +1,40 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/
+
+.page-select {
+  padding: 0px 6px 0px 6px;
+}
+
+#report-container .filter-well {
+  margin: 5px 0px 10px 0px;
+}
+
+.select-box-slide {
+  margin-left: 3px;
+}
+
+#page-selector {
+  margin-right: 5px;
+}
+
+#table-helpers .col-md-2 {
+  padding-left: 3px;
+}
+
+.chart-title {
+  padding-right: 5px;
+}
+
+.sortable-arrow {
+  color: #2F85D5;
+}
+
+.loss-indicator {
+  color: red;
+}
+
+.profit-indicator {
+  color: green;
+}

data/app/assets/stylesheets/spree/frontend/spree_admin_insights.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/app/controllers/spree/admin/insights_controller.rb

@@ -0,0 +1,112 @@
+module Spree
+  module Admin
+    class InsightsController < Spree::Admin::BaseController
+      before_action :ensure_report_exists, :set_default_pagination, only: [:show, :download]
+      before_action :set_reporting_period, only: [:index, :show, :download]
+      before_action :load_reports, only: [:index, :show]
+
+      def index
+        respond_to do |format|
+          format.html
+          format.json { render json: {} }
+        end
+      end
+
+      def show
+        report = ReportGenerationService.generate_report(@report_name, params.merge(@pagination_hash))
+
+        @report_data = shared_data.merge(report.to_h)
+        respond_to do |format|
+          format.html { render :index }
+          format.json { render json: @report_data }
+        end
+      end
+
+      def download
+        @report = ReportGenerationService.generate_report(@report_name, params.merge(@pagination_hash))
+
+        respond_to do |format|
+          format.csv do
+            send_data ReportGenerationService.download(@report),
+              filename: "#{ @report_name.to_s }.csv"
+          end
+          format.xls do
+            send_data ReportGenerationService.download(@report, { col_sep: "\t" }),
+              filename: "#{ @report_name.to_s }.xls"
+          end
+          format.text do
+            send_data ReportGenerationService.download(@report),
+              filename: "#{ @report_name.to_s }.txt"
+          end
+          format.pdf do
+            render pdf: "#{ @report_name.to_s }",
+              disposition: 'attachment',
+              layout: 'spree/layouts/pdf.html'
+          end
+        end
+      end
+
+      private
+        def ensure_report_exists
+          @report_name = params[:id].to_sym
+          unless ReportGenerationService.report_exists?(get_report_category, @report_name)
+            redirect_to admin_insights_path, alert: Spree.t(:not_found, scope: [:reports])
+          end
+        end
+
+        def load_reports
+          @reports = ReportGenerationService.reports_for_category(get_report_category)
+        end
+
+        def shared_data
+          {
+            current_page:      params[:page] || 0,
+            report_category:   params[:report_category],
+            request_path:      request.path,
+            url:               request.url,
+            searched_fields:   params[:search],
+          }
+        end
+
+        def get_report_category
+          params[:report_category] = if params[:report_category]
+            params[:report_category].to_sym
+          else
+            session[:report_category].try(:to_sym) || ReportGenerationService.default_report_category
+          end
+          session[:report_category] = params[:report_category]
+        end
+
+        def set_reporting_period
+          if params[:search].present?
+            if params[:search][:start_date] == ""
+              # When clicking on 'x' to remove the filter
+              params[:search][:start_date] = nil
+            else
+              params[:search][:start_date] = params[:search][:start_date] || session[:search_start_date]
+            end
+            if params[:search][:end_date] == ""
+              params[:search][:end_date] = nil
+            else
+              params[:search][:end_date] = params[:search][:end_date].presence || session[:search_end_date]
+            end
+          else
+            params[:search] = {}
+            params[:search][:start_date] = session[:search_start_date]
+            params[:search][:end_date] = session[:search_end_date]
+          end
+          session[:search_start_date] = params[:search][:start_date]
+          session[:search_end_date] = params[:search][:end_date]
+        end
+
+        def set_default_pagination
+          @pagination_hash = { paginate: false }
+          unless params[:paginate] == 'false'
+            @pagination_hash[:paginate] = true
+            @pagination_hash[:records_per_page] = params[:per_page].try(:to_i) || Spree::Config[:records_per_page]
+            @pagination_hash[:offset] = params[:page].to_i * @pagination_hash[:records_per_page]
+          end
+        end
+    end
+  end
+end