reports_kit 0.2.0 → 0.3.0

data/docs/display_options.md

@@ -11,10 +11,9 @@ You can use any `type` value supported by Chart.js, including `bar`, `line`, `ho
 Here's an example of a horizontal bar chart:
 
 ```yaml
-measure:
-  key: flight
-  dimensions:
-  - carrier
+measure: flight
+dimensions:
+- carrier
 chart:
   type: horizontalBar
   options:
@@ -37,11 +36,10 @@ You can use any `options` that are supported by Chart.js.
 Here's an example of a chart with Chart.js options:
 
 ```yaml
-measure:
-  key: flight
-  dimensions:
-  - origin_market
-  - carrier
+measure: flight
+dimensions:
+- origin_market
+- carrier
 chart:
   type: horizontalBar
   options:
@@ -66,12 +64,11 @@ You can use any `datasets` options that are supported by Chart.js.
 Here's an example of a chart with `datasets` options:
 
 ```yaml
-measure:
-  key: flight
-  dimensions:
-  - flight_at
-  - key: carrier
-    limit: 3
+measure: flight
+dimensions:
+- flight_at
+- key: carrier
+  limit: 3
 chart:
   type: line
   datasets:

data/docs/filters.md

@@ -7,13 +7,12 @@ A filter is like a SQL `WHERE`: it filters the results to only include results t
 For example, if the `Flight` model has a `delay` column that's an integer, the chart below will show only flights that have a delay of greater than 15 minutes:
 
 ```yaml
-measure:
-  key: flight
-  filters:
-  - key: delay
-    criteria:
-      operator: '>'
-      value: 15
+measure: flight
+filters:
+- key: delay
+  criteria:
+    operator: '>'
+    value: 15
 dimensions:
 - carrier
 ```
@@ -22,13 +21,12 @@ dimensions:
 You can also create form controls that the user can use to filter the chart:
 
 ```yaml
-measure:
-  key: flight
-  filters:
-  - carrier
-  - carrier_name
-  - is_on_time
-  - flight_at
+measure: flight
+filters:
+- carrier
+- carrier_name
+- is_on_time
+- flight_at
 dimensions:
 - flight_at
 - carrier
@@ -55,12 +53,11 @@ In `app/views/my_view.html.haml`, you can use ReportsKit's form helpers to creat
 Boolean filters can be used on any `boolean` columns, or you can define your own boolean filter (see [Custom Filters](#custom-filters)).
 
 ```yaml
-measure:
-  key: flight
-  filters:
-  - key: is_on_time
-    criteria:
-      value: true
+measure: flight
+filters:
+- key: is_on_time
+  criteria:
+    value: true
 dimensions:
 - carrier
 ```
@@ -71,30 +68,30 @@ dimensions:
 Datetime filters can be used on any `datetime` or `timestamp` columns, or you can define your own datetime filter (see [Custom Filters](#custom-filters)).
 
 ```yaml
-measure:
-  key: flight
-  filters:
-  - key: flight_at
-    criteria:
-      operator: between
-      value: Oct 1, 2016 - Jan 1, 2017
+measure: flight
+filters:
+- key: flight_at
+  criteria:
+    operator: between
+    value: -3M - now
 dimensions:
 - carrier
 ```
 [<img src="images/flights_with_configured_datetime.png?raw=true" width="500" />](images/flights_with_configured_datetime.png?raw=true)
 
+The `value` in the example above is shorthand for relative time; it represents the time range of `(3.months.ago..Time.zone.now)`. To see the other supported time durations (e.g. `w` for week, `d` for day), see [RelativeTime](https://github.com/tombenner/reports_kit/blob/master/lib/reports_kit/relative_time.rb).
+
 ##### Number
 
 Number filters can be used on any `integer`, `float`, or `decimal` columns, or you can define your own number filter (see [Custom Filters](#custom-filters)).
 
 ```yaml
-measure:
-  key: flight
-  filters:
-  - key: delay
-    criteria:
-      operator: '>'
-      value: 15
+measure: flight
+filters:
+- key: delay
+  criteria:
+    operator: '>'
+    value: 15
 dimensions:
 - carrier
 ```
@@ -105,13 +102,12 @@ dimensions:
 String filters can be used on any `string` or `text` columns, or you can define your own number filter (see [Custom Filters](#custom-filters)).
 
 ```yaml
-measure:
-  key: flight
-  filters:
-  - key: carrier_name
-    criteria:
-      operator: contains
-      value: airlines
+measure: flight
+filters:
+- key: carrier_name
+  criteria:
+    operator: contains
+    value: airlines
 dimensions:
 - carrier
 ```
@@ -134,12 +130,11 @@ end
 We can then use the `was_delayed` filter:
 
 ```yaml
