quirk 0.0.2

data/LICENSE.md

@@ -0,0 +1,23 @@
+Copyright (c) 2012, Hugh Bien
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list
+of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,82 @@
+Description
+===========
+
+Quirk is a command line utility for tracking good and bad habits.
+
+Installation
+============
+
+    % gem install quirk
+
+Then configure your habits in a plaintext file:
+
+    % quirk -e
+    mile-run: monday, wednesday, thursday
+    walk-dog: everyday
+    ^quit-tv: friday
+
+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
+
+To see a single habit (green days are good, red is bad):
+
+    % quirk -c mile-run
+          Jan 2012
+    Su Mo Tu We Th Fr Sa
+     1  2  3  4  5  6  7
+     8  9 10 11 12 13 14
+    15 16 17 18 19 20 21
+    22 23 24 25 26 27 28
+    29 30 31
+
+Looking for a specific year?
+
+    % quirk mile-run -y 2011
+
+See all of your current streaks:
+
+    % quirk -s
+    17 mile-run
+     3 walk-dog
+    -3 quit-tv
+
+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 `^`:
+
+    2012/01/01 walk-dog
+    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
+quitting habits on a green day.
+
+Zsh Tab Completion
+==================
+
+Here's an example zsh completion function:
+
+    #compdef quirk
+    compadd `quirk -l`
+
+Put this into your `site-functions` directory (wherever `$fpath` points to):
+
+    % echo $fpath
+    /usr/share/zsh/site-functions /usr/share/zsh/4.3.11/functions
+    % sudo vim /usr/share/zsh/site-functions/_quirk
+
+License
+=======
+
+Copyright 2012 Hugh Bien - http://hughbien.com.
+Released under BSD License, see LICENSE.md for more info.

