freshtrack 0.3.0 → 0.4.0

data/History.txt

@@ -1,3 +1,11 @@
+== 0.4.0 2008-08-29
+
+* 1 minor enhancement:
+  * Extracted the time-collection concern from Freshtrack itself and created time collectors:
+    * one_inch_punch
+    * punch
+    * More can be easily made
+
 == 0.3.0 2008-08-27
 
 * 1 minor enhancement:

data/Manifest.txt

@@ -12,6 +12,9 @@ lib/freshtrack/core_ext.rb
 lib/freshtrack/core_ext/array.rb
 lib/freshtrack/core_ext/numeric.rb
 lib/freshtrack/core_ext/time.rb
+lib/freshtrack/time_collectors/one_inch_punch.rb
+lib/freshtrack/time_collectors/punch.rb
+lib/freshtrack/time_collectors/punchy_template.rb
 lib/freshbooks/extensions.rb
 lib/freshbooks/extensions/base_object.rb
 lib/freshbooks/extensions/project.rb
@@ -21,15 +24,17 @@ log/debug.log
 script/destroy
 script/generate
 setup.rb
-spec/base_object_spec.rb
+spec/core_ext/array_spec.rb
+spec/core_ext/numeric_spec.rb
+spec/core_ext/time_spec.rb
+spec/time_collectors/one_inch_punch_spec.rb
+spec/time_collectors/punch_spec.rb
+spec/freshbooks/base_object_spec.rb
+spec/freshbooks/project_spec.rb
+spec/freshbooks/task_spec.rb
+spec/freshbooks/time_entry_spec.rb
 spec/freshtrack_command_spec.rb
 spec/freshtrack_spec.rb
-spec/project_spec.rb
-spec/task_spec.rb
-spec/time_entry_spec.rb
-spec/array_spec.rb
-spec/numeric_spec.rb
-spec/time_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
 tasks/deployment.rake

data/README.txt

@@ -8,7 +8,7 @@ Freshtrack is used to automatically create time entries in FreshBooks from your
 
 * Simple and easy to use
 
-* Only works with data from one_inch_punch
+* Modular time-collector system
 
 == SYNOPSIS:
 
@@ -27,12 +27,13 @@ Freshtrack is used to automatically create time entries in FreshBooks from your
 
 == REQUIREMENTS:
 
-* one_inch_punch (gem)
+* a time collector (see below)
 * freshbooks (gem)
 * A FreshBooks account
 * a configuration file located at ~/.freshtrack.yml and looking like
 
   --- 
+  collector: one_inch_punch
   company: Company Name
   token: API Token
   project_task_mapping:
@@ -42,6 +43,9 @@ Freshtrack is used to automatically create time entries in FreshBooks from your
 
 (The 'Company Name' is the XXX in 'XXX.freshbooks.com'. The 'project_name' is the XXX in 'punch list XXX'.)
 
+The 'collector' is what freshtrack will use to gather the time data that will end up as FreshBooks time entries.
+Freshtrack ships with two collectors: 'punch' and 'one_inch_punch'. These are both gems that can be installed (by `gem install [collector name]`) and used without much effort. If these time-tracking tools aren't to your liking, you are free to write your own collector. Further documentation on that is forthcoming, but for now just take a look at the two collectors that already exist.
+
 == INSTALL:
 
 * gem install freshtrack

data/config/hoe.rb

@@ -60,8 +60,7 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   # == Optional
   p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
   p.extra_deps = [     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
-    ['freshbooks', '= 2.1'],
-    ['one_inch_punch', '>= 0.0.3']
+    ['freshbooks', '= 2.1']
   ]
   
   #p.spec_extras = {}    # A hash of extra values to set in the gemspec.

data/lib/freshtrack/time_collectors/one_inch_punch.rb

@@ -0,0 +1,16 @@
+require 'freshtrack/time_collectors/punchy_template'
+require 'punch'
+
+module Freshtrack
+  module TimeCollector
+    class OneInchPunch
+      include PunchyTemplate
+      
+      def get_time_data(project)
+        ::Punch.load
+        time_data = ::Punch.list(project, options)
+        condense_time_data(time_data)
+      end
+    end
+  end
+end

data/lib/freshtrack/time_collectors/punch.rb

@@ -0,0 +1,26 @@
+require 'freshtrack/time_collectors/punchy_template'
+
+module Freshtrack
+  module TimeCollector
+    class Punch
+      include PunchyTemplate
+      
+      def get_time_data(project)
+        time_data = IO.read("| punch list #{project} #{option_str}")
+        converted = convert_time_data(time_data)
+        condense_time_data(converted)
+      end
+      
+      def convert_time_data(time_data)
+        YAML.load(time_data)
+      end
+      
+      
+      private
+      
+      def option_str
+        options.collect { |key, val|  "--#{key} #{val.strftime('%Y-%m-%dT%H:%M:%S%z')}" }.join(' ')
+      end
+    end
+  end
+end

data/lib/freshtrack/time_collectors/punchy_template.rb

