reports_kit 0.2.0 → 0.3.0

data/lib/reports_kit/reports/{filter_with_measure.rb → filter_with_series.rb}

@@ -1,6 +1,6 @@
 module ReportsKit
   module Reports
-    class FilterWithMeasure
+    class FilterWithSeries
       CONFIGURATION_STRATEGIES_FILTER_TYPE_CLASSES = {
         association: FilterTypes::Records,
         boolean: FilterTypes::Boolean,
@@ -15,19 +15,19 @@ module ReportsKit
         string: FilterTypes::String
       }
 
-      attr_accessor :filter, :measure, :configuration
+      attr_accessor :filter, :series, :configuration
 
-      delegate :key, :properties, :label, to: :filter
+      delegate :key, :expression, :properties, :label, to: :filter
       delegate :configured_by_association?, :configured_by_column?, :configured_by_model?, :configured_by_time?,
         :settings_from_model, :configuration_strategy, :instance_class, :column_type, :column,
         to: :configuration
 
-      def initialize(filter:, measure:)
+      def initialize(filter:, series:)
         self.filter = filter
-        self.measure = measure
+        self.series = series
         self.configuration = InferrableConfiguration.new(self, :filters)
 
-        self.properties[:criteria] = filter_type.default_criteria unless self.properties[:criteria]
+        properties[:criteria] = filter_type.default_criteria unless properties[:criteria]
       end
 
       def normalized_properties
@@ -64,7 +64,7 @@ module ReportsKit
       end
 
       def filter_type
-        type_klass.new(settings, properties)
+        type_klass.new(settings, properties, primary_dimension: series.dimensions.first)
       end
 
       def filter_type_class_from_model

data/lib/reports_kit/reports/generate_autocomplete_results.rb

@@ -41,8 +41,8 @@ module ReportsKit
 
       def model
         @model ||= begin
-          measure = Measure.new(measure_key, context_record: context_record)
-          filter = FilterWithMeasure.new(filter: Filter.new(filter_key), measure: measure)
+          series = Series.new(measure_key, context_record: context_record)
+          filter = FilterWithSeries.new(filter: Filter.new(filter_key), series: series)
           filter.instance_class
         end
       end

data/lib/reports_kit/reports/inferrable_configuration.rb

@@ -11,7 +11,7 @@ module ReportsKit
 
       attr_accessor :inferrable, :inferrable_type
 
-      delegate :key, :measure, to: :inferrable
+      delegate :key, :expression, :series, to: :inferrable
 
       def initialize(inferrable, inferrable_type)
         self.inferrable = inferrable
@@ -57,7 +57,7 @@ module ReportsKit
       end
 
       def reflection
-        model_class.reflect_on_association(key.to_sym)
+        model_class.reflect_on_association(expression.to_sym)
       end
 
       def instance_class
@@ -71,7 +71,7 @@ module ReportsKit
       end
 
       def inferred_settings
-        return { column: "#{model_class.table_name}.#{key}" } if configured_by_column?
+        return { column: "#{model_class.table_name}.#{expression}" } if configured_by_column?
         if configured_by_association?
           return inferred_settings_from_belongs_to_or_has_one if inferred_settings_from_belongs_to_or_has_one
           return inferred_settings_from_has_many if inferred_settings_from_has_many
@@ -115,7 +115,7 @@ module ReportsKit
       end
 
       def column_type
-        column_type = model_class.columns_hash[key.to_s].try(:type)
+        column_type = model_class.columns_hash[expression.to_s].try(:type)
         return column_type if SUPPORTED_COLUMN_TYPES.include?(column_type)
       end
 
@@ -125,8 +125,8 @@ module ReportsKit
       end
 
       def model_class
-        return unless measure
-        measure.model_class
+        return unless series
+        series.model_class
       end
     end
   end

data/lib/reports_kit/reports/{measure.rb → series.rb}

@@ -1,13 +1,17 @@
 module ReportsKit
   module Reports
-    class Measure < AbstractMeasure
+    class Series < AbstractSeries
+      VALID_KEYS = [:measure, :dimensions, :filters, :limit, :report_options]
+
       attr_accessor :properties, :dimensions, :filters, :context_record
 
       def initialize(properties, context_record: nil)
-        properties = properties.dup
-        properties = { key: properties } if properties.is_a?(String)
+        properties = { measure: properties } if properties.is_a?(String)
+        properties = properties.deep_symbolize_keys.dup
+        measure_properties = properties[:measure]
+        properties[:measure] = measure_properties
+        properties[:measure] = { key: properties[:measure] } if properties[:measure].is_a?(String)
         raise ArgumentError.new("Measure properties must be a String or Hash, not a #{properties.class.name}: #{properties.inspect}") unless properties.is_a?(Hash)
