zenhob-hcl 0.2.2 → 0.2.3

data/.document

@@ -0,0 +1 @@
+--files CHANGELOG

data/.gitignore

@@ -1,2 +1,5 @@
 *.sw[nop]
 pkg
+tags
+doc
+.yardoc

data/CHANGELOG

@@ -0,0 +1,41 @@
+= Recent Changes in HCl
+
+== v0.2.3 Sun Aug 23 21:39:34 2009 -0700
+
+* Allow decimal time offset without a dot, closes #29.
+* Reverted and re-fixed: Adding note fails when task is started without notes, #26.
+* Reinstate the --version option
+
+== v0.2.2 Sun Aug 9 11:16:34 2009 -0700
+
+* Support installation via rip, closes #27.
+* Fixed: Adding note fails when task is started without notes, closes #26.
+* Avoid stack trace on missing XML root node, closes #25.
+
+== v0.2.1 Thu Jul 30 14:02:23 2009 -0700
+
+* Fixed: Creating timers without starting them.
+
+== v0.2.0 Thu Jul 30 11:40:33 2009 -0700
+
+* Allow an initial time to be specified when starting a timer, closes #9.
+* Always display hours as HH:MM, closes #22.
+* Do not write empty task cache, closes #23.
+
+== v0.1.3 Tue Jul 28 09:19:53 2009 -0700
+
+* Add a note about ruby-dev for debian/ubuntu users, closes #20.
+* Friendlier error message on unrecognized task, closes #18, #21.
+
+== v0.1.2 Mon Jul 27 11:46:50 2009 -0700
+
+* Automatically include rubygems in bin/hcl.
+
+== v0.1.1 Fri Jul 24 19:32:32 2009 -0700
+
+* Mention gem in README, read version from file.
+    
+== v0.1.0 Fri Jul 24 19:09:23 2009 -0700
+
+* Initial public release
+

data/README.markdown

@@ -1,4 +1,4 @@
-# hcl
+# HCl
 
 HCl is a command-line tool for interacting with Harvest time sheets using the
 [Harvest time tracking API][htt].

data/Rakefile

@@ -1,3 +1,10 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+end
+
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/hcl.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hcl}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Zack Hobson"]
-  s.date = %q{2009-08-09}
+  s.date = %q{2009-08-23}
   s.default_executable = %q{hcl}
   s.description = %q{HCl is a command-line client for manipulating Harvest time sheets.}
   s.email = %q{zack@opensourcery.com}
@@ -16,8 +16,9 @@ Gem::Specification.new do |s|
      "README.markdown"
   ]
   s.files = [
-    ".gitignore",
-     ".gitmodules",
+    ".document",
+     ".gitignore",
+     "CHANGELOG",
      "LICENSE",
      "README.markdown",
      "Rakefile",
@@ -25,13 +26,17 @@ Gem::Specification.new do |s|
      "bin/hcl",
      "deps.rip",
      "hcl.gemspec",
-     "hcl_conf.yml.example",
      "lib/hcl/app.rb",
+     "lib/hcl/commands.rb",
      "lib/hcl/day_entry.rb",
      "lib/hcl/project.rb",
      "lib/hcl/task.rb",
      "lib/hcl/timesheet_resource.rb",
-     "lib/hcl/utility.rb"
+     "lib/hcl/utility.rb",
+     "test/app_test.rb",
+     "test/day_entry_test.rb",
+     "test/test_helper.rb",
+     "test/utility_test.rb"
   ]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/zenhob/hcl}
