active_reporting 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7a5444ba19be4d20842e16f8e800e45837e133bd
-  data.tar.gz: 24b59685e4cd70770a13a8a2925c85d860e782a3
+SHA256:
+  metadata.gz: 4470ea5ed19154c0f73c4205dfb251f327a076563eeee479a8ebf1410cfd6c81
+  data.tar.gz: '038914792fde14a53347f7952336a68e3d2520a171dbb2a620342ba85dffc144'
 SHA512:
-  metadata.gz: 1df566a6122ec806f231a116ffe33cf729374fe529ddf18a2763cb2462946414c60bada55a06e7fc036ef3c4fc0002f021d06b1147cb011c7810ce1b517cd82e
-  data.tar.gz: 0ec9387af8a5918f3685732b4331377302e373ae56843305991d2c8abc24928c4a19ea79ed7d3bd6b5e979204c2a15cde3806df62a282a8714ac0d6a439fb4e6
+  metadata.gz: 0dafa3b0a2d8a9731f14c51e1505bdf79b79cb52fb9b9ecabe3c8006340f946b60638090b775a830a8952f7dce1c32f75608eb488894e08d899e0cc6b5b0d5e5
+  data.tar.gz: a4a2e65604d42d290582c50954aa66f991350bf5efbfd47887ae4534d4ed7811dc70538371cd693650124af7f1ef0843ebd4c62a84111527d35c268231a79a11

data/.gitignore

@@ -6,5 +6,7 @@
 /doc/
 /pkg/
 /spec/reports/
+.byebug_history
+.ruby-version
 /tmp/
 .DS_STORE

data/.rubocop.yml

@@ -4,6 +4,9 @@ AllCops:
     - Gemfile
   TargetRubyVersion: 2.3
 
+Metrics/ClassLength:
+  Max: 150
+
 Metrics/LineLength:
   Max: 120
 

data/.travis.yml

@@ -1,10 +1,15 @@
 sudo: false
 language: ruby
+addons:
+  postgresql: "9.6"
 rvm:
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 env:
+  - RAILS=6-0 DB=sqlite
+  - RAILS=6-0 DB=pg
+  - RAILS=6-0 DB=mysql
   - RAILS=5-2 DB=sqlite
   - RAILS=5-2 DB=pg
   - RAILS=5-2 DB=mysql
@@ -14,6 +19,14 @@ env:
   - RAILS=4-2 DB=sqlite
   - RAILS=4-2 DB=pg
   - RAILS=4-2 DB=mysql
+matrix:
+  exclude:
+    - rvm: 2.4.6
+      env: RAILS=6-0 DB=mysql
+    - rvm: 2.4.6
+      env: RAILS=6-0 DB=pg
+    - rvm: 2.4.6
+      env: RAILS=6-0 DB=sqlite
 before_script:
   - psql -c 'create database active_reporting_test;' -U postgres
   - mysql -e 'create database active_reporting_test collate utf8_general_ci;'

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.4.1 (2019-05-28)
+
+### Features
+
+* Hierarchical dimensions may now have custom keys in result (#16) - *andresgutgon*
+
+### Misc
+
+* Test against Raisl 6.0RC
+* Loosen AR requirements. The gem will install for any AR version, but only ones listed in the README are supported
+* Test against active Rubies
+
 ## 0.4.0 (2018-05-02)
 
 ### Breaking Changes
@@ -15,7 +27,7 @@
 * Specify rescue from LoadError for ransack (#9) - *niborg*
 * Fix ransack fallback logic (#8) - *germanotm*
 
-## Misc
+### Misc
 
 * Test against Rails 5.2
 * Test against Ruby 2.5

data/Gemfile

@@ -10,14 +10,22 @@ db = ENV['DB'] || 'sqlite'
 case rails
 when '4-2'
   gem 'activerecord', '~> 4.2.0'
-  if ENV['DB'] == 'pg'
-    gem 'pg', '~> 0.18'
-  end
-  if ENV['DB'] == 'mysql'
-    gem 'mysql2', '~> 0.3.18'
-  end
 when '5-1'
   gem 'activerecord', '~> 5.1.0'
-else
+when '5-2'
   gem 'activerecord', '~> 5.2.0'
+when '6-0'
+  gem 'activerecord', '6.0.0.rc1'
+end
+
+case rails
+when '4-2'
+  case ENV['DB']
+  when 'pg'
+    gem 'pg', '~> 0.18'
+  when 'mysql'
+    gem 'mysql2', '~> 0.3.18'
+  when 'sqlite'
+    gem 'sqlite3', '~> 1.3.0'
+  end
 end

data/README.md

@@ -8,9 +8,9 @@ ActiveReporting implements various terminology used in Relational Online Analyti
 
 ActiveReporting officially supports MySQL, PostgreSQL, and SQLite.
 
-ActiveReporting officially supports Ruby 2.3, 2.4, and 2.5.
+ActiveReporting officially supports Ruby 2.4 and later. Other versions may work, but are not supported.
 
-ActiveReporting officially supports Rails 4.2, 5.1, and 5.2.
+ActiveReporting officially supports Rails 4.2, 5.1, and 5.2. Other versions may work, but are not supported.
 
 ## Installation
 
@@ -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, {order_date: :month}]`)
+`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, {order_date: :month}]`). In hierarchies you can customize the label in this way: `[{order_date: { label: :month, name: :a_custom_name_for_month }}]`. If you use a hash instead of a Symbol to define a hierarchy the `label` item must be a valid field in your table. The `name` can be whatever you want.
 
 `dimension_filter` - A hash were the keys are dimension filter names and the values are the values passed into the filter.
 
@@ -342,7 +342,7 @@ metric = ActiveReporting::Metric.new(
   dimension_filter: {months_ago: 1}
 )
 
-report = ActiveReporting.new(metric, dimension_filter: {from_region: 'North'}, dimension_identifiers: false)
+report = ActiveReporting::Report.new(metric, dimension_filter: {from_region: 'North'}, dimension_identifiers: false)
 report.run
 => [{order_count: 17, sales_rep: 'Mary Sue'}]
 ```

data/active_reporting.gemspec

@@ -24,8 +24,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3'
 
-  spec.add_dependency 'activerecord', '>= 4.2.0'
-  spec.add_dependency 'activesupport', '>= 4.2.0'
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'activesupport'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest', '~> 5.0'

data/lib/active_reporting/reporting_dimension.rb

@@ -15,16 +15,35 @@ module ActiveReporting
       Array(dimensions).map do |dim|
         dimension_name, label = dim.is_a?(Hash) ? Array(dim).flatten : [dim, nil]
         found_dimension = fact_model.dimensions[dimension_name.to_sym]
-        raise UnknownDimension, "Dimension '#{dim}' not found on fact model '#{fact_model}'" if found_dimension.nil?
-        new(found_dimension, label: label)
+
+        raise(UnknownDimension, "Dimension '#{dim}' not found on fact model '#{fact_model}'") if found_dimension.nil?
+
+        new(found_dimension, label_config(label))
       end
     end
 
+    # If you pass a symbol it means you just indicate
+    # the field on that dimension. With a hash you can
+    # customize the name of the label
+    #
+    # @param [Symbol|Hash] label
+    def self.label_config(label)
+      return { label: label } unless label.is_a?(Hash)
+
+      {
+        label: label[:field],
+        label_name: label[:name]
+      }
+    end
+
     # @param dimension [ActiveReporting::Dimension]
-    # @option label [Symbol] Hierarchical dimension to be used as a label
-    def initialize(dimension, label: nil)
+    # @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)
       @dimension = dimension
-      determine_label(label)
+
+      determine_label_field(label)
+      determine_label_name(label_name)
     end
 
     # The foreign key to use in queries
@@ -40,7 +59,7 @@ module ActiveReporting
     def select_statement(with_identifier: true)
       return [degenerate_select_fragment] if type == Dimension::TYPES[:degenerate]
 
-      ss = ["#{label_fragment} AS #{name}"]
+      ss = ["#{label_fragment} AS #{@label_name}"]
       ss << "#{identifier_fragment} AS #{name}_identifier" if with_identifier
       ss
     end
@@ -75,14 +94,18 @@ module ActiveReporting
 
     private ####################################################################
 
-    def determine_label(label)
-      @label = if label.present? && validate_hierarchical_label(label)
-                 label.to_sym
+    def determine_label_field(label_field)
+      @label = if label_field.present? && validate_hierarchical_label(label_field)
+                 label_field.to_sym
                else
                  dimension_fact_model.dimension_label || Configuration.default_dimension_label
                end
     end
 
+    def determine_label_name(label_name)
+      @label_name = label_name ? "#{name}_#{label_name}" : name
+    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.4.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_reporting
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Tony Drake
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2019-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -185,8 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Add relational OLAP-like functionality for ActiveRecord