reports_kit 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e12a4b95211ec84a8662237e268dfacfcd23978a
-  data.tar.gz: c5ec6f7f3f4e8bd9613764e8cd74108971255c26
+  metadata.gz: ae53802c82ae537f372cf8813f596ba837be224a
+  data.tar.gz: 8c46d69d66a2e1b3e1e47d88b7bc45f398e9a8e0
 SHA512:
-  metadata.gz: 94b293476548bdd6ad1bed10018e4889f4d28a56b59490059274777fcd608790399a2f835b6f858d9f4075fd96c9accfe382d6fa4e9474079a827008fb157b0f
-  data.tar.gz: fd582ab216f799db4dbf3c0c197b95f5ebe155b55fa9bcc17bfbb15adcdf79dc22f85d999109187d02d8678b045fcc57846d8aa0748d8c1830d8e7e030662e3c
+  metadata.gz: 26b7239f82a98fb70d5229963bccd6c77850c9600f76441f369cfe987a25d4bd54adec86dce6ceb5a1a58a01e600e38e1ce4d49fcf25721fd9fd179d2433cf1d
+  data.tar.gz: 1369039cdb9b87cbcbb0047ea6873b934d8071aa911e04bf54d76f8e5be47308f020c2d6cd0869c2cd60e47e2f33a6d582410b759687da3b7e92d625d7ff880f

data/app/assets/javascripts/reports_kit/lib/report.js

@@ -73,8 +73,6 @@ ReportsKit.Report = (function() {
         format: 'MMM D, YYYY'
       },
       ranges: {
-        'Today': [moment(), moment()],
-        'Last 7 Days': [moment().subtract(7, 'days'), moment()],
         'Last 30 Days': [moment().subtract(30, 'days'), moment()],
         'Last 2 Months': [moment().subtract(2, 'months'), moment()],
         'Last 3 Months': [moment().subtract(3, 'months'), moment()],

data/config/routes.rb

@@ -1,9 +1,9 @@
 ReportsKit::Engine.routes.draw do
   namespace :reports_kit do
     resources :reports, only: [:index]
-    resources :resources, only: [] do
-      collection do
-        get 'measures/:measure_key/filters/:filter_key/autocomplete' => :autocomplete
+    resources :filters, only: [], param: :key do
+      member do
+        get :autocomplete
       end
     end
   end

data/gemfiles/mysql.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    reports_kit (0.3.1)
+    reports_kit (0.3.2)
       rails (>= 3)
       spreadsheet (>= 1.1)
 
@@ -135,7 +135,7 @@ GEM
     sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.0)
+    sprockets-rails (3.2.1)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
@@ -164,4 +164,4 @@ DEPENDENCIES
   timecop (~> 0)
 
 BUNDLED WITH
-   1.14.6
+   1.15.4

data/gemfiles/postgresql.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    reports_kit (0.3.1)
+    reports_kit (0.3.2)
       rails (>= 3)
       spreadsheet (>= 1.1)
 
@@ -134,7 +134,7 @@ GEM
     sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.0)
+    sprockets-rails (3.2.1)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
@@ -162,4 +162,4 @@ DEPENDENCIES
   timecop (~> 0)
 
 BUNDLED WITH
-   1.14.6
+   1.15.4

data/lib/reports_kit.rb

@@ -1,18 +1,19 @@
 require 'rails/all'
 
+require 'reports_kit/normalized_params'
 require 'reports_kit/base_controller'
 require 'reports_kit/cache'
 require 'reports_kit/configuration'
 require 'reports_kit/engine'
 require 'reports_kit/entity'
-require 'reports_kit/report_builder'
+require 'reports_kit/filters_controller'
 require 'reports_kit/form_builder'
 require 'reports_kit/helper'
 require 'reports_kit/model'
 require 'reports_kit/model_configuration'
 require 'reports_kit/order'
 require 'reports_kit/relative_time'