@@ -39,6 +44,12 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{Harvest timesheets from the command-line}
+  s.test_files = [
+    "test/app_test.rb",
+     "test/day_entry_test.rb",
+     "test/test_helper.rb",
+     "test/utility_test.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/hcl/app.rb

@@ -11,6 +11,7 @@ require 'highline/import'
 
 ## app dependencies
 require 'hcl/utility'
+require 'hcl/commands'
 require 'hcl/timesheet_resource'
 require 'hcl/project'
 require 'hcl/task'
@@ -29,51 +30,65 @@ class Net::HTTP
 end
 
 module HCl
-  class App
-  include HCl::Utility
-
-  SETTINGS_FILE = "#{ENV['HOME']}/.hcl_settings"
-  CONFIG_FILE = "#{ENV['HOME']}/.hcl_config"
+  VERSION = "0.2.3"
 
-  class UnknownCommand < StandardError; end
+  class App
+    include HCl::Utility
+    include HCl::Commands
+  
+    SETTINGS_FILE = "#{ENV['HOME']}/.hcl_settings"
+    CONFIG_FILE = "#{ENV['HOME']}/.hcl_config"
+  
+    class UnknownCommand < StandardError; end
+  
+    def initialize
+      read_config
+      read_settings
+    end
 
-  def self.command *args
-    hcl = new.process_args(*args).run
-  end
+    # Run the given command and arguments.
+    def self.command *args
+      hcl = new.process_args(*args).run
+    end
 
-  def run
-    begin
-      if @command
-        if respond_to? @command
-          result = send @command, *@args
-          if not result.nil?
-            if result.respond_to? :to_a
-              puts result.to_a.join(', ')
-            elsif result.respond_to? :to_s
-              puts result
+    # Return true if the string is a known command, false otherwise.
+    #
+    # @param [#to_s] command name of command
+    # @return [true, false]
+    def command? command
+      Commands.instance_methods.include? command.to_s
+    end
+  
+    # Start the application.
+    def run
+      begin
+        if @command
+          if command? @command
+            result = send @command, *@args
+            if not result.nil?
+              if result.respond_to? :to_a
+                puts result.to_a.join(', ')
+              elsif result.respond_to? :to_s
+                puts result
+              end
             end
+          else
+            raise UnknownCommand, "unrecognized command `#{@command}'"
           end
         else
-          raise UnknownCommand, "unrecognized command `#{@command}'"
+          show
         end
-      else
-        show
+      rescue TimesheetResource::Failure => e
+        puts "Internal failure. #{e}"
+        exit 1
       end
-    rescue TimesheetResource::Failure => e
-      puts "Internal failure. #{e}"
-      exit 1
     end
-  end
-
-  def initialize
-    read_config
-    read_settings
-  end
-
-  def process_args *args
-    Trollop::options(args) do
-      stop_on %w[ show tasks set unset note add rm start stop ]
-      banner <<-EOM
+  
+    def process_args *args
+      Trollop::options(args) do
+        stop_on Commands.instance_methods
+        version "HCl version #{VERSION}"
+        banner <<-EOM
 HCl is a command-line client for manipulating Harvest time sheets.
 
 Commands:
@@ -81,6 +96,7 @@ Commands:
     hcl tasks
     hcl aliases
     hcl set <key> <value ...>
+    hcl unset <key>
     hcl start <task> [msg]
     hcl stop [msg]
     hcl note <msg>
@@ -95,140 +111,54 @@ Examples:
 
 Options:
 EOM
-    end
-    @command = args.shift
-    @args = args
-    self
-  end
-
-  def tasks
-    tasks = Task.all
-    if tasks.empty?
-      puts "No cached tasks. Run `hcl show' to populate the cache and try again."
-    else
-      tasks.each { |task| puts "#{task.project.id} #{task.id}\t#{task}" }
-    end
-    nil
-  end
-
-  def read_config
-    if File.exists? CONFIG_FILE
-      config = YAML::load File.read(CONFIG_FILE)
-      TimesheetResource.configure config
-    elsif File.exists? old_conf = File.dirname(__FILE__) + "/../hcl_conf.yml"
-      config = YAML::load File.read(old_conf)
-      TimesheetResource.configure config
-      write_config config
-    else
-      config = {}
-      puts "Please specify your Harvest credentials.\n"
-      config['login'] = ask("Email Address: ")
-      config['password'] = ask("Password: ") { |q| q.echo = false }
-      config['subdomain'] = ask("Subdomain: ")
-      TimesheetResource.configure config
-      write_config config
-    end
-  end
-
-  def write_config config
-    puts "Writing configuration to #{CONFIG_FILE}."
-    File.open(CONFIG_FILE, 'w') do |f|
-     f.write config.to_yaml
-    end
-  end
-
-  def read_settings
-    if File.exists? SETTINGS_FILE
-      @settings = YAML.load(File.read(SETTINGS_FILE))
-    else
-      @settings = {}
-    end
-  end
-
-  def write_settings
-    File.open(SETTINGS_FILE, 'w') do |f|
-     f.write @settings.to_yaml
-    end
-    nil
-  end
-
-  def set key = nil, *args
-    if key.nil?
-      @settings.each do |k, v|
-        puts "#{k}: #{v}"
       end
-    else
-      value = args.join(' ')
-      @settings ||= {}
-      @settings[key] = value
-      write_settings
+      @command = args.shift
+      @args = args
+      self
     end
-    nil
-  end
-
-  def unset key
-    @settings.delete key
-    write_settings
-  end
 
-  def aliases
-    @settings.keys.select { |s| s =~ /^task\./ }.map { |s| s.slice(5..-1) }
-  end
-
-  def start *args
-    starting_time = args.detect {|x| x =~ /^\+\d*(\.|:)\d+$/ }
-    if starting_time
-      args.delete(starting_time)
-      starting_time = time2float starting_time
-    end
-    ident = args.shift
-    task_ids = if @settings.key? "task.#{ident}"
-        @settings["task.#{ident}"].split(/\s+/)
+    protected
+  
+    def read_config
+      if File.exists? CONFIG_FILE
+        config = YAML::load File.read(CONFIG_FILE)
+        TimesheetResource.configure config
+      elsif File.exists? old_conf = File.dirname(__FILE__) + "/../hcl_conf.yml"
+        config = YAML::load File.read(old_conf)
+        TimesheetResource.configure config
+        write_config config
       else
-        [ident, args.shift]
+        config = {}
+        puts "Please specify your Harvest credentials.\n"
+        config['login'] = ask("Email Address: ")
+        config['password'] = ask("Password: ") { |q| q.echo = false }
+        config['subdomain'] = ask("Subdomain: ")
+        TimesheetResource.configure config
+        write_config config
       end
-    task = Task.find *task_ids
-    if task.nil?
-      puts "Unknown project/task alias, try one of the following: #{aliases.join(', ')}."
-      exit 1
     end
-    timer = task.start(:starting_time => starting_time, :note => args.join(' '))
-    puts "Started timer for #{timer}."
-  end
-
-  def stop
-    entry = DayEntry.with_timer
-    if entry
-      entry.toggle
-      puts "Stopped #{entry}."
-    else
-      puts "No running timers found."
+  
+    def write_config config
+      puts "Writing configuration to #{CONFIG_FILE}."
+      File.open(CONFIG_FILE, 'w') do |f|
+       f.write config.to_yaml
+      end
     end
-  end
-
-  def note *args
-    message = args.join ' '
-    entry = DayEntry.with_timer
-    if entry
-      entry.append_note message
-      puts "Added note '#{message}' to #{entry}."
-    else
-      puts "No running timers found."
+  
+    def read_settings
+      if File.exists? SETTINGS_FILE
+        @settings = YAML.load(File.read(SETTINGS_FILE))
+      else
+        @settings = {}
+      end
     end
-  end
-
-  def show *args
-    date = args.empty? ? nil : Chronic.parse(args.join(' '))
-    total_hours = 0.0
-    DayEntry.all(date).each do |day|
-      running = day.running? ? '(running) ' : ''
-      puts "\t#{day.formatted_hours}\t#{running}#{day.project} #{day.notes}"[0..78]
-      total_hours = total_hours + day.hours.to_f
+  
+    def write_settings
+      File.open(SETTINGS_FILE, 'w') do |f|
+       f.write @settings.to_yaml
+      end
+      nil
     end
-    puts "\t" + '-' * 13
-    puts "\t#{as_hours total_hours}\ttotal"
-  end
-
   end
 end
 

data/lib/hcl/commands.rb

@@ -0,0 +1,90 @@
+module HCl
+  module Commands
+    def tasks
+      tasks = Task.all
+      if tasks.empty?
+        puts "No cached tasks. Run `hcl show' to populate the cache and try again."
+      else
+        tasks.each { |task| puts "#{task.project.id} #{task.id}\t#{task}" }
+      end
+      nil
+    end
+  
+    def set key = nil, *args
+      if key.nil?
+        @settings.each do |k, v|
+          puts "#{k}: #{v}"
+        end
+      else
+        value = args.join(' ')
+        @settings ||= {}
+        @settings[key] = value
+        write_settings
+      end
+      nil
+    end
+  
+    def unset key
+      @settings.delete key
+      write_settings
+    end
+  
+    def aliases
+      @settings.keys.select { |s| s =~ /^task\./ }.map { |s| s.slice(5..-1) }
+    end
+  
+    def start *args
+      starting_time = args.detect {|x| x =~ /^\+\d*(\.|:)?\d+$/ }
+      if starting_time
+        args.delete(starting_time)
+        starting_time = time2float starting_time
+      end
+      ident = args.shift
+      task_ids = if @settings.key? "task.#{ident}"
+          @settings["task.#{ident}"].split(/\s+/)
+        else
+          [ident, args.shift]
+        end
+      task = Task.find *task_ids
+      if task.nil?
+        puts "Unknown project/task alias, try one of the following: #{aliases.join(', ')}."
+        exit 1
+      end
+      timer = task.start(:starting_time => starting_time, :note => args.join(' '))
+      puts "Started timer for #{timer}."
+    end
+  
+    def stop
+      entry = DayEntry.with_timer
+      if entry
+        entry.toggle
+        puts "Stopped #{entry}."
+      else
+        puts "No running timers found."
+      end
+    end
+  
+    def note *args
+      message = args.join ' '
+      entry = DayEntry.with_timer
+      if entry
+        entry.append_note message
+        puts "Added note '#{message}' to #{entry}."
+      else
+        puts "No running timers found."
+      end
+    end
+  
+    def show *args
+      date = args.empty? ? nil : Chronic.parse(args.join(' '))
+      total_hours = 0.0
+      DayEntry.all(date).each do |day|
+        running = day.running? ? '(running) ' : ''
+        puts "\t#{day.formatted_hours}\t#{running}#{day.project} #{day.notes}"[0..78]
+        total_hours = total_hours + day.hours.to_f
+      end
+      puts "\t" + '-' * 13
+      puts "\t#{as_hours total_hours}\ttotal"
+    end
+  end
+end

data/lib/hcl/day_entry.rb

@@ -23,18 +23,17 @@ module HCl
       end
     end
 
+    def notes
+      super || @data[:notes] = ''
+    end
+
     # Append a string to the notes for this task.
     def append_note new_notes
       # If I don't include hours it gets reset.
       # This doens't appear to be the case for task and project.
-      if notes.nil?
-        notes = new_notes
-      else
-        notes << " #{new_notes}"
-      end
       DayEntry.post("daily/update/#{id}", <<-EOD)
       <request>
-        <notes>#{notes}</notes>
+        <notes>#{notes << " #{new_notes}"}</notes>
         <hours>#{hours}</hours>
       </request>
       EOD

data/lib/hcl/utility.rb

@@ -1,16 +1,23 @@
 module HCl
   module Utility
     # Convert from decimal to a string of the form HH:MM.
+    #
+    # @param [#to_f] hours number of hours in decimal
+    # @return [String] of the form "HH:MM"
     def as_hours hours
       minutes = hours.to_f * 60.0
       sprintf "%d:%02d", (minutes / 60).to_i, (minutes % 60).to_i
     end
 
+    # Convert from a time span in hour or decimal format to a float.
+    #
+    # @param [String] time_string either "M:MM" or decimal
+    # @return [#to_f] converted to a floating-point number
     def time2float time_string
       if time_string =~ /:/
         hours, minutes = time_string.split(':')
         hours.to_f + (minutes.to_f / 60.0)
-      elsif time_string =~ /./
+      else
         time_string.to_f
       end
     end

data/test/app_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+class AppTest < Test::Unit::TestCase
+
+  should "permit commands from the HCl::Commands module" do
+    app = HCl::App.new
+    assert HCl::Commands.instance_methods.all? { |c| app.command? c  }
+  end
+end

data/test/day_entry_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+class DayEntryTest < Test::Unit::TestCase
+  should "read DayEntry xml" do
+    entries = HCl::DayEntry.from_xml(<<-EOD)
+<daily>
+  <for_day type="date">Wed, 18 Oct 2006</for_day>
+  <day_entries>
+    <day_entry>
+      <id type="integer">195168</id>
+      <client>Iridesco</client>
+      <project>Harvest</project>
+      <task>Backend Programming</task>
+      <hours type="float">2.06</hours>
+      <notes>Test api support</notes>
+      <timer_started_at type="datetime">
+        Wed, 18 Oct 2006 09:53:06 -0000
+      </timer_started_at>
+      <created_at type="datetime">Wed, 18 Oct 2006 09:53:06 -0000</created_at>
+    </day_entry>
+  </day_entries>
+</daily>
+    EOD
+    assert_equal 1, entries.size
+    {
+      :project => 'Harvest',
+      :client => 'Iridesco',
+      :task => 'Backend Programming',
+      :notes => 'Test api support',
+      :hours => '2.06',
+    }.each do |method, value|
+      assert_equal value, entries.first.send(method)
+    end
+  end
+
+  should "append to an existing note" do
+    entry = HCl::DayEntry.new(:id => '1', :notes => 'yourmom.', :hours => '1.0')
+    HCl::DayEntry.stubs(:post)
+    entry.append_note('hi world')
+    assert_equal 'yourmom. hi world', entry.notes
+  end
+
+  should "append to an undefined note" do
+    entry = HCl::DayEntry.new(:id => '1', :notes => nil, :hours => '1.0')
+    HCl::DayEntry.stubs(:post)
+    entry.append_note('hi world')
+    assert_equal ' hi world', entry.notes
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'test/unit'
+require 'hcl/app'
+require 'shoulda'
+require 'mocha'

data/test/utility_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class UtilityTest < Test::Unit::TestCase
+  include HCl::Utility
+
+  should "convert decimal input when converting time2float" do
+    assert_equal 2.5, time2float("2.5")
+  end
+
+  should "convert HH:MM input when converting time2float" do
+    assert_equal 2.5, time2float("2:30")
+  end
+
+  should "assume decimal input when converting time2float" do
+    assert_equal 2.0, time2float("2")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zenhob-hcl
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Zack Hobson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-09 00:00:00 -07:00
+date: 2009-08-23 00:00:00 -07:00
 default_executable: hcl
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,8 +62,9 @@ extra_rdoc_files:
 - LICENSE
 - README.markdown
 files: 
+- .document
 - .gitignore
-- .gitmodules
+- CHANGELOG
 - LICENSE
 - README.markdown
 - Rakefile
@@ -71,13 +72,17 @@ files:
 - bin/hcl
 - deps.rip
 - hcl.gemspec
-- hcl_conf.yml.example
 - lib/hcl/app.rb
+- lib/hcl/commands.rb
 - lib/hcl/day_entry.rb
 - lib/hcl/project.rb
 - lib/hcl/task.rb
 - lib/hcl/timesheet_resource.rb
 - lib/hcl/utility.rb
+- test/app_test.rb
+- test/day_entry_test.rb
+- test/test_helper.rb
+- test/utility_test.rb
 has_rdoc: true
 homepage: http://github.com/zenhob/hcl
 licenses: 
@@ -105,5 +110,8 @@ rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: Harvest timesheets from the command-line
-test_files: []
-
+test_files: 
+- test/app_test.rb
+- test/day_entry_test.rb
+- test/test_helper.rb
+- test/utility_test.rb

data/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "ext/harvest"]
-	path = ext/harvest
-	url = git://github.com/aiaio/harvest.git

data/hcl_conf.yml.example

@@ -1,3 +0,0 @@
-subdomain: mycompany
-login: me@mycompany.com
-password: secret