hcl 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8860d754ce1f11debeb1148da0dfe589df72aff
-  data.tar.gz: 8135fb56ef40b3d6966d31551d842f43182c3192
+  metadata.gz: db61484751f4f46ad0e78d1221bd7c6291812ed8
+  data.tar.gz: 835db00cb847562bb1bfdd32156ce14bae753d36
 SHA512:
-  metadata.gz: dac13754647a2858e99a0d38b276f02e75f0a7140cfb4859f8bfd94231e5b0372865256628ff6c274f7af7162ddc18baf4ac0a5b633063b6bb38d388405ca613
-  data.tar.gz: a4d934b2cb3435cfa90f6caf243f18e4b42a37f428d113044623d6c900750af602182c4b6e54bc73f7b818903881ede611f38c2946774ce90ce7b390990aff0c
+  metadata.gz: 842e229a4dc43d0931f2fed478ec12e78576ad073095994ca71ff9fb9d79c24af4f592af479c0a8d01ae360e69a0a81c4e8084ee30c3d0ad694fe011345c14c8
+  data.tar.gz: 298c413ac8be9f93bd0910ca7da08bb8a7d006ec86078ed1e30317e672d9f7cb13598a87e47caa10f61d1783feef16219bcec5300faa0733598df0e8a1cd84d8

data/CHANGELOG

@@ -1,5 +1,10 @@
 = Recent Changes in HCl
 
+== v0.4.5
+
+* allow filtering of tasks by project code
+* eliminate shoulda from development dependencies
+
 == v0.4.4
 
 * added completion command to output a Bash auto-complete script, closes #34

data/HACKING.markdown

@@ -1,21 +1,16 @@
 # Hacking HCl
 
-## Rubygems
+## Running the tests
 
-They're useful so we use them to install our gems. However there's no need to
-explicitly include rubygems in the app. That's up the system to decide. Don't
-require rubygems in the code.
+Use Bundler to install dependencies before you run the tests:
 
-We require rubygems in the test as a developer convenience.
+    gem install bundler
+    bundle
+    rake test
 
-## Running HCl in place
+## Running HCl during development
 
-This is common and supported:
+To run HCl in place (e.g. for testing out local changes) you can use bundle exec:
 
-  ruby -rubygems -Ilib bin/hcl
+    bundle exec bin/hcl
 
-Don't add dir(__FILE__)/lib to the load path in the binary. Bad manners.
-
-## That's it
-
-That's it. I mostly wrote this to explain why I rolled back certain changes.

data/README.markdown

@@ -15,20 +15,15 @@ or you can install from source:
 
     $ rake install
 
-If you're using HCl for the first time, the show command sets up your
-Harvest credentials:
-
-    $ hcl show
-
 ## Usage
 
     hcl [start] @<task_alias> [+<time>] [<message>]
     hcl note <message>
-    hcl stop [message]
+    hcl stop [<message>]
     hcl resume [@<task_alias>]
     hcl log @<task_alias> [+<time>] [<message>]
-    hcl show [date]
-    hcl tasks
+    hcl show [<date>]
+    hcl tasks [<project_code>]
     hcl alias <task_alias> <project_id> <task_id>
     hcl aliases
     hcl (cancel | nvm | oops)
@@ -41,6 +36,9 @@ available tasks.
 
     $ hcl tasks
 
+You can also pass a project code (this is the short optional code associated
+with each project) to list only the tasks for that project.
+
 ### Starting a Timer
 
 Since it's not practical to enter two long numbers every time you want to

data/lib/hcl/app.rb

@@ -9,20 +9,23 @@ module HCl
     include HCl::Utility
     include HCl::Commands
 
-    SETTINGS_FILE = "#{ENV['HOME']}/.hcl/settings.yml"
-    CONFIG_FILE = "#{ENV['HOME']}/.hcl/config.yml"
+
+    HCL_DIR = ENV['HCL_DIR'] || "#{ENV['HOME']}/.hcl"
+    SETTINGS_FILE = "#{HCL_DIR}/settings.yml"
+    CONFIG_FILE = "#{HCL_DIR}/config.yml"
     OLD_SETTINGS_FILE = "#{ENV['HOME']}/.hcl_settings"
     OLD_CONFIG_FILE = "#{ENV['HOME']}/.hcl_config"
 
-    def initialize
+    def configure
       FileUtils.mkdir_p(File.join(ENV['HOME'], ".hcl"))
       read_config
       read_settings
+      self
     end
 
     # Run the given command and arguments.
     def self.command *args
-      hcl = new.process_args(*args).run
+      new.configure.process_args(*args).run
     end
 
     # Return true if the string is a known command, false otherwise.
@@ -47,10 +50,10 @@ module HCl
               end
             end
           else
-            start @command, *@args
+            puts start(@command, *@args)
           end
         else
-          show
+          puts show
         end
       rescue RuntimeError => e
         STDERR.puts "Error: #{e}"

data/lib/hcl/commands.rb

@@ -3,14 +3,18 @@ require 'highline'
 
 module HCl
   module Commands
