worklog 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1584302fdc1291767a62be5b3873534bec302870088fcb1ca7d707ac149dd339
-  data.tar.gz: 4bd2a089e9fc389f3f9b91345ba1207138713b3aae5950c64d5f3b59af5518dc
+  metadata.gz: f86fec2e2f6cb64723a6604d08a027bfbe953d39426007acbd9a3ed9581b2b09
+  data.tar.gz: 1999d9aa0ea423938ba9492f81ee21585236e69c839f2ee8eb10ff14b19920c5
 SHA512:
-  metadata.gz: 37c9fc32fd5e5bf1ae4ede3c57bf449b9df7aad707165846f54e7960f59ec42c0172e2aca6b97ac923bbab5c778db31964806a05422d9921ef8b47d8a631d2c6
-  data.tar.gz: e49fa11b381af12402e76488c3432e8140fe41e28fcf820283abfe8780675ff0c6e3ad97543ce1b0bca3f2dcc647e3f270e89ff39b29134848ff065d723bf0a7
+  metadata.gz: babe7127b8d55f996b67711b80f095e90dd7b9bf05f211370a709b046439da00dc7140d9944617e866f47b0d2d94cf83f88c7ed49945fd62bc7475d76d4285fd
+  data.tar.gz: '092b877a042ac156d33dd7c0320e1c09b63f441218d610825ff833eaae2cc3cd2d0f66d5cc856a7c1c91d02aa6d980447eab10c919077ad62fd51cebef884a6d'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    worklog (0.1.0)
+    worklog (0.1.1)
       thor (~> 1.0.1)
 
 GEM

data/README.md

@@ -1,12 +1,18 @@
 # Worklog
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/worklog`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Ruby](https://github.com/nvoynov/worklog/actions/workflows/main.yml/badge.svg)](https://github.com/nvoynov/worklog/actions/workflows/main.yml)
 
-TODO: Delete this and the text above, and describe your gem
+Welcome to the `worklog` gem! The gem provides a simple domain-specific language (DSL) for tracking work time and a command-line interface (CLI) for processing the time spent. It'll answer some basic questions like "how much time I've spent on this project this month?", "how much I've earned the previous week?", "how much total effort for the subject was", etc.
+
+Hopefully, this set of [User Stories](user stories.md) helps you catch the basic idea, and the following sections of the README will clarify the usage details.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Just install it yourself as:
+
+    $ gem install worklog
+
+Or you can (now I cannot see meaning doing that, but you certainly can) add this line to your application's Gemfile:
 
 ```ruby
 gem 'worklog'
@@ -16,13 +22,35 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+## Usage
 
-    $ gem install worklog
+### Worklog CLI
 