-require 'reports_kit/resources_controller'
+require 'reports_kit/report_builder'
 require 'reports_kit/reports_controller'
 require 'reports_kit/value'
 require 'reports_kit/version'
@@ -49,6 +50,8 @@ require 'reports_kit/reports/filter'
 require 'reports_kit/reports/filter_with_series'
 require 'reports_kit/reports/generate_autocomplete_results'
 require 'reports_kit/reports/inferrable_configuration'
+require 'reports_kit/reports/properties'
+require 'reports_kit/reports/properties_to_filter'
 require 'reports_kit/reports/series'
 
 module ReportsKit

data/lib/reports_kit/base_controller.rb

@@ -1,10 +1,10 @@
 module ReportsKit
   class BaseController < ActionController::Base
+    include ReportsKit::NormalizedParams
+
     # This is intentionally public to allow external code to access it
     def context_record
-      context_record_method = ReportsKit.configuration.context_record_method
-      return unless context_record_method
-      instance_eval(&context_record_method)
+      ReportsKit.configuration.context_record(self)
     end
   end
 end

data/lib/reports_kit/configuration.rb

@@ -35,5 +35,10 @@ module ReportsKit
       return custom_methods.call if custom_methods.is_a?(Proc)
       raise ArgumentError.new("Invalid type for custom_methods configuration: #{custom_methods.class}")
     end
+
+    def context_record(context)
+      return unless context_record_method
+      context.instance_eval(&context_record_method)
+    end
   end
 end

data/lib/reports_kit/filters_controller.rb

@@ -0,0 +1,9 @@
+module ReportsKit
+  class FiltersController < ReportsKit::BaseController
+    def autocomplete
+      properties = Reports::Properties.generate(self)
+      results = Reports::GenerateAutocompleteResults.new(params, properties, context_record: context_record).perform
+      render json: { data: results }
+    end
+  end
+end

data/lib/reports_kit/form_builder.rb

@@ -4,21 +4,23 @@ module ReportsKit
 
     DEFAULT_DATE_RANGE_VALUE = ['-2M', 'now']
 
-    attr_accessor :properties, :additional_params
+    attr_accessor :properties, :additional_params, :context_record, :properties_to_filter
 
-    def initialize(properties, additional_params: nil)
+    def initialize(properties, additional_params: nil, context_record: nil)
       self.properties = properties.deep_symbolize_keys
       self.additional_params = additional_params
+      self.context_record = context_record
+      self.properties_to_filter = Reports::PropertiesToFilter.new(properties, context_record: context_record)
     end
 
     def check_box(filter_key, options = {})
-      filter = validate_filter!(filter_key)
+      filter = properties_to_filter.perform(filter_key)
       checked = filter.normalized_properties[:criteria][:value] == 'true'
       check_box_tag(filter_key, '1', checked, options)
     end
 
     def date_range(filter_key, options = {})
-      filter = validate_filter!(filter_key)
+      filter = properties_to_filter.perform(filter_key)
       defaults = { class: 'form-control input-sm date_range_picker' }
       options = defaults.deep_merge(options)
       value = filter.normalized_properties[:criteria][:value].presence
@@ -27,22 +29,17 @@ module ReportsKit
     end
 
     def multi_autocomplete(filter_key, options = {})
-      validate_filter!(filter_key)
-      filter = series_filters.find { |f| f.key == filter_key.to_s }
+      filter = properties_to_filter.perform(filter_key)
       reports_kit_path = Rails.application.routes.url_helpers.reports_kit_path
-      path = "#{reports_kit_path}reports_kit/resources/measures/#{filter.series.key}/filters/#{filter_key}/autocomplete?"
+      path = "#{reports_kit_path}reports_kit/filters/#{filter_key}/autocomplete?"
       path += additional_params.to_query if additional_params.present?
-      scope = options.delete(:scope)
-      params = {}
-      params[:scope] = scope if scope.present?
 
       defaults = {
         class: 'form-control input-sm select2',
         multiple: 'multiple',
         data: {
           placeholder: options[:placeholder],
-          path: path,
-          params: params
+          path: path
         }
       }
       options = defaults.deep_merge(options)
