guard 2.8.2 → 2.9.0

data/lib/guard/notifiers/base.rb.orig

@@ -1,221 +0,0 @@
-require "rbconfig"
-require "guard/ui"
-
-module Guard
-  module Notifier
-    # Base class for all notifiers.
-    #
-    class Base
-      HOSTS = {
-        darwin:  "Mac OS X",
-        linux:   "Linux",
-        freebsd: "FreeBSD",
-        openbsd: "OpenBSD",
-        sunos:   "SunOS",
-        solaris: "Solaris",
-        mswin:   "Windows",
-        mingw:   "Windows",
-        cygwin:  "Windows"
-      }
-
-      ERROR_ADD_GEM_AND_RUN_BUNDLE = "Please add \"gem '%s'\" to your Gemfile "\
-        "and run Guard with \"bundle exec\"."
-
-      attr_reader :options
-
-      def initialize(opts = {})
-        @options = opts
-      end
-
-      # This method should be overriden by subclasses and return an array of
-      # OSes the notifier supports. By default, it returns :all which mean
-      # there's no check against the current OS.
-      #
-      # @see HOSTS for the list of possible OSes
-      #
-      def self.supported_hosts
-        :all
-      end
-
-      # Test if the notifier can be used.
-      #
-      # @param [Hash] opts notifier options
-      # @option opts [Boolean] silent true if no error messages should be shown
-      # @return [Boolean] the availability status
-      #
-      def self.available?(opts = {})
-        if _supported_host?
-          true
-        else
-          hosts = supported_hosts.map { |host| HOSTS[host.to_sym] }.join(", ")
-          unless opts.fetch(:silent) { false }
-            ::Guard::UI.error "The :#{name} notifier runs only on #{hosts}."
-          end
-          false
-        end
-      end
-
-      # This method must be overriden.
-      #
-      def notify(_message, opts = {})
-        options.delete(:silent)
-        opts.replace(options.merge(opts))
-        normalize_standard_options!(opts)
-      end
-
-      # Returns the title of the notifier.
-      #
-      # @example Un-modulize the class name
-      #   Guard::Notifier::FileNotifier.title
-      #   #=> 'FileNotifier'
-      #
-      # @return [String] the title of the notifier
-      #
-      def self.title
-        to_s.sub(/.+::(\w+)$/, '\1')
-      end
-
-      # Returns the name of the notifier.
-      #
-      # @example Un-modulize, underscorize and downcase the class name
-      #   Guard::Notifier::FileNotifier.name
-      #   #=> 'file_notifier'
-      #
-      # @return [String] the name of the notifier
-      #
-      def self.name
-        title.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
-      end
-
-      # Returns the name of the notifier's gem. By default it returns the
-      # notifier name. This method can be overriden by subclasses.
-      #
-      # @example Un-modulize, underscorize and downcase the class name
-      #   Guard::Notifier::FileNotifier.gem_name
-      #   #=> 'file_notifier'
-      #
-      # @return [String] the name of the notifier's gem
-      #
-      def self.gem_name
-        name
-      end
-
-      # This method tries to require the gem whose name is returned by
-      # `.gem_name`. If a LoadError or NameError occurs, it displays an error
-      # message (unless opts[:silent] is true) and returns false.
-      #
-      # @param [Hash] opts some options
-      # @option opts [Boolean] silent true if no error messages should be shown
-      #
-      # @return [Boolean] whether or not the gem is loaded
-      #
-      def self.require_gem_safely(opts = {})
-        require gem_name
-        true
-      rescue LoadError, NameError
-        unless opts[:silent]
-          UI.error ERROR_ADD_GEM_AND_RUN_BUNDLE % [gem_name]
-        end
-        false
-      end
-
-      # Returns the title of the notifier.
-      #
-      # @example Un-modulize the class name
-      #   Guard::Notifier::FileNotifier.new.title
-      #   #=> 'FileNotifier'
-      #
-      # @return [String] the title of the notifier
-      #
-      def title
-        self.class.title
-      end
-
-      # Returns the name of the notifier.
-      #
-      # @example Un-modulize, underscorize and downcase the class name
-      #   Guard::Notifier::FileNotifier.new.name
-      #   #=> 'file_notifier'
-      #
-      # @return [String] the name of the notifier
-      #
-      def name
-        self.class.name
-      end
-
-      # Paths where all Guard images are located
-      #
-      # @return [Pathname] the path to the images directory
-      #
-      def images_path
-        @images_path ||= Pathname.new(__FILE__).dirname + "../../../images"
-      end
-
-      # @private
-      #
-      # Checks if the current OS is supported by the notifier.
-      #
-      # @see .supported_hosts
-      #
-      def self._supported_host?
-        supported_hosts == :all ||
-        RbConfig::CONFIG["host_os"] =~ /#{supported_hosts.join('|')}/
-      end
-
-      # Set or modify the `:title`, `:type` and `:image` options for a
-      # notification. Should be used in `#notify`.
-      #
-      # @param [Hash] opts additional notification library options
-      # @option opts [String] type the notification type. Either 'success',
-      #   'pending', 'failed' or 'notify'
-      # @option opts [String] title the notification title
-      # @option opts [String] image the path to the notification image
-      #
-      def normalize_standard_options!(opts)
-        opts[:title] ||= "Guard"
-        opts[:type]  ||= _notification_type(opts.fetch(:image, :success))
-        opts[:image]   = _image_path(opts.delete(:image) { :success })
-      end
-
-      private
-
-      # Get the image path for an image symbol for the following
-      # known image types:
-      #
-      # - failed
-      # - pending
-      # - success
-      #
-      # If the image is not a known symbol, it will be returned unmodified.
-      #
-      # @param [Symbol, String] image the image symbol or path to an image
-      #
-      # @return [String] the image path
-      #
-      def _image_path(image)
-        case image
-        when :failed, :pending, :success
-          images_path.join("#{image}.png").to_s
-        else
-          image
-        end
-      end
-
-      # Get the notification type depending on the
-      # image that has been selected for the notification.
-      #
-      # @param [Symbol, String] image the image symbol or path to an image
-      #
-      # @return [String] the notification type
-      #
-      def _notification_type(image)
-        case image
-        when :failed, :pending, :success
-          image
-        else
-          :notify
-        end
-      end
-    end
-  end
-end

