guard 2.7.3 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fe4d02f1b032eb80f48d28b9e2a96cedc706a8d
-  data.tar.gz: 8835c817d58724daa4838a98688300cbde8c6118
+  metadata.gz: 0b526a83a981a77336113761579089329aad8a71
+  data.tar.gz: 66bee09b0f816bbd18092b115ca7e402c6df6382
 SHA512:
-  metadata.gz: 42b4e420d55c5344df40f26ca6005da64cce67014d4dc06cbb08db146231fcb56c28a2b2c8a89434c3921e83cf3e946c8dcf3c821281fc948b038c5feb2a962c
-  data.tar.gz: 793aa5c2052dd4d37778b6361ceddd42a1e50d8ad4cd7eac1b4434955dfc6d7afadc94cdf6f96a2e0895fd2f26b05e138ab05d25cacf83d36a664221b3469215
+  metadata.gz: 2845651127734112e666e48c11dbeba3d1a2b88ac350441f9b5fc9a40213bbfc3c9307a8982cf57a522001d8567a6ca14e5b419736806bcaa365d58135712ac1
+  data.tar.gz: 023b5f58b9a20b19d566b49e413b71b12195c4432bba7bb66321f98e3aa1a146235e20ce6ae9fbd5aa9c4349ae6b8d68bd1962f979bacfb4313bf061c1af13b4

data/README.md

@@ -293,9 +293,10 @@ $ bundle exec guard start --no-bundler-warning
 
 #### `--show-deprecations`
 
-Turn on deprecation warnings.
+This option is deprecated. No, seriously! Deprecations are now always shown.
+
+(To *really* hide them, set the environment variable `GUARD_GEM_SILENCE_DEPRECATIONS=1`)
 
-*NOTE: They are OFF by default (see: [#298](https://github.com/guard/guard/issues/298))*
 
 #### `-l`/`--latency` option
 

data/lib/guard/cli.rb

@@ -70,10 +70,11 @@ module Guard
                   aliases: "-B",
                   banner: "Turn off warning when Bundler is not present"
 
+    # DEPRECATED
     method_option :show_deprecations,
                   type: :boolean,
                   default: false,
-                  banner: "Turn on deprecation warnings"
+                  banner: "DEPRECATED: it does nothing"
 
     # Listen options
     method_option :latency,

data/lib/guard/deprecated_methods.rb

@@ -62,7 +62,8 @@ module Guard
     end
 
     def evaluator
-      UI.deprecation(Deprecator::GUARD_EVALUATOR_DEPRECATION)
+      # TODO: probably deprecate once it isn't used internally
+      # UI.deprecation(Deprecator::GUARD_EVALUATOR_DEPRECATION)
       # TODO: this will be changed to the following when scope is reworked
       # ::Guard.session.evaluator
       ::Guard.instance_variable_get(:@evaluator)

data/lib/guard/deprecator.rb

@@ -2,7 +2,8 @@ require "guard/ui"
 
 module Guard
   class Deprecator
-    UPGRADE_WIKI = "https://github.com/guard/guard/wiki"\
+    UPGRADE_WIKI =
+      "https://github.com/guard/guard/wiki" +
       "/Upgrade-guide-for-existing-guards-to-Guard-v1.1"
 
     MORE_INFO_ON_UPGRADING_TO_GUARD_1_1 = <<-EOS.gsub(/^\s*/, "")
@@ -128,10 +129,5 @@ module Guard
       Starting with Guard 2.7.1 it was discovered that this accessor was never
       initialized or used internally.
     EOS
-
-    GUARD_EVALUATOR_DEPRECATION = <<-EOS.gsub(/^\s*/, "")
-      Starting with Guard 2.7.1 ::Guard.session.evaluator should be used
-      instead.
-    EOS
   end
 end

data/lib/guard/guard.rb

@@ -1,5 +1,63 @@
 require "guard/plugin/base"
 
+module Guard
+  unless ENV["GUARD_GEM_SILENCE_DEPRECATIONS"] == "1"
+
+    UPGRADE_WIKI_URL =
+      "https://github.com/guard/guard/"  +
+      "wiki/Upgrading-to-Guard-2.0#changes-in-guardguard"
+
+    STDERR.puts <<-EOS
+
+    ******** BIG DEPRECATION WARNING !! ********
+
+    Hi, Guard here.
+
+    You're including lib/guard/guard.rb ...
+
+    ... which contains code deprecated over a year ago!
+
+
+    This file will likely be removed in the next version, so make sure you're
+    not requiring it anywhere to ensure safe gem upgrades.
+
+    If this message is annoying and you can't quickly fix the issue (see below),
+    you have 2 options:
+
+      1) Simply set the env variable "GUARD_GEM_SILENCE_DEPRECATIONS" to "1" to
+      skip this message
+
+      2) Freeze the gem to a previous version (not recommended because upgrades
+      are cool and you might forget to unfreeze later!).
+
+      E.g. in your Gemfile:
+
+        if Time.now > Time.new(2014,11,10)
+          gem 'guard', '~> 2.8'
+        else
+          # Freeze until 2014-11-10 - in case we forget to change back ;)
+          gem 'guard', '= 2.7.3'
+        end
+
+    If you don't know which gem or plugin is requiring this file, here's a
+    backtrace:
+
+    #{Thread.current.backtrace[1..5].join("\n\t >> ")}"
+
+    Here's how to quickly upgrade/fix this (given you are a maintainer of the
+    offending plugin or you want to prepare a pull request yourself):
+
+      #{UPGRADE_WIKI_URL}
+
+    Have fun!
+
+    ******** END OF DEPRECATION MESSAGE ********
+
+    EOS
+
+  end
+end
+
 module Guard
   # @deprecated Inheriting from `Guard::Guard` is deprecated, please inherit
   #   from {Plugin} instead. Please note that the constructor signature has