@@ -0,0 +1,38 @@
+module Freshtrack
+  module TimeCollector
+    module PunchyTemplate
+      attr_reader :options
+      
+      def initialize(options = {})
+        @options = options
+      end
+      
+      def condense_time_data(time_data)
+        date_data = times_to_dates(time_data)
+        group_date_data(date_data)
+      end
+      
+      def times_to_dates(time_data)
+        time_data.each do |td|
+          punch_in  = td.delete('in')
+          punch_out = td.delete('out')
+
+          td['date']  = punch_in.to_date
+          td['hours'] = (punch_out - punch_in).secs_to_hours
+        end
+      end
+      
+      def group_date_data(date_data)
+        separator = '-' * 20
+        grouped = date_data.group_by { |x|  x['date'] }
+        grouped.sort.inject([]) do |arr, (date, data)|
+          this_date = { 'date' => date }
+          this_date['hours'] = data.inject(0) { |sum, x|  sum + x['hours'] }
+          this_date['hours'] = ('%.2f' % this_date['hours']).to_f
+          this_date['notes'] = data.collect { |x|  x['log'].join("\n") }.join("\n" + separator + "\n")
+          arr + [this_date]
+        end
+      end
+    end
+  end
+end

data/lib/freshtrack/version.rb

@@ -1,7 +1,7 @@
 module Freshtrack #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 3
+    MINOR = 4
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/lib/freshtrack.rb

@@ -2,7 +2,6 @@ $:.unshift File.dirname(__FILE__)
 require 'freshbooks/extensions'
 require 'freshtrack/core_ext'
 require 'yaml'
-require 'punch'
 
 module Freshtrack
   class << self
@@ -37,42 +36,9 @@ module Freshtrack
       raise unless @task
     end
     
-    def get_time_data(project_name, options = {})
-      Punch.load
-      time_data = Punch.list(project_name, options)
-      condense_time_data(time_data)
-    end
-    
-    def condense_time_data(time_data)
-      date_data = times_to_dates(time_data)
-      group_date_data(date_data)
-    end
-    
-    def times_to_dates(time_data)
-      time_data.each do |td|
-        punch_in  = td.delete('in')
-        punch_out = td.delete('out')
-        
-        td['date']  = punch_in.to_date
-        td['hours'] = (punch_out - punch_in).secs_to_hours
-      end
-    end
-    
-    def group_date_data(date_data)
-      separator = '-' * 20
-      grouped = date_data.group_by { |x|  x['date'] }
-      grouped.sort.inject([]) do |arr, (date, data)|
-        this_date = { 'date' => date }
-        this_date['hours'] = data.inject(0) { |sum, x|  sum + x['hours'] }
-        this_date['hours'] = ('%.2f' % this_date['hours']).to_f
-        this_date['notes'] = data.collect { |x|  x['log'].join("\n") }.join("\n" + separator + "\n")
-        arr + [this_date]
-      end
-    end
-    
     def get_data(project_name, options = {})
       get_project_data(project_name)
-      get_time_data(project_name, options)
+      collector(options).get_time_data(project_name)
     end
     
     def track(project_name, options = {})
@@ -100,5 +66,13 @@ module Freshtrack
         nil
       end
     end
+    
+    def collector(options = {})
+      collector_name = config['collector']
+      class_name = collector_name.capitalize.gsub(/([a-z])_([a-z])/) { "#{$1}#{$2.upcase}" }
+      require "freshtrack/time_collectors/#{collector_name}"
+      klass = Freshtrack::TimeCollector.const_get(class_name)
+      klass.new(options)
+    end
   end
 end

