reports_kit 0.3.1 → 0.3.2

data/lib/reports_kit/reports/properties.rb

@@ -0,0 +1,10 @@
+module ReportsKit
+  module Reports
+    class Properties
+      def self.generate(context)
+        properties = context.instance_eval(&ReportsKit.configuration.properties_method)
+        properties.deep_symbolize_keys
+      end
+    end
+  end
+end

data/lib/reports_kit/reports/properties_to_filter.rb

@@ -0,0 +1,40 @@
+module ReportsKit
+  module Reports
+    class PropertiesToFilter
+      attr_accessor :properties, :context_record
+
+      def initialize(properties, context_record: nil)
+        self.properties = properties
+        self.context_record = context_record
+      end
+
+      def perform(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
+
+      private
+
+      def filters
+        @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: context_record)
+      end
+    end
+  end
+end

data/lib/reports_kit/reports/series.rb

@@ -19,9 +19,9 @@ module ReportsKit
         filter_hashes = filter_hashes.values if filter_hashes.is_a?(Hash) && filter_hashes.key?(:'0')
 
         self.properties = properties
+        self.context_record = context_record
         self.dimensions = dimension_hashes.map { |dimension_hash| DimensionWithSeries.new(dimension: Dimension.new(dimension_hash), series: self) }
         self.filters = filter_hashes.map { |filter_hash| FilterWithSeries.new(filter: Filter.new(filter_hash), series: self) }
-        self.context_record = context_record
       end
 
       def key
@@ -78,6 +78,11 @@ module ReportsKit
       end
 
       def model_class
+        if context_record
+          reflection = context_record.class.reflect_on_association(key.to_sym) ||
+            context_record.class.reflect_on_association(key.pluralize.to_sym)
+          return reflection.klass if reflection
+        end
         key.camelize.constantize
       end
 
@@ -100,7 +105,7 @@ module ReportsKit
 
         series_hashes.map do |series_hash|
           if series_hash[:composite_operator].present?
-            CompositeSeries.new(series_hash)
+            CompositeSeries.new(series_hash, context_record: context_record)
           else
             new(series_hash, context_record: context_record)
           end

data/lib/reports_kit/reports_controller.rb

@@ -26,19 +26,6 @@ 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
@@ -53,8 +40,7 @@ module ReportsKit
 
     def properties
       @properties ||= begin
-        properties_method = ReportsKit.configuration.properties_method
-        properties = instance_eval(&properties_method)
+        properties = Reports::Properties.generate(self)
         properties.merge(params_properties).deep_symbolize_keys
       end
     end

data/lib/reports_kit/version.rb

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

data/spec/factories/pro_repo_factory.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :pro_repo, class: Pro::Repo do
+    sequence(:full_name) { |i| "foo/bar#{i}" }
+  end
+end

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

@@ -307,6 +307,33 @@ describe ReportsKit::Reports::Data::Generate do
           datasets: [{ label: 'Issues', data: [2.0] }]
         })
       end
+
+      context 'with a namespaced context_record class' do
+        let(:pro_repo) { create(:pro_repo) }
+        let(:context_record) { pro_repo }
+        let(:properties) do
+          {
+            measure: 'special_issue',
+            dimensions: %w(repo)
+          }
+        end
+
+        let!(:issues) do
+          [
+            create(:issue, repo: pro_repo),
+            create(:issue, repo: pro_repo),
+            create(:issue, repo: pro_repo),
+            create(:issue, repo: repo2)
+          ]
+        end
+
+        it 'returns the chart_data' do
+          expect(chart_data).to eq({
+            labels: [pro_repo.to_s],
+            datasets: [{ label: 'Special Issues', data: [3.0] }]
+          })
+        end
+      end
     end
 
     context 'with a limit' do

data/spec/spec_helper.rb

@@ -7,9 +7,6 @@ require 'timecop'
 require 'support/factory_girl'
 require 'support/helpers'
 
-directory = File.dirname(File.absolute_path(__FILE__))
-Dir.glob("#{directory}/factories/*.rb") { |file| require file }
-
 Time.zone = ActiveSupport::TimeZone.new('UTC')
 ActiveRecord::Base.default_timezone = :utc
 
