active_reporting 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3ef7db85c82db17046183576d9a62cfe08acbcc
-  data.tar.gz: ed929413c1768196e855b3116bc76c82df631cc8
+  metadata.gz: a42a126d95b11825c31edc43efd23fb483238266
+  data.tar.gz: 1679cf35f25aeee3f40117ffce4d4b4fdf8be499
 SHA512:
-  metadata.gz: f74516592d42a6494db7f827a1bcbf7391c9d4a5ff44e181205b6bf385a692fa57e62fdfec7005007e606dfb8a65e13f073618670eb3a76f10a6ef64272ceaaf
-  data.tar.gz: 2ff7e312d8f749199fa022e2000e825bfbd6c58174e81be4ef4a7b2dd09c7301cf898f7bb34ef70682fdd1907928333decdee867a358239cd1e401deea084cc2
+  metadata.gz: 2eb0fba1d05b5f482716db8cd47cf165546c35533e061a46d55abc8708359b3ba3f0812db60d68b85cf1375554f25037a6e83ff231db1e988d4b6014e2198431
+  data.tar.gz: d2d2be2376f03a9590142bd732369426510c7f0916bc432f42e82c14e4dcff406a726a8de53ae2a4d7774b8f39e93c3485c54236eafd244dcf8a022a3494f609

data/.travis.yml

@@ -5,20 +5,15 @@ rvm:
   - 2.3.4
   - 2.4.1
 env:
+  - RAILS=5-1 DB=sqlite
+  - RAILS=5-1 DB=pg
+  - RAILS=5-1 DB=mysql
   - RAILS=5-0 DB=sqlite
   - RAILS=5-0 DB=pg
   - RAILS=5-0 DB=mysql
   - RAILS=4-2 DB=sqlite
   - RAILS=4-2 DB=pg
   - RAILS=4-2 DB=mysql
-matrix:
-  exclude:
-    - rvm: 2.2.7
-      env: RAILS=5-0 DB=sqlite
-    - rvm: 2.2.7
-      env: RAILS=5-0 DB=pg
-    - rvm: 2.2.7
-      env: RAILS=5-0 DB=mysql
 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,6 +1,25 @@