data/spec/{array_spec.rb → core_ext/array_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
 
 describe Array do
   it 'should be groupable' do

data/spec/{numeric_spec.rb → core_ext/numeric_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
 
 describe Integer do
   it 'should be convertible from seconds to hours' do

data/spec/{time_spec.rb → core_ext/time_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
 
 describe Time do
   it 'should be convertible to date' do

data/spec/{base_object_spec.rb → freshbooks/base_object_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
 
 Thing     = FreshBooks::BaseObject.new(:attr)
 ThingDeal = FreshBooks::BaseObject.new(:attr)

data/spec/{project_spec.rb → freshbooks/project_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
 
 describe FreshBooks::Project do
   before :each do

data/spec/{task_spec.rb → freshbooks/task_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
 
 describe FreshBooks::Task do
   before :each do

data/spec/{time_entry_spec.rb → freshbooks/time_entry_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
 
 describe FreshBooks::TimeEntry do
   before :each do

data/spec/freshtrack_command_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper.rb')
 
 describe 'freshtrack command' do
   def run_command(*args)

data/spec/freshtrack_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper.rb')
 
 describe Freshtrack do
   describe 'loading configuration' do
@@ -128,273 +128,134 @@ describe Freshtrack do
     end
   end
   
-  describe 'getting time data' do
+  describe 'getting data' do
     before :each do
       @project_name = :proj
-      @time_data = stub('time data')
-      Punch.stubs(:load)
-      Punch.stubs(:list).returns(@time_data)
-      Freshtrack.stubs(:condense_time_data)
+      Freshtrack.stubs(:get_project_data)
+      @collector = stub('collector', :get_time_data => nil)
+      Freshtrack.stubs(:collector).returns(@collector)
     end
     
     it 'should require an argument' do
-      lambda { Freshtrack.get_time_data }.should raise_error(ArgumentError)
+      lambda { Freshtrack.get_data }.should raise_error(ArgumentError)
     end
     
     it 'should accept an argument' do
-      lambda { Freshtrack.get_time_data(@project_name) }.should_not raise_error(ArgumentError)
+      lambda { Freshtrack.get_data(@project_name) }.should_not raise_error(ArgumentError)
     end
     
     it 'should accept options' do
-      lambda { Freshtrack.get_time_data(@project_name, :after => Time.now) }.should_not raise_error(ArgumentError)
+      lambda { Freshtrack.get_data(@project_name, :before => Time.now) }.should_not raise_error(ArgumentError)
     end
     
-    it 'should have punch load the time data' do
-      Punch.expects(:load)
-      Freshtrack.get_time_data(@project_name)
+    it 'should get project data for supplied project' do
+      Freshtrack.expects(:get_project_data).with(@project_name)
+      Freshtrack.get_data(@project_name)
     end
     
-    it 'should get the time data from punch' do
-      Punch.expects(:list)
-      Freshtrack.get_time_data(@project_name)
+    it 'should retrieve a time collector' do
+      Freshtrack.expects(:collector).returns(@collector)
+      Freshtrack.get_data(@project_name)
     end
     
-    it 'should pass the supplied project when getting the time data' do
-      Punch.expects(:list).with(@project_name, anything)
-      Freshtrack.get_time_data(@project_name)
+    it 'should get time data for supplied project' do
+      @collector.expects(:get_time_data).with(@project_name)
+      Freshtrack.get_data(@project_name)
     end
     
-    it 'should pass the supplied options on when getting the time data' do
+    it 'should pass the options on when retrieving a time collector' do
       options = { :after => Time.now - 12345 }
-      Punch.expects(:list).with(@project_name, options)
-      Freshtrack.get_time_data(@project_name, options)
-    end
-    
-    it 'should pass an empty hash by default' do
-      Punch.expects(:list).with(@project_name, {})
-      Freshtrack.get_time_data(@project_name)
-    end
-    
-    it 'should condense the time data' do
-      Freshtrack.expects(:condense_time_data).with(@time_data)
-      Freshtrack.get_time_data(@project_name)
-    end
-    
-    it 'should return the condensed data' do
-      condensed = stub('condensed time data')
-      Freshtrack.stubs(:condense_time_data).returns(condensed)
-      Freshtrack.get_time_data(@project_name).should == condensed
-    end
-  end
-  
-  describe 'condensing time data' do
-    before :each do
-      @time_data = stub('time data')
-      Freshtrack.stubs(:times_to_dates)
-      Freshtrack.stubs(:group_date_data)
-    end
-    
-    it 'should require an argument' do
-      lambda { Freshtrack.condense_time_data }.should raise_error(ArgumentError)
-    end
-    
-    it 'should accept an argument' do
-      lambda { Freshtrack.condense_time_data(@time_data) }.should_not raise_error(ArgumentError)
-    end
-    
-    it 'should convert times to dates and hour differences' do
-      Freshtrack.expects(:times_to_dates).with(@time_data)
-      Freshtrack.condense_time_data(@time_data)
+      Freshtrack.expects(:collector).with(options).returns(@collector)
+      Freshtrack.get_data(@project_name, options)
     end
     
-    it 'should group date and hour differences' do
-      date_hour_data = stub('date/hour data')
-      Freshtrack.stubs(:times_to_dates).returns(date_hour_data)
-      Freshtrack.expects(:group_date_data).with(date_hour_data)
-      Freshtrack.condense_time_data(@time_data)
+    it 'should default options to an empty hash' do
+      Freshtrack.expects(:collector).with({}).returns(@collector)
+      Freshtrack.get_data(@project_name)
     end
     
-    it 'should return the grouped date/hour data' do
-      grouped_dates = stub('grouped date/hour data')
-      Freshtrack.stubs(:group_date_data).returns(grouped_dates)
-      Freshtrack.condense_time_data(@time_data).should == grouped_dates
+    it 'should return time data' do
+      time_data = stub('time data')
+      @collector.stubs(:get_time_data).returns(time_data)
+      Freshtrack.get_data(@project_name).should == time_data
     end
   end
   
-  describe 'converting times to dates and hour differences' do
-    before :each do
-      @time_data = []
-    end
-    
-    it 'should require an argument' do
-      lambda { Freshtrack.times_to_dates }.should raise_error(ArgumentError)
-    end
-    
-    it 'should accept an argument' do
-      lambda { Freshtrack.times_to_dates(@time_data) }.should_not raise_error(ArgumentError)
-    end
-    
-    it 'should return an array' do
-      Freshtrack.times_to_dates(@time_data).should be_kind_of(Array)
-    end
-    
-    it 'should replace the in/out time data with a single date' do
-      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 25, 7,  25, 0) })
-      result = Freshtrack.times_to_dates(@time_data)
-      result = result.first
-      
-      result.should     have_key('date')
-      result.should_not have_key('in')
-      result.should_not have_key('out')
-    end
-    
-    it 'should make the date appopriate to the time' do
-      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 25, 7,  25, 0) })
-      result = Freshtrack.times_to_dates(@time_data)
-      result = result.first
-      result['date'].should == Date.civil(2008, 1, 25)
-    end
-    
-    it 'should use the in time date' do
-      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 26, 7,  25, 0) })
-      result = Freshtrack.times_to_dates(@time_data)
-      result = result.first
-      result['date'].should == Date.civil(2008, 1, 25)
-    end
-    
-    it 'should add hour data' do
-      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 25, 7,  25, 0) })
-      result = Freshtrack.times_to_dates(@time_data)
-      result = result.first
-      result.should have_key('hours')
+  describe 'getting a collector' do
+    module Freshtrack
+      module TimeCollector
+        class Punch
+        end
+        
+        class OneInchPunch
+        end
+      end
     end
     