-measure:
-  key: flight
-  filters:
-  - key: was_delayed
-    criteria:
-      value: true
+measure: flight
+filters:
+- key: was_delayed
+  criteria:
+    value: true
 dimensions:
 - carrier
 ```
@@ -154,10 +149,9 @@ Most charting libraries don't provide interactive form controls, but ReportsKit
 Check boxes can be used with filters that have a `boolean` type.
 
 ```yaml
-measure:
-  key: flight
-  filters:
-  - is_on_time
+measure: flight
+filters:
+- is_on_time
 dimensions:
 - flight_at
 - carrier
@@ -176,10 +170,9 @@ dimensions:
 Date ranges can be used with filters that have a `datetime` type.
 
 ```yaml
-measure:
-  key: flight
-  filters:
-  - flight_at
+measure: flight
+filters:
+- flight_at
 dimensions:
 - flight_at
 - carrier
@@ -193,10 +186,9 @@ dimensions:
 ##### Multi-Autocomplete
 
 ```yaml
-measure:
-  key: flight
-  filters:
-  - carrier
+measure: flight
+filters:
+- carrier
 dimensions:
 - flight_at
 - carrier
@@ -210,10 +202,9 @@ dimensions:
 ##### String Filter
 
 ```yaml
-measure:
-  key: flight
-  filters:
-  - carrier_name
+measure: flight
+filters:
+- carrier_name
 dimensions:
 - flight_at
 - carrier

data/docs/measures.md

@@ -5,9 +5,8 @@ The measure is what is being counted (or aggregated in another way). You can use
 For example, say we have a `Flight` model with a `flight_at` datetime column. We can chart the number of flights over time:
 
 ```yaml
-measure:
-  key: flight
-  dimensions:
-  - flight_at
+measure: flight
+dimensions:
+- flight_at
 ```
 [<img src="images/flights_by_flight_at.png?raw=true" width="500" />](images/flights_by_flight_at.png?raw=true)

data/lib/reports_kit.rb

@@ -4,6 +4,7 @@ require 'reports_kit/base_controller'
 require 'reports_kit/cache'
 require 'reports_kit/configuration'
 require 'reports_kit/engine'
+require 'reports_kit/entity'
 require 'reports_kit/helper'
 require 'reports_kit/model'
 require 'reports_kit/model_configuration'
@@ -12,24 +13,25 @@ require 'reports_kit/relative_time'
 require 'reports_kit/report_builder'
 require 'reports_kit/resources_controller'
 require 'reports_kit/reports_controller'
+require 'reports_kit/value'
 require 'reports_kit/version'
 
 require 'reports_kit/reports/adapters/mysql'
 require 'reports_kit/reports/adapters/postgresql'
 
+require 'reports_kit/reports/data/add_table_aggregations'
+require 'reports_kit/reports/data/aggregate_composite'
+require 'reports_kit/reports/data/aggregate_one_dimension'
+require 'reports_kit/reports/data/aggregate_two_dimensions'
 require 'reports_kit/reports/data/chart_options'
-require 'reports_kit/reports/data/composite_aggregation'
-require 'reports_kit/reports/data/entity'
 require 'reports_kit/reports/data/format_one_dimension'
+require 'reports_kit/reports/data/format_table'
 require 'reports_kit/reports/data/format_two_dimensions'
 require 'reports_kit/reports/data/generate'
 require 'reports_kit/reports/data/generate_for_properties'
-require 'reports_kit/reports/data/one_dimension'
 require 'reports_kit/reports/data/populate_one_dimension'
 require 'reports_kit/reports/data/populate_two_dimensions'
-require 'reports_kit/reports/data/two_dimensions'
 require 'reports_kit/reports/data/utils'
-require 'reports_kit/reports/data/value'
 
 require 'reports_kit/reports/filter_types/base'
 require 'reports_kit/reports/filter_types/boolean'
@@ -38,15 +40,15 @@ require 'reports_kit/reports/filter_types/number'
 require 'reports_kit/reports/filter_types/records'
 require 'reports_kit/reports/filter_types/string'
 
-require 'reports_kit/reports/abstract_measure'
-require 'reports_kit/reports/composite_measure'
+require 'reports_kit/reports/abstract_series'
+require 'reports_kit/reports/composite_series'
 require 'reports_kit/reports/dimension'
-require 'reports_kit/reports/dimension_with_measure'
+require 'reports_kit/reports/dimension_with_series'
 require 'reports_kit/reports/filter'
-require 'reports_kit/reports/filter_with_measure'
+require 'reports_kit/reports/filter_with_series'
 require 'reports_kit/reports/generate_autocomplete_results'
 require 'reports_kit/reports/inferrable_configuration'
-require 'reports_kit/reports/measure'
+require 'reports_kit/reports/series'
 
 module ReportsKit
   def self.configure

data/lib/reports_kit/base_controller.rb

@@ -1,7 +1,6 @@
 module ReportsKit
   class BaseController < ActionController::Base
-    private
-
+    # This is intentionally public to allow external code to access it
     def context_record
       context_record_method = ReportsKit.configuration.context_record_method
       return unless context_record_method

data/lib/reports_kit/configuration.rb

@@ -1,22 +1,37 @@
 module ReportsKit
   class Configuration
-    attr_accessor :cache_duration, :cache_store,
-      :context_params_method, :context_record_method, :custom_methods, :first_day_of_week
+    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
+
+    DEFAULT_PROPERTIES_METHOD = lambda do |env|
+      path = Rails.root.join('config', 'reports_kit', 'reports', "#{report_key}.yml")
+      YAML.load_file(path)
+    end
 
     def initialize
       self.cache_duration = 5.minutes
       self.cache_store = nil
-      self.context_params_method = nil
       self.context_record_method = nil
       self.custom_methods = {}
+      self.default_dimension_limit = 30
+      self.default_properties = nil
       self.first_day_of_week = :sunday
+      self.properties_method = DEFAULT_PROPERTIES_METHOD
+      self.report_filename_method = nil
+      self.use_concurrent_queries = false
     end
 
     def custom_method(method_name)
       return if method_name.blank?
-      method = custom_methods[method_name.to_sym]
+      method = evaluated_custom_methods[method_name.to_sym]
       raise ArgumentError.new("A method named '#{method_name}' is not defined") unless method
       method
     end
+
+    def evaluated_custom_methods
+      return custom_methods if custom_methods.is_a?(Hash)
+      return custom_methods.call if custom_methods.is_a?(Proc)
+      raise ArgumentError.new("Invalid type for custom_methods configuration: #{custom_methods.class}")
+    end
   end
 end

data/lib/reports_kit/entity.rb

@@ -0,0 +1,3 @@
+module ReportsKit
+  Entity = Struct.new(:key, :label, :instance)
+end

data/lib/reports_kit/helper.rb

@@ -5,15 +5,16 @@ module ReportsKit
       'export_xls' => :export_xls_element
     }
 
-    def render_report(properties, &block)
-      raise ArgumentError.new('`properties` must be a Hash or String') if properties.blank?
-      if properties.is_a?(String)
-        path = Rails.root.join('config', 'reports_kit', 'reports', "#{properties}.yml")
-        properties = YAML.load_file(path)
-      end
+    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))
-      content_tag :div, nil, class: 'reports_kit_report form-inline', data: { properties: builder.properties, path: path } do
+      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
@@ -21,7 +22,7 @@ module ReportsKit
           end
         end
         elements << content_tag(:div, nil, class: 'reports_kit_visualization')
-        action_elements = action_elements_for_properties(properties)
+        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) }
@@ -33,25 +34,20 @@ module ReportsKit
 
     private
 
-    def additional_params
-      @additional_params ||= begin
-        context_params_method = ReportsKit.configuration.context_params_method
-        return {} unless context_params_method
-        context_params = instance_eval(&context_params_method)
-        { context_params: context_params }
-      end
+    def report_key
+      params[:report_params][:key]
     end
 
-    def action_elements_for_properties(properties)
-      return if properties['actions'].blank?
-      properties['actions'].map do |action|
+    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)
+        send(element_method, additional_params)
       end
     end
 
-    def export_csv_element
+    def export_csv_element(additional_params)
       data = {
         role: 'reports_kit_export_button',
         path: reports_kit.reports_kit_reports_path({ format: 'csv' }.merge(additional_params))
@@ -59,7 +55,7 @@ module ReportsKit
       link_to('Download CSV', '#', class: 'btn btn-primary', data: data)
     end
 
-    def export_xls_element
+    def export_xls_element(additional_params)
       data = {
         role: 'reports_kit_export_button',
         path: reports_kit.reports_kit_reports_path({ format: 'xls' }.merge(additional_params))

data/lib/reports_kit/model_configuration.rb

@@ -9,7 +9,7 @@ module ReportsKit
       self.autocomplete_scopes = []
     end
 
-    def aggregation(key, expression, properties={})
+    def aggregation(key, expression, properties = {})
       aggregations << { key: key.to_s, expression: expression }.merge(properties).symbolize_keys
     end