freshtrack 0.2.2 → 0.3.0

data/History.txt

@@ -1,3 +1,8 @@
+== 0.3.0 2008-08-27
+
+* 1 minor enhancement:
+  * Now using my one_inch_punch gem, getting the time data without having to shell out
+
 == 0.2.2 2008-02-27
 
 * 1 tiny enhancement:

data/Manifest.txt

@@ -22,6 +22,7 @@ script/destroy
 script/generate
 setup.rb
 spec/base_object_spec.rb
+spec/freshtrack_command_spec.rb
 spec/freshtrack_spec.rb
 spec/project_spec.rb
 spec/task_spec.rb

data/README.txt

@@ -1,18 +1,36 @@
-Freshtrack is used to automatically create time entries in FreshBooks.
+= freshtrack
 
-It presently depends on punch, the gem by Ara T. Howard, and any arguments given to 
-freshtrack are passed along to punch as if freshtrack were an alias for 'punch list'.
+== DESCRIPTION:
 
-For example
+Freshtrack is used to automatically create time entries in FreshBooks from your own tracked time.
 
-  freshtrack proj --after 2008-01-16 --before 2008-02-01
+== FEATURES/PROBLEMS:
 
-would get time data for the second half of January 2008 by using the command
+* Simple and easy to use
 
-  punch list proj --after 2008-01-16 --before 2008-02-01
+* Only works with data from one_inch_punch
 
+== SYNOPSIS:
 
-Freshtrack requires a configuration file, ~/.freshtrack.yml, that looks something like
+  $ freshtrack proj
+  
+  or
+  
+  $ freshtrack proj --before 2008-08-16
+  
+  or! (if you really want)
+  
+  require 'freshtrack'
+  
+  Freshtrack.init
+  Freshtrack.track('proj', :before => Time.parse('2008-08-16'))
+
+== REQUIREMENTS:
+
+* one_inch_punch (gem)
+* freshbooks (gem)
+* A FreshBooks account
+* a configuration file located at ~/.freshtrack.yml and looking like
 
   --- 
   company: Company Name
@@ -22,9 +40,13 @@ Freshtrack requires a configuration file, ~/.freshtrack.yml, that looks somethin
       :project: FreshBooks Project Name
       :task: FreshBooks Task Name
 
-The 'Company Name' is the XXX in 'XXX.freshbooks.com'. The 'project_name' is the XXX in 'punch list XXX'
+(The 'Company Name' is the XXX in 'XXX.freshbooks.com'. The 'project_name' is the XXX in 'punch list XXX'.)
+
+== INSTALL:
+
+* gem install freshtrack
 
+== THANKS:
 
-NOTE: As of this writing, punch (0.0.1) specifically requires attributes version 5.0.0 even though 5.0.1 is out.
-Because of the way gems work, punch will not work if both are installed. Make sure the specific installed version 
-of attributes is 5.0.0.
+  * Kevin Barnes and Rick Bradley, for giving me a reason to track time and invoice people for it
+  * The FreshBooks team, for making invoicing easy

data/bin/freshtrack

@@ -10,8 +10,34 @@ rescue LoadError
 end
 
 require 'freshtrack'
+require 'optparse'
+require 'time'
+
+OPTIONS = {}
+MANDATORY_OPTIONS = %w[]
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+Usage: #{File.basename($0)} [options]
+
+Options are:
+BANNER
+  opts.separator ''
+  opts.on('-v', '--version',
+          "Show the #{File.basename($0)} version number and exit") { require 'freshtrack/version'; puts "#{File.basename($0)} #{Freshtrack::VERSION::STRING}"; exit  }
+  opts.on('--after [TIME]', String,
+          "Restrict command to only after the given time") { |time|  OPTIONS[:after] = Time.parse(time) }
+  opts.on('--before [TIME]', String,
+          "Restrict command to only before the given time") { |time|  OPTIONS[:before] = Time.parse(time) }
+  opts.on("-h", "--help",
+          "Show this help message.") { puts opts; exit }
+  opts.parse!(ARGV)
+
+  if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
+    puts opts; exit
+  end
+end
 
-# do stuff
 project = ARGV.shift
 
 unless project
@@ -20,4 +46,4 @@ unless project
 end
 
 Freshtrack.init
-Freshtrack.track(project, ARGV.join(' '))
+Freshtrack.track(project, OPTIONS)

data/config/hoe.rb

@@ -2,7 +2,7 @@ require 'freshtrack/version'
 
 AUTHOR = 'Yossef Mendelssohn'  # can also be an array of Authors
 EMAIL = 'ymendel@pobox.com'
-DESCRIPTION = "description of gem"
+DESCRIPTION = "Track your time on FreshBooks"
 GEM_NAME = 'freshtrack' # what ppl will type to install your gem
 RUBYFORGE_PROJECT = 'yomendel' # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
