reports_kit 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50df5df0e40d9cd127c03bacec3905c401be05ab
-  data.tar.gz: 071d750fe875bcdaa4308fde9e6bf280b18c5d3e
+  metadata.gz: e12a4b95211ec84a8662237e268dfacfcd23978a
+  data.tar.gz: c5ec6f7f3f4e8bd9613764e8cd74108971255c26
 SHA512:
-  metadata.gz: a6fbfb97c8e5f30a23d1260c73046e5f1e19941b0cdaad796ae490c8ebcbf73eeacc3eb3cfc1cd974f80e58b7c31e56d7366e3311e6af9146da055a64c410f25
-  data.tar.gz: 57c6cdba6764b876efbe81d85f98285c5945b85f0571d8fa715806f2210b94b317698b06a957171ef78ea15fc23d2c21e904eb6f2f250e9036270f5217d26fd7
+  metadata.gz: 94b293476548bdd6ad1bed10018e4889f4d28a56b59490059274777fcd608790399a2f835b6f858d9f4075fd96c9accfe382d6fa4e9474079a827008fb157b0f
+  data.tar.gz: fd582ab216f799db4dbf3c0c197b95f5ebe155b55fa9bcc17bfbb15adcdf79dc22f85d999109187d02d8678b045fcc57846d8aa0748d8c1830d8e7e030662e3c

data/README.md

@@ -2,117 +2,20 @@ 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 charts with customizable, interactive filters.
+ReportsKit lets you easily create beautiful, interactive charts and tables.
 
-For interactive examples, see [reportskit.co](https://www.reportskit.co/).
-
----
+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)
 