-    def tasks
+    def tasks project_code=nil
       tasks = Task.all
+      if tasks.empty? # cache tasks
+        DayEntry.all
+        tasks = Task.all
+      end
+      tasks.select! {|t| t.project.code == project_code } if project_code
       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}" }
+        puts "No matching tasks."
+        exit 1
       end
-      nil
+      tasks.map { |task| "#{task.project.id} #{task.id}\t#{task}" }.join("\n")
     end
 
     def set key = nil, *args
@@ -31,7 +35,7 @@ module HCl
       entry = DayEntry.with_timer || DayEntry.last
       if entry
         if entry.cancel
-          puts "Deleted entry #{entry}."
+          "Deleted entry #{entry}."
         else
           puts "Failed to delete #{entry}!"
           exit 1
@@ -51,14 +55,14 @@ module HCl
 
     def unalias task
       unset "task.#{task}"
-        puts "Removed task alias @#{task}."
+      "Removed task alias @#{task}."
     end
 
     def alias task_name, *value
       task = Task.find *value
       if task
         set "task.#{task_name}", *value
-        puts "Added alias @#{task_name} for #{task}."
+        "Added alias @#{task_name} for #{task}."
       else
         puts "Unrecognized project and task ID: #{value.inspect}"
         exit 1
@@ -83,7 +87,7 @@ module HCl
       timer = task.start \
         :starting_time => starting_time,
         :note => args.join(' ')
-      puts "Started timer for #{timer} (at #{current_time})"
+      "Started timer for #{timer} (at #{current_time})"
     end
 
     def log *args
@@ -96,7 +100,7 @@ module HCl
       if entry
         entry.append_note(args.join(' ')) if args.any?
         entry.toggle
-        puts "Stopped #{entry} (at #{current_time})"
+        "Stopped #{entry} (at #{current_time})"
       else
         puts "No running timers found."
         exit 1
@@ -108,7 +112,7 @@ module HCl
       entry = DayEntry.with_timer
       if entry
         entry.append_note message
-        puts "Added note to #{entry}."
+        "Added note to #{entry}."
       else
         puts "No running timers found."
         exit 1
@@ -118,14 +122,15 @@ module HCl
     def show *args
       date = args.empty? ? nil : Chronic.parse(args.join(' '))
       total_hours = 0.0
+      result = ''
       DayEntry.all(date).each do |day|
         running = day.running? ? '(running) ' : ''
         columns = HighLine::SystemExtensions.terminal_size[0]
-        puts "\t#{day.formatted_hours}\t#{running}#{day.project}: #{day.notes.lines.last}"[0..columns-1]
+        result << "\t#{day.formatted_hours}\t#{running}#{day.project}: #{day.notes.lines.last}\n"[0..columns-1]
         total_hours = total_hours + day.hours.to_f
       end
-      puts "\t" + '-' * 13
-      puts "\t#{as_hours total_hours}\ttotal (as of #{current_time})"
+      result << ("\t" + '-' * 13) << "\n"
+      result << "\t#{as_hours total_hours}\ttotal (as of #{current_time})\n"
     end
 
     def resume *args

data/lib/hcl/task.rb

@@ -45,7 +45,11 @@ module HCl
     end
 
     def to_s
-      "#{project.client} - #{project.name} - #{name}"
+      if project.code.empty?
+        "#{project.client} - #{project.name} - #{name}"
+      else
+        "#{project.client} - [#{project.code}] #{project.name} - #{name}"
+      end
     end
 
     def add opts

data/lib/hcl/version.rb

@@ -1,3 +1,3 @@
 module HCl
-  VERSION = '0.4.4'
+  VERSION = '0.4.5'
 end

data/test/app_test.rb

@@ -1,8 +1,17 @@
 require 'test_helper'
 class AppTest < Test::Unit::TestCase
 
-  should "permit commands from the HCl::Commands module" do
+  def test_commands
     app = HCl::App.new
     assert HCl::Commands.instance_methods.all? { |c| app.command? c  }, 'all methods are commands'
   end
+
+  def test_command_show
+    HCl::DayEntry.expects(:all).returns([HCl::DayEntry.new({
+      hours:'2.06',
+      notes: 'hi world',
+      project: 'App'
+    })])
+    HCl::App.command 'show'
+  end
 end

data/test/command_test.rb

