guard 2.10.0 → 2.10.1

data/lib/guard/deprecated/guard.rb.orig

@@ -1,178 +0,0 @@
-require "guard/config"
-fail "Deprecations disabled (strict mode)" if Guard::Config.new.strict?
-
-require "guard/ui"
-require "guard/plugin_util"
-require "guard/guardfile/evaluator"
-
-module Guard
-  # @deprecated Every method in this module is deprecated
-  module Deprecated
-    module Guard
-      def self.add_deprecated(klass)
-        klass.send(:extend, ClassMethods)
-      end
-
-      module ClassMethods
-        MORE_INFO_ON_UPGRADING_TO_GUARD_2 = <<-EOS.gsub(/^\s*/, "")
-          For more information on how to upgrade for Guard 2.0, please head
-          over to: https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0%s
-        EOS
-
-        # @deprecated Use `Guard.plugins(filter)` instead.
-        #
-        # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
-        #   upgrade for Guard 2.0
-        #
-        GUARDS = <<-EOS.gsub(/^\s*/, "")
-          Starting with Guard 2.0 'Guard.guards(filter)' is deprecated.
-
-          Please use 'Guard.plugins(filter)' instead.
-
-            #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods"}
-        EOS
-
-        def guards(filter = nil)
-          ::Guard::UI.deprecation(GUARDS)
-          plugins(filter)
-        end
-
-        # @deprecated Use `Guard.add_plugin(name, options = {})` instead.
-        #
-        # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
-        #   upgrade for Guard 2.0
-        #
-        ADD_GUARD = <<-EOS.gsub(/^\s*/, "")
-          Starting with Guard 2.0 'Guard.add_guard(name, options = {})' is
-          deprecated.
-
-          Please use 'Guard.add_plugin(name, options = {})' instead.
-
-        #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods"}
-        EOS
-
-        def add_guard(*args)
-          ::Guard::UI.deprecation(ADD_GUARD)
-          add_plugin(*args)
-        end
-
-        # @deprecated Use
-        #   `Guard::PluginUtil.new(name).plugin_class(fail_gracefully:
-        #   fail_gracefully)` instead.
-        #
-        # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
-        #   upgrade for Guard 2.0
-        #
-        GET_GUARD_CLASS = <<-EOS.gsub(/^\s*/, "")
-          Starting with Guard 2.0 'Guard.get_guard_class(name, fail_gracefully
-          = false)' is deprecated and is now always on.
-
-          Please use 'Guard::PluginUtil.new(name).plugin_class(fail_gracefully:
-          fail_gracefully)' instead.
-
-        #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods"}
-        EOS
-
-        def get_guard_class(name, fail_gracefully = false)
-          UI.deprecation(GET_GUARD_CLASS)
-          PluginUtil.new(name).plugin_class(fail_gracefully: fail_gracefully)
-        end
-
-        # @deprecated Use `Guard::PluginUtil.new(name).plugin_location` instead.
-        #
-        # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
-        #   upgrade for Guard 2.0
-        #
-        LOCATE_GUARD = <<-EOS.gsub(/^\s*/, "")
-          Starting with Guard 2.0 'Guard.locate_guard(name)' is deprecated.
-
-          Please use 'Guard::PluginUtil.new(name).plugin_location' instead.
-
-        #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods"}
-        EOS
-
-        def locate_guard(name)
-          UI.deprecation(LOCATE_GUARD)
-          PluginUtil.new(name).plugin_location
-        end
-
-        # @deprecated Use `Guard::PluginUtil.plugin_names` instead.
-        #
-        # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
-        #   upgrade for Guard 2.0
-        #
-        # Deprecator message for the `Guard.guard_gem_names` method
-        GUARD_GEM_NAMES = <<-EOS.gsub(/^\s*/, "")
-          Starting with Guard 2.0 'Guard.guard_gem_names' is deprecated.
-
-          Please use 'Guard::PluginUtil.plugin_names' instead.
-
-        #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods"}
-        EOS
-
-        def guard_gem_names
-          UI.deprecation(GUARD_GEM_NAMES)
-          PluginUtil.plugin_names
-        end
-
-        RUNNING = <<-EOS.gsub(/^\s*/, "")
-          Starting with Guard 2.7.1 it was discovered that Guard.running was
-          never initialized or used internally.
-        EOS
-
-        def running
-          UI.deprecation(RUNNING)
-          nil
-        end
-
-        LOCK = <<-EOS.gsub(/^\s*/, "")
-          Starting with Guard 2.7.1 it was discovered that this accessor was
-          never initialized or used internally.
-        EOS
-        def lock
-          UI.deprecation(LOCK)
-        end
-
-        EVALUATOR = <<-EOS.gsub(/^\s*/, "")
-          Starting with Guard 2.8.2 this method shouldn't be used
-        EOS
-
-        def evaluator
-          UI.deprecation(EVALUATOR)
-          options = ::Guard.state.session.evaluator_options
-          ::Guard::Guardfile::Evaluator.new(options)
-        end
-
-        RESET_EVALUATOR = <<-EOS.gsub(/^\s*/, "")
-          Starting with Guard 2.8.2 this method shouldn't be used
-        EOS
-
-        def reset_evaluator(_options)
-          UI.deprecation(RESET_EVALUATOR)
-        end
-
-        RUNNER = <<-EOS.gsub(/^\s*/, "")
-          Starting with Guard 2.8.2 this method shouldn't be used
-        EOS
-
-        def runner
-          UI.deprecation(RUNNER)
-          ::Guard::Runner.new
-        end
-
-        EVALUATE_GUARDFILE = <<-EOS.gsub(/^\s*/, "")
-          Starting with Guard 2.8.2 this method shouldn't be used
-        EOS
-
-        def evaluate_guardfile
-          UI.deprecation(EVALUATE_GUARDFILE)
-          options = ::Guard.state.session.evaluator_options
-          evaluator = ::Guard::Guardfile::Evaluator.new(options)
-          evaluator.evaluate
-          msg = "No plugins found in Guardfile, please add at least one."
-          ::Guard::UI.error msg if _pluginless_guardfile?
-        end
-      end
-    end
-  end
-end

data/lib/guard/dsl_describer.rb.orig

@@ -1,188 +0,0 @@
-# encoding: utf-8
-require "formatador"
-
-require "guard/guardfile/evaluator"
-require "guard/ui"
-require "guard/metadata"
-
-module Guard
-  # The DslDescriber evaluates the Guardfile and creates an internal structure
-  # of it that is used in some inspection utility methods like the CLI commands
-  # `show` and `list`.
-  #
-  # @see Guard::Dsl
-  # @see Guard::CLI
-  #
-  class DslDescriber
-    # Initializes a new DslDescriber object.
-    #
-    # @option options [String] guardfile the path to a valid Guardfile
-    #
-    # @option options [String] guardfile_contents a string representing the
-    # content of a valid Guardfile
-    #
-    # @see Guard::Guardfile::Evaluator#initialize
-    #
-    def initialize(options = {})
-      ::Guard.reset_groups
-      ::Guard.reset_plugins
-      ::Guard.reset_scope
-      ::Guard.reset_options(options)
-    end
-
-    # List the Guard plugins that are available for use in your system and marks
-    # those that are currently used in your `Guardfile`.
-    #
-    # @see CLI#list
-    #
-    def list
-      _evaluate_guardfile
-      names = ::Guard::PluginUtil.plugin_names.sort.uniq
-      final_rows = names.inject([]) do |rows, name|
-        used = ::Guard.plugins(name).any?
-        rows << {
-          Plugin: name.capitalize,
-          Guardfile: used ? "✔" : "✘"
-        }
-      end
-
-      Formatador.display_compact_table(final_rows, [:Plugin, :Guardfile])
-    end
-
-    # Shows all Guard plugins and their options that are defined in
-    # the `Guardfile`.
-    #
-    # @see CLI#show
-    #
-    def show
-      _evaluate_guardfile
-      groups = ::Guard.groups
-
-      final_rows = groups.each_with_object([]) do |group, rows|
-
-        plugins = Array(::Guard.plugins(group: group.name))
-
-        plugins.each do |plugin|
-          options = plugin.options.inject({}) do |o, (k, v)|
-            o.tap { |option| option[k.to_s] = v }
-          end.sort
-
-          if options.empty?
-            rows << :split
-            rows << {
-              Group: group.title,
-              Plugin: plugin.title,
-              Option: "",
-              Value: ""
-            }
-          else
-            options.each_with_index do |(option, value), index|
-              if index == 0
-                rows << :split
-                rows << {
-                  Group: group.title,
-                  Plugin: plugin.title,
-                  Option: option.to_s,
-                  Value: value.inspect
-                }
-              else
-                rows << {
-                  Group: "",
-                  Plugin: "",
-                  Option: option.to_s,
-                  Value: value.inspect
-                }
-              end
-            end
-          end
-        end
-
-        rows
-      end
-
-      Formatador.display_compact_table(
-        final_rows.drop(1),
-        [:Group, :Plugin, :Option, :Value]
-      )
-    end
-
-    # Shows all notifiers and their options that are defined in
-    # the `Guardfile`.
-    #
-    # @see CLI#show
-    #
-    def notifiers
-      _evaluate_guardfile
-
-      supported = ::Guard::Notifier::SUPPORTED
-      Notifier.connect
-      detected = Notifier.notifiers
-      Notifier.disconnect
-
-      merged_notifiers = supported.inject(:merge)
-      final_rows = merged_notifiers.each_with_object([]) do |definition, rows|
-
-        name      = definition[0]
-        clazz     = definition[1]
-        available = clazz.available?(silent: true) ? "✔" : "✘"
-        notifier  = detected.detect { |n| n[:name] == name }
-        used      = notifier ? "✔" : "✘"
-
-        options = _merge_options(clazz, notifier)
-        options.delete(:silent)
-
-        if options.empty?
-          rows << :split
-          _add_row(rows, name, available, used, "", "")
-        else
-          options.each_with_index do |(option, value), index|
-            if index == 0
-              rows << :split
-              _add_row(rows, name, available, used, option.to_s, value.inspect)
-            else
-              _add_row(rows, "", "", "", option.to_s, value.inspect)
-            end
-          end
-        end
-
-        rows
-      end
-
-      Formatador.display_compact_table(
-        final_rows.drop(1),
-        [:Name, :Available, :Used, :Option, :Value]
-      )
-    end
-
-    private
-
-    # Evaluates the `Guardfile` by delegating to
-    #   {Guard::Guardfile::Evaluator#evaluate_guardfile}.
-    #
-    def _evaluate_guardfile
-      ::Guard.save_scope
-      ::Guard::Guardfile::Evaluator.new(::Guard.options).evaluate_guardfile
-      ::Guard.restore_scope
-    end
-
-    def _merge_options(klass, notifier)
-      notify_options = notifier ? notifier[:options] : {}
-
-      if klass.const_defined?(:DEFAULTS)
-        klass.const_get(:DEFAULTS).merge(notify_options)
-      else
-        notify_options
-      end
-    end
-
-    def _add_row(rows, name, available, used, option, value)
-      rows << {
-        Name: name,
-        Available: available,
-        Used: used,
-        Option: option,
-        Value: value
-      }
-    end
-  end
-end

