watch_tower 0.0.0.1

data/lib/watch_tower/eye.rb

@@ -0,0 +1,79 @@
+require 'digest/sha1'
+
+module WatchTower
+  module Eye
+    extend self
+
+    # Start the watch loop
+    #
+    # @param [Hash] options
+    # @raise [EyeError]
+    def start(options = {})
+      LOG.debug("#{__FILE__}:#{__LINE__}: The Eye loop has just started")
+      loop do
+        # Try getting the mtime of the document opened by each editor in the
+        # editors list.
+        Editor.editors.each do |editor|
+          # Create an instance of the editor
+          # TODO: Should be used as a class instead
+          editor = editor.new
+          # Check if the editor is running
+          if editor.is_running?
+            LOG.debug("#{__FILE__}:#{__LINE__}: #{editor.to_s} is running")
+            # Get the currently being edited file from the editor
+            files_paths = editor.current_paths
+            files_paths.each do |file_path|
+              begin
+                # Get the file_hash of the file
+                file_hash = Digest::SHA1.file(file_path).hexdigest
+                # Create a project from the file_path
+                project = Project.new_from_path(file_path)
+              rescue PathNotUnderCodePath
+                LOG.debug("#{__FILE__}:#{__LINE__ - 2}: The file '#{file_path}' is not located under '#{Config[:code_path]}', it has been ignored")
+                next
+              rescue FileNotFound
+                LOG.debug "#{__FILE__}:#{__LINE__ - 5}: The file '#{file_path}' does not exist, it has been ignored"
+                next
+              end
+
+              begin
+                # Create (or fetch) a project
+                project_model = Server::Project.find_or_create_by_name_and_path(project.name, project.path)
+
+                # Create (or fetch) a file
+                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)
+                rescue ActiveRecord::RecordInvalid => e
+                  # This should happen if the mtime is already present
+                end
+              rescue ActiveRecord::RecordInvalid => e
+                # This should not happen
+                LOG.fatal("#{__FILE__}:#{__LINE__}: #{e}")
+                $close_eye = true
+              end
+            end
+          else
+            LOG.debug("#{__FILE__}:#{__LINE__}: #{editor.to_s} is not running")
+          end
+        end
+
+        # If $stop global is set, please stop, otherwise sleep for 30 seconds.
+        if $close_eye
+          LOG.debug("#{__FILE__}:#{__LINE__}: Closing eye has been requested, end the loop")
+          break
+        else
+          sleep 10
+        end
+      end
+    end
+
+    # Start the Eye, a method invoked from the Watch Tower command line interface
+    #
+    # @param [Hash] options
+    def start!(options = {})
+      start(options)
+    end
+  end
+end

data/lib/watch_tower/project.rb

@@ -0,0 +1,14 @@
+require 'watch_tower/project/any_based'
+require 'watch_tower/project/init'
+
+module WatchTower
+  class Project
+    extend ::ActiveSupport::Autoload
+
+    autoload :GitBased
+    autoload :PathBased
+
+    include AnyBased
+    include Init
+  end
+end

data/lib/watch_tower/project/any_based.rb

@@ -0,0 +1,22 @@
+module WatchTower
+  class Project
+    module AnyBased
+
+      def self.included(base)
+        base.send :include, InstanceMethods
+        base.extend ClassMethods
+      end
+
+      module InstanceMethods
+        attr_reader :name, :path
+      end
+
+      module ClassMethods
+        protected
+          def expand_path(path)
+            File.expand_path(path)
+          end
+      end
+    end
+  end
+end

data/lib/watch_tower/project/git_based.rb

