watch_tower 0.0.1.beta5 → 0.0.1.beta6

data/.gitignore

@@ -4,7 +4,11 @@ Gemfile.lock
 pkg/*
 .rbx
 .rvmrc
+tmp
 
 # Tranmuter output
 README.pdf
-README.html
+README.html
+
+# Sass
+.sass-cache

data/Gemfile

@@ -30,6 +30,7 @@ platforms :ruby do
     if RbConfig::CONFIG['target_os'] =~ /linux/i
       gem 'rb-inotify', require: false
       gem 'libnotify', require: false
+      gem 'therubyracer', require: false
     end
   end
 end

data/README.md

@@ -1,82 +1,106 @@
 # Watch Tower [![Build Status](http://travis-ci.org/TechnoGate/watch_tower.png)](http://travis-ci.org/TechnoGate/watch_tower) [![Still Maintained](http://stillmaintained.com/TechnoGate/watch_tower.png)](http://stillmaintained.com/TechnoGate/watch_tower)
 
-[![Click here to lend your support to: Open Source Projects and make a donation at www.pledgie.com !](http://www.pledgie.com/campaigns/16123.png?skin_name=chrome)](http://www.pledgie.com/campaigns/16123)
+[![Click here to lend your support to: Open Source Projects and make a donation at www.pledgie.com!](http://pledgie.com/campaigns/16123.png?skin_name=chrome)](http://www.pledgie.com/campaigns/16123)
 
-WatchTower helps you track the time you spend on each project and on each file
-in the projects.
+WatchTower helps you track how much time you spend on all of your projects, at
+the project, directory, and file level.
 
 # Introduction
 
-Did you ever wonder how much each of your projects really costs? Watch Tower
-comes to the rescue.
+Did you ever want to keep track of how much time you _really_ spend on all of
+your projects? Sure, you can try to remember to keep running estimates of your
+time in the hope that you can aggregate those estimates later into some
+meaningful data. But sometimes you forget, or an error creeps into your
+estimate. And those errors add up. Quickly.
 
-WatchTower runs in the background and monitors your editors (see Supported
-Editors) and records the time you spend on each file and thus on the project
-in total. Using a simple but powerful web interface, you can view details and
-statistics about each project and each file.
+You can try some tracking software that depends on you to start and stop
+timers. But what happens if you forget to start or stop one of those timers?
+
+What you need is a passive system that will take care of all of this for you,
+so you can focus on the actual work, which is where WatchTower comes into
+play.
+
+WatchTower runs in the background and keeps track of the time spent editing
+each file with one of the supported editors (listed below). Since WatchTower
+keeps track of the time spent on each file, and it knows which project each
+file belongs to, you can view details and statistics on each project, right
+down to the file level.
 
 # Features
 
-- Track editors (see Supported Editors) and record all files tracked under
-  git or placed under __code_path__ defined in the config file.
-- Display all projects on the home page that has been worked on the current
-  month, the date range can be changed using the date picker on the home page
-- For each project, a detailed overview of each file with the elapsed time
-  within the selected date range
+- Tracks the supported editors (listed below) and records the time spent on
+  all files as specified via the customized configuration file (Git and
+  __code_path__ are supported).
+
+- A WatchTower Home Page where you can see how much time you've spent on all
+  watched projects, as well as a total summary. The default display includes
+  all projects worked on during the current month, but the page includes a
+  date picker for easy selection. You can select a project to view the
+  project's Detail Page.
+
+  ![Example: WatchTower Home Page](http://f.cl.ly/items/1C0W1W0V2L3s3k2o313f/home_page.png)
+
+- A Project Detail Page that displays a detailed report of the time spent on
+  the project, each directory within the project, and each file. The default
+  display includes all files worked on during the current month, but the page
+  includes a date picker for easy selection.
+
+  ![Example: Project Detail Page](http://f.cl.ly/items/3T263A350w261b0b2U1x/project_page.png)
 
 # Supported Editors
 
 - TextMate
 - Xcode
+- ViM (gVim and MacVim are also supported)
 
 # Supported Operating Systems
 
 - Mac OS X
+- Linux
 
-# Installation
+# Getting Started
 
-The installation has been made as simple as possible, here's the steps required:
+1. Install the WatchTower gem:
 
-```bash
-$ gem install watch_tower --pre
-$ watchtower install
-$ watchtower load_bootloader
-```
+    ```bash
+    $ gem install watch_tower --pre
+    ```
+2. Followed by:
+
+    ```bash
+    $ watchtower install
+    $ watchtower load_bootloader
+    ```
 
-This creates a configuration file which you __should__ review before invoking
-__WatchTower__, located at __~/.watch_tower/config.yml__ the configuration file
-is self explanatory.
+3. __Review the self-explanatory configuration file__ located at
+__~/.watch_tower/config.yml__ and make any changes necessary.
 
 # Update
 
-It is important to run
+Run 
 
 ```bash
 $ watchtower install_bootloader
 $ watchtower reload_bootloader
 ```
 
-because the path to watchtower binary file is hardcoded in the boot loader.
+to update the path to the WatchTower binary in the boot loader.
 
 # Usage
 
-The installation process should create a launcher on login which starts
-__WatchTower__ you can open the web interface by going to
-http://localhost:9282 or using the command
+The installation process creates a launcher on login that starts
+__WatchTower__. You can view your WatchTower Home Page via the web interface
+by going to http://localhost:9282, or from the command line:
 
 ```bash
 $ watchtower open
 ```
 
-# Screenshots
-
-## Home page
+# Commands
 
-[![Home page](http://cloud.github.com/downloads/TechnoGate/watch_tower/home_page.png)](http://cloud.github.com/downloads/TechnoGate/watch_tower/home_page.png)
-
-## Project page
-
-[![Project page](http://cloud.github.com/downloads/TechnoGate/watch_tower/project_page.png)](http://cloud.github.com/downloads/TechnoGate/watch_tower/project_page.png)
+For more information on available commands, you can take a look at the
+[WatchTower Command Line wiki
+page](https://github.com/TechnoGate/watch_tower/wiki/WatchTower-Command-Line).
 
 # Contributing
 
@@ -95,10 +119,12 @@ in mind for the project
 
 # Credits
 
-This projects is heavily inspired by
+This project is heavily inspired by
 [timetap](https://github.com/elia/timetap) created by [Elia
-Schito](https://github.com/elia), it also uses a number of open source
-projects including but not limited to:
+Schito](https://github.com/elia).
+
+It also uses a number of open source
+projects including, but not limited to:
 
 - [rb-appscript](http://appscript.sourceforge.net/)
 - [activesupport](https://github.com/rails/rails)
@@ -124,6 +150,8 @@ projects including but not limited to:
 - [factory_girl](https://github.com/thoughtbot/factory_girl)
 - [timecop](https://github.com/jtrupiano/timecop)
 - [pry](https://github.com/pry/pry)
+- [systemu](https://github.com/ahoward/systemu)
+- [cronedit](http://cronedit.rubyforge.org)
 
 # License
 
@@ -148,4 +176,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/watch_tower/appscript.rb

@@ -6,75 +6,12 @@ rescue LoadError
   # Define a part of the Appscript gem so WatchTower is fully operational
   module ::Appscript
     CommandError = Class.new(Exception)
-
-    class Application
-
-      MOCK_METHODS = [:name, :version, :unix_id, :by_pid]
-
-      def is_running?
-        false
-      end
-
-      def get
-        "Not available"
-      end
-
-      def processes
-        Process.new(self)
-      end
-
-      MOCK_METHODS.each do |method|
-        define_method method do |*args|
-          self
-        end
-      end
-    end
-
-    class Process
-      def initialize(klass)
-        @klass = klass
-      end
-
-      def [](*args)
-        [@klass]
-      end
-    end
-
     def app(*args)
-      Application.new
-    end
-
-    def its
-      self
+      raise ::WatchTower::AppscriptNotLoadedError
     end
-
-    def name
-      self
-    end
-
-    def eq(*args)
-      self
-    end
-
-    def Appscript.app(*args)
-      Application.new
-    end
-
-    def Appscript.its
-      self
-    end
-
-    def Appscript.name
-      self
-    end
-
-    def Appscript.eq(*args)
-      self
-    end
-
   end
 
   module ::FindApp
     ApplicationNotFoundError = Class.new(Exception)
   end
-end
+end

data/lib/watch_tower/cli/install.rb

@@ -61,22 +61,6 @@ module WatchTower
             end
 
             protected
-              # Taken from hub
-              # https://github.com/defunkt/hub/blob/master/lib/hub/context.rb#L186
-              # Cross-platform way of finding an executable in the $PATH.
-              #
-              # which('ruby') #=> /usr/bin/ruby
-              def which(cmd)
-                exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-                ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-                  exts.each { |ext|
-                    exe = "\#{path}/\#{cmd}\#{ext}"
-                    return exe if File.executable? exe
-                  }
-                end
-                return nil
-              end
-
               # Install the configuration file
               def install_config_file
                 self.class.source_root(TEMPLATE_PATH)
@@ -89,6 +73,8 @@ module WatchTower
                 case RbConfig::CONFIG['target_os']
                 when /darwin/
                   install_bootloader_on_mac
+                when /linux/
+                  install_bootloader_on_linux
                 else
                   puts bootloader_not_supported_on_current_os
                 end
@@ -98,8 +84,6 @@ module WatchTower
               def install_bootloader_on_mac
                 self.class.source_root(TEMPLATE_PATH)
                 create_file bootloader_path_on_mac, force: options[:force] do
-                  ruby_binary = which('ruby')
-                  watch_tower_binary = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'bin', 'watchtower'))
                   template = File.expand_path(find_in_source_paths('watchtower.plist.erb'))
                   ERB.new(File.read(template)).result(binding)
                 end
@@ -107,6 +91,50 @@ module WatchTower
                 puts "\nCreated. Now run:\n  watchtower load_bootloader\n\n"
               end
 
+              # Install bootloader on linux
+              def install_bootloader_on_linux
+                require 'cronedit'
+                # Remove any old entries
+                uninstall_bootloader_on_linux
+                # Define the crontab command
+                crontab_command = "\#{ruby_binary} \#{watch_tower_binary} start --bootloader"
+                # Create a crontab instance
+                crontab = CronEdit::Crontab.new
+                # Add the command
+                crontab.add Time.now.strftime('%s'), { minute: "@reboot", hour: '', day: '', month: '', weekday: '', command: crontab_command }
+                # Commit changes
+                crontab.commit
+              end
+
+              # Uninstall bootloader on linux
+              def uninstall_bootloader_on_linux
+                require 'cronedit'
+                # Create a crontab instance
+                crontab = CronEdit::Crontab.new
+                # Iterate over crontab entries and remove any command having watchtower start
+                crontab.list.each_pair do |k, c|
+                  if c =~ /watchtower start/
+                    crontab.remove(k)
+                  end
+                end
+                # Commit changes
+                crontab.commit
+              end
+
+              # Returns the absolute path to the ruby binary
+              #
+              # @return [String] The path to ruby
+              def ruby_binary
+                WatchTower.which('ruby')
+              end
+
+              # Returns the absolute path to the watchtower binary
+              #
+              # @return [String] The path to watch tower binary
+              def watch_tower_binary
+                File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'bin', 'watchtower'))
+              end
+
               # Load bootloader
               def load_bootloader_on_os
                 require 'rbconfig'
@@ -139,7 +167,6 @@ module WatchTower
                   puts bootloader_not_supported_on_current_os
                 end
               end
-
               # Load the bootloader
               def load_bootloader_on_mac
                 system "launchctl load \#{bootloader_path_on_mac}"
@@ -178,4 +205,4 @@ MSG
       end
     end
   end
-end
+end

data/lib/watch_tower/editor/base_ps.rb

@@ -23,9 +23,17 @@ module WatchTower
             def version
               raise NotImplementedError, "Please define this function in your class."
             end
+
+            # The editor's name for the log
+            # Child classes can overwrite this method
+            #
+            # @return [String]
+            def to_s
+              "\#{self.class.to_s.split('::').last} Editor"
+            end
           END
         end
       end
     end
   end
-end
+end

data/lib/watch_tower/editor/extensions/watchtower.vim

@@ -0,0 +1,20 @@
+" This function prints the list of open files
+" Usage:
+" vim --servername "<server>" --remote-expr "watchtower#ls()"
+
+" Make sure the function is loaded only once
+if exists("loaded_watchtower_ls_function")
+  finish
+endif
+let loaded_watchtower_ls_function = 1
+
+" Provided by Marcin Szamotulski <mszamot@gmail.com>
+" Modified by Wael Nasreddine <wael.nasreddine@gmail.com>
+" http://groups.google.com/group/vim_use/msg/3dfb796c366b2e50
+function! watchtower#ls()
+  let list=[]
+  for i in range(1, bufnr('$'))
+    call add(list, fnamemodify(bufname(i), ':p'))
+  endfor
+  return list
+endfunction

data/lib/watch_tower/editor/textmate.rb

@@ -11,9 +11,15 @@ module WatchTower
         # returns [::Appscript::Application | nil]
         def editor
           app 'Textmate'
+        rescue AppscriptNotLoadedError
+          # This is expected if appscriot not loaded, on linux for example
         rescue ::FindApp::ApplicationNotFoundError
-          LOG.debug "#{__FILE__}:#{__LINE__ - 2}: Textmate application can't be found, maybe not installed?"
+          LOG.debug "#{__FILE__}:#{__LINE__ - 4}: Textmate application can't be found, maybe not installed?"
+          nil
+        rescue ::Appscript::CommandError => e
+          LOG.error "#{__FILE__}:#{__LINE__ - 7}: Command error #{e}"
+          nil
         end
     end
   end
-end
+end

data/lib/watch_tower/editor/vim.rb

@@ -0,0 +1,113 @@
+# -*- encoding: utf-8 -*-
+
+# Somehow on my laptop, the systemu command works well for vim but does not
+# work at all for gvim, in fact calling systemu just returns an empty stdout.
+# TODO: Figure out if it's a problem on my box or systemu's bug
+
+# require 'systemu'
+class Object
+  # This method returns the output of a system command
+  # much like the original systemu method
+  #
+  # @param [String] cmd: The command to run.
+  # @return [Array] formed of status, stdout, stderr
+  def systemu(cmd)
+    [0, `#{cmd}`, '']
+  end
+end
+
+module WatchTower
+  module Editor
+    class Vim
+      include BasePs
+
+      VIM_EXTENSION_PATH = File.join(EDITOR_EXTENSIONS_PATH, 'watchtower.vim')
+
+      def initialize
+        # Get the list of supported vims
+        supported_vims
+      end
+
+      # Return the name of the Editor
+      #
+      # @return [String] The editor's name
+      def name
+        "ViM"
+      end
+
+      # Return the version of the editor
+      #
+      # @return [String] The editor's version
+      def version
+        if is_running?
+          status, stdout, stderr = systemu "#{editor} --version"
+
+          stdout.scan(/^VIM - Vi IMproved (\d+\.\d+).*/).first.first
+        end
+      end
+
+      # Is it running ?
+      #
+      # @return [Boolean] Is ViM running ?
+      def is_running?
+        servers.any?
+      end
+
+      # Return the open documents of all vim servers
+      #
+      # @return [Array] Absolute paths to all open documents
+      def current_paths
+        if is_running?
+          # Make sure All servers has loaded our function
+          send_extensions_to_editor
+          # Init documents
+          documents = []
+          servers.each do |server|
+            status, stdout, stderr = systemu "#{editor} --servername #{server} --remote-expr 'watchtower#ls()'"
+
+            documents += stdout.split("\n")
+          end
+
+          documents.uniq
+        end
+      end
+
+      protected
+      # Return a list of supported vim commands
+      #
+      # @return [Array] A list of supported vim commands.
+      def supported_vims
+        @vims ||= ['mvim', 'gvim', 'vim'].collect do |vim|
+          # Get the absolute path of the command
+          vim_path = WatchTower.which(vim)
+          # Print the help of the command
+          status, stdout, stderr = systemu "#{vim_path} --help" if vim_path
+          # This command is compatible if it exists and if it respond to --remote
+          vim_path && stdout =~ %r(--remote) ? vim_path : nil
+        end.reject { |vim| vim.nil? }
+      end
+
+      # Return the editor
+      #
+      # @return [String|nil] The editor command
+      def editor
+        @vims.any? && @vims.first
+      end
+
+      # Returns the running servers
+      #
+      # @return [Array] Name of running ViM Servers
+      def servers
+        status, stdout, stderr = systemu "#{editor} --serverlist"
+        stdout.split("\n")
+      end
+
+      # Send WatchTower extensions to vim
+      def send_extensions_to_editor
+        servers.each do |server|
+          systemu "#{editor} --servername #{server} --remote-send ':source #{VIM_EXTENSION_PATH}<CR>'"
+        end
+      end
+    end
+  end
+end

data/lib/watch_tower/editor/xcode.rb

@@ -15,10 +15,15 @@ module WatchTower
           # https://github.com/apalancat/timetap/blob/editors/lib/time_tap/editors.rb#L25
           pid = app('System Events').processes[its.name.eq('Xcode')].first.unix_id.get
           app.by_pid(pid)
+        rescue AppscriptNotLoadedError
+          # This is expected if appscriot not loaded, on linux for example
         rescue ::FindApp::ApplicationNotFoundError
+          LOG.debug "#{__FILE__}:#{__LINE__ - 5}: Xcode application can't be found, maybe not installed?"
+          nil
         rescue ::Appscript::CommandError
+          LOG.debug "#{__FILE__}:#{__LINE__ - 7}: Xcode is not running."
           nil
         end
     end
   end
-end
+end

data/lib/watch_tower/editor.rb

@@ -8,6 +8,7 @@ module WatchTower
     autoload :BasePs
     autoload :Textmate
     autoload :Xcode
+    autoload :Vim
 
     def self.editors
       Editor.constants.                                     # Collect the defined constants
@@ -16,4 +17,4 @@ module WatchTower
         select { |c| c.class == Class }                     # Keep only classes
     end
   end
-end
+end

data/lib/watch_tower/errors.rb

@@ -12,6 +12,9 @@ module WatchTower
   PathError = Class.new ProjectError
   PathNotUnderCodePath = Class.new PathError
 
+  # Appscript errors
+  AppscriptNotLoadedError = Class.new WatchTowerError
+
   # Exception raised by the Editor module
   EditorError = Class.new WatchTowerError
   TextmateError = Class.new EditorError
@@ -24,4 +27,4 @@ module WatchTower
 
   # Exceptions raised by the Eye module
   EyeError = Class.new WatchTowerError
-end
+end

data/lib/watch_tower/eye.rb

@@ -30,8 +30,10 @@ module WatchTower
             # Iterate over the files to fill the database
             files_paths.each do |file_path|
               begin
-                next unless file_path && File.exists?(file_path)
                 next if file_path =~ IGNORED_PATHS
+                next unless file_path
+                next unless File.exists?(file_path)
+                next unless File.file?(file_path)
                 # Get the file_hash of the file
                 file_hash = Digest::SHA1.file(file_path).hexdigest
                 # Create a project from the file_path
@@ -91,4 +93,4 @@ module WatchTower
       start(options)
     end
   end
-end
+end

data/lib/watch_tower/version.rb

@@ -4,7 +4,7 @@ module WatchTower
   MAJOR = 0
   MINOR = 0
   TINY = 1
-  PRE = 'beta5'
+  PRE = 'beta6'
 
   def self.version
     # Init the version