@@ -0,0 +1,99 @@
+require 'test_helper'
+class CommandTest < Test::Unit::TestCase
+  include HCl::Commands
+  include HCl::Utility
+
+  def setup
+    @settings = {}
+  end
+
+  # the current_time utility method needs to be deterministic
+  def current_time
+    'high noon'
+  end
+
+  # stub settings helpers
+  def write_settings; end
+  def read_settings
+    @settings
+  end
+
+  def test_tasks
+    HCl::Task.expects(:all).returns([HCl::Task.new(
+      id:123,
+      name: 'Dev',
+      project: HCl::Project.new(id:456, name:'App', client:'Bob', code:'b')
+    )])
+    result = tasks
+    assert_equal "456 123\tBob - [b] App - Dev", result
+  end
+
+  def test_show
+    HCl::DayEntry.expects(:all).returns([HCl::DayEntry.new({
+      hours:'2.06',
+      notes: 'hi world',
+      project: 'App'
+    })])
+    result = show
+    assert_equal \
+      "\t2:03\tApp: hi world\n\t-------------\n\t2:03\ttotal (as of high noon)\n",
+      result
+  end
+
+  def test_aliases
+    HCl::Task.expects(:all).returns([HCl::Task.new(
+      id:123,
+      name: 'Dev',
+      project: HCl::Project.new(id:456, name:'App', client:'Bob', code:'b')
+    )])
+    result = send :alias, *%w[ hcl 456 123 ]
+    assert_equal '456 123', @settings['task.hcl']
+
+    result = aliases
+    assert_equal ["@hcl"], result
+
+    result = unalias 'hcl'
+    assert !@settings.key?('task.hcl'), 'hcl alias is no longer defined'
+  end
+
+  def test_start
+    task = HCl::Task.new(
+      id:123,
+      name: 'Dev',
+      project: HCl::Project.new(id:456, name:'App', client:'Bob', code:'b')
+    )
+    HCl::Task.expects(:find).with('456','123').returns(task)
+    task.expects(:start).with(starting_time:nil, note:'do stuff')
+    start *%w[ 456 123 do stuff ]
+  end
+
+  def test_stop
+    entry = stub
+    HCl::DayEntry.expects(:with_timer).returns(entry)
+    entry.expects(:append_note).with('all done')
+    entry.expects(:toggle)
+    stop 'all done'
+  end
+
+  def test_resume
+    entry = stub
+    HCl::DayEntry.expects(:last).returns(entry)
+    entry.expects(:toggle)
+    resume
+  end
+
+  def test_cancel
+    entry = stub
+    HCl::DayEntry.expects(:with_timer).returns(entry)
+    entry.expects(:cancel).returns(true)
+    cancel
+  end
+
+  def test_note
+    entry = stub
+    HCl::DayEntry.expects(:with_timer).returns(entry)
+    entry.expects(:append_note).with('hi world')
+    note 'hi world'
+  end
+
+end

data/test/day_entry_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class DayEntryTest < Test::Unit::TestCase
-  should "read DayEntry xml" do
+  def test_from_xml
     entries = HCl::DayEntry.from_xml(<<-EOD)
 <daily>
   <for_day type="date">Wed, 18 Oct 2006</for_day>
@@ -33,14 +33,14 @@ class DayEntryTest < Test::Unit::TestCase
     end
   end
 
-  should "append to an existing note" do
+  def test_append_note
     entry = HCl::DayEntry.new(:id => '1', :notes => 'yourmom.', :hours => '1.0')
     HCl::DayEntry.stubs(:post)
     entry.append_note('hi world')
     assert_equal "yourmom.\nhi world", entry.notes
   end
 
-  should "append to an undefined note" do
+  def test_append_note_to_empty
     entry = HCl::DayEntry.new(:id => '1', :notes => nil, :hours => '1.0')
     HCl::DayEntry.stubs(:post)
     entry.append_note('hi world')

data/test/task_test.rb

@@ -0,0 +1,26 @@
+
+class Task < Test::Unit::TestCase
+  def test_cache_tasks
+    HCl::Task.cache_tasks(REXML::Document.new(<<-EOD))
+<daily>
+  <projects>
+    <project>
+      <name>Click and Type</name>
+      <code></code>
+      <id type="integer">3</id>
+      <client>AFS</client>
+      <tasks>
+        <task>
+          <name>Security support</name>
+          <id type="integer">14</id>
+          <billable type="boolean">true</billable>
+        </task>
+      </tasks>
+    </project>
+  </projects>
+</daily>
+    EOD
+    assert_equal 1, HCl::Task.all.size
+    assert_equal 'Security support', HCl::Task.all.first.name
+  end
+end

data/test/test_helper.rb

@@ -1,7 +1,20 @@
-$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'bundler'
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/test/'
+  add_filter do |source_file|
+    source_file.lines.count < 15
+  end
+end
 
-require 'rubygems'
 require 'test/unit'
-require 'hcl'
-require 'shoulda'
 require 'mocha/setup'
+require 'fileutils'
+
+# override the default hcl dir
+FileUtils.mkdir_p __dir__+"/dot_hcl"
+ENV['HCL_DIR'] = __dir__+"/dot_hcl"
+
+require 'hcl'
+
+

data/test/utility_test.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hcl
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Zack Hobson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-20 00:00:00.000000000 Z
+date: 2013-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -131,7 +131,9 @@ files:
 - lib/hcl/version.rb
 - lib/hcl.rb
 - test/app_test.rb
+- test/command_test.rb
 - test/day_entry_test.rb
+- test/task_test.rb
 - test/test_helper.rb
 - test/utility_test.rb
 homepage: http://zackhobson.com/hcl/