reports_kit 0.3.1 → 0.3.2

data/docs/filters.md

@@ -1,216 +0,0 @@
-### 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: 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: 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: flight
-filters:
-- key: is_on_time
-  criteria:
-    value: 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: 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: 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: 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: flight
-filters:
-- key: was_delayed
-  criteria:
-    value: 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: 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: 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: 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: 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

@@ -1,12 +0,0 @@
-### 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/resources_controller.rb

@@ -1,8 +0,0 @@
-module ReportsKit
-  class ResourcesController < ReportsKit::BaseController
-    def autocomplete
-      results = Reports::GenerateAutocompleteResults.new(params, context_record: context_record).perform
-      render json: { data: results }
-    end
-  end
-end