punched 0.1.0

data/README.md

@@ -0,0 +1,138 @@
+# Punchcard
+## Minimal time tracking tool for cli
+
+[![Build Status](https://travis-ci.org/pstaender/punchcard.svg?branch=master)](https://travis-ci.org/pstaender/punchcard)
+
+### Requirements
+
+  * ruby 2+
+  * unix bash (maybe windows works as well?!?)
+
+### Install
+
+```sh
+  $ gem install punched
+```
+
+Or choose your preferred filename and location:
+
+```sh
+  $ echo '#!/usr/bin/env ruby' > /usr/local/bin/punched
+  $ curl https://raw.githubusercontent.com/pstaender/punchcard/master/lib/punchcard.rb >> /usr/local/bin/punched
+  $ curl https://raw.githubusercontent.com/pstaender/punchcard/master/bin/punched >> /usr/local/bin/punched
+  $ chmod +x /usr/local/bin/punched
+```
+
+### Usage
+
+#### Start Project
+
+```sh
+  $ punched start "Punchcard (programming)"
+```
+
+#### Wildcard
+
+Save keystrokes by using wildcard. The last active project, which matches the pattern (case insensitive) will be selected:
+
+```sh
+  $ punched start "Punch*"
+```
+
+#### Stop Project
+
+```sh
+  $ punched stop "Punch*"
+```
+
+#### Toggle
+
+Toggle between start and stop:
+
+```sh
+  $ punched toggle "Punch*"
+```
+
+#### Status
+
+```sh
+  $ punched status "Punch*"
+
+    Punchcard (programming)
+    01:10:09
+```
+
+#### List details
+
+```sh
+  $ punched details "Punch*"
+
+    Punchcard (programming) (stopped)
+
+    00:00:08	2017-05-07 08:16:06 - 2017-05-07 08:16:14
+    00:04:35	2017-05-07 08:22:02 - 2017-05-07 08:26:37
+    ...
+    ========
+    01:10:04	(total)
+```
+
+#### Set Hourly Rate
+
+```sh
+  $ punched set "Punch*" hourlyRate 250€
+```
+
+#### Total time in seconds
+
+```sh
+  $ punched total "Punch*"
+```
+
+#### Rename and delete Project
+
+```sh
+  $ punched rename "Old Title" "New Title"
+```
+
+```sh
+  $ punched remove "Punchcard (programming)"
+```
+
+
+#### List all projects with total time in CSV format
+
+```sh
+  $ punched all
+
+    "project","status","last active on","total duration","hourly rate","earnings"
+    "Website","stopped","2017-05-07 15:50:00","04:06:00","250.0 €","1025.00 €"
+    "Punchcard (programming)","stopped","2017-07-11 12:47:42","01:10:04","",""
+```
+
+You can use `all` with any other action as well, e.g. `punched all stop` to stop all running projects.
+
+Hint: Use your favorite output formatter to get a nicer project summary of your choice; e.g. with [csv2md](https://www.npmjs.com/package/csv2md):
+
+```sh
+  $ punched all | csv2md --pretty
+
+    | project                   | status  | last active on      | total duration | hourly rate | earnings |
+    |---------------------------|---------|---------------------|----------------|-------------|----------|
+    | Website                   | stopped | 2017-05-07 15:50:00 | 04:06:00       | 250.0 €     | 1025.0 € |
+    | Punchcard (programming)   | stopped | 2017-05-07 12:47:42 | 01:10:04       |             |          |
+```
+
+### Store projects files in a custom folder and sync them between computers
+
+By default, PunchCard will store the data in `~/.punchcard/`. Define your custom destination with:
+
+```sh
+  export PUNCHCARD_DIR=~/Nextcloud/punchcard
+```
+
+
+### Tests
+
+```sh
+  $ bundle exec rspec
+```

data/bin/punched

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+$:.push File.expand_path("../lib", __FILE__)
+require 'punchcard'
+
+#
+# CLI Wrapper
+#
+
+def available_actions
+  PunchCard.new(nil).public_methods(false).reject { |item| item.to_s.end_with?('=') }.sort
+end
+
+def action_available? action
+  available_actions.include? action.to_sym
+end
+
+def exit_with_error! msg
+  STDERR.puts msg
+  exit 1
+end
+
+def usage
+  "Usage: #{File.basename(__FILE__)} 'Name of my project' [#{available_actions.join('|')}]"
+end
+
+def all action
+  puts('"project","status","last active on","total duration","hourly rate","earnings"') if action == 'csv'
+  Dir[PunchCard::SETTINGS_DIR+'/*'].sort_by { |f| File.mtime(f) }.reverse.each do |file|
+    puts `ruby #{__FILE__} #{action} '#{File.basename(file)}'`
+  end
+end
+
+if ARGV.first == 'all'
+  all ARGV[1] ? ARGV[1] : 'csv'
+  exit
+elsif ARGV.first && ['-h', '--help', 'help'].include?(ARGV.first)
+  puts usage
+  exit
+end
+
+selected_action = ARGV[0]
+project_name    = ARGV[1]
+
+if selected_action
+  if action_available?(selected_action)
+    exit_with_error!("2nd argument has to be the project name, e.g.:\n#{usage}") if !project_name && selected_action != 'list'
+    punch_card = PunchCard.new project_name
+    begin
+      arguments = ARGV.drop(2)
+      if arguments.size > 0
+        puts punch_card.send(selected_action.to_s, *arguments)
+      else
+        puts punch_card.send(selected_action.to_s)
+      end
+    rescue PunchCardError => e
+      exit_with_error! "Error: #{e.message}"
+    end
+  else
+    exit_with_error! "Unrecognized action '#{selected_action || ''}'\n#{usage}"
+  end
+end

data/lib/punchcard.rb

@@ -0,0 +1,316 @@
+# (c) 2017 by philipp staender
+
+class PunchCardError < StandardError;
+end
+
+class PunchCard
+
+  SETTINGS_DIR        = ENV['PUNCHCARD_DIR'] || File.expand_path('~/.punchcard')
+  HOURLY_RATE_PATTERN = /^\s*(\d+)([^\d]+)*\s*/i
+  TIME_POINT_PATTERN  = /^(\d+)((\-)(\d+))*$/
+  META_KEY_PATTERN    = /^([a-zA-Z0-9]+)\:\s*(.*)$/
+  VERSION             = '0.1.0'
+
+  attr_accessor :project
+
+  def initialize project_name
+    @wilcard_for_filename = ''
+    @meta_data            = {}
+    find_or_make_settings_dir
+    if project_name
+      self.project = project_name
+      find_or_make_file
+      read_project_data
+    end
+  end
+
+  def start
+    output = []
+    if start_time && !end_time
+      output << "'#{project}' already started (#{humanized_total} total)"
+      output << "#{duration(start_time, timestamp)}"
+    else
+      output << "'#{project}' started (#{humanized_total} total)"
+      self.start_time = timestamp
+    end
+    output.join("\n")
+  end
+
+  def stop
+    output = []
+    if end_time
+      output << "'#{@project}' already stopped (#{humanized_total} total)"
+    elsif start_time
+      output << "'#{@project}' stopped (#{humanized_total} total)"
+      self.end_time = timestamp
+    else
+      output << "Nothing to stop"
+    end
+    output.join("\n")
+  end
+
+  def toggle
+    if active?
+      stop
+    else
+      start
+    end
+  end
+
+  def status
+    project_exists_or_stop!
+    find_or_make_file
+    output = []
+    output << (project+" (#{running_status})\n")
+    output << humanized_total
+    output.join("\n")
+  end
+
+  def details
+    project_exists_or_stop!
+    find_or_make_file
+    output = []
+    output << project+" (#{running_status})\n\n"
+    project_data.map do |line|
+      points = line_to_time_points(line)
+      if points
+        starttime = points[0]
+        endtime   = points[1] || timestamp
+        output << duration(starttime, endtime) + "\t" + self.class.format_time(Time.at(starttime)) + " - " + self.class.format_time(Time.at(endtime))
+      end
+    end
+    output << "========\n#{humanized_total}\t(total)"
+    output.join("\n")
+  end
+
+  def csv
+    project_exists_or_stop!
+    find_or_make_file
+    durations = []
+    project_data.map do |line|
+      points = line_to_time_points(line)
+      if points
+        starttime = points[0]
+        endtime   = points[1] || timestamp
+        durations.push duration(starttime, endtime)
+      end
+    end
+    '"'+[
+        @project,
+        running_status,
+        self.class.format_time(File.ctime(project_file)),
+        humanized_total,
+        hourly_rate ? hourly_rate[:hourlyRate].to_s + " #{hourly_rate[:currency]}" : '',
+        hourly_rate ? (hourly_rate[:hourlyRate] * total / 3600.0).round(2).to_s + " #{hourly_rate[:currency]}" : '',
+    ].join('","') + '"'
+  end
+
+  def remove
+    if File.exists?(project_file)
+      File.delete(project_file)
+      "Deleted #{project_file}"
+    end
+  end
+
+  def rename new_project_name
+    old_filename = project_filename
+    data         = project_data
+    data[0]      = new_project_name
+    write_string_to_project_file! data.join("\n")
+    self.project = new_project_name
+    File.rename(old_filename, project_filename) && "#{old_filename} -> #{project_filename}"
+  end
+
+  def project= project_name
+    @project = project_name
+    if @project.end_with?('*')
+      @wilcard_for_filename = "*"
+      @project              = @project.chomp("*")
+    end
+    @project.strip
+  end
+
+  def project
+    @project.strip
+  end
+
+  def set key, value
+    raise PunchCardError.new("Key '#{key}' can only be alphanumeric") unless key.match(/^[a-zA-Z0-9]+$/)
+    @meta_data[key.to_sym] = value
+    write_to_project_file!
+    @meta_data
+  end
+
+  def total
+    total = 0
+    project_data.map do |line|
+      points = line_to_time_points(line)
+      if points
+        starttime = points[0]
+        endtime   = points[1] || timestamp
+        total     += endtime - starttime
+      end
+    end
+    total
+  end
+
+  def self.format_time datetime
+    datetime.strftime('%F %T')
+  end
+
+  private
+
+  def hourly_rate
+    hourly_rate_found = @meta_data[:hourlyRate] && @meta_data[:hourlyRate].match(HOURLY_RATE_PATTERN)
+    if hourly_rate_found
+      {
+          hourlyRate: hourly_rate_found[1].to_f,
+          currency:   hourly_rate_found[2] ? hourly_rate_found[2].strip : '',
+      }
+    else
+      nil
+    end
+  end
+
+  def project_exists_or_stop!
+    raise PunchCardError.new("'#{@project}' does not exists") unless project_exist?
+  end
+
+  def active?
+    running_status == 'running'
+  end
+
+  def running_status
+    start_time && !end_time ? 'running' : 'stopped'
+  end
+
+  def humanized_total
+    humanize_duration total
+  end
+
+  def duration starttime, endtime
+    if starttime
+      humanize_duration endtime - starttime
+    else
+      humanize_duration 0
+    end
+  end
+
+  def humanize_duration duration
+    hours   = duration / (60 * 60)
+    minutes = (duration / 60) % 60
+    seconds = duration % 60
+    "#{decimal_digits(hours)}:#{decimal_digits(minutes)}:#{decimal_digits(seconds)}"
+  end
+
+  def decimal_digits digit
+    if digit.to_i < 10
+      "0#{digit}"
+    else
+      digit.to_s
+    end
+  end
+
+  def start_time
+    time_points ? time_points[0] : nil
+  end
+
+  def start_time= time
+    append_new_line time
+  end
+
+  def end_time= time
+    replace_last_line "#{start_time}-#{time}"
+  end
+
+  def end_time
+    time_points ? time_points[1] : nil
+  end
+
+  def time_points
+    line_to_time_points last_entry
+  end
+
+  def line_to_time_points line
+    matches = line.match(TIME_POINT_PATTERN)
+    matches ? [matches[1].to_i, matches[4] ? matches[4].to_i : nil] : nil
+  end
+
+  def last_entry
+    project_data.last
+  end
+
+  def timestamp
+    Time.now.to_i
+  end
+
+  def read_project_data
+    title      = nil
+    meta_data  = []
+    timestamps = []
+    i          = 0
+    File.open(project_file, "r").each_line do |line|
+      line.strip!
+      if i.zero?
+        title = line
+      elsif line.match(META_KEY_PATTERN)
+        set line.match(META_KEY_PATTERN)[1], line.match(META_KEY_PATTERN)[2]
+      elsif line.match(TIME_POINT_PATTERN)
+        timestamps.push line
+      end
+      i += 1
+    end
+    @project = title if title
+    timestamps
+  end
+
+  def project_data
+    File.open(project_file).each_line.map { |line| line.strip }
+  end
+
+  def write_string_to_project_file! string
+    File.open(project_file, 'w') { |f| f.write(string) }
+  end
+
+  def write_to_project_file!
+    timestamps      = project_data.select { |line| line.match(/^\d+/) }
+    meta_data_lines = @meta_data.map { |key, value| "#{key}: #{value}" }
+    write_string_to_project_file! [@project, meta_data_lines.join("\n"), timestamps].reject(&:empty?).join("\n")
+  end
+
+  def append_new_line line
+    open(project_file, 'a') { |f| f.puts("\n"+line.to_s.strip) }
+  end
+
+  def replace_last_line line
+    data     = project_data
+    data[-1] = line
+    write_string_to_project_file! data.join("\n")
+  end
+
+  def project_file
+    Dir[project_filename + @wilcard_for_filename].sort_by { |f| File.mtime(f) }.reverse.first || project_filename
+  end
+
+  def project_filename
+    SETTINGS_DIR + "/#{sanitize_filename(@project)}"
+  end
+
+  def project_exist?
+    File.exists?(project_file)
+  end
+
+  def find_or_make_file
+    write_string_to_project_file!(@project+"\n") unless project_exist?
+    @project = project_data.first
+  end
+
+  def find_or_make_settings_dir
+    Dir.mkdir(SETTINGS_DIR) unless File.exists?(SETTINGS_DIR)
+  end
+
+  def sanitize_filename name
+    name.downcase.gsub(/(\\|\/)/, '').gsub(/[^0-9a-z.\-]/, '_')
+  end
+
+end

data/punched.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "punchcard"
+
+Gem::Specification.new do |s|
+  s.name               = 'punched'
+  s.version            = PunchCard::VERSION
+  s.authors            = ["Philipp Staender"]
+  s.email              = ["philipp.staender@gmail.com"]
+  s.homepage           = 'https://github.com/pstaender/punchcard'
+  s.summary            = 'Punchcard Timetracker'
+  s.description        = 'Minimal time tracking tool for cli'
+  s.license            = 'GPL-3.0'
+  s.executables        = ['punched']
+  s.default_executable = 'punched'
+  s.rubyforge_project  = 'punched'
+  s.require_paths      = ["lib"]
+  s.files              = `git ls-files`.split("\n")
+end

data/spec/punchcard_spec.rb

@@ -0,0 +1,156 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "punchcard"
+require 'securerandom'
+
+def example_settings_dir
+  File.expand_path('./punchcard_test_data')
+end
+
+def setup_example_settings_dir
+  Dir.glob(example_settings_dir+'/*').each { |file| File.delete(file) }
+  PunchCard.send(:remove_const, :SETTINGS_DIR)
+  PunchCard.const_set(:SETTINGS_DIR, example_settings_dir)
+end
+
+describe PunchCard do
+
+  before do
+    setup_example_settings_dir
+  end
+
+  let(:example_project) { PunchCard.new('My Project') }
+
+  def random_project
+    PunchCard.new("My random Project #{SecureRandom.hex}")
+  end
+
+  def my_project_file filename = 'my_project'
+    File.open("#{example_settings_dir}/#{filename}", "r").read
+  end
+
+  def start_and_stop
+    example_project.start
+    sleep 0.1
+    example_project.stop
+    example_project
+  end
+
+  def two_seconds_tracking
+    example_project.start
+    sleep 2
+    example_project
+  end
+
+  it 'should create a new PunchCard object' do
+    expect(example_project).to be_a(PunchCard)
+  end
+
+  it 'should start a project' do
+    example_project.start
+  end
+
+  it 'should start and stop a project' do
+    start_and_stop
+  end
+
+  it 'should track a project time' do
+    timestamp = Time.now.to_i
+    start_and_stop
+    expect(my_project_file.lines.first.strip).to eq('My Project')
+    expect(my_project_file.lines.last.strip).to match('^'+timestamp.to_s[0..-3]+'\\d{2}\\-'+timestamp.to_s[0..-3]+'\\d{2}+$')
+  end
+
+  it 'should calculate tracked total time' do
+    project      = two_seconds_tracking
+    tracked_time = project.details.lines.last.match(/^\d{2}\:\d{2}\:(\d{2}).*total/)[1].to_i
+    expect(tracked_time).to  be_between 1, 3
+    project      = two_seconds_tracking
+    tracked_time = project.details.lines.last.match(/^\d{2}\:\d{2}\:(\d{2}).*total/)[1].to_i
+    expect(tracked_time).to be_between 3, 5
+  end
+
+  it 'should toggle' do
+    project = start_and_stop
+    expect(project.status.lines.first).to match /stopped/
+    project.toggle
+    expect(project.status.lines.first).to match /running/
+    project.toggle
+    expect(project.status.lines.first).to match /stopped/
+    expect(my_project_file.lines.last).to match(/^\d+/)
+    expect(my_project_file.lines[-2]).to match(/^\d+/)
+  end
+
+  it 'should read and write utf8 names' do
+    PunchCard.new "Playing Motörhead"
+    expect(my_project_file('playing_mot_rhead').strip).to eq("Playing Motörhead")
+    project = PunchCard.new "Playing*"
+    expect(project.project).to eq("Playing Motörhead")
+  end
+
+  it 'should set hourlyRate' do
+    project = start_and_stop
+    project.set 'hourlyRate', "1000 €"
+    expect(my_project_file.lines[1].strip).to eq("hourlyRate: 1000 €")
+  end
+
+  it 'should calculate earnings' do
+    project = start_and_stop
+    project.set 'hourlyRate', "1000EURO"
+    project.toggle
+    sleep 2
+    project.toggle
+    project.toggle
+    sleep 2
+    project.toggle
+    expect(project.csv).to match /^"My Project","stopped","[0-9\-\s\:]+?","[0-9\:]+?","1000.0 EURO","1\.\d+ EURO"$/
+  end
+
+  it 'should track different projects simultanously' do
+    project_a = random_project
+    project_b = random_project
+    expect(project_a.project).not_to eq(project_b.project)
+    project_a.start
+    project_b.start
+    sleep 2
+    project_a.stop
+    sleep 2
+    project_b.stop
+    expect(project_b.total.to_i - project_a.total.to_i).to be_between(2,3)
+  end
+
+  it 'should load latest project by wildcard' do
+    project_a = random_project
+    project   = PunchCard.new "My random*"
+    expect(project.project).to eq(project_a.project)
+    sleep 1
+    project_b = random_project
+    project   = PunchCard.new "My random*"
+    expect(project.project).to eq(project_b.project)
+    expect(project.project).not_to eq(project_a.project)
+  end
+
+  it 'should rename' do
+    project = example_project
+    content = my_project_file
+    project.rename 'Renamed Project'
+    expect(File.open("#{example_settings_dir}/renamed_project", "r").read.strip).to eq(content.strip.sub(/My Project/, 'Renamed Project'))
+    expect(File.exists?("#{example_settings_dir}/my_project")).to be_falsey
+    expect(project.project).to eq('Renamed Project')
+    project.start
+    sleep 0.1
+    project.stop
+    content = File.open("#{example_settings_dir}/renamed_project", "r").read.strip
+    project.rename 'Other Project'
+    expect(File.open("#{example_settings_dir}/other_project", "r").read.strip).to eq(content.strip.sub(/Renamed Project/, 'Other Project'))
+    expect(File.exists?("#{example_settings_dir}/renamed_project")).to be_falsey
+  end
+
+  it 'should remove' do
+    project = example_project
+    expect(File.exists?("#{example_settings_dir}/my_project")).to be_truthy
+    project.remove
+    expect(File.exists?("#{example_settings_dir}/my_project")).to be_falsey
+  end
+
+end