@@ -50,7 +47,7 @@ module ReportsKit
     end
 
     def string_filter(filter_key, options = {})
-      filter = validate_filter!(filter_key)
+      filter = properties_to_filter.perform(filter_key)
       defaults = { class: 'form-control input-sm' }
       options = defaults.deep_merge(options)
       text_field_tag(filter_key, filter.normalized_properties[:criteria][:value], options)
@@ -58,32 +55,6 @@ module ReportsKit
 
     private
 
-    def validate_filter!(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
-
-    def 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: nil)
-    end
-
     def default_date_range_value
       @default_date_range_value ||= begin
         start_date = Reports::Data::Utils.format_time_value(DEFAULT_DATE_RANGE_VALUE[0])

data/lib/reports_kit/helper.rb

@@ -1,9 +1,11 @@
 module ReportsKit
   module Helper
+    include ReportsKit::NormalizedParams
+
     def render_report(report_params, context_params: {}, actions: %w(export_csv export_xls), js_report_class: 'Report', &block)
       report_params = { key: report_params } if report_params.is_a?(String)
       params.merge!(context_params: context_params, report_params: report_params)
-      properties = instance_eval(&ReportsKit.configuration.properties_method).deep_symbolize_keys
+      properties = Reports::Properties.generate(self)
       builder = ReportBuilder.new(
         report_params: report_params,
         context_params: context_params,
@@ -18,17 +20,5 @@ module ReportsKit
         builder.render
       end
     end
-
-    def context_params
-      params[:context_params]
-    end
-
-    def report_params
-      params[:report_params]
-    end
-
-    def report_key
-      report_params[:key]
-    end
   end
 end

data/lib/reports_kit/model_configuration.rb

@@ -1,12 +1,11 @@
 module ReportsKit
   class ModelConfiguration
-    attr_accessor :aggregations, :dimensions, :filters, :autocomplete_scopes
+    attr_accessor :aggregations, :dimensions, :filters
 
     def initialize
       self.aggregations = []
       self.dimensions = []
       self.filters = []
-      self.autocomplete_scopes = []
     end
 
     def aggregation(key, expression, properties = {})
@@ -20,9 +19,5 @@ module ReportsKit
     def filter(key, type_key, properties)
       filters << { key: key.to_s, type_key: type_key }.merge(properties).symbolize_keys
     end
-
-    def autocomplete_scope(*scopes)
-      self.autocomplete_scopes += scopes.map(&:to_s)
-    end
   end
 end

data/lib/reports_kit/normalized_params.rb

@@ -0,0 +1,16 @@
+module ReportsKit
+  module NormalizedParams
+    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
+  end
+end

data/lib/reports_kit/report_builder.rb

@@ -17,8 +17,9 @@ module ReportsKit
       self.js_report_class = js_report_class
       self.view_context = view_context
       self.block = block
-      self.properties = properties#view_context.instance_eval(&ReportsKit.configuration.properties_method).deep_symbolize_keys
-      self.form_builder = ReportsKit::FormBuilder.new(properties, additional_params: additional_params)
+      self.properties = properties
+      context_record = ReportsKit.configuration.context_record(view_context)
+      self.form_builder = ReportsKit::FormBuilder.new(properties, additional_params: additional_params, context_record: context_record)
     end
 
     def render

data/lib/reports_kit/reports/composite_series.rb

@@ -1,10 +1,11 @@
 module ReportsKit
   module Reports
     class CompositeSeries < AbstractSeries
-      attr_accessor :properties
+      attr_accessor :properties, :context_record
 
-      def initialize(properties)
+      def initialize(properties, context_record:)
         self.properties = properties.dup
+        self.context_record = context_record
       end
 
       def label
@@ -24,7 +25,7 @@ module ReportsKit
       end
 
       def serieses
-        @serieses ||= Reports::Series.new_from_properties!(properties, context_record: nil)
+        @serieses ||= Reports::Series.new_from_properties!(properties, context_record: context_record)
       end
 
       def filters

data/lib/reports_kit/reports/data/aggregate_composite.rb

@@ -20,7 +20,7 @@ module ReportsKit
         }
 
         def initialize(properties, context_record:)
