active_reporting 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bbb1cca5da777e98db50e52e0dd97a44e20cd9844c8d4d88cbb739485a7f22f
-  data.tar.gz: f3d5fcc3f6e174e6eb6ca582c57add3b844cc0deb632e6f844ee9990db31c93f
+  metadata.gz: 07ad5ad6e21234d6441a8e97908cf854406d30e2a77b741096d0c874c85d5c42
+  data.tar.gz: 982a82ba6ab68d81dee8a1db785f25d993ac14b2572e698923437a4c1a37bd1e
 SHA512:
-  metadata.gz: b57b0e82ebb5d1d645383d3aa88551b43c999c1443d0ecac6544d83295d6d1745f2956696499a5ce3ff249f8d91251e298a77e3921a68722d6842ffb7e90e705
-  data.tar.gz: 3fcec68b2de1a822ecef745f7b75ca6aaa7ae9587d7a25ce5ae5234a26e1d083bab01da4ccd70bafd47a9382810fb0932cb287ca7b18d20916789f4e0809b045
+  metadata.gz: 0f7a37f152776e1d9fbc2440b71cb045464063f759c88cfff5d6dc0302ab8e9f6ea7aeed4c35375b5ad25861132dfb1ba4ebad57da6051ba75680beb309c3665
+  data.tar.gz: 0c07b8989e32d26ca39105630ffe74b83207425449d412f344461c194926e0efed64da367449898295de62a3618910f7a249e94ee91efe0290b3332d1b820319

data/CHANGELOG.md

