headcount 0.6.0 → 0.7.0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+# Version 0.7.0 - 2012-04-06
+
+* Added seeding support and ability to get a headcount for any given time
+
+# Version 0.6.0 - 2012-04-06
+
+* What was added?
+
 # Version 0.5.0 - 2012-04-06
 
 * Added timestamping

data/README.md

@@ -25,7 +25,7 @@ Configure Headcount through a rails initializer.  Here's an example:
 # config/initializers/headcount.rb
 Headcount.configure do |config|
   config.path       = 'db/headcount.json' # default
-  config.timestamp  = ''                  # default (YYYY-MM-DD HH:MM:SS)
+  config.timestamp  = '%Y-%m-%d %H:%M:%S' # default (YYYY-MM-DD HH:MM:SS)
   
   # by default Headcount will use the underlying table name for the key
   count User                          # :users key implied
@@ -58,6 +58,23 @@ If you'd like to have the results written to disk instead just use the bang vers
 Headcount.count! # will append the results to the output file
 ```
 
+## Seeding
+
+If you have a history of data that you'd like to generate headcounts you can give the `seed` method a try.
+
+**Notice** For seeding to work your queries must respond to `where` and the underlying table must have a `created_at` column. If resulting historical query is invalid, the headcount will just fall back to the original query.
+
+```
+Headcount.seed(2.years.ago, 1.day) # preview the historical headcounts
+```
+
+If you're happy with the data, simply call the bang version to write it to disk:
+
+```
+Headcount.seed!(2.years.ago, 1.day) # WARNING: this will overwrite any existing data
+```
+
+
 ## Scheduling
 
 Your options are open as far as scheduling goes.  If you like [crontab](http://crontab.org/), use crontab. If you prefer [clockwork](https://github.com/tomykaira/clockwork), use clockwork. 

data/lib/headcount.rb

@@ -2,11 +2,14 @@ require 'headcount/support'
 require 'headcount/registry'
 require 'headcount/persistence'
 require 'headcount/configuration'
+require 'headcount/history'
 require 'headcount/railtie' if defined?(Rails)
 
 module Headcount
   @@registry = Headcount::Registry.new
-
+  
+  include Headcount::History
+  
   class << self
     def register(key, query)
       key.to_sym.tap do |key|
@@ -17,15 +20,23 @@ module Headcount
     def find(key)
       @@registry[key.to_sym]
     end
-
-    def count(key = nil)
-      if key
+    
+    # this method is getting a little messy -- need to clean it up
+    # arg can either be a symbol or a time instance
+    def count(arg = nil)
+      if arg.is_a?(Symbol)
+        key = arg
         count_for(key)
       else
         {}.tap do |headcount|
-          headcount[:timestamp] = Headcount::Support.timestamp_for(DateTime.now)
+          now = DateTime.now
+          time = arg || now
+          headcount[:timestamp] = Headcount::Support.timestamp_for(time)
           
           @@registry.each do |key, query| # using map would return an array here
+            query = query_for_time(query, time) unless time == now
+            query = yield query if block_given? # can alter the query at execution
+            
             headcount[key] = query.count
           end
         end
@@ -33,7 +44,9 @@ module Headcount
     end
 
     def count!
-      persist(count)
+      count.tap do |headcount|
+        persist(headcount)
+      end
     end
     
     def reset

data/lib/headcount/history.rb

@@ -0,0 +1,37 @@
+module Headcount
+  module History
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      def seed(start, interval)
+        time = start
+        now = DateTime.now
+        headcounts = []
+        
+        while time < now
+          headcounts << Headcount.count(time)
+          time += interval
+        end
+        
+        headcounts
+      end
+      
+      def seed!(start, interval)
+        seed(start, interval).tap do |headcounts|
+          persist(headcounts, {:reset => true})
+        end
+      end
+      
+      private
+      def query_for_time(query, time)
+        begin
+          query.where('created_at <= ?', time).tap do |modified_query|
+            modified_query.count # will trigger an error immediately so we can handle it below
+          end
+        rescue
+          query # just return the original query
+        end
+      end
+    end
+  end
+end

data/lib/headcount/persistence.rb

@@ -3,8 +3,9 @@ require 'headcount/persistence/file'
 module Headcount
   class << self
     private
-    def persist(headcount)
-      persistence_handler.save(count)
+    def persist(headcounts, options = {})
+      headcounts = Array.wrap(headcounts)
+      persistence_handler.save(headcounts, options)
     end
   end
 end

data/lib/headcount/persistence/file.rb

@@ -6,9 +6,13 @@ module Headcount
         @format = format
       end
       
-      def save(headcount)
+      def save(headcounts, options = {})
+        ::File.delete(@path) if ::File.exists?(@path) if options[:reset]
+          
         ::File.open(@path, 'a') do |file|
-          file.puts headcount.to_json
+          headcounts.each do |headcount|
+            file.puts headcount.to_json
+          end
         end
       end
     end

data/lib/headcount/version.rb

@@ -1,3 +1,3 @@
 module Headcount
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -2,7 +2,7 @@
 name: headcount
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Ryan Mohr
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-06 00:00:00 Z
+date: 2012-04-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -101,6 +101,7 @@ extra_rdoc_files: []
 files: 
 - lib/headcount/configuration.rb
 - lib/headcount/exceptions.rb
+- lib/headcount/history.rb
 - lib/headcount/persistence/file.rb
 - lib/headcount/persistence.rb
 - lib/headcount/railtie.rb