reports_kit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3abddaccea88828c06d6e0ff3131c56fba4dc20
+  data.tar.gz: 990fa98bba536c8334020fde32d5c202dea92f9b
+SHA512:
+  metadata.gz: c92b9aca0da9517597d63a21f461e7f29229a29b33f6598f24858e08401c11431846904de22bc305b246f095b5ed5e27fe51ba86b676e3db35844e7bffa6bac8
+  data.tar.gz: fe4f821935c7301266574d7ee973882a9cf3c7162e67f3c400b774b4867a8c7e82e0269ea6af11d102a2d79c1d9d110ea7bd6cca9ebfa1b927ab2ef905e0f1ad

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+Gemfile.lock
+*.gem
+log/*.log
+.bundle/
+pkg/

data/.rubocop.yml

@@ -0,0 +1,83 @@
+# inherits from https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+AllCops:
+  Exclude:
+    - spec/support/schema.rb
+    - bin/**/*
+    - tmp/**/*
+    - vendor/**/*
+    - .bundle/**/*
+  Rails:
+    Enabled: true
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 40
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 12
+Metrics/LineLength:
+  Enabled: true
+  Max: 140
+Metrics/PerceivedComplexity:
+  Enabled: true
+  Max: 12
+Metrics/ClassLength:
+  Enabled: true
+  CountComments: false
+  Max: 200
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 200
+  Enabled: true
+Metrics/MethodLength:
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: true
+  CountComments: false
+  Max: 50
+Metrics/ParameterLists:
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: true
+  Max: 5
+  CountKeywordArgs: true
+
+Lint/AssignmentInCondition:
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: true
+  AllowSafeAssignment: true
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Enabled: true
+Style/AlignHash:
+  EnforcedColonStyle: key
+  EnforcedHashRocketStyle: key
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Style/Alias:
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  EnforcedStyle: prefer_alias_method
+Style/BracesAroundHashParameters:
+  Exclude:
+    - spec/**/*
+Style/CaseIndentation:
+  EnforcedStyle: case
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: false
+Style/RaiseArgs:
+  Enabled: false
+Style/SignalException:
+  Enabled: false
+Style/SpecialGlobalVars:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Tom Benner
+
+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/README.md

@@ -0,0 +1,468 @@
+ReportsKit
+=====
+Beautiful, interactive charts for Ruby on Rails
+
+Table of Contents
+-----------------
+
+* [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/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.
+
+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
+```
+
+Usage
+-----
+### Your First Chart
+
+In any view, render 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']
+```
+
+[<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`:
+
+`config/reports_kit/reports/my_users.yml`
+```yaml
+measure: user
+dimensions:
+- created_at
+```
+
+`app/views/users/index.html.haml`
+```haml
+= 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
+
+```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
+
+##### Check Box
+
+```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
+```
+```haml
+= render_report 'filter_string' do
+  = f.string_filter :carrier_name, placeholder: 'Carrier name (e.g. Airlines)...', style: 'width: 175px;'
+```
+[<img src="docs/images/flights_with_string_filter.png?raw=true" width="500" />](docs/images/flights_with_string_filter.png?raw=true)
+
+### 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="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)
+
+
+License
+-------
+
+ReportsKit is released under the MIT License. Please see the MIT-LICENSE file for details.