@@ -1,8 +1,19 @@
+## 0.5.1 (2020-06-31)
+
+### Features
+
+* Allow dimensions defined in a `Metric` to use LEFT OUTER JOINs via a new `:join_method` option (#32) - *germanotm*
+
+### Misc
+
+* Fixed warning about initialized variables
+* Fixed Ruby 2.7 warning
+
 ## 0.5.0 (2020-06-30)
 
 ### Bug Fixes
 
-* Fix Missing quotation marks in column names causing SLQ errors on MYSQL - *germanotm*
+* Fix Missing quotation marks in column names causing SQL errors on MYSQL (#30) - *germanotm*
 
 ### Misc
 

data/Gemfile

@@ -11,5 +11,5 @@ case rails
 when '5-2'
   gem 'activerecord', '~> 5.2.0'
 when '6-0'
-  gem 'activerecord', '6.0.0'
+  gem 'activerecord', '~> 6.0.0'
 end

data/README.md

@@ -285,7 +285,7 @@ my_metric = ActiveReporting::Metric.new(
 
 `aggregate` - The SQL aggregate used to calculate the metric. Supported aggregates include count, max, min, avg, and sum. (Default: `:count`)
 
-`dimensions` - An array of dimensions used for the metric. When given just a symbol, the default dimension label will be used for the dimension. You may specify a hierarchy level by using a hash. (Examples: `[:sales_rep, {sale_date: :month}]`). In hierarchies you can customize the label in this way: `[{sale_date: { field: :month, name: :a_custom_name_for_month }}]`. If you use a hash instead of a Symbol to define a hierarchy the `field` item must be a valid field in your table. The `name` can be whatever label you want.
+`dimensions` - An array of dimensions used for the metric. When given just a symbol, the default dimension label will be used for the dimension. You may specify a hierarchy level by using a hash. (Examples: `[:sales_rep, {sale_date: :month}]`). In hierarchies you can customize the label in this way: `[{sale_date: { field: :month, name: :a_custom_name_for_month }}]`. If you use a hash instead of a Symbol to define a hierarchy the `field` item must be a valid field in your table. The `name` can be whatever label you want. You can choose the join_method with the dimension. The default value for join_method is :joins which does a standard "INNER JOIN", but you can pass a :left_outer_joins to use "LEFT OUTER JOIN" instead. Ex: `[{sales_rep: { join_method: :left_outer_joins }}]`
 
 `dimension_filter` - A hash were the keys are dimension filter names and the values are the values passed into the filter.
 

data/lib/active_reporting.rb

@@ -41,4 +41,5 @@ module ActiveReporting
   UnknownDimension        = Class.new(StandardError)
   UnknownDimensionFilter  = Class.new(StandardError)
   UnknownMetric           = Class.new(StandardError)
+  UnknownJoinMethod       = Class.new(StandardError)
 end

data/lib/active_reporting/fact_model.rb

@@ -85,6 +85,7 @@ module ActiveReporting
     #
     # @return [Symbol]
     def self.dimension_label
+      @dimension_label ||= nil
       @dimension_label || Configuration.default_dimension_label
     end
 
@@ -155,6 +156,7 @@ module ActiveReporting
     #
     # @return [Boolean]
     def self.ransack_fallback
+      @ransack_fallback ||= false
       @ransack_fallback || Configuration.ransack_fallback
     end
     private_class_method :ransack_fallback

data/lib/active_reporting/report.rb

@@ -52,7 +52,8 @@ module ActiveReporting
     def statement
       parts = {
         select: select_statement,
-        joins: dimension_joins,
+        joins: dimension_joins(ReportingDimension::JOIN_METHODS[:joins]),
+        left_outer_joins: dimension_joins(ReportingDimension::JOIN_METHODS[:left_outer_joins]),
         group: group_by_statement,
         having: having_statement,
         order: order_by_statement
@@ -84,8 +85,9 @@ module ActiveReporting
       end
     end
 
-    def dimension_joins
-      @dimensions.select { |d| d.type == :standard }.map { |d| d.name.to_sym }
+    def dimension_joins(join_method)
+      @dimensions.select { |d| d.type == Dimension::TYPES[:standard] && d.join_method == join_method }.
+                  map { |d| d.name.to_sym }
     end
 
     def group_by_statement

data/lib/active_reporting/reporting_dimension.rb

@@ -9,6 +9,9 @@ module ActiveReporting
     # See https://www.postgresql.org/docs/10/static/functions-datetime.html#FUNCTIONS-DATETIME-TRUNC
     DATETIME_HIERARCHIES = %i[microseconds milliseconds second minute hour day week month quarter year decade
                               century millennium].freeze
+    JOIN_METHODS = { joins: :joins, left_outer_joins: :left_outer_joins }.freeze
+    attr_reader :join_method
+
     def_delegators :@dimension, :name, :type, :klass, :association, :model, :hierarchical?, :datetime?
 
     def self.build_from_dimensions(fact_model, dimensions)
@@ -18,7 +21,7 @@ module ActiveReporting
 
         raise(UnknownDimension, "Dimension '#{dim}' not found on fact model '#{fact_model}'") if found_dimension.nil?
 
-        new(found_dimension, label_config(label))
+        new(found_dimension, **label_config(label))
       end
     end
 
@@ -32,18 +35,20 @@ module ActiveReporting
 
       {
         label: label[:field],
-        label_name: label[:name]
+        label_name: label[:name],
+        join_method: label[:join_method]
       }
     end
 
     # @param dimension [ActiveReporting::Dimension]
     # @option label [Maybe<Symbol>] Hierarchical dimension to be used as a label
     # @option label_name [Maybe<Symbol|String>] Hierarchical dimension custom name
-    def initialize(dimension, label: nil, label_name: nil)
+    def initialize(dimension, label: nil, label_name: nil, join_method: nil)
       @dimension = dimension
 
       determine_label_field(label)
       determine_label_name(label_name)
+      determine_join_method(join_method)
     end
 
     # The foreign key to use in queries
@@ -106,6 +111,16 @@ module ActiveReporting
       @label_name = label_name ? "#{name}_#{label_name}" : name
     end
 
+    def determine_join_method(join_method)
+      if join_method.blank?
+        @join_method = ReportingDimension::JOIN_METHODS[:joins]
+      elsif ReportingDimension::JOIN_METHODS.include?(join_method)
+        @join_method = join_method
+      else
+        raise UnknownJoinMethod, "Method '#{join_method}' not included in '#{ReportingDimension::JOIN_METHODS.values}'"
+      end
+    end
+
     def validate_hierarchical_label(hierarchical_label)
       if datetime?
         validate_supported_database_for_datetime_hierarchies

data/lib/active_reporting/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveReporting
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_reporting
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Tony Drake
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-30 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord