solidus_admin_insights 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 070e7fdbda893fd37283e8fcc9cbdb5b44ede55a
+  data.tar.gz: 332064c9672b762386c9a56d8d5d33f9426491d2
+SHA512:
+  metadata.gz: 03062260769865709aacfe5ad0e6fbbaf5020243256e10805092e87ef9a0ed1446d5d1af46d4e5e5fdecc04571359249213fe43c2886b293feca11a66f6805e9
+  data.tar.gz: 6d7c5904dc50c71a7d38f5a8d022c5523f3bc1ed8093f1ab28fd37a12fd789296d2ef112229b5a5c1b4d6fa314d1c0d354f71d33622cf95206eb92d8182e359d

data/.gitignore

@@ -0,0 +1,54 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+nbproject
+pkg
+*.swp
+spec/dummy
+
+*.gem
+*.rbc
+/.config
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/*
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+.rvmrc
+.ruby-version
+/public/system
+.rspec
+*.sassc
+*.DS_Store
+/test
+/config/*.yml
+*.log
+/public/test_files
+/public/system/*
+/public/*.json
+.byebug_history

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2017 [Vinsol]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,71 @@
+SolidusAdminInsights
+==============
+
+Dashboard for querying and viewing you solidus store's metrics. Use SolidusEventTracker to capture the metrics
+
+Installation
+------------
+
+Add solidus_admin_insights to your Gemfile:
+
+```ruby
+gem 'solidus_admin_insights'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g solidus_admin_insights:install
+```
+
+Adding new reports
+-------------------
+
+Create a class that inherits from `Spree::Report` and define a `report_query` method. If the report is to be paginated. it should define also define a method called `paginated` and set it to return `true` alongwith defining `paginated_report_query` and `record_count_query`. the `_query` methods should return objects that respond to `to_sql` which returns sql string for reporting query.
+
+All reports need to define the following constants:
+1.  `SORTABLE_ATTRIBUTES`: Other attributes based on which reports can be sorted.
+2.  `DEFAULT_SORTABLE_ATTRIBUTE`: The attribute which is used by default to sort the report results.
+3.  `HEADERS`: The static header fields for report. Note time based fields are automatically added. Any field not declared here but available in observation will be ignored while displaying the report.
+4.  `SEARCH_ATTRIBUTES`: A hash containing the attributes and their name on frontend based on which report result can be filtered.
+
+Additionally they need to define two nested classes. `Result` and `Result::Observation`.
+
+`Result` class can inherit from `Spree::Report::Result` if it is a basic report or from `Spree::Report::TimedResult` if the result can be time scaled(i.e. changing reporting period changes the scale of report).
+
+Similarly Observation class needs to inherit either from `Spree::Report::Observation` or `Spree::Report::TimedObservation`. It defines a macro call `observation_fields` which can be passed an array or hash with default values of fields which form one report item. Create a method of same name in Observation class for virtual fields which are not returned by queries. ie. average or for formatting db results.
+
+`TimedResult` has 2 lifecycle methods which can be overriden for customizing the report output.
+1. `build_empty_observations`: Generates empty observations which are later filled with datapoints returned by report query.
+2. `populate_observations`: Fill the empty observations with data returned via query.
+
+`TimedObservation` defines a describes? method which can be overriden to change where the query results gets copied to.
+
+You can add charts to reports by calling `charts` with a list of classes representing the chart. Each chart implementing class gets the results in it's initializer and need to implement to_h method returning the json representation of chart.
+
+Finally, register the report in initializer `solidus_admin_insights.rb` in its appropriate category or make a new category to make it available in admin dashboard.
+
+Testing
+-------
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'solidus_admin_insights/factories'
+```
+
+Credits
+-------
+
+[![vinsol.com: Ruby on Rails, iOS and Android developers](http://vinsol.com/vin_logo.png "Ruby on Rails, iOS and Android developers")](http://vinsol.com)
+
+Copyright (c) 2017 [vinsol.com](http://vinsol.com "Ruby on Rails, iOS and Android developers"), released under the New MIT License

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_admin_insights'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/jquery.tablesorter.min.js

@@ -0,0 +1,4 @@
+
+(function($){$.extend({tablesorter:new
+function(){var parsers=[],widgets=[];this.defaults={cssHeader:"header",cssAsc:"headerSortUp",cssDesc:"headerSortDown",cssChildRow:"expand-child",sortInitialOrder:"asc",sortMultiSortKey:"shiftKey",sortForce:null,sortAppend:null,sortLocaleCompare:true,textExtraction:"simple",parsers:{},widgets:[],widgetZebra:{css:["even","odd"]},headers:{},widthFixed:false,cancelSelection:true,sortList:[],headerList:[],dateFormat:"us",decimal:'/\.|\,/g',onRenderHeader:null,selectorHeaders:'thead th',debug:false};function benchmark(s,d){log(s+","+(new Date().getTime()-d.getTime())+"ms");}this.benchmark=benchmark;function log(s){if(typeof console!="undefined"&&typeof console.debug!="undefined"){console.log(s);}else{alert(s);}}function buildParserCache(table,$headers){if(table.config.debug){var parsersDebug="";}if(table.tBodies.length==0)return;var rows=table.tBodies[0].rows;if(rows[0]){var list=[],cells=rows[0].cells,l=cells.length;for(var i=0;i<l;i++){var p=false;if($.metadata&&($($headers[i]).metadata()&&$($headers[i]).metadata().sorter)){p=getParserById($($headers[i]).metadata().sorter);}else if((table.config.headers[i]&&table.config.headers[i].sorter)){p=getParserById(table.config.headers[i].sorter);}if(!p){p=detectParserForColumn(table,rows,-1,i);}if(table.config.debug){parsersDebug+="column:"+i+" parser:"+p.id+"\n";}list.push(p);}}if(table.config.debug){log(parsersDebug);}return list;};function detectParserForColumn(table,rows,rowIndex,cellIndex){var l=parsers.length,node=false,nodeValue=false,keepLooking=true;while(nodeValue==''&&keepLooking){rowIndex++;if(rows[rowIndex]){node=getNodeFromRowAndCellIndex(rows,rowIndex,cellIndex);nodeValue=trimAndGetNodeText(table.config,node);if(table.config.debug){log('Checking if value was empty on row:'+rowIndex);}}else{keepLooking=false;}}for(var i=1;i<l;i++){if(parsers[i].is(nodeValue,table,node)){return parsers[i];}}return parsers[0];}function getNodeFromRowAndCellIndex(rows,rowIndex,cellIndex){return rows[rowIndex].cells[cellIndex];}function trimAndGetNodeText(config,node){return $.trim(getElementText(config,node));}function getParserById(name){var l=parsers.length;for(var i=0;i<l;i++){if(parsers[i].id.toLowerCase()==name.toLowerCase()){return parsers[i];}}return false;}function buildCache(table){if(table.config.debug){var cacheTime=new Date();}var totalRows=(table.tBodies[0]&&table.tBodies[0].rows.length)||0,totalCells=(table.tBodies[0].rows[0]&&table.tBodies[0].rows[0].cells.length)||0,parsers=table.config.parsers,cache={row:[],normalized:[]};for(var i=0;i<totalRows;++i){var c=$(table.tBodies[0].rows[i]),cols=[];if(c.hasClass(table.config.cssChildRow)){cache.row[cache.row.length-1]=cache.row[cache.row.length-1].add(c);continue;}cache.row.push(c);for(var j=0;j<totalCells;++j){cols.push(parsers[j].format(getElementText(table.config,c[0].cells[j]),table,c[0].cells[j]));}cols.push(cache.normalized.length);cache.normalized.push(cols);cols=null;};if(table.config.debug){benchmark("Building cache for "+totalRows+" rows:",cacheTime);}return cache;};function getElementText(config,node){var text="";if(!node)return"";if(!config.supportsTextContent)config.supportsTextContent=node.textContent||false;if(config.textExtraction=="simple"){if(config.supportsTextContent){text=node.textContent;}else{if(node.childNodes[0]&&node.childNodes[0].hasChildNodes()){text=node.childNodes[0].innerHTML;}else{text=node.innerHTML;}}}else{if(typeof(config.textExtraction)=="function"){text=config.textExtraction(node);}else{text=$(node).text();}}return text;}function appendToTable(table,cache){if(table.config.debug){var appendTime=new Date()}var c=cache,r=c.row,n=c.normalized,totalRows=n.length,checkCell=(n[0].length-1),tableBody=$(table.tBodies[0]),rows=[];for(var i=0;i<totalRows;i++){var pos=n[i][checkCell];rows.push(r[pos]);if(!table.config.appender){var l=r[pos].length;for(var j=0;j<l;j++){tableBody[0].appendChild(r[pos][j]);}}}if(table.config.appender){table.config.appender(table,rows);}rows=null;if(table.config.debug){benchmark("Rebuilt table:",appendTime);}applyWidget(table);setTimeout(function(){$(table).trigger("sortEnd");},0);};function buildHeaders(table){if(table.config.debug){var time=new Date();}var meta=($.metadata)?true:false;var header_index=computeTableHeaderCellIndexes(table);$tableHeaders=$(table.config.selectorHeaders,table).each(function(index){this.column=header_index[this.parentNode.rowIndex+"-"+this.cellIndex];this.order=formatSortingOrder(table.config.sortInitialOrder);this.count=this.order;if(checkHeaderMetadata(this)||checkHeaderOptions(table,index))this.sortDisabled=true;if(checkHeaderOptionsSortingLocked(table,index))this.order=this.lockedOrder=checkHeaderOptionsSortingLocked(table,index);if(!this.sortDisabled){var $th=$(this).addClass(table.config.cssHeader);if(table.config.onRenderHeader)table.config.onRenderHeader.apply($th);}table.config.headerList[index]=this;});if(table.config.debug){benchmark("Built headers:",time);log($tableHeaders);}return $tableHeaders;};function computeTableHeaderCellIndexes(t){var matrix=[];var lookup={};var thead=t.getElementsByTagName('THEAD')[0];var trs=thead.getElementsByTagName('TR');for(var i=0;i<trs.length;i++){var cells=trs[i].cells;for(var j=0;j<cells.length;j++){var c=cells[j];var rowIndex=c.parentNode.rowIndex;var cellId=rowIndex+"-"+c.cellIndex;var rowSpan=c.rowSpan||1;var colSpan=c.colSpan||1
+var firstAvailCol;if(typeof(matrix[rowIndex])=="undefined"){matrix[rowIndex]=[];}for(var k=0;k<matrix[rowIndex].length+1;k++){if(typeof(matrix[rowIndex][k])=="undefined"){firstAvailCol=k;break;}}lookup[cellId]=firstAvailCol;for(var k=rowIndex;k<rowIndex+rowSpan;k++){if(typeof(matrix[k])=="undefined"){matrix[k]=[];}var matrixrow=matrix[k];for(var l=firstAvailCol;l<firstAvailCol+colSpan;l++){matrixrow[l]="x";}}}}return lookup;}function checkCellColSpan(table,rows,row){var arr=[],r=table.tHead.rows,c=r[row].cells;for(var i=0;i<c.length;i++){var cell=c[i];if(cell.colSpan>1){arr=arr.concat(checkCellColSpan(table,headerArr,row++));}else{if(table.tHead.length==1||(cell.rowSpan>1||!r[row+1])){arr.push(cell);}}}return arr;};function checkHeaderMetadata(cell){if(($.metadata)&&($(cell).metadata().sorter===false)){return true;};return false;}function checkHeaderOptions(table,i){if((table.config.headers[i])&&(table.config.headers[i].sorter===false)){return true;};return false;}function checkHeaderOptionsSortingLocked(table,i){if((table.config.headers[i])&&(table.config.headers[i].lockedOrder))return table.config.headers[i].lockedOrder;return false;}function applyWidget(table){var c=table.config.widgets;var l=c.length;for(var i=0;i<l;i++){getWidgetById(c[i]).format(table);}}function getWidgetById(name){var l=widgets.length;for(var i=0;i<l;i++){if(widgets[i].id.toLowerCase()==name.toLowerCase()){return widgets[i];}}};function formatSortingOrder(v){if(typeof(v)!="Number"){return(v.toLowerCase()=="desc")?1:0;}else{return(v==1)?1:0;}}function isValueInArray(v,a){var l=a.length;for(var i=0;i<l;i++){if(a[i][0]==v){return true;}}return false;}function setHeadersCss(table,$headers,list,css){$headers.removeClass(css[0]).removeClass(css[1]);var h=[];$headers.each(function(offset){if(!this.sortDisabled){h[this.column]=$(this);}});var l=list.length;for(var i=0;i<l;i++){h[list[i][0]].addClass(css[list[i][1]]);}}function fixColumnWidth(table,$headers){var c=table.config;if(c.widthFixed){var colgroup=$('<colgroup>');$("tr:first td",table.tBodies[0]).each(function(){colgroup.append($('<col>').css('width',$(this).width()));});$(table).prepend(colgroup);};}function updateHeaderSortCount(table,sortList){var c=table.config,l=sortList.length;for(var i=0;i<l;i++){var s=sortList[i],o=c.headerList[s[0]];o.count=s[1];o.count++;}}function multisort(table,sortList,cache){if(table.config.debug){var sortTime=new Date();}var dynamicExp="var sortWrapper = function(a,b) {",l=sortList.length;for(var i=0;i<l;i++){var c=sortList[i][0];var order=sortList[i][1];var s=(table.config.parsers[c].type=="text")?((order==0)?makeSortFunction("text","asc",c):makeSortFunction("text","desc",c)):((order==0)?makeSortFunction("numeric","asc",c):makeSortFunction("numeric","desc",c));var e="e"+i;dynamicExp+="var "+e+" = "+s;dynamicExp+="if("+e+") { return "+e+"; } ";dynamicExp+="else { ";}var orgOrderCol=cache.normalized[0].length-1;dynamicExp+="return a["+orgOrderCol+"]-b["+orgOrderCol+"];";for(var i=0;i<l;i++){dynamicExp+="}; ";}dynamicExp+="return 0; ";dynamicExp+="}; ";if(table.config.debug){benchmark("Evaling expression:"+dynamicExp,new Date());}eval(dynamicExp);cache.normalized.sort(sortWrapper);if(table.config.debug){benchmark("Sorting on "+sortList.toString()+" and dir "+order+" time:",sortTime);}return cache;};function makeSortFunction(type,direction,index){var a="a["+index+"]",b="b["+index+"]";if(type=='text'&&direction=='asc'){return"("+a+" == "+b+" ? 0 : ("+a+" === null ? Number.POSITIVE_INFINITY : ("+b+" === null ? Number.NEGATIVE_INFINITY : ("+a+" < "+b+") ? -1 : 1 )));";}else if(type=='text'&&direction=='desc'){return"("+a+" == "+b+" ? 0 : ("+a+" === null ? Number.POSITIVE_INFINITY : ("+b+" === null ? Number.NEGATIVE_INFINITY : ("+b+" < "+a+") ? -1 : 1 )));";}else if(type=='numeric'&&direction=='asc'){return"("+a+" === null && "+b+" === null) ? 0 :("+a+" === null ? Number.POSITIVE_INFINITY : ("+b+" === null ? Number.NEGATIVE_INFINITY : "+a+" - "+b+"));";}else if(type=='numeric'&&direction=='desc'){return"("+a+" === null && "+b+" === null) ? 0 :("+a+" === null ? Number.POSITIVE_INFINITY : ("+b+" === null ? Number.NEGATIVE_INFINITY : "+b+" - "+a+"));";}};function makeSortText(i){return"((a["+i+"] < b["+i+"]) ? -1 : ((a["+i+"] > b["+i+"]) ? 1 : 0));";};function makeSortTextDesc(i){return"((b["+i+"] < a["+i+"]) ? -1 : ((b["+i+"] > a["+i+"]) ? 1 : 0));";};function makeSortNumeric(i){return"a["+i+"]-b["+i+"];";};function makeSortNumericDesc(i){return"b["+i+"]-a["+i+"];";};function sortText(a,b){if(table.config.sortLocaleCompare)return a.localeCompare(b);return((a<b)?-1:((a>b)?1:0));};function sortTextDesc(a,b){if(table.config.sortLocaleCompare)return b.localeCompare(a);return((b<a)?-1:((b>a)?1:0));};function sortNumeric(a,b){return a-b;};function sortNumericDesc(a,b){return b-a;};function getCachedSortType(parsers,i){return parsers[i].type;};this.construct=function(settings){return this.each(function(){if(!this.tHead||!this.tBodies)return;var $this,$document,$headers,cache,config,shiftDown=0,sortOrder;this.config={};config=$.extend(this.config,$.tablesorter.defaults,settings);$this=$(this);$.data(this,"tablesorter",config);$headers=buildHeaders(this);this.config.parsers=buildParserCache(this,$headers);cache=buildCache(this);var sortCSS=[config.cssDesc,config.cssAsc];fixColumnWidth(this);$headers.click(function(e){var totalRows=($this[0].tBodies[0]&&$this[0].tBodies[0].rows.length)||0;if(!this.sortDisabled&&totalRows>0){$this.trigger("sortStart");var $cell=$(this);var i=this.column;this.order=this.count++%2;if(this.lockedOrder)this.order=this.lockedOrder;if(!e[config.sortMultiSortKey]){config.sortList=[];if(config.sortForce!=null){var a=config.sortForce;for(var j=0;j<a.length;j++){if(a[j][0]!=i){config.sortList.push(a[j]);}}}config.sortList.push([i,this.order]);}else{if(isValueInArray(i,config.sortList)){for(var j=0;j<config.sortList.length;j++){var s=config.sortList[j],o=config.headerList[s[0]];if(s[0]==i){o.count=s[1];o.count++;s[1]=o.count%2;}}}else{config.sortList.push([i,this.order]);}};setTimeout(function(){setHeadersCss($this[0],$headers,config.sortList,sortCSS);appendToTable($this[0],multisort($this[0],config.sortList,cache));},1);return false;}}).mousedown(function(){if(config.cancelSelection){this.onselectstart=function(){return false};return false;}});$this.bind("update",function(){var me=this;setTimeout(function(){me.config.parsers=buildParserCache(me,$headers);cache=buildCache(me);},1);}).bind("updateCell",function(e,cell){var config=this.config;var pos=[(cell.parentNode.rowIndex-1),cell.cellIndex];cache.normalized[pos[0]][pos[1]]=config.parsers[pos[1]].format(getElementText(config,cell),cell);}).bind("sorton",function(e,list){$(this).trigger("sortStart");config.sortList=list;var sortList=config.sortList;updateHeaderSortCount(this,sortList);setHeadersCss(this,$headers,sortList,sortCSS);appendToTable(this,multisort(this,sortList,cache));}).bind("appendCache",function(){appendToTable(this,cache);}).bind("applyWidgetId",function(e,id){getWidgetById(id).format(this);}).bind("applyWidgets",function(){applyWidget(this);});if($.metadata&&($(this).metadata()&&$(this).metadata().sortlist)){config.sortList=$(this).metadata().sortlist;}if(config.sortList.length>0){$this.trigger("sorton",[config.sortList]);}applyWidget(this);});};this.addParser=function(parser){var l=parsers.length,a=true;for(var i=0;i<l;i++){if(parsers[i].id.toLowerCase()==parser.id.toLowerCase()){a=false;}}if(a){parsers.push(parser);};};this.addWidget=function(widget){widgets.push(widget);};this.formatFloat=function(s){var i=parseFloat(s);return(isNaN(i))?0:i;};this.formatInt=function(s){var i=parseInt(s);return(isNaN(i))?0:i;};this.isDigit=function(s,config){return/^[-+]?\d*$/.test($.trim(s.replace(/[,.']/g,'')));};this.clearTableBody=function(table){if($.browser.msie){function empty(){while(this.firstChild)this.removeChild(this.firstChild);}empty.apply(table.tBodies[0]);}else{table.tBodies[0].innerHTML="";}};}});$.fn.extend({tablesorter:$.tablesorter.construct});var ts=$.tablesorter;ts.addParser({id:"text",is:function(s){return true;},format:function(s){return $.trim(s.toLocaleLowerCase());},type:"text"});ts.addParser({id:"digit",is:function(s,table){var c=table.config;return $.tablesorter.isDigit(s,c);},format:function(s){return $.tablesorter.formatFloat(s);},type:"numeric"});ts.addParser({id:"currency",is:function(s){return/^[£$€?.]/.test(s);},format:function(s){return $.tablesorter.formatFloat(s.replace(new RegExp(/[£$€]/g),""));},type:"numeric"});ts.addParser({id:"ipAddress",is:function(s){return/^\d{2,3}[\.]\d{2,3}[\.]\d{2,3}[\.]\d{2,3}$/.test(s);},format:function(s){var a=s.split("."),r="",l=a.length;for(var i=0;i<l;i++){var item=a[i];if(item.length==2){r+="0"+item;}else{r+=item;}}return $.tablesorter.formatFloat(r);},type:"numeric"});ts.addParser({id:"url",is:function(s){return/^(https?|ftp|file):\/\/$/.test(s);},format:function(s){return jQuery.trim(s.replace(new RegExp(/(https?|ftp|file):\/\//),''));},type:"text"});ts.addParser({id:"isoDate",is:function(s){return/^\d{4}[\/-]\d{1,2}[\/-]\d{1,2}$/.test(s);},format:function(s){return $.tablesorter.formatFloat((s!="")?new Date(s.replace(new RegExp(/-/g),"/")).getTime():"0");},type:"numeric"});ts.addParser({id:"percent",is:function(s){return/\%$/.test($.trim(s));},format:function(s){return $.tablesorter.formatFloat(s.replace(new RegExp(/%/g),""));},type:"numeric"});ts.addParser({id:"usLongDate",is:function(s){return s.match(new RegExp(/^[A-Za-z]{3,10}\.? [0-9]{1,2}, ([0-9]{4}|'?[0-9]{2}) (([0-2]?[0-9]:[0-5][0-9])|([0-1]?[0-9]:[0-5][0-9]\s(AM|PM)))$/));},format:function(s){return $.tablesorter.formatFloat(new Date(s).getTime());},type:"numeric"});ts.addParser({id:"shortDate",is:function(s){return/\d{1,2}[\/\-]\d{1,2}[\/\-]\d{2,4}/.test(s);},format:function(s,table){var c=table.config;s=s.replace(/\-/g,"/");if(c.dateFormat=="us"){s=s.replace(/(\d{1,2})[\/\-](\d{1,2})[\/\-](\d{4})/,"$3/$1/$2");}else if(c.dateFormat=="uk"){s=s.replace(/(\d{1,2})[\/\-](\d{1,2})[\/\-](\d{4})/,"$3/$2/$1");}else if(c.dateFormat=="dd/mm/yy"||c.dateFormat=="dd-mm-yy"){s=s.replace(/(\d{1,2})[\/\-](\d{1,2})[\/\-](\d{2})/,"$1/$2/$3");}return $.tablesorter.formatFloat(new Date(s).getTime());},type:"numeric"});ts.addParser({id:"time",is:function(s){return/^(([0-2]?[0-9]:[0-5][0-9])|([0-1]?[0-9]:[0-5][0-9]\s(am|pm)))$/.test(s);},format:function(s){return $.tablesorter.formatFloat(new Date("2000/01/01 "+s).getTime());},type:"numeric"});ts.addParser({id:"metadata",is:function(s){return false;},format:function(s,table,cell){var c=table.config,p=(!c.parserMetadataName)?'sortValue':c.parserMetadataName;return $(cell).metadata()[p];},type:"numeric"});ts.addWidget({id:"zebra",format:function(table){if(table.config.debug){var time=new Date();}var $tr,row=-1,odd;$("tr:visible",table.tBodies[0]).each(function(i){$tr=$(this);if(!$tr.hasClass(table.config.cssChildRow))row++;odd=(row%2==0);$tr.removeClass(table.config.widgetZebra.css[odd?0:1]).addClass(table.config.widgetZebra.css[odd?1:0])});if(table.config.debug){$.tablesorter.benchmark("Applying Zebra widget",time);}}});})(jQuery);

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

@@ -0,0 +1,2 @@
+//= require spree/backend/solidus_admin_insights/report_loader
+//= require spree/backend/tmpl

data/app/assets/javascripts/spree/backend/solidus_admin_insights/paginator.js

@@ -0,0 +1,128 @@
+function Paginator(inputs, reportLoader) {
+  this.$insightsTableList = inputs.insightsDiv;
+  this.paginatorDiv = inputs.paginatorDiv;
+  this.tableSorter = inputs.tableSorterObject;
+  this.removePaginationButton = inputs.removePaginationButton;
+  this.reportLoader = reportLoader;
+  this.applyPaginationButton = inputs.applyPaginationButton;
+}
+
+Paginator.prototype.bindEvents = function () {
+  var _this = this;
+  this.paginatorDiv.on('click', '.pagination-link', function (event) {
+    event.preventDefault();
+    _this.loadPaginationData(event);
+  });
+
+  this.reportLoader.perPageSelector.on('change', function(event) {
+    _this.togglePaginatorButtons(_this.removePaginationButton, _this.applyPaginationButton);
+    _this.loadReportData(event);
+  });
+
+  this.removePaginationButton.on('click', function(event) {
+    _this.togglePaginatorButtons(_this.applyPaginationButton, _this.removePaginationButton);
+    event.preventDefault();
+    _this.removePagination(this);
+  });
+
+  this.applyPaginationButton.on('click', function(event) {
+    _this.togglePaginatorButtons(_this.removePaginationButton, _this.applyPaginationButton);
+    event.preventDefault();
+    _this.applyPagination(event);
+  });
+};
+
+Paginator.prototype.togglePaginatorButtons = function(firstButton, secondButton) {
+  firstButton.closest('span').removeClass('hide');
+  secondButton.closest('span').addClass('hide');
+};
+
+Paginator.prototype.refreshPaginator = function(data) {
+  this.reportLoader.perPageSelector.val(data['per_page']);
+  this.populatePaginationData(data);
+};
+
+Paginator.prototype.loadPaginationData = function (event) {
+  var $element = $(event.target),
+    sorted_attributes = this.tableSorter.fetchSortedAttribute(),
+    attribute = sorted_attributes[0],
+    sortOrder = sorted_attributes[1],
+    requestPath = $element.attr('href') + '&sort%5Battribute%5D=' + attribute + '&sort%5Btype%5D=' + sortOrder,
+    _this = this;
+  _this.reportLoader.requestUrl = requestPath;
+
+  if (!($element.parents('li').hasClass('active'))) {
+    $.ajax({
+      type: 'GET',
+      url: requestPath,
+      dataType: 'json',
+      success: function(data) {
+        _this.populateInsightsData(data);
+        _this.paginatorDiv.find('.active').removeClass('active');
+        $element.parents('li').addClass('active');
+      }
+    });
+  }
+};
+
+Paginator.prototype.populateInsightsData = function(data) {
+  this.reportLoader.populateInsightsData(data);
+};
+
+Paginator.prototype.populatePaginationData = function(data) {
+  var $templateData = $(tmpl('paginator-tmpl', data));
+  this.paginatorDiv.empty().append($templateData);
+  this.pageLinks = this.paginatorDiv.find('.pagination-link');
+};
+
+Paginator.prototype.loadReportData = function(event) {
+  var $element = $(event.target),
+      sorted_attributes = this.tableSorter.fetchSortedAttribute(),
+      attribute = sorted_attributes[0],
+      sortOrder = sorted_attributes[1],
+      requestUrl = $element.data('url') + '&sort%5Battribute%5D=' + attribute + '&sort%5Btype%5D=' + sortOrder + '&' + $('#filter-search').serialize() + '&per_page=' + $element.val();
+  $element.data('url', requestUrl);
+  this.reportLoader.loadChart($element);
+};
+
+Paginator.prototype.removePagination = function(currentElement) {
+  var $element = this.reportLoader.perPageSelector,
+      _this = this,
+      sorted_attributes = this.tableSorter.fetchSortedAttribute(),
+      attribute = sorted_attributes[0],
+      sortOrder = sorted_attributes[1],
+      requestUrl = $element.data('url') + '&sort%5Battribute%5D=' + attribute + '&sort%5Btype%5D=' + sortOrder + '&' + $('#filter-search').serialize() + '&paginate=false';
+  $(currentElement).attr('href', requestUrl);
+  _this.reportLoader.requestUrl = requestUrl;
+  $element.val('');
+  $.ajax({
+    type: 'GET',
+    url: requestUrl,
+    dataType: 'json',
+    success: function(data) {
+      _this.populateInsightsData(data);
+      _this.paginatorDiv.empty();
+    }
+  });
+};
+
+Paginator.prototype.applyPagination = function(currentElement) {
+  var $element = this.reportLoader.perPageSelector,
+      _this = this,
+      sorted_attributes = this.tableSorter.fetchSortedAttribute(),
+      attribute = sorted_attributes[0],
+      sortOrder = sorted_attributes[1],
+      requestUrl = $element.data('url') + '&sort%5Battribute%5D=' + attribute + '&sort%5Btype%5D=' + sortOrder + '&' + $('#filter-search').serialize();
+  $(currentElement).attr('href', requestUrl);
+  _this.reportLoader.requestUrl = requestUrl;
+  $element.val('5');
+  $.ajax({
+    type: 'GET',
+    url: requestUrl,
+    dataType: 'json',
+    success: function(data) {
+      _this.populateInsightsData(data);
+      _this.populatePaginationData(data);
+    }
+  });
+};

data/app/assets/javascripts/spree/backend/solidus_admin_insights/report_loader.js

@@ -0,0 +1,265 @@
+//= require spree/backend/solidus_admin_insights/paginator
+//= require spree/backend/solidus_admin_insights/searcher
+//= require spree/backend/solidus_admin_insights/table_sorter
+
+function ReportLoader(inputs) {
+  this.$selectList = inputs.reportsSelectBox;
+  this.$insightsTableList = inputs.insightsDiv;
+  this.$narrowDownData = inputs.narrowDownData;
+  this.tableHelpers = inputs.tableHelpers;
+  this.pageSelector = inputs.tableHelpers.find('#page-selector');
+  this.perPageSelector = this.tableHelpers.find('#per_page');
+  this.pageHelpers = this.tableHelpers.find('#page-helpers');
+  this.resetButton = inputs.resetButton;
+  this.downloadButton = inputs.downloadButton;
+  this.refreshButton = inputs.refreshButton;
+  this.filterDiv = inputs.filterDiv;
+  this.paginatorDiv = inputs.paginatorDiv;
+  this.removePaginationButton = inputs.removePaginationButton;
+  this.applyPaginationButton = inputs.applyPaginationButton;
+  this.chartContainer = inputs.chartContainer;
+  this.downloadLinks = inputs.downloadLinks;
+  this.requestUrl = '';
+  this.isStatePushable = true;
+  this.tableSorterObject = null;
+  this.searcherObject = null;
+  this.paginatorObject = null;
+}
+
+ReportLoader.prototype.init = function() {
+  var tableSorterInputs = {
+    $insightsTable: this.$insightsTableList,
+    reportLoader: this,
+    paginatorDiv: this.paginatorDiv
+  };
+  this.tableSorterObject = new TableSorter(tableSorterInputs);
+  this.tableSorterObject.bindEvents();
+
+  var searcherInputs = {
+    filterDiv:   this.filterDiv,
+    insightsDiv: this.$insightsTableList,
+    tableSorterObject: this.tableSorterObject
+  };
+  this.searcherObject = new Searcher(searcherInputs, this);
+  this.searcherObject.bindEvents();
+
+  var paginatorInputs = {
+    paginatorDiv: this.paginatorDiv,
+    insightsDiv: this.$insightsTableList,
+    tableSorterObject: this.tableSorterObject,
+    removePaginationButton: this.removePaginationButton,
+    applyPaginationButton: this.applyPaginationButton
+  };
+  this.paginatorObject = new Paginator(paginatorInputs, this);
+  this.paginatorObject.bindEvents();
+  this.setDefaultReport();
+};
+
+ReportLoader.prototype.setDefaultReport = function() {
+  if(location.pathname == '/admin/insights') {
+    this.$selectList.val($(this.$selectList.find('option')[1]).val()).change();
+    window.history.pushState({}, '', this.$selectList.find(':selected').data('url'));
+  }
+};
+
+ReportLoader.prototype.bindEvents = function() {
+  var _this = this;
+  _this.$selectList.on('change', function() {
+    $(this).find('option').first().attr('disabled', true);
+    _this.paginatorObject.togglePaginatorButtons(_this.paginatorObject.removePaginationButton, _this.paginatorObject.applyPaginationButton);
+    _this.loadChart($(this).find(':selected'));
+  });
+
+  this.resetButton.on('click', function() {
+    _this.resetFilters(event);
+  });
+
+  this.refreshButton.on('click', function() {
+    _this.refreshPage(event);
+  });
+
+  this.downloadButton.on('click', function() {
+    _this.toggleDownloadLinks(event, this);
+  });
+
+  this.$narrowDownData.on('keyup', function() {
+    var value = $(this).val();
+    var pattern = new RegExp(value, "i");
+
+    _this.$insightsTableList.find('tbody > tr').each(function() {
+      if (!($(this).find('td').text().search(pattern) >= 0)) {
+        $(this).hide();
+      }
+      if (($(this).find('td').text().search(pattern) >= 0)) {
+        $(this).show();
+      }
+    });
+
+  });
+
+  $('body').on('click', function(event) {
+    _this.downloadButton.removeClass('open');
+    event.stopPropagation();
+  });
+
+  _this.bindPopStateEventCallback();
+};
+
+ReportLoader.prototype.toggleDownloadLinks = function(event, element) {
+  $(element).toggleClass('open');
+  event.preventDefault();
+  event.stopPropagation();
+};
+
+ReportLoader.prototype.resetFilters = function(event) {
+  event.preventDefault();
+  var $element = $(event.target),
+      paginate = this.removePaginationButton.closest('span').hasClass('hide');
+  $element.attr('href', this.perPageSelector.data('url') + '&paginate=' + paginate);
+  $element.data('url', this.perPageSelector.data('url') + '&paginate=' + paginate);
+  this.loadChart($element);
+};
+
+ReportLoader.prototype.refreshPage = function(event) {
+  event.preventDefault();
+  var $element = $(event.target);
+  $element.attr('href', location.href);
+  $element.data('url', location.href);
+  this.loadChart($element);
+};
+
+ReportLoader.prototype.bindPopStateEventCallback = function() {
+  var _this = this;
+  window.onpopstate = function(event) {
+    event.state ? (report_name = event.state['report_name'] || '') : (report_name = '');
+    _this.$selectList.val(report_name);
+    _this.$selectList.select2('val', report_name);
+    var $selectedOption = _this.$selectList.find(':selected');
+    _this.fetchChartDataWithoutState(location.href, $selectedOption);
+  };
+};
+
+ReportLoader.prototype.loadChart = function($selectedOption) {
+  var requestPath = $selectedOption.data('url');
+  this.fetchChartData(requestPath, $selectedOption);
+};
+
+ReportLoader.prototype.fetchChartData = function(url, $selectedOption) {
+  var _this = this;
+  _this.requestUrl = url;
+  $.ajax({
+    type: 'GET',
+    url: url,
+    dataType: 'json',
+    cache: false,
+    success: function(data) {
+      (_this.isStatePushable ? _this.populateInsightsData(data) : _this.populateInsightsDataWithoutState(data))
+      if(data.headers != undefined) {
+        _this.tableHelpers.removeClass('hide');
+
+        if(!data.pagination_required) {
+          _this.pageSelector.addClass('hide');
+          $.each(_this.pageHelpers.find('.col-md-2'), function(index, object) {
+            $(object).removeClass('col-md-2').addClass('col-md-3');
+          });
+        } else {
+          _this.pageSelector.removeClass('hide');
+          $.each(_this.pageHelpers.find('.col-md-3'), function(index, object) {
+            $(object).removeClass('col-md-3').addClass('col-md-2');
+          });
+        }
+        _this.perPageSelector.data('url', data['request_path'] + '?report_category=' + data['report_category']);
+        _this.setDownloadLinksPath();
+        _this.searcherObject.refreshSearcher($selectedOption, data);
+        _this.paginatorObject.refreshPaginator(data);
+        if(data.searched_fields != undefined)
+          _this.searcherObject.fillFormFields(data.searched_fields);
+      }
+    }
+  });
+};
+
+ReportLoader.prototype.buildChart = function(data) {
+  var chart_container = $('#chart-container');
+  if ((data['chart_json'] != undefined) && (data['chart_json']['chart'])) {
+    chart_container.empty().removeClass('hidden');
+    $.each(data['chart_json']['charts'], function(index, chart) {
+      var chart_div = $('<div>', { id: chart['id'] });
+      chart_container.append(chart_div);
+      chart_div.highcharts(chart['json']);
+    });
+  } else {
+    chart_container.addClass('hidden');
+  }
+};
+
+ReportLoader.prototype.fetchChartDataWithoutState = function(url, $selectedOption) {
+  this.isStatePushable = false;
+  this.fetchChartData(url, $selectedOption);
+};
+
+ReportLoader.prototype.populateInsightsData = function(data) {
+  if(data.headers != undefined) {
+    var $templateData = $(tmpl('tmpl', data));
+    this.$insightsTableList.empty().append($templateData);
+    this.buildChart(data);
+  } else {
+    this.$insightsTableList.empty();
+    this.paginatorDiv.empty();
+    this.filterDiv.addClass('hide');
+    this.chartContainer.addClass('hidden');
+  }
+  if(this.isStatePushable) {
+    this.pushUrlToHistory();
+  } else {
+    this.isStatePushable = true;
+  }
+};
+
+ReportLoader.prototype.setDownloadLinksPath = function($selectedOption) {
+  var _this = this;
+  $.each(this.downloadLinks, function() {
+    $(this).attr('href', $(this).data('url') + '?id=' + _this.$selectList.val() + '&paginate=false');
+  });
+};
+
+ReportLoader.prototype.populateInsightsDataWithoutState = function(data) {
+  this.isStatePushable = false;
+  this.populateInsightsData(data);
+};
+
+ReportLoader.prototype.pushUrlToHistory = function() {
+  var report_name = this.$selectList.find(':selected').val();
+  window.history.pushState({ report_name: report_name }, '', this.requestUrl);
+  this.requestUrl = '';
+};
+
+ReportLoader.prototype.populateInitialData = function() {
+  var $selectedOption = this.$selectList.find(':selected');
+  this.fetchChartDataWithoutState(location.href, $selectedOption);
+};
+
+$(function() {
+  var is_admin_insights_page = $("[data-hook='admin-insights']").length;
+  if (is_admin_insights_page) {
+    var inputs = {
+      insightsDiv:      $('#report-div'),
+      reportsSelectBox: $('#reports'),
+      resetButton: $('#reset'),
+      refreshButton: $('#refresh'),
+      removePaginationButton: $('#remove-pagination'),
+      applyPaginationButton: $('#apply-pagination'),
+      tableHelpers: $('#table-helpers'),
+      filterDiv: $('#search-div'),
+      paginatorDiv: $('#paginator-div'),
+      narrowDownData: $('#narrow-down-report-data'),
+      chartContainer: $('#chart-container'),
+      downloadLinks: $('.download-link'),
+      downloadButton: $('.toggle-btn')
+    },
+    reportLoader = new ReportLoader(inputs);
+    reportLoader.init();
+    reportLoader.bindEvents();
+    reportLoader.populateInitialData();
+  }
+});