ar_aggregate_by_interval 1.1.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1c961b3ed5d12203cc873a4594870eb7408f5a4
-  data.tar.gz: 0d3bd079ac028864d66b4b69f4908686dff8cf47
+  metadata.gz: 8c7e6ecadea46b5a620c4b4a6f2e86a4bd8cbb7d
+  data.tar.gz: 853b144cabd27a0fdbfbc3567c560a44fdc74bc1
 SHA512:
-  metadata.gz: de4dc421547761903a03d2f2a2d7c20e83dfe702fe1364ed08628ed11ad10d9ac457f3ae554ef90b09ae72dde382b4507042e04654579135f9dc6054c836c057
-  data.tar.gz: 2bf2561984d1adde9aeaad18e99191726d372525aa01ba0f192e58d0ceb219bcecd844ca1673e85349772f192457326480229b5ca0c2ba01d478b10b86041f04
+  metadata.gz: ccc8387f47774bcd549fd82be2c73f378ef4613e87769e0f3d402e75124dd1ca6d6094bf355a835f13149128a5e5cd2bd285d0d91bad4d2d7855bfe036c87c8f
+  data.tar.gz: 1f9eea1a86f3da795c343efeacfea8a944f53cd6f146634e7b702557534a621daf28b727e661f48cc4c28dff6309c1bb37c309e4787d29fb126cf94412a8cc12

data/CHANGELOG.md

