quirk 0.0.5 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c95eaa5792bfc25d6564edb67b4d89886b7bb15
+  data.tar.gz: 3dbe38d53f23a061f031a64d01f94ed6497b4a27
+SHA512:
+  metadata.gz: 52846f87cdb6eab06d4a28c01549eec005abf6d677619d7cbbc8d474d63dd26e108a60055e83a134285a20b857872a86e4012ba1e198c5342784429e2f9d6d38
+  data.tar.gz: 66f1b30d10f5aaafdfa584108622cba75dca66cb93c7d6253d669339bdcb4cd7a69df69a945db4793e1cbed3aafd57ccd51acd877c408f7b849ec43f8c26c9e9

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2012, Hugh Bien
+Copyright (c) Hugh Bien
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/README.md

@@ -1,29 +1,21 @@
-Description
-===========
+# Description
 
 Quirk is a command line utility for tracking good and bad habits.
 
-Installation
-============
+# Installation
 
     $ gem install quirk
 
 Then configure your habits in a plaintext file:
 
     $ quirk -e
-    mile-run: monday, wednesday, thursday
+    mile-run: monday, wednesday, thursday ; comments start with semi-colons
     walk-dog: everyday
-    ^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`.
+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.
-
-
-Usage
-=====
+# Usage
 
 When you've done something, mark it with:
 
@@ -42,78 +34,28 @@ To see a single habit (green days are good, red is bad):
 
 Looking for a specific year?
 
-    $ quirk mile-run -y 2011
+    $ quirk -c mile-run -y 2011
 
 See all of your current streaks:
 
     $ 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 `^`:
+Habits are stored in plaintext in `~/.quirk`.  You can use `quirk -e` to add/remove entries.  Habits
+start on the day of the first mark by default.
 
     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 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
-==================
-
-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
-    $ 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
+The first line means you walked the dog on `1/1`.  You can specify the first/last day for a habit
+using the `^`/`$` prefixes:
 
-This is useful for `tmux`'s status as a reminder of which habits are pending.
-Put this in your `.tmux.conf` file:
+    2012/01/01 ^walk-dog
+    2012/01/30 $walk-dog
 
-    set -g status-right '#[fg=yellow]#(quirk -t | xargs | tr " " ,)'
+This means I'll start on `1/1` and end on `1/30`, it's just a temporary goal for 1 month.
 
-License
-=======
+# License
 
 Copyright Hugh Bien - http://hughbien.com.
 Released under BSD License, see LICENSE.md for more info.

data/{quirk → bin/quirk}

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 require 'optparse'
-require File.expand_path('quirk', File.dirname(__FILE__))
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'quirk'))
 
 ARGV.options do |o|
   begin
@@ -11,9 +11,7 @@ ARGV.options do |o|
     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('-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!

data/{quirk.rb → lib/quirk.rb}

@@ -2,7 +2,7 @@ require 'date'
 require 'colorize'
 
 module Quirk
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
   QUIRKFILE = ENV['QUIRKFILE'] || "#{ENV['HOME']}/.quirk"
   EDITOR = ENV['EDITOR'] || 'vi'
 
@@ -27,22 +27,25 @@ module Quirk
       `#{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
+      contents = File.read(@quirkfile)
+      return if !cal.has_habit?(habit_id)
+
+      date = Quirk.today.strftime('%Y/%m/%d')
+      match = contents.match(/^(#{date} .*)$/)
+      if match # already has date, add habit to line
+        old_line = match.captures[0]
+        ids = old_line.strip.split(/\s+/, 2)[1].split(',').map(&:strip)
+        ids << habit_id
+        ids = ids.sort.uniq
+        new_line = "#{date} #{ids.join(', ')}"
+        contents.sub!(old_line, new_line)
+        File.open(@quirkfile, 'w') { |f| f.print(contents) }
+      else
+        File.open(@quirkfile, 'a') { |f| f.puts("#{date} #{habit_id}") }
       end
     end
 
-    def today
-      puts cal.today if cal.today !~ /^\s*$/
-    end
-
     def streaks
       puts cal.streaks
     end
@@ -61,15 +64,11 @@ module Quirk
   class Habit
     attr_reader :id, :days, :marks
 
-    def initialize(id, days, quitting)
-      @id, @days, @quitting, @marks = id, days, quitting, []
+    def initialize(id, days)
+      @id, @days, @marks = id, days, []
       raise "No days found for #{id}" if @days.empty?
     end
 
-    def quitting?
-      !!@quitting
-    end
-
     def mark!(date)
       @marks << date
       @marks.sort
@@ -89,12 +88,12 @@ module Quirk
 
     def pending?(date)
       weekday = date.strftime("%w").to_i
-      !quitting? && days.include?(weekday) && color_on(date) != :light_green
+      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
+      hit_color = :light_green
+      miss_color = :light_red
       last_date = [@last_date, Quirk.today].compact.min
       if first_date.nil? ||
          date < first_date ||
@@ -104,7 +103,7 @@ module Quirk
       elsif @marks.include?(date)
         hit_color
       else
-        date == last_date && !quitting? ? :white : miss_color
+        date == last_date ? :white : miss_color
       end
     end
 
@@ -132,10 +131,8 @@ module Quirk
       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)
+      self.new(id, parse_days(days))
     end
 
     def self.parse_days(text)
@@ -159,6 +156,7 @@ module Quirk
 
     def initialize(habits)
       @habits = habits.reduce({}) {|hash,habit| hash[habit.id] = habit; hash}
+      @ids = habits.map(&:id)
     end
 
     def year
@@ -209,10 +207,6 @@ module Quirk
       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)
