ar_aggregate_by_interval 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0941adcd198c82ec6bdd4d87187e6403f6738f6a
-  data.tar.gz: eb241530407ea9d26228d8637bdcdcfe3d07c477
+  metadata.gz: 600ccd6f3d13f4614f3be8a977397114501d1587
+  data.tar.gz: 00eff7b135ab7af2bf368cad7c46ccc6a6e40bd6
 SHA512:
-  metadata.gz: d29b854bc1a7265a68bfdee328618b7bef4cf550869536c10d065560a6ff6129bbd8b98d8f91fe4abcb254ac6942f11d84f953e807e5829c0c95577929d3f489
-  data.tar.gz: d5376e25140ee0d4d79d7b3614a4582ab8d80bca67a39850a648fd4e4e5e88049f81423cc6083935536baeca8777a07cfce10dc4354074d9be23cef748eb93b2
+  metadata.gz: ba67a323ed7e60c81d39cf2c751b2fe3c696bd51be706470bd567efdc90603bd8cd805fda3dfe155157a833bc9b957fa1bbd072eb274377549636f3f87e8b19f
+  data.tar.gz: 13c00d4056ea7d4fd49d2b4a12545f8a378614b21e1e427d6c1330e9f69ed1f4a75b8923049d85c4deda9423158560ad1d632050ffc80880baa708bb617c7e09

data/lib/ar_aggregate_by_interval.rb

@@ -24,6 +24,11 @@ module ArAggregateByInterval
 
     return super unless hash_args
 
+    # convert strings to symbols
+    [:group_by_column, :aggregate_column].each do |col|
+      hash_args[col] = hash_args[col].intern if hash_args[col]
+    end
+
     QueryRunner.new(self, {
       aggregate_function: aggregate_function,
       interval: interval
@@ -36,4 +41,4 @@ end
 # for queries on the class
 ActiveRecord::Base.send :extend, ArAggregateByInterval
 # for scoped queries
-ActiveRecord::Relation.send :include, ArAggregateByInterval
+ActiveRecord::Relation.send :include, ArAggregateByInterval

data/lib/ar_aggregate_by_interval/query_result.rb

@@ -9,7 +9,7 @@ module ArAggregateByInterval
   class QueryResult
 
     VALID_HASH_ARGS = {
-      ar_result: -> (v) { v.class.name == 'ActiveRecord::Relation' },
+      ar_result: -> (v) { v.respond_to?(:to_a) },
 
       # 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 },
@@ -21,7 +21,7 @@ module ArAggregateByInterval
     }
 
     def initialize(args)
-      ClassyHash.validate(args, VALID_HASH_ARGS)
+      validate_args!(args)
 
       @dates_values_hash = Utils.ar_to_hash(args[:ar_result], args[:ar_result_select_col_mapping])
       @date_iterator_method = Utils::DATE_ITERATOR_METHOD_MAP[args[:interval]]
@@ -44,6 +44,15 @@ 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)]
@@ -52,4 +61,4 @@ module ArAggregateByInterval
 
   end
 
-end
+end

data/lib/ar_aggregate_by_interval/query_runner.rb

@@ -11,12 +11,12 @@ module ArAggregateByInterval
     VALID_HASH_ARGS = {
       aggregate_function: [String], # sum, count
       interval: [String], # daily, weekly, monthly
-      group_by_column: [String], # i.e.: created_at
+      group_by_column: [Symbol], # i.e.: :created_at
 
       from: [Date, DateTime, Time, ActiveSupport::TimeWithZone],
       to: [:optional, Date, DateTime, Time, ActiveSupport::TimeWithZone],
 
-      aggregate_column: [:optional, String, NilClass] # required when using sum (as opposed to count)
+      aggregate_column: [:optional, Symbol, NilClass] # required when using sum (as opposed to count)
     }
 
     attr_reader :values, :values_and_dates

data/lib/ar_aggregate_by_interval/utils.rb

@@ -33,10 +33,10 @@ module ArAggregateByInterval
       end
 
       return {
-        group_by_column: group_by_column,
+        group_by_column: group_by_column.try(:intern),
         from: from,
         to: to,
-        aggregate_column: aggregate_column
+        aggregate_column: aggregate_column.try(:intern)
       }.delete_if { |k, v| v.nil? }
     end
 