+## 0.2.0 (2017-06-17)
+
+### Breaking Changes
+
+* `FactModel.use_model` renamed to `FactModel.model=`
+
+### Bug Fixes
+
+* `metric` lives on fact model and not metric (#3) - *Michael Wheeler (wheeyls)*
+
+### Misc
+
+* Readme corrections and updates (#2) - *Michael Wheeler (wheeyls)*
+
 ## 0.1.1 (2017-04-22)
 
+### Bug Fixes
+
 * Fix MySQL querying
+
+### Misc
+
 * Properly test against multiple dbs and versions of ActiveRecord in CI
 
 ## 0.1.0 (2017-04-16)

data/Gemfile

@@ -4,11 +4,13 @@ gemspec
 
 gem 'simplecov', require: false
 
-rails = ENV['RAILS'] || '5-0'
+rails = ENV['RAILS'] || '5-1'
 
 case rails
 when '4-2'
   gem 'activerecord', '~> 4.2.0'
-else
+when '5-0'
   gem 'activerecord', '~> 5.0.0'
+else
+  gem 'activerecord', '~> 5.1.0'
 end

data/README.md

@@ -37,6 +37,7 @@ ROLAP uses a set of terms to describe how a report is generated. ActiveReporting
 A fact table is the primary table where information is derived from in a report. It commonly contains fact columns (usually numeric values) and dimension columns (foreign keys to other tables or values that can be grouped together).
 
 SQL Equivalent: FROM
+
 Rails: ActiveRecord model
 
 ### Dimension
@@ -49,6 +50,7 @@ Examples:
 * The manufacture on a fact table of widgets
 
 SQL Equivalent: JOIN, GROUP BY
+
 Rails: ActiveRecord relation or attribute
 
 ### Dimension Hierarchy
@@ -71,6 +73,7 @@ Examples:
 This isn't really an official term, but I like using it to describe further filtering of dimensionable data.
 
 SQL Equivalent: WHERE
+
 Rails: `where()`, scopes, etc.
 
 ### Measure
@@ -82,6 +85,7 @@ Examples:
 * Number of units used in a transaction
 
 SQL Equivalent: Column in the fact table used in an aggregation function
+
 Rails: ActiveRecord attribute
 
 ### Metric
@@ -89,6 +93,7 @@ Rails: ActiveRecord attribute
 A metric is a measured value and the subject of the report. It is the result of *the* question you want answered.
 
 SQL Equivalent: A query result
+
 Rails: The result of an ActiveRecord query
 
 ### Star Schema
@@ -147,20 +152,20 @@ Every fact model links to an ActiveRecord model. This is done either by naming c
 This naming convention is `[ModelName]FactModel`. Meaning if you have an ActiveRecord model named `Ticket`, you'll then have a `TicketFactModel` to link them together.
 
 ```ruby
-class TicketFactModel < ActiveRecord::FactModel
+class TicketFactModel < ActiveReporting::FactModel
 
 end
 ```
 
-Alternatively, you may manually specify the model manually with `use_model`
+Alternatively, you may manually specify the model manually with `self.model=`
 
 ```ruby
-class TicketFactModel < ActiveRecord::FactModel
-  use_model SomeOtherModel
+class TicketFactModel < ActiveReporting::FactModel
+  self.model= SomeOtherModel
   # OR you may pass in a string or symbol
-  # use_model :some_other_model
-  # use_model 'some_other_model'
-  # use_model 'SomeOtherModel'
+  # self.model= :some_other_model
+  # self.model= 'some_other_model'
+  # self.model= 'SomeOtherModel'
 end
 ```
 
@@ -170,7 +175,7 @@ ActiveReporting assumes the column of a fact model used for summing, averaging,
 
 ```ruby
 class OrderFactModel < ActiveReporting::FactModel
-  measure = :total
+  self.measure = :total
 end
 ```
 
@@ -258,7 +263,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}]`)
 
 `dimension_filter` - A hash were the keys are dimension filter names and the values are the values passed into the filter.
 
@@ -278,7 +283,7 @@ metric = ActiveReporting::Metric.new(
   dimension_filter: {months_ago: 1}
 )
 
-report = ActiveReporting.new(metric)
+report = ActiveReporting::Report.new(metric)
 report.run
 => [{order_count: 12, sales_rep: 'Fred Jones', sales_rep_identifier: 123},{order_count: 17, sales_rep: 'Mary Sue', sales_rep_identifier: 123}]
 ```

data/lib/active_reporting/active_record_adaptor.rb

@@ -13,7 +13,7 @@ module ActiveReporting
                         const_name.constantize
                       rescue NameError
                         const = Object.const_set(const_name, Class.new(ActiveReporting::FactModel))
-                        const.use_model self
+                        const.model= self
                         const
                       end
     end

data/lib/active_reporting/fact_model.rb

@@ -15,11 +15,11 @@ module ActiveReporting
     #
     # @example
     #   class PostFactModel < ActiveReporting::FactModel
-    #     use_model :post
-    #     use_model Post
-    #     use_model 'post'
+    #     self.model= :post
+    #     self.model= Post
+    #     self.model= 'post'
     #   end
-    def self.use_model(model)
+    def self.model=(model)
       @model = if model.is_a?(String) || model.is_a?(Symbol)
                  model.to_s.classify.constantize
                else

data/lib/active_reporting/report.rb

@@ -78,7 +78,7 @@ module ActiveReporting
       when :count
         'COUNT(*)'
       else
-        "#{@metric.aggregate.to_s.upcase}(#{@metric.measure})"
+        "#{@metric.aggregate.to_s.upcase}(#{fact_model.measure})"
       end
     end
 

data/lib/active_reporting/version.rb

@@ -1,3 +1,3 @@
 module ActiveReporting
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_reporting
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tony Drake
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-23 00:00:00.000000000 Z
+date: 2017-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord