guard 2.10.1 → 2.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 100b160735c5c331821d9fa8119bb168ed5f907e
-  data.tar.gz: d677f7e1a7491ff72654d415d7c571f028fbef52
+  metadata.gz: 3106af4e3722da1f4bd41e051e5baf1ff8ace4f7
+  data.tar.gz: 0ef587f058e7f02bc5b4195a0b3b3b4d25847ddd
 SHA512:
-  metadata.gz: 0dcad099ca8bd1dca2486e078233215366c4236b8a1b0b465336d020667e041bd16e75df106efeef75a6013fcdb9601fdd35bd28eac8130c4eb3a910694004a3
-  data.tar.gz: 835a20ae288b6c660d9cb058eeba5b2c25f999bc3790c0dfb0ccf48a7816eff2405fe82e26cc9884b2397f02a610ba73f848c63bf89eb478fd94aae632ff31f7
+  metadata.gz: b5f3825c29f9c01f14b50051055e105a3695288da0ce2ba2d42fdd4e4af92881afb455515da551a1faaf192b28ba8eb2e599f0640002ff9c1d2d8db0796c734a
+  data.tar.gz: c107a499ff6e9814b536a9c1f723c5a7badc97e33f74ae8409f5b72d082fff63c09d3eac630cd9b6b12c9591ed1210b907ea05680f2b615d62bcde31b2eb5784

data/lib/guard/plugin_util.rb

@@ -168,6 +168,7 @@ module Guard
     end
 
     def self._gem_valid?(gem)
+      return false if gem.name == "guard-compat"
       return true if gem.name =~ /^guard-/
       full_path = gem.full_gem_path
       file = File.join(full_path, "lib", "guard", "#{gem.name}.rb")

data/lib/guard/plugin_util.rb.orig

