reports_kits 0.7.5 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b35a0852529dcce0c76158adc7d87f94051454ac3ded4c714044247e7d38333
-  data.tar.gz: cda1ecd4c9cd98a670d6b8db57a19eabddff6505abba198e5b28509de5025a99
+  metadata.gz: 6f32c4fd9b14483e53d38af3afb1395cc7260277689706c011e11247a6fc8f03
+  data.tar.gz: 2b4a6674475973dfd35c2f8619f677b88c8efaebbe094cb81f6c484859188803
 SHA512:
-  metadata.gz: f7e2b0725c3ececc97986ecde769610a7fb779810c4fdbe00316f6ece87e941c6c700f7aea088fda4024220ec50909d87ed66fb6bc706d24e4011847ee63ce4e
-  data.tar.gz: 7bb2251c503ed97d90a4b3c795b47644d7977e439208c2e8d69d58e8aeec2246f72e500102689392c4151e993da5a79c6f443dda8d0be05d741e4b7d728ee3a2
+  metadata.gz: 3c5c37ab2de7fe6da1787565b9bf7ee635da322ccfd3769b26470262c90b092c4c705be63c02b2c0ce49beaebf749332ffd3cecd064d901ed4aff601f4515c43
+  data.tar.gz: 02c85dc627f4dd78102ef7b2f8cb4ac1ce3aafee7e34161d634fb1f32ae0c5bc033e3274668f9b1f75a4f29302770b458a15297e67cbc2b078c7fa81080a8d89

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+Gemfile.lock
+*.gem
+log/*.log
+.bundle/
+pkg/

data/.rubocop.yml

@@ -0,0 +1,85 @@
+# inherits from https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+AllCops:
+  Exclude:
+    - spec/support/schema.rb
+    - bin/**/*
+    - tmp/**/*
+    - vendor/**/*
+    - .bundle/**/*
+  Rails:
+    Enabled: true
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 40
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 12
+Metrics/LineLength:
+  Enabled: true
+  Max: 140
+Metrics/PerceivedComplexity:
+  Enabled: true
+  Max: 12
+Metrics/ClassLength:
+  Enabled: true
+  CountComments: false
+  Max: 200
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 200
+  Enabled: true
+Metrics/MethodLength:
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: true
+  CountComments: false
+  Max: 50
+Metrics/ParameterLists:
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: true
+  Max: 5
+  CountKeywordArgs: true
+
+Lint/AssignmentInCondition:
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: true
+  AllowSafeAssignment: true
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Enabled: true
+Style/AlignHash:
+  EnforcedColonStyle: key
+  EnforcedHashRocketStyle: key
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Style/Alias:
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  EnforcedStyle: prefer_alias_method
+Style/BracesAroundHashParameters:
+  Exclude:
+    - spec/**/*
+Style/CaseIndentation:
+  EnforcedStyle: case
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: false
+Style/IndentHash:
+  EnforcedStyle: consistent
+Style/RaiseArgs:
+  Enabled: false
+Style/SignalException:
+  Enabled: false
+Style/SpecialGlobalVars:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,21 @@
+cache: bundler
+
+language: ruby
+
+services:
+  - mysql
+  - postgresql
+
+rvm:
+  - '2.2.7'
+  - '2.3.4'
+  - '2.4.1'
+
+before_install: gem update bundler
+before_script:
+  - psql -c 'CREATE DATABASE reports_kit_test;' -U postgres
+  - mysql -e 'CREATE DATABASE IF NOT EXISTS reports_kit_test;'
+  - mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
+  - bundle exec appraisal install
+
+script: bundle exec appraisal rspec

data/Appraisals

@@ -0,0 +1,27 @@
+appraise 'rails_4_mysql' do
+  gem 'mysql2'
+  gem 'rails', '4.2.10'
+end
+
+appraise 'rails_4_postgresql' do
+  gem 'pg'
+  gem 'rails', '4.2.10'
+end
+
+appraise 'rails_5_mysql' do
+  gem 'mysql2'
+  gem 'rails', '5.1.3'
+end
+
+appraise 'rails_5_postgresql' do
+  gem 'pg'
+  gem 'rails', '5.1.3'
+end
+
+# Rails 5.1.4 introduced a bug that generates invalid SQL when using distinct, group, limit and count. This should be resolved in 5.1.5,
+# but we'll need to specifically test against 5.1.4 to prevent this bug from impacting ReportsKit when Rails 5.1.4 is being used.
+# See https://github.com/tombenner/reports_kit/issues/6
+appraise 'rails_5.1.4_postgresql' do
+  gem 'pg'
+  gem 'rails', '5.1.4'
+end

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Tom Benner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+ReportsKit
+=====
+[![Build Status](https://travis-ci.org/tombenner/reports_kit.svg?branch=master)](https://travis-ci.org/tombenner/reports_kit)
+
+ReportsKit lets you easily create beautiful, interactive charts and tables.
+
+For examples and documentation, see [reportskit.co](https://www.reportskit.co/).
+
+[<img src="docs/images/demo.gif?raw=true" width="700" />](docs/images/demo.gif?raw=true)
+
+Resources
+---------
+
+* [Documentation](https://www.reportskit.co/)
+* [Getting Started](https://www.reportskit.co/categories/getting_started)
+* [How It Works](https://www.reportskit.co/subcategories/how_it_works)
+
+Documentation
+-------------
+
+The documentation is hosted at [reportskit.co](https://www.reportskit.co/), and it's generated using [tombenner/reports_kit_docs](https://github.com/tombenner/reports_kit_docs). If you'd like to improve the documentation, feel free to open a PR!
+
+Testing
+-------
+
+ReportsKit is tested against PostgreSQL and MySQL. If you'd like to submit a PR, please be sure to use [Appraisal](https://github.com/thoughtbot/appraisal) to test your changes in both contexts:
+
+```bash
+appraisal rspec
+```
+
+License
+-------
+
+ReportsKit is released under the MIT License. Please see the MIT-LICENSE file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'

data/app/assets/javascripts/reports_kits/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require ./vendor/moment
+//= require_tree .

data/app/assets/javascripts/reports_kits/lib/_init.js

@@ -0,0 +1,9 @@
+window.ReportsKits = {};
+
+$(document).ready(function() {
+  $('.reports_kit_report').each(function(index, el) {
+    var el = $(el)
+    var reportClass = el.data('report-class');
+    new ReportsKits[reportClass]().render({ 'el': el });
+  });
+});

data/app/assets/javascripts/reports_kits/lib/chart.js

@@ -0,0 +1,73 @@
+ReportsKits.Chart = (function(options) {
+  var self = this;
+
+  self.initialize = function(options) {
+    self.options = options;
+    self.report = options.report;
+    self.el = self.report.el;
+
+    self.defaultEmptyStateText = 'No data was found';
+    self.emptyStateEl = $('<div>' + self.defaultEmptyStateText + '</div>').appendTo(self.report.visualizationEl).hide();
+    self.loadingIndicatorEl = $('<div class="loading_indicator"></div>').appendTo(self.report.visualizationEl).hide();
+    self.canvas = $('<canvas />').appendTo(self.report.visualizationEl);
+  };
+
+  self.render = function() {
+    var path = self.el.data('path');
+    var separator = path.indexOf('?') === -1 ? '?' : '&';
+    path += separator + 'properties=' + encodeURIComponent(JSON.stringify(self.report.properties()));
+    self.loadingIndicatorEl.fadeIn(1000);
+    if (self.canvas.is(':visible')) {
+      self.canvas.fadeTo(300, 0.1);
+    }
+    $.getJSON(path, function(response) {
+      var data = response.data;
+      var chartData = data.chart_data;
+      var isEmptyState = chartData.datasets.length === 0 ||
+        (chartData.datasets.length === 1 && chartData.datasets[0].data.length === 0);
+      var emptyStateText = (data.report_options && data.report_options.empty_state_text) || self.defaultEmptyStateText;
+      var options = chartData.options;
+      options = self.addAdditionalOptions(options, data.report_options);
+
+      self.loadingIndicatorEl.stop(true, true).hide();
+      self.emptyStateEl.html(emptyStateText).toggle(isEmptyState);
+      if (isEmptyState) {
+        self.canvas.hide();
+        return;
+      }
+      self.canvas.show().fadeTo(300, 1);
+
+      var args = {
+        type: data.type,
+        data: chartData,
+        options: options
+      };
+
+      if (self.chart) {
+        self.chart.data.datasets = chartData.datasets;
+        self.chart.data.labels = chartData.labels;
+        self.chart.update();
+      } else {
+        self.chart = new Chart(self.canvas, args);
+      }
+    });
+  };
+
+  self.addAdditionalOptions = function(options, reportOptions) {
+    var additionalOptions = {};
+    var maxItems = reportOptions && reportOptions.legend && reportOptions.legend.max_items;
+    if (maxItems) {
+      options.legend = options.legend || {};
+      options.legend.labels = options.legend.labels || {};
+      options.legend.labels.filter = options.legend.labels.filter || function(item) {
+        var index = (typeof item.datasetIndex === 'undefined') ? item.index : item.datasetIndex;
+        return index < maxItems;
+      };
+    }
+    return options;
+  };
+
+  self.initialize(options);
+
+  return self;
+});

data/app/assets/javascripts/reports_kits/lib/report.js

@@ -0,0 +1,135 @@
+ReportsKits.Report = (function() {
+  var self = this;
+
+  self.render = function(options) {
+    self.el = options.el;
+    self.visualizationEl = self.el.find('.reports_kit_visualization');
+
+    self.defaultProperties = self.el.data('properties');
+    self.form = self.el.find('.reports_kit_report_form');
+
+    self.initializeElements();
+    self.initializeEvents();
+    self.initializeVisualization();
+    self.renderVisualization();
+  };
+
+  self.initializeVisualization = function() {
+    if (self.defaultProperties.format == 'table') {
+      self.visualization = new ReportsKits.Table({ report: self });
+    } else {
+      self.visualization = new ReportsKits.Chart({ report: self });
+    }
+  };
+
+  self.initializeElements = function() {
+    self.exportButtons = self.el.find('[data-role=reports_kit_export_button]');
+    self.initializeAutocompletes();
+    self.initializeDateRangePickers();
+  };
+
+  self.initializeAutocompletes = function() {
+    self.form.find('.select2').each(function(index, el) {
+      el = $(el);
+      var path = el.data('path');
+      var elParams = el.data('params');
+      el.select2({
+        theme: 'bootstrap',
+        minimumResultsForSearch: 10,
+        ajax: {
+          url: path,
+          dataType: 'json',
+          delay: 250,
+          data: function(params) {
+            var data = {
+              q: params.term,
+              page: params.page
+            };
+            data = $.extend(data, elParams);
+            return data;
+          },
+          processResults: function(data, params) {
+            params.page = params.page || 1;
+            return { results: data.data }
+          },
+          cache: true
+        }
+      });
+    });
+  };
+
+  self.initializeDateRangePickers = function() {
+    self.form.find('.date_range_picker').daterangepicker({
+      opens: 'left',
+      drops: 'down',
+      showDropdowns: false,
+      showWeekNumbers: false,
+      timePicker: false,
+      buttonClasses: ['btn', 'btn-sm'],
+      applyClass: 'btn-primary btn-daterange-submit',
+      cancelClass: 'btn-default',
+      maxDate: moment(),
+      locale: {
+        format: 'MMM D, YYYY'
+      },
+      ranges: {
+        'Last 30 Days': [moment().subtract(30, 'days'), moment()],
+        'Last 2 Months': [moment().subtract(2, 'months'), moment()],
+        'Last 3 Months': [moment().subtract(3, 'months'), moment()],
+        'Last 4 Months': [moment().subtract(4, 'months'), moment()],
+        'Last 6 Months': [moment().subtract(6, 'months'), moment()],
+        'Last 12 Months': [moment().subtract(12, 'months'), moment()],
+        'Year To Date': [moment().startOf('year'), moment()]
+      }
+    });
+  };
+
+  self.initializeEvents = function() {
+    self.form.find('select,input').on('change', function() {
+      self.renderVisualization();
+    })
+    self.form.on('submit', function() {
+      self.renderVisualization();
+      return false;
+    })
+    self.exportButtons.on('click', self.onClickExportButton);
+  };
+
+  self.properties = function() {
+    var filterKeysValues = {};
+    self.form.find('select,:text').each(function(index, el) {
+      var filter = $(el);
+      var key = filter.attr('name');
+      filterKeysValues[key] = filter.val();
+    });
+    self.form.find(':checkbox').each(function(index, el) {
+      var filter = $(el);
+      var key = filter.attr('name');
+      filterKeysValues[key] = filter.prop('checked');
+    });
+    var properties = $.extend({}, self.defaultProperties);
+
+    properties.ui_filters = {};
+    Object.keys(filterKeysValues).forEach(function(key, index) {
+      var value = filterKeysValues[key];
+      properties.ui_filters[key] = value;
+    });
+
+    return properties;
+  };
+
+  self.onClickExportButton = function(event) {
+    var el = $(event.target);
+    var path = el.data('path');
+    var separator = path.indexOf('?') === -1 ? '?' : '&';
+    path += separator + 'properties=' + encodeURIComponent(JSON.stringify(self.properties()));
+    window.open(path, '_blank');
+    return false;
+  };
+
+  self.renderVisualization = function() {
+    self.visualization.render();
+  };
+
+  return self;
+});

data/app/assets/javascripts/reports_kits/lib/table.js

@@ -0,0 +1,87 @@
+ReportsKits.Table = (function(options) {
+  var self = this;
+
+  self.initialize = function(options) {
+    self.options = options;
+    self.report = options.report;
+    self.el = self.report.el;
+
+    self.defaultEmptyStateText = 'No data was found';
+    self.emptyStateEl = $('<div>' + self.defaultEmptyStateText + '</div>').appendTo(self.report.visualizationEl).hide();
+    self.loadingIndicatorEl = $('<div class="loading_indicator"></div>').appendTo(self.report.visualizationEl).hide();
+    self.table = $('<table />', { 'class': 'table table-striped table-hover' }).appendTo(self.report.visualizationEl);
+  };
+
+  self.render = function() {
+    var path = self.el.data('path');
+    var separator = path.indexOf('?') === -1 ? '?' : '&';
+    path += separator + 'properties=' + encodeURIComponent(JSON.stringify(self.report.properties()));
+    self.loadingIndicatorEl.fadeIn(1000);
+    if (self.table.is(':visible')) {
+      self.table.fadeTo(300, 0.1);
+    }
+    $.getJSON(path, function(response) {
+      var data = response.data;
+      var tableData = data.table_data;
+      var reportOptions = data.report_options || {};
+      // If the data only includes column headers, then it we have an empty state.
+      var isEmptyState = tableData.length <= 1;
+      var emptyStateText = reportOptions.empty_state_text || self.defaultEmptyStateText;
+      self.emptyStateEl.html(emptyStateText);
+
+      self.loadingIndicatorEl.stop(true, true).hide();
+      self.emptyStateEl.toggle(isEmptyState);
+      if (isEmptyState) {
+        self.table.hide();
+        return;
+      }
+      self.table.show().fadeTo(300, 1);
+
+      var rowsCount = tableData.length;
+
+      var hasHead = typeof reportOptions.head_rows_count !== 'undefined';
+      var hasFoot = typeof reportOptions.foot_rows_count !== 'undefined';
+      var headRowStartIndex = hasHead ? 0 : 0;
+      var headRowEndIndex = hasHead ? reportOptions.head_rows_count - 1 : 0;
+      var footRowStartIndex = hasFoot ? rowsCount - reportOptions.foot_rows_count : null;
+      var footRowEndIndex = hasFoot ? rowsCount - 1 : null;
+
+      var html = '';
+      for(var i = 0; i < rowsCount; i++) {
+        if (i === headRowStartIndex) {
+          html += '<thead><tr>';
+        } else if (i === (headRowEndIndex + 1)) {
+          html += '<tbody><tr>';
+        } else if (i === footRowStartIndex) {
+          html += '<tfoot><tr>';
+        } else {
+          html += '<tr>';
+        }
+
+        for(var j = 0; j < tableData[i].length; j++) {
+          if (i == 0 || j == 0) {
+            html += '<th>' + (tableData[i][j] || '') + '</th>';
+          } else {
+            html += '<td>' + ((tableData[i][j] === null) ? '' : tableData[i][j]) + '</td>';
+          }
+        }
+
+        if (i === headRowEndIndex) {
+          html += '</tr></thead>';
+        } else if (i === (footRowStartIndex - 1)) {
+          html += '</tr></tbody>';
+        } else if (i === footRowEndIndex) {
+          html += '</tfoot></tbody>';
+        } else {
+          html += '</tr>';
+        }
+      }
+      self.table.html(html);
+      self.table.tablesorter({ sortInitialOrder: 'desc' });
+    });
+  };
+
+  self.initialize(options);
+
+  return self;
+});