toolshed 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c985d9e718e2feed7ec333208251e24c1db2f3e
-  data.tar.gz: 4401c13b81de6f31d52c7470c4b332b0e0742e57
+  metadata.gz: 2735e0a05ef49646976753969a095916a4f00324
+  data.tar.gz: aa781e23427a9534108d1d0727ea3b27fa90f142
 SHA512:
-  metadata.gz: e8932dd259abcf841c0b225db249089c8e083a5b4960b6049fa697988654fd7730f55517aa7d8c7392f216cc365d9e68aa8f4556463a0a328808af68cf4118d4
-  data.tar.gz: f24035635ed27bd5fb3de8979dbc26b60423f16db943528f6b809ebf427981cb1c39061ea469d1a4170fd43458f1ea41ececca1b54818fd53c39e18c004ab676
+  metadata.gz: aae5bc491f329b09cf07dd0768ae979b8f7883b5b67e3db2a57c26a11419ccb3da8538f8b8907a0b30627c30a6973bf16a357ba3855c7dd7c45cbc7b164def0d
+  data.tar.gz: 473ce7fb64bf9394874fc726fe5b8730297c3604d7a6ebdc8e761f06f6d790905cf1e536bd6e00337c157aa6f2e8301958cfb5cc7f218f2ec40d694cca6ea81a

data/bin/toolshed.rb

@@ -52,7 +52,12 @@ create_pull_request [                   # create a github pull request based on
   --title "Pull Request Title"          # Title you want to use with the pull request
   --body "Pull Request Body"            # Body you want to use with the pull request
 ]
-get_pivotal_tracker_story_information   # Get the ticket information from a PivotalTracker story based on project_id and story_id
+ticket_information [                    # Get the ticket information from a story based on ticket system configuration
+  --use-defaults="true|false"           # If you want to use defaults ticket_id is taken from branch_name otherwise configuration is used
+  --clipboard="true|false"              # Copy the output to the system clipboard (Mac OSx) tested
+  --field="field_name"                  # The field you want to either output or copy to your clipboard
+  --formatted-string="{name} - {url}    # Pass a formatted string in ticket name and url and it will return that string replaced by the actual value
+]
 create_pivotal_tracker_note             # Create a note for a specific PivotalTracker story based on project_id and story_id
 update_pivotal_tracker_story_status     # Update the status of PivotalTracker story
 create_branch [                         # Create a branch default (git) and push it to your local repository
@@ -66,7 +71,9 @@ push_branch [                           # Push your current working branch to yo
   --force                               # Push your current working branch up with --force after
   --branch-name "another"               # Push this specific branch up instead of your current working branch
 ]
-get_daily_time_update                   # Get a daily update from your time tracking toolset currently harvest is supported
+get_daily_time_update [                 # Get a daily update from your time tracking toolset currently harvest is supported
+  --format="html|text"                  # Format you want if you want html it will open html page in broswer otherwise puts out plain text
+]
 list_branches [                         # List branches for your remote repository
   --repository-name "depot"             # The repository name you want to list branches for if not passed pull_from_repository_name is used
 ]
@@ -149,6 +156,25 @@ if $0.split("/").last == 'toolshed'
         options[:branch_name] = opt
       end
     end,
+    'get_daily_time_update' => OptionParser.new do |opts|
+      opts.on("--format [ARG]") do |opt|
+        options[:format] = opt
+      end
+    end,
+    'ticket_information' => OptionParser.new do |opts|
+      opts.on("--use-defaults [ARG]") do |opt|
+        options[:use_defaults] = opt
+      end
+      opts.on("--clipboard [ARG]") do |opt|
+        options[:clipboard] = opt
+      end
+      opts.on("--field [ARG]") do |opt|
+        options[:field] = opt
+      end
+      opts.on("--formatted-string [ARG]") do |opt|
+        options[:formatted_string] = opt
+      end
+    end,
   }
 
   global.order!