-          self.composite_series = CompositeSeries.new(properties)
+          self.composite_series = CompositeSeries.new(properties, context_record: context_record)
           self.context_record = context_record
         end
 

data/lib/reports_kit/reports/data/generate_for_properties.rb

@@ -15,7 +15,7 @@ module ReportsKit
           if composite_operator
             raise ArgumentError.new('Aggregations require at least one series') if all_serieses.length == 0
             dimension_keys_values = Data::AggregateComposite.new(properties, context_record: context_record).perform
-            serieses_dimension_keys_values = { CompositeSeries.new(properties) => dimension_keys_values }
+            serieses_dimension_keys_values = { CompositeSeries.new(properties, context_record: context_record) => dimension_keys_values }
           elsif all_serieses.length == 1 && composite_serieses.length == 1
             dimension_keys_values = Data::AggregateComposite.new(composite_serieses.first.properties, context_record: context_record).perform
             serieses_dimension_keys_values = { all_serieses.first => dimension_keys_values }

data/lib/reports_kit/reports/filter_with_series.rb

@@ -54,6 +54,10 @@ module ReportsKit
         }
       end
 
+      def context_record_association
+        properties[:context_record_association] || instance_class.name.tableize
+      end
+
       def type_klass
         type_klass_for_configuration_strategy = CONFIGURATION_STRATEGIES_FILTER_TYPE_CLASSES[configuration_strategy]
         return type_klass_for_configuration_strategy if type_klass_for_configuration_strategy

data/lib/reports_kit/reports/generate_autocomplete_results.rb

@@ -1,12 +1,12 @@
 module ReportsKit
   module Reports
     class GenerateAutocompleteResults
-      attr_accessor :params, :measure_key, :filter_key, :context_record
+      attr_accessor :params, :filter_key, :filter, :context_record
 
-      def initialize(params, context_record: nil)
+      def initialize(params, properties, context_record: nil)
         self.params = params
-        self.measure_key = params[:measure_key]
-        self.filter_key = params[:filter_key]
+        self.filter_key = params[:key]
+        self.filter = Reports::PropertiesToFilter.new(properties, context_record: context_record).perform(filter_key)
         self.context_record = context_record
       end
 
@@ -14,7 +14,6 @@ module ReportsKit
         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 = results.public_send(scope) if scope
         results = results.limit(10_000)
         results = results.map { |result| { id: result.id, text: result.to_s } }
         results = results.sort_by { |result| result[:text].downcase }
@@ -30,7 +29,7 @@ module ReportsKit
 
       def relation
         if context_record
-          context_record.public_send(model.name.tableize)
+          context_record.public_send(filter.context_record_association)
         else
           model
         end
@@ -46,23 +45,9 @@ module ReportsKit
 
       def model
         @model ||= begin
-          series = Series.new(measure_key, context_record: context_record)
-          filter = FilterWithSeries.new(filter: Filter.new(filter_key), series: series)
           filter.instance_class
         end
       end
-
-      def scope
-        @scope ||= begin
-          scope = params[:scope]
-          return unless scope.present?
-          return unless model.try(:reports_kit_configuration) && model.reports_kit_configuration.autocomplete_scopes.present?
-          unless model.reports_kit_configuration.autocomplete_scopes.include?(scope)
-            raise ArgumentError.new("Unallowed scope '#{scope}' for model #{model.name}")
-          end
-          scope
-        end
-      end
     end
   end
 end

data/lib/reports_kit/reports/inferrable_configuration.rb

@@ -61,7 +61,7 @@ module ReportsKit
       end
 
       def instance_class
-        return reflection.class_name.constantize if reflection
+        return reflection.klass if reflection
         nil
       end