data/lib/guard/notifiers/tmux.rb.orig

@@ -1,339 +0,0 @@
-require "guard/notifiers/base"
-
-module Guard
-  module Notifier
-    # Changes the color of the Tmux status bar and optionally
-    # shows messages in the status bar.
-    #
-    # @example Add the `:tmux` notifier to your `Guardfile`
-    #   notification :tmux
-    #
-    # @example Enable text messages
-    #   notification :tmux, display_message: true
-    #
-    # @example Customize the tmux status colored for notifications
-    #   notification :tmux, color_location: 'status-right-bg'
-    #
-    class Tmux < Base
-      # Default options for the tmux notifications.
-      DEFAULTS = {
-        client:                 "tmux",
-        tmux_environment:       "TMUX",
-        success:                "green",
-        failed:                 "red",
-        pending:                "yellow",
-        default:                "green",
-        timeout:                5,
-        display_message:        false,
-        default_message_format: "%s - %s",
-        default_message_color:  "white",
-        display_on_all_clients: false,
-        display_title:          false,
-        default_title_format:   "%s - %s",
-        line_separator:         " - ",
-        change_color:           true,
-        color_location:         "status-left-bg"
-      }
-
-      ERROR_NOT_INSIDE_SESSION = "The :tmux notifier runs only on when Guard"\
-              " is executed inside of a tmux session."
-
-      def self.available?(opts = {})
-        super && _register!(opts)
-      end
-
-      # @private
-      #
-      # @return [Boolean] whether or not a TMUX environment is available
-      #
-      def self._tmux_environment_available?(opts)
-        !ENV[opts.fetch(:tmux_environment, DEFAULTS[:tmux_environment])].nil?
-      end
-
-      # @private
-      #
-      # Detects if a TMUX environment is available and if not,
-      # displays an error message unless `opts[:silent]` is true.
-      #
-      # @return [Boolean] whether or not a TMUX environment is available
-      #
-      def self._register!(opts)
-        @options_stored = false
-        if _tmux_environment_available?(opts)
-          true
-        else
-          unless opts[:silent]
-            ::Guard::UI.error ERROR_NOT_INSIDE_SESSION
-          end
-          false
-        end
-      end
-
-      # Shows a system notification.
-      #
-      # By default, the Tmux notifier only makes
-      # use of a color based notification, changing the background color of the
-      # `color_location` to the color defined in either the `success`,
-      # `failed`, `pending` or `default`, depending on the notification type.
-      #
-      # You may enable an extra explicit message by setting `display_message`
-      # to true, and may further disable the colorization by setting
-      # `change_color` to false.
-      #
-      # @param [String] title the notification title
-      # @param [Hash] opts additional notification library options
-      # @option opts [String] type the notification type. Either 'success',
-      #   'pending', 'failed' or 'notify'
-      # @option opts [String] message the notification message body
-      # @option opts [String] image the path to the notification image
-      # @option opts [Boolean] change_color whether to show a color
-      #   notification
-      # @option opts [String,Array] color_location the location where to draw
-      #   the color notification
-      # @option opts [Boolean] display_message whether to display a message
-      #   or not
-      # @option opts [Boolean] display_on_all_clients whether to display a
-      #   message on all tmux clients or not
-      #
-      def notify(message, opts = {})
-        super
-        opts.delete(:image)
-
-        if opts.fetch(:change_color, DEFAULTS[:change_color])
-          options = opts.fetch(:color_location, DEFAULTS[:color_location])
-          color_locations = Array(options)
-          color = tmux_color(opts[:type], opts)
-
-          color_locations.each do |color_location|
-            _run_client "set", "#{self.class._quiet_option}"\
-              "#{color_location} #{color}"
-          end
-        end
-
-        type  = opts.delete(:type).to_s
-        title = opts.delete(:title)
-
-        if opts.fetch(:display_title, DEFAULTS[:display_title])
-          display_title(type, title, message, opts)
-        end
-
-        return unless opts.fetch(:display_message, DEFAULTS[:display_message])
-        display_message(type, title, message, opts)
-      end
-
-      # Displays a message in the title bar of the terminal.
-      #
-      # @param [String] title the notification title
-      # @param [String] message the notification message body
-      # @param [Hash] options additional notification library options
-      # @option options [String] success_message_format a string to use as
-      #   formatter for the success message.
-      # @option options [String] failed_message_format a string to use as
-      #   formatter for the failed message.
-      # @option options [String] pending_message_format a string to use as
-      #   formatter for the pending message.
-      # @option options [String] default_message_format a string to use as
-      #   formatter when no format per type is defined.
-      #
-      def display_title(type, title, message, opts = {})
-        format = "#{type}_title_format".to_sym
-        defaults = DEFAULTS[:default_title_format]
-        options = opts.fetch(:default_title_format, defaults)
-        title_format   = opts.fetch(format, options)
-        teaser_message = message.split("\n").first
-        display_title  = title_format % [title, teaser_message]
-
-        _run_client "set-option", "#{self.class._quiet_option}"\
-          "set-titles-string '#{display_title}'"
-      end
-
-      # Displays a message in the status bar of tmux.
-      #
-      # @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 [Hash] options additional notification library options
-      # @option options [Integer] timeout the amount of seconds to show the
-      #   message in the status bar
-      # @option options [String] success_message_format a string to use as
-      #   formatter for the success message.
-      # @option options [String] failed_message_format a string to use as
-      #   formatter for the failed message.
-      # @option options [String] pending_message_format a string to use as
-      #   formatter for the pending message.
-      # @option options [String] default_message_format a string to use as
-      #   formatter when no format per type is defined.
-      # @option options [String] success_message_color the success notification
-      #   foreground color name.
-      # @option options [String] failed_message_color the failed notification
-      #   foreground color name.
-      # @option options [String] pending_message_color the pending notification
-      #   foreground color name.
-      # @option options [String] default_message_color a notification
-      #   foreground color to use when no color per type is defined.
-      # @option options [String] line_separator a string to use instead of a
-      #   line-break.
-      #
-      def display_message(type, title, message, opts = {})
-        default_format = DEFAULTS[:default_message_format]
-        default_format = opts.fetch(:default_message_format, default_format)
-        format = "#{type}_message_format".to_sym
-        message_format = opts.fetch(format, default_format)
-
-        default_color = DEFAULTS[:default_message_color]
-        default_color = opts.fetch(:default_message_color, default_color)
-        color = "#{type}_message_color".to_sym
-        message_color = opts.fetch(color, default_color)
-
-        display_time = opts.fetch(:timeout, DEFAULTS[:timeout])
-        separator = opts.fetch(:line_separator, DEFAULTS[:line_separator])
-
-        color = tmux_color type, opts
-        formatted_message = message.split("\n").join(separator)
-        display_message = message_format % [title, formatted_message]
-
-        _run_client(
-          "set",
-          "#{self.class._quiet_option}display-time #{display_time * 1000}")
-
-        _run_client "set", "#{self.class._quiet_option}"\
-          "message-fg #{message_color}"
-        _run_client "set", "#{self.class._quiet_option}"\
-          "message-bg #{color}"
-        _run_client "display-message", "'#{display_message}'"
-      end
-
-      # Get the Tmux color for the notification type.
-      # You can configure your own color by overwriting the defaults.
-      #
-      # @param [String] type the notification type
-      # @return [String] the name of the emacs color
-      #
-      def tmux_color(type, opts = {})
-        type = type.to_sym
-
-        opts[type] || DEFAULTS[type] || opts[:default] || DEFAULTS[:default]
-      end
-
-      # Notification starting, save the current Tmux settings
-      # and quiet the Tmux output.
-      #
-      def self.turn_on
-        unless @options_stored
-          _reset_options_store
-
-          _clients.each do |client|
-            @options_store[client].merge!(_options_for_client(client))
-          end
-
-          @options_stored = true
-        end
-      end
-
-      # Notification stopping. Restore the previous Tmux state
-      # if available (existing options are restored, new options
-      # are unset) and unquiet the Tmux output.
-      #
-      def self.turn_off
-        if @options_stored
-          @options_store.each do |client, options|
-            options.each do |key, value|
-              args = [
-                DEFAULTS[:client], "set", "-t",
-                client, _quiet_option.strip
-              ]
-              args << "-u" unless value
-              args << key
-              args << value if value
-              Sheller.run(args.join(" "))
-            end
-          end
-          _reset_options_store
-        end
-      end
-
-      def self.options_store
-        @options_store ||= {}
-      end
-
-      private
-
-      def self._clients
-        args = [DEFAULTS[:client], "list-clients", "-F", "'\#{client_tty}'"]
-        ttys = Sheller.stdout(args.join(" "))
-        ttys = ttys.split(/\n/)
-
-        # if user is running 'tmux -C' remove this client from list
-        ttys.delete("(null)")
-
-        ttys
-      end
-
-      def self._options_for_client(client)
-        options = {}
-
-        lines = Sheller.stdout("#{DEFAULTS[:client]} show -t #{client}")
-
-        lines.each_line do |line|
-          option, _, setting = line.chomp.partition(" ")
-          options[option] = setting
-        end
-
-        options
-      end
-
-      def _clients
-        self.class._clients
-      end
-
-      def _run_client(cmd, args)
-        default = DEFAULTS[:display_on_all_clients]
-        all_clients = @options.fetch(:display_on_all_clients, default)
-        clients = all_clients ? _clients : [nil]
-        clients.each do |client|
-          cmd_args = if client
-                       "#{_client_cmd_flag(cmd)} #{client.strip} #{args}"
-                     else
-                       args
-                     end
-          Sheller.run("#{DEFAULTS[:client]} #{cmd} #{cmd_args}")
-        end
-      end
-
-      def _client_cmd_flag(cmd)
-        case cmd
-        when "set", "set-option" then "-t"
-        when "display-message" then "-c"
-        end
-      end
-
-      # Reset the internal Tmux options store defaults.
-      #
-      def self._reset_options_store
-        @options_stored = false
-        @options_store = {}
-
-        _clients.each do |client|
-          @options_store[client] = {
-            "status-left-bg"  => nil,
-            "status-right-bg" => nil,
-            "status-left-fg"  => nil,
-            "status-right-fg" => nil,
-            "message-bg"      => nil,
-            "message-fg"      => nil,
-            "display-time"    => nil
-          }
-        end
-      end
-
-      def self._tmux_version
-        @@tmux_version ||= Float(Sheller.stdout("tmux -V")[/\d+\.\d+/])
-      end
-
-      def self._quiet_option
-        "-q " if _tmux_version >= 1.7
-      end
-    end
-  end
-end