@@ -60,8 +60,8 @@ 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'],
-    ['punch',      '>= 0.0.1']
+    ['freshbooks', '= 2.1'],
+    ['one_inch_punch', '>= 0.0.3']
   ]
   
   #p.spec_extras = {}    # A hash of extra values to set in the gemspec.

data/lib/freshtrack/version.rb

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

data/lib/freshtrack.rb

@@ -2,6 +2,7 @@ $:.unshift File.dirname(__FILE__)
 require 'freshbooks/extensions'
 require 'freshtrack/core_ext'
 require 'yaml'
+require 'punch'
 
 module Freshtrack
   class << self
@@ -36,14 +37,10 @@ module Freshtrack
       raise unless @task
     end
     
-    def get_time_data(project_name, options = '')
-      time_data = IO.read("| punch list #{project_name} #{options}")
-      convert_time_data(time_data)
-    end
-    
-    def convert_time_data(time_data)
-      raw = YAML.load(time_data)
-      condense_time_data(raw)
+    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)
@@ -73,12 +70,12 @@ module Freshtrack
       end
     end
     
-    def get_data(project_name, options = '')
+    def get_data(project_name, options = {})
       get_project_data(project_name)
       get_time_data(project_name, options)
     end
     
-    def track(project_name, options = '')
+    def track(project_name, options = {})
       data = get_data(project_name, options)
       data.each do |entry_data|
         create_entry(entry_data)

data/spec/freshtrack_command_spec.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'freshtrack command' do
+  def run_command(*args)
+    Object.const_set(:ARGV, args)
+    begin
+      eval File.read(File.join(File.dirname(__FILE__), *%w[.. bin freshtrack]))
+    rescue SystemExit
+    end
+  end
+  
+  before :each do
+    [:ARGV, :OPTIONS, :MANDATORY_OPTIONS].each do |const|
+      Object.send(:remove_const, const) if Object.const_defined?(const)
+    end
+    
+    Freshtrack.stubs(:init)
+    Freshtrack.stubs(:track)
+    
+    @project = 'myproj'
+  end
+  
+  it 'should exist' do
+    lambda { run_command(@project) }.should_not raise_error(Errno::ENOENT)
+  end
+  
+  it 'should require a project' do
+    self.expects(:puts) { |text|  text.match(/usage.+project/i) }
+    run_command
+  end
+  
+  it 'should init Freshtrack' do
+    Freshtrack.expects(:init)
+    run_command(@project)
+  end
+  
+  it 'should track time' do
+    Freshtrack.expects(:track)
+    run_command(@project)
+  end
+  
+  it 'should track time for the given project' do
+    Freshtrack.expects(:track).with(@project, anything)
+    run_command(@project)
+  end
+  
+  describe 'when options specified' do
+    it "should pass on an 'after' time option given by --after" do
+      time_option = '2008-08-26 09:47'
+      time = Time.local(2008, 8, 26, 9, 47)
+      Freshtrack.expects(:track).with(@project, has_entry(:after => time))
+      run_command(@project, '--after', time_option)
+    end
+
+    it "should pass on a 'before' time option given by --before" do
+      time_option = '2008-08-23 15:39'
+      time = Time.local(2008, 8, 23, 15, 39)
+      Freshtrack.expects(:track).with(@project, has_entry(:before => time))
+      run_command(@project, '--before', time_option)
+    end
+
+    it 'should handle a time option given as a date' do
+      time_option = '2008-08-23'
+      time = Time.local(2008, 8, 23)
+      Freshtrack.expects(:track).with(@project, has_entry(:before => time))
+      run_command(@project, '--before', time_option)
+    end
+  end
+  
+  it 'should pass no options if none specified' do
+    Freshtrack.expects(:track).with(@project, {})
+    run_command(@project)
+  end
+end

data/spec/freshtrack_spec.rb

@@ -132,8 +132,9 @@ describe Freshtrack do
     before :each do
       @project_name = :proj
       @time_data = stub('time data')
-      IO.stubs(:read).returns(@time_data)
-      Freshtrack.stubs(:convert_time_data)
+      Punch.stubs(:load)
+      Punch.stubs(:list).returns(@time_data)
+      Freshtrack.stubs(:condense_time_data)
     end
     
     it 'should require an argument' do
@@ -144,74 +145,45 @@ describe Freshtrack do
       lambda { Freshtrack.get_time_data(@project_name) }.should_not raise_error(ArgumentError)
     end
     