@@ -0,0 +1,86 @@
+require 'git'
+
+module WatchTower
+  class Project
+    module GitBased
+      extend self
+      include AnyBased
+
+      # Cache for working_directory by path
+      # The key is the path to a file, the value is the working directory of
+      # this path
+      @@working_cache = Hash.new
+
+      # Cache for project_name by path
+      # The key is the path to a file, the value is the project's name
+      @@project_name_cache = Hash.new
+
+      # Cache for project git path
+      # The key is the path to a file, the value is the project's parts
+      @@project_git_folder_path = Hash.new
+
+      # Check if the path is under Git
+      #
+      # @param path The path we should check if it's under Git control
+      # @param [Hash] options A hash of options
+      # @return boolean
+      def active_for_path?(path, options = {})
+        path = expand_path path
+        project_git_folder_path(path).present?
+      end
+
+      # Return the working directory (the project's path if you will) from a path
+      # to any file inside the project
+      #
+      # @param path The path to look the project path from
+      # @param [Hash] options A hash of options
+      # @return [String] the project's folder
+      def working_directory(path, options = {})
+        path = expand_path path
+        return @@working_cache[path] if @@working_cache.key?(path)
+
+        @@working_cache[path] = File.dirname(project_git_folder_path(path))
+        @@working_cache[path]
+      end
+
+      # Return the project's name from a path to any file inside the project
+      #
+      # @param path The path to look the project path from
+      # @param [Hash] options A hash of options
+      # @return [String] the project's name
+      def project_name(path, options = {})
+        path = expand_path path
+        return @@project_name_cache[path] if @@project_name_cache.key?(path)
+
+        @@project_name_cache[path] = File.basename working_directory(path, options)
+        @@project_name_cache[path]
+      end
+
+      def head(path)
+        log(path)
+      end
+
+      def log(path)
+        g = ::Git.open path
+        g.log.first
+      end
+
+      protected
+        def project_git_folder_path(path)
+          return @@project_git_folder_path[path] if @@project_git_folder_path.key?(path)
+
+          # Define the start
+          n = 0
+          # Define the maximum search folder
+          max_n = path.split('/').size
+
+          until File.exists?(File.expand_path File.join(path, (%w{..} * n).flatten, '.git')) || n > max_n
+            n = n + 1
+          end
+
+          @@project_git_folder_path[path] = n <= max_n ? File.expand_path(File.join(path, (%w{..} * n).flatten, '.git')) : nil
+          @@project_git_folder_path[path]
+        end
+    end
+  end
+end

data/lib/watch_tower/project/init.rb

@@ -0,0 +1,38 @@
+module WatchTower
+  class Project
+    module Init
+      def self.included(base)
+        base.extend ClassMethods
+        base.send :include, InstanceMethods
+      end
+
+      module ClassMethods
+        # Create a new project from a path (to a file or a folder)
+        #
+        # @param [String] path, the path to the file
+        # @return [Project] a new initialized project
+        def new_from_path(path)
+          raise FileNotFound unless path && File.exists?(path)
+          LOG.debug("#{__FILE__}:#{__LINE__}: Creating a project from #{path}")
+          if GitBased.active_for_path?(path)
+            Project.new GitBased.project_name(path), GitBased.working_directory(path)
+          else
+            Project.new PathBased.project_name(path), PathBased.working_directory(path)
+          end
+        end
+      end
+
+      module InstanceMethods
+        # Initialize a project using a name and a path
+        #
+        # @param [String] name: the name of the project
+        # @param [String] path: The path of the project
+        def initialize(name, path)
+          LOG.debug("#{__FILE__}:#{__LINE__}: Created project #{name} located at #{path}")
+          @name = name
+          @path = path
+        end
+      end
+    end
+  end
+end

data/lib/watch_tower/project/path_based.rb