data/quirk

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require File.expand_path('quirk', File.dirname(__FILE__))
+
+ARGV.options do |o|
+  begin
+    app = Quirk::App.new
+    action = nil
+    o.set_summary_indent('  ')
+    o.banner =    "Usage: #{File.basename($0)} [OPTION]"
+    o.define_head "Track good and bad habits (v#{Quirk::VERSION})"
+    o.on('-c', '--calendar habit', 'show calendar') { |h| action = [:calendar, h] }
+    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('-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)
+  rescue RuntimeError => e
+    puts e.to_s
+  end
+end

data/quirk.rb

@@ -0,0 +1,239 @@
+require 'date'
+require 'colorize'
+
+module Quirk
+  VERSION = '0.0.2'
+  QUIRKFILE = ENV['QUIRKFILE'] || "#{ENV['HOME']}/.quirk"
+  EDITOR = ENV['EDITOR'] || 'vi'
+
+  def self.today
+    @today || Date.today
+  end
+
+  def self.today=(date) # for testing
+    @today = date
+  end
+
+  class App
+    def initialize(quirkfile = QUIRKFILE)
+      @quirkfile = quirkfile
+    end
+
+    def calendar(habit_id)
+      puts cal.output(habit_id)
+    end
+
+    def edit
+      `#{EDITOR} #{QUIRKFILE} < \`tty\` > \`tty\``
+    end
+
+    def list
+      puts cal.list
+    end
+
+    def mark(habit_id)
+      File.open(@quirkfile, 'a') do |file|
+        if cal.has_habit?(habit_id)
+          file.puts("#{Quirk.today.strftime('%Y/%m/%d')} #{habit_id}")
+        end
+      end
+    end
+
+    def streaks
+      puts cal.streaks
+    end
+
+    def year=(year)
+      raise "Invalid year: #{year}" if year !~ /\d\d\d\d/
+      cal.year = year.to_i
+    end
+
+    private
+    def cal
+      @cal ||= Calendar.parse(File.read(@quirkfile))
+    end
+  end
+
+  class Habit
+    attr_reader :id, :days, :marks
+
+    def initialize(id, days, quitting)
+      @id, @days, @quitting, @marks = id, days, quitting, []
+    end
+
+    def quitting?
+      !!@quitting
+    end
+
+    def mark!(date)
+      @marks << date
+      @marks.sort
+    end
+
+    def mark_first!(date)
+      @first_date = date
+    end
+
+    def first_date
+      @first_date || @marks.first
+    end
+
+    def color_on(date)
+      hit_color = quitting? ? :light_red : :light_green
+      miss_color = quitting? ? :light_green : :light_red
+      last_date = quitting? ? (Quirk.today + 1) : Quirk.today
+      if @marks.empty? ||
+         date < first_date ||
+         date > last_date ||
+         !days.include?(date.wday)
+        :white
+      elsif @marks.include?(date)
+        hit_color
+      else
+        date == last_date && !quitting? ? :white : miss_color
+      end
+    end
+
+    def streak
+      return 0 if @marks.empty?
+
+      count = 0
+      deltas = {:light_red => -1, :light_green => 1, :white => 0}
+      date = Quirk.today
+      while date >= first_date && (color = color_on(date)) == :white
+        date -= 1
+      end
+
+      init_color = color
+      while date >= first_date
+        color = color_on(date)
+        break if color != init_color && days.include?(date.wday)
+        date -= 1
+        count += deltas[color]
+      end
+      count
+    end
+
+    def self.parse(line)
+      line.strip!
+      line.gsub!(/\s+/, ' ')
+
+      quitting = line =~ /^\^/
+      line = line[1..-1] if quitting
+      id, days = line.split(':', 2).map(&:strip)
+      self.new(id, parse_days(days), quitting)
+    end
+
+    def self.parse_days(text)
+      originals = text.split(',').map(&:strip)
+      days = []
+      if originals.include?('everyday')
+        (0..6).to_a
+      else
+        %w(sunday monday tuesday wednesday
+           thursday friday saturday).each_with_index do |day, index|
+          days << (index) if originals.include?(day)
+        end
+        days
+      end
+    end
+  end
+  
+  class Calendar
+    attr_writer :year
+
+    def initialize(habits)
+      @habits = habits.reduce({}) {|hash,habit| hash[habit.id] = habit; hash}
+    end
+
+    def year
+      @year || Quirk.today.year
+    end
+
+    def has_habit?(habit_id)
+      raise "No habit found: #{habit_id}" if !@habits.has_key?(habit_id)
+      true
+    end
+
+    def output(habit_id)
+      return if !has_habit?(habit_id)
+      habit = @habits[habit_id]
+      months = (1..12).map do |month|
+        first = Date.new(year, month, 1)
+        out = "#{first.strftime('         %b        ')}\n"
+        out += "Su Mo Tu We Th Fr Sa\n"
+        out += ("   " * first.wday)
+        while first.month == month
+          out += (first..(first + (6 - first.wday))).map do |date|
+            if date.year != year || date.month != month
+              '  '
+            else
+              len = date.day.to_s.length
+              "#{' ' * (2 - len)}#{date.day.to_s.colorize(habit.color_on(date))}"
+            end
+          end.join(" ")
+          out += "\n"
+          first += 7 - first.wday
+        end
+        out.split("\n")
+      end
+      out = "#{(' ' * 32)}#{year}\n"
+      index = 0
+      while index < 12
+        line = 0
+        max_line = [months[index], months[index+1], months[index+2]].
+          map(&:length).max
+        while line <= max_line
+          out += "#{months[index][line] || (' ' * 20)}   "
+          out += "#{months[index+1][line] || ( ' ' * 20)}   "
+          out += "#{months[index+2][line]}\n"
+          line += 1
+        end
+        index += 3
+      end
+      out
+    end
+
+    def list
+      @habits.values.map(&:id).sort.join("\n")
+    end
+
+    def mark!(line)
+      date = Date.parse(line.strip.split(/\s+/)[0])
+      originals = line.strip.split(/\s+/, 2)[1].split(',').map(&:strip)
+      originals.each do |original|
+        if original =~ /^\^\s*/
+          original = original.sub(/^\^\s*/, '')
+          habit = @habits[original] if has_habit?(original)
+          habit.mark_first!(date)
+        elsif has_habit?(original)
+          @habits[original].mark!(date)
+        end
+      end
+    end
+
+    def streaks
+      pairs = @habits.values.map do |habit|
+        [habit.streak, habit.id]
+      end.sort_by(&:first)
+      len = pairs.map {|p| p.first.to_s.length}.max
+      pairs.map do |count, id|
+        "#{' ' * (len - count.to_s.length)}#{count} #{id}"
+      end.join("\n")
+    end
+
+    def self.parse(text)
+      marks, habits = [], []
+      text.strip.each_line do |line|
+        if line =~ /^\d\d\d\d\/\d\d?\/\d\d?\s+/
+          marks << line
+        elsif line !~ /^\s*$/
+          habits << Habit.parse(line)
+        end
+      end
+      cal = Calendar.new(habits)
+      marks.each { |mark| cal.mark!(mark) }
+      cal
+    end
+  end
+end

data/quirk_test.rb

@@ -0,0 +1,109 @@
+require 'rubygems'
+require "#{File.dirname(__FILE__)}/quirk"
+require 'minitest/autorun'
+
+Quirk.today = Date.new(2012, 1, 5) # 1 Su, 2 Mo, 3 Tu, 4 We, 5 Th
+
+class QuirkAppTest < MiniTest::Unit::TestCase
+  def setup
+    @app = Quirk::App.new(File.join(File.dirname(__FILE__), 'quirkfile'))
+  end
+end
+
+class QuirkHabitTest < MiniTest::Unit::TestCase
+  def test_parse
+    habit = Quirk::Habit.parse(' running:  monday , tuesday, wednesday')
+    assert_equal('running', habit.id)
+    assert_equal([1, 2, 3], habit.days)
+    refute(habit.quitting?)
+
+    habit2 = Quirk::Habit.parse('walk-dog: everyday')
+    assert_equal('walk-dog', habit2.id)
+    assert_equal([0, 1, 2, 3, 4, 5, 6], habit2.days)
+    refute(habit2.quitting?)
+
+    habit3 = Quirk::Habit.parse('^quit-tv: everyday')
+    assert_equal('quit-tv', habit3.id)
+    assert_equal([0, 1, 2, 3, 4, 5, 6], habit3.days)
+    assert(habit3.quitting?)
+  end
+
+  def test_color_on
+    habit = Quirk::Habit.parse('running: sunday, monday, wednesday, thursday')
+    habit.mark!(Date.new(2012, 1, 2))
+    habit.mark!(Date.new(2012, 1, 3))
+    assert_equal(:white, habit.color_on(Date.new(2012, 1, 1)))
+    assert_equal(:green, habit.color_on(Date.new(2012, 1, 2)))
+    assert_equal(:white, habit.color_on(Date.new(2012, 1, 3)))
+    assert_equal(:red, habit.color_on(Date.new(2012, 1, 4)))
+    assert_equal(:white, habit.color_on(Date.new(2012, 1, 5)))
+  end
+
+  def test_color_on_quit
+    quit = Quirk::Habit.parse('^quit-tv: sunday, monday, wednesday, thursday')
+    quit.mark!(Date.new(2012, 1, 2))
+    assert_equal(:white, quit.color_on(Date.new(2012, 1, 1)))
+    assert_equal(:red, quit.color_on(Date.new(2012, 1, 2)))
+    assert_equal(:white, quit.color_on(Date.new(2012, 1, 3)))
+    assert_equal(:green, quit.color_on(Date.new(2012, 1, 4)))
+    assert_equal(:green, quit.color_on(Date.new(2012, 1, 5)))
+
+    quit.mark_first!(Date.new(2012, 1, 1))
+    assert_equal(:green, quit.color_on(Date.new(2012, 1, 1)))
+  end
+
+  def test_streak
+    missing = Quirk::Habit.parse('running: everyday')
+    assert_equal(0, missing.streak)
+
+    perfect = Quirk::Habit.parse('running: monday, wednesday')
+    perfect.mark!(Date.new(2012, 1, 2))
+    perfect.mark!(Date.new(2012, 1, 4))
+    assert_equal(2, perfect.streak)
+
+    bad = Quirk::Habit.parse('running: monday, tuesday, wednesday')
+    bad.mark!(Date.new(2012, 1, 1))
+    bad.mark!(Date.new(2012, 1, 2))
+    assert_equal(-2, bad.streak)
+  end
+
+  def test_streak_quit
+    missing = Quirk::Habit.parse('^quit-tv: everyday')
+    assert_equal(0, missing.streak)
+
+    perfect = Quirk::Habit.parse('^quit-tv: monday, tuesday')
+    perfect.mark!(Date.new(2011, 12, 31))
+    perfect.mark!(Date.new(2012, 1, 4))
+    assert_equal(2, perfect.streak)
+
+    bad = Quirk::Habit.parse('^quit-tv: sunday, thursday')
+    bad.mark!(Date.new(2012, 1, 1)) # sunday
+    bad.mark!(Date.new(2012, 1, 5)) # thursday
+    assert_equal(-2, bad.streak)
+  end
+end
+
+class QuirkCalendarTest < MiniTest::Unit::TestCase
+  def setup
+    @running = Quirk::Habit.parse('running: everyday')
+    @walking = Quirk::Habit.parse('walk-dog: sunday, saturday')
+    @smoking = Quirk::Habit.parse('^smoking: everyday')
+    @cal = Quirk::Calendar.new([@running, @walking, @smoking])
+    @cal.mark!('2012/01/01 ^smoking')
+    @cal.mark!('2012/01/01 running, walk-dog')
+    @cal.mark!('2012/01/02 running, walk-dog')
+  end
+
+  def test_mark
+    assert_equal([Date.new(2012,1,1), Date.new(2012,1,2)], @running.marks)
+    assert_equal([Date.new(2012,1,1), Date.new(2012,1,2)], @walking.marks)
+  end
+
+  def test_mark_first
+    assert_equal(Date.new(2012, 1, 1), @smoking.first_date)
+  end
+
+  def test_streaks
+    assert_equal("-2 running\n 0 smoking\n 1 walk-dog", @cal.streaks)
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: quirk
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Hugh Bien
+autorequire: 
+bindir: .
+cert_chain: []
+date: 2012-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Command line tool for tracking good/bad habits, data stored in plaintext.
+email:
+- hugh@hughbien.com
+executables:
+- quirk
+extensions: []
+extra_rdoc_files: []
+files:
+- quirk.rb
+- quirk_test.rb
+- README.md
+- LICENSE.md
+- quirk
+- ./quirk
+homepage: https://github.com/hughbien/quirk
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Track good and bad habits
+test_files: []