-    it 'should make the hour data appropriate to the in/out difference' do
-      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 25, 7,  55, 0) })
-      result = Freshtrack.times_to_dates(@time_data)
-      result = result.first
-      result['hours'].should == 1.5
-    end
-  end
-  
-  describe 'grouping date data' do
     before :each do
-      @date_data = []
+      Freshtrack.stubs(:config).returns({'collector' => 'punch' })
+      @collector = stub('collector')
+      Freshtrack::TimeCollector::Punch.stubs(:new).returns(@collector)
     end
     
-    it 'should require an argument' do
-      lambda { Freshtrack.group_date_data }.should raise_error(ArgumentError)
+    it 'should accept options' do
+      lambda { Freshtrack.collector(:before => Time.now) }.should_not raise_error(ArgumentError)
     end
     
-    it 'should accept an argument' do
-      lambda { Freshtrack.group_date_data(@date_data) }.should_not raise_error(ArgumentError)
+    it 'should not require options' do
+      lambda { Freshtrack.collector }.should_not raise_error(ArgumentError)
     end
     
-    it 'should return an array' do
-      Freshtrack.group_date_data(@date_data).should be_kind_of(Array)
+    it 'should require a library based on the collector given in the config' do
+      Freshtrack.expects(:require).with('freshtrack/time_collectors/punch')
+      Freshtrack.collector
     end
     
-    it 'should group the data by date' do
-      today = Date.today
-      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => [] })
-      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => [] })
-      @date_data.push({ 'date' => today + 1, 'hours' => 0, 'log' => [] })
-      Freshtrack.group_date_data(@date_data).collect { |x|  x['date'] }.should == [today, today + 1]
+    it 'should create a collector object based on the collector given in the config' do
+      Freshtrack::TimeCollector::Punch.expects(:new)
+      Freshtrack.collector
     end
     
-    it 'should return the array sorted by date' do
-      today = Date.today
-      @date_data.push({ 'date' => today + 1, 'hours' => 0, 'log' => [] })
-      @date_data.push({ 'date' => today - 1, 'hours' => 0, 'log' => [] })
-      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => [] })
-      @date_data.push({ 'date' => today + 1, 'hours' => 0, 'log' => [] })
-      Freshtrack.group_date_data(@date_data).collect { |x|  x['date'] }.should == [today - 1, today, today + 1]
+    it 'should pass the options on when creating a collector object' do
+      options = { :before => Time.now }
+      Freshtrack::TimeCollector::Punch.expects(:new).with(options)
+      Freshtrack.collector(options)
     end
     
-    it 'should add the hours for a particular date' do
-      today = Date.today
-      @date_data.push({ 'date' => today,     'hours' => 1, 'log' => [] })
-      @date_data.push({ 'date' => today,     'hours' => 3, 'log' => [] })
-      @date_data.push({ 'date' => today + 1, 'hours' => 2, 'log' => [] })
-      result = Freshtrack.group_date_data(@date_data)
-      
-      result[0]['date'].should  == today
-      result[0]['hours'].should == 4
-      
-      result[1]['date'].should  == today + 1
-      result[1]['hours'].should == 2
+    it 'should pass an empty hash if no options given' do
+      Freshtrack::TimeCollector::Punch.expects(:new).with({})
+      Freshtrack.collector
     end
     
-    it 'should round the hours to two decimal places' do
-      today = Date.today
-      @date_data.push({ 'date' => today, 'hours' => 1.666666666, 'log' => [] })
-      result = Freshtrack.group_date_data(@date_data)
-      
-      result[0]['date'].should  == today
-      result[0]['hours'].should == 1.67
+    it 'should return the collector' do
+      Freshtrack.collector.should == @collector
     end
     
-    it 'should join the log into notes' do
-      today = Date.today
-      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => ['punch in 1', 'punch out 1'] })
-      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => ['punch in 2', 'punch out 2'] })
-      @date_data.push({ 'date' => today + 1, 'hours' => 0, 'log' => ['punch in 3', 'punch out 3'] })
-      result = Freshtrack.group_date_data(@date_data)
-      
-      result[0]['date'].should  == today
-      result[0]['notes'].should == "punch in 1\npunch out 1\n--------------------\npunch in 2\npunch out 2"
-      result[0].should_not have_key('log')
-      
-      result[1]['date'].should  == today + 1
-      result[1]['notes'].should == "punch in 3\npunch out 3"
-      result[1].should_not have_key('log')
-    end
-  end
-  
-  describe 'getting data' do
-    before :each do
-      @project_name = :proj
-      Freshtrack.stubs(:get_project_data)
-      Freshtrack.stubs(:get_time_data)
+    it 'should error if no collector is given in the config' do
+      Freshtrack.stubs(:config).returns({})
+      lambda { Freshtrack.collector }.should raise_error
     end
     
-    it 'should require an argument' do
-      lambda { Freshtrack.get_data }.should raise_error(ArgumentError)
+    it "should accept a collector of 'punch'" do
+      Freshtrack.stubs(:config).returns({'collector' => 'punch'})
+      lambda { Freshtrack.collector }.should_not raise_error
     end
     
-    it 'should accept an argument' do
-      lambda { Freshtrack.get_data(@project_name) }.should_not raise_error(ArgumentError)
-    end
-    
-    it 'should accept options' do
-      lambda { Freshtrack.get_data(@project_name, :before => Time.now) }.should_not raise_error(ArgumentError)
-    end
-    
-    it 'should get project data for supplied project' do
-      Freshtrack.expects(:get_project_data).with(@project_name)
-      Freshtrack.get_data(@project_name)
-    end
-    
-    it 'should get time data for supplied project' do
-      Freshtrack.expects(:get_time_data).with(@project_name, anything)
-      Freshtrack.get_data(@project_name)
-    end
-    
-    it 'should pass options on when getting time data' do
-      options = { :after => Time.now - 12345 }
-      Freshtrack.expects(:get_time_data).with(@project_name, options)
-      Freshtrack.get_data(@project_name, options)
+    it "should accept a collector of 'one_inch_punch'" do
+      Freshtrack.stubs(:config).returns({'collector' => 'one_inch_punch'})
+      Freshtrack::TimeCollector::OneInchPunch.stubs(:new)
+      lambda { Freshtrack.collector }.should_not raise_error
     end
     
-    it 'should default options to an empty hash' do
-      Freshtrack.expects(:get_time_data).with(@project_name, {})
-      Freshtrack.get_data(@project_name)
+    it 'should correctly camel-case a collector name' do
+      Freshtrack.stubs(:config).returns({'collector' => 'one_inch_punch'})
+      Freshtrack::TimeCollector::OneInchPunch.expects(:new)
+      Freshtrack.collector
     end
     
-    it 'should return time data' do
-      time_data = stub('time data')
-      Freshtrack.stubs(:get_time_data).returns(time_data)
-      Freshtrack.get_data(@project_name).should == time_data
+    it 'should error if an unknown collector is given in the config' do
+      Freshtrack.stubs(:config).returns({'collector' => 'blam'})
+      lambda { Freshtrack.collector }.should raise_error
     end
   end
   

data/spec/time_collectors/one_inch_punch_spec.rb

