guard 2.7.2 → 2.7.3

data/lib/guard/ui.rb.orig

@@ -0,0 +1,278 @@
+require "lumberjack"
+
+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
+      #
+      def options=(options)
+        @options = ::Guard::Options.new(options)
+      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 = {})
+        msg = "neither ::Guard.setup nor ::Guard.reset_options was called"
+        fail msg if ::Guard.options.nil?
+        warning(message, options) if ::Guard.options[:show_deprecations]
+      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.options[:clear]
+
+        fail "UI not set up!" if @clearable.nil?
+        return unless @clearable || opts[:force]
+
+        @clearable = false
+        ::Guard::Terminal.clear
+      rescue Errno::ENOENT => e
+        warning("Failed to clear the screen: #{e.inspect}")
+      end
+
+      # TODO: arguments: UI uses Guard::options anyway
+      def setup(_options)
+        @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)
+        first_non_blank_scope = _first_non_blank_scope(scope)
+        unless first_non_blank_scope.nil?
+          scope_message = first_non_blank_scope.map(&:title).join(", ")
+        end
+
+        info "#{ action } #{ scope_message || "all" }"
+      end
+
+      private
+
+      # Returns the first non-blank scope by searching in the given `scope`
+      # hash and in Guard.scope. Returns nil if no non-blank scope is found.
+      #
+      def _first_non_blank_scope(scope)
+        [:plugins, :groups].each do |scope_name|
+          s = scope[scope_name] || ::Guard.scope[scope_name]
+          return s if !s.nil? && !s.empty?
+        end
+
+        nil
+      end
+
+      # 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
+
+      # Display a message of the type `method` and with the color `color_name`
+      # (no color by default) conditionnaly given a `plugin_name`.
+      #
+      # @param [String] plugin_name the calling plugin name
+      # @option options [Boolean] reset whether to clean the output before
+      # @option options [String] plugin manually define the calling plugin
+      #
+      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.7.2"
+  VERSION = "2.7.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 2.7.2
+  version: 2.7.3
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2014-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -97,25 +97,36 @@ files:
 - images/pending.png
 - images/success.png
 - lib/guard.rb
+- lib/guard.rb.orig
 - lib/guard/aruba_adapter.rb
 - lib/guard/cli.rb
+- lib/guard/cli.rb.orig
 - lib/guard/commander.rb
+- lib/guard/commander.rb.orig
 - lib/guard/commands/all.rb
+- lib/guard/commands/all.rb.orig
 - lib/guard/commands/change.rb
 - lib/guard/commands/notification.rb
 - lib/guard/commands/pause.rb
 - lib/guard/commands/reload.rb
+- lib/guard/commands/reload.rb.orig
 - lib/guard/commands/scope.rb
+- lib/guard/commands/scope.rb.orig
 - lib/guard/commands/show.rb
 - lib/guard/deprecated_methods.rb
+- lib/guard/deprecated_methods.rb.orig
 - lib/guard/deprecator.rb
+- lib/guard/deprecator.rb.orig
 - lib/guard/dsl.rb
 - lib/guard/dsl_describer.rb
 - lib/guard/dsl_describer.rb.orig
 - lib/guard/group.rb
 - lib/guard/guard.rb
+- lib/guard/guard.rb.orig
 - lib/guard/guardfile.rb
+- lib/guard/guardfile.rb.orig
 - lib/guard/guardfile/evaluator.rb
+- lib/guard/guardfile/evaluator.rb.orig
 - lib/guard/guardfile/generator.rb
 - lib/guard/interactor.rb
 - lib/guard/jobs/base.rb
@@ -123,6 +134,7 @@ files:
 - lib/guard/jobs/sleep.rb
 - lib/guard/notifier.rb
 - lib/guard/notifiers/base.rb
+- lib/guard/notifiers/base.rb.orig
 - lib/guard/notifiers/emacs.rb
 - lib/guard/notifiers/file_notifier.rb
 - lib/guard/notifiers/gntp.rb
@@ -138,14 +150,18 @@ files:
 - lib/guard/plugin/base.rb
 - lib/guard/plugin/hooker.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
+- lib/guard/runner.rb.orig
 - lib/guard/setuper.rb
+- lib/guard/setuper.rb.orig
 - lib/guard/sheller.rb
 - 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