data/lib/guard/notifier.rb.orig

@@ -1,247 +0,0 @@
-require "yaml"
-require "rbconfig"
-require "pathname"
-
-require_relative "internals/environment"
-require_relative "notifier/detected"
-
-require_relative "ui"
-
-module Guard
-  # The notifier handles sending messages to different notifiers. Currently the
-  # following
-  # libraries are supported:
-  #
-  # * Ruby GNTP
-  # * Growl
-  # * Libnotify
-  # * rb-notifu
-  # * emacs
-  # * Terminal Notifier
-  # * Terminal Title
-  # * Tmux
-  #
-  # Please see the documentation of each notifier for more information about
-  # the requirements
-  # and configuration possibilities.
-  #
-  # Guard knows four different notification types:
-  #
-  # * success
-  # * pending
-  # * failed
-  # * notify
-  #
-  # The notification type selection is based on the image option that is
-  # sent to {#notify}. Each image type has its own notification type, and
-  # notifications with custom images goes all sent as type `notify`. The
-  # `gntp` notifier is able to register these types
-  # at Growl and allows customization of each notification type.
-  #
-  # Guard can be configured to make use of more than one notifier at once.
-  #
-  # @see Guard::Dsl
-  #
-  # TODO: rename to plural
-  module Notifier
-    extend self
-
-    NOTIFICATIONS_DISABLED = "Notifications disabled by GUARD_NOTIFY" +
-      " environment variable"
-
-    USING_NOTIFIER = "Guard is using %s to send notifications."
-
-    ONLY_NOTIFY = "Only notify() is available from a child process"
-
-    DEPRECTED_IMPLICIT_CONNECT = "Calling Guard::Notifier.notify()" +
-      " without a prior Notifier.connect() is deprecated"
-
-    # List of available notifiers, grouped by functionality
-    SUPPORTED = [
-      {
-        gntp: GNTP,
-        growl: Growl,
-        terminal_notifier: TerminalNotifier,
-        libnotify: Libnotify,
-        notifysend: NotifySend,
-        notifu: Notifu
-      },
-      { emacs: Emacs },
-      { tmux: Tmux },
-      { terminal_title: TerminalTitle },
-      { file: FileNotifier }
-    ]
-
-    class NotServer < RuntimeError
-    end
-
-    def connect(options = {})
-      @detected = Detected.new(SUPPORTED)
-      return if _client?
-
-      _env.notify_pid = $$
-
-      fail "Already connected" if active?
-
-      return unless enabled? && options[:notify]
-
-      turn_on
-    rescue Detected::NoneAvailableError => e
-      ::Guard::UI.info e.to_s
-    end
-
-    def disconnect
-      if _client?
-        @detected = nil
-        return
-      end
-
-      turn_off if active?
-      @detected.reset
-      _env.notify_pid = nil
-      @detected = nil
-    end
-
-    # Turn notifications on.
-    #
-    # @param [Hash] options the turn_on options
-    # @option options [Boolean] silent disable any logging
-    #
-    def turn_on(opts = {})
-      _check_server!
-      return unless enabled?
-
-      fail "Already active!" if active?
-
-      silent = opts[:silent]
-
-      @detected.available.each do |klass, _|
-        ::Guard::UI.info(format(USING_NOTIFIER, klass.title)) unless silent
-        klass.turn_on if klass.respond_to?(:turn_on)
-      end
-
-      _env.notify_active = true
-    end
-
-    # Turn notifications off.
-    def turn_off
-      _check_server!
-
-      fail "Not active!" unless active?
-
-      @detected.available.each do |klass, _|
-        klass.turn_off if klass.respond_to?(:turn_off)
-      end
-
-      _env.notify_active = false
-    end
-
-    # Toggle the system notifications on/off
-    def toggle
-      unless enabled?
-        ::Guard::UI.error NOTIFICATIONS_DISABLED
-        return
-      end
-
-      if active?
-        ::Guard::UI.info "Turn off notifications"
-        turn_off
-        return
-      end
-
-      turn_on
-    end
-
-    # Test if the notifications can be enabled based on ENV['GUARD_NOTIFY']
-    def enabled?
-      _env.notify?
-    end
-
-    # Test if notifiers are currently turned on
-    def active?
-      _env.notify_active?
-    end
-
-    # Add a notification library to be used.
-    #
-    # @param [Symbol] name the name of the notifier to use
-    # @param [Hash] options the notifier options
-    # @option options [String] silent disable any error message
-    # @return [Boolean] if the notification could be added
-    #
-    def add(name, opts = {})
-      _check_server!
-
-      return false unless enabled?
-
-      if name == :off && active?
-        turn_off
-        return false
-      end
-
-      # ok to pass new instance when called without connect (e.g. evaluator)
-      (@detected || Detected.new(SUPPORTED)).add(name, opts)
-    end
-
-    # TODO: deprecate/remove
-    alias :add_notifier  :add
-
-    # Show a system notification with all configured notifiers.
-    #
-    # @param [String] message the message to show
-    # @option opts [Symbol, String] image the image symbol or path to an image
-    # @option opts [String] title the notification title
-    #
-    def notify(message, message_opts = {})
-      if _client?
-        # TODO: remove
-        UI.deprecation(DEPRECTED_IMPLICIT_CONNECT)
-        return unless enabled?
-        connect(notify: true)
-      else
-        return unless active?
-      end
-
-      @detected.available.each do |klass, options|
-        _notify(klass, options, message, message_opts)
-      end
-    end
-
-    # Used by dsl describer
-    def notifiers
-      @detected.available.map { |mod, opts| { name: mod.name, options: opts } }
-    end
-
-    private
-
-    def _env
-      (@environment ||= _create_env)
-    end
-
-    def _create_env
-      Internals::Environment.new("GUARD").tap do |env|
-        env.create_method(:notify?) { |data| data != "false" }
-        env.create_method(:notify_pid) { |data| data && Integer(data) }
-        env.create_method(:notify_pid=)
-        env.create_method(:notify_active?)
-        env.create_method(:notify_active=)
-      end
-    end
-
-    def _check_server!
-      _client? && fail(NotServer, ONLY_NOTIFY)
-    end
-
-    def _client?
-      (pid = _env.notify_pid) && (pid != $$)
-    end
-
-    def _notify(klass, options, message, message_options)
-      notifier = klass.new(options)
-      notifier.notify(message, message_options.dup)
-    rescue RuntimeError => e
-      ::Guard::UI.error "Notification failed for #{notifier.name}: #{e.message}"
-      ::Guard::UI.debug e.backtrace.join("\n")
-    end
-  end
-end