herodot 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29a451b50c5b14cc6e2f1acf802439ce7755932f
-  data.tar.gz: 510e67c25f443cfe889fc5f8b754d3c519dd0b42
+  metadata.gz: 47210cf5317cca524e9519a983cc37f6d51f9434
+  data.tar.gz: a70cf7144148edc5ec91725816af393467c6d24d
 SHA512:
-  metadata.gz: c3040f3a6f6f29870e5a7f0ceb4993f644919be1e81774b6822a51d7187dd829510763a159bc9096c28390bc51960c1c2e021cbb3ee46922753cabb1251a9270
-  data.tar.gz: 76cd7068583335589940f231424fefe727439cea68073e46bf49961a1bb35259e34da07483666fe4a2ca0e5faf82ffe38726f025d31d354942a8eb3ce24087fa
+  metadata.gz: d8590a06ba8a42afcbf55dc4911797bcda422d4b71f5d9eb78a7f9f5e813f5f1fe1af1a009311d3e32727d0652571d7011de70593fbc9413fc1d5aa20a60e730
+  data.tar.gz: 9750bb7f4d5d46c13c5667e240b177f617a830173f69f54a5f2779299b45a0b8d09ab57c35233c3571e2f0f8c932581d3c9efabc822c457fb0f5e4b13646b53a

data/.herodot.yml

@@ -0,0 +1,3 @@
+---
+:link: https://github.com/bitcrowd/herodot/issues/
+:pattern: "\\d+"

data/README.md

@@ -49,6 +49,21 @@ Show Help:
     $ herodot help track
     $ herodot help show
 
+## Linking to issue trackers
+If you use https://github.com/bitcrowd/tickety-tick or otherwise have branch names, that contain
+the issue number, you can link a tracked herodot repository with your issue tracker, so it
+will print urls of issues it recognizes under the branch name.
+
+To use this feature set up a link with
+
+    $ herodot link
+
+You are then guided through the process of linking. When using JIRA or Github with tickety-tick, this should be rather self-explaining, but you can also set up a custom tracker if you are using something different. Just choose `other` and add a URL, to which issue numbers can be appended and a Ruby style regular expression, to cut out the issue number out of your branches.
+
+The result will be written into a  `.herodot.yml` file in the current or specified directory.
+
+HINT: If you do not want to add `.herodot.yml` into your repo or `.gitignore`, you can add it to `./.git/info/exclude` as well. 
+
 ## Configuration
 
 Herodot writes a configuration yaml to `~/.herodot.yml` with something like this:

data/lib/herodot/commands.rb

@@ -14,7 +14,8 @@ class Herodot::Commands
     range = Chronic.parse(subject, guess: false, context: :past)
     abort "Date not parsable: #{args.join(' ')}" unless range
     worklog = Herodot::Parser.parse(range, config)
-    output = Herodot::Output.print(worklog.totals, opts)
+    decorated_worklog = Herodot::ProjectLink.new(worklog)
+    output = Herodot::Output.print(decorated_worklog.totals, opts)
     puts output
   end
 
@@ -29,4 +30,32 @@ class Herodot::Commands
       FileUtils.touch(config.worklog_file)
     end
   end
+
+  def self.link(path)
+    path = '.' if path.nil?
+    choose do |menu|
+      menu.prompt = 'What tracker do you want to link to?'
+      menu.choice(:jira) { link_jira(path) }
+      menu.choice(:github) { link_github(path) }
+      menu.choices(:other) { link_other(path) }
+      menu.default = :other
+    end
+  end
+
+  def self.link_jira(path)
+    prefix = ask('Jira URL prefix (something for https://something.atlassian.net)?')
+    pattern = ask('Ticket prefix (ABCD for tickets like ABCD-123)')
+    Herodot::ProjectLink.link(path, "http://#{prefix}.atlassian.net/browse/", "#{pattern}-\\d+")
+  end
+
+  def self.link_github(path)
+    handle = ask('Github handle (something/something for https://github.com/something/something)?')
+    Herodot::ProjectLink.link(path, "https://github.com/#{handle}/issues/", '\\d+')
+  end
+
+  def self.link_other(path)
+    url = ask('URL to issue tracker:')
+    pattern = ask('Ticket regex pattern (ruby):')
+    Herodot::ProjectLink.link(path, url, pattern)
+  end
 end

data/lib/herodot/output.rb

@@ -49,10 +49,10 @@ class Herodot::Output
     end
 
     def print_day(times)
-      times.values.group_by { |log| log[:project] }.flat_map do |_, logs|
-        logs.map do |log|
-          [colorize(log[:project]), log[:branch], format_time(log[:time])]
-        end
+      times.sort_by { |log| log[:project] }.flat_map do |log|
+        lines = [[colorize(log[:project]), log[:branch], format_time(log[:time])]]
+        lines << ['', Rainbow(log[:link]).color(80, 80, 80), ''] if log[:link]
+        lines
       end
     end
   end

data/lib/herodot/project_link.rb

@@ -0,0 +1,52 @@
+class Herodot::ProjectLink
+  PROJECT_CONFIG = '.herodot.yml'.freeze
+
+  def self.project_config_file(path)
+    File.join(File.expand_path(path), PROJECT_CONFIG)
+  end
+
+  def self.link(path, link, pattern)
+    puts "Write link into #{project_config_file(path)}"
+    File.open(project_config_file(path), 'w') do |f|
+      YAML.dump({ link: link, pattern: pattern }, f)
+    end
+  end
+
+  def initialize(worklog)
+    @worklog = worklog
+    @project_configurations = {}
+  end
+
+  def totals
+    @worklog.totals.map do |date, logs|
+      [date, decorated_logs(logs)]
+    end
+  end
+
+  private
+
+  def decorated_logs(logs)
+    logs.map do |log|
+      decorated_log(log)
+    end
+  end
+
+  def decorated_log(log)
+    link = issue_management_link(log)
+    return log if link.nil?
+    log.merge(link: link)
+  end
+
+  def issue_management_link(log)
+    config = @project_configurations.fetch(log[:path], load_project_configuration(log[:path]))
+    return nil unless config.fetch(:link, false)
+    ticket = log[:branch].scan(Regexp.new(config.fetch(:pattern, /$^/)))
+    [config[:link], ticket.first].join if ticket.any?
+  end
+
+  def load_project_configuration(path)
+    file = self.class.project_config_file(path)
+    return { link: false } unless File.exist?(file)
+    File.open(file) { |f| YAML.load(f) }
+  end
+end

data/lib/herodot/version.rb

@@ -1,3 +1,3 @@
 module Herodot
-  VERSION = '0.1.8'.freeze
+  VERSION = '0.1.9'.freeze
 end

data/lib/herodot/worklog.rb

@@ -15,7 +15,7 @@ class Herodot::Worklog
     project = project_path.gsub(@config.projects_directory.to_s, '')
     id = "#{project}:#{branch}"
     @raw_logs << { time: time, id: id }
-    @branches[id] = { branch: branch, project: project }
+    @branches[id] = { branch: branch, project: project, path: project_path }
   end
 
   def logs_with_events
@@ -48,7 +48,7 @@ class Herodot::Worklog
         sums[id] ||= { time: 0, **branch(id) }
         sums[id][:time] += time[:time]
       end
-      [date, time_sums]
+      [date, time_sums.values]
     end
   end
 

data/lib/herodot.rb

@@ -6,6 +6,7 @@ require_relative 'herodot/worklog'
 require_relative 'herodot/parser'
 require_relative 'herodot/commands'
 require_relative 'herodot/output'
+require_relative 'herodot/project_link'
 
 class Herodot::Application
   include Commander::Methods
@@ -19,6 +20,7 @@ class Herodot::Application
     config = Herodot::Configuration.new
     track_command(config)
     show_command(config)
+    link_command(config)
     default_command :show
     run!
   end
@@ -27,7 +29,7 @@ class Herodot::Application
                       ', that will log the current branch into the worklog file.'.freeze
   def track_command(config)
     command :track do |c|
-      c.syntax = 'herodot track <repository path>'
+      c.syntax = 'herodot track [<repository path>]'
       c.summary = 'Start tracking a repository'
       c.description = TRACK_DESCRIPTION
       c.example 'Start tracking current repository', 'herodot track'
@@ -53,6 +55,20 @@ class Herodot::Application
     end
   end
 
+  LINK_DESCRIPTION = 'This command can link a repository to a project issue tracking tool.'\
+                     ' The commmands writes the settings in `project_path/.herodot.yml`.'.freeze
+  def link_command(_)
+    command :link do |c|
+      c.syntax = 'herodot link [<repository path>]'
+      c.summary = 'Link project with issue tracker'
+      c.description = SHOW_DESCRIPTION
+      c.example 'Link current repository', 'herodot link'
+      c.action do |args, _|
+        Herodot::Commands.link(args[0])
+      end
+    end
+  end
+
   def show_command_examples(c)
     c.example 'Shows this weeks worklogs', 'herodot show'
     c.example 'Shows last weeks worklogs', 'herodot show last week'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: herodot
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - bitcrowd
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-07 00:00:00.000000000 Z
+date: 2017-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -160,6 +160,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".herodot.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -176,6 +177,7 @@ files:
 - lib/herodot/configuration.rb
 - lib/herodot/output.rb
 - lib/herodot/parser.rb
+- lib/herodot/project_link.rb
 - lib/herodot/version.rb
 - lib/herodot/worklog.rb
 - post-checkout