noventius 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cc617e8561a3d80508c66c26477028e6d8bf6fc
+  data.tar.gz: 5dc709e45a22849681cc05e2d9ae4f632f39b7f6
+SHA512:
+  metadata.gz: 349a9fd40d315d93b23ba0bac28d3ad7fb19c5bec4901868af0ec19eff7a7c6548c774bd7efaf22437ac1d67e7f2bf4a2fa31964d8d0317590a3eb9ddac16e7f
+  data.tar.gz: f4f3397862a83e647b06479beaee2b17dcd84e13cf8fb59be731931fb20b10687737c1a9d3206782375e89b3d41fe66c79f7e47d3b7d21d56cf26d8dbca5524c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Andres Pache
+
+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/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Nuntius'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks

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

@@ -0,0 +1,39 @@
+// 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 any plugin's vendor/assets/javascripts directory 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/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery/dist/jquery.min
+//= require bootstrap/dist/js/bootstrap.min
+//= require moment/min/moment-with-locales.min
+//= require moment-timezone/builds/moment-timezone-with-data.min
+//= require eonasdan-bootstrap-datetimepicker/build/js/bootstrap-datetimepicker.min
+//= require jquery-validation/dist/jquery.validate.min
+//= require jquery-validation/dist/additional-methods.min
+//= require select2-dist/dist/js/select2.full
+//= require jquery-tablesorter
+//= require moment
+//= require_self
+//= require nuntius/reports
+
+var DATE_FORMAT = 'DD/MM/YYYY';
+var DATETIME_FORMAT = 'DD/MM/YYYY HH:mm';
+
+(function() {
+
+  $.validator.addMethod('date', function(value, element) {
+    return this.optional( element ) || moment(value, DATE_FORMAT, true).isValid();
+  });
+
+  $.validator.addMethod('datetime', function(value, element) {
+    return this.optional( element ) || moment(value, DATETIME_FORMAT, true).isValid();
+  });
+
+})();

data/app/assets/javascripts/nuntius/columns.js

@@ -0,0 +1,57 @@
+function getSorterForType(type) {
+  switch(type) {
+    case 'datetime':
+    case 'date':
+      return 'date';
+      break;
+    case 'integer':
+    case 'float':
+      return 'digit';
+      break;
+    default:
+      return 'text';
+  }
+}
+
+function addColumnsSorting(table) {
+  var $this = $(table);
+
+  var headers = $this.find('th').map(function(index, element) {
+    var $element = $(element);
+    var sorter;
+
+    if ($element.hasClass('column-header')) {
+      var type = $element.data('type');
+      sorter = getSorterForType(type);
+    } else {
+      sorter = false;
+    }
+
+    return { sorter: sorter };
+  });
+
+  $this.tablesorter({
+    theme: 'bootstrap',
+    widthFixed: true,
+    headerTemplate: '{content} {icon}',
+    widgets: ['uitheme'],
+    headers: headers
+  });
+}
+
+$(function() {
+  $.tablesorter.addParser({
+    id: 'date',
+    is: function(s) {
+      return false;
+    },
+    format: function(datetime) {
+      return moment(datetime).utc().format('x');
+    },
+    type: 'numeric'
+  });
+
+  $('table').each(function() {
+    addColumnsSorting(this);
+  });
+});

data/app/assets/javascripts/nuntius/filters/select.js

@@ -0,0 +1,88 @@
+function depedencyValue(depedency) {
+  return $('select.nuntius-filter#q_' + depedency).val();
+}
+
+function handleSelectChange(filter, clear) {
+  var filterId = $(filter).attr('id').replace('q_', '');
+
+  $('select.nuntius-filter').each(function() {
+    var $this = $(this);
+    var dependentFilters = $this.data('dependent') || [];
+
+    if (!Array.isArray(dependentFilters)) {
+      dependentFilters = [dependentFilters];
+    }
+
+    if (dependentFilters.includes(filterId)) {
+      if (clear) {
+        clearDependentSelect($this);
+      } else {
+        updateDependentSelect($this, dependentFilters);
+      }
+    }
+  });
+}
+
+function clearDependentSelect($filter) {
+  $filter.html('').select2({data: null});
+  $filter.prop('disabled', true);
+  handleSelectChange($filter, true);
+}
+
+function updateDependentSelect($filter, dependencies) {
+  var values = dependencies.map(depedencyValue);
+  var options = $filter.data('options')[values.join('_!_')];
+  var  currentValue = $filter.data('currentValue');
+
+  if (typeof options == 'undefined') {
+    $filter.html('').select2({data: null});
+    $filter.prop('disabled', true);
+    return;
+  }
+
+  $filter.prop('disabled', false);
+
+  options = options.map(function(option) {
+    if (typeof option == 'object' && option.length == 2 && typeof option[1] != 'undefined') {
+      return { id: option[1] || '', text: option[0] }
+    } else {
+      return { id: option, text: option }
+    }
+  });
+
+  var selectOptions = { data: options };
+  var includeBlank = $filter.data('includeBlank');
+
+  if (includeBlank != null && typeof includeBlank != 'undefined') {
+    options.unshift({ id: '', text: '' });
+
+    selectOptions.allowClear = true;
+    selectOptions.placeholder = $filter.data('includeBlank')
+  }
+
+  $filter.html('').select2(selectOptions);
+  handleSelectChange($filter, false);
+
+  if (currentValue != null && typeof currentValue != 'undefined') {
+    $filter.val(currentValue).trigger('change');
+  }
+}
+
+$(function() {
+  $('select.nuntius-filter').each(function() {
+    var $this = $(this);
+
+    var selectOptions = {};
+    var includeBlank = $this.data('includeBlank');
+    if (includeBlank != null && includeBlank != 'undefined') {
+      selectOptions.allowClear = true;
+      selectOptions.placeholder = $this.data('includeBlank')
+    }
+
+    $(this).select2(selectOptions)
+           .on('select2:select', function() { handleSelectChange(this, false) })
+           .on('select2:unselect', function() { handleSelectChange(this, true) });
+    handleSelectChange(this, false);
+  })
+
+});

data/app/assets/javascripts/nuntius/filters.js

@@ -0,0 +1,44 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+(function(){
+
+  $(document).on('ready page:load', function(){
+
+    // Initialize all DatePickers
+    $("[type='date']").each(function (index, el) {
+      var $el = $(el);
+      var filterName = $el.attr('name');
+
+      if(FILTERS[filterName]['options']['icon']) {
+        $el = $el.parent();
+      }
+      $el.datetimepicker({ format: DATE_FORMAT });
+
+      setDateTimePickerDate($el, FILTER_PARAMS[filterName], DATE_FORMAT);
+    });
+
+    // Initialize all DateTimePickers
+    $("[type='datetime']").each(function (index, el) {
+      var $el = $(el);
+      var filterName = $el.attr('name');
+
+      if(FILTERS[filterName]['options']['icon']) {
+        $el = $el.parent();
+      }
+      $el.datetimepicker({ format: DATETIME_FORMAT, sideBySide: true });
+
+      setDateTimePickerDate($el, FILTER_PARAMS[filterName], DATETIME_FORMAT);
+    });
+
+  });
+
+  var setDateTimePickerDate = function(el, val, format) {
+    if(val) {
+      var $el = $(el);
+      var date = moment(val, format);
+
+      $el.data('DateTimePicker').defaultDate(date);
+    }
+  };
+
+})();

data/app/assets/javascripts/nuntius/forms.js

@@ -0,0 +1,38 @@
+(function(){
+
+  var FORM_SELECTOR = '#filter-form';
+
+  function submitWithFormat(form, event, format) {
+    event.preventDefault();
+    event.stopPropagation();
+
+    form.find('input[name=format]').val(format);
+    form.submit();
+  }
+
+  $(document).on('ready page:load', function(){
+    var $form = $(FORM_SELECTOR);
+    $form.validate({
+      errorClass: 'has-error has-feedback',
+      validClass: 'has-success has-feedback',
+      errorPlacement: function(error, element) {
+        $error = $(error);
+        $element = $(element);
+        $(error).addClass('control-label');
+        $element.closest('.form-group').append(error);
+      },
+      rules: VALIDATIONS['rules'],
+      messages: VALIDATIONS['messages']
+    });
+
+    $form.on('click', 'input[name=commit]', function(e) {
+      submitWithFormat($form, e, 'html');
+    });
+
+    $form.on('click', '.download', function(e) {
+      submitWithFormat($form, e, 'csv');
+    });
+
+  });
+
+})();

data/app/assets/javascripts/nuntius/nested.js

@@ -0,0 +1,25 @@
+$(function() {
+  $('table').on('click', 'tr[data-nested]', function() {
+    var $this = $(this);
+    var nested = $this.data('nested');
+
+    if ($this.next('tr.nested-container').length) {
+      $this.siblings('tr.nested-container').remove();
+      return;
+    }
+
+    var td = $('<td>').attr('colspan', $this.find('td').length);
+    var tr = $('<tr>').append(td).addClass('nested-container');
+
+    $this.siblings('tr.nested-container').remove();
+
+    $this.after(tr);
+
+    var data = nested.filters;
+    data.row = nested.row;
+    $.get(nested.url, data, function(table) {
+      td.append(table);
+      addColumnsSorting(td.find('table'));
+    });
+  });
+});

data/app/assets/javascripts/nuntius/reports.js

@@ -0,0 +1,7 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+//= require nuntius/filters
+//= require nuntius/forms
+//= require nuntius/columns
+//= require nuntius/nested
+//= require_tree ./filters

data/app/assets/stylesheets/nuntius/application.css

@@ -0,0 +1,36 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require bootstrap/dist/css/bootstrap.min
+ *= require eonasdan-bootstrap-datetimepicker/build/css/bootstrap-datetimepicker.min
+ *= require select2-dist/dist/css/select2
+ *= require jquery-tablesorter/theme.bootstrap
+ *= require_self
+ *= require nuntius/reports
+ *= require nuntius/nested
+ */
+
+.navbar {
+  border-bottom: none;
+}
+
+.has-error.form-control {
+  border-color: red;
+}
+
+.has-error.form-control:focus {
+  border-color: red;
+}
+
+.has-error.control-label {
+  color: red;
+}

data/app/assets/stylesheets/nuntius/nested.css

@@ -0,0 +1,8 @@
+tr[data-nested] {
+    cursor: pointer
+}
+
+table.nested {
+    border: 3px solid red !important;
+    margin-bottom: 0;
+}

data/app/assets/stylesheets/nuntius/reports.css

@@ -0,0 +1,17 @@
+.form-inline .form-group {
+  padding: 5px;
+  position: relative;
+  vertical-align: bottom;
+}
+
+.form-inline label {
+  display: block;
+}
+
+.select-filter-wrapper {
+  width: 14em;
+}
+
+select.nuntius-filter {
+  width: 100%;
+}

data/app/controllers/concerns/nuntius/filter_params.rb

@@ -0,0 +1,23 @@
+module Nuntius
+
+  module FilterParams
+
+    SCOPE_KEY = :q
+
+    def self.included(base)
+      base.helper_method :filter_params
+    end
+
+    def filter_params
+      var_name = "@#{SCOPE_KEY}"
+
+      if instance_variable_defined?(var_name)
+        instance_variable_get(var_name)
+      else
+        instance_variable_set(var_name, params.fetch(SCOPE_KEY, {}))
+      end
+    end
+
+  end
+
+end

data/app/controllers/nuntius/application_controller.rb

@@ -0,0 +1,17 @@
+module Nuntius
+
+  class ApplicationController < ActionController::Base
+
+    include FilterParams
+
+    helper_method :reports
+
+    protect_from_forgery with: :exception
+
+    def reports
+      @reports ||= Report.all
+    end
+
+  end
+
+end

data/app/controllers/nuntius/reports_controller.rb

@@ -0,0 +1,45 @@
+require_dependency 'nuntius/application_controller'
+
+module Nuntius
+
+  class ReportsController < ApplicationController
+
+    before_action :set_report, only: [:show, :nested]
+    before_action :set_nested_report, only: [:nested]
+
+    def index
+      reports
+    end
+
+    def show
+      respond_to do |format|
+        format.html
+        format.csv { render text: @report.to(:csv) }
+      end
+    end
+
+    def nested
+      respond_to do |format|
+        format.html { render layout: false }
+      end
+    end
+
+    protected
+
+    def set_report
+      @report ||= report_class.new(filter_params)
+    rescue NameError
+      redirect_to reports_path, alert: 'Report not found'
+    end
+
+    def set_nested_report
+      @nested_report ||= @report.build_nested_report(params[:row])
+    end
+
+    def report_class
+      params.require(:name).constantize
+    end
+
+  end
+
+end

data/app/helpers/concerns/nuntius/filter_wrappers.rb