@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 This file adheres to [Keep a changelog](http://keepachangelog.com/).
 
+## [1.2.0] - 2015-04-05
+### Added
+- normalize_dates option
+
 ## [1.1.7] - 2015-03-15 (maintenance)
 ### Added
 - Tests for from and to parameters

data/README.md

@@ -1,4 +1,5 @@
-# ArAggregateByInterval (Time series)
+# ArAggregateByInterval
+## ActiveRecord time series
 ---
 
 [![Circle CI](https://circleci.com/gh/jotto/ar_aggregate_by_interval.svg?style=svg)](https://circleci.com/gh/jotto/ar_aggregate_by_interval)
@@ -26,15 +27,22 @@ Blog.avg_weekly(:created_at, :pageviews, 1.month.ago).values
 
 ## Usage
 ```ruby
-# be explicit and pass a hash
-# [:group_by_column, :from, :to, :aggregate_column]
-
-# or just pass arguments
-# count: arg_hash can be arguments: (group_by_col, from, to)
-# sum and avg: arg_hash can be arguments: (group_by_col, aggregate_col, from, to)
-Blog.{count,sum,avg}_{daily,weekly,monthly}(arg_hash).{values,values_and_dates}
+Blog.{count,sum,avg}_{daily,weekly,monthly}(hash_or_arg_list).{values,values_and_dates}`
 ```
 
+### 1. "method_missing" methods on ActiveRecord
+* `{count,sum,avg}_{daily,weekly,monthly}`
+
+### 2. pass hash or argument list
+
+* pass a Hash
+  * `{:group_by_column, :from, :to, :aggregate_column, :normalize_dates}`
+* or pass arguments
+  * when using count: `[group_by_col, from, to, options_hash]`
+  * when using sum or avg: `[group_by_col, aggregate_col, from, to, options_hash]`
+
+### 3. methods you can call: `#values` or `#values_and_dates`
+
 ```ruby
 #values //(returns an array of numerics)
 => [4, 2, 15, 0, 10]
@@ -72,3 +80,6 @@ Billing.sum_weekly({
   to: Time.zone.now
 }).values_and_dates
 ```
+
+## Options
+* `normalize_dates` defaults to `True` which means the `from` argument is converted to beginning_of_{day,week,month} and the `to` argument is converted to end_of_{day,week,month}

data/lib/ar_aggregate_by_interval.rb

@@ -17,7 +17,7 @@ module ArAggregateByInterval
 
     hash_args = if args.size == 1 && args.first.is_a?(Hash)
       args.first
-    elsif args.size > 1 && !args.any?{ |a| a.is_a?(Hash) }
+    elsif args.size > 1 && !args[0..-2].any?{ |a| a.is_a?(Hash) }
       Utils.args_to_hash(aggregate_function, interval, *args)
     else
       nil

data/lib/ar_aggregate_by_interval/query_result.rb

@@ -11,9 +11,6 @@ module ArAggregateByInterval
     VALID_HASH_ARGS = {
       date_values_hash: [Hash],
 
-      # # hash with 1 key where the key is a date column and value is the column being aggegated
-      # ar_result_select_col_mapping: -> (v) { v.is_a?(Hash) && v.size == 1 },
-
       from: [Date, DateTime, Time, ActiveSupport::TimeWithZone],
       to: [Date, DateTime, Time, ActiveSupport::TimeWithZone],
 
@@ -23,7 +20,6 @@ module ArAggregateByInterval
     def initialize(hash_args)
       ClassyHash.validate(hash_args, VALID_HASH_ARGS)
 
-      # @dates_values_hash = Utils.ar_to_hash(args[:ar_result], args[:ar_result_select_col_mapping])
       @dates_values_hash = hash_args[:date_values_hash]
       @date_iterator_method = Utils::DATE_ITERATOR_METHOD_MAP[hash_args[:interval]]
 
@@ -49,15 +45,6 @@ module ArAggregateByInterval
 
     private
 
-    # def validate_args!(hash_args)
-    #   ClassyHash.validate(hash_args, VALID_HASH_ARGS)
-    #   first_res = hash_args[:ar_result].first
-    #   keys = hash_args[:ar_result_select_col_mapping].to_a.flatten
-    #   if first_res && keys.any? { |key| !first_res.respond_to?(key) }
-    #     raise RuntimeError.new("the collection passed does not respond to all attribs: #{keys}")
-    #   end
-    # end
-
     def array_of_dates
       @array_of_dates ||= @from.to_date.send(@date_iterator_method, @to.to_date).map do |date|
         [date, date.strftime(@strftime_format)]

data/lib/ar_aggregate_by_interval/query_runner.rb

@@ -16,7 +16,9 @@ module ArAggregateByInterval
       from: [Date, DateTime, Time, ActiveSupport::TimeWithZone],
       to: [:optional, Date, DateTime, Time, ActiveSupport::TimeWithZone],
 
-      aggregate_column: [:optional, Symbol, NilClass] # required when using sum (as opposed to count)
+      aggregate_column: [:optional, Symbol, NilClass], # required when using sum (as opposed to count)
+
+      normalize_dates: [:optional, TrueClass, FalseClass]
     }
 
     attr_reader :values, :values_and_dates, :from, :to, :interval
@@ -27,8 +29,15 @@ module ArAggregateByInterval
 
       @ar_model = ar_model
 
-      @from = normalize_from(hash_args[:from], hash_args[:interval])
-      @to = normalize_to(hash_args[:to] || Time.zone.try(:now) || Time.now, hash_args[:interval])
+      @from = hash_args[:from]
+      @to = hash_args[:to] || Time.zone.try(:now) || Time.now
+
+      # by default, change dates to beginning and end of interval
+      # e.g. beginning and end of {day,week,month}
+      if hash_args[:normalize_dates] != false
+        @from = normalize_from(@from, hash_args[:interval])
+        @to = normalize_to(@to, hash_args[:interval])
+      end
 
       @db_vendor_select =
         Utils.select_for_grouping_column(hash_args[:group_by_column])[hash_args[:interval]]

data/lib/ar_aggregate_by_interval/utils.rb

@@ -11,19 +11,18 @@ module ArAggregateByInterval
 
     # support legacy arguments (as opposed to direct hash)
     # can do:
-    # ArModel.count_weekly(:group_by_col, :from, :to, :return_dates_bool)
-    # ArModel.count_weekly(:from, :to, :return_dates_bool) # defaults to :created_at
+    # ArModel.count_weekly(:group_by_col, :from, :to, :options_hash)
+    # ArModel.count_weekly(:from, :to, :options_hash) # defaults to :created_at
     # or
-    # ArModel.sum_weekly(:group_by_col, :aggregate_col, :from, :to, :return_dates_bool)
+    # ArModel.sum_weekly(:group_by_col, :aggregate_col, :from, :to, :options_hash)
     def args_to_hash(sum_or_count, daily_weekly_monthly, *args)
-      group_by_column, aggregate_column, from, to, return_dates = args
+      group_by_column, aggregate_column, from, to, options_hash = args
 
       group_by_column ||= 'created_at'
-      return_dates ||= false
 
       if sum_or_count == 'count'
         if aggregate_column.present? && (aggregate_column.is_a?(Date) || aggregate_column.is_a?(Time))
-          return_dates = to
+          options_hash = to
           to = from
           from = aggregate_column
           aggregate_column = nil
@@ -32,19 +31,16 @@ module ArAggregateByInterval
         raise ArgumentError, "aggregate_column cant be nil with #{sum_or_count}"
       end
 
-      return {
+      if !options_hash.nil? && !options_hash.is_a?(Hash)
+        raise ArgumentError, 'last argument must be options hash'
+      end
+
+      return (options_hash || {}).merge({
         group_by_column: group_by_column.try(:intern),
         from: from,
         to: to,
         aggregate_column: aggregate_column.try(:intern)
-      }.delete_if { |k, v| v.nil? }
-    end
-
-    def ar_to_hash(ar_result, mapping)
-      ar_result.to_a.inject({}) do |memo, ar_obj|
-        mapping.each { |key, val| memo.merge!(ar_obj.send(key).to_s => ar_obj.send(val)) }
-        memo
-      end
+      }).delete_if { |k, v| v.nil? }
     end
 
     def ruby_strftime_map

data/lib/ar_aggregate_by_interval/version.rb

@@ -1,3 +1,3 @@
 module ArAggregateByInterval
-  VERSION = '1.1.7'
+  VERSION = '1.2.0'
 end

data/spec/lib/ar_aggregate_by_interval_spec.rb

@@ -15,7 +15,7 @@ describe ArAggregateByInterval do
       @from = DateTime.parse '2013-08-05'
       @to = @from
       blog1 = Blog.create! arbitrary_number: 10, created_at: @from
-      blog2 = Blog.create! arbitrary_number: 20, created_at: @from
+      blog2 = Blog.create! arbitrary_number: 20, created_at: @from + 1.day
 
       # extra row that should not be included in any of the calculations
       # verifying that the from and to parameters are working
@@ -61,6 +61,21 @@ describe ArAggregateByInterval do
 
     context 'hash args' do
 
+      context 'with normalize dates disabled' do
+        subject do
+          Blog.count_weekly({
+            group_by_column: :created_at,
+            from: @from,
+            to: @to,
+            normalize_dates: false
+          })
+        end
+
+        it "does not change dates on #{db_config}" do
+          expect(subject.values_and_dates).to eq([date: @from.to_date, value: 1])
+        end
+      end
+
       context 'for count' do
         subject do
           Blog.count_weekly({
@@ -112,6 +127,18 @@ describe ArAggregateByInterval do
 
     context 'normal args' do
 
+      context 'with normalize dates disabled' do
+        subject do
+          Blog.count_weekly(:created_at, @from, @from, {
+            normalize_dates: false
+          })
+        end
+
+        it "does not change dates on #{db_config}" do
+          expect(subject.values_and_dates).to eq([date: @from.to_date, value: 1])
+        end
+      end
+
       context 'with to' do
         subject do
           Blog.count_weekly(:created_at, @from, @from)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_aggregate_by_interval
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.2.0
 platform: ruby
 authors:
 - Jonathan Otto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler