timetrackr 0.1.1

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'shoulda', '>= 0'
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.5.2'
+  gem 'rcov', '>= 0'
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 felix
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.mkd

@@ -0,0 +1,36 @@
+# timetrackr
+
+A simple CLI time tracking utility.
+
+## Example
+
+    >tt start work
+
+    >tt switch play
+
+    >tt
+    work                            0h  0m  3s
+    play *                          0h  0m  1s
+
+    >tt clear work
+
+    >tt time
+    play *                          0h  0m  5s
+
+
+
+## Contributing to timetrackr
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+
+## Copyright
+
+Copyright (c) 2011 Felix Hanley. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "timetrackr"
+  gem.homepage = "http://github.com/felix/timetrackr"
+  gem.license = "MIT"
+  gem.summary = "A simple time tracking utility"
+  gem.description = "A simple time tracking utility"
+  gem.email = "felix@seconddrawer.com.au"
+  gem.authors = ["Felix Hanley"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "timetrackr #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/bin/timetrackr

@@ -0,0 +1,161 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'timetrackr'
+require 'timetrackr/period'
+
+DEFAULTS = {
+  :backend => 'sqlite',
+  :verbose => false,
+  :single_task => false,
+  :path => File.join(ENV['HOME'],'.timetrackr.db'),
+  :relative_format => "%2<hours>dh %2<minutes>dm %2<seconds>ds",
+  :absolute_time => "%H:%m",
+  :absolute_day => "%Y-%m-%d"
+}
+
+def show_help
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  puts "timetrackr version #{version}"
+  puts <<HELP
+
+  timetrackr [command] [options]
+
+  Available commands:
+
+      start [task]   start a task
+      stop [task]    stop a task (or 'all')
+      switch TASK    switch tasks
+      time [task]    show time for a task (or 'all')
+      log [task]     show time log for a task (or 'all')
+
+  Global options
+      -h --help      show this help
+      -v --verbose   be noisy
+HELP
+end
+
+def format_time(time, fmt_str)
+  hours = time.to_i/3600.to_i
+  minutes = (time/60 - hours * 60).to_i
+  seconds = (time - (minutes * 60 + hours * 3600))
+  format(fmt_str,{
+    :hours => hours,
+    :minutes => minutes,
+    :seconds => seconds})
+end
+
+config = {}
+config_file = File.join(ENV['HOME'],'.timetrackrrc')
+if File.exist?(config_file)
+  require 'yaml'
+  config = YAML.load_file(config_file)
+end
+
+# global options
+while (cmd = ARGV.shift) && cmd.start_with?('-')
+  if ['-v','--verbose'].include? cmd
+    config[:verbose] = true
+  end
+  if ['-h','--help'].include? cmd
+    show_help
+    exit 1
+  end
+end
+
+config = DEFAULTS.merge(config || {})
+$verbose = config[:verbose]
+trackr = TimeTrackr.create(config[:backend], config)
+
+# 
+# commands
+#
+case cmd
+when 'start','in','s'
+  task = ARGV.shift
+  notes = ARGV.join(' ')
+  # switch tasks if config says so
+  if config[:single_task] && trackr.current != task
+    trackr.current.each { |t|
+      trackr.stop(t) unless t == task
+    }
+    puts "Switched to task '#{task}'" if $verbose
+  else
+    puts "Started task '#{task}'" if $verbose
+  end
+  trackr.start(task, notes)
+
+when 'stop','out','kill','k'
+  if ARGV[0] == 'all' || ARGV[0].nil?
+    tasks = trackr.tasks
+  else
+    tasks = ARGV
+  end
+  tasks.each do |task|
+    trackr.stop(task)
+    puts "Stopped task '#{task}'" if $verbose
+  end
+
+when 'switch','sw'
+  task = ARGV.shift
+  notes = ARGV.join(' ')
+  trackr.current.each do |t|
+    trackr.stop(t) unless t == task
+  end
+  trackr.start(task, notes)
+  puts "Switched to task '#{task}'" if $verbose
+
+when 'time','status',nil
+  task = ARGV.shift
+  if task && trackr.tasks.include?(task)
+    tasks = [*task]
+  else
+    tasks = trackr.tasks.each
+  end
+  tasks.each do |task|
+    total = trackr.history(task).reduce(0){ |t, period|
+      t = t + period.length
+    }
+    name = trackr.current.include?(task) ? task+' *' : task
+    puts name.ljust(15) << format_time(total,config[:relative_format])
+  end
+
+when 'log'
+  if ARGV[0] == 'all' || ARGV[0].nil?
+    tasks = trackr.tasks
+  else
+    tasks = ARGV
+  end
+  table = []
+  periods = tasks.each.collect{ |t| trackr.history(t) }.flatten
+  lastday = nil
+  table << periods.sort{|x,y| x.start <=> y.start}.collect{ |period|
+    currday = period.start.strftime(config[:absolute_day])
+    day = (currday == lastday) ? ' ' : currday
+    lastday = currday
+    name = period.current? ? period.task+' *' : period.task
+    start = period.start.strftime(config[:absolute_time])
+    stop = period.current? ? ' ' : period.stop.strftime(config[:absolute_time])
+    length = format_time(period.length, config[:relative_format])
+    "#{day.ljust(12)} #{name.ljust(15)} #{start.ljust(7)} #{stop.ljust(7)} #{length}"
+  }
+  puts table.join("\n")
+
+
+when 'clear','delete','del'
+  tasks = ARGV
+  tasks = trackr.tasks if task == 'all'
+  tasks.each do |task|
+    trackr.clear(task)
+    puts "Task '#{task}' cleared" if $verbose
+  end
+
+else
+  puts "'#{cmd}' is not a valid command"
+  show_help
+end
+
+trackr.close
+
+#  vim: set ts=2 sw=2 tw=80 ft=ruby fdm=syntax et fen :

data/lib/timetrackr/period.rb

@@ -0,0 +1,21 @@
+class Period
+
+  attr_accessor :task, :start, :stop, :notes
+
+  def initialize(task, start, stop=nil, notes='')
+    @task = task
+    @start = start
+    @stop = stop
+    @notes = notes
+  end
+
+  def length
+    stop = @stop || DateTime.now
+    stop - @start
+  end
+
+  def current?
+    stop.nil?
+  end
+
+end

data/lib/timetrackr/yaml.rb

@@ -0,0 +1,70 @@
+#
+# keeps the following format in a yaml file:
+#
+# :current: []
+#
+# :tasks:
+#   foo:
+#   - :start: 2011-05-16 14:26:26.263449 +07:00
+#     :stop: 2011-05-16 14:26:27 +07:00
+#     :notes: "blah blah blah"
+#
+
+class YamlTimeTrackr < TimeTrackr
+
+  def initialize(path)
+    @log_path = path
+    if !File.exist? @log_path
+      @db = {:current => [], :tasks => {}}
+      write_file
+    end
+    @db = YAML.load_file(@log_path)
+    puts "Using log file '#{@log_path}'" if $verbose
+  end
+
+  def current
+    @db[:current]
+  end
+
+  def tasks
+    @db[:tasks].keys.compact.uniq || []
+  end
+
+  def start(task, notes)
+    @db[:tasks][task] = Array[] unless @db[:tasks][task]
+    if !@db[:current].include?(task)
+      @db[:current].unshift(task)
+      @db[:tasks][task].push({:start => Time.now, :notes => notes})
+    end
+  end
+
+  def stop(task)
+    if @db[:current].include?(task)
+      @db[:current].delete(task)
+      @db[:tasks][task].last[:stop] = Time.now
+    end
+  end
+
+  def history(task, p_begin=nil, p_end=nil)
+    @db[:tasks][task].sort{|x,y| x[:start] <=> y[:start]}.collect {|p|
+      Period.new(task,p[:start],p[:stop],p[:notes])
+    } unless !@db[:tasks].include? task
+  end
+
+  def close
+    write_file
+  end
+
+  def clear(task)
+    @db[:current].delete(task)
+    @db[:tasks].delete(task)
+  end
+
+  private
+
+  def write_file
+    File.open(@log_path,'w') do |fh|
+      YAML.dump(@db,fh)
+    end
+  end
+end

data/lib/timetrackr.rb

@@ -0,0 +1,84 @@
+autoload 'YamlTimeTrackr', 'timetrackr/yaml'
+autoload 'SqliteTimeTrackr', 'timetrackr/sqlite'
+
+class TimeTrackr
+  def self.create(type,options={})
+    case type.to_s
+    when 'yaml'
+      begin
+        require 'yaml'
+        log = YamlTimeTrackr.new(options[:path])
+        puts 'Loaded yaml tracker' if $verbose
+      rescue LoadError
+        puts 'Yaml not found'
+      end
+    when 'sqlite'
+      begin
+        require 'sqlite3'
+        log = SqliteTimeTrackr.new(options[:path])
+        puts 'Loaded sqlite tracker' if $verbose
+      rescue LoadError
+        puts 'Sqlite not found'
+      end
+    else
+      raise "Bad log type: #{type}"
+    end
+    log
+  end
+
+  #
+  # return an array of current tasks
+  #
+  def current
+    raise 'Not Implemented'
+  end
+
+  #
+  # start a period
+  #
+  def start(task,notes)
+    raise 'Not implemented'
+  end
+
+  #
+  # stop a period
+  #
+  def stop(task)
+    raise 'Not implemented'
+  end
+
+  #
+  # return an array of all tasks
+  #
+  def tasks
+    raise 'Not Implemented'
+  end
+
+  #
+  # time in task in seconds
+  #
+  def time(task)
+  end
+
+  #
+  # get task history as an array of Periods
+  #
+  def history(task)
+    raise 'Not Implemented'
+  end
+
+  #
+  # clear an task
+  #
+  def clear(task)
+    raise 'Not Implemented'
+  end
+
+  #
+  # cleanup and close
+  #
+  def close
+  end
+
+end
+

data/test/helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'timetrackr'

data/test/test_timetrackr.rb

@@ -0,0 +1,53 @@
+require 'helper'
+
+class TestTimetrackr < Test::Unit::TestCase
+  context 'a YAML based tracker' do
+    setup do
+      @config = {:path => '/tmp/timetracker.test'}
+      @t = TimeTrackr.create('yaml',@config)
+    end
+
+    def teardown
+      File.unlink(@config[:path]) rescue nil
+    end
+
+    should 'initialise a log file' do
+      assert File.exist?(@config[:path])
+    end
+
+    context 'with empty db' do
+      setup do
+        File.open(@config[:path]) do |fh|
+          @db = YAML.load(fh)
+        end
+      end
+
+      should 'create basic structure' do
+        File.open(@config[:path]) do |fh|
+          @db = YAML.load(fh)
+        end
+        assert @db[:current].class == Array
+        assert @db[:tasks].class == Hash
+      end
+
+      should 'not fail on current command' do
+        assert_nothing_raised Exception do
+          @t.current
+        end
+      end
+
+      should 'not fail on tasks command' do
+        assert_nothing_raised Exception do
+          @t.tasks
+        end
+      end
+
+      should 'not fail on close command' do
+        assert_nothing_raised Exception do
+          @t.close
+        end
+      end
+
+    end
+  end
+end

data/timetrackr.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{timetrackr}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Felix Hanley"]
+  s.date = %q{2011-05-17}
+  s.default_executable = %q{timetrackr}
+  s.description = %q{A simple time tracking utility}
+  s.email = %q{felix@seconddrawer.com.au}
+  s.executables = ["timetrackr"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.mkd"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.mkd",
+    "Rakefile",
+    "VERSION",
+    "bin/timetrackr",
+    "lib/timetrackr.rb",
+    "lib/timetrackr/period.rb",
+    "lib/timetrackr/yaml.rb",
+    "test/helper.rb",
+    "test/test_timetrackr.rb",
+    "timetrackr.gemspec"
+  ]
+  s.homepage = %q{http://github.com/felix/timetrackr}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A simple time tracking utility}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_timetrackr.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: timetrackr
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Felix Hanley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-17 00:00:00 +07:00
+default_executable: timetrackr
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: A simple time tracking utility
+email: felix@seconddrawer.com.au
+executables: 
+- timetrackr
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.mkd
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.mkd
+- Rakefile
+- VERSION
+- bin/timetrackr
+- lib/timetrackr.rb
+- lib/timetrackr/period.rb
+- lib/timetrackr/yaml.rb
+- test/helper.rb
+- test/test_timetrackr.rb
+- timetrackr.gemspec
+has_rdoc: true
+homepage: http://github.com/felix/timetrackr
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2036167775305557846
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A simple time tracking utility
+test_files: 
+- test/helper.rb
+- test/test_timetrackr.rb