time_tap 0.2.0 → 0.4.0.pre

data/.gitignore

@@ -1,42 +1,10 @@
-# rcov generated
 coverage
-
-# rdoc generated
 rdoc
-
-# yard generated
 doc
 .yardoc
-
-# bundler
+pkg/*
+*.gem
 .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
+.sass*
+/Gemfile.lock
+/log/*.log

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/Gemfile

@@ -1,22 +1,4 @@
-source "http://rubygems.org"
+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
+# Specify your gem's dependencies in time_tap.gemspec
+gemspec

data/README.md

@@ -2,80 +2,122 @@
 
 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 
+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. 
+## Installing
 
-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 
+    gem install time_tap
+
+    timetap --install
+
+… and visit [localhost:1111](http://localhost:1111/)
+
+### Installing from source
+
+- Get the codez: `git clone git://github.com/elia/timetap.git`
+- Run `bundle exec bin/timetap --install`
+
+
+
+
+## How it works
+
+TimeTap keeps an eye on the modification time of the frontmost file in TextMate
+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 
+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
+### 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).
+
+
+## Editors
+
+TimeTap works with TextMate, TextMate2 and SublimeText2.
+For TM2 and ST2 you need to install specific bundles (in the `vendor/` folder).
+
+### TextMate
+
+Need to do nothing, thanks to `rb-appscript` :)
+
+
+### TextMate 2
+
+You need to install the bundle in [`vendor/SublimeText2`](https://github.com/elia/timetap/tree/master/vendor/TextMate2)
+
+
+### SublimeText
+
+You need to install the package in [`vendor/SublimeText2`](https://github.com/elia/timetap/tree/master/vendor/SublimeText2)
+
+
+
+## Configuring
 
-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.
+TimeTap uses a config file to control where projects are kept, etc. the path is:
 
-## Setting up config file
+    ~/.timetap.config
 
-timetap uses a config file to control where projects are kept, etc. Put this config file in `~/.tap_config`.
+Which can look like this:
 
-    cp config.yaml ~/.tap_config
+```yaml
+port: 1111
+# the port on localhost for the web interface
 
-### Keys Explained
+# These are used to identify project root folders
+code_folders:
+  - ~/Code/MyCompany
+  - ~/Code
 
-    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
-    
+# It's highly recomended to use 1.9.3
+ruby: /Users/elia/.rvm/bin/ruby-1.9.3-p286
+```
 
-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:
+
+### About "nested project layers"
+
+TimeTap assumes you keep your projects inside a specific folder, like this:
+
+    ~/Code/
+      tap/
+      tik_tak/
+      tk-win/
+      AcmeCorp/
+        website/
+        intranet/
+
+But if you keep your projects grouped in subfolders like this:
 
     ~/Code/
       Clients/
         AcmeCorp/
           website/
-            intranet
+          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 (?)
+then, the `nested_project_layers` key tells TimeTap how deep to look for project names inside a hierarchy (in the example a value of 2 will catch `AcmeCorp`, `BetaCorp`, `project_one` and `timetap`).
 
 
 ## How to Contribute
@@ -91,6 +133,27 @@ Use it, love it, then...
 * Send me a pull request. Bonus points for topic branches.
 
 
+### TODO
+
+- <strike>make it more configurable</strike>
+- <strike>gemify (with jeweler)</strike>
+- <strike>support other text editors, or at least make it easy to do so</strike>
+- (r)spec it!
+- flatten encoding quick-fixes with proper solutions (eat and spit only utf8)
+- integration with external (online) time tracking tools
+
+
+## Credits
+
+- Ryan Wilcox [@rwilcox](https://github.com/rwilcox)
+
+
+## Related Projects
+
+- [Watch Tower](https://github.com/TechnoGate/watch_tower)
+- [Vim TimeTap](https://github.com/rainerborene/vim-timetap)
+
+
 ## Copyright
 
-Copyright (c) 2009 Elia Schito. See LICENSE for details.
+Copyright © 2009-2012 Elia Schito. See LICENSE for details.

data/Rakefile

@@ -1,34 +1,5 @@
-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
+Bundler::GemHelper.install_tasks
 
 require 'rspec/core'
 require 'rspec/core/rake_task'

data/bin/timetap

@@ -4,52 +4,51 @@
 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
-
+TimeTap.load_user_config!
 
 require 'optparse'
 OptionParser.new do |opts|
   opts.banner = "Usage: #{$0} [options]"
 
-  opts.on("-f", "--foreground", "Run in foreground.") do
-    TimeTap.config[:foreground] = true
+  opts.on("-f", "--foreground", "Run in foreground (default).") do
+    TimeTap.config[:background] = false
+  end
+
+  opts.on("-b", "--background", "Run in background.") do
+    TimeTap.config[:background] = true
   end
-  
-  opts.on("-p", "--port PORT", "Use specified port for server. (default #{options['port']})") do |value|
+
+  opts.on("-p", "--port PORT", "Use specified port for server. (default #{TimeTap.config['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
+
+  opts.on("-l", "--log-level LEVEL", "Use specified port for server. (default #{TimeTap.config['port']})") do |value|
+    TimeTap.config[:log_level] = value
   end
-  
-  opts.on("--reload", "Reload login launch agent.") do
-    puts 'Reloading...'
-    TimeTap.reload!
+
+  opts.on("-i", "--install", "Sets TimeTap to be launched automatically at login, and boots it.") do
+    TimeTap.install_launcher!
+    TimeTap.install_config!
+    TimeTap.reload_launcher!
+    # TimeTap::reload_launcher! uses `exec` so it never gets here
     exit
   end
 end.parse!
 
-
-unless TimeTap.config[:foreground]
+TimeTap.config[:foreground] = !TimeTap.config[:background]
+if TimeTap.config[:background]
   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.logger = Logger.new($stdout)
+  TimeTap.logger.level = Logger.const_get(TimeTap.config[:log_level].upcase) if TimeTap.config[:log_level]
+  TimeTap.logger.info '[TimeTap] Going foreground...'
   TimeTap.start
 end

data/lib/time_tap.rb

@@ -1,81 +1,123 @@
-#!/usr/bin/env ruby
-# encoding: utf-8
+require 'active_support/core_ext/hash/indifferent_access'
+require 'logger'
 
+module TimeTap
+  @config = {
+    :root => "~",
+    # root is where the logs will be saved
 
-require 'rubygems'
-gem 'activesupport',  '~> 2.3.8'
-gem 'actionpack',     '~> 2.3.8'
-gem 'i18n',           '~> 0.3.5'
-gem 'haml'
-gem 'rb-appscript'
-gem 'sinatra'
+    # code is where all your projects live
+    :code_folders => %w[
+      ~/Code
+      ~/Developer
+      ~/Development
+      ~/src
+      ~/code
+      ~/rails
+      ~/Desktop
+      ~
+    ],
 
+    :nested_project_layers => 1,
+    # see below about nested projects
 
-module TimeTap
+    :port => 1111,
+    # the port on localhost for the web interface
+
+    :ruby => '/usr/bin/ruby',
+    # the ruby you want to use
+
+    :backend         => :file_system,
+    :backend_options => { :file_name => '~/.timetap.history' },
+    :editor          => :text_mate,
+    :log_file        => '~/.timetap.log'
+  }.with_indifferent_access
   attr_accessor :config
-  
+
+
+  @logger = Logger.new($stdout)
+  attr_accessor :logger
+
+
   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
-  
-  
+
+
+
+  # BACKEND
+
+  def backend
+    require 'time_tap/backend'
+    @backend = Backend.load config[:backend], config[:backend_options]
+  end
+
+  def editor
+    require 'time_tap/editor'
+    @backend = Editor.load config[:editor], config[:editor_options]
+  end
+
+
+  # START
+
   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'
-    
-    
-  
+
+    logger.info "[TimeTap] config: #{config.to_yaml}"
     # SIGNAL HANDLING
-  
-    Signal.trap("INT")  {exit}
-    Signal.trap("TERM") {exit}
-  
-  
+
+    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)
+
+    watcher = Watcher.new(editor, backend)
+    watcher.keep_watching
   end
-  
+
+
   # Add a plist for OSX's launchd and have *TimeTap* launched automatically at login.
-  def install!
+  def install_launcher!
+    puts 'Installing launcher...'
+
     load_plist_info!
     ruby        = config[:ruby] || "/usr/bin/ruby"
     include_dir = '-I'+File.expand_path('../../lib', __FILE__)
     launcher    = File.expand_path('../../bin/timetap', __FILE__)
+    working_directory = File.expand_path('../../', __FILE__)
 
     puts "\nCreating launchd plist in\n  #{plist_path}"
 
@@ -88,17 +130,25 @@ module TimeTap
 	<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>-S</string>
+		<string>bundle</string>
+		<string>exec</string>
 		<string>#{launcher}</string>
 		<string>-f</string>
 	</array>
 
+
+  <key>WorkingDirectory</key>
+  <string>#{working_directory}</string>
+  <key>StandardErrorPath</key>
+  <string>/usr/local/var/log/timetap.log</string>
+  <key>StandardOutPath</key>
+  <string>/usr/local/var/log/timetap.log</string>
+
 	<key>OnDemand</key>
 	<false/>
 
@@ -109,20 +159,44 @@ module TimeTap
       PLIST
     end
   end
-  
-  def reload!
+
+  def reload_launcher!
+    puts 'Reloading system launcher...'
+
     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}")
+
+  def load_user_config!
+    require 'yaml'
+    TimeTap.config.merge! YAML.load_file(user_config) if File.exist?(user_config)
+  end
+
+  def user_config
+    @user_config ||= File.expand_path('~/.timetap.config')
+  end
+
+  def install_config!
+    puts 'Checking config...'
+    unless File.exist? user_config
+      require 'fileutils'
+      example_config = File.expand_path('../time_tap/config.yml.example', __FILE__)
+      FileUtils.copy example_config, user_config
+      puts "Added default config to #{user_config}"
     end
-    
+  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