@@ -0,0 +1,144 @@
+module WatchTower
+  class Project
+    # The module contains Path specific project methods, methods like name, path
+    # The module can be included into another module/class or used on it's own,
+    # it does extend itself so any methods defined here is available to both class
+    # and instance level
+    module PathBased
+      include AnyBased
+      extend self
+
+      # Cache for working_directory by path
+      # The key is the path to a file, the value is the working directory of
+      # this path
+      @@working_cache = Hash.new
+
+      # Cache for project_name by path
+      # The key is the path to a file, the value is the project's name
+      @@project_name_cache = Hash.new
+
+      # Cache for project path parts
+      # The key is the path to a file, the value is the project's parts
+      @@project_path_part_cache = Hash.new
+
+      # Return the working directory (the project's path if you will) from a path
+      # to any file inside the project
+      #
+      # @param [String] path The path to look the project path from
+      # @param [Hash] options A hash of options
+      # @return [String] the project's folder
+      def working_directory(path, options = {})
+        return @@working_cache[path] if @@working_cache.key?(path)
+
+
+        @@working_cache[path] = project_path_from_nested_path(code_path(options),
+          path, nested_project_layers(options))
+        @@working_cache[path]
+      end
+
+      # Return the project's name from a path to any file inside the project
+      #
+      # @param path The path to look the project path from
+      # @param [Hash] options A hash of options
+      # @return [String] the project's name
+      def project_name(path, options = {})
+        return @@project_name_cache[path] if @@project_name_cache.key?(path)
+
+        @@project_name_cache[path] = project_name_from_nested_path(code_path(options),
+          path, nested_project_layers(options))
+        @@project_name_cache[path]
+      end
+
+      protected
+
+        # Get the code path from the options, if not found use the one from the
+        # configurations
+        #
+        # @param [Hash] options
+        # @return [String] The Code path
+        def code_path(options = {})
+          options[:code_path] || Config[:code_path]
+        end
+
+        # Get the nested_project_layers from the options, if not found use the
+        # one from the configurations
+        #
+        # @param [Hash] options
+        # @return [String] The nested_project_layers
+        def nested_project_layers(options = {})
+          options[:nested_project_layers] || Config[:nested_project_layers]
+        end
+
+        # Taken from timetap
+        # https://github.com/elia/timetap/blob/master/lib/time_tap/project.rb#L40
+        #
+        # Find out the path parts of the project that's currently being worked on,
+        # under the code path, it uses the param nested_project_layers to determine
+        # the project name from the entire expanded path to any file under the
+        # project
+        #
+        # nested project layers works "how many folders inside your code folder
+        # do you keep projects.
+        #
+        # For example, if your directory structure looks like:
+        # ~/Code/
+        #    Clients/
+        #        AcmeCorp/
+        #            website/
+        #            intranet
+        #        BetaCorp/
+        #           skunkworks/
+        #    OpenSource/
+        #        project_one/
+        #        timetap/
+        #
+        # A nested_project_layers setting of 2 would mean we track "AcmeCorp", "BetaCorp", and everything
+        # under OpenSource, as their own projects
+        #
+        # @param code The path you store all the projects under
+        # @param path The path to look the project name from
+        # @param nested_project_layers How many folders, defaults to 2
+        # @return [Array] The project path's parts
+        # @raise [WatchTower::PathNotUnderCodePath] if the path is not nested under code
+        def project_path_part(code, path, nested_project_layers = 2)
+          return @@project_path_part_cache[path] if @@project_path_part_cache.key?(path)
+
+          # Expand pathes
+          code = expand_path code
+          path = expand_path path
+
+          regex_suffix = "([^/]+)"
+          regex_suffix = [regex_suffix] * nested_project_layers
+          regex_suffix = regex_suffix.join("/")
+
+          path.scan(%r{(#{code})/#{regex_suffix}}).flatten.collect(&:chomp).
+            tap { |r| raise PathNotUnderCodePath unless r.any? }.
+            tap { |ppp| @@project_path_part_cache[path] = ppp }
+        end
+
+        # Find out the project's name
+        # See #project_path_part
+        #
+        # @param code The path you store all the projects under
+        # @param path The path to look the project name from
+        # @param nested_project_layers How many folders, defaults to 2
+        # @return [String] The project's name
+        # @raise [WatchTower::PathNotUnderCodePath] if the path is not nested under code
+        def project_name_from_nested_path(code, path, nested_project_layers = 2)
+          project_path_part(code, path, nested_project_layers)[nested_project_layers]
+        end
+
+        # Find out the project's path
+        # See #project_path_part
+        #
+        # @param code The path you store all the projects under
+        # @param path The path to look the project name from
+        # @param nested_project_layers How many folders, defaults to 2
+        # @return [String] The project's path
+        # @raise [WatchTower::PathNotUnderCodePath] if the path is not nested under code
+        def project_path_from_nested_path(code, path, nested_project_layers = 2)
+          project_path_part(code, path, nested_project_layers)[0..nested_project_layers].join('/')
+        end
+    end
+  end
+end

data/lib/watch_tower/server.rb

@@ -0,0 +1,62 @@
+module WatchTower
+  module Server
+    extend ::ActiveSupport::Autoload
+
+    autoload :Database
+    autoload :Duration, ::File.join(MODELS_PATH, 'duration.rb')
+    autoload :Project, ::File.join(MODELS_PATH, 'project.rb')
+    autoload :File, ::File.join(MODELS_PATH, 'file.rb')
+    autoload :TimeEntry, ::File.join(MODELS_PATH, 'time_entry.rb')
+    autoload :Helpers
+    autoload :Configurations
+    autoload :Decorator
+    autoload :App
+
+    # Start the server
+    # This method starts the database and then starts the server
+    #
+    # @param [Hash] options
+    def self.start(options = {})
+      # Start the Database
+      Database.start!(options)
+
+      # Start the Sinatra application
+      start_web_server(options)
+    end
+
+    # Start the Server, a method invoked from the Watch Tower command line interface
+    #
+    # @param [Hash] options
+    def self.start!(options = {})
+      start(options)
+    end
+
+    protected
+      # Start the web_server
+      # This method starts the web server (The Sinatra app)
+      #
+      # @param [Hash] options
+      def self.start_web_server(options = {})
+        LOG.debug("#{__FILE__}:#{__LINE__}: Starting the Sinatra App")
+
+        # Abort execution if the Thread raised an error.
+        Thread.abort_on_exception = true
+
+        WatchTower.threads[:web_server] = Thread.new do
+          LOG.debug("#{__FILE__}:#{__LINE__}: Starting a new Thread for the web server.")
+
+          begin
+            LOG.debug("#{__FILE__}:#{__LINE__}: Starting the web server in the new Thread.")
+
+            # Start the server
+            App.run!(options)
+
+            LOG.debug("#{__FILE__}:#{__LINE__}: The server has stopped.")
+          rescue Exception => e
+            LOG.fatal "#{__FILE__}:#{__LINE__ - 4}: #{e}"
+            raise e
+          end
+        end
+      end
+  end
+end