minder 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1bd7f4b433d3f09c0b5c5c932d45f65b7e00dd6
+  data.tar.gz: e8c92eac92153eea880e7762c040fef0f43ffc27
+SHA512:
+  metadata.gz: 44bbcf6c44358e936ad5d0896992a7ddb9d1815ab18bf4b5c077b346ab7651e19baba8ae5d1fbdb3c9391c97e8bc4f9d6fef108477fd29715c237fcc0d9860f3
+  data.tar.gz: efd8144a3790c3afe5d2848d8d392ec1ceb59bfedc6584e2b0b734e3f2215a8f775e988a2636ef2663d537f60a8490e000fae70786ff4a1bd19e4223ae160939

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/Gemfile

@@ -0,0 +1,5 @@
+ruby '2.2.2'
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    minder (0.1)
+      curses
+      virtus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    byebug (4.0.5)
+      columnize (= 0.9.0)
+    coderay (1.1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    columnize (0.9.0)
+    curses (1.0.1)
+    debug_inspector (0.0.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    equalizer (0.0.11)
+    ice_nine (0.11.1)
+    method_source (0.8.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.1.0)
+      byebug (~> 4.0)
+      pry (~> 0.10)
+    pry-stack_explorer (0.4.9.2)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    timecop (0.7.3)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minder!
+  pry
+  pry-byebug
+  pry-stack_explorer
+  rake
+  rspec
+  timecop

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Joseph Method
+
+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,45 @@
+## What is it?
+
+This is a CLI-based tool that combines the best of several different
+productivity methodologies.
+
+At present it has these features:
+
+- A timer to help with keeping to the [Pomodoro
+  Technique](http://pomodorotechnique.com/) rhythm of 4 25 minute work periods
+  with five minute breaks, followed by a long 15 minute break. You hear the
+  soothing sounds of a "pomodoro" kitchen timer at the beginning and end of a
+  break.
+- A todo log that allows starting, unstarting and completing a task.
+- Stores a simple text log of task and pomodoro activity.
+
+Plans for the future include:
+
+- Filtering by GTD-style labels (like @context, +project, and #tag)
+- Integration with a website blacklist tool like
+  [SelfControl](https://github.com/SelfControlApp/selfcontrol/).
+- Keeping track of the number of pomodoros performed during a day.
+- Desktop notifications for Linux and MacOS
+- Prompts to summarize plans for the day and day's end progress.
+
+Audio files are from https://github.com/niftylettuce/pomodoro-timer
+
+## Usage
+
+There are three sections. You can switch between sections by pressing Tab. The
+commands for each section only work when the section is focused.
+
+- The Pomodoro timer section. Press space to begin the next period. Press 'e'
+  to edit the whole tasks list in your `$EDITOR`.
+- The Tasks section. This section disappears during a Pomodoro period to avoid
+  distraction.
+  - Press 'd' to mark a task as done.
+  - Press 'x' to delete a task.
+  - Press 's' to start a task.
+  - Press 'u' to un-start a task.
+- The Quick Add Task section. Enter text here to add a task to the tasks list
+  at any time.
+
+## License
+
+MIT License, see LICENSE.txt

data/bin/minder

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'minder'
+require 'minder/application'
+
+application = Minder::Application.new
+application.run

data/lib/minder/application.rb

@@ -0,0 +1,128 @@
+require 'minder/config'
+require 'minder/pomodoro_runner'
+require 'minder/task_recorder'
+require 'minder/scene'
+
+require 'curses'
+require 'fileutils'
+
+module Minder
+  class Application
+    attr_accessor :config,
+                  :scene,
+                  :pomodoro_frame,
+                  :message_frame,
+                  :quick_add_frame
+
+    def initialize(config: Minder::Config.new(CONFIG_LOCATION))
+      self.config = config
+      config.load
+      FileUtils.mkdir_p(File.join(ENV['HOME'], '.minder'))
+      FileUtils.touch(DOING_FILE)
+      FileUtils.touch(DONE_FILE)
+    end
+
+    def config_location
+      config.location
+    end
+
+    def run
+      pomodoro_runner.add_observer(self, :handle_event)
+
+      self.scene = Scene.new
+      scene.setup
+
+      options = { pomodoro_runner: pomodoro_runner, task_manager: task_recorder  }
+
+      self.pomodoro_frame = PomodoroFrame.new(options)
+      self.message_frame = MessageFrame.new(options)
+      self.quick_add_frame = QuickAddFrame.new(options)
+      quick_add_frame.focus
+
+      scene.frames << pomodoro_frame
+      scene.frames << message_frame
+      scene.frames << quick_add_frame
+
+      scene.frames.each do |frame|
+        frame.add_observer(self, :handle_event)
+      end
+
+      # TODO: Eww, gross
+      scene.redraw
+      scene.redraw
+
+      old_dimensions = [Curses.lines, Curses.cols]
+      loop do
+        scene.frames.each do |frame|
+          next unless frame.focused?
+          frame.listen
+        end
+        pomodoro_runner.tick
+        pomodoro_frame.refresh
+        scene.focused_frame.set_cursor_position
+        scene.focused_frame.window_refresh
+
+        new_dimensions = [Curses.lines, Curses.cols]
+        if new_dimensions != old_dimensions
+          scene.redraw
+          scene.redraw
+          old_dimensions = new_dimensions
+        end
+
+        sleep(0.01)
+      end
+
+      scene.close
+    end
+
+    def pomodoro_runner
+      @runner ||= PomodoroRunner.new(
+        work_duration: config.work_duration,
+        short_break_duration: config.short_break_duration,
+        long_break_duration: config.long_break_duration)
+    end
+
+    def task_recorder
+      @task_recorder ||= TaskRecorder.new
+    end
+
+    def handle_event(event, data = {})
+      return unless event
+
+      case event
+      when :started_work
+        message_frame.hide
+      when :completed_work
+        message_frame.unhide
+      when :continue
+        pomodoro_runner.continue
+      when :editor
+        `$EDITOR ~/.minder/doing.txt`
+        task_recorder.reload
+      when :add_task
+        task_recorder.add_task(data[:task])
+      when :switch_focus
+        scene.switch_focus
+      when :select_next_task
+        task_recorder.select_next_task
+      when :select_previous_task
+        task_recorder.select_previous_task
+      when :delete_task
+        task_recorder.delete_task
+      when :complete_task
+        task_recorder.complete_task
+      when :start_task
+        task_recorder.start_task
+      when :unstart_task
+        task_recorder.unstart_task
+      when :select_last_task
+        task_recorder.select_last_task
+      when :select_first_task
+        task_recorder.select_first_task
+      end
+
+      scene.redraw
+      scene.redraw
+    end
+  end
+end

data/lib/minder/break_period.rb

@@ -0,0 +1,13 @@
+require 'minder/period'
+
+module Minder
+  class BreakPeriod < Period
+    def initialize(minutes: DEFAULT_WORK_PERIOD)
+      super
+    end
+
+    def title
+      "Break period"
+    end
+  end
+end

data/lib/minder/config.rb

@@ -0,0 +1,35 @@
+require 'json'
+
+module Minder
+  class Config
+    DEFAULTS = {
+      work_duration: 25,
+      short_break_duration: 5,
+      long_break_duration: 15
+    }
+
+    attr_accessor :location
+    attr_reader :data
+
+    def initialize(location = nil)
+      self.location = location
+      @data = {}
+    end
+
+    def load
+      if File.exists?(location.to_s)
+        file = File.open(location, 'r')
+        @data = JSON.parse(file.read, symbolize_names: true)
+      end
+      DEFAULTS.each do |key, value|
+        data[key] ||= DEFAULTS[key]
+      end
+    end
+
+    DEFAULTS.keys.each do |key|
+      define_method(key) do
+        data[key]
+      end
+    end
+  end
+end

data/lib/minder/frame.rb

@@ -0,0 +1,172 @@
+require 'observer'
+require 'erb'
+module Minder
+  class Frame
+    include Observable
+
+    attr_accessor :window,
+                  :min_height,
+                  :height,
+                  :width,
+                  :left,
+                  :top,
+                  :pomodoro_runner,
+                  :task_manager,
+                  :lines
+
+    def initialize(**options)
+      height = options.fetch(:height, 3)
+      width = options.fetch(:width, 40)
+      top = options.fetch(:top, 0)
+      left = options.fetch(:left, 0)
+      task_manager = options.fetch(:task_manager)
+      pomodoro_runner = options.fetch(:pomodoro_runner)
+
+      @focused = false
+      @hidden = false
+      @has_cursor = false
+      self.pomodoro_runner = pomodoro_runner
+      self.task_manager = task_manager
+      self.min_height = height
+
+      self.height = height
+      self.width = width
+      self.top = top
+      self.left = left
+
+      self.window = build_window
+      self.lines = []
+    end
+
+    def build_window
+      Curses::Window.new(min_height, width, top, left)
+    end
+
+    def focus
+      @focused = true
+      @has_cursor = true
+    end
+
+    def unfocus
+      @focused = false
+      @has_cursor = false
+    end
+
+    def focused?
+      @focused
+    end
+
+    def hidden?
+      @hidden
+    end
+
+    def hide
+      erase
+      @hidden = true
+    end
+
+    def unhide
+      @hidden = false
+    end
+
+    def template
+      raise NotImplementedError
+    end
+
+    def move(top, left)
+      window.move(top, left)
+    end
+
+    def has_cursor?
+      @has_cursor
+    end
+
+    def listen
+      window.timeout = 0
+      handle_keypress(window.getch)
+    end
+
+    def refresh
+      return if @hidden
+      parse_template
+      set_text
+      window_refresh
+    end
+
+    def window_refresh
+      window.refresh
+    end
+
+    def parse_template
+      b = binding
+      self.lines = ERB.new(template).result(b).split("\n")
+    end
+
+    def resize
+      erase
+
+      self.width = Curses.cols
+      if lines.length >= min_height - 2
+        self.height = lines.length + 2
+      else
+        self.height = min_height
+      end
+
+      window.resize(height, width)
+      window_refresh
+    end
+
+    def set_text
+      window.box(?|, ?-)
+      height.times do |index|
+        next if index >= height - 2
+        window.setpos(index + 1, 1)
+        line = lines[index]
+        if line
+          print_line(line)
+        else
+          print_line('')
+        end
+      end
+    end
+
+    def erase
+      height.times do |index|
+        window.setpos(index, 0)
+        window.addstr(' ' * width )
+      end
+      window_refresh
+    end
+
+    def set_cursor_position
+      window.setpos(1, 0)
+    end
+
+    def print_line(text)
+      text = text[0,width - 2]
+      remainder = width - 2 - text.length
+      window.addstr(text + ' ' * remainder)
+    end
+
+    def handle_keypress(key)
+      return unless key
+
+      if key.is_a?(Fixnum)
+        if key == 9 # tab
+          changed
+          notify_observers(:switch_focus)
+        else
+          handle_non_char_keypress(key)
+        end
+      else
+        handle_char_keypress(key)
+      end
+    end
+
+    def handle_non_char_keypress(key)
+    end
+
+    def handle_char_keypress(key)
+    end
+  end
+end

data/lib/minder/idle_period.rb

@@ -0,0 +1,25 @@
+require 'minder/period'
+
+module Minder
+  class IdlePeriod < Period
+    def title
+      "Press space to start next period"
+    end
+
+    def message
+      nil
+    end
+
+    def start!
+      # noop
+    end
+
+    def elapsed?
+      true
+    end
+
+    def completed?
+      true
+    end
+  end
+end

data/lib/minder/message_frame.rb

@@ -0,0 +1,124 @@
+require 'minder/frame'
+
+module Minder
+  class MessageFrame < Frame
+    attr_reader :current_line
+
+    def initialize(*)
+      super
+      self.height = desired_height
+    end
+
+    def template
+      if task_manager.tasks?
+        doing_message
+      else
+        prompt_message
+      end
+    end
+
+    #def build_window
+      #Curses::Pad.new(min_height, width)
+    #end
+
+    #def window_refresh
+      #window.refresh(scroll_offset, 0, 3, 0, height + 2, width)
+    #end
+
+    def prompt_message
+      <<-TEXT
+What are you working on?
+
+Press (e) to open editor.
+TEXT
+    end
+
+    def header_text
+<<-TEXT
+Tasks        (s) start (x) to delete (d) to mark as done
+
+TEXT
+    end
+
+    def tasks_text
+      text = ''
+      task_manager.tasks.each do |task|
+         if task.started?
+          text += "-[*] #{task}\n"
+        else
+          text += "-[ ] #{task}\n"
+        end
+      end
+      text
+    end
+
+    def tasks_text_lines
+      tasks_text.split("\n")
+    end
+
+    def header_text_lines
+      header_text.split("\n")
+    end
+
+    def desired_height
+      header_text_lines.length + tasks_text_lines.length + 3
+    end
+
+    def allocated_tasks_height
+      height - header_text_lines.length
+    end
+
+    def offset_tasks_text
+      tasks_text_lines[scroll_offset..(allocated_tasks_height + scroll_offset - 4)].join("\n")
+    end
+
+    def blank_line
+      " " * (width - 2) + "\n"
+    end
+
+    def doing_message
+      header_text +
+        offset_tasks_text #+
+        #blank_lines
+    end
+
+    def blank_lines
+      blank_line * scroll_offset
+    end
+
+    def set_cursor_position
+      window.setpos(3 + task_manager.selected_task_index - scroll_offset, 3)
+    end
+
+    def scroll_offset
+      position = task_manager.selected_task_index + 5
+      if height - position < 0
+        (height - position).abs
+      else
+        0
+      end
+    end
+
+    def handle_char_keypress(key)
+      event = case key
+      when 'j' then :select_next_task
+      when 'k' then :select_previous_task
+      when 'd' then :complete_task
+      when 'x' then :delete_task
+      when 's' then :start_task
+      when 'u' then :unstart_task
+      when 'G' then :select_last_task
+      when 'g'
+        @keypress_memory ||= []
+        @keypress_memory << 'g'
+        if @keypress_memory == ['g', 'g']
+          @keypress_memory = []
+          :select_first_task
+        end
+      end
+
+      changed
+      notify_observers(event)
+    end
+  end
+end