quirk 0.0.4 → 0.0.5

data/README.md

@@ -6,32 +6,32 @@ Quirk is a command line utility for tracking good and bad habits.
 Installation
 ============
 
-    % gem install quirk
+    $ gem install quirk
 
 Then configure your habits in a plaintext file:
 
-    % quirk -e
+    $ quirk -e
     mile-run: monday, wednesday, thursday
     walk-dog: everyday
-    ; comments start with semi-colons
-    ^quit-tv: friday
+    ^quit-tv: friday ; comments start with semi-colons
+
+By default, all this does is edit the `~/.quirk` file.  You can configure
+which file to use by setting the environment variable `QUIRKFILE`.
 
 If a habit is prefixed with `^`, it means you're trying to break that habit.
 In this case you're trying to quit TV on Fridays.
 
-By default, all this does is edit the `~/.quirk` file.  You can configure
-which file to use by setting the environment variable `QUIRKFILE`.
 
 Usage
 =====
 
 When you've done something, mark it with:
 
-    % quirk -m mile-run
+    $ quirk -m mile-run
 
 To see a single habit (green days are good, red is bad):
 
-    % quirk -c mile-run
+    $ quirk -c mile-run
           Jan 2012
     Su Mo Tu We Th Fr Sa
      1  2  3  4  5  6  7
@@ -42,15 +42,21 @@ To see a single habit (green days are good, red is bad):
 
 Looking for a specific year?
 
-    % quirk mile-run -y 2011
+    $ quirk mile-run -y 2011
 
 See all of your current streaks:
 
-    % quirk -s
+    $ quirk
     17 mile-run
      3 walk-dog
     -3 quit-tv
 
+See which habits are pending for today:
+
+    $ quirk -t
+    mile-run
+    walk-dog
+
 Habits are stored in plaintext in `~/.quirk`.  You can use `quirk -e` to
 add/remove entries.  Note that habits start on the day of the first mark
 by default.  You can also specify the first day using `^`:
@@ -59,9 +65,20 @@ by default.  You can also specify the first day using `^`:
     2012/01/01 ^quit-tv
 
 The first line means you walked the dog on `1/1`.  The second line means you
-started the habit of quitting TV.  This is especailly handy for starting
+started the habit of quitting TV.  This is especially handy for starting
 quitting habits on a green day.
 
+You can specify the last day for a habit using `$`:
+
+    2012/01/01 ^quit-tv
+    2012/01/30 $quit-tv
+    2012/01/15 quit-tv
+    2012/01/16 quit-tv
+
+The first line means on `1/1`, I'm going to start quitting TV.  The second line
+means I'll stop the habit on `1/30`, it's just a temporary goal for 1 month.
+The last two lines means I watched TV on `1/15` and `1/16` (two red days).
+
 Zsh Tab Completion
 ==================
 
@@ -72,12 +89,31 @@ Here's an example zsh completion function:
 
 Put this into your `site-functions` directory (wherever `$fpath` points to):
 
-    % echo $fpath
+    $ echo $fpath
     /usr/share/zsh/site-functions /usr/share/zsh/4.3.11/functions
-    % sudo vim /usr/share/zsh/site-functions/_quirk
+    $ vim /usr/share/zsh/site-functions/_quirk
+
+Tmux and Other Notifications Integration
+========================================
+
+Use `quirk -t` to see which habits are pending for today.  Habits are separated
+by a newline.  Use `xargs` and/or `tr` to format as you see fit:
+
+    $ quirk -t
+    mile-run
+    wlak-dog
+    $ quirk -t | xargs
+    mile-run walk-dog
+    $ quirk -t | xargs | tr " " ,
+    mile-run,walk-dog
+
+This is useful for `tmux`'s status as a reminder of which habits are pending.
+Put this in your `.tmux.conf` file:
+
+    set -g status-right '#[fg=yellow]#(quirk -t | xargs | tr " " ,)'
 
 License
 =======
 
-Copyright 2012 Hugh Bien - http://hughbien.com.
+Copyright Hugh Bien - http://hughbien.com.
 Released under BSD License, see LICENSE.md for more info.

data/quirk

@@ -5,7 +5,7 @@ require File.expand_path('quirk', File.dirname(__FILE__))
 ARGV.options do |o|
   begin
     app = Quirk::App.new
-    action = nil
+    action = 'streaks'
     o.set_summary_indent('  ')
     o.banner =    "Usage: #{File.basename($0)} [OPTION]"
     o.define_head "Track good and bad habits (v#{Quirk::VERSION})"
@@ -13,11 +13,11 @@ ARGV.options do |o|
     o.on('-e', '--edit', 'edit habits') { action = [:edit] }
     o.on('-l', '--list', 'list habits') { action = [:list] }
     o.on('-m', '--mark habit', 'mark for today') { |h| action = [:mark, h] }