@@ -0,0 +1,258 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+require 'freshtrack/time_collectors/one_inch_punch'
+
+describe Freshtrack::TimeCollector::OneInchPunch do
+  before :each do
+    @collector = Freshtrack::TimeCollector::OneInchPunch.new
+  end
+  
+  describe 'when initialized' do
+    it 'should accept options' do
+      lambda { Freshtrack::TimeCollector::OneInchPunch.new(:before => Time.now) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should not require options' do
+      lambda { Freshtrack::TimeCollector::OneInchPunch.new }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should provide access to the given options' do
+      options = { :after => Time.now }
+      Freshtrack::TimeCollector::OneInchPunch.new(options).options.should == options
+    end
+    
+    it 'should default options to an empty hash' do
+      Freshtrack::TimeCollector::OneInchPunch.new.options.should == {}
+    end
+  end
+  
+  it 'should get time data' do
+    @collector.should respond_to(:get_time_data)
+  end
+  
+  describe 'getting time data' do
+    before :each do
+      @project = 'myproj'
+      @time_data = stub('time data')
+      Punch.stubs(:load)
+      Punch.stubs(:list).returns(@time_data)
+      @collector.stubs(:condense_time_data)
+    end
+    
+    it 'should accept a project' do
+      lambda { @collector.get_time_data(@project) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require a project' do
+      lambda { @collector.get_time_data }.should raise_error(ArgumentError)
+    end
+    
+    it 'should have punch load the time data' do
+      Punch.expects(:load)
+      @collector.get_time_data(@project)
+    end
+    
+    it 'should get the time data from punch' do
+      Punch.expects(:list)
+      @collector.get_time_data(@project)
+    end
+    
+    it 'should pass the supplied project when getting the time data' do
+      Punch.expects(:list).with(@project, anything)
+      @collector.get_time_data(@project)
+    end
+    
+    it 'should pass the supplied options on when getting the time data' do
+      options = { :after => Time.now - 12345 }
+      @collector.stubs(:options).returns(options)
+      Punch.expects(:list).with(@project, options)
+      @collector.get_time_data(@project)
+    end
+    
+    it 'should condense the time data' do
+      @collector.expects(:condense_time_data).with(@time_data)
+      @collector.get_time_data(@project)
+    end
+    
+    it 'should return the condensed data' do
+      condensed = stub('condensed time data')
+      @collector.stubs(:condense_time_data).returns(condensed)
+      @collector.get_time_data(@project).should == condensed
+    end
+  end
+  
+  it 'should condense time data' do
+    @collector.should respond_to(:condense_time_data)
+  end
+  
+  describe 'condensing time data' do
+    before :each do
+      @time_data = stub('time data')
+      @collector.stubs(:times_to_dates)
+      @collector.stubs(:group_date_data)
+    end
+    
+    it 'should accept time data' do
+      lambda { @collector.condense_time_data(@time_data) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require time data' do
+      lambda { @collector.condense_time_data }.should raise_error(ArgumentError)
+    end
+    
+    it 'should convert times to dates and hour differences' do
+      @collector.expects(:times_to_dates).with(@time_data)
+      @collector.condense_time_data(@time_data)
+    end
+    
+    it 'should group date and hour differences' do
+      date_hour_data = stub('date/hour data')
+      @collector.stubs(:times_to_dates).returns(date_hour_data)
+      @collector.expects(:group_date_data).with(date_hour_data)
+      @collector.condense_time_data(@time_data)
+    end
+    
+    it 'should return the grouped date/hour data' do
+      grouped_dates = stub('grouped date/hour data')
+      @collector.stubs(:group_date_data).returns(grouped_dates)
+      @collector.condense_time_data(@time_data).should == grouped_dates
+    end
+  end
+  
+  it 'should convert times to dates and hour differences' do
+    @collector.should respond_to(:times_to_dates)
+  end
+  
+  describe 'converting times to dates and hour differences' do
+    before :each do
+      @time_data = []
+    end
+    
+    it 'should accept time data' do
+      lambda { @collector.times_to_dates(@time_data) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require time data' do
+      lambda { @collector.times_to_dates }.should raise_error(ArgumentError)
+    end
+    
+    it 'should return an array' do
+      @collector.times_to_dates(@time_data).should be_kind_of(Array)
+    end
+    
+    it 'should replace the in/out time data with a single date' do
+      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 25, 7,  25, 0) })
+      result = @collector.times_to_dates(@time_data)
+      result = result.first
+      
+      result.should     have_key('date')
+      result.should_not have_key('in')
+      result.should_not have_key('out')
+    end
+    
+    it 'should make the date appopriate to the time' do
+      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 25, 7,  25, 0) })
+      result = @collector.times_to_dates(@time_data)
+      result = result.first
+      result['date'].should == Date.civil(2008, 1, 25)
+    end
+    
+    it 'should use the in time date' do
+      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 26, 7,  25, 0) })
+      result = @collector.times_to_dates(@time_data)
+      result = result.first
+      result['date'].should == Date.civil(2008, 1, 25)
+    end
+    
+    it 'should add hour data' do
+      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 25, 7,  25, 0) })
+      result = @collector.times_to_dates(@time_data)
+      result = result.first
+      result.should have_key('hours')
+    end
+    
+    it 'should make the hour data appropriate to the in/out difference' do
+      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 25, 7,  55, 0) })
+      result = @collector.times_to_dates(@time_data)
+      result = result.first
+      result['hours'].should == 1.5
+    end
+  end
+  
+  it 'should group date data' do
+    @collector.should respond_to(:group_date_data)
+  end
+  
+  describe 'grouping date data' do
+    before :each do
+      @date_data = []
+    end
+    
+    it 'should accept date data' do
+      lambda { @collector.group_date_data(@date_data) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require date data' do
+      lambda { @collector.group_date_data }.should raise_error(ArgumentError)
+    end
+    
+    it 'should return an array' do
+      @collector.group_date_data(@date_data).should be_kind_of(Array)
+    end
+    
+    it 'should group the data by date' do
+      today = Date.today
+      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => [] })
+      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => [] })
+      @date_data.push({ 'date' => today + 1, 'hours' => 0, 'log' => [] })
+      @collector.group_date_data(@date_data).collect { |x|  x['date'] }.should == [today, today + 1]
+    end
+    
+    it 'should return the array sorted by date' do
+      today = Date.today
+      @date_data.push({ 'date' => today + 1, 'hours' => 0, 'log' => [] })
+      @date_data.push({ 'date' => today - 1, 'hours' => 0, 'log' => [] })
+      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => [] })
+      @date_data.push({ 'date' => today + 1, 'hours' => 0, 'log' => [] })
+      @collector.group_date_data(@date_data).collect { |x|  x['date'] }.should == [today - 1, today, today + 1]
+    end
+    
+    it 'should add the hours for a particular date' do
+      today = Date.today
+      @date_data.push({ 'date' => today,     'hours' => 1, 'log' => [] })
+      @date_data.push({ 'date' => today,     'hours' => 3, 'log' => [] })
+      @date_data.push({ 'date' => today + 1, 'hours' => 2, 'log' => [] })
+      result = @collector.group_date_data(@date_data)
+      
+      result[0]['date'].should  == today
+      result[0]['hours'].should == 4
+      
+      result[1]['date'].should  == today + 1
+      result[1]['hours'].should == 2
+    end
+    
+    it 'should round the hours to two decimal places' do
+      today = Date.today
+      @date_data.push({ 'date' => today, 'hours' => 1.666666666, 'log' => [] })
+      result = @collector.group_date_data(@date_data)
+      
+      result[0]['date'].should  == today
+      result[0]['hours'].should == 1.67
+    end
+    
+    it 'should join the log into notes' do
+      today = Date.today
+      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => ['punch in 1', 'punch out 1'] })
+      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => ['punch in 2', 'punch out 2'] })
+      @date_data.push({ 'date' => today + 1, 'hours' => 0, 'log' => ['punch in 3', 'punch out 3'] })
+      result = @collector.group_date_data(@date_data)
+      
+      result[0]['date'].should  == today
+      result[0]['notes'].should == "punch in 1\npunch out 1\n--------------------\npunch in 2\npunch out 2"
+      result[0].should_not have_key('log')
+      
+      result[1]['date'].should  == today + 1
+      result[1]['notes'].should == "punch in 3\npunch out 3"
+      result[1].should_not have_key('log')
+    end
+  end
+end

data/spec/time_collectors/punch_spec.rb

