guard 2.10.5 → 2.11.0

data/lib/guard/notifier/detected.rb

@@ -1,87 +0,0 @@
-require "nenv"
-
-require_relative "../notifiers/emacs"
-require_relative "../notifiers/file_notifier"
-require_relative "../notifiers/gntp"
-require_relative "../notifiers/growl"
-require_relative "../notifiers/libnotify"
-require_relative "../notifiers/notifysend"
-require_relative "../notifiers/rb_notifu"
-require_relative "../notifiers/terminal_notifier"
-require_relative "../notifiers/terminal_title"
-require_relative "../notifiers/tmux"
-
-module Guard
-  module Notifier
-    # @private api
-
-    YamlEnvStorage = Nenv::Builder.build do
-      create_method(:notifiers=) { |data| YAML::dump(data) }
-      create_method(:notifiers) { |data| data ? YAML::load(data) : [] }
-    end
-
-    # @private api
-    class Detected
-      NO_SUPPORTED_NOTIFIERS = "Guard could not detect any of the supported" +
-        " notification libraries."
-
-      class NoneAvailableError < RuntimeError
-      end
-
-      def initialize(supported)
-        @supported = supported
-        @environment = YamlEnvStorage.new("guard")
-      end
-
-      def reset
-        @environment.notifiers = nil
-      end
-
-      def detect
-        return unless _data.empty?
-        @supported.each do |group|
-          group.detect { |name, _| add(name, silent: true) }
-        end
-
-        fail NoneAvailableError, NO_SUPPORTED_NOTIFIERS if _data.empty?
-      end
-
-      def available
-        _data.map { |entry| [_to_module(entry[:name]), entry[:options]] }
-      end
-
-      def add(name, opts)
-        klass = _to_module(name)
-        return false unless klass
-
-        all = @environment.notifiers
-
-        # Silently skip if it's already available, because otherwise
-        # we'd have to do :turn_off, then configure, then :turn_on
-        names = all.map(&:first).map(&:last)
-        unless names.include?(name)
-          return false unless klass.available?(opts)
-          @environment.notifiers = all << { name: name, options: opts }
-          true
-        end
-
-        # Just overwrite the options (without turning the notifier off or on),
-        # so those options will be passed in next calls to notify()
-        all.each { |item| item[:options] = opts if item[:name] == name }
-        true
-      end
-
-      def _to_module(name)
-        @supported.each do |group|
-          next unless (notifier = group.detect { |n, _| n == name })
-          return notifier.last
-        end
-        nil
-      end
-
-      def _data
-        @environment.notifiers || []
-      end
-    end
-  end
-end

data/lib/guard/notifiers/base.rb

@@ -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/emacs.rb

@@ -1,99 +0,0 @@
-require "guard/notifiers/base"
-require "guard/sheller"
-
-module Guard
-  module Notifier
-    # Send a notification to Emacs with emacsclient
-    # (http://www.emacswiki.org/emacs/EmacsClient).
-    #
-    # @example Add the `:emacs` notifier to your `Guardfile`
-    #   notification :emacs
-    #
-    class Emacs < Base
-      DEFAULTS = {
-        client:    "emacsclient",
-        success:   "ForestGreen",
-        failed:    "Firebrick",
-        default:   "Black",
-        fontcolor: "White",
-      }
-
-      def self.available?(opts = {})
-        return false unless super
-
-        client_name = opts.fetch(:client, DEFAULTS[:client])
-        cmd = "#{client_name} --eval '1' 2> #{IO::NULL} || echo 'N/A'"
-        stdout = Sheller.stdout(cmd)
-        return false if stdout.nil?
-        !%w(N/A 'N/A').include?(stdout.chomp)
-      end
-
-      # Shows 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] opts additional notification library options
-      # @option opts [String] success the color to use for success
-      #   notifications (default is 'ForestGreen')
-      # @option opts [String] failed the color to use for failure
-      #   notifications (default is 'Firebrick')
-      # @option opts [String] pending the color to use for pending
-      #   notifications
-      # @option opts [String] default the default color to use (default is
-      #   'Black')
-      # @option opts [String] client the client to use for notification
-      #   (default is 'emacsclient')
-      # @option opts [String, Integer] priority specify an int or named key
-      #   (default is 0)
-      #
-      def notify(message, opts = {})
-        super
-
-        opts      = DEFAULTS.merge(opts)
-        color     = emacs_color(opts[:type], opts)
-        fontcolor = emacs_color(:fontcolor, opts)
-        elisp = <<-EOF.gsub(/\s+/, " ").strip
-          (set-face-attribute 'mode-line nil
-               :background "#{color}"
-               :foreground "#{fontcolor}")
-        EOF
-
-        _run_cmd(opts[:client], "--eval", elisp)
-      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
-      # @param [Hash] options aditional notification options
-      #
-      # @option options [String] success the color to use for success
-      # notifications (default is 'ForestGreen')
-      #
-      # @option options [String] failed the color to use for failure
-      # notifications (default is 'Firebrick')
-      #
-      # @option options [String] pending the color to use for pending
-      # notifications
-      #
-      # @option options [String] default the default color to use (default is
-      # 'Black')
-      #
-      # @return [String] the name of the emacs color
-      #
-      def emacs_color(type, options = {})
-        default = options.fetch(:default, DEFAULTS[:default])
-        options.fetch(type.to_sym, default)
-      end
-
-      private
-
-      def _run_cmd(cmd, *args)
-        Sheller.run(cmd, *args)
-      end
-    end
-  end
-end

data/lib/guard/notifiers/file_notifier.rb

@@ -1,54 +0,0 @@
-require "guard/notifiers/base"
-
-module Guard
-  module Notifier
-    # Writes Guard notification results to a file.
-    #
-    # @example Add the `:file` notifier to your `Guardfile`
-    #   notification :file, path: 'tmp/guard_result'
-    #
-    class FileNotifier < Base
-      DEFAULTS = {
-        format: "%s\n%s\n%s\n"
-      }
-
-      # @param [Hash] opts some options
-      # @option opts [Boolean] path the path to a file where Guard notification
-      #   results will be written
-      #
-      def self.available?(opts = {})
-        super && opts.has_key?(:path)
-      end
-
-      # Writes the notification to a file. By default it writes type, title,
-      # and message separated by newlines.
-      #
-      # @param [String] message the notification message body
-      # @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
-      # @option opts [String] format printf style format for file contents
-      # @option opts [String] path the path of where to write the file
-      #
-      def notify(message, opts = {})
-        super
-
-        if opts[:path]
-          format = opts.fetch(:format, DEFAULTS[:format])
-
-          _write(opts[:path], format % [opts[:type], opts[:title], message])
-        else
-          ::Guard::UI.error ":file notifier requires a :path option"
-        end
-      end
-
-      private
-
-      def _write(path, contents)
-        File.write(path, contents)
-      end
-    end
-  end
-end