counter 0.5.2 → 0.5.3

data/README.rdoc

@@ -67,11 +67,15 @@ See Counter docs for detail.
     c.increment('another-key')
   end
   
-  # Contribute to totals.
+  # Both contribute to totals grouped by category.
   PageView.totals
   => [['a-key',3],['another-key',1]]
   
-See MovingCount docs for detail.
+  # Get the grand total across all categories.
+  PageView.grand_total
+  => 4
+  
+See MovingCount docs for detail (filters available on totals to limit results).
 
 == Author
 

data/VERSION

@@ -1 +1 @@
-0.5.2
+0.5.3

data/counter.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{counter}
-  s.version = "0.5.2"
+  s.version = "0.5.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Koski"]
-  s.date = %q{2010-07-29}
+  s.date = %q{2010-08-11}
   s.description = %q{count things, either as a one-off or aggregated over time}
   s.email = %q{bkoski@nytimes.com}
   s.extra_rdoc_files = [

data/lib/counter/moving_count.rb

@@ -88,10 +88,49 @@ class MovingCount < ActiveRecord::Base
     true
   end
   
-  # Returns totals across entire history.  Optional limit param restricts resultset.
-  def self.totals limit=nil
-    values = self.connection.select_rows("SELECT category, SUM(count) AS cnt FROM #{self.table_name} GROUP BY category ORDER BY cnt DESC #{"LIMIT #{limit}" if limit};")
+  # Returns single sum across all categories, limited by options.  Use this to get, say, total across all categories matching "http://myhost..."
+  # Optional filters:
+  #  * <tt>:window</tt> limits totaled to samples to those in the past <em>n</em> seconds (can of course specify as 1.hour with ActiveSupport)
+  #  * <tt>:category_like</tt> run a LIKE match against categories before totaling, useful for limiting scope of totals.  '%' wildcards are allowed.
+  def self.grand_total opts={}
+    latest_sample = self.maximum(:sample_time)
+    return 0 if latest_sample.nil? # don't try to run counts against empty db
+
+    q = "SELECT SUM(count) FROM #{self.table_name}"
+    
+    where = []
+    where << self.sanitize_sql(['category LIKE ?', opts[:category_like]])                       if opts[:category_like]
+    where << self.sanitize_sql(['sample_time > ?', latest_sample - opts[:window]]) if opts[:window]
+    
+    q += " WHERE #{where.join(' AND ')}" unless where.empty?
+    
+    self.connection.select_value(q).to_i
+  end
+  
+  # Returns totals grouped by category across entire history.
+  # Optional filters can be used to filter totals:
+  #  * <tt>:limit</tt> limits results to top <em>n</em>
+  #  * <tt>:window</tt> limits totaled to samples to those in the past <em>n</em> seconds (can of course specify as 1.hour with ActiveSupport)
+  #  * <tt>:category_like</tt> run a LIKE match against categories before totaling, useful for limiting scope of totals.  '%' wildcards are allowed.
+  def self.totals opts={}
+    latest_sample = self.maximum(:sample_time)
+    return [] if latest_sample.nil? # don't try to run counts against empty db
+    
+    q  = "SELECT category, SUM(count) AS cnt FROM #{self.table_name}"
+    
+    where = []
+    where << self.sanitize_sql(['category LIKE ?', opts[:category_like]])                       if opts[:category_like]
+    where << self.sanitize_sql(['sample_time > ?', latest_sample - opts[:window]]) if opts[:window]
+    
+    q += " WHERE #{where.join(' AND ')}" unless where.empty?
+    
+    q += ' GROUP BY category'
+    q += ' ORDER BY cnt DESC'
+    q += " LIMIT #{opts[:limit]}" if opts[:limit]
+    
+    values = self.connection.select_rows(q)
     values.map { |v| v[1] = v[1].to_i }
+    
     return values
   end
   

data/test/test_moving_count.rb

@@ -111,12 +111,61 @@ class MovingCountTest < Test::Unit::TestCase
         assert_equal [['http://www.nytimes.com',3],['http://www.nytimes.com/article.html',1]], PageView.totals
       end
       
+      should "match against category_like if provided" do
+        setup_existing_counts(10.minutes)
+        setup_existing_counts(5.minutes)
+        PageView.record_counts { |c| c.saw('http://www.nytimes.com'); c.saw('http://www.nytimes.com/article.html') }
+        
+        assert_equal [['http://www.nytimes.com/article.html',1]],
+                     PageView.totals(:category_like => 'http://www.nytimes.com/article%')
+      end
+      
+      should "filter to window if provided" do
+        setup_existing_counts(10.minutes)
+        setup_existing_counts(5.minutes)
+        
+        assert_equal [['http://www.nytimes.com',1]], PageView.totals(:window => 5.minutes)
+      end
+      
       should "respect limit if provided" do
         setup_existing_counts(10.minutes)
         setup_existing_counts(5.minutes)
         PageView.record_counts { |c| c.saw('http://www.nytimes.com'); c.saw('http://www.nytimes.com/article.html') }
         
-        assert_equal [['http://www.nytimes.com',3]], PageView.totals(1)
+        assert_equal [['http://www.nytimes.com',3]], PageView.totals(:limit => 1)
+      end
+    
+      should "return an empty array if no data has been recorded" do
+        assert_equal [], PageView.totals
+      end
+    end
+    
+    context "grand total" do
+      
+      should "return total sum across all samples" do
+        setup_existing_counts(10.minutes)
+        setup_existing_counts(5.minutes)
+        
+        assert_equal 2, PageView.grand_total
+      end
+      
+      should "match against category_like if providedd" do
+        setup_existing_counts(10.minutes)
+        setup_existing_counts(5.minutes)
+        PageView.record_counts { |c| c.saw('http://www.nytimes.com'); c.saw('http://www.nytimes.com/article.html') }
+        
+        assert_equal 1, PageView.grand_total(:category_like => 'http://www.nytimes.com/article%')
+      end
+      
+      should "filter to window if provided" do
+        setup_existing_counts(10.minutes)
+        setup_existing_counts(5.minutes)
+        
+        assert_equal 1, PageView.grand_total(:window => 5.minutes)
+      end
+      
+      should "return 0 if no data has been recorded" do
+        assert_equal 0, PageView.grand_total
       end
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: counter
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors: 
 - Ben Koski
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-29 00:00:00 -04:00
+date: 2010-08-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency