reports_kit 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45c91b55162a7b482e7c8e0cef402f9dcc0b80ec
-  data.tar.gz: 27d1bb568a27ce2407db170680a8f5e0c60e1d70
+  metadata.gz: 3952d8e13131065be390fe346c8182be221ec6bf
+  data.tar.gz: 411ce357e9e03b3a233cf8f3ce822f05006e7786
 SHA512:
-  metadata.gz: 7b1b0fc9746dd296e728d0ba444f1bd6894f455e9b0345c0a54f61d8913c47c6bebb2a4543d609fa2013ddcd3a6e2850af5ea5ab041ae2eb5cb19502a15a8c52
-  data.tar.gz: f71b824343340b45ac2a9bfff4cd436a5f2e5f8a9e50690d31829d7b017fb6f4ddeaf0d77a06036b0654e55a0bc467bb37c3d8973b074cf77f87eb4de931eb2a
+  metadata.gz: e28f85804d7d648c18899656ccff8b07e3f10beabd11bba19159b193bbd11942e9e33bde4bd7ec04e69cc60b63e80f469cbf117f46dbac39a92620f1d59ac5bb
+  data.tar.gz: 9cef277587fa45fff0691b38f5a67ff7784401f0092eb00eeb735a02bbdea42dae0e9c68252dfa0b3738290abd38677f3177757aba96ee8be2386c19df5a0fc8

data/README.md

@@ -1,29 +1,40 @@
 ReportsKit
 =====
-Beautiful, interactive charts for Ruby on Rails
+ReportsKit lets you easily create beautiful charts with customizable, interactive filters.
 
-Table of Contents
------------------
+Add powerful reporting to your Rails app in minutes, not months!
 
-* [Overview](#overview)
-* [Installation](#installation)
-* [Usage](#usage)
-  * [Your First Chart](#your-first-chart)
-  * [Measures](#measures)
-  * [Dimensions](#dimensions)
-  * [Filters](#filters)
-  * [Display Options](#display-options)
-* [License](#license)
-
-Overview
---------
-ReportsKit lets you easily create beautiful charts with customizable, interactive filters.
+For interactive examples, see [reportskit.co](https://www.reportskit.co/).
+
+---
+
+[<img src="docs/images/demo.gif?raw=true" width="500" />](docs/images/demo.gif?raw=true)
+
+[<img src="docs/images/demo_area.png?raw=true" width="500" />](docs/images/demo_area.png?raw=true)
+
+[<img src="docs/images/demo_dashed_line.png?raw=true" width="500" />](docs/images/demo_dashed_line.png?raw=true)
+
+[<img src="docs/images/demo_horizontal_stacked.png?raw=true" width="500" />](docs/images/demo_horizontal_stacked.png?raw=true)
+
+[<img src="docs/images/demo_legend.png?raw=true" width="500" />](docs/images/demo_legend.png?raw=true)
+
+[<img src="docs/images/demo_multiautocomplete.png?raw=true" width="500" />](docs/images/demo_multiautocomplete.png?raw=true)
 
-For interactive examples, see [reportskit.co](https://www.reportskit.co).
+[<img src="docs/images/demo_radar.png?raw=true" width="250" />](docs/images/demo_radar.png?raw=true)
 
-[<img src="docs/images/flights_with_filters.png?raw=true" width="500" />](docs/images/flights_with_filters.png?raw=true)
+---
 
-ReportsKit integrates with ActiveRecord, abstracting away complex aggregation logic to make it easy to create powerful charts and filters.
+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](documentation)
 
 Installation
 ------------
@@ -51,20 +62,23 @@ Rails.application.routes.draw do
 end
 ```
 
-Usage
------
-### Your First Chart
+Quick Start
+-----------
 
-In any view, render a chart that shows the number of records of a model (e.g. `user`) created over time:
+After installation, you can create your first chart with a single line!
+
+In any view, create a chart that shows the number of records of a model (e.g. `user`) created over time:
 
 `app/views/users/index.html.haml`
 ```haml
 = render_report measure: 'user', dimensions: ['created_at']
 ```
 
+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)
 
-You can also configure your charts using YAML and then pass the filename to `render_report`:
+Instead of passing a hash to `render_report`, you can alternatively configure your charts using YAML and then pass the filename to `render_report`:
 
 `config/reports_kit/reports/my_users.yml`
 ```yaml
@@ -78,389 +92,30 @@ dimensions:
 = render_report 'my_users'
 ```
 
-### Measures
-
-The measure is what is being counted (or aggregated). You can use any model for the measure.
-
-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: flight
-dimensions:
-- flight_at
-```
-[<img src="docs/images/flights_by_flight_at.png?raw=true" width="500" />](docs/images/flights_by_flight_at.png?raw=true)
-
-### Dimensions
-
-#### Overview
-
-The dimension is what the measure is being grouped by. You can use datetime columns, integer columns, string columns, associations, or even define custom dimensions.
-
-For example, the chart below groups by a `carrier` association on `Flight`
-
-```yaml
-measure: flight
-dimensions:
-- carrier
-```
-[<img src="docs/images/flights_by_carrier.png?raw=true" width="500" />](docs/images/flights_by_carrier.png?raw=true)
-
-You can also use two dimensions:
-
-```yaml
-measure: flight
-dimensions:
-- carrier
-- flight_at
-```
-[<img src="docs/images/flights_by_carrier_and_flight_at.png?raw=true" width="500" />](docs/images/flights_by_carrier_and_flight_at.png?raw=true)
-
-Dimensions can be configured using a string:
-
-```yaml
-measure: flight
-dimensions:
-- carrier
-```
-
-Or, if you need to use options, you can configure them using a hash:
-
-```yaml
-measure: flight
-dimensions:
-- key: carrier
-  limit: 5
-```
-#### Types
-
-##### Association
-
-```yaml
-measure: flight
-dimensions:
-- carrier
-```
-[<img src="docs/images/flights_by_carrier.png?raw=true" width="500" />](docs/images/flights_by_carrier.png?raw=true)
-
-##### Datetime Column
-
-```yaml
-measure: flight
-dimensions:
-- flight_at
-```
-[<img src="docs/images/flights_by_flight_at.png?raw=true" width="500" />](docs/images/flights_by_flight_at.png?raw=true)
-
-##### Integer Column
-
-```yaml
-measure: flight
-dimensions:
-- delay
-```
-[<img src="docs/images/flights_by_delay.png?raw=true" width="500" />](docs/images/flights_by_delay.png?raw=true)
-
-##### Custom
-
-You can define custom dimensions in your model. For example, if `Flight` has a column named `delay` (in minutes), we can define a `hours_delayed` dimension:
-
-```ruby
-class Flight < ApplicationRecord
-  include ReportsKit::Model
-
-  reports_kit do
-    dimension :hours_delayed, group: 'GREATEST(ROUND(flights.delay::float/60), 0)'
-  end
-end
-```
-
-We can then use the `hours_delayed` dimension:
-
-```yaml
-measure: flight
-dimensions:
-- hours_delayed
-```
-[<img src="docs/images/flights_by_hours_delayed.png?raw=true" width="500" />](docs/images/flights_by_hours_delayed.png?raw=true)
-
-#### Options
-
-##### `key` *String*
-
-The dimension's identifier. You can use association names (e.g. `author`), column names (e.g. `created_at`), or the keys of custom dimensions (e.g. `my_dimension`).
-
-##### `limit` *Integer*
-
-The maximum number of dimension instances to include.
-
-### Filters
-
-#### Overview
-
-A filter is like a `where`: it filters the results to only include results that match a condition. You can use datetime columns, integer columns, string columns, associations, or even define custom filters.
-
-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
-dimensions:
-- carrier
-```
-[<img src="docs/images/flights_with_configured_number.png?raw=true" width="500" />](docs/images/flights_with_configured_number.png?raw=true)
-
-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
-dimensions:
-- flight_at
-- carrier
-```
-
-In `app/views/my_view.html.haml`:
-```haml
-= render_report 'filters' do
-  .pull-right
-    = f.date_range :flight_at
-  = f.multi_autocomplete :carrier, scope: 'top', placeholder: 'Carrier...'
-  = f.string_filter :carrier_name, placeholder: 'Carrier name (e.g. Airlines)...', style: 'width: 175px;'
-  .checkbox
-    = label_tag :is_on_time do
-      = f.check_box :is_on_time
-      On time
-```
-[<img src="docs/images/flights_with_filters.png?raw=true" width="500" />](docs/images/flights_with_filters.png?raw=true)
-
-#### Types
-
-##### Boolean
-
-```yaml
-measure:
-  key: flight
-  filters:
-  - key: is_on_time
-    criteria:
-      operator: true
-      value: 15
-dimensions:
-- carrier
-```
-[<img src="docs/images/flights_with_configured_boolean.png?raw=true" width="500" />](docs/images/flights_with_configured_boolean.png?raw=true)
-
-##### Datetime
+The YAML approach is more maintainable and readable, so we'll use it in the rest of the documentation.
 
-```yaml
-measure:
-  key: flight
-  filters:
-  - key: flight_at
-    criteria:
-      operator: between
-      value: Oct 1, 2016 - Jan 1, 2017
-dimensions:
-- carrier
-```
-[<img src="docs/images/flights_with_configured_datetime.png?raw=true" width="500" />](docs/images/flights_with_configured_datetime.png?raw=true)
-
-##### Number
-
-```yaml
-measure:
-  key: flight
-  filters:
-  - key: delay
-    criteria:
-      operator: '>'
-      value: 15
-dimensions:
-- carrier
-```
-[<img src="docs/images/flights_with_configured_number.png?raw=true" width="500" />](docs/images/flights_with_configured_number.png?raw=true)
-
-##### String
-
-```yaml
-measure:
-  key: flight
-  filters:
-  - key: carrier_name
-    criteria:
-      operator: contains
-      value: airlines
-dimensions:
-- carrier
-```
-[<img src="docs/images/flights_with_configured_string.png?raw=true" width="500" />](docs/images/flights_with_configured_string.png?raw=true)
-
-
-#### Form Controls
+### Form Controls
 
-##### Check Box
+You can add a date range form control to the above chart with a single line, using one of ReportsKit's form helpers:
 
-```yaml
-measure:
-  key: flight
-  filters:
-  - is_on_time
-dimensions:
-- flight_at
-- carrier
-```
-```haml
-= render_report 'filter_check_box' do
-  .checkbox
-    = label_tag :is_on_time do
-      = f.check_box :is_on_time
-      On time
-```
-[<img src="docs/images/flights_with_check_box.png?raw=true" width="500" />](docs/images/flights_with_check_box.png?raw=true)
-
-##### Date Range
-
-```yaml
-measure:
-  key: flight
-  filters:
-  - flight_at
-dimensions:
-- flight_at
-- carrier
-```
-```haml
-= render_report 'filter_date_range' do
-  = f.date_range :flight_at
-```
-[<img src="docs/images/flights_with_date_range.png?raw=true" width="500" />](docs/images/flights_with_date_range.png?raw=true)
-
-##### Multi-Autocomplete
-
-```yaml
-measure:
-  key: flight
-  filters:
-  - carrier
-dimensions:
-- flight_at
-- carrier
-```
-```haml
-= render_report 'filter_multi_autocomplete' do
-  = f.multi_autocomplete :carrier, scope: 'top', placeholder: 'Carrier...'
-```
-[<img src="docs/images/flights_with_multi_autocomplete.png?raw=true" width="500" />](docs/images/flights_with_multi_autocomplete.png?raw=true)
-
-##### String Filter
-
-```yaml
-measure:
-  key: flight
-  filters:
-  - carrier_name
-dimensions:
-- flight_at
-- carrier
-```
+`app/views/users/index.html.haml`
 ```haml
-= render_report 'filter_string' do
-  = f.string_filter :carrier_name, placeholder: 'Carrier name (e.g. Airlines)...', style: 'width: 175px;'
+= render_report 'my_users' do |f|
+  = f.date_range :created_at
 ```
-[<img src="docs/images/flights_with_string_filter.png?raw=true" width="500" />](docs/images/flights_with_string_filter.png?raw=true)
 
-### Display Options
+[<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)
 
-#### Overview
+Many other form controls are available; see [Filters](docs/filters.md) for more.
 
-Charts are rendered using [Chart.js](http://www.chartjs.org/). You can configure your ReportsKit chart using any [Chart.js options](http://www.chartjs.org/docs/).
+### How It Works
 
-##### `type`
+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 sort the results chronologically.
 
-You can use any `type` value supported by Chart.js, including `bar`, `line`, `horizontalBar`, `radar`, and more.
-
-Here's an example of a horizontal bar chart:
-
-```yaml
-measure: flight
-dimensions:
-- carrier
-chart:
-  type: horizontalBar
-  options:
-    scales:
-      xAxes:
-      - scaleLabel:
-          display: true
-          labelString: Flights
-      yAxes:
-      - scaleLabel:
-          display: true
-          labelString: Carrier
-```
-[<img src="docs/images/horizontal_bar.png?raw=true" width="500" />](docs/images/horizontal_bar.png?raw=true)
-
-##### `options`
-
-You can use any `options` that are supported by Chart.js.
-
-Here's an example of a chart with Chart.js options:
-
-```yaml
-measure: flight
-dimensions:
-- origin_market
-- carrier
-chart:
-  type: horizontalBar
-  options:
-    scales:
-      xAxes:
-      - stacked: true
-        scaleLabel:
-          display: true
-          labelString: Flights
-      yAxes:
-      - stacked: true
-        scaleLabel:
-          display: true
-          labelString: Market
-```
-[<img src="docs/images/chart_options.png?raw=true" width="500" />](docs/images/chart_options.png?raw=true)
-
-##### `datasets`
-
-You can use any `datasets` options that are supported by Chart.js.
-
-Here's an example of a chart with `datasets` options:
-
-```yaml
-measure: flight
-dimensions:
-- flight_at
-- key: carrier
-  limit: 3
-chart:
-  type: line
-  datasets:
-    fill: false
-    borderDash:
-      - 5
-      - 5
-```
-[<img src="docs/images/dashed_line.png?raw=true" width="500" />](docs/images/dashed_line.png?raw=true)
+To learn how to use more of ReportsKit's features, check out the following resources:
 
+* [Examples](https://www.reportskit.co/)
+* [Documentation](documentation)
 
 License
 -------

data/docs/README.md

@@ -0,0 +1,7 @@
+Documentation
+-------------
+
+1. [Measures](docs/measures.md)
+1. [Dimensions](docs/dimensions.md)
+1. [Display Options](docs/display_options.md)
+1. [Filters](docs/filters.md)

data/docs/dimensions.md

@@ -0,0 +1,110 @@
+### Dimensions
+
+#### Overview
+
+The dimension is what the measure is being grouped by. You can use datetime columns, integer columns, string columns, associations, or even define custom dimensions.
+
+For example, say you have a `Flight` model with a `belongs_to :carrier` association:
+
+```ruby
+class Flight < ActiveRecord::Base
+  belongs_to :carrier
+end
+```
+
+You can then use `dimensions: ['carrier']` to count the number of Flights per Carrier:
+
+```yaml
+measure: flight
+dimensions:
+- carrier
+```
+[<img src="images/flights_by_carrier.png?raw=true" width="500" />](images/flights_by_carrier.png?raw=true)
+
+You can also use two dimensions:
+
+```yaml
+measure: flight
+dimensions:
+- carrier
+- flight_at
+```
+[<img src="images/flights_by_carrier_and_flight_at.png?raw=true" width="500" />](images/flights_by_carrier_and_flight_at.png?raw=true)
+
+Dimensions can be configured using a string (`carrier`):
+
+```yaml
+measure: flight
+dimensions:
+- carrier
+```
+
+Or, if you need to use options, you can configure them using a hash:
+
+```yaml
+measure: flight
+dimensions:
+- key: carrier
+  limit: 5
+```
+#### Types
+
+##### Association
+
+```yaml
+measure: flight
+dimensions:
+- carrier
+```
+[<img src="images/flights_by_carrier.png?raw=true" width="500" />](images/flights_by_carrier.png?raw=true)
+
+##### Datetime Column
+
+```yaml
+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)
+
+##### Integer Column
+
+```yaml
+measure: flight
+dimensions:
+- delay
+```
+[<img src="images/flights_by_delay.png?raw=true" width="500" />](images/flights_by_delay.png?raw=true)
+
+##### Custom Dimensions
+
+You can define custom dimensions in your model. For example, if `Flight` has a column named `delay` (in minutes), we can define a `hours_delayed` dimension:
+
+```ruby
+class Flight < ApplicationRecord
+  include ReportsKit::Model
+
+  reports_kit do
+    dimension :hours_delayed, group: 'GREATEST(ROUND(flights.delay::float/60), 0)'
+  end
+end
+```
+
+We can then use the `hours_delayed` dimension:
+
+```yaml
+measure: flight
+dimensions:
+- hours_delayed
+```
+[<img src="images/flights_by_hours_delayed.png?raw=true" width="500" />](images/flights_by_hours_delayed.png?raw=true)
+
+#### Options
+
+##### `key` *String*
+
+The dimension's identifier. You can use association names (e.g. `author`), column names (e.g. `created_at`), or the keys of custom dimensions (e.g. `my_dimension`).
+
+##### `limit` *Integer*
+
+The maximum number of dimension instances to include. For example, if you set `limit: 5` and have one dimension, then the x-axis will only show 5 items.

data/docs/display_options.md

@@ -0,0 +1,80 @@
+### Display Options
+
+#### Overview
+
+Charts are rendered using [Chart.js](http://www.chartjs.org/). You can configure your ReportsKit chart using any [Chart.js options](http://www.chartjs.org/docs/).
+
+##### `type`
+
+You can use any `type` value supported by Chart.js, including `bar`, `line`, `horizontalBar`, `radar`, and more.
+
+Here's an example of a horizontal bar chart:
+
+```yaml
+measure: flight
+dimensions:
+- carrier
+chart:
+  type: horizontalBar
+  options:
+    scales:
+      xAxes:
+      - scaleLabel:
+          display: true
+          labelString: Flights
+      yAxes:
+      - scaleLabel:
+          display: true
+          labelString: Carrier
+```
+[<img src="images/horizontal_bar.png?raw=true" width="500" />](images/horizontal_bar.png?raw=true)
+
+##### `options`
+
+You can use any `options` that are supported by Chart.js.
+
+Here's an example of a chart with Chart.js options:
+
+```yaml
+measure: flight
+dimensions:
+- origin_market
+- carrier
+chart:
+  type: horizontalBar
+  options:
+    scales:
+      xAxes:
+      - stacked: true
+        scaleLabel:
+          display: true
+          labelString: Flights
+      yAxes:
+      - stacked: true
+        scaleLabel:
+          display: true
+          labelString: Market
+```
+[<img src="images/chart_options.png?raw=true" width="500" />](images/chart_options.png?raw=true)
+
+##### `datasets`
+
+You can use any `datasets` options that are supported by Chart.js.
+
+Here's an example of a chart with `datasets` options:
+
+```yaml
+measure: flight
+dimensions:
+- flight_at
+- key: carrier
+  limit: 3
+chart:
+  type: line
+  datasets:
+    fill: false
+    borderDash:
+      - 5
+      - 5
+```
+[<img src="images/dashed_line.png?raw=true" width="500" />](images/dashed_line.png?raw=true)

data/docs/filters.md

@@ -0,0 +1,225 @@
+### Filters
+
+#### Overview
+
+A filter is like a SQL `WHERE`: it filters the results to only include results that match a condition. You can use datetime columns, integer columns, string columns, associations, or even define custom filters.
+
+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
+dimensions:
+- carrier
+```
+[<img src="images/flights_with_configured_number.png?raw=true" width="500" />](images/flights_with_configured_number.png?raw=true)
+
+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
+dimensions:
+- flight_at
+- carrier
+```
+
+In `app/views/my_view.html.haml`, you can use ReportsKit's form helpers to create the controls:
+```haml
+= render_report 'filters' do |f|
+  .pull-right
+    = f.date_range :flight_at
+  = f.multi_autocomplete :carrier, scope: 'top', placeholder: 'Carrier...'
+  = f.string_filter :carrier_name, placeholder: 'Carrier name (e.g. Airlines)...', style: 'width: 175px;'
+  .checkbox
+    = label_tag :is_on_time do
+      = f.check_box :is_on_time
+      On time
+```
+[<img src="images/flights_with_filters.png?raw=true" width="500" />](images/flights_with_filters.png?raw=true)
+
+#### Types
+
+##### Boolean
+
+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:
+      operator: true
+dimensions:
+- carrier
+```
+[<img src="images/flights_with_configured_boolean.png?raw=true" width="500" />](images/flights_with_configured_boolean.png?raw=true)
+
+##### Datetime
+
+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
+dimensions:
+- carrier
+```
+[<img src="images/flights_with_configured_datetime.png?raw=true" width="500" />](images/flights_with_configured_datetime.png?raw=true)
+
+##### 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
+dimensions:
+- carrier
+```
+[<img src="images/flights_with_configured_number.png?raw=true" width="500" />](images/flights_with_configured_number.png?raw=true)
+
+##### String
+
+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
+dimensions:
+- carrier
+```
+[<img src="images/flights_with_configured_string.png?raw=true" width="500" />](images/flights_with_configured_string.png?raw=true)
+
+##### Custom Filters
+
+You can define custom filters in your model. For example, if `Flight` has a column named `delay` (an integer with a unit of minutes), then we can define a `was_delayed` dimension:
+
+```ruby
+class Flight < ApplicationRecord
+  include ReportsKit::Model
+
+  reports_kit do
+    filter :was_delayed, :boolean, conditions: 'delay IS NOT NULL AND delay > 15'
+  end
+end
+```
+
+We can then use the `was_delayed` filter:
+
+```yaml
+measure:
+  key: flight
+  filters:
+  - key: was_delayed
+    criteria:
+      operator: true
+dimensions:
+- carrier
+```
+[<img src="images/flights_by_hours_delayed.png?raw=true" width="500" />](images/flights_by_hours_delayed.png?raw=true)
+
+#### Form Controls
+
+Most charting libraries don't provide interactive form controls, but ReportsKit does. It makes it easy to add form controls to allow end users to modify charts.
+
+##### Check Box
+
+Check boxes can be used with filters that have a `boolean` type.
+
+```yaml
+measure:
+  key: flight
+  filters:
+  - is_on_time
+dimensions:
+- flight_at
+- carrier
+```
+```haml
+= render_report 'filter_check_box' do |f|
+  .checkbox
+    = label_tag :is_on_time do
+      = f.check_box :is_on_time
+      On time
+```
+[<img src="images/flights_with_check_box.png?raw=true" width="500" />](images/flights_with_check_box.png?raw=true)
+
+##### Date Range
+
+Date ranges can be used with filters that have a `datetime` type.
+
+```yaml
+measure:
+  key: flight
+  filters:
+  - flight_at
+dimensions:
+- flight_at
+- carrier
+```
+```haml
+= render_report 'filter_date_range' do |f|
+  = f.date_range :flight_at
+```
+[<img src="images/flights_with_date_range.png?raw=true" width="500" />](images/flights_with_date_range.png?raw=true)
+
+##### Multi-Autocomplete
+
+```yaml
+measure:
+  key: flight
+  filters:
+  - carrier
+dimensions:
+- flight_at
+- carrier
+```
+```haml
+= render_report 'filter_multi_autocomplete' do |f|
+  = f.multi_autocomplete :carrier, scope: 'top', placeholder: 'Carrier...'
+```
+[<img src="images/flights_with_multi_autocomplete.png?raw=true" width="500" />](images/flights_with_multi_autocomplete.png?raw=true)
+
+##### String Filter
+
+```yaml
+measure:
+  key: flight
+  filters:
+  - carrier_name
+dimensions:
+- flight_at
+- carrier
+```
+```haml
+= render_report 'filter_string' do |f|
+  = f.string_filter :carrier_name, placeholder: 'Carrier name (e.g. Airlines)...', style: 'width: 175px;'
+```
+[<img src="images/flights_with_string_filter.png?raw=true" width="500" />](images/flights_with_string_filter.png?raw=true)

data/docs/measures.md

@@ -0,0 +1,12 @@
+### Measures
+
+The measure is what is being counted (or aggregated in another way). You can use any model as the measure.
+
+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: 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

@@ -6,7 +6,6 @@ require 'reports_kit/engine'
 require 'reports_kit/helper'
 require 'reports_kit/model'
 require 'reports_kit/model_configuration'
-require 'reports_kit/rails'
 require 'reports_kit/report_builder'
 require 'reports_kit/resources_controller'
 require 'reports_kit/reports_controller'

data/lib/reports_kit/reports/measure.rb

@@ -16,13 +16,17 @@ module ReportsKit
       end
 
       def key
-        properties[:key]
+        properties[:key].underscore
       end
 
       def label
         key.pluralize.titleize
       end
 
+      def relation_name
+        key.tableize
+      end
+
       def aggregate_function
         :count
       end
@@ -32,7 +36,7 @@ module ReportsKit
       end
 
       def base_relation
-        return context_record.public_send(key.pluralize) if context_record
+        return context_record.public_send(relation_name) if context_record
         model_class
       end
 

data/lib/reports_kit/reports_controller.rb

@@ -1,14 +1,8 @@
 module ReportsKit
   class ReportsController < ReportsKit::BaseController
     def index
-      # RubyProf.start
       properties = ActiveSupport::JSON.decode(params[:properties])
       report_data = Reports::Data::Generate.new(properties, context_record: context_record).perform
-      # result = RubyProf.stop
-      # printer = RubyProf::CallStackPrinter.new(result)
-      # File.open(Rails.root.join('tmp', 'out.html'), 'w') do |file|
-      #   printer.print(file, :min_percent => 2)
-      # end
       render json: { data: report_data }
     end
   end

data/lib/reports_kit/version.rb

@@ -1,3 +1,3 @@
 module ReportsKit
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reports_kit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tom Benner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -136,8 +136,19 @@ files:
 - app/assets/stylesheets/reports_kit/vendor/select2-bootstrap.css
 - app/assets/stylesheets/reports_kit/vendor/select2.css
 - config/routes.rb
+- docs/README.md
+- docs/dimensions.md
+- docs/display_options.md
+- docs/filters.md
 - docs/images/chart_options.png
 - docs/images/dashed_line.png
+- docs/images/demo.gif
+- docs/images/demo_area.png
+- docs/images/demo_dashed_line.png
+- docs/images/demo_horizontal_stacked.png
+- docs/images/demo_legend.png
+- docs/images/demo_multiautocomplete.png
+- docs/images/demo_radar.png
 - docs/images/flights_by_carrier.png
 - docs/images/flights_by_carrier_and_flight_at.png
 - docs/images/flights_by_delay.png
@@ -155,7 +166,8 @@ files:
 - docs/images/horizontal_bar.png
 - docs/images/legend_right.png
 - docs/images/users_by_created_at.png
-- gists/doc.txt
+- docs/images/users_by_created_at_with_filter.png
+- docs/measures.md
 - lib/reports_kit.rb
 - lib/reports_kit/base_controller.rb
 - lib/reports_kit/configuration.rb
@@ -163,7 +175,6 @@ files:
 - lib/reports_kit/helper.rb
 - lib/reports_kit/model.rb
 - lib/reports_kit/model_configuration.rb
-- lib/reports_kit/rails.rb
 - lib/reports_kit/report_builder.rb
 - lib/reports_kit/reports/data/chart_options.rb
 - lib/reports_kit/reports/data/generate.rb

data/gists/doc.txt

@@ -1,58 +0,0 @@
-1. Add ReportsKit
-
-Gemfile
-
-source 'https://my-api-key@gems.reportskit.co' do
-  gem 'reportskit'
-end
-
-
-2. Configure Models
-
-Configure the filters and dimensions that can be used in your reports:
-
-app/models/task.rb
-
-class Task < ActiveRecord::Base
-  belongs_to :assignee
-  belongs_to :project
-
-  reportskit do
-    filter :assignee
-    filter :project
-    filter :completed_at
-    filter :is_completed, :boolean, conditions: -> { where.not(completed_at: nil) }
-
-    dimension :assignee
-    dimension :project
-    dimension :completed_at
-  end
-end
-
-
-3. Configure Reports
-
-config/reportskit/reports/completed_tasks.yml
-
-name: Completed tasks
-measures:
-- tasks
-dimensions:
-- completed_at
-display_format: area
-
-
-4. Add Report to a View
-
-app/views/reports/my_view.html.haml
-
-= render_report 'completed_tasks'
-
-
-5. Add Routes:
-
-config/routes.rb
-
-mount ReportsKit::Engine, at: '/reports'
-
-That's it! You can now visit the view in step 4. to see the report that you've configured.

data/lib/reports_kit/rails.rb

@@ -1,5 +0,0 @@
-if Rails.version >= '3.1'
-  require 'reports_kit/engine'
-else
-  ActionView::Base.send :include, Chartkick::Helper
-end