konkit_worklogger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e32fb8f5819a91cc824775e141bf9024ba48693b7996ca2db32c4498d95d8e76
+  data.tar.gz: c86267887802a77e7e066d4ed0893128fd54af7c9b0b7c011fc2a53c1b050b1a
+SHA512:
+  metadata.gz: 5af58d33ff266cd36ea0c5cb6b7cc6616d7dd21e644a014b0eac70376ec0b1e8c8d025ae4b235bebfcc32ebeca74d6c7ece49657db28b2cd9fcf1e631b504628
+  data.tar.gz: a6fa0033fb081ffd0bcff35ab2688d00899b677e734a96e65b593315bb8628a9f3400ad5eeb8ab4d9e4d28f0c02c6fd2b0596f66825022526e9c32d81976a343

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea/
+*.gem
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    konkit_worklogger (0.1.0)
+      thor (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thor (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  konkit_worklogger!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Łukasz Tenerowicz
+
+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,11 @@
+# KonkitWorklogger - log your work automatically
+
+What's the problem with logging work? You have to remember about it.
+How many times have you forgotten to write the start or the end time of your work?
+
+This tool measures how long your computer is turned on. 
+Therefore all you need to care about is to turn your computer off when you finish your day.
+
+Under the hood, it writes a new line to a file each minute (scheduled by cron).
+Then, it gathers all those "minutes" to calculate your work time.
+Because of that, it works even if you have to pause the work for some time - you just need to turn the computer off.

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 'konkit_worklogger'
+
+# 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/bin/worklogger

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'konkit_worklogger'
+require 'thor'
+
+class Worklogger < Thor
+  desc 'today', "Display today's work count"
+  def today
+    configuration = WorkLoggerConfiguration.load
+    today = Date.today
+
+    DaySummaryPrinter.new(configuration).print(today.year, today.month, today.day)
+  end
+
+  desc 'month', "Display month's work count"
+  def month
+    configuration = WorkLoggerConfiguration.load
+    today = Date.today
+
+    MonthSummaryPrinter.new(configuration).print(today.year, today.month)
+  end
+
+  desc 'increment', "Do not run this manually. This is called to increment the minutes' counter"
+  def increment
+    configuration = WorkLoggerConfiguration.load
+    now = Time.now
+
+    Updater.new(configuration).write(now)
+  end
+end
+
+Worklogger.start

data/konkit_worklogger.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/konkit_worklogger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'konkit_worklogger'
+  spec.version       = KonkitWorklogger::VERSION
+  spec.authors       = ['Łukasz Tenerowicz']
+  spec.email         = ['konkit@gmail.com']
+
+  spec.summary       = 'Worklogger'
+  spec.description   = 'Log your time of work automatically with a mechanism based on Cron.'
+  spec.homepage      = 'https://github.com/konkit/konkit_worklogger'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = ['worklogger']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency('rake', '~> 12.0')
+  spec.add_development_dependency('rspec', '~> 3.0')
+  spec.add_dependency('thor', '~> 1.0')
+end

data/konkit_worklogger.iml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="jdk" jdkName="RVM: ruby-2.7.1 [worklogger]" jdkType="RUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.1.4, RVM: ruby-2.7.1 [worklogger]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.3, RVM: ruby-2.7.1 [worklogger]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, RVM: ruby-2.7.1 [worklogger]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.9.0, RVM: ruby-2.7.1 [worklogger]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.9.2, RVM: ruby-2.7.1 [worklogger]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.9.2, RVM: ruby-2.7.1 [worklogger]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.9.1, RVM: ruby-2.7.1 [worklogger]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.9.3, RVM: ruby-2.7.1 [worklogger]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="thor (v1.0.1, RVM: ruby-2.7.1 [worklogger]) [gem]" level="application" />
+  </component>
+</module>

data/lib/konkit_worklogger.rb

@@ -0,0 +1,11 @@
+require 'konkit_worklogger/version'
+require 'konkit_worklogger/day_entry'
+require 'konkit_worklogger/month_entry'
+require 'konkit_worklogger/configuration'
+require 'konkit_worklogger/printer'
+require 'konkit_worklogger/updater'
+
+module KonkitWorklogger
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/konkit_worklogger/configuration.rb

@@ -0,0 +1,35 @@
+require 'yaml'
+require 'fileutils'
+
+class WorkLoggerConfiguration
+  attr_reader :worklogger_path
+
+  def initialize(worklogger_path, config_path = nil)
+    @worklogger_path = worklogger_path
+    @config_path = config_path || '%s/.konkit_worklogger/config.yml' % Dir.home
+  end
+
+  def self.load
+    conf = if File.file?(@config_path)
+             config_file_content = IO.read(@config_path)
+             config = YAML.safe_load(config_file_content)
+
+             worklogger_path = config['path']
+
+             WorkLoggerConfiguration.new(worklogger_path)
+           else
+             default_entries_path = '%s/.konkit_worklogger/timeentries' % Dir.home
+
+             unless File.directory?('%s/.konkit_worklogger/' % Dir.home)
+               FileUtils.mkdir_p('%s/.konkit_worklogger/' % Dir.home)
+             end
+
+             File.open(@config_path, 'w') { |file| file.write({ 'path' => default_entries_path }.to_yaml) }
+             WorkLoggerConfiguration.new(default_entries_path)
+           end
+
+    FileUtils.mkdir_p(conf.worklogger_path) unless File.directory?(conf.worklogger_path)
+
+    conf
+  end
+end

data/lib/konkit_worklogger/day_entry.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'csv'
+require_relative 'utils'
+
+class DayEntry
+  include Utils
+  attr_reader :time_in_minutes, :start_time, :end_time
+
+  def initialize(time_in_minutes, start_time, end_time)
+    @time_in_minutes = time_in_minutes
+    @start_time = start_time
+    @end_time = end_time
+  end
+
+  def time_today
+    minutes_to_time(@time_in_minutes)
+  end
+end
+
+class DayEntryLoader
+  include Utils
+
+  def initialize(configuration)
+    @configuration = configuration
+  end
+
+  def load_from_file(year, month, day)
+    filename = get_filename(@configuration, year, month, day)
+
+    lines ||= CSV.readlines(filename)
+
+    lines_count = lines.length
+
+    start_time = lines[0][0]
+
+    end_time = lines[lines_count - 1][0]
+
+    DayEntry.new(lines_count, start_time, end_time)
+  end
+end

data/lib/konkit_worklogger/month_entry.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'utils'
+
+class MonthEntry
+  attr_reader :time_in_month, :days_worked, :month_balance, :day_entries
+
+  def initialize(time_in_month, days_worked, month_balance, day_entries)
+    @time_in_month = time_in_month
+    @days_worked = days_worked
+    @month_balance = month_balance
+    @day_entries = day_entries
+  end
+end
+
+class MonthEntryLoader
+  def initialize(day_loader)
+    @day_loader = day_loader
+  end
+
+  def load(year, month)
+    minutes_of_work = 0
+    days_worked = 0
+    month_balance = 0
+
+    day_entries = {}
+
+    (1..31).each do |day|
+      begin
+        day_entry = @day_loader.load_from_file(year, month, day)
+
+        unless day_entry.nil?
+          time_in_day = day_entry.time_in_minutes
+
+          day_entries[day] = time_in_day
+          minutes_of_work += time_in_day
+          days_worked += 1
+          month_balance += time_in_day - (8 * 60)
+        end
+      rescue Errno::ENOENT
+      end
+    end
+
+    MonthEntry.new(minutes_of_work, days_worked, month_balance, day_entries)
+  end
+
+  def calculate_balance(year, month)
+    entry = load(year, month)
+    balance_in_sec = entry.month_balance
+
+    balance_in_sec
+  end
+
+  def balance_with_carry(year, month)
+    current_month_entry = load(year, month)
+    previous_month_entry = load(year, month - 1)
+
+    if previous_month_entry.days_worked != 0
+      current_month_entry.month_balance + balance_with_carry(year, month - 1)
+    else
+      current_month_entry.month_balance
+    end
+  end
+end

data/lib/konkit_worklogger/printer.rb

@@ -0,0 +1,41 @@
+class DaySummaryPrinter
+  def initialize(configuration)
+    @configuration = configuration
+  end
+
+  def print(year, month, day)
+    entry = DayEntryLoader.new(@configuration).load_from_file(year, month, day)
+
+    date_string = format('%d-%02d-%02d', year, month, day)
+    puts format('%s: %s - %s (%s)', date_string, entry.start_time, entry.end_time, entry.time_today)
+  end
+end
+
+class MonthSummaryPrinter
+  include Utils
+
+  def initialize(configuration)
+    @configuration = configuration
+  end
+
+  def print(year, month)
+    day_loader = DayEntryLoader.new(@configuration)
+    month_loader = MonthEntryLoader.new(day_loader)
+    entry = month_loader.load(year, month)
+    balance_with_carry = month_loader.balance_with_carry(year, month)
+
+    entry.day_entries.each do |day, minutes|
+      day_of_week_abbr = day_of_week(year, month, day)
+      puts format('%s %s - %s', day_of_week_abbr, day, minutes_to_time(minutes))
+    end
+
+    puts 'Days worked this month: %d' % entry.days_worked
+    puts format('Total count of work hours: %s/%s', minutes_to_time(entry.time_in_month), minutes_to_time(entry.days_worked * 8 * 60))
+    puts 'Balance in current month: %s ' % minutes_to_time(entry.month_balance)
+    puts 'Balance with carry in current month: %s ' % minutes_to_time(balance_with_carry)
+  end
+
+  def day_of_week(year, month, day)
+    Date.new(year, month, day).strftime('%A')[0..2]
+  end
+end

data/lib/konkit_worklogger/updater.rb

@@ -0,0 +1,15 @@
+class Updater
+  include Utils
+
+  def initialize(configuration)
+    @configuration = configuration
+  end
+
+  def write(time)
+    file_path = get_filename(@configuration, time.year, time.month, time.day)
+
+    CSV.open(file_path, 'a+') do |csv|
+      csv << [format('%d:%02d', time.hour, time.min)]
+    end
+  end
+end

data/lib/konkit_worklogger/utils.rb

@@ -0,0 +1,14 @@
+module Utils
+  def minutes_to_time(minutes)
+    full_hours = minutes / 60
+    min_str = (minutes - 60 * full_hours)
+
+    format('%d:%02d', full_hours, min_str)
+  end
+
+  def get_filename(conf, year, month, day)
+    folder_path = format('%s/%d-%02d', conf.worklogger_path, year.to_i, month.to_i)
+    FileUtils.mkdir_p(folder_path) unless File.directory?(folder_path)
+    format('%s/%02d.csv', folder_path, day.to_i)
+  end
+end

data/lib/konkit_worklogger/version.rb

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

data/lib/migration/migrate_old_entries.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../konkit_worklogger/utils'
+require_relative '../konkit_worklogger/configuration'
+require 'fileutils'
+
+class Migration
+  include Utils
+
+  def transform_file(old_fname)
+    config = WorkLoggerConfiguration.load
+
+    old_file_match = old_fname.match(/(?<year>\d\d\d\d)-(?<month>\d\d)-(?<day>\d\d).txt/)
+
+    unless old_file_match.nil?
+      year = old_file_match[:year]
+      month = old_file_match[:month]
+      day = old_file_match[:day]
+
+      new_fname = get_filename(config, year, month, day)
+
+      old_file = File.open(old_fname, 'r')
+      new_file = File.open(new_fname, 'w')
+
+      old_file.each_line do |line|
+        match = line.match(/(\d\d?:\d\d).+/)&.captures
+
+        new_file.write("#{match[0]}\n") unless match.nil? || match.empty?
+      end
+
+      old_file.close
+      new_file.close
+    end
+  end
+end
+
+Dir['*'].select { |f| f =~ /\d\d\d\d\-\d\d\-\d\d\.txt/ }.each do |old_fname|
+  Migration.new.transform_file(old_fname)
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: konkit_worklogger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Łukasz Tenerowicz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Log your time of work automatically with a mechanism based on Cron.
+email:
+- konkit@gmail.com
+executables:
+- worklogger
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/worklogger
+- konkit_worklogger.gemspec
+- konkit_worklogger.iml
+- lib/konkit_worklogger.rb
+- lib/konkit_worklogger/configuration.rb
+- lib/konkit_worklogger/day_entry.rb
+- lib/konkit_worklogger/month_entry.rb
+- lib/konkit_worklogger/printer.rb
+- lib/konkit_worklogger/updater.rb
+- lib/konkit_worklogger/utils.rb
+- lib/konkit_worklogger/version.rb
+- lib/migration/migrate_old_entries.rb
+homepage: https://github.com/konkit/konkit_worklogger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/konkit/konkit_worklogger
+  source_code_uri: https://github.com/konkit/konkit_worklogger
+  changelog_uri: https://github.com/konkit/konkit_worklogger
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Worklogger
+test_files: []