data/lib/toolshed.rb

@@ -3,6 +3,8 @@ require 'httparty'
 require 'pivotal-tracker'
 require 'harvested'
 require 'veto'
+require 'launchy'
+require 'clipboard'
 
 module Toolshed
   BLANK_REGEX = /\S+/

data/lib/toolshed/base.rb

@@ -1,6 +1,18 @@
 module Toolshed
   class Base
-    # implement base methods here
+    def self.wait_for_command(command, seconds=10)
+      begin
+        Timeout::timeout(seconds) {
+          until (system(command))
+            sleep 1
+          end
+          return
+        }
+      rescue Timeout::Error => e
+        puts "Unable to execute command after #{seconds} seconds"
+        return
+      end
+    end
   end
 end
 

data/lib/toolshed/cli.rb

@@ -23,7 +23,7 @@ module Toolshed
       {
         'create_pull_request'                   => Toolshed::Commands::CreatePullRequest,
         'create_pivotal_tracker_note'           => Toolshed::Commands::CreatePivotalTrackerNote,
-        'get_pivotal_tracker_story_information' => Toolshed::Commands::GetPivotalTrackerStoryInformation,
+        'ticket_information'                    => Toolshed::Commands::TicketInformation,
         'update_pivotal_tracker_story_status'   => Toolshed::Commands::UpdatePivotalTrackerStoryStatus,
         'create_branch'                         => Toolshed::Commands::CreateBranch,
         'checkout_branch'                       => Toolshed::Commands::CheckoutBranch,
@@ -38,7 +38,7 @@ end
 
 require 'toolshed/commands/create_pull_request'
 require 'toolshed/commands/create_pivotal_tracker_note'
-require 'toolshed/commands/get_pivotal_tracker_story_information'
+require 'toolshed/commands/ticket_information'
 require 'toolshed/commands/update_pivotal_tracker_story_status'
 require 'toolshed/commands/create_branch'
 require 'toolshed/commands/checkout_branch'

data/lib/toolshed/commands/get_daily_time_update.rb

@@ -3,14 +3,24 @@ module Toolshed
     class GetDailyTimeUpdate
       def execute(args, options = {})
         if (Toolshed::Client.time_tracking_tool == 'harvest')
-          harvest = Toolshed::TimeTracking::Harvest.new
+          harvest = Toolshed::TimeTracking::Harvest.new(options)
 
           puts "Getting time entries:"
           
           notes = harvest.previous
-          notes = "#{notes}\n\n#{harvest.today}"
+          notes = "#{notes}#{harvest.line_break}#{harvest.line_break}#{harvest.today}"
+          notes = "#{notes}#{harvest.brought_to_you_by_message}"
 
-          puts notes
+          if (harvest.format == 'html')
+            FileUtils.rm_rf(Toolshed::TimeTracking::Harvest::GENERATED_HTML_FILE_LOCATION)
+            File.open(Toolshed::TimeTracking::Harvest::GENERATED_HTML_FILE_LOCATION, 'w') {|f| f.write(notes) }
+            Launchy.open( Toolshed::TimeTracking::Harvest::GENERATED_HTML_FILE_LOCATION ) do |exception|
+              puts "Attempted to open #{uri} and failed because #{exception}"
+            end
+            puts "Checkout out your default or open browser!"
+          else
+            puts notes
+          end
         else
           puts "Time tracking tool is undefined implementation needed"
           exit

data/lib/toolshed/commands/ticket_information.rb

@@ -0,0 +1,79 @@
+module Toolshed
+  module Commands
+    class TicketInformation
+      def execute(args, options = {})
+        begin
+          ticket_tracker_class =  Object.const_get("Toolshed::TicketTracking::#{Toolshed::Client.ticket_tracking_tool.camel_case}")
+
+          if Object.const_get("#{ticket_tracker_class}::USE_PROJECT_ID")
+            ticket_tracker_project_id = read_user_input_project_id("Project ID (Default: #{Toolshed::Client.default_pivotal_tracker_project_id}):", options.merge!({ default: Toolshed::Client.default_pivotal_tracker_project_id }))
+            options.merge!({ project_id: ticket_tracker_project_id })
+          end
+
+          ticket_tracker = ticket_tracker_class.create_instance(options)
+
+          default_ticket_id = Toolshed::TicketTracking::PivotalTracker::story_id_from_branch_name(Toolshed::Git::Base.branch_name)
+          ticket_id = read_user_input_ticket_id("Story ID (Default: #{default_ticket_id}):", options.merge!({ default: default_ticket_id }))
+
+          if Object.const_get("#{ticket_tracker_class}::USE_PROJECT_ID")
+            puts "Using Project: #{ticket_tracker_project_id}"
+          end
+          puts "Using Ticket: #{ticket_id}"
+
+          result = ticket_tracker.story_information(ticket_id)
+
+          if (options[:field])
+            field_value = result.send(options[:field])
+            if (options[:clipboard])
+              Clipboard.copy field_value
+            end
+
+            puts field_value
+          elsif(options[:formatted_string])
+            formatted_string = options[:formatted_string].gsub(/\{(.*?)\}/) { |m| result.send(m.gsub("{", "").gsub("}", "")) }
+            if (options[:clipboard])
+              Clipboard.copy formatted_string
+            end
+
+            puts formatted_string
+          else
+            result.instance_variables.each do |name, value|
+              puts "#{name}: #{result.instance_variable_get(name).inspect}"
+            end
+          end
+
+          return
+        rescue => e
+          puts e.message
+          exit
+        end
+      end
+
+      def read_user_input_project_id(message, options)
+        return options[:default] if (options.has_key?(:use_defaults))
+
+        puts message
+        value = $stdin.gets.chomp
+
+        if (value.empty?)
+          value = options[:default]
+        end
+
+        value
+      end
+
+      def read_user_input_ticket_id(message, options)
+        return options[:default] if (options.has_key?(:use_defaults))
+
+        puts message
+        value = $stdin.gets.chomp
+
+        if (value.empty?)
+          value = options[:default]
+        end
+
+        value
+      end
+    end
+  end
+end

data/lib/toolshed/git/git.rb

@@ -17,14 +17,10 @@ module Toolshed
 
     def checkout(branch_name)
       branch_name = Toolshed::Git::Base.branch_name_from_id(branch_name)
-      until system("git checkout #{branch_name} #{Toolshed::Client.git_quiet}")
-        sleep 1
-      end
+      Toolshed::Base.wait_for_command("git checkout #{branch_name} #{Toolshed::Client.git_quiet}")
 
       unless (Toolshed::Git::Base.git_submodule_command.empty?)
-        until system(Toolshed::Git::Base.git_submodule_command)
-          sleep 1
-        end
+        Toolshed::Base.wait_for_command(Toolshed::Git::Base.git_submodule_command)
       end
 
       branch_name
@@ -38,9 +34,7 @@ module Toolshed
         Toolshed::Git::Base.checkout('master')
       end
 
-      until system("git push #{Toolshed::Client.push_to_remote_name} :#{branch_name}; git branch -D #{branch_name}")
-        sleep 1
-      end
+      Toolshed::Base.wait_for_command("git push #{Toolshed::Client.push_to_remote_name} :#{branch_name}; git branch -D #{branch_name}")
 
       branch_name
     end
@@ -62,9 +56,7 @@ module Toolshed
       branch_name = (options.has_key?(:branch_name)) ? Toolshed::Git::Base.branch_name_from_id(options[:branch_name]) : Toolshed::Git::Base.branch_name
       force_command = (options.has_key?(:force_command)) ? '--force' : ''
 
-      until system("git push #{Toolshed::Client.push_to_remote_name} #{branch_name} #{force_command}")
-        sleep 1
-      end
+      Toolshed::Base.wait_for_command("git push #{Toolshed::Client.push_to_remote_name} #{branch_name} #{force_command}")
 
       branch_name
     end
@@ -111,23 +103,15 @@ module Toolshed
         self.validator.validate!(self)
 
         new_branch_name = Toolshed::Git::Base.clean_branch_name(self.to_remote_branch_name)
-        until system("git remote update #{Toolshed::Client.git_quiet}")
-          sleep 1
-        end
+        Toolshed::Base.wait_for_command("git remote update #{Toolshed::Client.git_quiet}")
 
-        until system("git checkout -b #{new_branch_name} #{self.from_remote_name}/#{self.from_remote_branch_name} #{Toolshed::Client.git_quiet}")
-          sleep 1
-        end
+        Toolshed::Base.wait_for_command("git checkout -b #{new_branch_name} #{self.from_remote_name}/#{self.from_remote_branch_name} #{Toolshed::Client.git_quiet}")
 
         unless (Toolshed::Git::Base.git_submodule_command.empty?)
-          until system(Toolshed::Git::Base.git_submodule_command)
-            sleep 1
-          end
+          Toolshed::Base.wait_for_command(Toolshed::Git::Base.git_submodule_command)
         end
 
-        until system("git push #{self.to_remote_name} #{new_branch_name} #{Toolshed::Client.git_quiet}")
-          sleep 1
-        end
+        Toolshed::Base.wait_for_command("git push #{self.to_remote_name} #{new_branch_name} #{Toolshed::Client.git_quiet}")
       end
     end
   end

data/lib/toolshed/time_tracking/harvest.rb

@@ -4,8 +4,9 @@ module Toolshed
       extend TimeTracking
 
       MAX_ATTEMPTS = 10
+      GENERATED_HTML_FILE_LOCATION = '/tmp/toolshed_generated_time_sheet.html'
 
-      attr_accessor :harvest_client, :project_id
+      attr_accessor :harvest_client, :project_id, :line_break, :start_list_item, :end_list_item, :start_unorder_list, :end_unorder_list, :format
 
       def initialize(options={})
         username = Toolshed::Client::time_tracking_username
@@ -24,18 +25,27 @@ module Toolshed
            owner = options[:sub_domain]
         end
 
-        self.harvest_client = ::Harvest.client('ackmanndickenson', 'jwaller@ackmanndickenson.com', 'V0AU2gRMLhs1')
+        self.harvest_client = ::Harvest.client(owner, username, password)
         self.project_id = self.get_project_id
+
+        # setup formatting
+        formatter(options)
       end
 
-      def previous(days_ago=1)
-        notes = "Previous:\n\n"
+      def previous(days_ago=1, options={})
+
+        notes = "Previous:#{self.line_break}"
 
         time_entries = self.harvest_client.time.all((DateTime.now - days_ago), self.project_id)
         if (time_entries.size > 0 || days_ago == Toolshed::TimeTracking::Harvest::MAX_ATTEMPTS)
+          notes = "#{notes}#{self.start_unorder_list}"
           time_entries.each do |time_entry|
-            notes = "#{notes}#{time_entry.notes}\n"
+            notes = "#{notes}#{self.start_list_item}#{time_entry.notes}#{self.end_list_item}"
+            if (self.end_list_item == '')
+              notes = "#{notes}#{self.line_break}"
+            end
           end
+          notes = "#{notes}#{self.end_unorder_list}"
         else
           notes = self.previous(days_ago + 1)
         end
@@ -44,12 +54,17 @@ module Toolshed
       end
 
       def today
-        notes = "Today:\n\n"
+        notes = "Today:#{self.line_break}"
 
         time_entries = self.harvest_client.time.all(Time.now, self.project_id)
+        notes = "#{notes}#{self.start_unorder_list}"
         time_entries.each do |time_entry|
-          notes = "#{notes}#{time_entry.notes}\n"
+          notes = "#{notes}#{self.start_list_item}#{time_entry.notes}#{self.end_list_item}"
+          if (self.end_list_item == '')
+            notes = "#{notes}#{self.line_break}"
+          end
         end
+        notes = "#{notes}#{self.end_unorder_list}"
 
         notes
       end
@@ -63,6 +78,28 @@ module Toolshed
 
         project_id
       end
+
+      def brought_to_you_by_message
+        "#{self.line_break}Provided by Toolshed https://rubygems.org/gems/toolshed#{self.line_break}"
+      end
+
+      def formatter(options={})
+        if (options[:format] && options[:format] == 'html')
+          self.format = 'html'
+          self.line_break = "<br>"
+          self.start_list_item = "<li>"
+          self.end_list_item = "</li>"
+          self.start_unorder_list = "<ul>"
+          self.end_unorder_list = "</ul>"
+        else
+          self.format = 'text'
+          self.line_break = "\n"
+          self.start_list_item = ""
+          self.end_list_item = ""
+          self.start_unorder_list = ""
+          self.end_unorder_list = ""
+        end
+      end
     end
   end
 end

data/lib/toolshed/version.rb

@@ -1,3 +1,3 @@
 module Toolshed
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/toolshed.gemspec

@@ -14,8 +14,8 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = ["toolshed"]
-  #spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  #spec.executables   = ["toolshed"]
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "pivotal-tracker"
   spec.add_dependency "harvested"
   spec.add_dependency "veto"
+  spec.add_dependency "launchy"
+  spec.add_dependency "clipboard"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toolshed
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - test
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -80,6 +80,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: clipboard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +226,7 @@ email:
 - test@gmail.com
 executables:
 - toolshed
+- toolshed.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -219,9 +248,9 @@ files:
 - lib/toolshed/commands/create_pull_request.rb
 - lib/toolshed/commands/delete_branch.rb
 - lib/toolshed/commands/get_daily_time_update.rb
-- lib/toolshed/commands/get_pivotal_tracker_story_information.rb
 - lib/toolshed/commands/list_branches.rb
 - lib/toolshed/commands/push_branch.rb
+- lib/toolshed/commands/ticket_information.rb
 - lib/toolshed/commands/update_pivotal_tracker_story_status.rb
 - lib/toolshed/error.rb
 - lib/toolshed/git/git.rb

data/lib/toolshed/commands/get_pivotal_tracker_story_information.rb

@@ -1,37 +0,0 @@
-module Toolshed
-  module Commands
-    class GetPivotalTrackerStoryInformation
-      def execute(args, options = {})
-        begin
-          print "Project ID (Default: #{Toolshed::Client.default_pivotal_tracker_project_id})? "
-          project_id = $stdin.gets.chomp.strip
-          if (project_id == '')
-            project_id = Toolshed::Client.default_pivotal_tracker_project_id
-          end
-
-          pivotal_tracker = Toolshed::TicketTracking::PivotalTracker.new({
-              project_id: project_id,
-              username: Toolshed::TicketTracking::PivotalTracker.username,
-              password: Toolshed::TicketTracking::PivotalTracker.password,
-          })
-
-          default_story_id = Toolshed::TicketTracking::PivotalTracker::story_id_from_branch_name(Toolshed::Git::Base.branch_name)
-          print "Story ID (Default: #{default_story_id})? "
-          story_id = $stdin.gets.chomp.strip
-          if (story_id == '')
-            story_id = default_story_id
-          end
-
-          result = pivotal_tracker.story_information(story_id)
-          result.instance_variables.each do |name, value|
-            puts "#{name}: #{result.instance_variable_get(name).inspect}"
-          end
-          exit
-        rescue => e
-          puts e.message
-          exit
-        end
-      end
-    end
-  end
-end