Merge pull request #16 from e2/more_ways_to_disable_warnings

add more warning silencing options

Author: e2

.travis.yml

@@ -1,9 +1,11 @@
 sudo: false
 language: ruby
 bundler_args: --without development
+env: JRUBY_OPTS='--server -Xcompile.invokedynamic=false'
 rvm:
   - 2.2.5
   - 2.3.1
   - jruby-9.1.2.0
+
 before_install: gem install bundler -v 1.12.5
 cache: bundler

Gemfile

@@ -13,4 +13,5 @@ end
 
 group :test do
   gem 'rspec', '~> 3.4'
+  gem 'gem_isolator', '~> 0.2', '>= 0.2.3'
 end

Guardfile

@@ -63,6 +63,8 @@ group :specs, halt_on_fail: true do
     watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
     watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
 
+    watch(%r{^spec/acceptance/fixtures/(.+)\.rb$}) { 'spec/acceptance' }
+
     # Turnip features and steps
     watch(%r{^spec/acceptance/(.+)\.feature$})
     watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|

lib/ruby_dep/quiet.rb

@@ -0,0 +1,3 @@
+require 'ruby_dep/warning'
+
+RubyDep::Warning.new.silence!

lib/ruby_dep/ruby_version.rb

@@ -1,7 +1,7 @@
 
 module RubyDep
   class RubyVersion
-    attr_reader :status
+    attr_reader :status # NOTE: monkey-patched by acceptance tests
     attr_reader :version
     attr_reader :engine
 

lib/ruby_dep/warning.rb

@@ -19,8 +19,8 @@ class Warning
 
     NOTICE_BUGGY_ALTERNATIVE = '(Or, at least to %s)'.freeze
 
-    NOTICE_HOW_TO_DISABLE = '(To disable warnings, set'\
-      " #{DISABLING_ENVIRONMENT_VAR}=1)".freeze
+    NOTICE_HOW_TO_DISABLE = '(To disable warnings, see:'\
+      "#{PROJECT_URL}/wiki/Disabling-warnings )".freeze
 
     NOTICE_OPEN_ISSUE = 'If you need this version supported,'\
       " please open an issue at #{PROJECT_URL}".freeze
@@ -37,6 +37,10 @@ def show_warnings
       raise "Unknown problem type: #{problem.inspect}"
     end
 
+    def silence!
+      ENV[DISABLING_ENVIRONMENT_VAR] = '1'
+    end
+
     private
 
     def silenced?

spec/acceptance/fixtures/show_warnings.rb

@@ -0,0 +1,12 @@
+require 'ruby_dep/warning'
+
+# Monkey patch so warning happens on every tested Ruby version
+module RubyDep
+  class RubyVersion
+    def status
+      :insecure
+    end
+  end
+end
+
+RubyDep::Warning.new.show_warnings

spec/acceptance/fixtures/warnings_silenced_by_require.rb

@@ -0,0 +1,13 @@
+require 'ruby_dep/quiet'
+require 'ruby_dep/warning'
+
+# Monkey patch so warning happens on every tested Ruby version
+module RubyDep
+  class RubyVersion
+    def status
+      :insecure
+    end
+  end
+end
+
+RubyDep::Warning.new.show_warnings

spec/acceptance/warnings_spec.rb

@@ -0,0 +1,68 @@
+require 'gem_isolator'
+
+RSpec.describe 'warnings' do
+  let(:gems) { [['ruby_dep', { path: Dir.pwd }]] }
+
+  let!(:spec_path) do
+    File.expand_path("spec/acceptance/fixtures/#{spec}")
+  end
+
+  let(:subcmd) do
+    "bundle exec ruby #{spec_path} 2>&1"
+  end
+
+  let(:code) do
+    "o=`#{subcmd}`"\
+      ";raise \"Unexpected output: \#{o.inspect}\" unless o.empty?"
+  end
+
+  let(:cmd) do
+    "ruby -e '#{code}'"
+  end
+
+  def run_isolated(cmd)
+    GemIsolator.isolate(gems: gems) do |env, isolation|
+      new_env = env.dup
+      yield(new_env, isolation) if block_given?
+      unless isolation.system(env, 'gem install -q bundler')
+        raise 'failed to install bundler'
+      end
+      expect(isolation.system(new_env, cmd)).to eq(true)
+    end
+  end
+
+  context 'when not silenced' do
+    let!(:spec) { 'show_warnings.rb' }
+
+    let(:code) do
+      "o=`#{subcmd}`;"\
+        "unless o =~ /Ruby has security vulnerabilities/\n"\
+        "  raise \"Warning expected, got: \#{o.inspect}\"\n"\
+        'end'
+    end
+
+    it 'produces a warning' do
+      run_isolated(cmd)
+    end
+  end
+
+  context 'when silenced' do
+    context 'with environment variable' do
+      let!(:spec) { 'show_warnings.rb' }
+
+      it 'produces no output' do
+        run_isolated(cmd) do |env, _isolation|
+          env['RUBY_DEP_GEM_SILENCE_WARNINGS'] = '1'
+        end
+      end
+    end
+
+    context 'with special include file' do
+      let!(:spec) { 'warnings_silenced_by_require.rb' }
+
+      it 'produces no output' do
+        run_isolated(cmd)
+      end
+    end
+  end
+end

spec/lib/ruby_dep/warning_spec.rb

@@ -63,18 +63,37 @@ def rquote(str)
     before { subject.show_warnings }
 
     context 'when silenced' do
-      around do |example|
-        old = ENV['RUBY_DEP_GEM_SILENCE_WARNINGS']
-        ENV['RUBY_DEP_GEM_SILENCE_WARNINGS'] = '1'
-        example.run
-        ENV['RUBY_DEP_GEM_SILENCE_WARNINGS'] = old
+      context 'with an environment variable' do
+        around do |example|
+          old = ENV['RUBY_DEP_GEM_SILENCE_WARNINGS']
+          ENV['RUBY_DEP_GEM_SILENCE_WARNINGS'] = '1'
+          example.run
+          ENV['RUBY_DEP_GEM_SILENCE_WARNINGS'] = old
+        end
+
+        context 'with any outdated Ruby' do
+          let(:ruby_version) { outdated_ruby }
+          it 'does not show anything' do
+            expect(logger).to_not have_received(:warning)
+            expect(logger).to_not have_received(:notice)
+          end
+        end
       end
 
-      context 'with any outdated Ruby' do
-        let(:ruby_version) { outdated_ruby }
-        it 'does not show anything' do
-          expect(logger).to_not have_received(:warning)
-          expect(logger).to_not have_received(:notice)
+      context 'with a method call' do
+        around do |example|
+          old = ENV['RUBY_DEP_GEM_SILENCE_WARNINGS']
+          subject.silence!
+          example.run
+          ENV['RUBY_DEP_GEM_SILENCE_WARNINGS'] = old
+        end
+
+        context 'with any outdated Ruby' do
+          let(:ruby_version) { outdated_ruby }
+          it 'does not show anything' do
+            expect(logger).to_not have_received(:warning)
+            expect(logger).to_not have_received(:notice)
+          end
         end
       end
     end