-## Usage
+The `worklog` gem command-line interface is build on [Thor](https://github.com/rails/thor), so that your first command should be `worklog help` or `thor list`. Then you can get help for each command individually through `worklog help COMMAND`.
+
+### Worklog DSL
+
+The following example shows all the DSL possibilities:
+
+```ruby
+require 'worklog'
+
+sheet = Woklog::DSL.build do
+  title "worklog"
+  author "nvoynov"
+  date_format "%Y-%m-%d" # @see Ruby documentations of Date.strptime
+  hourly_rate 20.00
+
+  track "2021-05-22", spent: "6h30m", task: "working on use cases"
+  track "2021-05-21", spent: "2h", task: "working on user stories", rate: 30 # this is an special hourly rate for overtime
+  track "2021-05-21", spent: "8h", task: "working on user stories"
+  track "2021-05-20", spent: "8h", task: "working on vision document"
+end
+sheet.spent
+sheet.reward
+```
 
-TODO: Write usage instructions here
+I think to make a more serious example (sandbox) with which you can play around and see the commands in action. __TODO__ provide a complex example with multiple subjects and authors, several months of log, etc.
 
 ## Development
 

data/TODO.md

@@ -0,0 +1,30 @@
+% TODO
+
+0. Error handling during parsing files, stop on errors
+1. Check if date_format parameter is valid (Date.strptime)
+2. Rethink commands ...
+   * many subjects and authors possible or not?
+
+I'm a team member and work for several projects in the same period of time
+
+I'm a manager and manage one or more teams, and I want to have effort calculated. There are worklogs for all team member in a project. And I want o calculate ...
+
+Every I can be involved in several projects
+
+# What is there?
+
+There is a set of employees who work for set of projects and fill down worklog for each project separately. Each employee can work for several projects for certain period of time. Each project can involve several team members.
+
+When all worklog loaded - many files, projects, team members ... Now it combined by one project, but there can also be different authors, to that one separate worklog of one author must be combined by (title, author)
+
+... and full report must have
+
+* title,
+* author,
+* date,
+   * year
+   * month
+   * week
+* rate,
+* spent,
+* task

data/lib/worklog/decorator.rb

@@ -31,7 +31,6 @@ module Worklog
     end
 
     # TODO: this year, previous year?
-
     def this_month
       tracks(-> (x,_) { x >= start_of_month(Date.today) })
     end
@@ -45,15 +44,15 @@ module Worklog
 # FIXME: incorrect for sunday 1
     def this_week
       today = Date.today
-      from = today - today.wday + 1
+      from = today - (today.wday - 1) % 7
       tracks(-> (x,_) { x >= from })
     end
 
 # FIXME: incorrect for sunday 1
     def prev_week
       today = Date.today
-      till = today - today.wday # last sunday
-      from = till  - 6          # prev monday
+      from = today - 7 - (today.wday - 1) % 7
+      till = from + 6
       tracks(-> (x,_) { x >= from && x <= till })
     end
 

data/lib/worklog/dsl.rb

@@ -41,6 +41,10 @@ module Worklog
       @sheet.title = title
     end
 
+    def author(author)
+      @sheet.author = author
+    end
+
     def date_format(fmt)
       @sheet.date_format = fmt
     end
@@ -49,6 +53,7 @@ module Worklog
       @sheet.hourly_rate = rate
     end
 
+    # TODO: error handling 
     def read(text)
       instance_eval text
     end

data/lib/worklog/entities/sheet.rb

@@ -10,17 +10,19 @@ module Worklog
     # This class represent sheet of tracks collection
     class Sheet
       attr_reader :tracks
+      attr_accessor :title
+      attr_accessor :author
       attr_accessor :source
       attr_accessor :date_format
       attr_accessor :hourly_rate
-      attr_accessor :title
 
 
       def initialize
         @tracks = {}
         @date_format = "%Y-%m-%d"
         @hourly_rate = 0
-        @title = ""
+        @title =  "Unspecified"
+        @author = "Unspecified"
       end
 
       # This method adds new track to the sheet
@@ -60,6 +62,18 @@ module Worklog
         end
       end
 
+      def spent
+        @tracks.inject(0) {|sum, (d, t)|
+          sum + t.map(&:spent).inject(:+)
+        }
+      end
+
+      def reward
+        @tracks.inject(0) {|sum, (d, t)|
+          sum + t.map(&:reward).inject(:+)          
+        }
+      end
+
     end
   end
 end

data/lib/worklog/printer.rb

@@ -10,9 +10,12 @@ module Worklog
       super
     end
 
-    # TODO: header for this/prev month/week
-    # TODO: grouping by months if there are more than one
     def print(report, subtitle = "")
+      # TODO: provide spec for "no traks found"
+      if report[:items].empty?
+        puts "No tracks found"
+        return
+      end
       puts "-= #{report[:title]} #{subtitle} =-"
       puts %w(Date Year Month Week Spent Reward Task).join(?\t)
       report[:items].each do |track|
@@ -46,11 +49,31 @@ module Worklog
       print(super(), subtitle)
     end
 
-    def this_week; print(super()); end
-    def prev_week; print(super()); end
+    def this_week
+      subtitle = this_week_title
+      print(super(), subtitle)
+    end
+
+    def prev_week
+      subtitle = prev_week_title
+      print(super(), subtitle)
+    end
 
     protected
 
+      def this_week_title
+        today = Date.today
+        from = today - (today.wday - 1) % 7
+        "from #{from} till #{today}"
+      end
+
+      def prev_week_title
+        today = Date.today
+        from = today - 7 - (today.wday - 1) % 7
+        till = from + 6
+        "from #{from} till #{till}"
+      end
+
       def format_spent(spent)
         h = spent / 60
         m = spent % 60

data/lib/worklog/services.rb

@@ -1,6 +1,6 @@
 require_relative "services/service"
-require_relative "services/get_timelogs"
-require_relative "services/new_timelog"
+require_relative "services/get_worklogs"
+require_relative "services/new_worklog"
 
 module Worklog
   module Services

data/lib/worklog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Worklog
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/user stories.md

@@ -0,0 +1,82 @@
+% Worklog User Stories
+
+# Creating worklog
+
+As a User, at any time, I want to create a worklog for any subject, so that I'll have the time spent for the subject recoded.
+
+Main success scenario
+
+1. The user starts the command-line interface, requests the `new` command, and provides `title` and `author` parameters of the new worklog (`worklog new [SUBJECT] [AUTHOR]`).
+2. The system creates worklog file with provided parameters in the working directory.
+
+The new worklog file content
+
+```ruby
+title  "Worklog"
+author "nvoynov"
+date_format "%Y-%m-%d"
+hourly_rate 20
+
+track "2021-07-16", spent: "1h", desc: "creating worklog"
+```
+
+# Logging time
+
+As a User, at any time, I want to record time spent on my tasks, so that I'll have all my efforts recorded. I want to have written down the day, time spent, and task description.
+
+## DSL
+
+I want to record day logged time by adding appropriate text to my worklog. I think it will be convenient enough write straight into the file without any functions from the system side.
+
+## Special hourly rate
+
+I want to have the ability to specify the special hourly rate when I work overtime.
+
+## Multiple tracks per day
+
+I want to have the ability to log several record for one day and by different hourly rates. It must be calculated together by unique date in reporting and combine work descriptions.
+
+```ruby
+on "2021-07-16", spent: "4h30m", desc: "working on user stories"
+on "2021-07-16", spent: "2h30m", desc: "working on crawling use case"
+on "2021-07-16", spent: "2h30m", desc: "working on crawling use case", special_rate: 30
+```
+
+## Multiple files per subject
+
+I want to have several worklogs for single subject, so that I can keep worklog by months
+
+# Getting report
+
+As a User, at any time, I want to get reports based on worklogs, so that I can check my total hours and provide reports for my employer or customers.
+
+## Base report
+
+I want to have a verbose report at the beginning that will have such
+
+## Specifying time period
+
+When I request the report, I want to specify a period of time for the report in some convenient for me manner like "this week", "this month", "pervious month", etc. I want to have "this month" period by default.
+
+## Specifying subject
+
+When I work for several projects, I want to request the report for all subjects, or for chosen subject.
+
+```markdown
+% Nikolay's timesheet for November 2021
+
+Project | Date       | Hours  | Rate | Description
+------- | ---------- | ------ | ---- | -----------
+Audit   | 2021-07-16 | 6h 30m |   20 | working on user stories
+Audit   | 2021-07-17 | 8h 00m |   20 | working on user stories
+
+Total: 14h 30m, $290
+```
+
+## Grouping and subtotals
+
+When I request a report, I want to have the ability to specify data grouping
+
+# Exporting reports
+
+As a User, at any time, I want to export requested reports in a file to send it through the Internet next, so that I can provide reports for my employer and customers. I want "txt" and "csv" formats to be supported.

data/worklog.worklog

@@ -0,0 +1,11 @@
+# self promoting worklog example ;)
+
+title "Worklog"
+author "nvoynov"
+date_format "%Y-%m-%d" # @see Ruby documentations of Date.strptime
+hourly_rate 0
+
+track "2021-07-25", spent: "3h", task: "fixed decorator.prev_week"
+track "2021-07-25", spent: "1h", task: "added user stories and improved README"
+track "2021-07-24", spent: "4h", task: "worklog instead of timelog; released v0.1.0"
+track "2021-07-23", spent: "2h", task: "timelog instead of timesheet"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worklog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nikolay Voynov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-24 00:00:00.000000000 Z
+date: 2021-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -43,6 +43,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
 - bin/setup
 - exe/worklog
@@ -55,11 +56,13 @@ files:
 - lib/worklog/entities/track.rb
 - lib/worklog/printer.rb
 - lib/worklog/services.rb
-- lib/worklog/services/get_timelogs.rb
-- lib/worklog/services/new_timelog.rb
+- lib/worklog/services/get_worklogs.rb
+- lib/worklog/services/new_worklog.rb
 - lib/worklog/services/service.rb
 - lib/worklog/version.rb
+- user stories.md
 - worklog.gemspec
+- worklog.worklog
 homepage: https://github.com/nvoynov/worklog
 licenses:
 - MIT