@@ -231,18 +225,10 @@ module Quirk
       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]
-      end.sort_by(&:first)
+      pairs = @ids.map do |id|
+        [@habits[id].streak, id]
+      end
       len = pairs.map {|p| p.first.to_s.length}.max
       pairs.map do |count, id|
         "#{' ' * (len - count.to_s.length)}#{count} #{id}"

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: quirk
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.0.6
 platform: ruby
 authors:
 - Hugh Bien
 autorequire: 
-bindir: .
+bindir: bin
 cert_chain: []
-date: 2013-02-16 00:00:00.000000000 Z
+date: 2014-12-29 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.
@@ -51,34 +46,31 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- quirk.rb
-- quirk_test.rb
 - LICENSE.md
 - README.md
-- quirk
-- ./quirk
+- bin/quirk
+- lib/quirk.rb
 homepage: https://github.com/hughbien/quirk
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Track good and bad habits
 test_files: []

data/quirk_test.rb

@@ -1,206 +0,0 @@
-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_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))
-    habit.mark!(Date.new(2012, 1, 3))
-    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(:white, habit.color_on(Date.new(2012, 1, 3)))
-    assert_equal(:light_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(:light_red, quit.color_on(Date.new(2012, 1, 2)))
-    assert_equal(:white, quit.color_on(Date.new(2012, 1, 3)))
-    assert_equal(:light_green, quit.color_on(Date.new(2012, 1, 4)))
-    assert_equal(:light_green, quit.color_on(Date.new(2012, 1, 5)))
-    assert_equal(:white, quit.color_on(Date.new(2012, 1, 6)))
-
-    quit.mark_first!(Date.new(2012, 1, 1))
-    assert_equal(:light_green, quit.color_on(Date.new(2012, 1, 1)))
-  end
-
-  def test_color_on_empty_quit
-    quit = Quirk::Habit.parse('^quit-tv: everyday')
-    quit.mark_first!(Date.new(2012, 1, 1))
-    assert_equal(:white, quit.color_on(Date.new(2011, 12, 31)))
-    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(:light_green, quit.color_on(Date.new(2012, 1, 5)))
-    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)
-
-    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/04 $smoking')
-    @cal.mark!('2012/01/01 running, walk-dog')
-    @cal.mark!('2012/01/02 running, walk-dog')
-  end
-
-  def test_parse
-    calendar = Quirk::Calendar.parse(
-      "; ignore comment line\n" +
-      "running: everyday ; ignore comment\n" +
-      "^smoking: everyday\n\n" +
-      "; ignore comment line\n" +
-      "2012/01/01 ^smoking ; ignore comment\n" +
-      "2012/01/01 running\n\n")
-
-    assert(calendar.has_habit?('running'))
-    assert(calendar.has_habit?('smoking'))
-    assert_equal(Date.new(2012, 1, 1), calendar.habits['running'].first_date)
-    assert_equal(Date.new(2012, 1, 1), calendar.habits['smoking'].first_date)
-  end
-
-  def test_parse_day_error
-    assert_raises(RuntimeError) { Quirk::Calendar.parse('running: invalid') }
-  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_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 1 walk-dog\n 4 smoking", @cal.streaks)
-  end
-end