@@ -0,0 +1,298 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+require 'freshtrack/time_collectors/punch'
+
+describe Freshtrack::TimeCollector::Punch do
+  before :each do
+    @collector = Freshtrack::TimeCollector::Punch.new
+  end
+  
+  describe 'when initialized' do
+    it 'should accept options' do
+      lambda { Freshtrack::TimeCollector::Punch.new(:before => Time.now) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should not require options' do
+      lambda { Freshtrack::TimeCollector::Punch.new }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should provide access to the given options' do
+      options = { :after => Time.now }
+      Freshtrack::TimeCollector::Punch.new(options).options.should == options
+    end
+    
+    it 'should default options to an empty hash' do
+      Freshtrack::TimeCollector::Punch.new.options.should == {}
+    end
+  end
+  
+  it 'should get time data' do
+    @collector.should respond_to(:get_time_data)
+  end
+  
+  describe 'getting time data' do
+    before :each do
+      @project = 'myproj'
+      @time_data = stub('time data')
+      IO.stubs(:read).returns(@time_data)
+      @collector.stubs(:convert_time_data)
+      @collector.stubs(:condense_time_data)
+    end
+    
+    it 'should accept a project' do
+      lambda { @collector.get_time_data(@project) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require a project' do
+      lambda { @collector.get_time_data }.should raise_error(ArgumentError)
+    end
+    
+    it 'should get the time data (from punch)' do
+      IO.expects(:read).with(regexp_matches(/^\| punch list\b/))
+      @collector.get_time_data(@project)
+    end
+    
+    it 'should pass the supplied project when getting the time data' do
+      IO.expects(:read).with(regexp_matches(/\b#{@project}\b/))
+      @collector.get_time_data(@project)
+    end
+    
+    it 'should pass the supplied options on as a string when getting the time data' do
+      time = Time.local(2007, 3, 4, 13, 47, 56)
+      options = { :after => time }
+      option_str = '--after 2007-03-04T13:47:56-0500'
+      @collector.stubs(:options).returns(options)
+      IO.expects(:read).with(regexp_matches(/\b#{@project} #{option_str}\b/))
+      @collector.get_time_data(@project)
+    end
+    
+    it 'should default option string to empty string' do
+      IO.expects(:read).with(regexp_matches(/\b#{@project} $/))
+      @collector.get_time_data(@project)
+    end
+    
+    it 'should convert the time data' do
+      @collector.expects(:convert_time_data).with(@time_data)
+      @collector.get_time_data(@project)
+    end
+    
+    it 'should condense the converted time data' do
+      converted_time_data = stub('converted time data')
+      @collector.stubs(:convert_time_data).returns(converted_time_data)
+      @collector.expects(:condense_time_data).with(converted_time_data)
+      @collector.get_time_data(@project)
+    end
+    
+    it 'should return the condensed data' do
+      condensed = stub('condensed time data')
+      @collector.stubs(:condense_time_data).returns(condensed)
+      @collector.get_time_data(@project).should == condensed
+    end
+  end
+  
+  it 'should convert time data' do
+    @collector.should respond_to(:convert_time_data)
+  end
+  
+  describe 'converting time data' do
+    before :each do
+      @time_data = stub('time data')
+      YAML.stubs(:load)
+      @collector.stubs(:condense_time_data)
+    end
+    
+    it 'should accept time data' do
+      lambda { @collector.convert_time_data(@time_data) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require time data' do
+      lambda { @collector.convert_time_data }.should raise_error(ArgumentError)
+    end
+
+    it 'should convert the time data from YAML' do
+      YAML.expects(:load).with(@time_data)
+      @collector.convert_time_data(@time_data)
+    end
+    
+    it 'should return the converted time data' do
+      converted = stub('converted time data')
+      YAML.stubs(:load).returns(converted)
+      @collector.convert_time_data(@time_data).should == converted
+    end
+  end
+  
+  it 'should condense time data' do
+    @collector.should respond_to(:condense_time_data)
+  end
+  
+  describe 'condensing time data' do
+    before :each do
+      @time_data = stub('time data')
+      @collector.stubs(:times_to_dates)
+      @collector.stubs(:group_date_data)
+    end
+    
+    it 'should accept time data' do
+      lambda { @collector.condense_time_data(@time_data) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require time data' do
+      lambda { @collector.condense_time_data }.should raise_error(ArgumentError)
+    end
+    
+    it 'should convert times to dates and hour differences' do
+      @collector.expects(:times_to_dates).with(@time_data)
+      @collector.condense_time_data(@time_data)
+    end
+    
+    it 'should group date and hour differences' do
+      date_hour_data = stub('date/hour data')
+      @collector.stubs(:times_to_dates).returns(date_hour_data)
+      @collector.expects(:group_date_data).with(date_hour_data)
+      @collector.condense_time_data(@time_data)
+    end
+    
+    it 'should return the grouped date/hour data' do
+      grouped_dates = stub('grouped date/hour data')
+      @collector.stubs(:group_date_data).returns(grouped_dates)
+      @collector.condense_time_data(@time_data).should == grouped_dates
+    end
+  end
+  
+  it 'should convert times to dates and hour differences' do
+    @collector.should respond_to(:times_to_dates)
+  end
+  
+  describe 'converting times to dates and hour differences' do
+    before :each do
+      @time_data = []
+    end
+    
+    it 'should accept time data' do
+      lambda { @collector.times_to_dates(@time_data) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require time data' do
+      lambda { @collector.times_to_dates }.should raise_error(ArgumentError)
+    end
+    
+    it 'should return an array' do
+      @collector.times_to_dates(@time_data).should be_kind_of(Array)
+    end
+    
+    it 'should replace the in/out time data with a single date' do
+      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 25, 7,  25, 0) })
+      result = @collector.times_to_dates(@time_data)
+      result = result.first
+      
+      result.should     have_key('date')
+      result.should_not have_key('in')
+      result.should_not have_key('out')
+    end
+    
+    it 'should make the date appopriate to the time' do
+      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 25, 7,  25, 0) })
+      result = @collector.times_to_dates(@time_data)
+      result = result.first
+      result['date'].should == Date.civil(2008, 1, 25)
+    end
+    
+    it 'should use the in time date' do
+      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 26, 7,  25, 0) })
+      result = @collector.times_to_dates(@time_data)
+      result = result.first
+      result['date'].should == Date.civil(2008, 1, 25)
+    end
+    
+    it 'should add hour data' do
+      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 25, 7,  25, 0) })
+      result = @collector.times_to_dates(@time_data)
+      result = result.first
+      result.should have_key('hours')
+    end
+    
+    it 'should make the hour data appropriate to the in/out difference' do
+      @time_data.push({ 'in' => Time.local(2008, 1, 25, 6,  25, 0), 'out' => Time.local(2008, 1, 25, 7,  55, 0) })
+      result = @collector.times_to_dates(@time_data)
+      result = result.first
+      result['hours'].should == 1.5
+    end
+  end
+  
+  it 'should group date data' do
+    @collector.should respond_to(:group_date_data)
+  end
+  
+  describe 'grouping date data' do
+    before :each do
+      @date_data = []
+    end
+    
+    it 'should accept date data' do
+      lambda { @collector.group_date_data(@date_data) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require date data' do
+      lambda { @collector.group_date_data }.should raise_error(ArgumentError)
+    end
+    
+    it 'should return an array' do
+      @collector.group_date_data(@date_data).should be_kind_of(Array)
+    end
+    
+    it 'should group the data by date' do
+      today = Date.today
+      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => [] })
+      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => [] })
+      @date_data.push({ 'date' => today + 1, 'hours' => 0, 'log' => [] })
+      @collector.group_date_data(@date_data).collect { |x|  x['date'] }.should == [today, today + 1]
+    end
+    
+    it 'should return the array sorted by date' do
+      today = Date.today
+      @date_data.push({ 'date' => today + 1, 'hours' => 0, 'log' => [] })
+      @date_data.push({ 'date' => today - 1, 'hours' => 0, 'log' => [] })
+      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => [] })
+      @date_data.push({ 'date' => today + 1, 'hours' => 0, 'log' => [] })
+      @collector.group_date_data(@date_data).collect { |x|  x['date'] }.should == [today - 1, today, today + 1]
+    end
+    
+    it 'should add the hours for a particular date' do
+      today = Date.today
+      @date_data.push({ 'date' => today,     'hours' => 1, 'log' => [] })
+      @date_data.push({ 'date' => today,     'hours' => 3, 'log' => [] })
+      @date_data.push({ 'date' => today + 1, 'hours' => 2, 'log' => [] })
+      result = @collector.group_date_data(@date_data)
+      
+      result[0]['date'].should  == today
+      result[0]['hours'].should == 4
+      
+      result[1]['date'].should  == today + 1
+      result[1]['hours'].should == 2
+    end
+    
+    it 'should round the hours to two decimal places' do
+      today = Date.today
+      @date_data.push({ 'date' => today, 'hours' => 1.666666666, 'log' => [] })
+      result = @collector.group_date_data(@date_data)
+      
+      result[0]['date'].should  == today
+      result[0]['hours'].should == 1.67
+    end
+    
+    it 'should join the log into notes' do
+      today = Date.today
+      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => ['punch in 1', 'punch out 1'] })
+      @date_data.push({ 'date' => today,     'hours' => 0, 'log' => ['punch in 2', 'punch out 2'] })
+      @date_data.push({ 'date' => today + 1, 'hours' => 0, 'log' => ['punch in 3', 'punch out 3'] })
+      result = @collector.group_date_data(@date_data)
+      
+      result[0]['date'].should  == today
+      result[0]['notes'].should == "punch in 1\npunch out 1\n--------------------\npunch in 2\npunch out 2"
+      result[0].should_not have_key('log')
+      
+      result[1]['date'].should  == today + 1
+      result[1]['notes'].should == "punch in 3\npunch out 3"
+      result[1].should_not have_key('log')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: freshtrack
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-27 00:00:00 -05:00
+date: 2008-08-29 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,16 +22,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "2.1"
     version: 