-    o.on('-s', '--streaks', 'list streaks') { action = [:streaks] }
+    o.on('-t', '--today', 'unfinished habits for today') { action = [:today] }
     o.on('-y', '--year year', 'set calendar year') { |y| app.year = y }
     o.on('-h', '--help', 'show this help message') { puts o; exit }
     o.parse!
-    action.nil? ? puts(o) : app.send(*action)
+    app.send(*action)
   rescue RuntimeError => e
     puts e.to_s
   end

data/quirk.rb

@@ -2,7 +2,7 @@ require 'date'
 require 'colorize'
 
 module Quirk
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
   QUIRKFILE = ENV['QUIRKFILE'] || "#{ENV['HOME']}/.quirk"
   EDITOR = ENV['EDITOR'] || 'vi'
 
@@ -39,6 +39,10 @@ module Quirk
       end
     end
 
+    def today
+      puts cal.today if cal.today !~ /^\s*$/
+    end
+
     def streaks
       puts cal.streaks
     end
@@ -75,14 +79,23 @@ module Quirk
       @first_date = date
     end
 
+    def mark_last!(date)
+      @last_date = date
+    end
+
     def first_date
       @first_date || @marks.first
     end
 
+    def pending?(date)
+      weekday = date.strftime("%w").to_i
+      !quitting? && days.include?(weekday) && color_on(date) != :light_green
+    end
+
     def color_on(date)
       hit_color = quitting? ? :light_red : :light_green
       miss_color = quitting? ? :light_green : :light_red
-      last_date = Quirk.today
+      last_date = [@last_date, Quirk.today].compact.min
       if first_date.nil? ||
          date < first_date ||
          date > last_date ||
@@ -96,7 +109,7 @@ module Quirk
     end
 
     def streak
-      return 0 if @marks.empty?
+      return 0 if first_date.nil?
 
       count = 0
       deltas = {:light_red => -1, :light_green => 1, :white => 0}
@@ -208,12 +221,24 @@ module Quirk
           original = original.sub(/^\^\s*/, '')
           habit = @habits[original] if has_habit?(original)
           habit.mark_first!(date)
+        elsif original =~ /^\$\s*/
+          original = original.sub(/^\$\s*/, '')
+          habit = @habits[original] if has_habit?(original)
+          habit.mark_last!(date)
         elsif has_habit?(original)
           @habits[original].mark!(date)
         end
       end
     end
 
+    def today
+      @habits.values.
+        select {|h| h.pending?(Quirk.today)}.
+        map(&:id).
+        sort.
+        join("\n")
+    end
+
     def streaks
       pairs = @habits.values.map do |habit|
         [habit.streak, habit.id]
@@ -227,9 +252,10 @@ module Quirk
     def self.parse(text)
       marks, habits = [], []
       text.strip.each_line do |line|
+        line = line.split(';')[0].to_s.strip # remove comments
         if line =~ /^\d\d\d\d\/\d\d?\/\d\d?\s+/
           marks << line
-        elsif line !~ /^\s*$/ && line !~ /^\s*;.*$/
+        elsif line !~ /^\s*$/
           habits << Habit.parse(line)
         end
       end

data/quirk_test.rb

@@ -28,6 +28,19 @@ class QuirkHabitTest < MiniTest::Unit::TestCase
     assert(habit3.quitting?)
   end
 
+  def test_pending
+    habit = Quirk::Habit.parse('running: monday')
+    refute(habit.pending?(Date.new(2012, 1, 1)))
+    assert(habit.pending?(Date.new(2012, 1, 2)))
+    habit.mark!(Date.new(2012, 1, 2))
+    refute(habit.pending?(Date.new(2012, 1, 2)))
+
+    habit2 = Quirk::Habit.parse('^quit-tv: everyday')
+    refute(habit.pending?(Date.new(2012, 1, 1)))
+    habit.mark!(Date.new(2012, 1, 1))
+    refute(habit.pending?(Date.new(2012, 1, 1)))
+  end
+
   def test_color_on
     habit = Quirk::Habit.parse('running: sunday, monday, wednesday, thursday')
     habit.mark!(Date.new(2012, 1, 2))
@@ -65,6 +78,51 @@ class QuirkHabitTest < MiniTest::Unit::TestCase
     assert_equal(:white, quit.color_on(Date.new(2012, 1, 6)))
   end
 
