reports_kit 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91c1e89f707ed386d31fbd29b764143a579bd634
-  data.tar.gz: 4afd3e37a4f9d315693e2f8626359ead4ba36870
+  metadata.gz: f73a1370ec5380438c97d70101c44741b71e11d4
+  data.tar.gz: 512485a9a8703592305f62bc0af6f21cc339d4f0
 SHA512:
-  metadata.gz: aecd3b0e784ec878e3cd154f1b16404f3c88b5a4aa910361ffc70c0cbf8c769fb40c90c6adea9069e2a7096d34c95c6f01dfaacff2140cbc8206b6444936298d
-  data.tar.gz: 636e9ba27cef392cb7d22e8ae3ef61606e5e859744490baaad9fe8a5e75767431fb07d8686c5fe989e4072cf9de87d6e82987e94492421cb463ee206e3ee9554
+  metadata.gz: 7f05e2853acc4f162d822351bdeb4e25243557334af27cde8b20edbccc825f95b1458e076a514490b054eb733807d32fa6d310f84e20412f9793d4d56fa47c46
+  data.tar.gz: 58c18993f9d3e24025a4fafe901b2c0345b8fa0019aedc01258873d0a128cc22bf1c92fbd173a7703bf5000c3919d10720f1b4b766c6d0fe5e509b7e9ad31e9b

data/gemfiles/rails_4_mysql.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    reports_kit (0.4.1)
+    reports_kit (0.5.0)
       rails (>= 3)
       spreadsheet (>= 1.1)
 

data/gemfiles/rails_4_postgresql.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    reports_kit (0.4.1)
+    reports_kit (0.5.0)
       rails (>= 3)
       spreadsheet (>= 1.1)
 

data/gemfiles/rails_5_mysql.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    reports_kit (0.4.1)
+    reports_kit (0.5.0)
       rails (>= 3)
       spreadsheet (>= 1.1)
 

data/gemfiles/rails_5_postgresql.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    reports_kit (0.4.1)
+    reports_kit (0.5.0)
       rails (>= 3)
       spreadsheet (>= 1.1)
 

data/lib/reports_kit/reports/contextual_filter.rb

@@ -5,9 +5,9 @@ module ReportsKit
 
       delegate :settings_from_model, to: :model_settings
 
-      def initialize(key, series:)
+      def initialize(key, model_class)
         self.key = key.to_sym
-        self.model_settings = ModelSettings.new(series, :contextual_filters, self.key)
+        self.model_settings = ModelSettings.new(model_class, :contextual_filters, self.key)
       end
 
       def apply(relation, context_params)

data/lib/reports_kit/reports/filter_with_series.rb

@@ -80,6 +80,15 @@ module ReportsKit
         type_class
       end
 
+      def apply_contextual_filters(relation, context_params)
+        return relation if properties[:contextual_filters].blank? || context_params.blank?
+        contextual_filters = properties[:contextual_filters].map { |key| ContextualFilter.new(key, relation.base_class) }
+        contextual_filters.each do |contextual_filter|
+          relation = contextual_filter.apply(relation, context_params)
+        end
+        relation
+      end
+
       def apply(relation)
         filter_type.apply_filter(relation)
       end

data/lib/reports_kit/reports/generate_autocomplete_results.rb

@@ -1,10 +1,11 @@
 module ReportsKit
   module Reports
     class GenerateAutocompleteResults
-      attr_accessor :params, :filter_key, :filter, :context_record
+      attr_accessor :params, :filter_key, :filter, :context_params, :context_record
 
       def initialize(params, properties, context_record: nil)
         self.params = params
+        self.context_params = params[:context_params]
         self.filter_key = params[:key]
         self.filter = Reports::PropertiesToFilter.new(properties, context_record: context_record).perform(filter_key)
         self.context_record = context_record
@@ -13,7 +14,7 @@ module ReportsKit
       def perform
         raise ArgumentError.new("Could not find a model for filter_key: '#{filter_key}'") unless model
         return autocomplete_results_method.call(params: params, context_record: context_record, relation: relation) if autocomplete_results_method
-        results = relation
+        results = filter.apply_contextual_filters(relation, context_params)
         results = results.limit(10_000)
         results = results.map { |result| { id: result.id, text: result.to_s } }
         results = results.sort_by { |result| result[:text].downcase }

data/lib/reports_kit/reports/inferrable_configuration.rb

