Standardise output for all commands

All commands now output the objects they were operating on, in a user
configurable format. So the `fill` command will output the timeslips
it created to fill gaps, and the `delete` command will output the
timeslips it deleted.

Author: simonwo

Gemfile.lock

@@ -4,6 +4,7 @@ PATH
     freeagent-cli (0.2)
       dotenv (> 2.1.2)
       oauth2 (~> 2)
+      snaky_hash (~> 2.0)
       thor (~> 1.3)
       webrick (~> 1.9)
 

exe/fa

@@ -2,6 +2,7 @@
 
 require 'dotenv/load'
 require 'thor'
+require 'snaky_hash'
 require_relative '../lib/freeagent'
 
 def match type, collection, needle, *values
@@ -34,6 +35,29 @@ module Freeagent
       def api
         @api ||= API.new
       end
+
+      def users
+        @users ||= Hash.new {|cache, url| cache[url] = api.user url.split('/').last }
+      end
+
+      def projects
+        @projects ||= Hash.new {|cache, url| cache[url] = api.project url.split('/').last }
+      end
+
+      def tasks
+        @tasks ||= Hash.new {|cache, url| cache[url] = api.task url.split('/').last }
+      end
+
+      def human timeslip
+        [
+          Date::parse(timeslip.dated_on).strftime('%a %d %b %Y'),
+          users[timeslip.user].email,
+          projects[timeslip.project].name,
+          tasks[timeslip.task].name,
+          timeslip.hours,
+          timeslip.comment
+        ].join("\t")
+      end
     end
 
     desc 'list [-U USER] [-P PROJECT [-T TASK]] [-f FROM] [-t TO]', "List timeslips"
@@ -42,6 +66,7 @@ module Freeagent
     method_option :task, aliases: '-T', type: :string, default: nil, desc: 'Name of a task within the project'
     method_option :from, aliases: '-f', type: :string, default: nil, desc: 'Date to list timeslips from'
     method_option :to, aliases: '-t', type: :string, default: nil, desc: 'Date to list timeslips to'
+    method_option :format, type: :string, default: 'human', desc: 'Output format, one of human or json'
     def list
       raise ArgumentError, '--project must be specified if --task if used' if options[:project].nil? && !options[:task].nil?
 
@@ -51,83 +76,108 @@ module Freeagent
       project = options[:project].nil? ? nil : match(:project, api.projects, options[:project], :name)
       task = options[:task].nil? ? nil : match(:task, api.tasks(project), options[:task], :name)
 
-      users = Hash.new {|cache, url| cache[url] = api.user url.split('/').last }
       users[user.url] = user unless user.nil?
-      projects = Hash.new {|cache, url| cache[url] = api.project url.split('/').last }
       projects[project.url] = project unless project.nil?
-      tasks = Hash.new {|cache, url| cache[url] = api.task url.split('/').last }
       tasks[task.url] = task unless task.nil?
 
       api.timeslips(user: user, project: project, task: task, from: from, to: to).each do |timeslip|
-        puts [
-          Date::parse(timeslip.dated_on).strftime('%a %d %b %Y'),
-          users[timeslip.user].email,
-          projects[timeslip.project].name,
-          tasks[timeslip.task].name,
-          timeslip.hours,
-          timeslip.comment
-        ].join("\t")
+        puts case options[:format].downcase
+        when 'human'; human(timeslip)
+        when 'json'; timeslip.to_json
+        else raise ArgumentError, "unknown output format #{options[:format]}"
+        end
       end
     end
 
     desc 'create USER PROJECT [TASK [FROM [TO]]]', "Create timeslips"
     method_option :hours, aliases: '-h', type: :numeric, default: 8, desc: "Number of hours per day"
     method_option :weekends, aliases: '-w', type: :boolean, default: false, desc: "Create timeslips on Saturdays and Sundays"
     method_option :comment, aliases: '-c', type: :string, default: nil, desc: "Comment to add to any created timeslips"
+    method_option :format, type: :string, default: 'human', desc: 'Output format, one of human or json'
     def create user, project, task = nil, from = nil, to = nil
       from = from.nil? ? Date::today : Date::parse(from)
       to = to.nil? ? from : Date::parse(to)
       user = match :user, api.users, user, :first_name, :last_name, :email
       project = match :project, api.projects, project, :name
       task = select_task project, task
 
-      puts "Creating timeslips for #{user.first_name} #{user.last_name} for task '#{task.name}' in project '#{project.name}' between #{from} and #{to} inclusive"
+      users[user.url] = user unless user.nil?
+      projects[project.url] = project unless project.nil?
+      tasks[task.url] = task unless task.nil?
+
       timeslips = from.step(to).map do |date|
         next if (date.saturday? || date.sunday?) && !options[:weekends]
