now-task-manager 0.1.0

data/doc/formats/today.md

@@ -0,0 +1,115 @@
+# `Today` format
+
+This format is used for tasks that are being worked on today.
+
+```
+Morning routine (7:50 – 9:20)
+✔ Headspace. #meditation
+✘ Go swimming. #exercise
+  Reason: Some clever excuse.
+✔ Eat breakfast.
+✔ [20] Spanish flashcards. #learning
+
+Admin (9:20 – 12)
+✔ [9:20-10:00] Inbox 0.
+  I should allocate more time to it from now on.
+
+  Some more comment line 1
+  Some more comment line 2
+- [started at 10:00] Print out invoices.
+- Review GitHub issues.
+- [11:40] Call with Sonia.
+
+Lunch break (12 – 13)
+
+Work for client 1 (13 – 17)
+- Issue#87.
+
+Evening (after 17)
+- Free style meditation. #meditation
+```
+
+## Metadata
+
+Metadata are indented lines following a task.
+
+There can be either lines, subtasks or key value pairs or a combination of either.
+
+### Lines
+
+```
+I should allocate more time to it from now on.
+
+Some more comment line 1.
+Some more comment line 2.
+```
+
+This will turn into:
+
+```ruby
+[
+  "I should allocate more time to it from now on.",
+  "Some more comment line 1. Some more comment line 2."
+]
+```
+
+### Key-value pairs
+
+```
+- [8:25-8:41] Research EU residency permit:
+  Link: http://www.migrant.info.pl/temporary-residence-permit.html, http://www.migrant.info.pl/residence-card.html
+  Outcome: This is what I need.
+  Next: Apply for http://www.migrant.info.pl/temporary-residence-permit.html # -> This makes the task.
+  Review: Upon my return from CZ/ES. # -> This makes a headline.
+
+- [10:09-10:20] Push the code from Cloud9 to GH and clone it from my mac.
+  Skipped: SSH keys issues, I requested it to be researched.
+
+- [11:42-12:20] Clean up the flat, find my MasterCard.
+  Comment: It took me a good while to find the card. # VNORENY.
+    I have to clean up the mess and keep it clean!
+
+- Headspace.
+  Skipped: Instead of meditating, I wrote a command to play the next HS episode and, to remember them. I tend to forget which episode I'm on.
+
+- Millennium: pick up EUR.
+  Postponed: Queue too long.
+
+- [11:31-11:41] Review my moleskine to see whether I need to take it with me.
+  Outcome: I don't need to take it.
+
+✔ Inquire about why the payment failed.
+  Waiting for: Response.
+  Review: Tomorrow.
+
+- [9:51-9:59] Inquire about why the payment failed.
+  Review: tomorrow.
+```
+
+### Subtasks
+
+```
+- [9:37-9:51] Plan the CZ/ES trip and make the reservations for PRG.
+  ✔ Book accommodation in PRG.
+  - Ping Macarena.
+```
+
+## Considered features
+
+#### Nested time frames
+
+Very often an action is interrupted by an other. If it takes 5 minutes, it's irrelevant to log it, but what if it took half of the afternoon?
+
+NOTE: http://kschiess.github.io/parslet/parser.html last to chapters explain how to create the recursion.
+
+```
+Work for client 1 (13 – 17)
+- Issue#87.
+
+  Emergency (2 – 3:30)
+  ✔ Extinguish fire in the living room.
+
+- Task
+```
+
+_There are detailed [unit specs](spec/pomodoro/parser) for the format._

data/doc/getting-started.md

