task_report 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: deb93afc5fb2fc5f81288039cd66cf095fe45203
-  data.tar.gz: b69535adc26bd8afea35c91f299fcdb6a0cbb950
+  metadata.gz: 908081dcb425e2557ce5daa1076c7d2946e55c33
+  data.tar.gz: 67ce04ed13abdd51cc1535a0aeab9d0f152de912
 SHA512:
-  metadata.gz: d3c5c02da2772745835d6cdea939934ae4870e0e1b8f499ab180c67742be3672f471dd6ab87ef5500169d746915320b7210f61ebf90f2d6818d4bda8427f418e
-  data.tar.gz: bd682a0a40a426ae4f2e777619834bbe930017adf99f78079a190f212a06752993dac617bb663c54c61808e96d1e62080fea9f8e982ab1caa175b5555e18c9a4
+  metadata.gz: b5944f6161c7a43abb051eae208bb4403da3989de3335268adbd7862461c56eff92074d540aa770a3b1bf1d3c7d24ec5a175e9beff545b95ada59963be33f2c5
+  data.tar.gz: b4b41dc1a3a062bc9cf5a6684d75f89768747e141bac581bc52a3a23dc486dc040c241466c28566d3c35041a11383491fa65dd7514a7f86995b84d291870c882

data/README.md

@@ -1,6 +1,6 @@
 ## Description
 
-This tool enables you to track where your time goes via a private [gist](https://gist.github.com). The data itself is stored in a gist as json, and a formatted summary can be generated and shared (TODO, right now there's only a stdout summary). This means that task tracking is not tied to any specific machine, but rather a github account.
+This tool enables you to track where your time goes via a private [gist](https://gist.github.com). The data itself is stored in a gist as json, and a formatted summary can be generated and shared (coming soon, actually. Right now there is only a stdout summary). This means that task tracking is not tied to any specific machine, but rather a github account.
 
 ## Installation
 
@@ -40,8 +40,10 @@ Use `task` as follows:
   `task list`
     - Lists all of today's tasks
 
-  `task summary`
+  `task summary [--gist, -g]`
     - prints a task summary to the command line
+    - if the `--gist` or `-g` options are used, creates a markdown gist summary
+      and prints the link to stdout
 
   `task delete {TASK-ID, TASK-DESCRIPTION, today, gist}`
     - deletes the provided task if it exists
@@ -52,25 +54,27 @@ Use `task` as follows:
     - shows this message
 ```
 
-## System Requirements
+## Dependencies
 
 - ruby >= 2.3.0
 
 ## TODO:
 
 - [x] `continue`
-- [ ] `info`
 - [x] `delete`
-- [ ] confirmation messages for `delete`
 - [x] `list`
 - [x] `current`
 - [x] basic `summary`
+- [x] gist `summary`
 - [x] add configuration file support
-- [ ] gist `summary`
 - [x] setup install
+- [ ] `info` - display information about the current gist file (url, etc)
+- [ ] confirmation messages for `delete`
 - [ ] add jira support?
   - at the very least, a ticket field
+  - stretch goal: add the ability to make new issues, and update time estimates for existing ones
 - [ ] allow `summary` to take a gist id, so you can retroactively generate summaries
+- [ ] add User.name as well as User.github_username, so we an pretty print
 
 ## License
 

data/VERSION

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

data/bin/task

@@ -22,8 +22,10 @@ def show_usage_message(exit_status = 0)
   `task list`
     - Lists all of today's tasks
 
-  `task summary`
+  `task summary [--gist, -g]`
     - prints a task summary to the command line
+    - if the `--gist` or `-g` options are used, creates a markdown gist summary
+      and prints the link to stdout
 
   `task delete {TASK-ID, TASK-DESCRIPTION, today, gist}`
     - deletes the provided task if it exists
@@ -52,7 +54,7 @@ when 'delete'
 when 'current'
   TaskReport.current
 when 'summary'
-  TaskReport.summary
+  TaskReport.summary(ARGV[1])
 else
   show_usage_message
 end

data/lib/task_report.rb

@@ -98,11 +98,21 @@ module TaskReport
       puts 'Something went wrong. There are multiple ongoing tasks.'
     end
 
-    def summary
+    def summary(options)
       return if no_gist?
 
       @report ||= Report.create_from_gist(report_gist)
-      @report.print_summary
+
+      if ['--gist', '-g'].include? options
+        @report.gist_summary
+      else
+        unless options.nil?
+          puts "The #{options} option is not recorgnized.\n"\
+               "Printing the summary to the stdout.\n\n"
+        end
+
+        @report.print_summary
+      end
     end
 
     private

data/lib/task_report/report.rb

@@ -30,6 +30,7 @@ module TaskReport
           description: gist_description,
           json_file_name: json_file_name,
           gist_id: gist['id'],
+          gist_html_url: gist['html_url'],
           existing_json_content: Gist.file_content(raw_url)
         )
       end
@@ -114,19 +115,40 @@ module TaskReport
       end
     end
 
+    def gist_summary
+      if @tasks.empty?
+        puts 'There are no tasks reported for today.'
+        return
+      end
+
+      puts 'Creating a gist summary.'
+
+      Gist.edit(@gist_id,
+        description: @description, # do we actually need this? Seems odd...
+        files: {
+          'summary.md' => {
+            content: gist_summary_content
+          }
+        }
+      )
+
+      puts "#{@gist_html_url}#file-summary-md"
+    end
+
     def save_to_gist!
       if @gist_id
-        edit_existing_gist!
+        edit_existing_data_gist!
       else
-        save_new_gist!
+        save_new_data_gist!
       end
     end
 
     private
-      def initialize(description:, json_file_name:, gist_id: nil, existing_json_content: {})
+      def initialize(description:, json_file_name:, gist_id: nil, gist_html_url: nil, existing_json_content: {})
         @description = description
         @json_file_name = json_file_name
         @gist_id = gist_id
+        @gist_html_url = gist_html_url
 
         @date = Time.parse(
           existing_json_content.fetch('date', Time.now.strftime('%Y-%m-%d %z'))
@@ -149,7 +171,7 @@ module TaskReport
         JSON.pretty_generate(to_h)
       end
 
-      def save_new_gist!
+      def save_new_data_gist!
         puts "Starting a new report gist for the day."
 
         Gist.create(
@@ -163,7 +185,7 @@ module TaskReport
         )
       end
 
-      def edit_existing_gist!
+      def edit_existing_data_gist!
         puts "Saving to today's report gist."
 
         Gist.edit(@gist_id,
@@ -198,5 +220,16 @@ module TaskReport
       def ensure_only_one_ongoing_task!
         raise MultipleOngoingTasks if @tasks.count(&:ongoing?) > 1
       end
+
+      def gist_summary_content
+        lines = ["## #{User.name} Task Report #{@date.strftime('%Y-%m-%d')}", '']
+
+        @tasks.each do |task|
+          lines << "- '#{task.description}'"
+          lines << "  - #{task.duration.to_s}"
+        end
+
+        lines.join("\n")
+      end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: task_report
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Mat Pataki