active_reporting 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63bda6ce4591fc9695b29db8e53aee19966e3630e9c8b059c686678043f20938
-  data.tar.gz: e780a77254b8c8b1cc23ecc732146d581def733fef8669fc3a0419e32fabf5df
+  metadata.gz: bc7dff49fb9bffe3ea663751a710d20343a8dd6a218a088433e772884ab3412b
+  data.tar.gz: 9c03f8ed6f0247d911da6290b120c8b74643cc780761585cd8b0b85ef4a55ff3
 SHA512:
-  metadata.gz: 89718eab7d4398d77f9d19de7e7160e52feebfc295e03a7c05a113a87159e5e3640b599d681559c53e749bf68bdcee477effff6b4b605c4dcf317da6c09d2cdd
-  data.tar.gz: 4d999fe0374b28e826edbb6f6eca9fc9f8ab9ae7aff1056aa88757079e00847f8361862108ba65227f530b72fa918e849dd3bbfe1b337156a685dd4f26b706d8
+  metadata.gz: 4c48dae4c7a6a5389241ef0ee3d01038073d2c75582b8b60aaa93be0e41a3e70abc84f87d609071bca9e86b72968a842f65af199d1a7f7f84e8c449ab720cf9e
+  data.tar.gz: 003b8752db40a55ac09dde37d6f32d21bc14d921c88011393339b4f59554dedfe10557d49545f929d5ea1c7f5a64911fd1fda9fc5bf0d67823e9b68eae9396c1

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/tests.yml

@@ -0,0 +1,150 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+env:
+  POSTGRES_USER: postgres
+  POSTGRES_PASSWORD: postgres
+  PGPASSWORD: postgres
+  POSTGRES_HOST: localhost
+  MYSQL_HOST: '127.0.0.1'
+  MYSQL_USER: 'root'
+
+jobs:
+  tests:
+    services:
+      pg:
+        image: postgres:12
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports: ['5432:5432']
+      mysql:
+        image: mysql:5.7
+        env:
+            MYSQL_ALLOW_EMPTY_PASSWORD: yes
+            MYSQL_DATABASE: active_reporting_test
+        ports:
+            - 3306
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: '3.0'
+            gemfile: '6.1'
+            db: 'mysql'
+
+          - ruby: '3.0'
+            gemfile: '6.1'
+            db: 'pg'
+
+          - ruby: '3.0'
+            gemfile: '6.1'
+            db: 'sqlite'
+
+          - ruby: '3.0'
+            gemfile: '7.0'
+            db: 'mysql'
+
+          - ruby: '3.0'
+            gemfile: '7.0'
+            db: 'pg'
+
+          - ruby: '3.0'
+            gemfile: '7.0'
+            db: 'sqlite'
+
+          - ruby: '3.1'
+            gemfile: '7.0'
+            db: 'mysql'
+
+          - ruby: '3.1'
+            gemfile: '7.0'
+            db: 'pg'
+
+          - ruby: '3.1'
+            gemfile: '7.0'
+            db: 'sqlite'
+
+          - ruby: '3.2'
+            gemfile: '7.0'
+            db: 'mysql'
+
+          - ruby: '3.2'
+            gemfile: '7.0'
+            db: 'pg'
+
+          - ruby: '3.2'
+            gemfile: '7.0'
+            db: 'sqlite'
+
+          - ruby: '3.3'
+            gemfile: '7.0'
+            db: 'mysql'
+
+          - ruby: '3.3'
+            gemfile: '7.0'
+            db: 'pg'
+
+          - ruby: '3.3'
+            gemfile: '7.0'
+            db: 'sqlite'
+
+          - ruby: '3.2'
+            gemfile: '7.1'
+            db: 'mysql'
+
+          - ruby: '3.2'
+            gemfile: '7.1'
+            db: 'pg'
+
+          - ruby: '3.2'
+            gemfile: '7.1'
+            db: 'sqlite'
+
+          - ruby: '3.3'
+            gemfile: '7.1'
+            db: 'mysql'
+
+          - ruby: '3.3'
+            gemfile: '7.1'
+            db: 'pg'
+
+          - ruby: '3.3'
+            gemfile: '7.1'
+            db: 'sqlite'
+    name: rails ${{ matrix.gemfile }}, ruby ${{ matrix.ruby }}, ${{ matrix.db }}
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: false
+
+    - name: Bundle install
+      env:
+        DB: ${{ matrix.db }}
+        RAILS: ${{ matrix.gemfile }}
+      run: |
+        bundle install --jobs 4 --retry 3
+    - name: Create PG DB
+      run: |
+        psql -c 'create database active_reporting_test;' -U postgres -h localhost
+    - name: Run tests
+      env:
+        MYSQL_PORT: ${{ job.services.mysql.ports['3306'] }}
+        DB: ${{ matrix.db }}
+        RAILS: ${{ matrix.gemfile }}
+      run: |
+        bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.6.2 (2024-03-18)
+
+### Features
+
+* `Metric` can now take an optional `measure` argument to override the measure that would normally be used.
+
+## 0.6.1 (2020-08-29)
+
+### Misc
+
+* Add `date` as an option for datetime drills - *germanotm*
+
 ## 0.6.0 (2020-08-21)
 
 ### Features