-[<img src="docs/images/demo_area.png?raw=true" width="425" />](docs/images/demo_area.png?raw=true)
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-[<img src="docs/images/demo_dashed_line.png?raw=true" width="425" />](docs/images/demo_dashed_line.png?raw=true)
-
-[<img src="docs/images/demo_horizontal_stacked.png?raw=true" width="425" />](docs/images/demo_horizontal_stacked.png?raw=true)
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-[<img src="docs/images/demo_legend.png?raw=true" width="425" />](docs/images/demo_legend.png?raw=true)
-
-[<img src="docs/images/demo_multiautocomplete.png?raw=true" width="425" />](docs/images/demo_multiautocomplete.png?raw=true)
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-[<img src="docs/images/demo_radar.png?raw=true" width="230" />](docs/images/demo_radar.png?raw=true)
-
----
-
-1. **Quick setup** - Install ReportsKit and create your first chart in less than one minute using just ~5 lines of code.
-1. **Simple chart configuration** - Create charts using your existing Rails models. ReportsKit examines the column types and associations to understand how to render the chart.
-1. **Powerful results** - To see what ReportsKit can create with minimal code, see [reportskit.co](https://www.reportskit.co/).
-
 Resources
 ---------
 
-* [Installation](#installation)
-* [Quick Start](#quick-start)
-* [Examples](https://www.reportskit.co/)
-* [Documentation](docs)
-
-Installation
-------------
-
-In `Gemfile`:
-```ruby
-gem 'reports_kit'
-```
-
-In `app/assets/stylesheets/application.css.scss`:
-```scss
-*= require reports_kit/application
-```
-
-In `app/assets/javascripts/application.js`:
-```js
-//= require reports_kit/application
-```
-
-In `config/routes.rb`:
-```ruby
-Rails.application.routes.draw do
-  mount ReportsKit::Engine, at: '/'
-  # ...
-end
-```
-
-Quick Start
------------
-
-After installation, you can create your first chart with just a YAML file and a single line in any view.
-
-Configure the chart in the YAML file:
-
-`config/reports_kit/reports/my_users.yml`
-```yaml
-measure: user
-dimensions:
-- created_at
-```
-
-Then pass that filename to `render_report` in a view:
-
-`app/views/users/index.html.haml`
-```haml
-= render_report 'my_users'
-```
-
-You're done! `render_report` will render the following chart:
-
-[<img src="docs/images/users_by_created_at.png?raw=true" width="500" />](docs/images/users_by_created_at.png?raw=true)
-
-### Form Controls
-
-You can add a date range form control to the above chart with a single line, using one of ReportsKit's form helpers:
-
-`app/views/users/index.html.haml`
-```haml
-= render_report 'my_users' do |f|
-  = f.date_range :created_at
-```
-
-[<img src="docs/images/users_by_created_at_with_filter.png?raw=true" width="500" />](docs/images/users_by_created_at_with_filter.png?raw=true)
-
-Many other form controls are available; see [Filters](docs/filters.md) for more.
-
-### How It Works
-
-In the Quick Start chart, `measure: user` tells ReportsKit to count the number of `User` records, and `dimensions: ['created_at']` tells it to group by the week of the `created_at` column. Since `created_at` is a `datetime` column, ReportsKit knows that it should group the counts by week (the granularity is configurable), sort them chronologically, and add in zeros for any missing weeks.
-
-ReportsKit infers sane defaults from your ActiveRecord model configurations. If there was a `belongs_to :company` association on `User` and you used `dimensions: ['company']`, then ReportsKit would count users grouped by the `company_id` column and show company names on the x-axis.
-
-If you need more customization (e.g. custom filters, custom dimensions, custom aggregation functions, custom orders, aggregations of aggregations, etc), ReportsKit is very flexible and powerful and supports all of these with a simple syntax. It lets you use SQL, too.
-
-To learn how to use more of ReportsKit's features, check out the following resources:
-
-* [Examples](https://www.reportskit.co/)
-* [Documentation](docs)
+* [Documentation](https://www.reportskit.co/)
+* [Getting Started](https://www.reportskit.co/categories/getting_started)
+* [Data Examples](https://www.reportskit.co/categories/data)
+* [Visualization Examples](https://www.reportskit.co/categories/visualization)
+* [How It Works](https://www.reportskit.co/categories/getting_started/subcategories/how_it_works)
 
 Testing
 -------

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

@@ -37,15 +37,22 @@ ReportsKit.Table = (function(options) {
       }
       self.table.show().fadeTo(300, 1);
 
-      var rowAggregationsCount = self.rowAggregationsCount(reportOptions);
-      var rowAggregationsStartIndex = rowAggregationsCount ? (tableData.length - rowAggregationsCount) : null;
+      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 < tableData.length; i++) {
-        if (i == 0) {
+      for(var i = 0; i < rowsCount; i++) {
+        if (i === headRowStartIndex) {
           html += '<thead><tr>';
-        } else if (i == 1) {
+        } else if (i === (headRowEndIndex + 1)) {
           html += '<tbody><tr>';
-        } else if (rowAggregationsCount && i == rowAggregationsStartIndex) {
+        } else if (i === footRowStartIndex) {
           html += '<tfoot><tr>';
         } else {
           html += '<tr>';
@@ -59,12 +66,12 @@ ReportsKit.Table = (function(options) {
           }
         }
 
-        if (i == 0) {
+        if (i === headRowEndIndex) {
           html += '</tr></thead>';
-        } else if (i == tableData.length && rowAggregationsCount) {
-          html += '</tfoot></tbody>';
-        } else if (i == tableData.length) {
+        } else if (i === (footRowStartIndex - 1)) {
           html += '</tr></tbody>';
+        } else if (i === footRowEndIndex) {
+          html += '</tfoot></tbody>';
         } else {
           html += '</tr>';
         }
@@ -74,19 +81,6 @@ ReportsKit.Table = (function(options) {
     });
   };
 
-  self.rowAggregationsCount = function(reportOptions) {
-    if (!reportOptions.aggregations) {
-      return 0;
-    };
-    var rowAggregationsCount = 0;
-    for(var i = 0; i < reportOptions.aggregations.length; i++) {
-      if (reportOptions.aggregations[i].from === 'columns') {
-        rowAggregationsCount += 1;
-      }
-    }
-    return rowAggregationsCount;
-  };
-
   self.initialize(options);
 
   return self;

data/app/assets/stylesheets/reports_kit/reports.css.sass

@@ -28,3 +28,6 @@
         content: "\25BC"
       .headerSortDown::after
         content: "\25B2"
+.reports_kit_actions
+  margin-top: 12px
+  text-align: right

data/gemfiles/mysql.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    reports_kit (0.2.0)
+    reports_kit (0.3.1)
       rails (>= 3)
       spreadsheet (>= 1.1)
 

data/gemfiles/postgresql.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    reports_kit (0.2.0)
+    reports_kit (0.3.1)
       rails (>= 3)
       spreadsheet (>= 1.1)
 

data/lib/reports_kit.rb

@@ -5,12 +5,13 @@ require 'reports_kit/cache'
 require 'reports_kit/configuration'
 require 'reports_kit/engine'
 require 'reports_kit/entity'
+require 'reports_kit/report_builder'
+require 'reports_kit/form_builder'
 require 'reports_kit/helper'
 require 'reports_kit/model'
 require 'reports_kit/model_configuration'
 require 'reports_kit/order'
 require 'reports_kit/relative_time'
-require 'reports_kit/report_builder'
 require 'reports_kit/resources_controller'
 require 'reports_kit/reports_controller'
 require 'reports_kit/value'

data/lib/reports_kit/configuration.rb

@@ -1,7 +1,8 @@
 module ReportsKit
   class Configuration
-    attr_accessor :cache_duration, :cache_store, :context_record_method, :custom_methods, :default_dimension_limit,
-      :default_properties, :first_day_of_week, :properties_method, :report_filename_method, :use_concurrent_queries
+    attr_accessor :autocomplete_results_method, :cache_duration, :cache_store, :context_record_method, :custom_methods,
+      :default_dimension_limit, :default_properties, :first_day_of_week, :properties_method, :report_filename_method,
+      :use_concurrent_queries
 
     DEFAULT_PROPERTIES_METHOD = lambda do |env|
       path = Rails.root.join('config', 'reports_kit', 'reports', "#{report_key}.yml")
@@ -9,6 +10,7 @@ module ReportsKit
     end
 
     def initialize
+      self.autocomplete_results_method = nil
       self.cache_duration = 5.minutes
       self.cache_store = nil
       self.context_record_method = nil

data/lib/reports_kit/form_builder.rb

@@ -0,0 +1,95 @@
+module ReportsKit
+  class FormBuilder
+    include ActionView::Helpers
+
+    DEFAULT_DATE_RANGE_VALUE = ['-2M', 'now']
+
+    attr_accessor :properties, :additional_params
+
+    def initialize(properties, additional_params: nil)
+      self.properties = properties.deep_symbolize_keys
+      self.additional_params = additional_params
+    end
+
+    def check_box(filter_key, options = {})
+      filter = validate_filter!(filter_key)
+      checked = filter.normalized_properties[:criteria][:value] == 'true'
+      check_box_tag(filter_key, '1', checked, options)
+    end
+
+    def date_range(filter_key, options = {})
+      filter = validate_filter!(filter_key)
+      defaults = { class: 'form-control input-sm date_range_picker' }
+      options = defaults.deep_merge(options)
+      value = filter.normalized_properties[:criteria][:value].presence
+      value ||= default_date_range_value
+      text_field_tag(filter_key, value, options)
+    end
+
+    def multi_autocomplete(filter_key, options = {})
+      validate_filter!(filter_key)
+      filter = series_filters.find { |f| f.key == filter_key.to_s }
+      reports_kit_path = Rails.application.routes.url_helpers.reports_kit_path
+      path = "#{reports_kit_path}reports_kit/resources/measures/#{filter.series.key}/filters/#{filter_key}/autocomplete?"
+      path += additional_params.to_query if additional_params.present?
+      scope = options.delete(:scope)
+      params = {}
+      params[:scope] = scope if scope.present?
+
+      defaults = {
+        class: 'form-control input-sm select2',
+        multiple: 'multiple',
+        data: {
+          placeholder: options[:placeholder],
+          path: path,
+          params: params
+        }
+      }
+      options = defaults.deep_merge(options)
+      select_tag(filter_key, nil, options)
+    end
+
+    def string_filter(filter_key, options = {})
+      filter = validate_filter!(filter_key)
+      defaults = { class: 'form-control input-sm' }
+      options = defaults.deep_merge(options)
+      text_field_tag(filter_key, filter.normalized_properties[:criteria][:value], options)
+    end
+
+    private
+
+    def validate_filter!(filter_key)
+      filter_key = filter_key.to_s
+      filter = filters.find { |f| f.key == filter_key }
+      raise ArgumentError.new("A filter with key '#{filter_key}' is not configured in this report") unless filter
+      filter
+    end
+
+    def filters
+      ui_filters + series_filters
+    end
+
+    def series_filters
+      serieses.map(&:filters).flatten
+    end
+
+    def ui_filters
+      return [] if properties[:ui_filters].blank?
+      properties[:ui_filters].map do |ui_filter_properties|
+        Reports::Filter.new(ui_filter_properties)
+      end
+    end
+
+    def serieses
+      Reports::Series.new_from_properties!(properties, context_record: nil)
+    end
+
+    def default_date_range_value
+      @default_date_range_value ||= begin
+        start_date = Reports::Data::Utils.format_time_value(DEFAULT_DATE_RANGE_VALUE[0])
+        end_date = Reports::Data::Utils.format_time_value(DEFAULT_DATE_RANGE_VALUE[1])
+        [start_date, Reports::FilterTypes::Datetime::SEPARATOR, end_date].join(' ')
+      end
+    end
+  end
+end

data/lib/reports_kit/helper.rb

@@ -1,66 +1,34 @@
 module ReportsKit
   module Helper
-    ACTION_KEYS_METHODS = {
-      'export_csv' => :export_csv_element,
-      'export_xls' => :export_xls_element
-    }
-
     def render_report(report_params, context_params: {}, actions: %w(export_csv export_xls), js_report_class: 'Report', &block)
       report_params = { key: report_params } if report_params.is_a?(String)
-      additional_params = { context_params: context_params, report_params: report_params }
-      params.merge!(additional_params)
-      properties = instance_eval(&ReportsKit.configuration.properties_method)
-      properties = properties.deep_symbolize_keys
-      builder = ReportsKit::ReportBuilder.new(properties, additional_params: additional_params)
-      path = reports_kit.reports_kit_reports_path({ format: 'json' }.merge(additional_params))
-      data = { properties: properties.slice(:format), path: path, report_class: js_report_class }
-      content_tag :div, nil, class: 'reports_kit_report form-inline', data: data do
-        elements = []
-        if block_given?
-          elements << form_tag(path, method: 'get', class: 'reports_kit_report_form') do
-            capture(builder, &block)
-          end
-        end
-        elements << content_tag(:div, nil, class: 'reports_kit_visualization')
-        action_elements = generate_action_elements(actions, additional_params)
-        if action_elements
-          elements << content_tag(:div, nil, class: 'reports_kit_actions') do
-            action_elements.map { |element| concat(element) }
-          end
-        end
-        elements.join.html_safe
+      params.merge!(context_params: context_params, report_params: report_params)
+      properties = instance_eval(&ReportsKit.configuration.properties_method).deep_symbolize_keys
+      builder = ReportBuilder.new(
+        report_params: report_params,
+        context_params: context_params,
+        actions: actions,
+        js_report_class: js_report_class,
+        properties: properties,
+        view_context: self,
+        block: block
+      )
+      capture do
+        capture(builder, &block) if block
+        builder.render
       end
     end
 
-    private
-
-    def report_key
-      params[:report_params][:key]
+    def context_params
+      params[:context_params]
     end
 
-    def generate_action_elements(actions, additional_params)
-      return if actions.blank?
-      actions.map do |action|
-        element_method = ACTION_KEYS_METHODS[action]
-        raise ArgumentError.new("Invalid action: #{action}") unless element_method
-        send(element_method, additional_params)
-      end
+    def report_params
+      params[:report_params]
     end
 
-    def export_csv_element(additional_params)
-      data = {
-        role: 'reports_kit_export_button',
-        path: reports_kit.reports_kit_reports_path({ format: 'csv' }.merge(additional_params))
-      }
-      link_to('Download CSV', '#', class: 'btn btn-primary', data: data)
-    end
-
-    def export_xls_element(additional_params)
-      data = {
-        role: 'reports_kit_export_button',
-        path: reports_kit.reports_kit_reports_path({ format: 'xls' }.merge(additional_params))
-      }
-      link_to('Download Excel', '#', class: 'btn btn-primary', data: data)
+    def report_key
+      report_params[:key]
     end
   end
 end

data/lib/reports_kit/report_builder.rb

@@ -2,93 +2,85 @@ module ReportsKit
   class ReportBuilder
     include ActionView::Helpers
 
-    DEFAULT_DATE_RANGE_VALUE = ['-2M', 'now']
+    attr_accessor :report_params, :context_params, :additional_params, :actions, :js_report_class, :properties, :view_context, :block, :form_builder
 
-    attr_accessor :properties, :additional_params
+    ACTION_KEYS_METHODS = {
+      'export_csv' => :export_csv_button,
+      'export_xls' => :export_xls_button
+    }
 
-    def initialize(properties, additional_params: nil)
-      self.properties = properties.deep_symbolize_keys
-      self.additional_params = additional_params
+    def initialize(report_params:, context_params: {}, actions: %w(export_csv export_xls), js_report_class: 'Report', properties:, view_context:, block: nil)
+      self.report_params = report_params.is_a?(String) ? { key: report_params } : report_params
+      self.context_params = context_params
+      self.additional_params = { context_params: context_params, report_params: self.report_params }
+      self.actions = actions
+      self.js_report_class = js_report_class
+      self.view_context = view_context
+      self.block = block
+      self.properties = properties#view_context.instance_eval(&ReportsKit.configuration.properties_method).deep_symbolize_keys
+      self.form_builder = ReportsKit::FormBuilder.new(properties, additional_params: additional_params)
     end
 
-    def check_box(filter_key, options = {})
-      filter = validate_filter!(filter_key)
-      checked = filter.normalized_properties[:criteria][:value] == 'true'
-      check_box_tag(filter_key, '1', checked, options)
+    def render
+      data = { properties: properties.slice(:format), path: reports_data_path, report_class: js_report_class }
+      view_context.content_tag :div, nil, class: 'reports_kit_report form-inline', data: data do
+        elements = []
+        elements << view_context.capture(self, &block) if block
+        elements << view_context.content_tag(:div, nil, class: 'reports_kit_visualization')
+        elements << action_elements_container
+        elements.compact.join.html_safe
+      end
     end
 
-    def date_range(filter_key, options = {})
-      filter = validate_filter!(filter_key)
-      defaults = { class: 'form-control input-sm date_range_picker' }
-      options = defaults.deep_merge(options)
-      value = filter.normalized_properties[:criteria][:value].presence
-      value ||= default_date_range_value
-      text_field_tag(filter_key, value, options)
+    def form(&block)
+      raise ArgumentError.new('No block given for ReportBuilder#form') unless block
+      view_context.form_tag(reports_data_path, method: 'get', class: 'reports_kit_report_form') do
+        view_context.capture(form_builder, &block)
+      end
     end
 
-    def multi_autocomplete(filter_key, options = {})
-      validate_filter!(filter_key)
-      filter = series_filters.find { |f| f.key == filter_key.to_s }
-      reports_kit_path = Rails.application.routes.url_helpers.reports_kit_path
-      path = "#{reports_kit_path}reports_kit/resources/measures/#{filter.series.key}/filters/#{filter_key}/autocomplete?"
-      path += additional_params.to_query if additional_params.present?
-      scope = options.delete(:scope)
-      params = {}
-      params[:scope] = scope if scope.present?
-
-      defaults = {
-        class: 'form-control input-sm select2',
-        multiple: 'multiple',
-        data: {
-          placeholder: options[:placeholder],
-          path: path,
-          params: params
-        }
-      }
-      options = defaults.deep_merge(options)
-      select_tag(filter_key, nil, options)
+    def export_csv_button(text='Download CSV', options = {}, &block)
+      export_button(text, 'csv', options, &block)
     end
 
-    def string_filter(filter_key, options = {})
-      filter = validate_filter!(filter_key)
-      defaults = { class: 'form-control input-sm' }
-      options = defaults.deep_merge(options)
-      text_field_tag(filter_key, filter.normalized_properties[:criteria][:value], options)
+    def export_xls_button(text='Download Excel', options = {}, &block)
+      export_button(text, 'xls', options, &block)
     end
 
-    private
-
-    def validate_filter!(filter_key)
-      filter_key = filter_key.to_s
-      filter = filters.find { |f| f.key == filter_key }
-      raise ArgumentError.new("A filter with key '#{filter_key}' is not configured in this report") unless filter
-      filter
+    def export_button(text, format, options, &block)
+      data = {
+        role: 'reports_kit_export_button',
+        path: view_context.reports_kit.reports_kit_reports_path({ format: format }.merge(additional_params))
+      }
+      options = { class: 'btn btn-primary', data: data }.merge(options)
+      if block_given?
+        view_context.link_to('#', options, &block)
+      else
+        view_context.link_to(text, '#', options)
+      end
     end
 
-    def filters
-      ui_filters + series_filters
-    end
+    private
 
-    def series_filters
-      serieses.map(&:filters).flatten
+    def reports_data_path
+      @reports_data_path ||= view_context.reports_kit.reports_kit_reports_path({ format: 'json' }.merge(additional_params))
     end
 
-    def ui_filters
-      return [] if properties[:ui_filters].blank?
-      properties[:ui_filters].map do |ui_filter_properties|
-        Reports::Filter.new(ui_filter_properties)
+    def action_elements_container
+      return if action_elements.blank?
+      view_context.content_tag(:div, nil, class: 'reports_kit_actions') do
+        action_elements.map { |element| view_context.concat(element) }
       end
     end
 
-    def serieses
-      Reports::Series.new_from_properties!(properties, context_record: nil)
-    end
-
-    def default_date_range_value
-      @default_date_range_value ||= begin
-        start_date = Reports::Data::Utils.format_time_value(DEFAULT_DATE_RANGE_VALUE[0])
-        end_date = Reports::Data::Utils.format_time_value(DEFAULT_DATE_RANGE_VALUE[1])
-        [start_date, Reports::FilterTypes::Datetime::SEPARATOR, end_date].join(' ')
+    def action_elements
+      @action_elements ||= begin
+        return if actions.blank?
+        actions.map do |action|
+          element_method = ACTION_KEYS_METHODS[action]
+          raise ArgumentError.new("Invalid action: #{action}") unless element_method
+          send(element_method)
+        end.compact
       end
     end
   end

data/lib/reports_kit/reports/data/generate.rb

@@ -91,7 +91,14 @@ module ReportsKit
         end
 
         def report_options
-          properties[:report_options]
+          report_options = properties[:report_options] || {}
+          head_rows_count = report_options[:head_rows_count]
+          foot_rows_count = report_options[:foot_rows_count]
+          foot_rows_count ||= report_options[:aggregations].count { |config| config[:from] == 'rows' } if report_options[:aggregations]
+
+          report_options[:head_rows_count] = head_rows_count if head_rows_count && head_rows_count > 0
+          report_options[:foot_rows_count] = foot_rows_count if foot_rows_count && foot_rows_count > 0
+          report_options.presence
         end
 
         def data_format_method

data/lib/reports_kit/reports/generate_autocomplete_results.rb

@@ -12,6 +12,7 @@ module ReportsKit
 
       def perform
         raise ArgumentError.new("Could not find a model for filter_key: '#{filter_key}'") unless model
+        return autocomplete_results_method.call(params: params, context_record: context_record, relation: relation) if autocomplete_results_method
         results = relation
         results = results.public_send(scope) if scope
         results = results.limit(10_000)
@@ -23,6 +24,10 @@ module ReportsKit
 
       private
 
+      def autocomplete_results_method
+        ReportsKit.configuration.autocomplete_results_method
+      end
+
       def relation
         if context_record
           context_record.public_send(model.name.tableize)

data/lib/reports_kit/reports_controller.rb

@@ -26,6 +26,19 @@ module ReportsKit
       end
     end
 
+    def report_params
+      params[:report_params]
+    end
+
+    def context_params
+      params[:context_params]
+    end
+
+    def report_key
+      raise ArgumentError.new('Blank report_params') if report_params.blank?
+      report_params[:key]
+    end
+
     private
 
     def report_filename
@@ -38,10 +51,6 @@ module ReportsKit
       Reports::Data::Generate.new(properties, context_record: context_record).perform
     end
 
-    def report_key
-      params[:report_params][:key]
-    end
-
     def properties
       @properties ||= begin
         properties_method = ReportsKit.configuration.properties_method

data/lib/reports_kit/version.rb

@@ -1,3 +1,3 @@
 module ReportsKit
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/spec/fixtures/generate_inputs.yml

@@ -130,6 +130,32 @@
     - from: rows
       operator: sum
       label: Total
+- series:
+  - measure:
+      key: issue
+      name: Repo Issues
+    dimensions:
+    - key: repo
+      label:
+  - measure: label
+    dimensions:
+    - repo
+  format: table
+  report_options:
+    head_rows_count: 2
+- series:
+  - measure:
+      key: issue
+      name: Repo Issues
+    dimensions:
+    - key: repo
+      label:
+  - measure: label
+    dimensions:
+    - repo
+  format: table
+  report_options:
+    foot_rows_count: 3
 - series:
     measure: label
     dimensions:

data/spec/fixtures/generate_outputs.yml

@@ -425,6 +425,7 @@
     - :from: rows
       :operator: sum
       :label: Total
+    :foot_rows_count: 1
   :table_data:
   - - 
     - Repo Issues
@@ -447,6 +448,7 @@
     - :from: rows
       :operator: sum
       :label: Total
+    :foot_rows_count: 1
   :table_data:
   - - 
     - Repo Issues
@@ -464,6 +466,32 @@
     - 2
     - 3
     - 5
+- :type: table
+  :report_options:
+    :head_rows_count: 2
+  :table_data:
+  - - 
+    - Repo Issues
+    - Labels
+  - - foo/bar1
+    - 2
+    - 1
+  - - foo/bar2
+    - 0
+    - 2
+- :type: table
+  :report_options:
+    :foot_rows_count: 3
+  :table_data:
+  - - 
+    - Repo Issues
+    - Labels
+  - - foo/bar1
+    - 2
+    - 1
+  - - foo/bar2
+    - 0
+    - 2
 - :chart_data:
     :labels:
     - foo/bar1

data/spec/reports_kit/{report_builder_spec.rb → form_builder_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe ReportsKit::ReportBuilder do
+describe ReportsKit::FormBuilder do
   subject { described_class.new(properties) }
 
   context 'with a datetime dimension' do

data/spec/reports_kit/reports/data/generate_spec.rb

@@ -876,7 +876,7 @@ describe ReportsKit::Reports::Data::Generate do
     end
   end
 
-  describe 'composite aggregations' do
+  describe 'composite series' do
     context 'with two series' do
       let(:properties) do
         {
@@ -1114,7 +1114,7 @@ describe ReportsKit::Reports::Data::Generate do
         end
       end
 
-      context 'with a nested composite aggregation' do
+      context 'with a nested composite series' do
         let(:properties) do
           {
             series: [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reports_kit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Tom Benner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-19 00:00:00.000000000 Z
+date: 2017-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -226,6 +226,7 @@ files:
 - lib/reports_kit/configuration.rb
 - lib/reports_kit/engine.rb
 - lib/reports_kit/entity.rb
+- lib/reports_kit/form_builder.rb
 - lib/reports_kit/helper.rb
 - lib/reports_kit/model.rb
 - lib/reports_kit/model_configuration.rb
@@ -274,8 +275,8 @@ files:
 - spec/factories/tag_factory.rb
 - spec/fixtures/generate_inputs.yml
 - spec/fixtures/generate_outputs.yml
+- spec/reports_kit/form_builder_spec.rb
 - spec/reports_kit/relative_time_spec.rb
-- spec/reports_kit/report_builder_spec.rb
 - spec/reports_kit/reports/data/generate_spec.rb
 - spec/reports_kit/reports/dimension_with_series_spec.rb
 - spec/reports_kit/reports/filter_with_series_spec.rb