herodot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d271bdd095d68414ea0ba7f6a89c6cdeb4c9172
+  data.tar.gz: 3209c0c6f40cc1897f31d15046ac7e7abd67f140
+SHA512:
+  metadata.gz: b0cd808b0ca16ce2fcd01fc3ffb54407b951ac6cc4d67210d24d9ca80f4ccd70d0cd5fc57f12fe931a82b4ca6f495c3a0e44b08f459dfe8cbb65981d61373a04
+  data.tar.gz: 68cf8e83d777bf0d5fdc6a49e1ad953ee89365f23e26cc533c89a17226a9d48cb343d3710ad1e7e70710a8da9575a59f8ca083aab953ad965d9714a97081281a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  rubocop-bitcrowd:
+    - .rubocop.yml
+    - .rubocop-rspec.yml
+
+Rails:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in herodot.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Andreas Knöpfle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# Herodot
+
+Tracks your work based on git branch checkouts and commits. With herodot every time you switch branches or commit into a branch,
+the brach name, time and project is logged into a worklog file. Herodot can then parse that worklog file and show you a *rough
+estimate* on which branch in which folder you worked on and how long. This can aid you with your personal time tracking.
+
+## Installation
+
+Install with:
+
+    $ gem install herodot
+
+## Usage
+
+Track a git repository:
+
+    $ herodot track [path=.]
+
+
+Show your worklogs this week:
+
+    $ herodot show
+
+    or shorter
+
+    $ herodot
+
+Show last week
+
+    $ herodot show last week
+
+Show worklogs from 19-12-2016
+
+    $ herodot show 19-12-2016
+
+Herodot uses Chronic (https://github.com/mojombo/chronic) under the hood so you can enter anything that chronic supports.
+
+
+Show Help:
+
+    $ herodot help
+    $ herodot help track
+    $ herodot help show
+
+## Configuration
+
+Herodot writes a configuration yaml to `~/.herodot.yml` with something like this:
+
+```
+---
+projects_directory: "~" # Directory where you checkout your projects. Used to shorten paths
+work_times:             # Your work times that are used for guessing the times.
+  work_start: '9:30'
+  lunch_break_start: '13:00'
+  lunch_break_end: '13:30'
+  work_end: '18:00'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bitcrowd/herodot.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'herodot'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/herodot

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'herodot'
+
+Herodot::Application.new.run

data/herodot.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'herodot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'herodot'
+  spec.version       = Herodot::VERSION
+  spec.authors       = ['bitcrowd']
+  spec.email         = ['info@bitcrowd.net']
+  spec.summary       = 'Track your work with your git activity.'
+  spec.description   = 'With herodot you can track the times you spend on a '\
+                       'git branch. When using a branch for each ticket you '\
+                       'work on, herodot helps you with your time tracking.'
+  spec.homepage      = 'https://github.com/bitcrowd/herodot'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = %w(herodot)
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop-bitcrowd'
+  spec.add_dependency 'pry'
+  spec.add_dependency 'terminal-table'
+  spec.add_dependency 'chronic'
+  spec.add_dependency 'commander'
+end

data/lib/herodot/commands.rb

@@ -0,0 +1,31 @@
+require 'chronic'
+require 'fileutils'
+
+class Herodot::Commands
+  SCRIPT = "#!/bin/bash\n"\
+           "echo 'Logging into worklog'\n"\
+           "project=$(pwd)\n"\
+           "branch=$(git rev-parse --abbrev-ref HEAD)\n"\
+           'echo "$(date);$project;$branch" >> ~/worklog'.freeze
+  DEFAULT_RANGE = 'this week'.freeze
+
+  def self.show(args, config)
+    subject = args.empty? ? DEFAULT_RANGE : args.join(' ')
+    range = Chronic.parse(subject, guess: false, context: :past)
+    abort "Date not parsable: #{args.join(' ')}" unless range
+    worklog = Herodot::Parser.parse(range, config)
+    output = Herodot::Table.print(worklog.totals)
+    puts output
+  end
+
+  def self.track(path, config)
+    path = '.' if path.nil?
+    puts "Start tracking of `#{File.expand_path(path)}` into `#{config.worklog_file}`."
+    hooks = "#{path}/.git/hooks"
+    abort('Path is not a git repository.') unless File.exist?(hooks)
+    %w(post-checkout post-commit).each do |name|
+      File.open("#{hooks}/#{name}", 'w') { |file| file.write(SCRIPT) }
+      File.chmod(0o755, "#{hooks}/#{name}")
+    end
+  end
+end

data/lib/herodot/configuration.rb

@@ -0,0 +1,44 @@
+require 'yaml'
+
+class Herodot::Configuration
+  CONFIG_FILE = File.expand_path('~/.herodot.yml').freeze
+  DEFAULT_CONFIGURATION = {
+    'projects_directory' => '~',
+    'work_times' => {
+      'work_start' => '9:30',
+      'lunch_break_start' => '13:00',
+      'lunch_break_end' => '13:30',
+      'work_end' => '18:00'
+    }
+  }.freeze
+
+  def initialize
+    @worklog_file = '~/worklog'
+    if File.exist?(CONFIG_FILE)
+      @config = load_configuration
+    else
+      @config = DEFAULT_CONFIGURATION
+      save_configuration
+    end
+  end
+
+  def worklog_file
+    File.expand_path(@worklog_file)
+  end
+
+  def projects_directory
+    File.expand_path(@config['projects_directory'])
+  end
+
+  def work_times
+    @config['work_times'].map { |k, v| [k.to_sym, v.split(':').map(&:to_i)] }
+  end
+
+  def save_configuration
+    File.open(CONFIG_FILE, 'w') { |f| YAML.dump(@config, f) }
+  end
+
+  def load_configuration
+    File.open(CONFIG_FILE) { |f| YAML.safe_load(f) }
+  end
+end

data/lib/herodot/parser.rb

@@ -0,0 +1,22 @@
+require 'csv'
+require 'pry'
+
+class Herodot::Parser
+  class << self
+    def parse(range, config)
+      worklog = Herodot::Worklog.new(config)
+      from, to = from_to_from_range(range)
+      CSV.foreach(config.worklog_file, col_sep: ';') do |row|
+        next if row[2] == 'HEAD'
+        time = Time.parse(row[0])
+        worklog.add_entry(time, row[1], row[2]) if time >= from && time <= to
+      end
+      worklog
+    end
+
+    def from_to_from_range(range)
+      return [range, Time.now] unless range.respond_to?(:begin) && range.respond_to?(:end)
+      [range.begin, range.end + 3600]
+    end
+  end
+end

data/lib/herodot/table.rb

@@ -0,0 +1,37 @@
+require 'terminal-table'
+
+class Herodot::Table
+  HEADERS = %w(Project Branch Time).freeze
+
+  class << self
+    def format_time(time_is_seconds)
+      total_seconds = time_is_seconds.to_i
+      seconds = total_seconds % 60
+      minutes = (total_seconds / 60) % 60
+      hours = total_seconds / (60 * 60)
+      "#{hours}:#{minutes.to_s.rjust(2, '0')}:#{seconds.to_s.rjust(2, '0')}"
+    end
+
+    def print(worklogs_totals_per_day)
+      Terminal::Table.new(headings: HEADERS) do |table|
+        worklogs_totals_per_day.each do |date, times|
+          table.add_separator
+          table << [date]
+          table.add_separator
+          print_day(times).each { |row| table << row }
+          table.add_separator
+        end
+      end
+    end
+
+    private
+
+    def print_day(times)
+      times.values.group_by { |log| log[:project] }.flat_map do |_, logs|
+        logs.map do |log|
+          [log[:project], log[:branch], format_time(log[:time])]
+        end
+      end
+    end
+  end
+end

data/lib/herodot/version.rb

@@ -0,0 +1,3 @@
+module Herodot
+  VERSION = '0.1.0'.freeze
+end

data/lib/herodot/worklog.rb

@@ -0,0 +1,82 @@
+class Herodot::Worklog
+  attr_reader :branches
+  END_TRACK_EVENTS = [:work_end, :lunch_break_start, :after_last_dates_end].freeze
+  START_TRACK_EVNETS = [:work_start, :lunch_break_end, :before_first_dates_start].freeze
+  EVENTS = (END_TRACK_EVENTS + START_TRACK_EVNETS).freeze
+
+  def initialize(config)
+    @raw_logs = []
+    @branches = {}
+    @dates = []
+    @config = config
+  end
+
+  def add_entry(time, project_path, branch)
+    project = project_path.gsub(@config.projects_directory.to_s, '')
+    id = "#{project}:#{branch}"
+    @raw_logs << { time: time, id: id }
+    @branches[id] = { branch: branch, project: project }
+  end
+
+  def logs_with_events
+    filtered_logs = @raw_logs.chunk { |x| x[:id] }.map(&:last).map(&:first)
+    filtered_logs += work_time_events
+    filtered_logs << { time: Time.new(0), id: :before_first_dates_start }
+    filtered_logs << { time: Time.now, id: :after_last_dates_end }
+    filtered_logs.sort_by { |log| log[:time] }
+  end
+
+  def logs_with_times
+    current_id = nil
+    logs_with_events.each_cons(2).map do |log, following_log|
+      current_id = log[:id] unless EVENTS.include?(log[:id])
+      log.merge id: actual_id(current_id, log[:id]),
+                time: time_between(log, following_log),
+                date: log[:time].to_date
+    end
+  end
+
+  def logs_with_times_cleaned
+    logs_with_times.reject { |log| EVENTS.include?(log[:id]) }
+  end
+
+  def totals
+    grouped = logs_with_times_cleaned.group_by { |time| time[:date] }
+    dates.map do |date|
+      time_sums = grouped[date].each_with_object({}) do |time, sums|
+        id = time[:id]
+        sums[id] ||= { time: 0, project: @branches.dig(id, :project), branch: @branches.dig(id, :branch) }
+        sums[id][:time] += time[:time]
+      end
+      [date, time_sums]
+    end
+  end
+
+  def dates
+    @raw_logs.map { |log| log[:time].to_date }.uniq.sort
+  end
+
+  def work_time_events
+    dates.flat_map do |date|
+      @config.work_times.map do |event, (hour, minute)|
+        {
+          id: event,
+          time: Time.new(date.year, date.month, date.day, hour, minute)
+        }
+      end
+    end
+  end
+
+  def same_date?(log_entry, other_log_entry)
+    log_entry[:time].to_date == other_log_entry[:time].to_date
+  end
+
+  def time_between(log_entry, following_entry)
+    return 0 unless same_date?(log_entry, following_entry)
+    following_entry[:time] - log_entry[:time]
+  end
+
+  def actual_id(current_id, id)
+    END_TRACK_EVENTS.include?(id) ? id : current_id || id
+  end
+end

data/lib/herodot.rb

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'herodot/version'
+require 'herodot/configuration'
+require 'herodot/worklog'
+require 'herodot/parser'
+require 'herodot/commands'
+require 'herodot/table'
+require 'commander'
+
+class Herodot::Application
+  include Commander::Methods
+  USER_HOME = File.expand_path('~').to_s
+
+  def run
+    program :name, 'herodot'
+    program :version, Herodot::VERSION
+    program :description, 'Tracks your work based on git branch checkouts'
+
+    config = Herodot::Configuration.new
+    track_command(config)
+    show_command(config)
+    default_command :show
+    run!
+  end
+
+  TRACK_DESCRIPTION = 'This command sets up post commit and post checkout hooks'\
+                      ', 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.summary = 'Start tracking a repository'
+      c.description = TRACK_DESCRIPTION
+      c.example 'Start tracking current repository', 'herodot track'
+      c.action do |args, _|
+        Herodot::Commands.track(args[0], config)
+      end
+    end
+  end
+
+  SHOW_DESCRIPTION = 'This command parses the worklog file and returns the'\
+                     'git branch based worklog according to the'\
+                     'work times specified in the `~/.herodot.yml`.'.freeze
+  def show_command(config)
+    command :show do |c|
+      c.syntax = 'herodot show [<time range>]'
+      c.summary = 'Shows worklogs'
+      c.description = SHOW_DESCRIPTION
+      show_command_examples(c)
+      c.action do |args, _options|
+        Herodot::Commands.show(args, config)
+      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'
+    c.example 'Shows worklogs for last monday', 'herodot show monday'
+    c.example 'Shows worklogs for 12-12-2016', 'herodot show 12-12-2016'
+  end
+end

data/post-checkout

@@ -0,0 +1,6 @@
+#!/bin/bash
+echo 'Logging into worklog'
+project=$(pwd)
+branch=$(git rev-parse --abbrev-ref HEAD)
+
+echo "$(date);$project;$branch" >> ~/worklog

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: herodot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- bitcrowd
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bitcrowd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: terminal-table
+  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: chronic
+  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: commander
+  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'
+description: With herodot you can track the times you spend on a git branch. When
+  using a branch for each ticket you work on, herodot helps you with your time tracking.
+email:
+- info@bitcrowd.net
+executables:
+- herodot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/herodot
+- herodot.gemspec
+- lib/herodot.rb
+- lib/herodot/commands.rb
+- lib/herodot/configuration.rb
+- lib/herodot/parser.rb
+- lib/herodot/table.rb
+- lib/herodot/version.rb
+- lib/herodot/worklog.rb
+- post-checkout
+homepage: https://github.com/bitcrowd/herodot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Track your work with your git activity.
+test_files: []