data/lib/guard/guardfile.rb

@@ -16,7 +16,9 @@ module Guard
     # upgrade for Guard 2.0
     #
     def self.create_guardfile(options = {})
-      UI.deprecation(Deprecator::CREATE_GUARDFILE_DEPRECATION)
+      # FIXME: used internally by Guard
+      # TODO: reenable after majore refactoring is finished
+      # UI.deprecation(Deprecator::CREATE_GUARDFILE_DEPRECATION)
       Generator.new(options).create_guardfile
     end
 
@@ -26,7 +28,9 @@ module Guard
     # upgrade for Guard 2.0
     #
     def self.initialize_template(plugin_name)
-      UI.deprecation(Deprecator::INITIALIZE_TEMPLATE_DEPRECATION)
+      # FIXME: used internally by Guard
+      # TODO: reenable after majore refactoring is finished
+      # UI.deprecation(Deprecator::INITIALIZE_TEMPLATE_DEPRECATION)
       Generator.new.initialize_template(plugin_name)
     end
 
@@ -36,7 +40,9 @@ module Guard
     # upgrade for Guard 2.0
     #
     def self.initialize_all_templates
-      UI.deprecation(Deprecator::INITIALIZE_ALL_TEMPLATES_DEPRECATION)
+      # FIXME: used internally by Guard
+      # TODO: reenable after majore refactoring is finished
+      # UI.deprecation(Deprecator::INITIALIZE_ALL_TEMPLATES_DEPRECATION)
       Generator.new.initialize_all_templates
     end
   end

data/lib/guard/setuper.rb

@@ -15,7 +15,6 @@ module Guard
       guardfile: nil,
       no_interactions: false,
       no_bundler_warning: false,
-      show_deprecations: false,
       latency: nil,
       force_polling: false,
       wait_for_delay: nil,

data/lib/guard/ui.rb

@@ -97,7 +97,11 @@ module Guard
       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]
+        unless ENV["GUARD_GEM_SILENCE_DEPRECATIONS"] == "1"
+          backtrace = Thread.current.backtrace[1..3].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.

data/lib/guard/version.rb

@@ -1,3 +1,3 @@
 module Guard
-  VERSION = "2.7.3"
+  VERSION = "2.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 2.7.3
+  version: 2.8.0
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil