watch_tower 0.0.0.1

data/lib/watch_tower/appscript.rb

@@ -0,0 +1,22 @@
+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
+  module ::Appscript
+    class Application
+      def is_running?
+        false
+      end
+    end
+
+    def app(*args)
+      Application.new
+    end
+  end
+end

data/lib/watch_tower/cli.rb

@@ -0,0 +1,15 @@
+require 'thor'
+
+# Load all modules
+Dir["#{LIB_PATH}/cli/**/*.rb"].each { |f| require f }
+
+module WatchTower
+  module CLI
+    class Runner < ::Thor
+      # Include cli modules
+      include Install
+      include Open
+      include Start
+    end
+  end
+end

data/lib/watch_tower/cli/install.rb

@@ -0,0 +1,63 @@
+module WatchTower
+  module CLI
+    module Install
+
+      def self.included(base)
+        base.send :include, InstanceMethods
+      end
+
+      module InstanceMethods
+        def self.included(base)
+          base.class_eval <<-END, __FILE__, __LINE__ + 1
+            # This module needs Thor::Actions
+            include ::Thor::Actions
+
+            # Mappings (aliases)
+            map "-i" => :install
+
+            # Install WatchTower
+            desc "install", "Install Watch Tower"
+            def install
+              # Install the configuration file
+              install_config_file
+              # Install the bootloader
+              install_bootloader
+            end
+
+            protected
+              # Install the configuration file
+              def install_config_file
+                self.class.source_root(TEMPLATE_PATH)
+                copy_file 'config.yml', File.join(USER_PATH, 'config.yml')
+              end
+
+              # Install bootloader
+              def install_bootloader
+                require 'rbconfig'
+                case RbConfig::CONFIG['target_os']
+                when /darwin/
+                  install_bootloader_on_mac
+                else
+                  puts <<-MSG
+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
+MSG
+                end
+              end
+
+              # 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')
+
+                puts "\nCreated. Now run:\n  launchctl load ~/Library/LaunchAgents/fr.technogate.WatchTower.plist\n\n"
+              end
+          END
+        end
+      end
+    end
+  end
+end

data/lib/watch_tower/cli/open.rb

@@ -0,0 +1,24 @@
+module WatchTower
+  module CLI
+    module Open
+
+      def self.included(base)
+        base.send :include, InstanceMethods
+      end
+
+      module InstanceMethods
+        def self.included(base)
+          base.class_eval <<-END, __FILE__, __LINE__ + 1
+            # Open the WatchTower server in the browser
+            #
+            # TODO: Should be able to determine the port of the server.
+            desc "open", "Open the WatchTower in the browser"
+            def open
+              system "open http://localhost:9282"
+            end
+          END
+        end
+      end
+    end
+  end
+end

data/lib/watch_tower/cli/start.rb

