habits 0.1

data/LICENSE

@@ -0,0 +1,26 @@
+
+Copyright (c) 2010 Antti Hakala
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. 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.
+3. The name of the author may not be used to endorse or promote products
+   derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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

@@ -0,0 +1,8 @@
+Habits
+======
+
+An experimental habit tracker.
+
+Tracks habits in weekly cycles (i.e. status of each habit is cleared weekly). 
+Each habit has a day or days associated with it. Habits expects activity on the habit on those days. If no activity is registered, habit goes first into yellow zone (e.g. 20 hours before deadline), then into red zone (e.g. 6 hours before), and finally into missed state. Transfer into each zone/state can be used to trigger commands.
+

data/bin/habits

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'habits/command_line'
+

data/lib/habits/command_line.rb

@@ -0,0 +1,129 @@
+require 'time'
+require 'date'
+require 'habits'
+require 'habits/subcommand'
+require 'fileutils'
+
+if !File.exists?(Habits::Habit::HABITS_DIR)
+  FileUtils.mkdir Habits::Habit::HABITS_DIR
+  FileUtils.cp File.join(File.dirname(__FILE__), '..', '..', 'whip_config.rb'), 
+               Habits::Habit::HABITS_DIR+"/"
+  puts "\n*** Copied default whip_config.rb to #{Habits::Habit::HABITS_DIR}"
+  puts "*** Please edit it to suit you."
+  puts "*** Also, consider adding line '0   *   *   *   *   /usr/bin/habits whip'"
+  puts "*** to your crontab.\n"
+end
+
+sub = Subcommand.new
+
+sub.register('whip', [], 'Use the whip.') do
+  Habits::Whip.use
+end
+  
+sub.register('delete', ['TITLE'], 'Delete habit.') do |title|
+  h = Habits::Habit.find(title)
+  h.destroy
+  puts "#{h.title} deleted."
+end
+  
+sub.register('create', ['TITLE','DAYS'], 'Create a new habit.') do |title, days|
+  Habits::Habit.new(title, days.split(',')).save
+  puts "Habit \"#{title}\" created."
+end
+  
+sub.register('list', [], 'List habits.') do
+  puts "\nHABIT                     DAYS                           STATUS     YELLOW/RED"
+  puts "===============================================================================\n"
+  Habits::Habit.all_not_on_hold.each do |habit|
+    printf("%-25s %-30s %-10s [%dh / %dh]\n", 
+           habit.title, habit.days.join(','),
+           habit.status.value.to_s.capitalize,
+           (habit.yellow_zone / (60*60)),
+           (habit.red_zone / (60*60)))
+  end
+  puts "===============================================================================\n"
+  on_hold = Habits::Habit.all_on_hold
+  
+  if on_hold.size > 0
+    puts "\nOn Hold: #{on_hold.map{|h| h.title}.join(', ')}.\n"
+  end
+  
+  puts "\nWeek #{Date.today.cweek} | Total #{Habits::Habit.all.size} habits.\n\n"
+end
+
+sub.register('zones', ['TITLE','YELLOW_ZONE','RED_ZONE'], 
+             "Set habit's yellow and red zones.") do |title, yellow, red|
+  h = Habits::Habit.find(title)
+
+  h.yellow_zone = yellow.to_i * 60 * 60
+  h.red_zone = red.to_i * 60 * 60
+  h.save
+  puts "Zones set."
+end
+  
+sub.register('do', ['TITLE', '[HOURS]'], 
+             'Add activity to habit, hours optional.') do |title, hours|
+  h = Habits::Habit.find(title)
+  h.add_event(Habits::Events::Activity.new(hours ? hours.to_f : nil))
+  puts "Activity added."
+end
+
+sub.register('rename', ['TITLE', 'NEW_TITLE'], 'Rename habit.') do |title, new_title|
+  h = Habits::Habit.find(title)
+  h.set_title(new_title)
+  puts "Renamed #{title} -> #{new_title}"
+  h.save
+end
+
+sub.register('show', ['TITLE'], 'Show activity of habit.') do |title|
+  h = Habits::Habit.find(title)
+  
+  if h.events.empty?
+    puts "\nNo activity.\n\n"
+  else
+    puts "\n#{title} Activity:\n"+ ('='*(title.size)) + "==========\n"
+  
+    h.events.each do |event|
+      str = "  #{event.applied_at.strftime("%a %b %d %Y")}"
+      str += " #{event.duration} hours" if event.duration
+      puts str
+    end
+    puts
+  end
+end
+
+sub.register('split', ['TITLE'], 'Split a habit into days.') do |title|
+  h = Habits::Habit.find(title)
+  h.split!
+  puts "Habit \"#{title}\" split."
+end
+
+sub.register('join', ['TITLE', '[OTHER_TITLE]'], 
+             'Join habits. First one is kept.') do |title, other_title|
+  if other_title.nil?
+    Habits::Habit.join_all(title)
+    puts "#{title} joined."
+  else
+    habit = Habits::Habit.find(title)
+    other = Habits::Habit.find(other_title)
+    habit.join!(other)
+    puts "Habits \"#{title}\" and \"#{other_title}\" joined."
+  end
+end
+
+sub.register('hold', ['TITLE'], 'Put a habit on hold.') do |title|
+  h = Habits::Habit.find(title)
+  h.hold
+  puts "Habit \"#{title}\" is now on hold."
+end
+
+sub.register('unhold', ['TITLE'], 'Unhold a habit.') do |title|
+  h = Habits::Habit.find(title)
+  h.unhold
+  puts "Habit \"#{title}\" is not on hold anymore."
+end
+
+
+sub.default = 'list'
+
+sub.parse

