rspec_flat_error_formatter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f0fc33d0300de471fa1e50707a35558c07eb5ac
+  data.tar.gz: 42da12de674cfaed426fcdd7d36d7fb81ef23797
+SHA512:
+  metadata.gz: 923d27d17e532c0c90355f3cc16998572c9ea8d924b03bccc7859e2fc5d3d13e1df60392b19cebd69f73ce68d98503148e2ce27b5cc3323c362b252d1eb08cb7
+  data.tar.gz: 02ffe48b051a991549393e17c03effc5e442455171cfc5505973d961abe14f4d91789db2bf2852009165bf85c36b4268614f19ba9041f4c9637394c56eb0b9cd

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+*.code-*
+/.tags
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format RspecFlatErrorFormatter
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,38 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.4
+  DisplayCopNames: true
+
+Metrics/BlockLength:
+  Max: 10
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'example/**/*.rb'
+    - rspec_flat_error_formatter.gemspec
+
+Metrics/LineLength:
+  Max: 128
+
+Metrics/MethodLength:
+  Enabled: 20
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/ModuleLength:
+  Max: 150
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'example/**/*.rb'
+
+RSpec/ExpectActual:
+  Exclude:
+    - 'example/**/*.rb'
+
+RSpec/NestedGroups:
+  Max: 4

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+before_install: gem install bundler -v 1.16.1
+
+before_script:
+  - bundle exec rubocop --config .rubocop.yml
+
+script:
+  - bundle exec rspec
+
+notifications:
+  email:
+    on_success: never
+    on_failure: never

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+# Specify your gem's dependencies in rspec_flat_error_formatter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Victor Zagorodny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# RspecFlatErrorFormatter
+
+[![Build Status](https://travis-ci.org/vittorius/rspec_flat_error_formatter.svg?branch=master)](https://travis-ci.org/vittorius/rspec_flat_error_formatter)
+
+RSpec formater that produces errors output easily consumable by automated tools
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec_flat_error_formatter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec_flat_error_formatter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bundle exec rake spec` to run the tests.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vittorius/rspec_flat_error_formatter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Kudos
+
+* [@sj26](https://github.com/sj26) for his beautiful [rspec_junit_formatter](https://github.com/sj26/rspec_junit_formatter) - tests organization and some other stuff in repo are under the huge influence of RSpec JUnit Formatter repo

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/example/.rspec

@@ -0,0 +1 @@
+--format RspecFlatErrorFormatter

data/example/spec/example_spec.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require_relative 'shared_contexts'
+
+describe 'specs with errors' do
+  it 'succeeds' do
+    expect(true).to be(true)
+  end
+
+  it 'is skipped' do
+    skip 'Just skipped'
+  end
+
+  it 'is pending', pending: 'Just pending' do
+    expect(true).to be false
+  end
+
+  it 'fails' do
+    expect(false).to be(true)
+  end
+
+  it 'fails with diff' do
+    expect(a: 1, b: 2, c: 3).to include(d: 1, e: have_attributes(f: 2))
+  end
+
+  it 'raises an error' do
+    raise ArgumentError, 'Something went wrong with your arguments'
+  end
+
+  it 'raises an error (with cause)' do
+    begin
+      raise 'This is the cause'
+    rescue RuntimeError
+      raise ArgumentError
+    end
+  end
+
+  it 'raises an error (with cause, but no message)' do
+    begin
+      raise
+    rescue RuntimeError
+      raise ArgumentError
+    end
+  end
+
+  # this test also covers RSpec::Expectations::MultipleExpectationsNotMetError but we don't test for it here explicitly
+  # because we don't want this gem to depend on rspec-expectations; there's no real need for it
+  describe 'spec with multiple errors' do
+    around do |example|
+      example.run
+      begin
+        raise 'This is the cause'
+      rescue # rubocop:disable Style/RescueStandardError
+        raise 'Error in "around" block (re-raised)'
+      end
+    end
+
+    it 'fails' do
+      expect(true).to be false
+    end
+
+    after do
+      raise 'Error in "after" block'
+    end
+  end
+
+  it 'fails because of fixed pending', pending: 'Pending but actually fixed' do
+    expect(true).to be true
+  end
+
+  context 'with error(s) in shared context' do
+    context 'with error in "before" block' do
+      include_context 'when in "before" block'
+
+      it 'succeeds' do
+        expect(true).to be(true)
+      end
+    end
+
+    context 'with error in "let" block' do
+      include_context 'when in "let" definition'
+
+      before { error }
+
+      it 'succeeds' do
+        expect(true).to be(true)
+      end
+    end
+
+    context 'with multiple errors in an example' do
+      include_context 'when in "after" block'
+      include_context 'when in "around" block: after the example'
+
+      it 'fails' do
+        expect(true).to be(false)
+      end
+    end
+  end
+end
+
+# TODO: use shared examples

data/example/spec/shared_contexts.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+shared_context 'when in "before" block' do
+  before do
+    raise 'Error in "before" block'
+  end
+end
+
+shared_context 'when in "let" definition' do
+  let(:error) { raise 'Error in "let" definition' }
+end
+
+shared_context 'when in "after" block' do
+  after do
+    raise 'Error in "after" block'
+  end
+end
+
+shared_context 'when in "around" block: after the example' do
+  around do |example|
+    example.run
+    raise 'Error in "around" block'
+  end
+end

data/example/spec/shared_examples.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+shared_examples 'shared examples' do
+  describe 'specs with example errors' do
+    it 'succeeds in a shared example' do
+      expect(true).to be(true)
+    end
+
+    it 'fails in a shared example' do
+      expect(false).to be(true)
+    end
+
+    it 'raises in a shared example' do
+      raise ArgumentError
+    end
+
+    it 'is pending in a shared example' do
+      if defined? skip
+        skip 'Skipped in shared example'
+      else
+        pending 'Pending in shared example'
+      end
+    end
+  end
+
+  describe 'specs with non-example errors' do
+    describe 'in "before" block' do
+      before do
+        raise 'Error in "before" block'
+      end
+
+      it 'fails due to error' do
+        expect(true).to be(true)
+      end
+    end
+
+    describe 'in "let" definition' do
+      let(:error) { raise 'Error in "let" definition' }
+
+      it 'fails due to error' do
+        expect(true).to be(true)
+      end
+    end
+
+    describe 'in "after" block' do
+      after do
+        raise 'Error in "after" block'
+      end
+
+      it 'fails due to error' do
+        expect(true).to be(true)
+      end
+    end
+
+    describe 'in "around" block: before the example' do
+      around do |example|
+        raise 'Error in "around" block'
+        example.run # rubocop:disable Lint/UnreachableCode
+      end
+
+      it 'fails due to error' do
+        expect(true).to be(true)
+      end
+    end
+
+    describe 'in "around" block: after the example' do
+      around do |example|
+        example.run
+        raise 'Error in "around" block'
+      end
+
+      it 'fails due to error' do
+        expect(true).to be(true)
+      end
+    end
+  end
+end

data/lib/rspec_flat_error_formatter.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require 'rspec/support'
+require 'rspec/core'
+require 'rspec/core/formatters/console_codes'
+require 'rspec/core/formatters/base_text_formatter'
+
+class RspecFlatErrorFormatter < RSpec::Core::Formatters::BaseTextFormatter
+  VERSION = '0.0.1'
+  TOKEN_SEPARATOR = ': '
+
+  RSpec::Core::Formatters.register self, :example_passed, :example_pending, :example_failed, :start_dump
+
+  def start(notification)
+    output.puts pluralize(notification.count, 'example')
+    output.puts
+  end
+
+  def example_passed(_notification)
+    output.print colorizer.wrap('.', :success)
+  end
+
+  def example_pending(_notification)
+    output.print colorizer.wrap('*', :pending)
+  end
+
+  def example_failed(_notification)
+    output.print colorizer.wrap('F', :failure)
+  end
+
+  def start_dump(_notification)
+    output.puts
+  end
+
+  def dump_pending(notification)
+    return if notification.pending_notifications.empty?
+
+    formatted = +"\nPending: (Failures listed here are expected and do not affect your suite's status)\n\n"
+
+    notification.pending_notifications.each do |pending|
+      formatted << "#{pending_example_message(pending.example)}\n"
+    end
+
+    output.puts formatted
+  end
+
+  def dump_failures(notification)
+    return if notification.failure_notifications.empty?
+
+    formatted = +"\nFailures:\n\n"
+
+    notification.failure_notifications.each do |failure|
+      formatted << "#{failure_message(failure)}\n"
+    end
+
+    output.puts formatted
+  end
+
+  def dump_summary(_notification)
+    # TODO: Finished in 0.34138 seconds (files took 0.26296 seconds to load) (copy from BaseFormatter)
+    # TODO: 1 example, 0 failures (copy from BaseFormatter)
+  end
+
+  protected
+
+  def pending_example_kind(example)
+    example.skipped? ? 'Skipped' : 'Pending'
+  end
+
+  def pending_example_message(example)
+    formatted_message(
+      bt_line: colorizer.wrap(strip_bt_block(backtrace_formatter.backtrace_line(example.location)), :detail),
+      severity: colorizer.wrap('info', :pending),
+      message: colorizer.wrap("#{pending_example_kind(example)} (#{example.execution_result.pending_message})", :detail)
+    )
+  end
+
+  def pending_fixed_failure?(failure)
+    failure.example.execution_result.pending_fixed?
+  end
+
+  def multiple_exception_error?(failure)
+    failure.example.exception.is_a?(RSpec::Core::MultipleExceptionError::InterfaceTag)
+  end
+
+  def failure_message(failure)
+    if pending_fixed_failure?(failure)
+      pending_fixed_message(failure)
+    elsif multiple_exception_error?(failure)
+      multiple_exceptions_message(failure)
+    else
+      error_message(failure)
+    end
+  end
+
+  def pending_fixed_message(failure)
+    formatted_message(
+      bt_line: colorizer.wrap(format_backtrace_first_line(failure.exception, failure.example), :detail),
+      message: colorizer.wrap(
+        "Expected pending '#{failure.example.execution_result.pending_message}' to fail. No error was raised.",
+        :failure
+      ),
+      severity: colorizer.wrap('error', :failure)
+    )
+  end
+
+  # TODO: skip shared example stack frame printing for sub-errors
+  def multiple_exceptions_message(failure)
+    failure.exception.all_exceptions.map { |ex| error_message_for_example(ex, failure.example) }.join("\n")
+  end
+
+  def error_message(failure)
+    error_message_for_example(failure.exception, failure.example)
+  end
+
+  def error_message_for_example(exception, example)
+    formatted_message(
+      bt_line: colorizer.wrap(format_backtrace_first_line(exception, example), :detail),
+      message: colorizer.wrap(error_failure_message_fragment(exception, example), :failure),
+      severity: colorizer.wrap('error', :failure)
+    )
+  end
+
+  def error_failure_message_fragment(exception, example)
+    exception_class = exception_class_name(exception)
+    message, diff = *exception.message.split('Diff:')
+    [
+      exception_class.start_with?('RSpec', 'Rspec') ? '' : "#{exception_class}: ", # only non-RSpec exception classes
+      message.tr("\n", ' ').squeeze(' ').strip, # making it a one-liner
+      formatted_cause(exception, example),
+      diff.nil? ? '' : "\nDiff:" + diff
+    ].join
+  end
+
+  def formatted_message(bt_line:, severity:, message:)
+    [bt_line, severity, message].join(TOKEN_SEPARATOR)
+  end
+
+  def exception_class_name(exception)
+    name = exception.class.name
+    name = '(anonymous error class)' if name == ''
+    name
+  end
+
+  # violently copy-pasted from RSpec::Core::Formatters::ExceptionPresenter#final_exception
+  def last_cause(exception, previous = [])
+    cause = exception.cause
+    if cause && !previous.include?(cause)
+      previous << cause
+      last_cause(cause, previous)
+    else
+      exception
+    end
+  end
+
+  def formatted_cause(exception, example)
+    cause = last_cause(exception)
+    if cause == exception
+      ''
+    else
+      ", caused by '#{exception_class_name(cause)}: #{formatted_cause_message(cause)}' "\
+      "at #{format_backtrace_first_line(cause, example)}"
+    end
+  end
+
+  def formatted_cause_message(cause)
+    if cause.message.empty?
+      class_name = exception_class_name(cause)
+      class_name.match?(/anonymous/) ? '<no message>' : class_name
+    else
+      cause.message
+    end
+  end
+
+  def format_backtrace_first_line(exception, example)
+    strip_bt_block(backtrace_formatter.format_backtrace(exception.backtrace, example.metadata).first)
+  end
+
+  def strip_bt_block(bt_line)
+    bt_line.split(':in').first
+  end
+
+  def pluralize(count, string)
+    "#{count} #{string}#{'s' unless count.to_f == 1}"
+  end
+
+  def colorizer
+    RSpec::Core::Formatters::ConsoleCodes
+  end
+
+  def backtrace_formatter
+    RSpec.configuration.backtrace_formatter
+  end
+end

data/rspec_flat_error_formatter.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec_flat_error_formatter'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Victor Zagorodny']
+  spec.email         = ['post.vittorius@gmail.com']
+
+  spec.summary       = 'RSpec formater that produces output easily consumable by automated tools'
+  spec.homepage      = 'https://github.com/vittorius/rspec_flat_error_formatter'
+  spec.license       = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.4.2' # TODO: work on backwards compatibility for all RSpec 3.x Ruby versions
+
+  spec.add_dependency 'rspec-core', '~> 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 0'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: rspec_flat_error_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Victor Zagorodny
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- post.vittorius@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/.rspec
+- example/spec/example_spec.rb
+- example/spec/shared_contexts.rb
+- example/spec/shared_examples.rb
+- lib/rspec_flat_error_formatter.rb
+- rspec_flat_error_formatter.gemspec
+homepage: https://github.com/vittorius/rspec_flat_error_formatter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: RSpec formater that produces output easily consumable by automated tools
+test_files: []