minitest-reporters 1.3.6 → 1.3.8

data/README.md

@@ -1,135 +1,135 @@
-[gem]: https://rubygems.org/gems/minitest-reporters
-[travis]: https://travis-ci.org/kern/minitest-reporters
-
-# minitest-reporters - create customizable Minitest output formats
-
-[![Join the chat at https://gitter.im/kern/minitest-reporters](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/kern/minitest-reporters?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![Gem Version](https://badge.fury.io/rb/minitest-reporters.svg)][gem]
-[![Build Status](https://secure.travis-ci.org/kern/minitest-reporters.png)][travis]
-[![Windows build status](https://ci.appveyor.com/api/projects/status/3pugsxatwcldgyjd/branch/master?svg=true)](https://ci.appveyor.com/project/os97673/minitest-reporters/branch/master)
-
-Death to haphazard monkey-patching! Extend Minitest through simple hooks.
-
-## Installation ##
-
-    gem install minitest-reporters
-
-## Usage ##
-
-In your `test_helper.rb` file, add the following lines:
-
-```ruby
-require "minitest/reporters"
-Minitest::Reporters.use!
-```
-
-This will swap out the Minitest runner to the custom one used by minitest-reporters and use the correct reporters for Textmate, Rubymine, and the console. If you would like to write your own reporter, just `include Minitest::Reporter` and override the methods you'd like. Take a look at the provided reporters for examples.
-
-Don't like the default progress bar reporter?
-
-```ruby
-Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
-```
-
-Want to use multiple reporters?
-
-```ruby
-Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new, Minitest::Reporters::JUnitReporter.new]
-```
-
-If RubyMate, TeamCity, RubyMine or VIM presence is detected, the reporter will be automatically chosen,
-regardless of any reporters passed to the `use!` method.
-
-To override this behavior, you may set the ENV variable MINITEST_REPORTER:
-
-```sh
-export MINITEST_REPORTER=JUnitReporter
-```
-
-Detection of those systems is based on presence of certain ENV variables and are evaulated in the following order:
-
-```
- MINITEST_REPORTER => use reporter indicated in env variable
- TM_PID => use RubyMateReporter
- RM_INFO => use RubyMineReporter
- TEAMCITY_VERSION => use RubyMineReporter
- VIM => disable all Reporters
-```
-
-The following reporters are provided:
-
-```ruby
-Minitest::Reporters::DefaultReporter  # => Redgreen-capable version of standard Minitest reporter
-Minitest::Reporters::SpecReporter     # => Turn-like output that reads like a spec
-Minitest::Reporters::ProgressReporter # => Fuubar-like output with a progress bar
-Minitest::Reporters::RubyMateReporter # => Simple reporter designed for RubyMate
-Minitest::Reporters::RubyMineReporter # => Reporter designed for RubyMine IDE and TeamCity CI server
-Minitest::Reporters::JUnitReporter    # => JUnit test reporter designed for JetBrains TeamCity
-Minitest::Reporters::MeanTimeReporter # => Produces a report summary showing the slowest running tests
-Minitest::Reporters::HtmlReporter     # => Generates an HTML report of the test results
-```
-
-Options can be passed to these reporters at construction-time, e.g. to force
-color output from `DefaultReporter`:
-
-```ruby
-Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(:color => true)]
-```
-
-## Screenshots ##
-
-**Default Reporter**
-
-![Default Reporter](./assets/default-reporter.png?raw=true)
-
-**Spec Reporter**
-
-![Spec Reporter](./assets/spec-reporter.png?raw=true)
-
-**Progress Reporter**
-
-![Progress Reporter](./assets/progress-reporter.png?raw=true)
-
-## Caveats ##
-
-If you are using minitest-reporters with ActiveSupport 3.x, make sure that you require ActiveSupport before invoking `Minitest::Reporters.use!`. Minitest-reporters fixes incompatibilities caused by monkey patches in ActiveSupport 3.x. ActiveSupport 4.x is unaffected.
-
-**Rails Backtrace Filtering and Custom Backtrace Filtering**
-
-Minitest lets you configures your own, custom backtrace filter via
-`Minitest.backtrace_filter=`. If you're using Rails, then by default
-`Minitest.backtrace_filter` is a filter designed specially for Rails.
-
-But minitest-reporters overwrites `Minitest.backtrace_filter` by default. That means it
-will overwrite your custom filter and Rails' default filter. (You'll know this is
-happening if you see overly long or otherwise unexpected backtraces.)
-
-To avoid that, you must manually tell minitest-reporters which filter to use. In Rails,
-do this in `test_helper.rb`:
-```ruby
-    Minitest::Reporters.use!(
-      Minitest::Reporters::DefaultReporter.new,
-      ENV,
-      Minitest.backtrace_filter
-    )
-```
-The third parameter to `.use!`, in this case `Minitest.backtrace_filter`, should be a
-filter object. In the above example, you're telling minitest-reporters to use the filter
-that Rails has already set.
-
-## Note on Patches/Pull Requests ##
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a future version unintentionally.
-* Commit, but do not mess with the `Rakefile`. If you want to have your own version, that is fine but bump the version in a commit by itself in another branch so I can ignore it when I pull.
-* Send me a pull request. Bonus points for git flow feature branches.
-
-## Resources ##
-
-* [GitHub Repository](https://github.com/CapnKernul/minitest-reporters)
-* [Documentation](http://www.rubydoc.info/github/kern/minitest-reporters/master)
-
-## License ##
-
-Minitest-reporters is licensed under the MIT License. See [LICENSE](LICENSE) for details.
+[gem]: https://rubygems.org/gems/minitest-reporters
+[travis]: https://travis-ci.org/kern/minitest-reporters
+
+# minitest-reporters - create customizable Minitest output formats
+
+[![Join the chat at https://gitter.im/kern/minitest-reporters](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/kern/minitest-reporters?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Gem Version](https://badge.fury.io/rb/minitest-reporters.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/kern/minitest-reporters.png)][travis]
+[![Windows build status](https://ci.appveyor.com/api/projects/status/3pugsxatwcldgyjd/branch/master?svg=true)](https://ci.appveyor.com/project/os97673/minitest-reporters/branch/master)
+
+Death to haphazard monkey-patching! Extend Minitest through simple hooks.
+
+## Installation ##
+
+    gem install minitest-reporters
+
+## Usage ##
+
+In your `test_helper.rb` file, add the following lines:
+
+```ruby
+require "minitest/reporters"
+Minitest::Reporters.use!
+```
+
+This will swap out the Minitest runner to the custom one used by minitest-reporters and use the correct reporters for Textmate, Rubymine, and the console. If you would like to write your own reporter, just `include Minitest::Reporter` and override the methods you'd like. Take a look at the provided reporters for examples.
+
+Don't like the default progress bar reporter?
+
+```ruby
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+```
+
+Want to use multiple reporters?
+
+```ruby
+Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new, Minitest::Reporters::JUnitReporter.new]
+```
+
+If RubyMate, TeamCity, RubyMine or VIM presence is detected, the reporter will be automatically chosen,
+regardless of any reporters passed to the `use!` method.
+
+To override this behavior, you may set the ENV variable MINITEST_REPORTER:
+
+```sh
+export MINITEST_REPORTER=JUnitReporter
+```
+
+Detection of those systems is based on presence of certain ENV variables and are evaulated in the following order:
+
+```
+ MINITEST_REPORTER => use reporter indicated in env variable
+ TM_PID => use RubyMateReporter
+ RM_INFO => use RubyMineReporter
+ TEAMCITY_VERSION => use RubyMineReporter
+ VIM => disable all Reporters
+```
+
+The following reporters are provided:
+
+```ruby
+Minitest::Reporters::DefaultReporter  # => Redgreen-capable version of standard Minitest reporter
+Minitest::Reporters::SpecReporter     # => Turn-like output that reads like a spec
+Minitest::Reporters::ProgressReporter # => Fuubar-like output with a progress bar
+Minitest::Reporters::RubyMateReporter # => Simple reporter designed for RubyMate
+Minitest::Reporters::RubyMineReporter # => Reporter designed for RubyMine IDE and TeamCity CI server
+Minitest::Reporters::JUnitReporter    # => JUnit test reporter designed for JetBrains TeamCity
+Minitest::Reporters::MeanTimeReporter # => Produces a report summary showing the slowest running tests
+Minitest::Reporters::HtmlReporter     # => Generates an HTML report of the test results
+```
+
+Options can be passed to these reporters at construction-time, e.g. to force
+color output from `DefaultReporter`:
+
+```ruby
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(:color => true)]
+```
+
+## Screenshots ##
+
+**Default Reporter**
+
+![Default Reporter](./assets/default-reporter.png?raw=true)
+
+**Spec Reporter**
+
+![Spec Reporter](./assets/spec-reporter.png?raw=true)
+
+**Progress Reporter**
+
+![Progress Reporter](./assets/progress-reporter.png?raw=true)
+
+## Caveats ##
+
+If you are using minitest-reporters with ActiveSupport 3.x, make sure that you require ActiveSupport before invoking `Minitest::Reporters.use!`. Minitest-reporters fixes incompatibilities caused by monkey patches in ActiveSupport 3.x. ActiveSupport 4.x is unaffected.
+
+**Rails Backtrace Filtering and Custom Backtrace Filtering**
+
+Minitest lets you configures your own, custom backtrace filter via
+`Minitest.backtrace_filter=`. If you're using Rails, then by default
+`Minitest.backtrace_filter` is a filter designed specially for Rails.
+
+But minitest-reporters overwrites `Minitest.backtrace_filter` by default. That means it
+will overwrite your custom filter and Rails' default filter. (You'll know this is
+happening if you see overly long or otherwise unexpected backtraces.)
+
+To avoid that, you must manually tell minitest-reporters which filter to use. In Rails,
+do this in `test_helper.rb`:
+```ruby
+    Minitest::Reporters.use!(
+      Minitest::Reporters::DefaultReporter.new,
+      ENV,
+      Minitest.backtrace_filter
+    )
+```
+The third parameter to `.use!`, in this case `Minitest.backtrace_filter`, should be a
+filter object. In the above example, you're telling minitest-reporters to use the filter
+that Rails has already set.
+
+## Note on Patches/Pull Requests ##
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, but do not mess with the `Rakefile`. If you want to have your own version, that is fine but bump the version in a commit by itself in another branch so I can ignore it when I pull.
+* Send me a pull request. Bonus points for git flow feature branches.
+
+## Resources ##
+
+* [GitHub Repository](https://github.com/CapnKernul/minitest-reporters)
+* [Documentation](http://www.rubydoc.info/github/kern/minitest-reporters/master)
+
+## License ##
+
+Minitest-reporters is licensed under the MIT License. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -1,70 +1,70 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-require 'rubocop/rake_task'
-
-task :default => :test
-Rake::TestTask.new do |t|
-  t.pattern = "test/{unit,integration}/**/*_test.rb"
-  t.verbose = true
-end
-
-rubymine_home = [
-  ENV["RUBYMINE_HOME"],
-  "../rubymine-contrib/ruby-testing/src/rb/testing/patch/common",
-  "/Applications/RubyMine.app/Contents/rb/testing/patch/common",
-].compact.detect { |d| Dir.exist?(d) }
-
-Rake::TestTask.new("test:gallery") do |t|
-  t.pattern = "test/gallery/**/*_test.rb"
-  t.verbose = true
-  t.libs << rubymine_home
-end
-
-# - RubyMineReporter must be tested separately inside of RubyMine
-# - JUnitReporter normally writes to `test/reports` instead of stdout
-task :gallery do
-  unless rubymine_home
-    warn "To see RubyMineReporter supply RUBYMINE_HOME= or git clone git://git.jetbrains.org/idea/contrib.git ../rubymine-contrib"
-    exit 1
-  end
-
-  [
-    "Pride",
-    "DefaultReporter",
-    "JUnitReporter",
-    "ProgressReporter",
-    "RubyMateReporter",
-    "SpecReporter",
-    "RubyMineReporter",
-    "HtmlReporter",
-    "MeanTimeReporter",
-  ].each do |reporter|
-    puts
-    puts "-" * 72
-    puts "Running gallery tests using #{reporter}..."
-    puts "-" * 72
-    puts
-
-    sh "rake test:gallery REPORTER=#{reporter}" do
-      # Ignore failures. They're expected when you are running the gallery
-      # test suite.
-    end
-    sh "cat test/reports/*" if reporter == "JUnitReporter"
-  end
-end
-
-task :reset_statistics do
-  require 'minitest/reporters/mean_time_reporter'
-  Minitest::Reporters::MeanTimeReporter.reset_statistics!
-  puts "The mean time reporter statistics have been reset."
-  exit 0
-end
-
-desc 'Run RuboCop on the lib directory'
-RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb']
-  # only show the files with failures
-  task.formatters = ['clang']
-  # don't abort rake on failure
-  task.fail_on_error = false
-end
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'rubocop/rake_task'
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.pattern = "test/{unit,integration}/**/*_test.rb"
+  t.verbose = true
+end
+
+rubymine_home = [
+  ENV["RUBYMINE_HOME"],
+  "../rubymine-contrib/ruby-testing/src/rb/testing/patch/common",
+  "/Applications/RubyMine.app/Contents/rb/testing/patch/common",
+].compact.detect { |d| Dir.exist?(d) }
+
+Rake::TestTask.new("test:gallery") do |t|
+  t.pattern = "test/gallery/**/*_test.rb"
+  t.verbose = true
+  t.libs << rubymine_home
+end
+
+# - RubyMineReporter must be tested separately inside of RubyMine
+# - JUnitReporter normally writes to `test/reports` instead of stdout
+task :gallery do
+  unless rubymine_home
+    warn "To see RubyMineReporter supply RUBYMINE_HOME= or git clone git://git.jetbrains.org/idea/contrib.git ../rubymine-contrib"
+    exit 1
+  end
+
+  [
+    "Pride",
+    "DefaultReporter",
+    "JUnitReporter",
+    "ProgressReporter",
+    "RubyMateReporter",
+    "SpecReporter",
+    "RubyMineReporter",
+    "HtmlReporter",
+    "MeanTimeReporter",
+  ].each do |reporter|
+    puts
+    puts "-" * 72
+    puts "Running gallery tests using #{reporter}..."
+    puts "-" * 72
+    puts
+
+    sh "rake test:gallery REPORTER=#{reporter}" do
+      # Ignore failures. They're expected when you are running the gallery
+      # test suite.
+    end
+    sh "cat test/reports/*" if reporter == "JUnitReporter"
+  end
+end
+
+task :reset_statistics do
+  require 'minitest/reporters/mean_time_reporter'
+  Minitest::Reporters::MeanTimeReporter.reset_statistics!
+  puts "The mean time reporter statistics have been reset."
+  exit 0
+end
+
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  # only show the files with failures
+  task.formatters = ['clang']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end

data/appveyor.yml

@@ -1,22 +1,22 @@
----
-version: '#{build}'
-cache:
-  - vendor/bundle
-environment:
-  matrix:
-    - RUBY_VERSION: 25-x64
-    - RUBY_VERSION: 24-x64
-
-install:
-  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
-  - bundle install
-
-build: off
-
-before_test:
-  - ruby -v
-  - gem -v
-  - bundle -v
-
-test_script:
-  - bundle exec rake test
+---
+version: '#{build}'
+cache:
+  - vendor/bundle
+environment:
+  matrix:
+    - RUBY_VERSION: 25-x64
+    - RUBY_VERSION: 24-x64
+
+install:
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - bundle install
+
+build: off
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake test

data/lib/minitest/extensible_backtrace_filter.rb

@@ -1,67 +1,67 @@
-module Minitest
-  # Filters backtraces of exceptions that may arise when running tests.
-  class ExtensibleBacktraceFilter
-    # Returns the default filter.
-    #
-    # The default filter will filter out all Minitest and minitest-reporters
-    # lines.
-    #
-    # @return [Minitest::ExtensibleBacktraceFilter]
-    def self.default_filter
-      unless defined? @default_filter
-        filter = self.new
-        filter.add_filter(/lib\/minitest/)
-        @default_filter = filter
-      end
-
-      @default_filter
-    end
-
-    # Creates a new backtrace filter.
-    def initialize
-      @filters = []
-    end
-
-    # Adds a filter.
-    #
-    # @param [Regex] regex the filter
-    def add_filter(regex)
-      @filters << regex
-    end
-
-    # Determines if the string would be filtered.
-    #
-    # @param [String] str
-    # @return [Boolean]
-    def filters?(str)
-      @filters.any? { |filter| str =~ filter }
-    end
-
-    # Filters a backtrace.
-    #
-    # This will add new lines to the new backtrace until a filtered line is
-    # encountered. If there were lines added to the new backtrace, it returns
-    # those lines. However, if the first line in the backtrace was filtered,
-    # resulting in an empty backtrace, it returns all lines that would have
-    # been unfiltered. If that in turn does not contain any lines, it returns
-    # the original backtrace.
-    #
-    # @param [Array] backtrace the backtrace to filter
-    # @return [Array] the filtered backtrace
-    # @note This logic is based off of Minitest's #filter_backtrace.
-    def filter(backtrace)
-      result = []
-      return result unless backtrace
-
-      backtrace.each do |line|
-        break if filters?(line)
-        result << line
-      end
-
-      result = backtrace.reject { |line| filters?(line) } if result.empty?
-      result = backtrace.dup if result.empty?
-
-      result
-    end
-  end
-end
+module Minitest
+  # Filters backtraces of exceptions that may arise when running tests.
+  class ExtensibleBacktraceFilter
+    # Returns the default filter.
+    #
+    # The default filter will filter out all Minitest and minitest-reporters
+    # lines.
+    #
+    # @return [Minitest::ExtensibleBacktraceFilter]
+    def self.default_filter
+      unless defined? @default_filter
+        filter = self.new
+        filter.add_filter(/lib\/minitest/)
+        @default_filter = filter
+      end
+
+      @default_filter
+    end
+
+    # Creates a new backtrace filter.
+    def initialize
+      @filters = []
+    end
+
+    # Adds a filter.
+    #
+    # @param [Regex] regex the filter
+    def add_filter(regex)
+      @filters << regex
+    end
+
+    # Determines if the string would be filtered.
+    #
+    # @param [String] str
+    # @return [Boolean]
+    def filters?(str)
+      @filters.any? { |filter| str =~ filter }
+    end
+
+    # Filters a backtrace.
+    #
+    # This will add new lines to the new backtrace until a filtered line is
+    # encountered. If there were lines added to the new backtrace, it returns
+    # those lines. However, if the first line in the backtrace was filtered,
+    # resulting in an empty backtrace, it returns all lines that would have
+    # been unfiltered. If that in turn does not contain any lines, it returns
+    # the original backtrace.
+    #
+    # @param [Array] backtrace the backtrace to filter
+    # @return [Array] the filtered backtrace
+    # @note This logic is based off of Minitest's #filter_backtrace.
+    def filter(backtrace)
+      result = []
+      return result unless backtrace
+
+      backtrace.each do |line|
+        break if filters?(line)
+        result << line
+      end
+
+      result = backtrace.reject { |line| filters?(line) } if result.empty?
+      result = backtrace.dup if result.empty?
+
+      result
+    end
+  end
+end