hcl 0.4.15 → 0.4.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b075deba585be93e48ef66396c6c847d6b7bf0e0
-  data.tar.gz: 646e8e506006258deaee88748a40820f40d69bbc
+  metadata.gz: 59531588b87aa600b30ee0f3e6325cf4d3ee2528
+  data.tar.gz: 2e3776a004591899b1f54738aadaa270caa7bd6c
 SHA512:
-  metadata.gz: 8694e4acad5a4af641c724d7851ef559b032b097567790bd3d5fcb53cff394969dbcbb3886342036866aa2f310fcf66b0374ce3a6f3deb803956a43175137e7a
-  data.tar.gz: b0d1da651a3bb4e4688dfc664371a74aacab0a5d3b17a75e5e51d4c779032dd9fdbde652d0dc01cc3f80f4539496651e44f15eed962dbc1f7c4b0e8e1bae1dcc
+  metadata.gz: 0817b469cbfe8f933c38c3dfe12da7ce89e234f84c0931cf2b3c94109738a219fcc67cad0d87c205f47363b5a72851ec5ec5de1400da9fed00462155a4f852b2
+  data.tar.gz: bdc62476627578256de28356ac8370d8bce1b02d797c9917d4c4a79f226bf59db1c715da59ae7aca43299866af02abfcb699f633b0ad4e04b6e435d3ee5f1196

data/CHANGELOG.markdown

@@ -1,5 +1,11 @@
 # Recent Changes in HCl
 
+## v0.4.16 2017-02-12
+
+* improved bash completion (from chet0xhenry)
+* fix deprecated `respond_to?` impls, closes #72 (charneykaye)
+* fix manpage installation, closes #75 (thanks to lukehatfield)
+
 ## v0.4.15 2015-06-12
 
 * fix `status` command, closes #59

data/README.markdown

@@ -74,6 +74,15 @@ commands are equivalent:
 
     hcl @tacodev +0:15 Doing some stuff
     hcl +.25 @tacodev Doing some stuff
+    
+### Getting the Current Status
+
+The show command can give you a live view of your current day including
+any running tasks, last note, and total time.
+
+    hcl show
+
+Show can also be used with a variety of date formats. See [Date Formats](#date-formats) for more information
 
 ### Adding Notes to a Running Task
 
@@ -124,15 +133,12 @@ The above starts and immediately stops a one-hour timer with the given note.
 
 ## ADVANCED USAGE
 
-### Bash Auto-completion of Task Aliases
-
-You can enable auto-completion of task aliases by adding this to your shell
-configuration (note the backticks inside the double quotes):
+### Bash Tab Completions
 
-    complete -W "`cat ~/.hcl/aliases`" hcl
+You can enable auto-completion of commands, project ids, task ids and task aliases by adding this to your shell
+configuration:
 
-Warning: You will need to have run `hcl` at least once to create the aliases
-file. Without it, this command will fail with an error.
+    source $(ruby -e "print File.dirname(Gem.bin_path('hcl', 'hcl'))")/_hcl_completions
 
 ### Configuration Profiles
 
@@ -146,7 +152,7 @@ Here is a shell alias `myhcl` with a separate configuration from the
 main `hcl` command, and another command to configure alias completion:
 
     alias myhcl="env HCL_DIR=~/.myhcl hcl"
-    complete -W "`cat ~/.myhcl/aliases`" myhcl
+    complete -F _hcl myhcl
 
 Adding something like the above to your bashrc will enable a new command,
 `myhcl`. When using `myhcl` you can use different credentials and aliases,

data/Rakefile

@@ -6,7 +6,7 @@ task :update_bundle do
   system("bundle")
   system("git ci -am 'update gemfile.lock'")
 end
-task :release => :update_bundle
+task :release => [:update_bundle]
 
 require 'fileutils'
 task :clean do
@@ -22,7 +22,7 @@ task :default => :test
 
 # process the README into a manual page using ronn
 require 'ronn'
-task :man do
+task 'man/hcl.1' do
   print "Writing manual page..."
   head, content = File.read('README.markdown').split("## SYNOPSIS\n")
   content.prepend <<-END
@@ -33,12 +33,12 @@ hcl(1) -- Track time with Harvest time sheets
   END
   FileUtils.mkdir_p('man')
   File.write('man/hcl.1.ronn', content)
-  File.open('man/hcl.1','w').tap do |man|
+  File.open('man/hcl.1','w') do |man|
     man.write Ronn::Document.new('man/hcl.1.ronn').to_roff
   end
   puts "done."
 end
-task "pkg/hcl-#{HCl::VERSION}.gem" => :man
+task :build => 'man/hcl.1'
 
 require 'yard'
 YARD::Rake::YardocTask.new

data/bin/_hcl_completions

@@ -0,0 +1,67 @@
+#!/bin/bash
+
+_hcl_getProjects()
+{
+    $1 tasks | perl -ne 's/ - (?!.* -).*//g; print;' | sed -e 's/\s[0-9]\+\s/ /g' | sed -e 's/\s/ /g' | sort | uniq
+}
+
+_hcl_getTasks()
+{
+    $1 tasks | grep "^$2" | sed -e 's/\s/ /g' | sort | uniq | cut -d" " -f 2-
+}
+
+_hcl()
+{
+    local count=${#COMP_WORDS[@]}
+    local script=${COMP_WORDS[0]}
+    local cur=${COMP_WORDS[COMP_CWORD]}
+    case $count in
+        2)
+            COMPREPLY=( $(compgen -W "start resume log stop note show tasks alias unalias aliases cancel nvm oops config status" -- $cur) )
+            ;;
+        3)
+            local namespace=${COMP_WORDS[1]}
+            
+            case $namespace in
+                'alias')
+                    COMPREPLY=( $(compgen -W "" -- $cur) )
+                ;;
+                'start'|'resume'|'log')
+                    COMPREPLY=( $(compgen -W "$($script aliases | sed -e 's/,//g')" -- $cur) )
+                ;;
+            esac
+            ;;
+        4)
+            local namespace=${COMP_WORDS[1]}
+            local task=${COMP_WORDS[2]}
+            case $namespace in
+                'alias')
+                    local IFS_OLD="$IFS";
+                    local IFS=$'\n';
+                    COMPREPLY=( $(compgen -W "$(_hcl_getProjects $script)" -- $cur) )
+                    local IFS=$IFS_OLD;
+                    if [[ ${#COMPREPLY[*]} -eq 1 ]]; then #Only one completion
+                        COMPREPLY=$(echo $COMPREPLY | sed -e 's/\s.*$//g')
+                    fi
+                ;;
+            esac
+            ;;
+        5)
+            local namespace=${COMP_WORDS[1]}
+            local task=${COMP_WORDS[2]}
+            local projectid=${COMP_WORDS[3]}
+            case $namespace in
+                'alias')
+                    local IFS_OLD="$IFS";
+                    local IFS=$'\n';
+                    COMPREPLY=( $(compgen -W "$(_hcl_getTasks $script $projectid)" -- $cur) )
+                    local IFS=$IFS_OLD;
+                    if [[ ${#COMPREPLY[*]} -eq 1 ]]; then #Only one completion
+                        COMPREPLY=$(echo $COMPREPLY | sed -e 's/\s.*$//g')
+                    fi
+                ;;
+            esac
+            ;;
+    esac 
+}
+complete -F _hcl hcl

data/lib/hcl/app.rb

@@ -48,9 +48,9 @@ module HCl
           if command? @command
             result = send @command, *@args
             if not result.nil?
-              if result.respond_to? :join
+              if result.respond_to? :join, include_all=false
                 puts result.join(', ')
-              elsif result.respond_to? :to_s
+              elsif result.respond_to? :to_s, include_all=false
                 puts result
               end
             end

data/lib/hcl/timesheet_resource.rb

@@ -12,7 +12,7 @@ module HCl
       @data.key?(method.to_sym) ? @data[method] : super
     end
 
-    def respond_to? method
+    def respond_to? method, include_all=false
       (@data && @data.key?(method.to_sym)) || super
     end
 

data/lib/hcl/version.rb

@@ -1,3 +1,3 @@
 module HCl
-  VERSION = '0.4.15'
+  VERSION = '0.4.16'
 end

data/man/hcl.1

@@ -0,0 +1,268 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "HCL" "1" "February 2017" "" ""
+.
+.SH "NAME"
+\fBhcl\fR \- Track time with Harvest time sheets
+.
+.SH "SYNOPSIS"
+.
+.nf
+
+hcl [start] @<task_alias> [+<time>] [<message>]
+hcl note <message>
+hcl stop [<message>]
+hcl resume [@<task_alias>]
+hcl log @<task_alias> [+<time>] [<message>]
+hcl show [<date>]
+hcl tasks [<project_code>]
+hcl alias <task_alias> <project_id> <task_id>
+hcl unalias <task_alias>
+hcl aliases
+hcl (cancel | nvm | oops)
+hcl config
+hcl status
+.
+.fi
+.
+.SH "DESCRIPTION"
+.
+.SS "Available Projects and Tasks"
+To start a new timer you need to identify the project and task\. The tasks command displays a list of available tasks with their project and task IDs\.
+.
+.IP "" 4
+.
+.nf
+
+hcl tasks
+.
+.fi
+.
+.IP "" 0
+.
+.P
+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\.
+.
+.SS "Starting a Timer"
+Since it\'s not practical to enter two long numbers every time you want to identify a task, HCl supports task aliases:
+.
+.IP "" 4
+.
+.nf
+
+hcl alias tacodev 1234 5678
+hcl @tacodev Adding a new feature
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Starting a Timer with Initial Time"
+You can also provide an initial time when starting a new timer\. This can be expressed in floating\-point or HH:MM\. The following two commands are equivalent:
+.
+.IP "" 4
+.
+.nf
+
+hcl @tacodev +0:15 Doing some stuff
+hcl +\.25 @tacodev Doing some stuff
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Getting the Current Status"
+The show command can give you a live view of your current day including any running tasks, last note, and total time\.
+.
+.IP "" 4
+.
+.nf
+
+hcl show
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Show can also be used with a variety of date formats\. See \fIDate Formats\fR for more information
+.
+.SS "Adding Notes to a Running Task"
+While a task is running you can append lines to the task notes:
+.
+.IP "" 4
+.
+.nf
+
+hcl note Then I did something else
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fBNote\fR that \fBshow\fR only displays the last line of the timer notes\. You can list all the notes for a running timer by issuing the note command without any arguments:
+.
+.IP "" 4
+.
+.nf
+
+hcl note
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Stopping a Timer"
+The following command will stop a running timer (currently only one timer at a time is supported)\. You can provide a message when stopping a timer as well:
+.
+.IP "" 4
+.
+.nf
+
+hcl stop All done doing things
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Resuming a Timer"
+You can resume a stopped timer\. Specify a task to resume the last timer for that task:
+.
+.IP "" 4
+.
+.nf
+
+hcl resume
+hcl resume @xdev
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Canceling a Timer"
+If you accidentally started a timer that you didn\'t mean to, you can cancel it:
+.
+.IP "" 4
+.
+.nf
+
+hcl cancel
+.
+.fi
+.
+.IP "" 0
+.
+.P
+This will delete the running timer, or the last\-updated timer if one isn\'t running\. You can also use \fBnvm\fR or \fBoops\fR instead of \fBcancel\fR\.
+.
+.SS "Logging without Starting a Timer"
+You can log time and notes without leaving a timer running\. It takes the same arguments as start:
+.
+.IP "" 4
+.
+.nf
+
+hcl log @xdev +1 Worked for an hour\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The above starts and immediately stops a one\-hour timer with the given note\.
+.
+.SH "ADVANCED USAGE"
+.
+.SS "Bash Tab Completions"
+You can enable auto\-completion of commands, project ids, task ids and task aliases by adding this to your shell configuration:
+.
+.IP "" 4
+.
+.nf
+
+source $(ruby \-e "print File\.dirname(Gem\.bin_path(\'hcl\', \'hcl\'))")/_hcl_completions
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Configuration Profiles"
+You can modify your credentials with the \fB\-\-reauth\fR option, and review them with \fBhcl config\fR\. If you\'d rather store multiple configurations at once, specify an alternate configuration directory in the environment as \fBHCL_DIR\fR\. This can be used to interact with multiple harvest accounts at once\.
+.
+.P
+Here is a shell alias \fBmyhcl\fR with a separate configuration from the main \fBhcl\fR command, and another command to configure alias completion:
+.
+.IP "" 4
+.
+.nf
+
+alias myhcl="env HCL_DIR=~/\.myhcl hcl"
+complete \-F _hcl myhcl
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Adding something like the above to your bashrc will enable a new command, \fBmyhcl\fR\. When using \fBmyhcl\fR you can use different credentials and aliases, while \fBhcl\fR will continue to function with your original configuration\.
+.
+.SS "Interactive Console"
+An interactive Ruby console is provided to allow you to use the fairly powerful Harvest API client built into HCl, since not all of its features are exposed via the command line\. The current {HCl::App} instance is available as \fBhcl\fR\.
+.
+.P
+It\'s also possible to issue HCl commands directly (except \fBalias\fR, see below), or to query specific JSON end points and have the results pretty\-printed:
+.
+.IP "" 4
+.
+.nf
+
+hcl console
+hcl> show "yesterday"
+# => prints yesterday\'s timesheet, note the quotes!
+hcl> hcl\.http\.get(\'daily\')
+# => displays a pretty\-printed version of the JSON output
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Note that the HCl internals may change without notice\. Also, commands (like \fBalias\fR) that are also reserved words in Ruby can\'t be issued directly (use \fBsend :alias\fR instead)\.
+.
+.SS "Date Formats"
+Dates can be expressed in a variety of ways\. See the Chronic documentation \fIhttp://chronic\.rubyforge\.org/\fR for more information about available date input formats\. The following commands show the time sheet for the specified day:
+.
+.IP "" 4
+.
+.nf
+
+hcl show yesterday
+hcl show last friday
+hcl show 2 days ago
+hcl show 1 week ago
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Harvest service status"
+Harvest provides a status API \fIhttp://harveststatus\.com\fR, which you can query using the \fBhcl status\fR command\. This will tell you whether Harvest itself is up, along with a timestamp of when it was last tested\.
+.
+.SH "AUTHOR"
+HCl was designed and implemented by Zack Hobson \fIhttp://github\.com/zenhob\fR\.
+.
+.IP "\(bu" 4
+Non\-SSL support by Michael Bleigh \fIhttp://github\.com/mbleigh\fR\.
+.
+.IP "\(bu" 4
+Resume command by Brian Cooke \fIhttp://github\.com/bricooke\fR\.
+.
+.IP "\(bu" 4
+UI improvements by Chris Scharf \fIhttp://github\.com/scharfie\fR\.
+.
+.IP "" 0
+.
+.P
+See LICENSE for copyright details\.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hcl
 version: !ruby/object:Gem::Version
-  version: 0.4.15
+  version: 0.4.16
 platform: ruby
 authors:
 - Zack Hobson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-13 00:00:00.000000000 Z
+date: 2017-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem-man
@@ -219,6 +219,7 @@ files:
 - LICENSE
 - README.markdown
 - Rakefile
+- bin/_hcl_completions
 - bin/hcl
 - lib/hcl.rb
 - lib/hcl/app.rb
@@ -261,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Harvest timesheets from the command-line