time_tap 0.2.0

data/.gitignore

@@ -0,0 +1,42 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+
+gem 'activesupport',  '~> 2.3.8'
+gem 'actionpack',     '~> 2.3.8'
+gem 'i18n',           '~> 0.3.5'
+gem 'haml'
+gem 'rb-appscript'
+gem 'sinatra'
+
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 2.0.0.beta.19"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.0.pre3"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (2.3.9)
+      activesupport (= 2.3.9)
+      rack (~> 1.1.0)
+    activesupport (2.3.9)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    haml (3.0.21)
+    i18n (0.3.7)
+    jeweler (1.5.0.pre3)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.1.0)
+    rake (0.8.7)
+    rb-appscript (0.5.3)
+    rcov (0.9.9)
+    rspec (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+      rspec-mocks (= 2.0.0.rc)
+    rspec-core (2.0.0.rc)
+    rspec-expectations (2.0.0.rc)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+    sinatra (1.0)
+      rack (>= 1.0)
+    yard (0.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 2.3.8)
+  activesupport (~> 2.3.8)
+  bundler (~> 1.0.0)
+  haml
+  i18n (~> 0.3.5)
+  jeweler (~> 1.5.0.pre3)
+  rb-appscript
+  rcov
+  rspec (>= 2.0.0.beta.19)
+  sinatra
+  yard (~> 0.6.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Elia Schito
+
+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.md

@@ -0,0 +1,96 @@
+# TimeTap
+
+TimeTap helps you track the time you spend coding on each project while in TextMate.
+
+Once it's launched you don't have to bother anymore starting/stopping timers or 
+inventing some arbitrary amount of time to fill your fancy time tracker.
+
+<img src="http://f.cl.ly/items/17025fecf7189518cf07/timetap-project-list.png"/>
+<img src="http://f.cl.ly/items/7b96ad2f7b49a95fdfd0/timetap-project-page.png"/>
+
+
+## How does it work
+
+TimeTap keeps an eye on (tracks) the modification time of the frontmost file 
+and tells you how much time you spent on each project. 
+
+If you stop coding for a while while squeezing your brains TimeTap understands. 
+TimeTap will consider "coding time" pauses to up to 30 minutes between to saves 
+in the same project.
+
+Technically it saves a timestamp+path of the frontmost file in TextMate every 
+30 seconds, then it digests all this information in a nice Sinatra webapp.
+
+The server will respond on http://0.0.0.0:1111/.
+
+
+## Instructions
+
+Run `ruby -Ilib bin/timetap` or run 
+`rake launcher && launchctl load ~/Library/LaunchAgents` 
+to add a plist for OSX's launchd and have it launched automatically at login.
+
+## Setting up config file
+
+timetap uses a config file to control where projects are kept, etc. Put this config file in `~/.tap_config`.
+
+    cp config.yaml ~/.tap_config
+
+### Keys Explained
+
+    root - where the timetap logs should be saved. Recommended value: ~
+    code - where all you project live, in a flat hierachy. 
+    nested_project_layers - see below, on nested projects. Default is 1
+    
+
+Nested Projects allows you to keep your projects inside a hierarchy, instead of the original assumption of timetap (which is that all projects are flat).
+
+For example, you could keep your directory structure might look like:
+
+    ~/Code/
+      Clients/
+        AcmeCorp/
+          website/
+            intranet
+        BetaCorp/
+          skunkworks/
+      OpenSource/
+        project_one/
+        timetap/
+
+A `nested_project_layers` setting of 2 (in your `.tap_config` file) would mean we track "AcmeCorp", "BetaCorp", and everything under OpenSource, as their own projects
+    
+## Assumptions
+
+* You code on TextMate.
+* You save often (like me), at least every 30 minutes.
+* You keep your code organized (I use ~/Code as main code folder).
+
+
+## TODO
+
+- support other text editors, or at least make it easy to do so
+- (r)spec it!
+- make it more configurable
+- gemify (with jeweler)
+- flatten encoding quick-fixes with proper solutions (eat and spit only utf8)
+- integration with external (online) time tracking tools
+- export to csv (?)
+
+
+## How to Contribute
+
+Use it, love it, then...
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+## Copyright
+
+Copyright (c) 2009 Elia Schito. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+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 = "time_tap"
+  gem.summary = %Q{Unobtrusive time tracking for TextMate}
+  gem.description = %Q{TimeTap helps you track the time you spend coding on each project while in TextMate.}
+  gem.email = "perlelia@gmail.com"
+  gem.homepage = "http://github.com/elia/timetap"
+  gem.authors = ["Elia Schito"]
+  # 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)
+  #  spec.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  spec.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_development_dependency "rspec", ">= 2.0.0.beta.19"
+  gem.add_development_dependency "yard", "~> 0.6.0"
+  gem.add_development_dependency "bundler", "~> 1.0.0"
+  gem.add_development_dependency "jeweler", "~> 1.5.0.pre3"
+  gem.add_development_dependency "rcov", ">= 0"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+require 'time_tap/tasks'

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bin/timetap

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'time_tap'
+
+
+require 'yaml'
+user_config = File.expand_path("~/.tap_config")
+config_file = File.expand_path('../../config.yaml', __FILE__)
+
+options = YAML.load_file(config_file)
+options.merge! YAML.load_file(user_config) if File.exist?(user_config)
+TimeTap.config = options
+
+
+require 'optparse'
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options]"
+
+  opts.on("-f", "--foreground", "Run in foreground.") do
+    TimeTap.config[:foreground] = true
+  end
+  
+  opts.on("-p", "--port PORT", "Use specified port for server. (default #{options['port']})") do |value|
+    TimeTap.config[:port] = value
+  end
+  
+  opts.on("--install", "Launch automatically at login.") do
+    TimeTap.install!
+    puts "\nInstalled. Now run:\n  launchctl load ~/Library/LaunchAgents\n\n"
+    exit
+  end
+  
+  opts.on("--reload", "Reload login launch agent.") do
+    puts 'Reloading...'
+    TimeTap.reload!
+    exit
+  end
+end.parse!
+
+
+unless TimeTap.config[:foreground]
+  require 'time_tap/daemon'
+  
+  pid = fork {
+    # Try to replace "ruby" with "TimeTap" in the command string (for "ps -A" & co.)
+    $0 = 'TimeTap'
+    
+    Process.daemon(true)
+    TimeTap.start
+  }
+else
+  puts "going foreground"
+  TimeTap.start
+end

data/config.yaml

@@ -0,0 +1,8 @@
+root: "~"
+port: 1111
+code: Code
+nested_project_layers: 1
+ruby: /usr/bin/ruby
+textmate:
+  projects: ~/Development/Current Projects
+

data/lib/time_tap.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+
+require 'rubygems'
+gem 'activesupport',  '~> 2.3.8'
+gem 'actionpack',     '~> 2.3.8'
+gem 'i18n',           '~> 0.3.5'
+gem 'haml'
+gem 'rb-appscript'
+gem 'sinatra'
+
+
+module TimeTap
+  attr_accessor :config
+  
+  extend self
+  
+  
+  # CONFIGURATION
+
+  # Are we on 1.9?
+  # FIXME: this is wrong! :)
+  RUBY19 = RUBY_VERSION.to_f >= 1.9
+  
+  def config= options = {}
+    require 'active_support'
+    
+    # CONFIG
+    @config = HashWithIndifferentAccess.new(options)
+    @config[:root] = File.expand_path(config[:root])
+    @config[:port] = config[:port].to_i
+  end
+  
+  
+  def start options = {}
+    # REQUIREMENTS
+  
+    require 'yaml'
+    require 'active_support'
+    require 'time_tap/project'
+    require 'time_tap/editors'
+    require 'time_tap/watcher'
+    require 'time_tap/server'
+    
+    
+  
+    # SIGNAL HANDLING
+  
+    Signal.trap("INT")  {exit}
+    Signal.trap("TERM") {exit}
+  
+  
+    # WEB SERVER
+  
+    Thread.abort_on_exception = true
+  
+    @server = Thread.new {
+      Signal.trap("INT")  {exit}
+      Signal.trap("TERM") {exit}
+    
+      Server.run! :host => 'localhost', :port => TimeTap.config[:port]
+      exit
+    }
+  
+  
+    # WATCHER
+  
+    include Editors
+    Watcher.keep_watching(TextMate)
+  end
+  
+  # Add a plist for OSX's launchd and have *TimeTap* launched automatically at login.
+  def install!
+    load_plist_info!
+    ruby        = config[:ruby] || "/usr/bin/ruby"
+    include_dir = '-I'+File.expand_path('../../lib', __FILE__)
+    launcher    = File.expand_path('../../bin/timetap', __FILE__)
+
+    puts "\nCreating launchd plist in\n  #{plist_path}"
+
+    File.open(plist_path, 'w') do |file|
+      file << <<-PLIST
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>Label</key>
+	<string>com.eliaesocietas.TimeTap</string>
+
+	<key>Program</key>
+	<string>#{ruby}</string>
+
+	<key>ProgramArguments</key>
+	<array>
+		<string>#{ruby}</string>
+		<string>#{include_dir}</string>
+		<string>#{launcher}</string>
+		<string>-f</string>
+	</array>
+
+	<key>OnDemand</key>
+	<false/>
+
+	<key>RunAtLoad</key>
+	<true/>
+</dict>
+</plist>
+      PLIST
+    end
+  end
+  
+  def reload!
+    load_plist_info!
+    command = "launchctl unload #{plist_path}; launchctl load #{plist_path}"
+    exec command
+  end
+  
+  private
+  
+    attr_reader :plist_path, :plist_name
+    
+    def load_plist_info!
+      @plist_name ||= "com.eliaesocietas.TimeTap.plist"
+      @plist_path ||= File.expand_path("~/Library/LaunchAgents/#{plist_name}")
+    end
+    
+end