Contents

# frozen_string_literal: true
# With thanks to @myronmarston
# https://github.com/vcr/vcr/blob/master/spec/capture_warnings.rb

module CaptureWarnings
  def report_warnings(&block)
    current_dir = Dir.pwd
    warnings, errors = capture_error(&block).partition { |line| line.include?('warning') }
    project_warnings, other_warnings = warnings.uniq.partition { |line| line.include?(current_dir) }

    if errors.any?
      puts errors.join("\n")
    end

    if other_warnings.any?
      puts "#{ other_warnings.count } non-cucumber-core warnings detected, set VIEW_OTHER_WARNINGS=true to see them."
      print_warnings('other', other_warnings) if ENV['VIEW_OTHER_WARNINGS']
    end

    # Until they fix https://bugs.ruby-lang.org/issues/10661
    if RUBY_VERSION == "2.2.0"
      project_warnings = project_warnings.reject { |w| w =~ /warning: possible reference to past scope/ }
    end

    if project_warnings.any?
      puts "#{ project_warnings.count } cucumber-core warnings detected"
      print_warnings('cucumber-core', project_warnings)
      fail "Please remove all cucumber-core warnings."
    end

    ensure_system_exit_if_required
  end

  def capture_error(&block)
    old_stderr = STDERR.clone
    pipe_r, pipe_w = IO.pipe
    pipe_r.sync    = true
    error         = String.new
    reader = Thread.new do
      begin
        loop do
          error << pipe_r.readpartial(1024)
        end
      rescue EOFError
      end
    end
    STDERR.reopen(pipe_w)
    block.call
  ensure
    capture_system_exit
    STDERR.reopen(old_stderr)
    pipe_w.close
    reader.join
    return error.split("\n")
  end

  def print_warnings(type, warnings)
    puts
    puts "-" * 30 + " #{type} warnings: " + "-" * 30
    puts
    puts warnings.join("\n")
    puts
    puts "-" * 75
    puts
  end

  def ensure_system_exit_if_required
    raise @system_exit if @system_exit
  end

  def capture_system_exit
    @system_exit = $!
  end
end

Version data entries

9 entries across 9 versions & 2 rubygems

Version	Path
cucumber-core-5.0.1	spec/capture_warnings.rb
cucumber-core-5.0.0	spec/capture_warnings.rb
cucumber-core-3.0.0	spec/capture_warnings.rb
cucumber-core-3.0.0.pre.2	spec/capture_warnings.rb
cucumber-expressions-1.0.3	spec/capture_warnings.rb
cucumber-expressions-1.0.2	spec/capture_warnings.rb
cucumber-expressions-1.0.1	spec/capture_warnings.rb
cucumber-expressions-1.0.0	spec/capture_warnings.rb
cucumber-core-2.0.0	spec/capture_warnings.rb