data/lib/ar_aggregate_by_interval/version.rb

@@ -1,3 +1,3 @@
 module ArAggregateByInterval
-  VERSION = '1.1.0'
+  VERSION = '1.1.2'
 end

data/spec/ar_bootstrap/init.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+load File.join(File.dirname(__FILE__), './schema.rb')
+
+class Blog < ActiveRecord::Base
+  has_many :page_views
+end
+
+class PageView < ActiveRecord::Base
+  belongs_to :blog
+end

data/spec/{schema.rb → ar_bootstrap/schema.rb}

@@ -3,9 +3,15 @@
 ActiveRecord::Schema.define do
   self.verbose = false
 
-  create_table :blogs, :force => true do |t|
+  create_table :blogs, force: true do |t|
     t.integer :arbitrary_number
     t.timestamps null: false
   end
 
-end
+  create_table :page_views, force: true do |t|
+    t.references :blog
+    t.datetime :date
+    t.integer :count
+  end
+
+end

data/spec/lib/ar_aggregate_by_interval/query_runner_spec.rb

@@ -1,9 +1,4 @@
 require 'ar_aggregate_by_interval/query_runner'
-require 'active_record'
-ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
-load File.join(File.dirname(__FILE__), '../../schema.rb')
-
-class Blog < ActiveRecord::Base; end
 
 module ArAggregateByInterval
   describe QueryRunner do
@@ -13,7 +8,7 @@ module ArAggregateByInterval
         aggregate_function: aggregate_function,
         aggregate_column: (aggregate_column rescue nil),
         interval: interval,
-        group_by_column: 'created_at',
+        group_by_column: :created_at,
         from: from,
         to: to
       })
@@ -36,7 +31,7 @@ module ArAggregateByInterval
       context 'avg daily' do
         let(:interval) { 'daily' }
         let(:aggregate_function) { 'avg' }
-        let(:aggregate_column) { 'arbitrary_number' }
+        let(:aggregate_column) { :arbitrary_number }
 
         describe '.values' do
           it 'returns an array of size 7' do
@@ -68,4 +63,4 @@ module ArAggregateByInterval
     end
   end
 
-end
+end

data/spec/lib/ar_aggregate_by_interval_spec.rb

@@ -1,26 +1,22 @@
-require 'active_record'
 require 'ar_aggregate_by_interval'
-ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
-load File.join(File.dirname(__FILE__), '../schema.rb')
-
-class Blog < ActiveRecord::Base; end
 
 describe ArAggregateByInterval do
 
   before(:all) do |example|
     @from = DateTime.parse '2013-08-05'
     @to = @from
-    Blog.create arbitrary_number: 10, created_at: @from
+    blog = Blog.create arbitrary_number: 10, created_at: @from
+    blog.page_views.create date: @from
   end
 
   shared_examples_for 'count .values_and_dates' do
-    it 'returns value and date with expected values' do 
+    it 'returns value and date with expected values' do
       expect(subject.values_and_dates).to eq([date: @from.beginning_of_week.to_date, value: 1])
     end
   end
 
   shared_examples_for 'sum .values_and_dates' do
-    it 'returns value and date with expected values' do 
+    it 'returns value and date with expected values' do
       expect(subject.values_and_dates).to eq([date: @from.beginning_of_week.to_date, value: 10])
     end
   end
@@ -31,9 +27,18 @@ describe ArAggregateByInterval do
     end
   end
 
-  context 'scoped' do
+  context 'ActiveRecord::Relation scoped' do
+    subject do
+      # `where` returns ActiveRecord::Relation
+      Blog.where('id > 0').count_weekly(:created_at, @from, @from)
+    end
+    it_behaves_like 'count .values_and_dates'
+  end
+
+  context 'Array scoped' do
     subject do
-      Blog.where('id > 0').count_weekly('created_at', @from, @from)
+      # `associations` return arrays
+      Blog.first.page_views.count_weekly(:date, @from, @from)
     end
     it_behaves_like 'count .values_and_dates'
   end
@@ -43,7 +48,7 @@ describe ArAggregateByInterval do
     context 'for count' do
       subject do
         Blog.count_weekly({
-          group_by_column: 'created_at',
+          group_by_column: :created_at,
           from: @from,
           to: @to
         })