-- !ruby/object:Gem::Dependency 
-  name: one_inch_punch
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.0.3
-    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -68,6 +58,9 @@ files:
 - lib/freshtrack/core_ext/array.rb
 - lib/freshtrack/core_ext/numeric.rb
 - lib/freshtrack/core_ext/time.rb
+- lib/freshtrack/time_collectors/one_inch_punch.rb
+- lib/freshtrack/time_collectors/punch.rb
+- lib/freshtrack/time_collectors/punchy_template.rb
 - lib/freshbooks/extensions.rb
 - lib/freshbooks/extensions/base_object.rb
 - lib/freshbooks/extensions/project.rb
@@ -77,15 +70,17 @@ files:
 - script/destroy
 - script/generate
 - setup.rb
-- spec/base_object_spec.rb
+- spec/core_ext/array_spec.rb
+- spec/core_ext/numeric_spec.rb
+- spec/core_ext/time_spec.rb
+- spec/time_collectors/one_inch_punch_spec.rb
+- spec/time_collectors/punch_spec.rb
+- spec/freshbooks/base_object_spec.rb
+- spec/freshbooks/project_spec.rb
+- spec/freshbooks/task_spec.rb
+- spec/freshbooks/time_entry_spec.rb
 - spec/freshtrack_command_spec.rb
 - spec/freshtrack_spec.rb
-- spec/project_spec.rb
-- spec/task_spec.rb
-- spec/time_entry_spec.rb
-- spec/array_spec.rb
-- spec/numeric_spec.rb
-- spec/time_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/deployment.rake