@@ -0,0 +1,140 @@
+module WatchTower
+  module CLI
+    module Start
+
+      def self.included(base)
+        base.send :include, InstanceMethods
+      end
+
+      module InstanceMethods
+        def self.included(base)
+          base.class_eval <<-END, __FILE__, __LINE__ + 1
+            # Mappings (aliases)
+            map "-s" => :start
+
+            # Start watchtower
+            desc "start", "Start the Watch Tower"
+            method_option :bootloader,
+              type: :boolean,
+              required: false,
+              aliases: "-b",
+              default: false,
+              desc: "Is it invoked from the bootloader?"
+            method_option :foreground,
+              type: :boolean,
+              required: false,
+              aliases: "-f",
+              default: false,
+              desc: "Do not run in the background."
+            method_option :host,
+              type: :string,
+              required: false,
+              aliases: "-h",
+              default: 'localhost',
+              desc: "Set the server's host"
+            method_option :port,
+              type: :numeric,
+              required: false,
+              aliases: "-p",
+              default: 9282,
+              desc: "Set the server's port."
+            def start
+              if Config[:enabled] &&
+                (!options[:bootloader] || (options(:bootloader) && Config[:launch_on_boot]))
+                LOG.info "Starting WatchTower."
+                start!
+              else
+                abort "You need to edit the config file located at #{Config::CONFIG_FILE}."
+              end
+            end
+
+            protected
+              def start!
+                if options[:foreground]
+                  LOG.debug "#{__FILE__}:#{__LINE__}: Running WatchTower in foreground."
+
+                  # Start WatchTower
+                  start_watch_tower
+
+                  LOG.debug "#{__FILE__}:#{__LINE__}: WatchTower has finished."
+                else
+                  LOG.debug "#{__FILE__}:#{__LINE__}: Running WatchTower in the background."
+                  pid = fork do
+                    # Try to replace ruby with WatchTower in the command line (for ps)
+                    $0 = 'watchtower' unless $0 == 'watchtower'
+
+                    # Tell ruby that we are a daemon
+                    Process.daemon
+
+                    # Start WatchTower
+                    start_watch_tower
+
+                    LOG.debug "#{__FILE__}:#{__LINE__}: WatchTower has finished."
+                  end
+                end
+              end
+
+              # Start watch tower
+              # This method just start the watch tower it doesn't know
+              # or care if we are in a forked process or not, all it cares about
+              # is starting the database server before starting the eye
+              #
+              # see #start_server
+              # see #start_eye
+              def start_watch_tower
+                # Start the server
+                start_server
+
+                # Wait until the database starts
+                until Server::Database.is_connected? do
+                  sleep(1)
+                end
+
+                # Wait until the database has migrated
+                until Server::Database.is_migrated? do
+                  sleep(1)
+                end
+
+                # Start the eye now.
+                start_eye
+              end
+
+              # Start the eye
+              # This method just start the watch tower it doesn't know
+              # or care if we are in a forked process or not
+              def start_eye
+                LOG.debug "#{__FILE__}:#{__LINE__}: Starting the eye."
+                Eye.start!(watch_tower_options)
+              end
+
+              # Start the web server
+              # This method just start the watch tower it doesn't know
+              # or care if we are in a forked process or not
+              def start_server
+                LOG.debug "#{__FILE__}:#{__LINE__}: Starting the web server."
+                Server.start!(watch_tower_options)
+              end
+
+              # Return Watch Tower options
+              # same as options but modified to correspond to WatchTower options
+              # instead of CLI options
+              #
+              # @return [Hash] options
+              def watch_tower_options
+                return @watch_tower_options if @watch_tower_options
+
+                @watch_tower_options = options.dup
+                @watch_tower_options.delete(:bootloader)
+
+                # Log the options as a Debug
+                LOG.debug "#{__FILE__}:#{__LINE__}: Options are \#{@watch_tower_options.inspect}."
+
+                # Return the options
+                @watch_tower_options
+              end
+          END
+        end
+      end
+    end
+  end
+end

data/lib/watch_tower/config.rb

@@ -0,0 +1,38 @@
+require 'active_support/hash_with_indifferent_access'
+
+module WatchTower
+  module Config
+    extend self
+
+    # Define the config file's path
+    CONFIG_FILE = File.join(USER_PATH, 'config.yml')
+
+    # Define the config class variable
+    @@config = nil
+
+    # Return a particular config variable from the parsed config file
+    #
+    # @param [String|Symbol] config
+    # @return mixed
+    # @raise [Void]
+    def [](config)
+      ensure_config_file_exists
+      @@config ||= HashWithIndifferentAccess.new(YAML.parse_file(CONFIG_FILE).to_ruby)
+      @@config[:watch_tower].send(:[], config)
+    end
+
+    protected
+      # Ensures config file exists in the user config folder
+      #
+      # @param [Void]
+      # @return [Void]
+      # @raise [Void]
+      def ensure_config_file_exists
+        unless File.exists?(CONFIG_FILE)
+          File.open(CONFIG_FILE, 'w') do |f|
+            f.write(File.read(File.join(TEMPLATE_PATH, 'config.yml')))
+          end
+        end
+      end
+  end
+end

