guard 1.4.0 → 2.18.0

data/lib/guard/hook.rb

@@ -1,120 +0,0 @@
-module Guard
-
-  # Guard has a hook mechanism that allows you to insert callbacks for individual Guard plugins.
-  # By default, each of the Guard plugin instance methods has a "_begin" and an "_end" hook.
-  # For example, the Guard::Guard#start method has a :start_begin hook that is runs immediately
-  # before Guard::Guard#start, and a :start_end hook that runs immediately after Guard::Guard#start.
-  #
-  # Read more about [hooks and callbacks on the wiki](https://github.com/guard/guard/wiki/Hooks-and-callbacks).
-  #
-  module Hook
-
-    require 'guard/ui'
-
-    # The Hook module gets included.
-    #
-    # @param [Class] base the class that includes the module
-    #
-    def self.included(base)
-      base.send :include, InstanceMethods
-    end
-
-    # Instance methods that gets included in the base class.
-    #
-    module InstanceMethods
-
-      # When event is a Symbol, {#hook} will generate a hook name
-      # by concatenating the method name from where {#hook} is called
-      # with the given Symbol.
-      #
-      # @example Add a hook with a Symbol
-      #
-      #   def run_all
-      #     hook :foo
-      #   end
-      #
-      # Here, when {Guard::Guard#run_all} is called, {#hook} will notify callbacks
-      # registered for the "run_all_foo" event.
-      #
-      # When event is a String, {#hook} will directly turn the String
-      # into a Symbol.
-      #
-      # @example Add a hook with a String
-      #
-      #   def run_all
-      #     hook "foo_bar"
-      #   end
-      #
-      # When {Guard::Guard#run_all} is called, {#hook} will notify callbacks
-      # registered for the "foo_bar" event.
-      #
-      # @param [Symbol, String] event the name of the Guard event
-      # @param [Array] args the parameters are passed as is to the callbacks registered for the given event.
-      #
-      def hook(event, *args)
-        hook_name = if event.is_a? Symbol
-                      calling_method = caller[0][/`([^']*)'/, 1]
-                      "#{ calling_method }_#{ event }"
-                    else
-                      event
-                    end.to_sym
-
-        ::Guard::UI.debug "Hook :#{ hook_name } executed for #{ self.class }"
-
-        Hook.notify(self.class, hook_name, *args)
-      end
-    end
-
-    class << self
-
-      # Get all callbacks.
-      #
-      def callbacks
-        @callbacks ||= Hash.new { |hash, key| hash[key] = [] }
-      end
-
-      # Add a callback.
-      #
-      # @param [Block] listener the listener to notify
-      # @param [Guard::Guard] guard_class the Guard class to add the callback
-      # @param [Array<Symbol>] events the events to register
-      #
-      def add_callback(listener, guard_class, events)
-        _events = events.is_a?(Array) ? events : [events]
-        _events.each do |event|
-          callbacks[[guard_class, event]] << listener
-        end
-      end
-
-      # Checks if a callback has been registered.
-      #
-      # @param [Block] listener the listener to notify
-      # @param [Guard::Guard] guard_class the Guard class to add the callback
-      # @param [Symbol] event the event to look for
-      #
-      def has_callback?(listener, guard_class, event)
-        callbacks[[guard_class, event]].include?(listener)
-      end
-
-      # Notify a callback.
-      #
-      # @param [Guard::Guard] guard_class the Guard class to add the callback
-      # @param [Symbol] event the event to trigger
-      # @param [Array] args the arguments for the listener
-      #
-      def notify(guard_class, event, *args)
-        callbacks[[guard_class, event]].each do |listener|
-          listener.call(guard_class, event, *args)
-        end
-      end
-
-      # Reset all callbacks.
-      #
-      def reset_callbacks!
-        @callbacks = nil
-      end
-
-    end
-
-  end
-end

data/lib/guard/interactors/coolline.rb

@@ -1,64 +0,0 @@
-require 'guard'
-require 'guard/ui'
-require 'guard/interactor'
-require 'guard/interactors/helpers/terminal'
-require 'guard/interactors/helpers/completion'
-
-module Guard
-
-  # Interactor that uses coolline for getting the user input.
-  # This enables history support and auto-completion,
-  #
-  class CoollineInteractor < ::Guard::Interactor
-    include ::Guard::CompletionHelper
-    include ::Guard::TerminalHelper
-
-    # Test if the Interactor is
-    # available in the current environment?
-    #
-    # @param [Boolean] silent true if no error messages should be shown
-    # @return [Boolean] the availability status
-    #
-    def self.available?(silent = false)
-      if RbConfig::CONFIG['RUBY_PROGRAM_VERSION'] == '1.9.3'
-        require 'coolline'
-        true
-      else
-        ::Guard::UI.error 'The :coolline interactor runs only on Ruby 1.9.3.' unless silent
-        false
-      end
-
-    rescue LoadError => e
-      ::Guard::UI.error "Please add \"gem 'coolline'\" to your Gemfile and run Guard with \"bundle exec\"." unless silent
-      false
-    end
-
-    # Read a line from stdin with Readline.
-    #
-    def read_line
-      coolline = Coolline.new do |cool|
-        cool.transform_proc = proc do
-          cool.line
-        end
-
-        cool.completion_proc = proc do
-          word = cool.completed_word
-          auto_complete(word)
-        end
-      end
-
-      while line = coolline.readline(prompt)
-        process_input(line)
-      end
-    end
-
-    # The current interactor prompt
-    #
-    # @return [String] the prompt to show
-    #
-    def prompt
-      ::Guard.listener.paused? ? 'p> ' : '>> '
-    end
-
-  end
-end

data/lib/guard/interactors/helpers/completion.rb

@@ -1,32 +0,0 @@
-require 'guard'
-
-module Guard
-  
-  # Module for providing word completion to an interactor.
-  #
-  module CompletionHelper
-
-    COMPLETION_ACTIONS = %w[help reload exit pause notification show]
-    
-    # Auto complete the given word.
-    #
-    # @param [String] word the partial word
-    # @return [Array<String>] the matching words
-    #
-    def auto_complete(word)
-      completion_list.grep(/^#{ Regexp.escape(word) }/)
-    end
-
-    # Get the auto completion list.
-    #
-    # @return [Array<String>] the list of words
-    #
-    def completion_list
-      groups = ::Guard.groups.map { |group| group.name.to_s }
-      guards = ::Guard.guards.map { |guard| guard.class.to_s.downcase.sub('guard::', '') }
-
-      COMPLETION_ACTIONS + groups + guards - ['default']
-    end
-    
-  end
-end

data/lib/guard/interactors/helpers/terminal.rb

@@ -1,46 +0,0 @@
-module Guard
-
-  # Module for resetting terminal options for an interactor.
-  #
-  module TerminalHelper
-
-    # Start the interactor.
-    #
-    def start
-      store_terminal_settings if stty_exists?
-      super
-    end
-
-    # Stop the interactor.
-    #
-    def stop
-      super
-      restore_terminal_settings if stty_exists?
-    end
-
-    private
-
-    # Detects whether or not the stty command exists
-    # on the user machine.
-    #
-    # @return [Boolean] the status of stty
-    #
-    def stty_exists?
-      @stty_exists ||= system('hash', 'stty')
-    end
-
-    # Stores the terminal settings so we can resore them
-    # when stopping.
-    #
-    def store_terminal_settings
-      @stty_save = `stty -g 2>/dev/null`.chomp
-    end
-
-    # Restore terminal settings
-    #
-    def restore_terminal_settings
-      system("stty #{ @stty_save } 2>/dev/null") if @stty_save
-    end
-
-  end
-end

data/lib/guard/interactors/readline.rb

@@ -1,94 +0,0 @@
-require 'guard'
-require 'guard/ui'
-require 'guard/interactor'
-require 'guard/interactors/helpers/terminal'
-require 'guard/interactors/helpers/completion'
-
-module Guard
-
-  # Interactor that used readline for getting the user input.
-  # This enables history support and auto-completion, but is
-  # broken on OS X without installing `rb-readline` or using JRuby.
-  #
-  # @see http://bugs.ruby-lang.org/issues/5539
-  #
-  class ReadlineInteractor < ::Guard::Interactor
-    include ::Guard::CompletionHelper
-    include ::Guard::TerminalHelper
-
-    # Test if the Interactor is
-    # available in the current environment?
-    #
-    # @param [Boolean] silent true if no error messages should be shown
-    # @return [Boolean] the availability status
-    #
-    def self.available?(silent = false)
-      require 'readline'
-
-      if defined?(RbReadline) || defined?(JRUBY_VERSION) || RbConfig::CONFIG['target_os'] =~ /linux/i
-        true
-      else
-        ::Guard::UI.error 'The :readline interactor runs only fine on JRuby, Linux or with the gem \'rb-readline\' installed.' unless silent
-        false
-      end
-
-    rescue LoadError => e
-      ::Guard::UI.error "Please install Ruby Readline support or add \"gem 'rb-readline'\" to your Gemfile and run Guard with \"bundle exec\"." unless silent
-      false      
-    end
-
-    # Initialize the interactor.
-    #
-    def initialize
-      require 'readline'
-
-      Readline.completion_proc = proc { |word| auto_complete(word) }
-
-      begin
-        Readline.completion_append_character = ' '
-      rescue NotImplementedError
-        # Ignore, we just don't support it then
-      end
-    end
-
-    # Stop the interactor.
-    #
-    def stop
-      # Erase the current line for Ruby Readline
-      if Readline.respond_to?(:refresh_line) && !defined?(::JRUBY_VERSION)
-        Readline.refresh_line
-      end
-
-      # Erase the current line for Rb-Readline
-      if defined?(RbReadline) && RbReadline.rl_outstream
-        RbReadline._rl_erase_entire_line
-      end
-
-      super
-    end
-
-    # Read a line from stdin with Readline.
-    #
-    def read_line
-      require 'readline'
-
-      while line = Readline.readline(prompt, true)
-        line.gsub!(/^\W*/, '')
-        if line =~ /^\s*$/ or Readline::HISTORY.to_a[-2] == line
-          Readline::HISTORY.pop
-        end
-
-        process_input(line)
-      end
-    end
-
-    # The current interactor prompt
-    #
-    # @return [String] the prompt to show
-    #
-    def prompt
-      ::Guard.listener.paused? ? 'p> ' : '> '
-    end
-
-  end
-end

data/lib/guard/interactors/simple.rb

@@ -1,19 +0,0 @@
-require 'guard/interactor'
-
-module Guard
-
-  # Simple interactor that that reads user
-  # input from standard input.
-  #
-  class SimpleInteractor < ::Guard::Interactor
-
-    # Read a line from stdin with Readline.
-    #
-    def read_line
-      while line = $stdin.gets
-        process_input(line.gsub(/^\W*/, '').chomp)
-      end
-    end
-
-  end
-end

data/lib/guard/notifiers/emacs.rb

@@ -1,69 +0,0 @@
-require 'rbconfig'
-
-module Guard
-  module Notifier
-
-    # Default options for EmacsClient
-    DEFAULTS = {
-      :client  => 'emacsclient',
-      :success => 'ForestGreen',
-      :failed  => 'Firebrick',
-      :default => 'Black',
-    }
-
-    # Send a notification to Emacs with emacsclient (http://www.emacswiki.org/emacs/EmacsClient).
-    #
-    # @example Add the `:emacs` notifier to your `Guardfile`
-    #   notification :emacs
-    #
-    module Emacs
-      extend self
-
-      # Test if Emacs with running server is available.
-      #
-      # @param [Boolean] silent true if no error messages should be shown
-      # @return [Boolean] the availability status
-      #
-      def available?(silent = false)
-        result = `#{ DEFAULTS[:client] } --eval '1' 2> /dev/null || echo 'N/A'`
-
-        if result.chomp! == 'N/A'
-          false
-        else
-          true
-        end
-      end
-
-      # Show a system notification.
-      #
-      # @param [String] type the notification type. Either 'success', 'pending', 'failed' or 'notify'
-      # @param [String] title the notification title
-      # @param [String] message the notification message body
-      # @param [String] image the path to the notification image
-      # @param [Hash] options additional notification library options
-      # @option options [Boolean] sticky make the notification sticky
-      # @option options [String, Integer] priority specify an int or named key (default is 0)
-      #
-      def notify(type, title, message, image, options = { })
-        system(%(#{ DEFAULTS[:client] } --eval "(set-face-background 'modeline \\"#{ emacs_color(type) }\\")"))
-      end
-
-      # Get the Emacs color for the notification type.
-      # You can configure your own color by overwrite the defaults.
-      #
-      # @param [String] type the notification type
-      # @return [String] the name of the emacs color
-      #
-      def emacs_color(type)
-        case type
-            when 'success'
-              DEFAULTS[:success]
-            when 'failed'
-              DEFAULTS[:failed]
-            else
-              DEFAULTS[:default]
-        end
-      end
-    end
-  end
-end

data/lib/guard/notifiers/gntp.rb

@@ -1,118 +0,0 @@
-require 'rbconfig'
-require 'guard/ui'
-
-module Guard
-  module Notifier
-
-    # System notifications using the [ruby_gntp](https://github.com/snaka/ruby_gntp) gem.
-    #
-    # This gem is available for OS X, Linux and Windows and sends system notifications to
-    # the following system notification frameworks through the
-    # [Growl Network Transport Protocol](http://www.growlforwindows.com/gfw/help/gntp.aspx):
-    #
-    # * [Growl](http://growl.info)
-    # * [Growl for Windows](http://www.growlforwindows.com)
-    # * [Growl for Linux](http://mattn.github.com/growl-for-linux)
-    # * [Snarl](https://sites.google.com/site/snarlapp/)
-    #
-    # @example Add the `ruby_gntp` gem to your `Gemfile`
-    #   group :development
-    #     gem 'ruby_gntp'
-    #   end
-    #
-    # @example Add the `:gntp` notifier to your `Guardfile`
-    #   notification :gntp
-    #
-    # @example Add the `:gntp` notifier with configuration options to your `Guardfile`
-    #   notification :gntp, :sticky => true, :host => '192.168.1.5', :password => 'secret'
-    #
-    module GNTP
-      extend self
-
-      # Default options for the ruby gtnp gem
-      DEFAULTS = {
-        :sticky   => false,
-        :host     => '127.0.0.1',
-        :password => '',
-        :port     => 23053
-      }
-
-      # Is this notifier already registered
-      #
-      # @return [Boolean] registration status
-      #
-      def registered?
-        @registered ||= false
-      end
-
-      # Mark the notifier as registered.
-      #
-      def registered!
-        @registered = true
-      end
-
-      # Test if the notification library is available.
-      #
-      # @param [Boolean] silent true if no error messages should be shown
-      # @return [Boolean] the availability status
-      #
-      def available?(silent = false)
-        if RbConfig::CONFIG['host_os'] =~ /darwin|linux|freebsd|openbsd|sunos|solaris|mswin|mingw/
-          require 'ruby_gntp'
-          true
-
-        else
-          ::Guard::UI.error 'The :gntp notifier runs only on Mac OS X, Linux, FreeBSD, OpenBSD, Solaris and Windows.' unless silent
-          false
-        end
-
-      rescue LoadError
-        ::Guard::UI.error "Please add \"gem 'ruby_gntp'\" to your Gemfile and run Guard with \"bundle exec\"." unless silent
-        false
-      end
-
-      # Show a system notification.
-      #
-      # @param [String] type the notification type. Either 'success', 'pending', 'failed' or 'notify'
-      # @param [String] title the notification title
-      # @param [String] message the notification message body
-      # @param [String] image the path to the notification image
-      # @param [Hash] options additional notification library options
-      # @option options [String] host the hostname or IP address to which to send a remote notification
-      # @option options [String] password the password used for remote notifications
-      # @option options [Integer] port the port to send a remote notification
-      # @option options [Boolean] sticky make the notification sticky
-      #
-      def notify(type, title, message, image, options = { })
-        require 'ruby_gntp'
-
-        options = DEFAULTS.merge(options)
-
-        gntp = ::GNTP.new('Guard', options.delete(:host), options.delete(:password), options.delete(:port))
-
-        unless registered?
-          gntp.register({
-              :app_icon => File.expand_path(File.join(__FILE__, '..', '..', '..', '..', 'images', 'guard.png')),
-              :notifications => [
-                  { :name => 'notify', :enabled => true },
-                  { :name => 'failed', :enabled => true },
-                  { :name => 'pending', :enabled => true },
-                  { :name => 'success', :enabled => true }
-              ]
-          })
-
-          registered!
-        end
-
-        gntp.notify(options.merge({
-            :name  => type,
-            :title => title,
-            :text  => message,
-            :icon  => image
-        }))
-      end
-
-    end
-  end
-end
-

data/lib/guard/notifiers/growl.rb

@@ -1,99 +0,0 @@
-require 'rbconfig'
-require 'guard/ui'
-
-module Guard
-  module Notifier
-
-    # System notifications using the [growl](https://github.com/visionmedia/growl) gem.
-    #
-    # This gem is available for OS X and sends system notifications to
-    # [Growl](http://growl.info) through the [GrowlNotify](http://growl.info/downloads)
-    # executable.
-    #
-    # The `growlnotify` executable must be installed manually or by using
-    # [Homebrew](http://mxcl.github.com/homebrew/).
-    #
-    # Sending notifications with this notifier will not show the different
-    # Guard notifications in the Growl preferences. Use the :gntp or :growl_notify
-    # notifiers if you want to customize each notification type in Growl.
-    #
-    # @example Install `growlnotify` with Homebrew
-    #   brew install growlnotify
-    #
-    # @example Add the `growl` gem to your `Gemfile`
-    #   group :development
-    #     gem 'growl'
-    #   end
-    #
-    # @example Add the `:growl` notifier to your `Guardfile`
-    #   notification :growl
-    #
-    # @example Add the `:growl_notify` notifier with configuration options to your `Guardfile`
-    #   notification :growl, :sticky => true, :host => '192.168.1.5', :password => 'secret'
-    #
-    module Growl
-      extend self
-
-      # Default options for growl gem
-      DEFAULTS = {
-        :sticky   => false,
-        :priority => 0
-      }
-
-      # Test if the notification library is available.
-      #
-      # @param [Boolean] silent true if no error messages should be shown
-      # @return [Boolean] the availability status
-      #
-      def available?(silent = false)
-        if RbConfig::CONFIG['host_os'] =~ /darwin/
-          require 'growl'
-
-          if ::Growl.installed?
-            true
-          else
-            ::Guard::UI.error "Please install the 'growlnotify' executable." unless silent
-            false
-          end
-
-        else
-          ::Guard::UI.error 'The :growl notifier runs only on Mac OS X.' unless silent
-          false
-        end
-
-      rescue LoadError, NameError
-        ::Guard::UI.error "Please add \"gem 'growl'\" to your Gemfile and run Guard with \"bundle exec\"." unless silent
-        false
-      end
-
-      # Show a system notification.
-      #
-      # The documented options are for GrowlNotify 1.3, but the older options are
-      # also supported. Please see `growlnotify --help`.
-      #
-      # Priority can be one of the following named keys: `Very Low`, `Moderate`, `Normal`,
-      # `High`, `Emergency`. It can also be an int between -2 and 2.
-      #
-      # @param [String] type the notification type. Either 'success', 'pending', 'failed' or 'notify'
-      # @param [String] title the notification title
-      # @param [String] message the notification message body
-      # @param [String] image the path to the notification image
-      # @param [Hash] options additional notification library options
-      # @option options [Boolean] sticky make the notification sticky
-      # @option options [String, Integer] priority specify an int or named key (default is 0)
-      # @option options [String] host the hostname or IP address to which to send a remote notification
-      # @option options [String] password the password used for remote notifications
-      #
-      def notify(type, title, message, image, options = { })
-        require 'growl'
-
-        ::Growl.notify(message, DEFAULTS.merge(options).merge({
-            :name => 'Guard',
-            :title => title,
-            :image => image
-        }))
-      end
-
-    end
-  end
-end