-    it 'should accept an option string' do
-      lambda { Freshtrack.get_time_data(@project_name, 'option string') }.should_not raise_error(ArgumentError)
+    it 'should accept options' do
+      lambda { Freshtrack.get_time_data(@project_name, :after => 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)
     end
     
-    it 'should get the time data (from punch)' do
-      IO.expects(:read).with(regexp_matches(/^\| punch list\b/))
+    it 'should get the time data from punch' do
+      Punch.expects(:list)
       Freshtrack.get_time_data(@project_name)
     end
     
     it 'should pass the supplied project when getting the time data' do
-      IO.expects(:read).with(regexp_matches(/\b#{@project_name}\b/))
+      Punch.expects(:list).with(@project_name, anything)
       Freshtrack.get_time_data(@project_name)
     end
     
-    it 'should pass the supplied option string on when getting the time data' do
-      options = 'options go here'
-      IO.expects(:read).with(regexp_matches(/\b#{@project_name} #{options}\b/))
+    it 'should pass the supplied options on when getting the time data' do
+      options = { :after => Time.now - 12345 }
+      Punch.expects(:list).with(@project_name, options)
       Freshtrack.get_time_data(@project_name, options)
     end
     
-    it 'should default option string to empty string' do
-      IO.expects(:read).with(regexp_matches(/\b#{@project_name} $/))
+    it 'should pass an empty hash by default' do
+      Punch.expects(:list).with(@project_name, {})
       Freshtrack.get_time_data(@project_name)
     end
     
-    it 'should convert the time data' do
-      Freshtrack.expects(:convert_time_data).with(@time_data)
+    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 converted data' do
-      converted = stub('converted time data')
-      Freshtrack.stubs(:convert_time_data).returns(converted)
-      Freshtrack.get_time_data(@project_name).should == converted
-    end
-  end
-  
-  describe 'converting time data' do
-    before :each do
-      @time_data = stub('time data')
-      YAML.stubs(:load)
-      Freshtrack.stubs(:condense_time_data)
-    end
-    
-    it 'should require an argument' do
-      lambda { Freshtrack.convert_time_data }.should raise_error(ArgumentError)
-    end
-    
-    it 'should accept an argument' do
-      lambda { Freshtrack.convert_time_data(@time_data) }.should_not raise_error(ArgumentError)
-    end
-    
-    it 'should convert the time data from YAML' do
-      YAML.expects(:load).with(@time_data)
-      Freshtrack.convert_time_data(@time_data)
-    end
-    
-    it 'should condense the raw data' do
-      raw = stub('raw time data')
-      YAML.stubs(:load).returns(raw)
-      Freshtrack.expects(:condense_time_data).with(raw)
-      Freshtrack.convert_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.convert_time_data(@time_data).should == condensed
+      Freshtrack.get_time_data(@project_name).should == condensed
     end
   end
   
@@ -394,8 +366,8 @@ describe Freshtrack do
       lambda { Freshtrack.get_data(@project_name) }.should_not raise_error(ArgumentError)
     end
     
-    it 'should accept an option string' do
-      lambda { Freshtrack.get_data(@project_name, 'option string') }.should_not raise_error(ArgumentError)
+    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
@@ -408,14 +380,14 @@ describe Freshtrack do
       Freshtrack.get_data(@project_name)
     end
     
-    it 'should pass option string on when getting time data' do
-      options = 'here be options'
+    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)
     end
     
-    it 'should default option string to empty string' do
-      Freshtrack.expects(:get_time_data).with(@project_name, '')
+    it 'should default options to an empty hash' do
+      Freshtrack.expects(:get_time_data).with(@project_name, {})
       Freshtrack.get_data(@project_name)
     end
     
@@ -441,8 +413,8 @@ describe Freshtrack do
       lambda { Freshtrack.track(@project_name) }.should_not raise_error(ArgumentError)
     end
     
-    it 'should accept an option string' do
-      lambda { Freshtrack.track(@project_name, 'option string') }.should_not raise_error(ArgumentError)
+    it 'should accept options' do
+      lambda { Freshtrack.track(@project_name, :before => Time.now) }.should_not raise_error(ArgumentError)
     end
     
     it 'should get data for supplied project' do
@@ -450,14 +422,14 @@ describe Freshtrack do
       Freshtrack.track(@project_name)
     end
     
-    it 'should pass option string on when getting data' do
-      options = 'here be options'
+    it 'should pass options on when getting data' do
+      options = { :after => Time.now - 12345 }
       Freshtrack.expects(:get_data).with(@project_name, options).returns(@data)
       Freshtrack.track(@project_name, options)
     end
     
-    it 'should default option string to empty string' do
-      Freshtrack.expects(:get_data).with(@project_name, '').returns(@data)
+    it 'should default options to an empty hash' do
+      Freshtrack.expects(:get_data).with(@project_name, {}).returns(@data)
       Freshtrack.track(@project_name)
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: freshtrack
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -9,28 +9,40 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-27 00:00:00 -06:00
+date: 2008-08-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: freshbooks
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: "2.1"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: punch
+  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
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.1
+        version: 1.7.0
     version: 
-description: description of gem
+description: Track your time on FreshBooks
 email: ymendel@pobox.com
 executables: 
 - freshtrack
@@ -66,6 +78,7 @@ files:
 - script/generate
 - setup.rb
 - spec/base_object_spec.rb
+- spec/freshtrack_command_spec.rb
 - spec/freshtrack_spec.rb
 - spec/project_spec.rb
 - spec/task_spec.rb
@@ -102,9 +115,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: yomendel
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: description of gem
+summary: Track your time on FreshBooks
 test_files: []