@@ -32,7 +29,11 @@ else
     username: 'postgres'
   )
 end
+directory = File.dirname(File.absolute_path(__FILE__))
 Dir.glob("#{directory}/support/models/*.rb") { |file| require file }
+Dir.glob("#{directory}/support/models/**/*.rb") { |file| require file }
+Dir.glob("#{directory}/factories/*.rb") { |file| require file }
+
 require 'support/config'
 require 'support/schema'
 

data/spec/support/models/pro/repo.rb

@@ -0,0 +1,5 @@
+module Pro
+  class Repo < ::Repo
+    has_many :special_issues
+  end
+end

data/spec/support/models/pro/special_issue.rb

@@ -0,0 +1,4 @@
+module Pro
+  class SpecialIssue < ::Issue
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reports_kit
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Tom Benner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-02 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -184,38 +184,8 @@ files:
 - app/assets/stylesheets/reports_kit/vendor/select2.css
 - config/initializers/mime_types.rb
 - 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
-- docs/images/flights_by_flight_at.png
-- docs/images/flights_by_hours_delayed.png
-- docs/images/flights_with_check_box.png
-- docs/images/flights_with_configured_boolean.png
-- docs/images/flights_with_configured_datetime.png
-- docs/images/flights_with_configured_number.png
-- docs/images/flights_with_configured_string.png
-- docs/images/flights_with_date_range.png
-- docs/images/flights_with_filters.png
-- docs/images/flights_with_multi_autocomplete.png
-- docs/images/flights_with_string_filter.png
-- docs/images/horizontal_bar.png
-- docs/images/legend_right.png
 - docs/images/users_by_created_at.png
-- docs/images/users_by_created_at_with_filter.png
-- docs/measures.md
 - gemfiles/mysql.gemfile
 - gemfiles/mysql.gemfile.lock
 - gemfiles/postgresql.gemfile
@@ -226,10 +196,12 @@ files:
 - lib/reports_kit/configuration.rb
 - lib/reports_kit/engine.rb
 - lib/reports_kit/entity.rb
+- lib/reports_kit/filters_controller.rb
 - lib/reports_kit/form_builder.rb
 - lib/reports_kit/helper.rb
 - lib/reports_kit/model.rb
 - lib/reports_kit/model_configuration.rb
+- lib/reports_kit/normalized_params.rb
 - lib/reports_kit/order.rb
 - lib/reports_kit/relative_time.rb
 - lib/reports_kit/report_builder.rb
@@ -262,15 +234,17 @@ files:
 - lib/reports_kit/reports/filter_with_series.rb
 - lib/reports_kit/reports/generate_autocomplete_results.rb
 - lib/reports_kit/reports/inferrable_configuration.rb
+- lib/reports_kit/reports/properties.rb
+- lib/reports_kit/reports/properties_to_filter.rb
 - lib/reports_kit/reports/series.rb
 - lib/reports_kit/reports_controller.rb
-- lib/reports_kit/resources_controller.rb
 - lib/reports_kit/value.rb
 - lib/reports_kit/version.rb
 - reports_kit.gemspec
 - spec/factories/issue_factory.rb
 - spec/factories/issues_label_factory.rb
 - spec/factories/label_factory.rb
+- spec/factories/pro_repo_factory.rb
 - spec/factories/repo_factory.rb
 - spec/factories/tag_factory.rb
 - spec/fixtures/generate_inputs.yml
@@ -287,6 +261,8 @@ files:
 - spec/support/models/issue.rb
 - spec/support/models/issues_label.rb
 - spec/support/models/label.rb
+- spec/support/models/pro/repo.rb
+- spec/support/models/pro/special_issue.rb
 - spec/support/models/repo.rb
 - spec/support/models/tag.rb
 - spec/support/schema.rb

data/docs/README.md

@@ -1,8 +0,0 @@
-Documentation
--------------
-
-1. [Measures](measures.md)
-1. [Dimensions](dimensions.md)
-1. [Filters](filters.md)
-1. [Display Options](display_options.md)
-1. [Examples](https://www.reportskit.co/)

data/docs/dimensions.md

@@ -1,110 +0,0 @@
-### 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

@@ -1,80 +0,0 @@
-### 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)