habiter 0.2 → 0.3

data/README.rdoc

@@ -0,0 +1,70 @@
+habiter is a simple tool for maintaining good habits
+
+It can be used with the 'don't break the chain' technique, like
+Joe's Goals or Sciral Consistency, but adopts more positive
+techniques and uses a readable and editable YAML text file as
+storage.
+
+= Installation
+
+  % gem install habiter -s http://gemcutter.org/
+
+= Demo
+
+  ~$ habiter did clean_room
+  clean_room is not a habit yet. create and complete it? (y/n) y
+  ~$ habiter did jog
+  jog is not a habit yet. create and complete it? (y/n) y
+  ~$ habiter log
+             jog |----------------------------+|(1/28)
+         project |-------------------------++-+|(3/28)
+  practice_music |-----------------------+++++-|(5/28)
+        read_30m |-----------------------+--++-|(3/28)
+      clean_room |-----------------------+-+---|(2/28)
+
+= Scalars
+
+Habiter also now supports scalars: you can input a value for your
+activity, like
+
+  habiter did jog 5.5
+  habiter did heartbeat 78
+
+And it will be recorded. There is no representation of this data yet,
+and the representation within habiter will be minimal, only good output to
+formats which are easily visualized.
+
+= Install
+
+Install with 'gem install habiter' if you have gemcutter set up as a
+repository
+
+= FAQ
+
+* How do I add past data?
+  How do I delete recorded data?
+  How do I modify stuff I've recorded?
+
+Edit ~/.habiter.yaml
+
+* How do I reset habiter?
+
+  echo > ~/.habiter.yaml
+
+= Changelog
+
+== 3.0 (roadmap)
+
+* Dump to CSV
+
+== 2.5
+
+* Allows 'did' in past and future
+* Restructuring and cleanup internally
+* Internal documentation
+
+== 2.0
+
+* Scalar input
+
+Dedicated to Bryn Bellomy :)

data/bin/habiter

@@ -21,112 +21,153 @@ class String
   end
 end
 
-  
-
-@habiter_file = File.expand_path('~/.habiter.yaml')
-
-begin
-  @habits = YAML::load_file(@habiter_file)
-rescue
-  File.open(@habiter_file, 'w').close()
+class Habiter
+  def initialize(data_path = '~/.habiter.yaml') 
+    @habiter_file = File.expand_path(data_path)
+    begin
+      @habits = YAML::load_file(@habiter_file)
+    rescue
+      File.open(@habiter_file, 'w').close()
+    end
+    @habits = {} unless @habits
+  end
 end
 
-@habits = {} unless @habits
 
-options = {}
-
-optparse = OptionParser.new do |opts|
-  opts.banner = 
-    "Usage:
-    habiter did your_habit
-    habiter log"
-  options[:verbose] = false
-  opts.on('-v', '--verbose', "Show weekday letters for log") do
-    options[:verbose] = true
+class HabiterBin < Habiter
+  def dump(options={})
+    # Output this YAML datastore as normalized CSV for processing by
+    # whatever wants it
+    cols = @habits.length
+    i = 0 # TODO: AVOID THIS
+    rotated = {}
+    @habits.each do |habit, times|
+      times.collect! do |time|
+        this_time = normalize_time(time)
+        day = rotated.fetch(this_time, Array.new(cols, 0))
+        day[i] = (day[i].nil?) ? 1 : day[i] + 1
+        rotated[this_time] = day
+      end
+      i += 1
+    end
+    puts rotated.sort.keys[0]
   end
-end
 
-def did(args)
-  key = args[1]
-  new_record = (args.length > 2) ? {Time.now => args[2]} : Time.now
-  if not @habits.has_key?(key)
-    print "#{key} is not a habit yet. create and complete it? (y/n) "
-    if STDIN.gets.chomp == 'y'
-      @habits[key] = [new_record]
+  def did(key, scalar = false, yester = 0)
+    # Record that somebody did something. Expects an unadulterated
+    # args array, from which it takes the second and optionally third
+    # parameters
+    day = Date.today - yester
+    new_record = (scalar) ? {day => scalar} : day
+    if not @habits.has_key?(key)
+      print "#{key} is not a habit yet. create and complete it? (y/n) "
+      if STDIN.gets.chomp == 'y'
+        @habits[key] = [new_record]
+      end
+    else
+      @habits[key] << new_record
+    end
+    File.open(@habiter_file, 'w') do |f|
+      YAML.dump(@habits, f)
     end
-  else
-    @habits[key] << new_record
-  end
-  File.open(@habiter_file, 'w') do |f|
-    YAML.dump(@habits, f)
   end
-end
 
-
-def log(options={})
-  options[:days] = 28 unless options[:days]
-  name_column_width = @habits.max {|a,b| a[0].length <=> b[0].length}[0].length
-  day = Date.today - options[:days]
-  if options[:verbose]
-    print " " * (name_column_width + 2)
-    (0..options[:days]).each do |i|
-        print (day + (i)).strftime('%a')[0].chr.swapcase.colorize(37)
+  def log(options={})
+    # Display a basic visualization of recent task completion
+    options[:days] = 28 unless options[:days]
+    name_column_width = @habits.max {|a,b| a[0].length <=> b[0].length}[0].length
+    day = Date.today - options[:days]
+    if options[:verbose]
+      print " " * (name_column_width + 2)
+      (0..options[:days]).each do |i|
+          print((day + (i)).strftime('%a')[0].chr.swapcase.colorize(37))
+      end
+      puts
     end
-    puts
-  end
-  daily_counts = Array.new(29, 0)
-  @habits.each do |habit, times|
-    day = Date.today - (options[:days])
-    print (sprintf("%#{name_column_width}s ", habit) + "|").colorize(37)
-    times.collect! do |time|
-      if time.is_a? Hash
-        # For scalar values, normalize
-        time = time.keys.first
+    daily_counts = Array.new(29, 0)
+    @habits.each do |habit, times|
+      day = Date.today - (options[:days])
+      print((sprintf("%#{name_column_width}s ", habit) + "|").colorize(37))
+      times.collect! do |time|
+        normalize_time(time)
       end
-      if time.is_a? Time
-        time.to_date
-      elsif time.is_a? Date
-        # For user-inputted values, normalize
-        time
+      done_in_last_28, week, pre_week = 0, 0, 0
+      (0..options[:days]).each do |i|
+        if times.include? day
+          print "+".colorize(47)
+          daily_counts[i] += 1
+          done_in_last_28 += 1
+          pre_week += 1 unless i >= 20
+          week += 1 unless i < 20
+        else
+          print "-".colorize(37)
+        end
+        day += 1
       end
-    end
-    done_in_last_28, week, pre_week = 0, 0, 0
-    (0..options[:days]).each do |i|
-      if times.include? day
-        print "+".colorize(47)
-        daily_counts[i] += 1
-        done_in_last_28 += 1
-        pre_week += 1 unless i >= 20
-        week += 1 unless i < 20
+      if ((pre_week / 3) > (week + 2))
+        print "|".colorize(37)
+        print "(#{done_in_last_28}/28)".colorize(31)
       else
-        print "-".colorize(37)
+        print "|".colorize(37)
+        print "(#{done_in_last_28}/28)".colorize(32)
       end
-      day += 1
+      puts
     end
-    if ((pre_week / 3) > (week + 2))
-      print "|".colorize(37)
-      print "(#{done_in_last_28}/28)".colorize(31)
-    else
-      print "|".colorize(37)
-      print "(#{done_in_last_28}/28)".colorize(32)
+    if options[:verbose]
+      print " " * (name_column_width + 2)
+      (0..options[:days]).each do |i|
+          print((daily_counts[i] > 0) ? daily_counts[i] : " ")
+      end
+      puts
     end
-    puts
   end
-  if options[:verbose]
-    print " " * (name_column_width + 2)
-    (0..options[:days]).each do |i|
-        print (daily_counts[i] > 0) ? daily_counts[i] : " "
-    end
-    puts
+end
+
+def normalize_time(time)
+  if time.is_a? Hash
+    time = time.keys.first
+  end
+  if time.is_a? Time
+    time.to_date
+  elsif time.is_a? Date
+    time
+  end
+end
+
+
+
+
+hm = HabiterBin.new
+
+#
+# Command-line handling
+#
+
+options = {}
+optparse = OptionParser.new do |opts|
+  opts.banner = 
+    "Usage:
+    habiter did your_habit
+    habiter log"
+  options[:verbose] = false
+  opts.on('-v', '--verbose', "Show weekday letters for log") do
+    options[:verbose] = true
+  end
+  options[:yester] = 0
+  opts.on('-y', '--yester [DAYS]',
+          "Log an event in the past, given a number of days") do |days|
+    options[:yester] = days.to_i
   end
 end
 
 optparse.parse!
 
 if ARGV[0] == 'did'
-  did(ARGV)
+  key = ARGV[1]
+  scalar = (ARGV.length > 3) ? ARGV[2] : false
+  hm.did(key, scalar, options[:yester])
 elsif ARGV[0] == 'log'
-  log(options)
-else
-  puts optparse
+  hm.log(options)
+elsif ARGV[0] == 'dump'
+  hm.dump(options)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: habiter
 version: !ruby/object:Gem::Version 
-  version: "0.2"
+  version: "0.3"
 platform: ruby
 authors: 
 - Tom MacWright
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-06 00:00:00 -05:00
+date: 2009-12-13 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -23,7 +23,7 @@ extra_rdoc_files: []
 
 files: 
 - bin/habiter
-- README
+- README.rdoc
 has_rdoc: true
 homepage: http://github.com/tmcw/habiter
 licenses: []

data/README

@@ -1,54 +0,0 @@
-habiter is a simple tool for maintaining good habits
-
-It can be used with the 'don't break the chain' technique, like
-Joe's Goals or Sciral Consistency, but adopts more positive
-techniques and uses a readable and editable YAML text file as
-storage.
-
-Demo
-----
-
-~$ habiter did clean_room
-clean_room is not a habit yet. create and complete it? (y/n) y
-~$ habiter did jog
-jog is not a habit yet. create and complete it? (y/n) y
-~$ habiter log
-           jog |----------------------------+|(1/28)
-       project |-------------------------++-+|(3/28)
-practice_music |-----------------------+++++-|(5/28)
-      read_30m |-----------------------+--++-|(3/28)
-    clean_room |-----------------------+-+---|(2/28)
-
-Scalars
--------
-
-Habiter also now supports scalars: you can input a value for your
-activity, like
-
-habiter did jog 5.5
-habiter did heartbeat 78
-
-And it will be recorded. There is no representation of this data yet,
-and the representation within habiter will be minimal, only good output to
-formats which are easily visualized.
-
-Install
--------
-
-Install with 'gem install habiter' if you have gemcutter set up as a
-repository
-
-FAQ
----
-
-* How do I add past data?
-  How do I delete recorded data?
-  How do I modify stuff I've recorded?
-
-Edit ~/.habiter.yaml
-
-* How do I reset habiter?
-
-echo > ~/.habiter.yaml
-
-Dedicated to Bryn Bellomy :)