@@ -0,0 +1,86 @@
+module Nuntius
+
+  module FilterWrappers
+
+    DEFAULT_CHECK_BOX_VALUE = '1'
+    DEFAULT_RADIO_BUTTON_VALUE = false
+
+    def self.included(base)
+      base.extend self
+    end
+
+    def check_box_filter_tag(name, value: DEFAULT_CHECK_BOX_VALUE, checked: false, options: {})
+      check_box_tag(name, value, checked, options)
+    end
+
+    def color_filter_tag(name, value: nil, options: {})
+      color_field_tag(name, value, options)
+    end
+
+    def date_filter_tag(name, value: nil, options: {})
+      date_field_tag(name, value, options)
+    end
+
+    def datetime_filter_tag(name, value: nil, options: {})
+      datetime_field_tag(name, value, options)
+    end
+
+    def email_filter_tag(name, value: nil, options: {})
+      datetime_field_tag(name, value, options)
+    end
+
+    def month_filter_tag(name, value: nil, options: {})
+      month_field_tag(name, value, options)
+    end
+
+    def number_filter_tag(name, value: nil, options: {})
+      number_field_tag(name, value, options)
+    end
+
+    def phone_filter_tag(name, value: nil, options: {})
+      phone_field_tag(name, value, options)
+    end
+
+    def radio_button_filter_tag(name, value: DEFAULT_RADIO_BUTTON_VALUE, checked: false, options: {})
+      radio_button_tag(name, value, checked, options)
+    end
+
+    def range_filter_tag(name, value: nil, options: {})
+      range_field_tag(name, value, options)
+    end
+
+    def search_filter_tag(name, value: nil, options: {})
+      search_field_tag(name, value, options)
+    end
+
+    def select_filter_tag(name, option_tags: nil, options: {})
+      select_tag(name, option_tags, options)
+    end
+
+    def telephone_filter_tag(name, value: nil, options: {})
+      text_field_tag(name, value, options)
+    end
+
+    def text_area_filter_tag(name, content: nil, options: {})
+      text_area_tag(name, content, options)
+    end
+
+    def text_filter_tag(name, value: nil, options: {})
+      text_field_tag(name, value, options)
+    end
+
+    def time_filter_tag(name, value: nil, options: {})
+      time_field_tag(name, value, options)
+    end
+
+    def url_filter_tag(name, value: nil, options: {})
+      url_field_tag(name, value, options)
+    end
+
+    def week_filter_tag(name, value: nil, options: {})
+      week_field_tag(name, value, options)
+    end
+
+  end
+
+end

data/app/helpers/nuntius/alerts_helper.rb

@@ -0,0 +1,48 @@
+module Nuntius
+
+  module AlertsHelper
+
+    ALERT_TYPES = [:success, :info, :warning, :danger] unless const_defined?(:ALERT_TYPES)
+
+    def flash_alert(options = {})
+      flash_messages = []
+      flash.each do |type, message|
+        # Skip empty messages, e.g. for devise messages set to nothing in a locale file.
+        next if message.blank?
+
+        type = transform_type(type)
+
+        next unless ALERT_TYPES.include?(type)
+
+        tag_options = options_for_type(options, type)
+
+        close_button = content_tag(:button,           raw('×'),
+                                   type:              'button',
+                                   class:             'close',
+                                   'data-dismiss' =>  'alert')
+
+        Array(message).each do |msg|
+          text = content_tag(:div, close_button + msg, tag_options)
+          flash_messages << text if msg
+        end
+      end
+      flash_messages.join("\n").html_safe
+    end
+
+    def transform_type(type)
+      case type
+      when :notice then :success
+      when :alert, :error then :danger
+      else type
+      end
+    end
+
+    def options_for_type(options, type)
+      tag_class = options.extract!(:class)[:class]
+
+      { class: "alert fade in alert-#{type} #{tag_class}" }.merge(options)
+    end
+
+  end
+
+end

data/app/helpers/nuntius/application_helper.rb

@@ -0,0 +1,19 @@
+module Nuntius
+
+  module ApplicationHelper
+
+    SCOPE_KEY = Nuntius::FilterParams::SCOPE_KEY
+
+    def scope_name(name)
+      "#{SCOPE_KEY}[#{name}]"
+    end
+
+    def scope_keys(params)
+      Hash[*params.flat_map do |k, v|
+        [scope_name(k), v]
+      end]
+    end
+
+  end
+
+end

data/app/helpers/nuntius/cells_helper.rb

@@ -0,0 +1,24 @@
+module Nuntius
+
+  module CellsHelper
+
+    def cell_tag(value)
+      content_tag(:td, format_value(value))
+    end
+
+    def format_value(value)
+      case value
+      when Date, DateTime, Time
+        l(value, format: :long)
+      else
+        value
+      end
+    end
+
+    def cell_for_row_column(report, row, column)
+      column.value(report, row)
+    end
+
+  end
+
+end