data/lib/watch_tower/core_ext.rb

@@ -0,0 +1,4 @@
+require 'active_support/core_ext'
+require 'active_support/dependencies/autoload'
+
+Dir["#{File.dirname(__FILE__)}/core_ext/**/*.rb"].each { |f| require f }

data/lib/watch_tower/editor.rb

@@ -0,0 +1,17 @@
+module WatchTower
+  module Editor
+    extend ::ActiveSupport::Autoload
+
+    autoload :BaseAppscript
+    autoload :BasePs
+    autoload :Textmate
+    autoload :Xcode
+
+    def self.editors
+      Editor.constants.                                     # Collect the defined constants
+        collect { |c| "::WatchTower::Editor::#{c}"}.        # Access them under the Server module
+        collect(&:constantize).                             # Make them a constant
+        select { |c| c.class == Class }                     # Keep only classes
+    end
+  end
+end

data/lib/watch_tower/editor/base_appscript.rb

@@ -0,0 +1,34 @@
+require 'watch_tower/appscript'
+
+module WatchTower
+  module Editor
+    module BaseAppscript
+      def self.included(base)
+        base.send :include, InstanceMethods
+      end
+
+      module InstanceMethods
+        def self.included(base)
+          base.class_eval <<-END, __FILE__, __LINE__ + 1
+            # Include AppScript
+            include ::Appscript
+
+            def is_running?
+              editor.is_running? if editor
+            end
+
+            def current_path
+              current_paths.try(:first)
+            end
+
+            def current_paths
+              if is_running?
+                editor.document.get.collect(&:path).collect(&:get)
+              end
+            end
+          END
+        end
+      end
+    end
+  end
+end

data/lib/watch_tower/editor/base_ps.rb

@@ -0,0 +1,6 @@
+module WatchTower
+  module Editor
+    module BasePs
+    end
+  end
+end

data/lib/watch_tower/editor/textmate.rb

@@ -0,0 +1,17 @@
+module WatchTower
+  module Editor
+    class Textmate
+      include BaseAppscript
+
+      protected
+        # This method returns an instance of ::Appscript::Application
+        #
+        # returns [::Appscript::Application | nil]
+        def editor
+          app 'Textmate'
+        rescue ::FindApp::ApplicationNotFoundError
+          LOG.debug "#{__FILE__}:#{__LINE__ - 2}: Textmate application can't be found, maybe not installed?"
+        end
+    end
+  end
+end

data/lib/watch_tower/editor/xcode.rb

@@ -0,0 +1,22 @@
+module WatchTower
+  module Editor
+    class Xcode
+      include BaseAppscript
+
+      protected
+        # This method returns an instance of ::Appscript::Application
+        #
+        # returns [::Appscript::Application | nil]
+        def editor
+          # Cannot use app('Xcode') because it fails when multiple Xcode versions are installed
+          # Taken from timetap
+          # 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 ::FindApp::ApplicationNotFoundError
+        rescue ::Appscript::CommandError
+          nil
+        end
+    end
+  end
+end

data/lib/watch_tower/errors.rb

@@ -0,0 +1,25 @@
+module WatchTower
+  # Global Error
+  WatchTowerError = Class.new Exception
+
+  # Exceptions raised by the Project module
+  ProjectError = Class.new WatchTowerError
+  FileNotFound = Class.new ProjectError
+
+  # Exception raised by the Path module
+  PathError = Class.new ProjectError
+  PathNotUnderCodePath = Class.new PathError
+
+  # Exception raised by the Editor module
+  EditorError = Class.new WatchTowerError
+  TextmateError = Class.new EditorError
+  XcodeError = Class.new EditorError
+
+  # Exceptions raised by the Server module
+  ServerError = Class.new WatchTowerError
+  DatabaseError = Class.new ServerError
+  DatabaseConfigNotFoundError = Class.new DatabaseError
+
+  # Exceptions raised by the Eye module
+  EyeError = Class.new WatchTowerError
+end