@@ -17,7 +17,7 @@ module ReportsKit
       def initialize(inferrable, inferrable_type)
         self.inferrable = inferrable
         self.inferrable_type = inferrable_type
-        self.model_settings = ModelSettings.new(series, inferrable_type, key)
+        self.model_settings = ModelSettings.new(series.model_class, inferrable_type, key)
       end
 
       def configuration_strategy

data/lib/reports_kit/reports/model_settings.rb

@@ -1,10 +1,10 @@
 module ReportsKit
   module Reports
     class ModelSettings
-      attr_accessor :series, :model_configuration_type, :key
+      attr_accessor :model_class, :model_configuration_type, :key
 
-      def initialize(series, model_configuration_type, key)
-        self.series = series
+      def initialize(model_class, model_configuration_type, key)
+        self.model_class = model_class
         self.model_configuration_type = model_configuration_type
         self.key = key
       end
@@ -19,11 +19,6 @@ module ReportsKit
         config_hash || {}
       end
 
-      def model_class
-        return unless series
-        series.model_class
-      end
-
       private
 
       def model_configuration

data/lib/reports_kit/reports/series.rb

@@ -23,7 +23,7 @@ module ReportsKit
         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.contextual_filters = contextual_filter_keys.map { |key| ContextualFilter.new(key, series: self) }
+        self.contextual_filters = contextual_filter_keys.map { |key| ContextualFilter.new(key, model_class) }
       end
 
       def key

data/lib/reports_kit/version.rb

@@ -1,3 +1,3 @@
 module ReportsKit
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/spec/reports_kit/reports/generate_autocomplete_results_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe ReportsKit::Reports::GenerateAutocompleteResults do
+  subject { described_class.new(params, properties).perform }
+  let!(:repo) { create(:repo) }
+  let!(:repo2) { create(:repo) }
+  let!(:issues) do
+    [
+      create(:issue, repo: repo, opened_at: now - 2.weeks),
+      create(:issue, repo: repo2, opened_at: now - 2.weeks),
+      create(:issue, repo: repo, opened_at: now)
+    ]
+  end
+
+  context 'with valid params' do
+    let(:params) { { key: 'repo' } }
+    let(:properties) do
+      {
+        measure: 'issue',
+        filters: %w(repo),
+        dimensions: %w(opened_at)
+      }
+    end
+
+    it 'returns the results' do
+      expect(subject).to eq([
+        { id: repo.id, text: repo.to_s },
+        { id: repo2.id, text: repo2.to_s }
+      ])
+    end
+  end
+
+  context 'with a contextual_filter' do
+    context 'with context_params' do
+      let(:params) { { key: 'repo', context_params: { repo_id: repo.id } } }
+      let(:properties) do
+        {
+          measure: 'issue',
+          filters: [{ key: 'repo', contextual_filters: %w(for_repo) }],
+          dimensions: %w(opened_at)
+        }
+      end
+
+      it 'returns the results' do
+        expect(subject).to eq([
+          { id: repo.id, text: repo.to_s }
+        ])
+      end
+    end
+
+    context 'without context_params' do
+      let(:params) { { key: 'repo' } }
+      let(:properties) do
+        {
+          measure: 'issue',
+          filters: [{ key: 'repo', contextual_filters: %w(for_repo) }],
+          dimensions: %w(opened_at)
+        }
+      end
+
+      it 'returns the results' do
+        expect(subject).to eq([
+          { id: repo.id, text: repo.to_s },
+          { id: repo2.id, text: repo2.to_s }
+        ])
+      end
+    end
+  end
+end

data/spec/support/models/repo.rb

@@ -1,6 +1,12 @@
 class Repo < ActiveRecord::Base
+  include ReportsKit::Model
+
   has_many :issues
 
+  reports_kit do
+    contextual_filter :for_repo, ->(relation, context_params) { context_params ? relation.where(id: context_params[:repo_id]) : relation }
+  end
+
   def to_s
     full_name
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reports_kit
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Tom Benner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -271,6 +271,7 @@ files:
 - spec/reports_kit/reports/data/normalize_properties_spec.rb
 - spec/reports_kit/reports/dimension_with_series_spec.rb
 - spec/reports_kit/reports/filter_with_series_spec.rb
+- spec/reports_kit/reports/generate_autocomplete_results_spec.rb
 - spec/spec_helper.rb
 - spec/support/config.rb
 - spec/support/factory_girl.rb