@@ -0,0 +1,182 @@
+require "guard/ui"
+
+module Guard
+  # This class contains useful methods to:
+  #
+  # * Fetch all the Guard plugins names;
+  # * Initialize a plugin, get its location;
+  # * Return its class name;
+  # * Add its template to the Guardfile.
+  #
+  class PluginUtil
+    ERROR_NO_GUARD_OR_CLASS = "Could not load 'guard/%s' or'\
+    ' find class Guard::%s"
+
+    INFO_ADDED_GUARD_TO_GUARDFILE = "%s guard added to Guardfile,"\
+      " feel free to edit it"
+
+    attr_accessor :name
+
+    # Returns a list of Guard plugin Gem names installed locally.
+    #
+    # @return [Array<String>] a list of Guard plugin gem names
+    #
+    def self.plugin_names
+      valid = Gem::Specification.find_all.select do |gem|
+        _gem_valid?(gem)
+      end
+
+      valid.map { |x| x.name.sub(/^guard-/, "") }.uniq
+    end
+
+    # Initializes a new `Guard::PluginUtil` object.
+    #
+    # @param [String] name the name of the Guard plugin
+    #
+    def initialize(name)
+      @name = name.to_s.sub(/^guard-/, "")
+    end
+
+    # Initializes a new `Guard::Plugin` with the given `options` hash. This
+    # methods handles plugins that inherit from the deprecated `Guard::Guard`
+    # class as well as plugins that inherit from `Guard::Plugin`.
+    #
+    # @see Guard::Plugin
+    # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
+    # upgrade for Guard 2.0
+    #
+    # @return [Guard::Plugin] the initialized plugin
+    # @return [Guard::Guard] the initialized plugin. This return type is
+    #   deprecated and the plugin's maintainer should update it to be
+    #   compatible with Guard 2.0. 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
+    #
+    def initialize_plugin(options)
+      klass = plugin_class
+      fail "Could not load class: #{_constant_name.inspect}" unless klass
+      if klass.superclass.to_s == "Guard::Guard"
+        klass.new(options.delete(:watchers), options)
+      else
+        begin
+          klass.new(options)
+        rescue ArgumentError => e
+          fail "Failed to call #{klass}.new(options): #{e}"
+        end
+      end
+    end
+
+    # Locates a path to a Guard plugin gem.
+    #
+    # @return [String] the full path to the plugin gem
+    #
+    def plugin_location
+      @plugin_location ||= _full_gem_path("guard-#{name}")
+    rescue Gem::LoadError
+      ::Guard::UI.error "Could not find 'guard-#{ name }' gem path."
+    end
+
+    # Tries to load the Guard plugin main class. This transforms the supplied
+    # plugin name into a class name:
+    #
+    # * `guardname` will become `Guard::Guardname`
+    # * `dashed-guard-name` will become `Guard::DashedGuardName`
+    # * `underscore_guard_name` will become `Guard::UnderscoreGuardName`
+    #
+    # When no class is found with the strict case sensitive rules, another
+    # try is made to locate the class without matching case:
+    #
+    # * `rspec` will find a class `Guard::RSpec`
+    #
+    # @option options [Boolean] fail_gracefully whether error messages should
+    # not be printed
+    #
+    # @return [Class, nil] the loaded class
+    #
+    def plugin_class(options = {})
+      options = { fail_gracefully: false }.merge(options)
+
+      const = _plugin_constant
+      fail TypeError, "no constant: #{_constant_name}" unless const
+      @plugin_class ||= Guard.const_get(const)
+
+    rescue TypeError
+      begin
+        require "guard/#{ name.downcase }"
+        const = _plugin_constant
+        @plugin_class ||= Guard.const_get(const)
+
+      rescue TypeError => error
+        UI.error "Could not find class Guard::#{ _constant_name }"
+        UI.error error.backtrace.join("\n")
+      rescue LoadError => error
+        unless options[:fail_gracefully]
+          UI.error ERROR_NO_GUARD_OR_CLASS % [name.downcase, _constant_name]
+          UI.error "Error is: #{error}"
+          UI.error error.backtrace.join("\n")
+        end
+      end
+    end
+
+    # Adds a plugin's template to the Guardfile.
+    #
+    def add_to_guardfile
+      klass = plugin_class # call here to avoid failing later
+
+      require "guard/guardfile/evaluator"
+      # TODO: move this to Generator?
+      options = Guard.state.session.evaluator_options
+      evaluator = Guardfile::Evaluator.new(options)
+      evaluator.evaluate
+      if evaluator.guardfile_include?(name)
+        UI.info "Guardfile already includes #{ name } guard"
+      else
+        content = File.read("Guardfile")
+        File.open("Guardfile", "wb") do |f|
+          f.puts(content)
+          f.puts("")
+          f.puts(klass.template(plugin_location))
+        end
+
+        UI.info INFO_ADDED_GUARD_TO_GUARDFILE % name
+      end
+    end
+
+    private
+
+    # Returns the constant for the current plugin.
+    #
+    # @example Returns the constant for a plugin
+    #   > Guard::PluginUtil.new('rspec').send(:_plugin_constant)
+    #   => Guard::RSpec
+    #
+    def _plugin_constant
+      @_plugin_constant ||= Guard.constants.detect do |c|
+        c.to_s.downcase == _constant_name.downcase
+      end
+    end
+
+    # Guesses the most probable name for the current plugin based on its name.
+    #
+    # @example Returns the most probable name for a plugin
+    #   > Guard::PluginUtil.new('rspec').send(:_constant_name)
+    #   => "Rspec"
+    #
+    def _constant_name
+      @_constant_name ||= name.gsub(/\/(.?)/) { "::#{ $1.upcase }" }.
+        gsub(/(?:^|[_-])(.)/) { $1.upcase }
+    end
+
+    def self._gem_valid?(gem)
+      return false if gem.name == 'guard-compat'
+      return true if gem.name =~ /^guard-/
+      full_path = gem.full_gem_path
+      file = File.join(full_path, "lib", "guard", "#{gem.name}.rb")
+      File.exist?(file)
+    end
+
+    def _full_gem_path(name)
+      Gem::Specification.find_by_name(name).full_gem_path
+    end
+  end
+end

data/lib/guard/ui.rb

@@ -1,5 +1,6 @@
 require "lumberjack"
 
+# TODO: remove this dep!
 require "guard/internals/state"
 
 require "guard/options"

data/lib/guard/ui.rb.orig