data/Gemfile

@@ -4,12 +4,14 @@ gemspec
 
 gem 'simplecov', require: false
 
-rails = ENV['RAILS'] || '5-2'
+rails = ENV['RAILS'] || '6.1'
 db = ENV['DB'] || 'sqlite'
 
 case rails
-when '5-2'
-  gem 'activerecord', '~> 5.2.0'
-when '6-0'
-  gem 'activerecord', '~> 6.0.0'
+when '6.1'
+  gem 'activerecord', '~> 6.1.0'
+when '7.0'
+  gem 'activerecord', '~> 7.0.0'
+when '7.1'
+  gem 'activerecord', '~> 7.1.0'
 end

data/README.md

@@ -1,6 +1,4 @@
-[![Build Status](https://travis-ci.org/t27duck/active_reporting.svg?branch=master)](https://travis-ci.org/t27duck/active_reporting)
-
-[![Code Climate](https://codeclimate.com/github/t27duck/active_reporting/badges/gpa.svg)](https://codeclimate.com/github/t27duck/active_reporting)
+![Build Status](https://github.com/t27duck/active_reporting/workflows/CI/badge.svg)
 
 # ActiveReporting
 
@@ -8,9 +6,9 @@ ActiveReporting implements various terminology used in Relational Online Analyti
 
 ActiveReporting officially supports MySQL, PostgreSQL, and SQLite.
 
-ActiveReporting officially supports Ruby 2.5 and later. Other versions may work, but are not supported.
+ActiveReporting officially supports Ruby 3.0 and later. Other versions may work, but are not supported.
 
-ActiveReporting officially supports Rails 5.2, and 6.0. Other versions may work, but are not supported.
+ActiveReporting officially supports Rails 6.1 - 7.1. Other versions may work, but are not supported.
 
 ## Installation
 
@@ -250,6 +248,7 @@ When creating a metric, ActiveReporting will recognize the following datetime hi
 - decade
 - century
 - millennium
+- date
 
 Under the hood Active Reporting uses specific database functions to manipulate datetime columns. Postgres provides a way to group by `datetime` column data on the fly using the [`date_trunc` function](https://www.postgresql.org/docs/8.1/static/functions-datetime.html#FUNCTIONS-DATETIME-TRUNC). On Mysql this can be done using [Date and Time Functions](https://dev.mysql.com/doc/refman/8.0/en/date-and-time-functions.html).
 
@@ -307,7 +306,7 @@ my_metric = ActiveReporting::Metric.new(
 
 You may pass a hash instead of a symbol to customize the dimension options (example: { dimension_name: { option1: value, option2: value}}). The avaliable options are:
 
-- `field` - Specify the hierarchy level that should be used instead the default dimension label. Ex: `[:sales_rep, {mobile_phone: { field :manufacture }}]`. If you use a hash instead of a Symbol to define a hierarchy the `field` item must be a valid field in your table.
+- `field` - Specify the hierarchy level that should be used instead the default dimension label. Ex: `[:sales_rep, {mobile_phone: { field: :manufacture }}]`. If you use a hash instead of a Symbol to define a hierarchy the `field` item must be a valid field in your table.
 
 - `name` - You may costumize the label alias, by default the dimension name will be used. The `name` can be whatever label you want. Ex :`[{sale_date: { field: :month, name: :a_custom_name_for_month }}]`.
 
@@ -319,6 +318,8 @@ You may pass a hash instead of a symbol to customize the dimension options (exam
 
 `metric_filter` - An additional HAVING clause to be tacked on to the end of the query. This allows for the further filtering of the end results based on the value of the aggregate. (Examples: `{gt: 3}`, `{eq: 5}`, `{lte: 7}`)
 
+`measure` - Override the measure on the `ActiveReporting::Factmodel` used.
+
 `order_by_dimension` - Allows you to set the ordering of the results based on a dimension label. (Examples: `{author: :desc}`, `{sales_ref: :asc}`)
 
 For those using Postgres, you can take advantage of implicit hierarchies in `datetime` columns, as mentioned above:

data/lib/active_reporting/metric.rb

@@ -7,7 +7,8 @@ module ActiveReporting
   class Metric
     extend Forwardable
     def_delegators :@fact_model, :model
-    attr_reader :fact_model, :name, :dimensions, :dimension_filter, :aggregate, :metric_filter, :order_by_dimension
+    attr_reader :fact_model, :name, :dimensions, :dimension_filter, :aggregate
+    attr_reader :metric_filter, :order_by_dimension, :measure
 
     def initialize(
       name,
@@ -16,7 +17,8 @@ module ActiveReporting
       dimensions: [],
       dimension_filter: {},
       metric_filter: {},
-      order_by_dimension: {}
+      order_by_dimension: {},
+      measure: nil
     )
       @name               = name.to_sym
       @fact_model         = fact_model
@@ -25,6 +27,7 @@ module ActiveReporting
       @metric_filter      = metric_filter
       @dimensions         = ReportingDimension.build_from_dimensions(@fact_model, Array(dimensions))
       @order_by_dimension = order_by_dimension
+      @measure            = measure
       check_dimension_filter
     end
 

data/lib/active_reporting/report.rb

@@ -81,10 +81,14 @@ module ActiveReporting
       when :count
         'COUNT(*)'
       else
-        "#{@metric.aggregate.to_s.upcase}(#{fact_model.measure})"
+        "#{@metric.aggregate.to_s.upcase}(#{measure})"
       end
     end
 
+    def measure
+      @metric.measure || fact_model.measure
+    end
+
     def dimension_joins(join_method)
       @dimensions.select { |d| d.type == Dimension::TYPES[:standard] && d.join_method == join_method }.
                   map { |d| d.name.to_sym }

data/lib/active_reporting/reporting_dimension.rb

@@ -8,7 +8,7 @@ module ActiveReporting
     # Values for the Postgres `date_trunc` method.
     # 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
+                              century millennium date].freeze
     JOIN_METHODS = { joins: :joins, left_outer_joins: :left_outer_joins }.freeze
     attr_reader :join_method, :label
 
@@ -188,7 +188,12 @@ module ActiveReporting
     end
 
     def datetime_drill_postgress(column)
-      "DATE_TRUNC('#{@datetime_drill}', #{column})"
+      case @datetime_drill.to_sym
+      when :date
+        "DATE('#{column}')"
+      else
+        "DATE_TRUNC('#{@datetime_drill}', #{column})"
+      end
     end
 
     def datetime_drill_mysql(column)
@@ -219,6 +224,8 @@ module ActiveReporting
         "YEAR(#{column}) DIV 100"
       when :millennium
         "YEAR(#{column}) DIV 1000"
+      when :date
+        "DATE(#{column})"
       end
     end
 

data/lib/active_reporting/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_reporting
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Tony Drake
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2024-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -143,10 +143,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Add relational OLAP-like functionality for ActiveRecord

data/.codeclimate.yml

@@ -1,15 +0,0 @@
-engines:
-  duplication:
-    enabled: true
-    config:
-      languages:
-      - ruby
-  fixme:
-    enabled: true
-  rubocop:
-    enabled: true
-ratings:
-  paths:
-  - "**.rb"
-exclude_paths:
-- test/

data/.travis.yml

@@ -1,20 +0,0 @@
-sudo: false
-language: ruby
-services:
-  - mysql
-addons:
-  postgresql: "9.6"
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
-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
-before_script:
-  - psql -c 'create database active_reporting_test;' -U postgres
-  - mysql -e 'create database active_reporting_test collate utf8_general_ci;'