-        properties = properties.deep_symbolize_keys
 
         dimension_hashes = properties[:dimensions] || []
         dimension_hashes = dimension_hashes.values if dimension_hashes.is_a?(Hash) && dimension_hashes.key?(:'0')
@@ -15,17 +19,25 @@ module ReportsKit
         filter_hashes = filter_hashes.values if filter_hashes.is_a?(Hash) && filter_hashes.key?(:'0')
 
         self.properties = properties
-        self.dimensions = dimension_hashes.map { |dimension_hash| DimensionWithMeasure.new(dimension: Dimension.new(dimension_hash), measure: self) }
-        self.filters = filter_hashes.map { |filter_hash| FilterWithMeasure.new(filter: Filter.new(filter_hash), measure: self) }
+        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
-        properties[:key].underscore
+        properties[:measure][:key].underscore
       end
 
       def label
-        properties[:name].presence || key.pluralize.titleize
+        properties[:measure][:name].presence || key.pluralize.titleize
+      end
+
+      def limit
+        properties[:limit]
+      end
+
+      def edit_relation_method
+        ReportsKit.configuration.custom_method(properties[:report_options].try(:[], :edit_relation_method))
       end
 
       def relation_name
@@ -47,7 +59,7 @@ module ReportsKit
       end
 
       def aggregation_key
-        properties[:aggregation]
+        properties[:measure][:aggregation]
       end
 
       def aggregation_config
@@ -82,14 +94,15 @@ module ReportsKit
       end
 
       def self.new_from_properties!(properties, context_record:)
-        measure_hashes = [properties[:measure]].compact + Array(properties[:measures])
-        raise ArgumentError.new('At least one measure must be configured') if measure_hashes.blank?
+        series_hashes = properties[:series].presence || properties.slice(*Series::VALID_KEYS)
+        series_hashes = [series_hashes] if series_hashes.is_a?(Hash)
+        raise ArgumentError.new('At least one series must be configured') if series_hashes.blank?
 
-        measure_hashes.map do |measure_hash|
-          if measure_hash[:composite_operator].present?
-            CompositeMeasure.new(measure_hash)
+        series_hashes.map do |series_hash|
+          if series_hash[:composite_operator].present?
+            CompositeSeries.new(series_hash)
           else
-            new(measure_hash, context_record: context_record)
+            new(series_hash, context_record: context_record)
           end
         end
       end

data/lib/reports_kit/reports_controller.rb

@@ -3,35 +3,55 @@ require 'spreadsheet'
 
 module ReportsKit
   class ReportsController < ReportsKit::BaseController
+    VALID_PARAMS_PROPERTIES_KEYS = [:ui_filters]
+
     def index
       respond_to do |format|
         format.json do
           render json: { data: report_data }
         end
         format.csv do
-          properties[:format] = 'table'
+          properties[:format] = 'csv'
           csv = CSV.generate do |csv|
             report_data[:table_data].each do |row|
               csv << row
             end
           end
-          send_data csv, filename: "Report.csv"
+          send_data csv, filename: "#{report_filename}.csv"
         end
         format.xls do
-          properties[:format] = 'table'
-          send_data xls_string, filename: 'Report.xls', type:  'application/vnd.ms-excel'
+          properties[:format] = 'csv'
+          send_data xls_string, filename: "#{report_filename}.xls", type:  'application/vnd.ms-excel'
         end
       end
     end
 
     private
 
+    def report_filename
+      report_filename_method = ReportsKit.configuration.report_filename_method
+      return 'Report' unless report_filename_method
+      instance_eval(&report_filename_method)
+    end
+
     def report_data
       Reports::Data::Generate.new(properties, context_record: context_record).perform
     end
 
+    def report_key
+      params[:report_params][:key]
+    end
+
     def properties
-      @properties ||= ActiveSupport::JSON.decode(params[:properties])
+      @properties ||= begin
+        properties_method = ReportsKit.configuration.properties_method
+        properties = instance_eval(&properties_method)
+        properties.merge(params_properties).deep_symbolize_keys
+      end
+    end
+
+    def params_properties
+      @params_properties ||= ActiveSupport::JSON.decode(params[:properties]).with_indifferent_access.slice(*VALID_PARAMS_PROPERTIES_KEYS)
     end
 
     def xls_string

data/lib/reports_kit/value.rb

@@ -0,0 +1,3 @@
+module ReportsKit
+  Value = Struct.new(:raw, :formatted)
+end

data/lib/reports_kit/version.rb

@@ -1,3 +1,3 @@
 module ReportsKit
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/fixtures/generate_inputs.yml

@@ -1,164 +1,217 @@
-- measure:
-    key: issue
+- series:
+    measure: issue
     dimensions:
     - repo
-- measure:
-    key: issue
+- series:
+    measure: issue
     dimensions:
     - repo
   chart:
     options:
       foo: bar
-- measure:
-    key: issue
+- series:
+    measure: issue
     dimensions:
     - repo
   chart:
     foo: bar
-- measure:
-    key: issue
+- series:
+    measure: issue
     dimensions:
     - repo
   chart:
     type: pie
-- measure:
-    key: issue
+- series:
+    measure: issue
     dimensions:
     - key: repo
-- measure:
-    key: issue
+- series:
+    measure: issue
     dimensions:
     - key: opened_at
-- measure:
-    key: issue
+- series:
+    measure: issue
     dimensions:
     - key: opened_at
     - key: repo
-- measure:
-    key: issue
+- series:
+    measure: issue
     filters:
     - key: locked
     - key: title
     - key: opened_at
     dimensions:
     - key: repo
-- measures:
-  - key: issue
+- series:
+  - measure: issue
     dimensions:
     - repo
-  - key: label
+  - measure: label
     dimensions:
     - repo
-- measures:
-  - key: issue
+- series:
+  - measure: issue
     dimensions:
     - repo
-  - key: label
+  - measure: label
     dimensions:
     - repo
-  - key: tag
+  - measure: tag
     dimensions:
     - repo
-- measures:
-  - key: issue
-    name: Repo Issues
+- series:
+  - measure:
+      key: issue
+      name: Repo Issues
     dimensions:
     - repo
-  - key: label
+  - measure: label
     dimensions:
     - repo
-- measures:
-  - key: issue
-    name: Repo Issues
+- series:
+  - measure:
+      key: issue
+      name: Repo Issues
     dimensions:
     - key: repo
       label:
-  - key: label
+  - measure: label
     dimensions:
     - repo
   format: table
-- measure:
-    key: label
+- series:
+  - measure:
+      key: issue
+      name: Repo Issues
+    dimensions:
+    - key: repo
+      label:
+  - measure: label
+    dimensions:
+    - repo
+  format: table
+  report_options:
+    aggregations:
+    - from: columns
+      operator: sum
+      label: Total
+- series:
+  - measure:
+      key: issue
+      name: Repo Issues
+    dimensions:
+    - key: repo
+      label:
+  - measure: label
+    dimensions:
+    - repo
+  format: table
+  report_options:
+    aggregations:
+    - from: rows
+      operator: sum
+      label: Total
+- series:
+  - measure:
+      key: issue
+      name: Repo Issues
+    dimensions:
+    - key: repo
+      label:
+  - measure: label
+    dimensions:
+    - repo
+  format: table
+  report_options:
+    aggregations:
+    - from: columns
+      operator: sum
+      label: Total
+    - from: rows
+      operator: sum
+      label: Total
+- series:
+    measure: label
     dimensions:
     - repo
   order: dimension1.label
-- measure:
-    key: label
+- series:
+    measure: label
     dimensions:
     - repo
   order: dimension1.label desc
-- measure:
-    key: label
+- series:
+    measure: label
     dimensions:
     - repo
   order: count
-- measure:
-    key: label
+- series:
+    measure: label
     dimensions:
     - repo
   order: count desc
-- measure:
-    key: issue
+- series:
+    measure: issue
     dimensions:
     - opened_at
   order: dimension1
-- measure:
-    key: issue
+- series:
+    measure: issue
     dimensions:
     - opened_at
   order: dimension1 desc
-- measure:
-    key: label
+- series:
+    measure: label
     dimensions:
     - repo
   order: 0
-- measure:
-    key: label
+- series:
+    measure: label
     dimensions:
     - repo
   order: 0 desc
-- measure:
-    key: label
+- series:
+    measure: label
     dimensions:
     - repo
   order: 1
-- measure:
-    key: label
+- series:
+    measure: label
     dimensions:
     - repo
   order: 1 desc
-- measure:
-    key: issue
+- series:
+    measure: issue
     dimensions:
     - key: opened_at
     - key: repo
   order: dimension1
-- measure:
-    key: issue
+- series:
+    measure: issue
     dimensions:
     - key: opened_at
     - key: repo
   order: dimension1 desc
-- measure:
-    key: label
+- series:
+    measure: label
     dimensions:
     - key: repo
     - key: created_at
   order: dimension1.label
-- measure:
-    key: label
+- series:
+    measure: label
     dimensions:
     - key: repo
     - key: created_at
   order: dimension1.label desc
-- measure:
-    key: issue
+- series:
+    measure: issue
     dimensions:
     - key: opened_at
     - key: repo
   order: count
-- measure:
-    key: issue
+- series:
+    measure: issue
     dimensions:
     - key: opened_at
     - key: repo