watch_tower 0.0.0.1 → 0.0.1.beta1

data/.todo

@@ -12,6 +12,9 @@
     <note priority="medium" time="1317889118" done="1317980852">
         Add a ci/travis.rb script which runs the tests under Travis-CI, needed because the config file added in todo number 3 won't exist and the current setup (sqlite) does not work with JRuby
     </note>
+    <note priority="veryhigh" time="1319041505">
+        The elapsed time of the project should change when the duration changes
+    </note>
     <note priority="high" time="1318256016">
         Figure out how to load assets from gems and remove the bundled jQuery files.
     </note>

data/.travis.yml

@@ -1,4 +1,8 @@
 script: 'ci/travis.rb'
+branches:
+  only:
+    - master
+    - develop
 rvm:
   - 1.9.2
   - 1.9.3

data/Gemfile

@@ -36,8 +36,4 @@ end
 
 platforms :mri do
   gem 'pg'
-
-  if RbConfig::CONFIG['target_os'] =~ /darwin/i
-    gem 'rb-appscript', '~>0.6.1'
-  end
 end

data/README.md

@@ -1,6 +1,6 @@
 # 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)
 
-<a href='http://www.pledgie.com/campaigns/16123'><img alt='Click here to lend your support to: Open Source Projects and make a donation at www.pledgie.com !' src='http://www.pledgie.com/campaigns/16123.png?skin_name=chrome' border='0' /></a>
+[![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)
 
 WatchTower helps you track the time you spend on each project.
 
@@ -35,4 +35,50 @@ http://localhost:9282 or using the command
 
 ```bash
 $ watchtower open
-```
+```
+
+# Screenshots
+
+## Home page
+
+![Home page](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)
+
+# Contributing
+
+Please feel free to fork and send pull requests, but please follow the
+following guidelines:
+
+- Prefix each commit message with the filename or the module followed by a
+  colon and a space, for example 'README: fix a typo' or 'Server/Project: Fix
+  a typo'.
+- Include tests.
+- Do not change the version, We will take care of that.
+
+# License
+
+## This code is free to use under the terms of the MIT license.
+
+Copyright (c) 2011 TechnoGate &lt;support@technogate.fr&gt;
+
+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/TODO

@@ -1,3 +1,6 @@
+- The elapsed time of the project should change when the duration changes
+  (added Wed Oct 19 18:25:05 2011, incomplete, priority veryhigh)
+
 - Figure out how to load assets from gems and remove the bundled jQuery files.
   (added Mon Oct 10 16:13:36 2011, incomplete, priority high)
 

data/ci/travis.rb

@@ -1,11 +1,14 @@
 #!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
 # This file has been taken from rails
 # https://github.com/rails/rails/blob/master/ci/travis.rb
 require 'fileutils'
 include FileUtils
 
 commands = [
+  'mysql -e "drop database if exists watch_tower_test;"',
   'mysql -e "create database watch_tower_test;"',
+  'psql  -c "drop database if exists watch_tower_test;" -U postgres',
   'psql  -c "create database watch_tower_test;" -U postgres'
 ]
 
@@ -97,6 +100,6 @@ if failures.empty?
 else
   puts
   puts "WatchTower build FAILED"
-  puts "Failed adapters: #{failures.join(', ')}"
+  puts "Failed adapters: #{failures.keys.join(', ')}"
   exit(false)
 end

data/lib/watch_tower/appscript.rb

@@ -1,22 +1,80 @@
+# -*- encoding: utf-8 -*-
+
 begin
-  require 'rubygems'
   require 'appscript'
 rescue LoadError
-  require 'rbconfig'
-  if RbConfig::CONFIG['target_os'] =~ /darwin/i
-    STDERR.puts "Please install 'appscript' to use this gem with Textmate"
-    STDERR.puts "gem install appscript"
-  end
-  # Define a simple class so the gem works even if Appscript is not installed
+  # 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
+    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

data/lib/watch_tower/cli/install.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module WatchTower
   module CLI
     module Install
@@ -25,6 +27,22 @@ 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)
@@ -42,7 +60,7 @@ module WatchTower
 WatchTower bootloader is not supported on your OS, you'd have to run it manually
 for the time being. Support for many editors and many OSes is planned for the
 future, if you would like to help, or drop in an issue please don't hesitate to
-do so on the Github page: https://github.com/TechnoGate/watch_tower
+do so on the project's Github page: https://github.com/TechnoGate/watch_tower
 MSG
                 end
               end
@@ -50,8 +68,14 @@ MSG
               # Install bootloader on Mac OS X
               def install_bootloader_on_mac
                 self.class.source_root(TEMPLATE_PATH)
-                copy_file 'watchtower.plist', File.join(ENV['HOME'], 'Library',
-                  'LaunchAgents', 'fr.technogate.WatchTower.plist')
+                # copy_file 'watchtower.plist', File.join(ENV['HOME'], 'Library',
+                #   'LaunchAgents', 'fr.technogate.WatchTower.plist')
+                create_file File.join(ENV['HOME'], 'Library', 'LaunchAgents', 'fr.technogate.WatchTower.plist') 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
 
                 puts "\nCreated. Now run:\n  launchctl load ~/Library/LaunchAgents/fr.technogate.WatchTower.plist\n\n"
               end

data/lib/watch_tower/cli/open.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module WatchTower
   module CLI
     module Open

data/lib/watch_tower/cli/start.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module WatchTower
   module CLI
     module Start
@@ -40,7 +42,7 @@ module WatchTower
               desc: "Set the server's port."
             def start
               if Config[:enabled] &&
-                (!options[:bootloader] || (options(:bootloader) && Config[:launch_on_boot]))
+                (!options[:bootloader] || (options[:bootloader] && Config[:launch_on_boot]))
                 LOG.info "Starting WatchTower."
                 start!
               else

data/lib/watch_tower/cli.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'thor'
 
 # Load all modules

data/lib/watch_tower/config.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'active_support/hash_with_indifferent_access'
 
 module WatchTower

data/lib/watch_tower/core_ext.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'active_support/core_ext'
 require 'active_support/dependencies/autoload'
 

data/lib/watch_tower/editor/base_appscript.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'watch_tower/appscript'
 
 module WatchTower
@@ -13,16 +15,41 @@ module WatchTower
             # Include AppScript
             include ::Appscript
 
+            # Is the editor running ?
+            #
+            # @return [Boolean]
             def is_running?
               editor.is_running? if editor
             end
 
+            # Returns the name of the editor
+            #
+            # Child class should implement this method
+            def name
+              editor.try(:name).try(:get)
+            end
+
+            # Returns the version of the editor
+            #
+            # Child class should implement this method
+            def version
+              editor.try(:version).try(:get)
+            end
+
+            # Return the path of the document being edited
+            # Child classes can override this method if the behaviour is different
+            #
+            # @return [String] path to the document currently being edited
             def current_path
               current_paths.try(:first)
             end
 
+            # Return the pathes of the documents being edited
+            # Child classes can override this method if the behaviour is different
+            #
+            # @return [Array] pathes to the documents currently being edited
             def current_paths
-              if is_running?
+              if is_running? && editor.respond_to?(:document)
                 editor.document.get.collect(&:path).collect(&:get)
               end
             end

data/lib/watch_tower/editor/base_ps.rb

@@ -1,6 +1,31 @@
+# -*- encoding: utf-8 -*-
+
 module WatchTower
   module Editor
     module BasePs
+      def self.included(base)
+        base.send :include, InstanceMethods
+      end
+
+      module InstanceMethods
+        def self.included(base)
+          base.class_eval <<-END, __FILE__, __LINE__ + 1
+            # Returns the name of the editor
+            #
+            # Child class should implement this method
+            def name
+              raise NotImplementedError, "Please define this function in your class."
+            end
+
+            # Returns the version of the editor
+            #
+            # Child class should implement this method
+            def version
+              raise NotImplementedError, "Please define this function in your class."
+            end
+          END
+        end
+      end
     end
   end
 end

data/lib/watch_tower/editor/textmate.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module WatchTower
   module Editor
     class Textmate

data/lib/watch_tower/editor/xcode.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module WatchTower
   module Editor
     class Xcode

data/lib/watch_tower/editor.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module WatchTower
   module Editor
     extend ::ActiveSupport::Autoload

data/lib/watch_tower/errors.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module WatchTower
   # Global Error
   WatchTowerError = Class.new Exception

data/lib/watch_tower/eye.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'digest/sha1'
 
 module WatchTower
@@ -22,8 +24,10 @@ module WatchTower
             LOG.debug("#{__FILE__}:#{__LINE__}: #{editor.to_s} is running")
             # Get the currently being edited file from the editor
             files_paths = editor.current_paths
+            # Iterate over the files to fill the database
             files_paths.each do |file_path|
               begin
+                next unless file_path && File.exists?(file_path)
                 # Get the file_hash of the file
                 file_hash = Digest::SHA1.file(file_path).hexdigest
                 # Create a project from the file_path
@@ -44,7 +48,10 @@ module WatchTower
                 file_model = project_model.files.find_or_create_by_path(file_path)
                 begin
                   # Create a time entry
-                  file_model.time_entries.create!(mtime: File.stat(file_path).mtime, file_hash: file_hash)
+                  file_model.time_entries.create! mtime: File.stat(file_path).mtime,
+                    file_hash: file_hash,
+                    editor_name: editor.name,
+                    editor_version: editor.version
                 rescue ActiveRecord::RecordInvalid => e
                   # This should happen if the mtime is already present
                 end
@@ -59,7 +66,7 @@ module WatchTower
           end
         end
 
-        # If $stop global is set, please stop, otherwise sleep for 30 seconds.
+        # If $stop global is set, please stop, otherwise sleep for 10 seconds.
         if $close_eye
           LOG.debug("#{__FILE__}:#{__LINE__}: Closing eye has been requested, end the loop")
           break
@@ -73,6 +80,10 @@ module WatchTower
     #
     # @param [Hash] options
     def start!(options = {})
+      # Signal handling
+      Signal.trap("INT")  { $close_eye = true }
+      Signal.trap("TERM") { $close_eye = true }
+
       start(options)
     end
   end

data/lib/watch_tower/file_tree.rb

@@ -0,0 +1,78 @@
+# -*- encoding: utf-8 -*-
+
+module WatchTower
+  # This class is used by the server to provided a FileTree representation
+  # of the files and their elapsed time
+  class FileTree
+
+    attr_reader :base_path, :files, :nested_tree, :elapsed_time
+
+    # Initialize
+    #
+    # @param [String] base_path: The base path of all files, usually the project's path
+    # @param [Array] files: The files and their elapsed time
+    #                The Array elements should be Hashes with two required keys
+    #                :path and :elapsed_time
+    def initialize(base_path, files)
+      # Init with args
+      @base_path = base_path
+      @all_files = remove_base_path_from_files(@base_path, files)
+      # Init with defaults
+      @elapsed_time = 0
+      @files = Array.new
+      @nested_tree = Hash.new
+      # Process the tree
+      process
+    end
+
+    protected
+      # Process the Tree
+      def process
+        # Parse files
+        parse_files
+        # Parse folders
+        parse_folders
+      end
+
+      # Removes the base_path from the files
+      def remove_base_path_from_files(base_path, files)
+        files.collect do |f|
+          f[:path] = f[:path].gsub(%r(#{base_path}#{File::SEPARATOR}), '')
+          f
+        end
+      end
+
+      # Parses only files under the current base_path
+      def parse_files
+        return if @files.any?
+
+        @all_files.each do |f|
+          unless f[:path] =~ %r(#{File::SEPARATOR})
+            @elapsed_time += f[:elapsed_time]
+            @files << f
+          end
+        end
+      end
+
+      # Parses only folders under the current base_path
+      def parse_folders
+        return if @nested_tree.any?
+
+        @all_files.each do |f|
+          if f[:path] =~ %r(#{File::SEPARATOR})
+            # Get the base_path
+            base_path = f[:path].split(File::SEPARATOR).first
+            # Do not continue if we already parsed this path
+            next if @nested_tree.has_key?(base_path)
+            # Get the nested files
+            nested_files = remove_base_path_from_files base_path,
+              @all_files.select { |f| f[:path] =~ %r(^#{base_path}#{File::SEPARATOR}) }
+            # Create a tree
+            @nested_tree[base_path] = self.class.new("#{@base_path}#{File::SEPARATOR}#{base_path}", nested_files)
+            # Add the elapsed_time of the tree
+            @elapsed_time += @nested_tree[base_path].elapsed_time
+          end
+        end
+      end
+  end
+end

data/lib/watch_tower/project/any_based.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module WatchTower
   class Project
     module AnyBased

data/lib/watch_tower/project/git_based.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'git'
 
 module WatchTower

data/lib/watch_tower/project/init.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module WatchTower
   class Project
     module Init

data/lib/watch_tower/project/path_based.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module WatchTower
   class Project
     # The module contains Path specific project methods, methods like name, path

data/lib/watch_tower/project.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'watch_tower/project/any_based'
 require 'watch_tower/project/init'
 

data/lib/watch_tower/server/app.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 # Sinatra
 require 'sinatra'
 
@@ -7,9 +9,7 @@ module WatchTower
       # Helper
       include Helpers::ImprovedPartials
       include Helpers::Asset
-
-      # Include Decorator
-      include Decorator
+      include Helpers::Presenters
 
       # Configurations
       include Configurations::Asset
@@ -18,19 +18,49 @@ module WatchTower
       paths :root => '/'
       paths :project => '/project/:id'
 
+      # Enable sessions
+      enable :sessions
+
+      # Before filter
+      before do
+        # Parse the from/to date from params and add it to the session
+        if params[:from_date] && params[:to_date]
+          if params[:from_date].present? && params[:to_date].present?
+            session[:date_filtering] = {
+              from_date: params[:from_date],
+              to_date: params[:to_date]
+            }
+          else
+            session[:date_filtering] = nil
+          end
+        end
+
+        # Make sure we have a default date filtering
+        unless session.try(:[], :date_filtering).try(:[], :from_date) && session.try(:[], :date_filtering).try(:[], :to_date)
+          session[:date_filtering] = {
+            from_date: Time.now.to_date.beginning_of_month.strftime('%m/%d/%Y'),
+            to_date: Time.now.to_date.strftime('%m/%d/%Y')
+          }
+        end
+      end
+
       # The index action
       get :root do
         @title = "Projects"
-        @projects = ProjectDecorator.decorate(Project.worked_on)
+        @durations = Duration.date_range(session[:date_filtering][:from_date], session[:date_filtering][:to_date])
+        @projects = @durations.collect(&:file).collect(&:project).uniq
 
-        haml :index
+        haml :index, layout: (request.xhr? ? false : :layout)
       end
 
+      # The project action
       get :project do
-        @project = ProjectDecorator.find(params[:id])
+        @project = Project.find(params[:id])
         @title = "Project - #{@project.name.camelcase}"
+        @durations = @project.durations.date_range(session[:date_filtering][:from_date], session[:date_filtering][:to_date])
+        @files = @durations.collect(&:file).uniq
 
-        haml :project
+        haml :project, layout: (request.xhr? ? false : :layout)
       end
     end
   end

data/lib/watch_tower/server/assets/javascripts/application.js

@@ -1,3 +1,7 @@
 //= require jquery
 //= require jquery_ujs
+//= require jquery-ui
+//= require jquery-datepick
+//= require jquery-datepick-ext
+//= require jquery-datepick-validation
 //= require_tree .