data/lib/habits/event.rb

@@ -0,0 +1,11 @@
+module Habits
+  
+  module Event
+    attr_reader :applied_at
+  
+    def apply(habit, time=Time.now)
+      @applied_at = time
+    end
+  end
+  
+end

data/lib/habits/events/activity.rb

@@ -0,0 +1,20 @@
+require 'habits/event'
+
+module Habits::Events
+
+  class Activity
+    include Habits::Event
+    
+    attr_reader :duration
+    
+    def initialize(duration=nil)
+      @duration = duration
+    end
+  
+    def apply(habit, time)
+      super
+    end
+    
+  end
+  
+end

data/lib/habits/habit.rb

@@ -0,0 +1,162 @@
+require 'fileutils'
+require 'yaml'
+
+require 'habits/status'
+require 'habits/events/activity'
+
+module Habits
+
+  # The habit class. Attached events describe activities etc.
+  class Habit
+    HABITS_DIR  = File.join(ENV['HOME'], '.habits')
+    YELLOW_ZONE = 16*60*60 # 16 hours before deadline,
+    RED_ZONE    = 6*60*60  #  6 -"-
+    
+    def self.all
+      @@all ||= begin
+        habits = []
+        Dir.glob(File.join(HABITS_DIR, '*.habit')).each do |habit_file|
+          habits << YAML.load(File.read(habit_file))
+        end
+        habits
+      end
+    end
+    
+    def self.all_not_on_hold
+      all.select{|habit| habit.status != Status.on_hold}
+    end
+    
+    def self.all_on_hold
+      all.select{|habit| habit.status == Status.on_hold}
+    end
+    
+    def self.find(title)
+      h = Habit.all.detect {|h| h.title == title.strip}
+      raise "No such habit found." unless h
+      h
+    end
+    
+    # Join all habits with title 'title':something.
+    def self.join_all(title)
+      joinables = Habit.all.select {|habit| habit.title =~ /^#{title}:.+/}
+      raise "Habits not found." if joinables.size == 0
+      habit = Habit.find(title) rescue nil
+      habit ||= Habit.new(title, [])
+      joinables.each{|joinable| habit.join!(joinable)}
+    end
+    
+    attr_reader :title, :days, :status, :events
+    attr_accessor :yellow_zone, :red_zone
+    
+    def initialize(title, days = ['Mon'], 
+                   yellow_zone = YELLOW_ZONE, 
+                   red_zone    = RED_ZONE,
+                   events      = [])
+      set_title(title)
+      set_days(days)
+      @yellow_zone, @red_zone = yellow_zone, red_zone
+      @status = Status.green
+      @created_at = Time.now
+      @events = events
+    end
+    
+    def add_event(event, time=Time.now)
+      event.apply(self, time)
+      @events << event
+      save
+    end
+    
+    def file_path(title=@title)
+      File.join(HABITS_DIR, title.downcase + '.habit')
+    end
+    
+    def save
+      @@all = nil
+      FileUtils.rm_f(file_path(@old_title)) if @old_title
+      FileUtils.mkdir_p HABITS_DIR
+      File.open(file_path, 'w') do |file|
+        file.write self.to_yaml
+      end
+      self
+    end
+    
+    def update_status
+      old_status = @status
+      @status = Status.resolve(self)
+      
+      if old_status != @status
+        yield if block_given?
+        save
+      end
+    end
+    
+    def activities_on_week(week, day=nil)
+      activities = @events.select do |e| 
+        e.is_a?(Events::Activity) and Date.new(e.applied_at.year, 
+                                               e.applied_at.month,
+                                               e.applied_at.day).cweek == week
+      end
+      activities = activities.select{|a| a.applied_at.strftime('%a') == day} if day
+      activities
+    end
+    
+    def destroy
+      FileUtils.rm_f file_path
+      @@all = nil
+    end
+    
+    def set_title(title)
+      raise "No spaces or commas allowed in habit title" if title =~ /[\s,,]+/
+      @old_title = @title
+      @title = title
+    end
+    
+    def set_days(days)
+      if days.detect{|d| Time::RFC2822_DAY_NAME.index(d).nil?}
+        raise "Valid days are #{Time::RFC2822_DAY_NAME.join(',')}"
+      else
+        @days = days
+      end
+    end
+    
+    def split
+      @days.map do |day|
+        events = @events.select{|event| event.applied_at.strftime('%a') == day}
+        Habit.new("#{@title}:#{day}", [day], YELLOW_ZONE, RED_ZONE, events)
+      end
+    end
+    
+    def split!
+      habits = split
+      habits.each{|habit| habit.save}
+      destroy
+      habits
+    end
+    
+    def join(habit)
+      @events += habit.events
+      @days += habit.days
+      @days.uniq!
+      @days.sort!{|a,b| Time::RFC2822_DAY_NAME.index(a) <=> Time::RFC2822_DAY_NAME.index(b)}
+    end
+    
+    def join!(habit)
+      join(habit)
+      save
+      habit.destroy
+    end
+    
+    def hold
+      @status = Status.on_hold
+      save
+    end
+    
+    def unhold
+      @status = Status.green
+      @status = Status.resolve(self)
+      save
+    end
+    
+  end
+  
+end

data/lib/habits/mock_data_store.rb

@@ -0,0 +1,25 @@
+
+module Habits
+  
+  # a module to  in Habit to mock data storing
+  class Habit
+    
+    def self.all
+      @@all
+    end
+    
+    def self.all=(habits)
+      @@all = habits
+    end
+    
+    def save
+      # do nothing
+    end
+    
+    def destroy
+      # do nothing
+    end
+    
+  end
+  
+end

data/lib/habits/status.rb

@@ -0,0 +1,60 @@
+require 'date'
+require 'time'
+
+module Habits
+  class Status
+    include Comparable
+    
+    VALUES = [:green, :yellow, :red, :missed, :on_hold]
+    VALUES.each do |val|
+      eval %Q(def self.#{val}; Status.new(#{val.inspect}) end)
+    end
+    
+    attr_reader :value
+    
+    def initialize(val)
+      raise "Invalid status value" unless VALUES.include?(val)
+      @value = val
+    end
+    
+    def <=>(other)
+      VALUES.index(self.value) <=> VALUES.index(other.value)
+    end
+    
+    # Resolves the status of a habit.
+    # Status starts fresh every week.
+    def self.resolve(habit, time=Time.now)
+      return Status.on_hold if habit.status == Status.on_hold
+      
+      statuses = []
+      date = Date.new(time.year, time.month, time.day)
+      
+      habit.days.each do |day|
+        activities = habit.activities_on_week(date.cweek, day)
+        day_diff = Time::RFC2822_DAY_NAME.index(day) - date.wday
+        
+        if !activities.empty? or (day_diff > 0)
+          statuses << Status.green
+        else
+          dl_date = date + day_diff
+          deadline = Time.mktime(dl_date.year, dl_date.month, 
+                                 dl_date.day, 23, 59)
+          
+          if Date.new(deadline.year, deadline.month, deadline.day).cweek != date.cweek
+            statuses << Status.green
+          elsif time > deadline
+            statuses << Status.missed
+          elsif time > (deadline - habit.red_zone)
+            statuses << Status.red
+          elsif time > (deadline - habit.yellow_zone)
+            statuses << Status.yellow
+          else
+            statuses << Status.green
+          end
+        end
+      end
+      statuses.max
+    end
+    
+  end
+end

data/lib/habits/subcommand.rb

@@ -0,0 +1,96 @@
+#
+# A minimal command line parser for subcommands.
+# CMD SUBCOMMAND ARG1 ARG2 ...
+#
+class Subcommand
+  attr_reader :subs
+  
+  class Cmd
+    attr_reader :args, :desc, :blk
+    
+    def initialize(args, desc, blk)
+      @args, @desc, @blk = args, desc, blk
+      @optional = @args.pop if @args.last =~ /^\[.*\]$/
+    end
+    
+    def args_str
+      (@args + [@optional]).compact.join(' ')
+    end
+    
+    # Parse @call_args for this command
+    def parse(args)
+      if (args.size == @args.size) or (@optional and args.size == @args.size+1)
+        @call_args = args
+      else
+        raise "Invalid arguments."
+      end
+    end
+    
+    # Trigger this command
+    def call
+      if @optional # provide nil for the optional arg in block if needed
+        args = @call_args
+        args << nil if @call_args.size == @args.size
+        blk.call *args
+      else
+        blk.call *@call_args
+      end
+    end
+  end
+
+  def initialize
+    @default = nil
+    @subs = {}
+  end
+  
+  # Register a command with name, arguments, description, and block (blk).
+  # The block is called with as many input args as you defined in 'args'
+  def register(cmd_name, args, desc, &blk)
+    @subs ||= {}
+    @subs[cmd_name] = Cmd.new(args, desc, blk)
+  end
+  
+  # Set the default command to be called when just the executable is run.
+  def default(&blk)
+    raise "No block given" unless blk
+    @default = blk
+  end
+  
+  # Set the default command to be one of the registered subcommands
+  def default=(cmd_name)
+    raise "No subcommand #{cmd_name} registerd" if @subs[cmd_name].nil?
+    @default = @subs[cmd_name].blk
+  end
+  
+  # Parse command line arguments according to registered commands.
+  def parse(args=ARGV)
+    if args.size == 0
+      @default.call if @default
+      return
+    end
+    
+    sub = @subs[args.shift]
+    
+    help and return if sub.nil?
+    
+    begin
+      sub.parse(args)
+      sub.call
+    rescue Exception => e
+      puts e.message
+      help
+    end
+  end
+  
+  # Print help of available commands.
+  def help
+    puts "\nUsage: #{File.basename($0)} {command} arg1 arg2 ...\n\nCommand        Args"+
+         ' '*32+"Description"
+    @subs.keys.sort.each do |name|
+      printf("  %-12s %-35s %s\n", name, @subs[name].args_str, @subs[name].desc)
+    end
+    puts
+    true
+  end
+  
+end

data/lib/habits/whip.rb

@@ -0,0 +1,39 @@
+require 'habits/habit'
+
+module Habits
+  
+  module Whip
+    extend self
+    @@transitions = {}
+    @@ticks = []
+    
+    # Add block to be executed when status changes to given status.
+    # A habit which changes to this status is passed to the block.
+    def on(status, &blk)
+      raise "No block given" if blk.nil?
+      @@transitions[status] = blk
+    end
+    
+    # Add a block to be called each time before whip is used.
+    def on_tick(&blk)
+      raise "No block given" if blk.nil?
+      @@ticks << blk
+    end
+    
+    # Use whip, i.e. update status of each habit and call
+    # blocks associated with state changes.
+    def use
+      @@ticks.each {|tick| tick.call}
+      
+      Habit.all.each do |habit|
+        habit.update_status do
+          st = habit.status.value
+          @@transitions[st].call(habit) if @@transitions[st]
+        end
+      end
+    end
+  end
+end
+
+config = File.join(Habits::Habit::HABITS_DIR, 'whip_config.rb')
+require config if File.exists?(config)

data/lib/habits.rb

@@ -0,0 +1,3 @@
+
+require 'habits/habit'
+require 'habits/whip'

data/whip_config.rb

@@ -0,0 +1,24 @@
+#
+# a habits whip config file
+#
+# Store in $HOME/.habits/whip_config.rb
+#
+
+def dialog(title, txt)
+  system %Q(say '#{title}')
+  system %Q(osascript -e 'tell app "System Events" to display dialog "#{txt}"')
+  # or if you have 'ruby-growl' gem installed
+  # system "growl -h localhost -m '#{txt}'"
+end
+
+Habits::Whip.on(:yellow) do |habit|
+  dialog habit.title, "[HABITS] #{habit.title} is now in yellow."
+end
+
+Habits::Whip.on(:red) do |habit|
+  dialog habit.title, "[HABITS] #{habit.title} is now in RED!"
+end
+
+Habits::Whip.on(:missed) do |habit|
+  dialog habit.title, "[HABITS] #{habit.title} MISSED!"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: habits
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Antti Hakala
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-26 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: A habit tracker. Tracks habits in weekly cycles.Each habit has a day or days associated with it.Habits expects activity on the habit on those days. If no activity is registered, habit goes first into yellow zone (e.g. 20 hours before deadline) and then into red zone (e.g. 6 hours). And finally into missed state.Transfer into each state can be used to trigger commands.
+email: antti.hakala@gmail.com
+executables: 
+- habits
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- LICENSE
+- bin/habits
+- whip_config.rb
+- lib/habits/command_line.rb
+- lib/habits/event.rb
+- lib/habits/events/activity.rb
+- lib/habits/habit.rb
+- lib/habits/mock_data_store.rb
+- lib/habits/status.rb
+- lib/habits/subcommand.rb
+- lib/habits/whip.rb
+- lib/habits.rb
+has_rdoc: true
+homepage: http://github.com/ander/habits
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A habit tracker.
+test_files: []
+