@@ -0,0 +1,268 @@
+require "lumberjack"
+
+require "guard/internals/state"
+
+require "guard/options"
+
+require "guard/ui/colors"
+
+require "guard/terminal"
+
+module Guard
+  # The UI class helps to format messages for the user. Everything that is
+  # logged through this class is considered either as an error message or a
+  # diagnostic message and is written to standard error ($stderr).
+  #
+  # If your Guard plugin does some output that is piped into another process
+  # for further processing, please just write it to STDOUT with `puts`.
+  #
+  module UI
+    include Colors
+
+    class << self
+      # Get the Guard::UI logger instance
+      #
+      def logger
+        @logger ||= begin
+                      Lumberjack::Logger.new(
+                        options.fetch(:device) { $stderr },
+                        options)
+                    end
+      end
+
+      # Since logger is global, for Aruba in-process to properly
+      # separate output between calls, we need to reset
+      #
+      # We don't use logger=() since it's expected to be a Lumberjack instance
+      def reset_logger
+        @logger = nil
+      end
+
+      # Get the logger options
+      #
+      # @return [Hash] the logger options
+      #
+      def options
+        @options ||= ::Guard::Options.new(
+          level: :info,
+          template: ":time - :severity - :message",
+          time_format: "%H:%M:%S")
+      end
+
+      # Set the logger options
+      #
+      # @param [Hash] options the logger options
+      # @option options [Symbol] level the log level
+      # @option options [String] template the logger template
+      # @option options [String] time_format the time format
+      #
+      # TODO: deprecate?
+      def options=(options)
+        @options = ::Guard::Options.new(options)
+      end
+
+      # Assigns a log level
+      def level=(new_level)
+        logger.level = new_level
+      end
+
+      # Show an info message.
+      #
+      # @param [String] message the message to show
+      # @option options [Boolean] reset whether to clean the output before
+      # @option options [String] plugin manually define the calling plugin
+      #
+      def info(message, options = {})
+        _filtered_logger_message(message, :info, nil, options)
+      end
+
+      # Show a yellow warning message that is prefixed with WARNING.
+      #
+      # @param [String] message the message to show
+      # @option options [Boolean] reset whether to clean the output before
+      # @option options [String] plugin manually define the calling plugin
+      #
+      def warning(message, options = {})
+        _filtered_logger_message(message, :warn, :yellow, options)
+      end
+
+      # Show a red error message that is prefixed with ERROR.
+      #
+      # @param [String] message the message to show
+      # @option options [Boolean] reset whether to clean the output before
+      # @option options [String] plugin manually define the calling plugin
+      #
+      def error(message, options = {})
+        _filtered_logger_message(message, :error, :red, options)
+      end
+
+      # Show a red deprecation message that is prefixed with DEPRECATION.
+      # It has a log level of `warn`.
+      #
+      # @param [String] message the message to show
+      # @option options [Boolean] reset whether to clean the output before
+      # @option options [String] plugin manually define the calling plugin
+      #
+      def deprecation(message, options = {})
+        unless ENV["GUARD_GEM_SILENCE_DEPRECATIONS"] == "1"
+          backtrace = Thread.current.backtrace[1..5].join("\n\t >")
+          msg = format("%s\nDeprecation backtrace: %s", message, backtrace)
+          warning(msg, options)
+        end
+      end
+
+      # Show a debug message that is prefixed with DEBUG and a timestamp.
+      #
+      # @param [String] message the message to show
+      # @option options [Boolean] reset whether to clean the output before
+      # @option options [String] plugin manually define the calling plugin
+      #
+      def debug(message, options = {})
+        _filtered_logger_message(message, :debug, :yellow, options)
+      end
+
+      # Reset a line.
+      #
+      def reset_line
+        $stderr.print(color_enabled? ? "\r\e[0m" : "\r\n")
+      end
+
+      # Clear the output if clearable.
+      #
+      def clear(opts = {})
+        return unless Guard.state.session.clear?
+
+        fail "UI not set up!" if @clearable.nil?
+        return unless @clearable || opts[:force]
+
+        @clearable = false
+        Terminal.clear
+      rescue Errno::ENOENT => e
+        warning("Failed to clear the screen: #{e.inspect}")
+      end
+
+      # TODO: arguments: UI uses Guard::options anyway
+      # @private api
+      def reset_and_clear
+        @clearable = false
+        clear(force: true)
+      end
+
+      # Allow the screen to be cleared again.
+      #
+      def clearable
+        @clearable = true
+      end
+
+      # Show a scoped action message.
+      #
+      # @param [String] action the action to show
+      # @param [Hash] scope hash with a guard or a group scope
+      #
+      def action_with_scopes(action, scope)
+        titles = Guard.state.scope.titles(scope)
+        info "#{action} #{titles.join(", ")}"
+      end
+
+      private
+
+      # Filters log messages depending on either the
+      # `:only`` or `:except` option.
+      #
+      # @param [String] plugin the calling plugin name
+      # @yield When the message should be logged
+      # @yieldparam [String] param the calling plugin name
+      #
+      def _filter(plugin)
+        only   = options[:only]
+        except = options[:except]
+        plugin ||= calling_plugin_name
+
+        match = !(only || except)
+        match ||= (only && only.match(plugin))
+        match ||= (except && !except.match(plugin))
+        return unless match
+        yield plugin
+      end
+
+      # @private
+      def _filtered_logger_message(message, method, color_name, options = {})
+        message = color(message, color_name) if color_name
+
+        _filter(options[:plugin]) do |plugin|
+          reset_line if options[:reset]
+          logger.send(method, message, plugin)
+        end
+      end
+
+      # Tries to extract the calling Guard plugin name
+      # from the call stack.
+      #
+      # @param [Integer] depth the stack depth
+      # @return [String] the Guard plugin name
+      #
+      def calling_plugin_name(depth = 2)
+        name = /(guard\/[a-z_]*)(\/[a-z_]*)?.rb:/i.match(caller[depth])
+        return "Guard" unless name
+        name[1].split("/").map do |part|
+          part.split(/[^a-z0-9]/i).map(&:capitalize).join
+        end.join("::")
+      end
+
+      # Checks if color output can be enabled.
+      #
+      # @return [Boolean] whether color is enabled or not
+      #
+      def color_enabled?
+        @color_enabled_initialized ||= false
+        @color_enabled = nil unless @color_enabled_initialized
+        @color_enabled_initialized = true
+        if @color_enabled.nil?
+          if Gem.win_platform?
+            if ENV["ANSICON"]
+              @color_enabled = true
+            else
+              begin
+                require "rubygems" unless ENV["NO_RUBYGEMS"]
+                require "Win32/Console/ANSI"
+                @color_enabled = true
+              rescue LoadError
+                @color_enabled = false
+                info "Run 'gem install win32console' to use color on Windows"
+              end
+            end
+          else
+            @color_enabled = true
+          end
+        end
+
+        @color_enabled
+      end
+
+      # Colorizes a text message. See the constant in the UI class for possible
+      # color_options parameters. You can pass optionally :bright, a foreground
+      # color and a background color.
+      #
+      # @example
+      #
+      #   color('Hello World', :red, :bright)
+      #
+      # @param [String] text the text to colorize
+      # @param [Array] color_options the color options
+      #
+      def color(text, *color_options)
+        color_code = ""
+        color_options.each do |color_option|
+          color_option = color_option.to_s
+          next if color_option == ""
+
+          unless color_option =~ /\d+/
+            color_option = const_get("ANSI_ESCAPE_#{ color_option.upcase }")
+          end
+          color_code += ";" + color_option
+        end
+        color_enabled? ? "\e[0#{ color_code }m#{ text }\e[0m" : text
+      end
+    end
+  end
+end

data/lib/guard/version.rb

@@ -1,3 +1,3 @@
 module Guard
-  VERSION = "2.10.1"
+  VERSION = "2.10.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 2.10.1
+  version: 2.10.2
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-01 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -108,6 +108,7 @@ files:
 - lib/guard/commands/reload.rb
 - lib/guard/commands/scope.rb
 - lib/guard/commands/show.rb
+- lib/guard/compat/test/helper.rb.orig
 - lib/guard/config.rb
 - lib/guard/deprecated/dsl.rb
 - lib/guard/deprecated/evaluator.rb
@@ -153,6 +154,7 @@ files:
 - lib/guard/options.rb
 - lib/guard/plugin.rb
 - lib/guard/plugin_util.rb
+- lib/guard/plugin_util.rb.orig
 - lib/guard/rake_task.rb
 - lib/guard/reevaluator.rb
 - lib/guard/runner.rb
@@ -160,6 +162,7 @@ files:
 - lib/guard/templates/Guardfile
 - lib/guard/terminal.rb
 - lib/guard/ui.rb
+- lib/guard/ui.rb.orig
 - lib/guard/ui/colors.rb
 - lib/guard/version.rb
 - lib/guard/version.rb.orig