@@ -0,0 +1,41 @@
+_This document is WIP._
+
+# Getting started
+
+_If you don't understand any term, read [terms](https://github.com/botanicus/now-task-manager/blob/master/doc/terms.md)_
+
+1. Define your schedules.
+
+There are two types of tasks: tasks to be done **today** and **scheduled tasks**.
+
+
+## Schedules
+
+The real fun starts with using schedules.
+
+```ruby
+# ~/.config/pomodoro/schedules/base.rb
+rule(:weekday, -> { today.weekday? }) do |tasks|
+  tasks.push(*morning_ritual_tasks)
+  tasks << Pomodoro::Task.new('TopTal.', 20, [:online, :work])
+  tasks << work_tasks[rand(work_tasks.length)]
+  tasks.push(*lunch_break_tasks)
+  tasks << Pomodoro::Task.new(project_of_the_week, 90, [:project_of_the_week, :online])
+  tasks << cleanup_tasks[rand(cleanup_tasks.length)]
+  tasks.push(*evening_tasks)
+end
+```
+
+# Configuration
+
+```yaml
+# ~/.config/pomodoro.yml
+---
+schedule:  ~/Dropbox/Data/Data/Pomodoro/Schedules/schedules.rb
+routine:   ~/Dropbox/Data/Data/Pomodoro/Schedules/base.rb
+today:     ~/Dropbox/Data/Data/Pomodoro/Tasks/%Y-%m-%d.today
+task_list: ~/Dropbox/Data/WIP/tasks.todo
+```
+
+- [today format](https://github.com/botanicus/now-task-manager/blob/master/doc/formats/today.md)
+- [schedule task list format](https://github.com/botanicus/now-task-manager/blob/master/doc/formats/scheduled.md)

data/doc/integrations.md

@@ -0,0 +1,68 @@
+_This document is WIP._
+
+https://github.com/blog/2231-building-your-first-atom-plugin
+
+- Writing Vim plugins http://stevelosh.com/blog/2011/09/writing-vim-plugins/
+- Vim plugin documentation http://learnvimscriptthehardway.stevelosh.com/chapters/54.html
+
+## BitBar plugin
+
+[BitBar](https://getbitbar.com/)
+
+```shell
+tee ~/.bitbar/pomodoro.1s.sh <<EOF
+#!/bin/sh
+
+log-time --bitbar
+EOF
+```
+
+![](https://raw.githubusercontent.com/botanicus/now-task-manager/master/doc/more-than-5m.png)
+![](https://raw.githubusercontent.com/botanicus/now-task-manager/master/doc/less-than-5m.png)
+
+## ZSH prompt.
+
+![](https://raw.githubusercontent.com/botanicus/now-task-manager/master/doc/prompt.png)
+
+## Limiting online access
+
+_TODO_
+This is why I wrote it in the first place.
+
+## OS X notifications
+
+`~/Library/LaunchAgents/botanicus.pomodoro_notification.plist`
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>Label</key>
+    <string>botanicus.pomodoro_notification</string>
+
+    <key>ProgramArguments</key>
+    <array>
+      <string>zsh</string>
+      <string>-c</string>
+      <string>pomodoro-loop</string>
+    </array>
+
+    <key>RunAtLoad</key>
+    <true />
+
+    <key>KeepAlive</key>
+    <true />
+
+    <!-- I don't have permissions to write into /var/log. -->
+    <key>StandardOutPath</key>
+    <string>/tmp/botanicus.pomodoro_notification.stdout</string>
+    <key>StandardErrorPath</key>
+    <string>/tmp/botanicus.pomodoro_notification.stderr</string>
+  </dict>
+</plist>
+```
+
+```shell
+launchctl load -w ~/Library/LaunchAgents/botanicus.pomodoro_notification.plist
+```

data/doc/terms.md

@@ -0,0 +1,32 @@
+### Time frames (not the same as time boxes for tasks)
+
+I always had some kind of semi-functional task list in place, but my work organisation
+was still hardly existent at all. It wasn't until I started to use time framing that this changed.
+
+Time frame is a block of time you give to a project. Your schedule is then time frames of a day
+
+```
+Morning routine (from 7:50)
+Admin (from 9:20)
+Work for client 1 (10:00 – 12:00)
+Lunch break (12:00 – 13)
+Work for client 2 (13 – 18)
+```
+
+### Schedules
+
+You are likely to have more schedules than one. I have one for Tuesday when I have
+a class from 6 and therefore I have to move my work session earlier, one for Wednesday
+when I have my Spanish class in the morning, one for the other work days,
+one for Saturday and one for Sunday.
+
+Using the [holidays gem](https://github.com/holidays/holidays) you can easily
+chose your Sunday schedule for a bank holiday.
+
+I have a different morning routine on Mondays and Thursdays, I go swimming, but
+since it fits into the given time frame, I do this in automatically scheduled tasks
+while keeping the schedule the same.
+
+### Automatically scheduled tasks
+
+### Scheduled tasks

data/doc/workflow.md

@@ -0,0 +1,60 @@
+_This document is WIP._
+
+## The workflow
+
+_If you don't understand any term, read [terms](https://github.com/botanicus/now-task-manager/blob/master/doc/terms.md)_
+
+![Workflow diagram](https://raw.githubusercontent.com/botanicus/now-task-manager/master/doc/diagram.png)
+
+### Planning
+
+In the evening you'll do `pomodoro edit tomorrow`. This will check your schedules and picks one to use. Schedule is a list of time frames, for instance for a work day we could have something like this:
+
+```
+Morning routine (from 7:50)
+Work for client 1 (9:20 – 12:00)
+Lunch break (12:00 – 13)
+Work for client 2 (13 – 18)
+```
+
+Then it will try to prepopulate the schedule with tasks. There will be various sources:
+
+- The scheduled lists.
+- Automatically scheduled tasks.
+- Unfinished tasks from today and postponed tasks.
+
+## Doing
+
+3. Next day you simply start getting through your list using `pomodoro next` and `pomodoro complete` (as well as `pomodoro postpone` and `pomodoro move_on`).
+
+The tasks will be looked for in the current time frame. That is even if you have unfinished tasks, if a new time frame started, the tool will pick a task from the newly started one.
+
+### Today tasks
+
+![](https://raw.githubusercontent.com/botanicus/now-task-manager/master/doc/img/today-annotated.png)
+
+- Tasks are stored in readable plain text format.
+- Command-line interface.
+- [Vim plugin](https://github.com/botanicus/now-task-manager/tree/master/support/vim).
+- BitBar plugin.
+
+### Scheduled tasks
+
+Scheduled tasks are either scheduled for a certain **date** (tomorrow, next Friday etc), for a ceratin **context** (next time I'm in Prague etc) or just generally for **later**.
+
+```
+Tomorrow
+- Buy milk.
+
+Prague
+- Pick up my shoes.
+
+Later
+- Fix the expense gem.
+```
+
+That's all there is to it. It's a simple text file and you can edit it to your liking.
+
+The only shortcut you get is `pomodoro + Another task.` which will add a task to the list for later.
+
+_**Read next**: [getting started](https://github.com/botanicus/now-task-manager/blob/master/doc/getting-started.md)_

data/lib/pomodoro.rb

@@ -0,0 +1,6 @@
+require 'pomodoro/config'
+require 'pomodoro/parser/today_parser'
+require 'pomodoro/parser/today_transformer'
+require 'pomodoro/parser/task_list_parser'
+require 'pomodoro/parser/task_list_transformer'
+require 'pomodoro/task_list'

data/lib/pomodoro/commands/bitbar.rb

@@ -0,0 +1,87 @@
+require 'pomodoro/exts/hour'
+
+module Pomodoro
+  module Commands
+    class BitBar
+      def self.heading(current_time_frame)
+        if current_time_frame
+          self.heading_work_in_progress(current_time_frame)
+        else
+          ['black', self.heading_default_icon]
+        end
+      end
+
+      def self.heading_default_icon
+        "| image=iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JQAAgIMAAPn/AACA6QAAdTAAAOpgAAA6mAAAF2+SX8VGAAACx1BMVEUAAAAhZ5QmerEmgLkmgLomgLomgLomgLomgLomgLkme7EhZ5QAAAAeYYwlerIcWogZTHkaTn0aTn0aTn0aTn0aTn0aTXocW4klerIfYYwicaUaZJtRXGurrLCur7NWYW4aZZoicaUhcacUWpN7hZWCi5gWXJQhcKcebqUTWZN9h5eDjJsUW5UebqUca6QRV5N8h5eDjJoSWZQca6QaaKMPVZJ8h5eDjJoQV5QaaKMXZqINU5F8h5eDjJoPVZMXZqIVY6AMUZB8h5eDjJoNU5IVY6ETX58LTo98h5eDjJoMUJATX58SXJwKTI18h5eDjJoLTo8SXJwRWJoJSYx9h5eDjJoKS40RWJsQVJcKSYx/iJeBipcKSY0QVJcORHwNU50yUnlVaYZTaIVTaIVTaIVTaIVTaIVUaIUwUXcNU50ORH0GGzENRH8LUZ0JUKAJUaEJUaEJUaEJUaEJUaEJUKALUZ4NRH8GHDIAAAADDBcIJUYILFQILFQILFQILFQILFQILFQILFQIJUYDDRgAAACxs7ewsrewsrewsrexs7f29fT19PT09PT09PT09PT09PT29fX39vb39vX19PPy8vLy8vLy8vLy8vL09PTf39/Jycny8fD19PPy8vLz8/Py8vLy8vLy8vK1tbVeXl6wsLD19fT19PPq6ura2trz8/Py8vKlpaVISEisrKzy8vL19fT29vXS0tJeXl60tLS0tLRFRUWlpaX09PTy8vL19PT19PPx8fGfn59JSUlISEiGhobv7+/z8/Py8vL19PT19PPz8/Pu7u6Pj49lZWXd3d309PTy8vLy8vL19PT19PPy8vLz8/Pl5eXMzMzy8vLy8vLy8vLy8vL19PT19PPy8vLy8vLz8/P09PTy8vLy8vLy8vLy8vL19fTz8e/v7u3v7u3v7u3v7u3v7u3v7u3v7u3v7u3y8e////+EY5Z8AAAAhXRSTlMDW8nf3t7e3t7fylwESeT////////////lS5b///////+YpP////+kpP////+kpP////+kpP////+kpP////+kpP////+kpP////+kpP////+kpP////+ko/////+jhf7////////////+hi3A+/7+/v7+/v77wi8AMomjpKSkpKSjiTMB0B5+TQAAAAFiS0dE7CG5sxsAAAAJcEhZcwAACxMAAAsTAQCanBgAAAAHdElNRQfhAhQRBSmWVlRBAAABG0lEQVQY0wEQAe/+AAABAgMEBQYGBgYHCAkKCwwADQ4PEBESExMTExQVFhcYGQAaGxwdhYaHh4eHiIkeHyAhACIjJIqLjI2Njo+QkZIlJicAKCkqk5SVlZaXmJmamyssLQAuLzCcnZ6foKGio6SlMTIzADQ1NqanqKmqq6ytrq83ODkAOjs8sLGys7S1tre4uT0+PwBAQUK6u7y9vr/AwcLDQ0RFAEZHSMTFxsfIycrLzM1JSksATE1Ozs/Q0dLT1NXW109QUQBSU1TY2drb3N3e3+DhVVZXAFhZWuLj5OXm5+jp6utbXF0AXl9gYWJjZGRkZGVmZ2hpagBrbG1ub3BxcXFxcnN0dXZ3AHh5ent8fX5+fn5/gIGCg4Sov3NOEAy3KQAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAxNy0wMi0yMFQxNzowNTo0MS0wNTowMHrHzbIAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMTctMDItMjBUMTc6MDU6NDEtMDU6MDALmnUOAAAAAElFTkSuQmCC"
+      end
+
+      def self.heading_work_in_progress(current_time_frame)
+        colour = self.colour_based_on_remaining_duration(current_time_frame)
+        [colour, "#{current_time_frame.name} | color=#{colour}"]
+      end
+
+      def self.colour_based_on_remaining_duration(current_time_frame)
+        if current_time_frame.remaining_duration.nil?
+          'gray'
+        elsif current_time_frame.remaining_duration < Hour.new(0, 10)
+          'red'
+        elsif current_time_frame.remaining_duration < Hour.new(0, 30)
+          'blue'
+        else
+          'green'
+        end
+      end
+
+      def self.with_active_time_frame(current_time_frame)
+        if current_time_frame
+          if current_time_frame.interval[1]
+            puts "#{current_time_frame.interval[0]}-#{current_time_frame.interval[1]} (#{current_time_frame.remaining_duration}h remaining) | color=#{colour}"
+          else
+            puts "After #{current_time_frame.interval[0]} | color=gray"
+          end
+          current_time_frame.tasks.each do |task|
+            colour = {unstarted: 'blue', in_progress: 'red', finished: 'gray', postponed: 'gray'}[task.status]
+            puts "#{task} | color=#{colour}"
+          end
+        elsif Time.now.hour < 14
+          today_tasks.each do |time_frame|
+            task_lines = time_frame.to_s.split("\n")[1..-1]
+            puts "#{time_frame.header} | color=#{task_lines.empty? ? 'gray' : 'green'}"
+            puts task_lines.map { |line| "#{line} | color=black" }.join("\n").gsub(/^- /, '-- ')
+          end
+          puts "Total: XYZ | colour=gray"
+        else
+          puts "Hours worked: #{Hour.new(0, today_tasks.duration)}"
+        end
+      end
+
+      def self.main(today_tasks, task_list)
+        if today_tasks && current_time_frame = today_tasks.get_current_time_frame
+          colour, icon = self.heading(current_time_frame)
+          puts icon, '---'
+          self.with_active_time_frame(current_time_frame)
+        elsif today_tasks
+          colour, icon = self.heading(nil)
+          puts icon, '---'
+          puts 'TODO: Some day summary and possibly show tomorrow.'
+        else
+          colour, icon = self.heading(nil)
+          puts icon, '---'
+          puts "Run 'pomodoro e' to add some tasks. | color=green"
+        end
+
+        if task_list && task_list.any? { |task_group| ! task_group.tasks.empty? }
+          puts "Scheduled tasks"
+          task_list.each do |task_group|
+            unless task_group.tasks.empty?
+              puts "-- #{task_group.name}"
+              task_group.tasks.each do |task|
+                puts "---- #{task} | color=black"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pomodoro/config.rb

@@ -0,0 +1,30 @@
+require 'yaml'
+
+module Pomodoro
+  class Config
+    CONFIG_PATH ||= File.expand_path('~/.config/pomodoro.yml')
+
+    def initialize
+      @data ||= YAML.load_file(CONFIG_PATH)
+    rescue
+      @data ||= Hash.new
+    end
+
+    {
+      task_list_path: '~/pomodoro/tasks.todo',
+      today_path: '~/pomodoro/%Y-%m-%d.today',
+      schedule_path: '~/pomodoro/schedule.rb',
+      routine_path: '~/pomodoro/routine.rb'
+    }.each do |key, default_value|
+      define_method(key) do |time = Time.now|
+        path = @data[key.to_s] || default_value
+        path = File.expand_path(time.strftime(path))
+        if File.exist?(File.expand_path("#{path}/.."))
+          path
+        else
+          raise "No #{key} found. Either create #{default_value} or add #{key} into #{CONFIG_PATH} pointing the the actual path."
+        end
+      end
+    end
+  end
+end