-        {'task' => task.url, 'project' => project.url, 'user' => user.url, 'dated_on' => date.to_s, 'hours' => options[:hours], 'comment' => options[:comment]}
+        SnakyHash::StringKeyed.new(task: task.url, project: project.url, user: user.url, dated_on: date.to_s, hours: options[:hours], comment: options[:comment])
       end.reject(&:nil?)
       api.batch_create_timeslips timeslips
+      timeslips.each do |timeslip|
+        puts case options[:format].downcase
+        when 'human'; human(timeslip)
+        when 'json'; timeslip.to_json
+        else raise ArgumentError, "unknown output format #{options[:format]}"
+        end
+      end
     end
 
     desc 'fill USER PROJECT [TASK [FROM [TO]]]', 'Fill remaining hours with new timeslips'
     method_option :hours, aliases: '-h', type: :numeric, default: 8, desc: "Number of hours per day"
     method_option :weekends, aliases: '-w', type: :boolean, default: false, desc: "Create timeslips on Saturdays and Sundays"
     method_option :comment, aliases: '-c', type: :string, default: nil, desc: "Comment to add to any created timeslips"
+    method_option :format, type: :string, default: 'human', desc: 'Output format, one of human or json'
     def fill user, project, task = nil, from = nil, to = nil
       from = from.nil? ? Date::today : Date::parse(from)
       to = to.nil? ? from : Date::parse(to)
       user = match :user, api.users, user, :first_name, :last_name, :email
       project = match :project, api.projects, project, :name
       task = select_task project, task
 
+      users[user.url] = user unless user.nil?
+      projects[project.url] = project unless project.nil?
+      tasks[task.url] = task unless task.nil?
+
       existing = api.timeslips(user: user, from: from, to: to).reduce(Hash.new) do |hash, timeslip|
         date = Date::parse timeslip.dated_on
         hash.update({date => (hash[date] || 0) + timeslip.hours.to_f})
       end
 
-      puts "Filling timeslips for #{user.first_name} #{user.last_name} up to #{options[:hours]}hrs using task '#{task.name}' in project '#{project.name}' between #{from} and #{to} inclusive"
       timeslips = from.step(to).map do |date|
         next if (date.saturday? || date.sunday?) && !options[:weekends]
         existing_hours = existing[date] || 0
         adding_hours = options[:hours] - existing_hours
         next if adding_hours <= 0
 
-        {'task' => task.url, 'project' => project.url, 'user' => user.url, 'dated_on' => date.to_s, 'hours' => adding_hours.to_s, 'comment' => options[:comment]}
+        SnakyHash::StringKeyed.new(task: task.url, project: project.url, user: user.url, dated_on: date.to_s, hours: adding_hours.to_s, comment: options[:comment])
       end.reject(&:nil?)
       api.batch_create_timeslips timeslips
+      timeslips.each do |timeslip|
+        puts case options[:format].downcase
+        when 'human'; human(timeslip)
+        when 'json'; timeslip.to_json
+        else raise ArgumentError, "unknown output format #{options[:format]}"
+        end
+      end
     end
 
     desc 'delete USER PROJECT TASK [FROM [TO]]', 'Delete timeslips'
+    method_option :format, type: :string, default: 'human', desc: 'Output format, one of human or json'
     def delete user, project, task, from = nil, to = nil
       from = from.nil? ? Date::today : Date::parse(from)
       to = to.nil? ? from : Date::parse(to)
       user = match :user, api.users, user, :first_name, :last_name, :email
       project = match :project, api.projects, project, :name
       task = match :task, api.tasks(project), task, :name
 
-      puts "Deleting timeslips for #{user.first_name} #{user.last_name} for task '#{task.name}' in project '#{project.name}' between #{from} and #{to} inclusive"
+      users[user.url] = user unless user.nil?
+      projects[project.url] = project unless project.nil?
+      tasks[task.url] = task unless task.nil?
+
       api.timeslips(user: user, project: project, task: task, from: from, to: to).each do |timeslip|
         api.delete_timeslip(timeslip)
+        puts case options[:format].downcase
+        when 'human'; human(timeslip)
+        when 'json'; timeslip.to_json
+        else raise ArgumentError, "unknown output format #{options[:format]}"
+        end
       end
     end
   end

freeagent-cli.gemspec

@@ -48,6 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'webrick', '~> 1.9'
   spec.add_dependency 'thor', '~> 1.3'
   spec.add_dependency 'dotenv', '> 2.1.2'
+  spec.add_dependency 'snaky_hash', '~> 2.0'
 
   spec.add_development_dependency 'rake', '~> 13'