+  def test_color_on_last_date
+    habit = Quirk::Habit.parse('running: everyday')
+    habit.mark!(Date.new(2012, 1, 2))
+    habit.mark!(Date.new(2012, 1, 3))
+    habit.mark_last!(Date.new(2012, 1, 4))
+    assert_equal(:white, habit.color_on(Date.new(2012, 1, 1)))
+    assert_equal(:light_green, habit.color_on(Date.new(2012, 1, 2)))
+    assert_equal(:light_green, habit.color_on(Date.new(2012, 1, 3)))
+    assert_equal(:white, habit.color_on(Date.new(2012, 1, 4)))
+    assert_equal(:white, habit.color_on(Date.new(2012, 1, 5)))
+
+    habit.mark!(Date.new(2012, 1, 4))
+    habit.mark!(Date.new(2012, 1, 5))
+    assert_equal(:light_green, habit.color_on(Date.new(2012, 1, 4)))
+    assert_equal(:white, habit.color_on(Date.new(2012, 1, 5)))
+  end
+
+  def test_color_on_future_last_date
+    habit = Quirk::Habit.parse('running: everyday')
+    habit.mark!(Date.new(2012, 1, 2))
+    habit.mark!(Date.new(2012, 1, 4))
+    habit.mark_last!(Date.new(2012, 1, 29))
+    assert_equal(:white, habit.color_on(Date.new(2012, 1, 1)))
+    assert_equal(:light_green, habit.color_on(Date.new(2012, 1, 2)))
+    assert_equal(:light_red, habit.color_on(Date.new(2012, 1, 3)))
+    assert_equal(:light_green, habit.color_on(Date.new(2012, 1, 4)))
+    assert_equal(:white, habit.color_on(Date.new(2012, 1, 5)))
+    assert_equal(:white, habit.color_on(Date.new(2012, 1, 6)))
+    assert_equal(:white, habit.color_on(Date.new(2012, 1, 28)))
+    assert_equal(:white, habit.color_on(Date.new(2012, 1, 29)))
+    assert_equal(:white, habit.color_on(Date.new(2012, 1, 30)))
+  end
+
+  def test_color_on_quit_last_date
+    quit = Quirk::Habit.parse('^quit-tv: everyday')
+    quit.mark_first!(Date.new(2012, 1, 1))
+    quit.mark_last!(Date.new(2012, 1, 4))
+    quit.mark!(Date.new(2012, 1, 5))
+    assert_equal(:light_green, quit.color_on(Date.new(2012, 1, 1)))
+    assert_equal(:light_green, quit.color_on(Date.new(2012, 1, 2)))
+    assert_equal(:light_green, quit.color_on(Date.new(2012, 1, 3)))
+    assert_equal(:light_green, quit.color_on(Date.new(2012, 1, 4)))
+    assert_equal(:white, quit.color_on(Date.new(2012, 1, 5)))
+  end
+
   def test_streak
     missing = Quirk::Habit.parse('running: everyday')
     assert_equal(0, missing.streak)
@@ -103,6 +161,7 @@ class QuirkCalendarTest < MiniTest::Unit::TestCase
     @smoking = Quirk::Habit.parse('^smoking: everyday')
     @cal = Quirk::Calendar.new([@running, @walking, @smoking])
     @cal.mark!('2012/01/01 ^smoking')
+    @cal.mark!('2012/01/04 $smoking')
     @cal.mark!('2012/01/01 running, walk-dog')
     @cal.mark!('2012/01/02 running, walk-dog')
   end
@@ -110,10 +169,10 @@ class QuirkCalendarTest < MiniTest::Unit::TestCase
   def test_parse
     calendar = Quirk::Calendar.parse(
       "; ignore comment line\n" +
-      "running: everyday\n" +
+      "running: everyday ; ignore comment\n" +
       "^smoking: everyday\n\n" +
       "; ignore comment line\n" +
-      "2012/01/01 ^smoking\n" +
+      "2012/01/01 ^smoking ; ignore comment\n" +
       "2012/01/01 running\n\n")
 
     assert(calendar.has_habit?('running'))
@@ -135,7 +194,13 @@ class QuirkCalendarTest < MiniTest::Unit::TestCase
     assert_equal(Date.new(2012, 1, 1), @smoking.first_date)
   end
 
+  def test_today
+    assert_equal("running", @cal.today)
+    @cal.mark!('2012/01/05 running')
+    assert_equal("", @cal.today)
+  end
+
   def test_streaks
-    assert_equal("-2 running\n 0 smoking\n 1 walk-dog", @cal.streaks)
+    assert_equal("-2 running\n 1 walk-dog\n 4 smoking", @cal.streaks)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quirk
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: .
 cert_chain: []
-date: 2012-05-31 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -53,8 +53,8 @@ extra_rdoc_files: []
 files:
 - quirk.rb
 - quirk_test.rb
-- README.md
 - LICENSE.md
+- README.md
 - quirk
 - ./quirk
 homepage: https://github.com/hughbien/quirk