@@ -54,20 +59,32 @@ describe ArAggregateByInterval do
     context 'for sum' do
       subject do
         Blog.sum_weekly({
-          group_by_column: 'created_at',
-          aggregate_column: 'arbitrary_number',
+          group_by_column: :created_at,
+          aggregate_column: :arbitrary_number,
           from: @from,
           to: @to
         })
       end
       it_behaves_like 'sum .values_and_dates'
+
+      context 'with strings' do
+        subject do
+          Blog.sum_weekly({
+            group_by_column: 'created_at',
+            aggregate_column: 'arbitrary_number',
+            from: @from,
+            to: @to
+          })
+        end
+        it_behaves_like 'sum .values_and_dates'
+      end
     end
 
     context 'for avg' do
       subject do
         Blog.avg_weekly({
-          group_by_column: 'created_at',
-          aggregate_column: 'arbitrary_number',
+          group_by_column: :created_at,
+          aggregate_column: :arbitrary_number,
           from: @from,
           to: @to
         })
@@ -80,19 +97,26 @@ describe ArAggregateByInterval do
   context 'normal args' do
     context 'for count' do
       subject do
-        Blog.count_weekly('created_at', @from, @from)
+        Blog.count_weekly(:created_at, @from, @from)
       end
       it_behaves_like 'count .values_and_dates'
     end
     context 'for sum' do
       subject do
-        Blog.sum_weekly('created_at', 'arbitrary_number', @from, @from)
+        Blog.sum_weekly(:created_at, :arbitrary_number, @from, @from)
       end
       it_behaves_like 'sum .values_and_dates'
+
+      context 'with strings' do
+        subject do
+          Blog.sum_weekly('created_at', 'arbitrary_number', @from, @from)
+        end
+        it_behaves_like 'sum .values_and_dates'
+      end
     end
     context 'for avg' do
       subject do
-        Blog.avg_weekly('created_at', 'arbitrary_number', @from, @from)
+        Blog.avg_weekly(:created_at, :arbitrary_number, @from, @from)
       end
       it_behaves_like 'avg .values_and_dates'
     end
@@ -101,7 +125,7 @@ describe ArAggregateByInterval do
   context 'bad args' do
     context 'for count' do
       subject do
-        Blog.count_weekly('created_at', {}, {})
+        Blog.count_weekly(:created_at, {}, {})
       end
       it 'raise NoMethodError' do
         expect do
@@ -112,7 +136,7 @@ describe ArAggregateByInterval do
 
     context 'for sum' do
       subject do
-        Blog.sum_weekly('created_at', @from, @from)
+        Blog.sum_weekly(:created_at, @from, @from)
       end
       it 'raise NoMethodError' do
         expect do
@@ -122,4 +146,4 @@ describe ArAggregateByInterval do
     end
   end
 
-end
+end

data/spec/spec_helper.rb

@@ -101,3 +101,5 @@ RSpec.configure do |config|
   Kernel.srand config.seed
 =end
 end
+
+require 'ar_bootstrap/init'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ar_aggregate_by_interval
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Jonathan Otto
@@ -157,10 +157,11 @@ files:
 - lib/ar_aggregate_by_interval/query_runner.rb
 - lib/ar_aggregate_by_interval/utils.rb
 - lib/ar_aggregate_by_interval/version.rb
+- spec/ar_bootstrap/init.rb
+- spec/ar_bootstrap/schema.rb
 - spec/lib/ar_aggregate_by_interval/query_runner_spec.rb
 - spec/lib/ar_aggregate_by_interval/utils_spec.rb
 - spec/lib/ar_aggregate_by_interval_spec.rb
-- spec/schema.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jotto/ar_aggregate_by_interval
 licenses: []
@@ -186,8 +187,9 @@ signing_key:
 specification_version: 4
 summary: add [sum|count]_[daily|weekly|monthly] to your AR models for MySQL AND Postgres
 test_files:
+- spec/ar_bootstrap/init.rb
+- spec/ar_bootstrap/schema.rb
 - spec/lib/ar_aggregate_by_interval/query_runner_spec.rb
 - spec/lib/ar_aggregate_by_interval/utils_spec.rb
 - spec/lib/ar_aggregate_by_interval_spec.rb
-- spec/schema.rb
 - spec/spec_helper.rb