rspec-legacy_formatters 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6a31dc262c49513ace20c235d84088138bc04d36
-  data.tar.gz: 0076604dd5968e361cd466ff74f409080a54a2d6
+SHA256:
+  metadata.gz: 9258440c0f471843e037dfff906d2c3fd84897041bf53365b854274a13fe46bd
+  data.tar.gz: 11c826f1b8524715b8627ace825265eb1ee22da05f9807fa3feeb955e467edea
 SHA512:
-  metadata.gz: dc72aefd2143eddacef4d38e09897b2a24e2863256cde5ffba23882ce679d0bcd48a61785b43357e4b5e52cbcc5157ae480a6e915a66c17efcd013ef1194830e
-  data.tar.gz: 484dc289429ea35e674809dfd7f1c4ed6916c7878ac48d174c1c43b2f081cf60fb24dcd23c0e96e6e9eeb6275545c51e6c338ce33238fda5fb21b65cf931fd6a
+  metadata.gz: 6010d1ceb9431f0d4f39f3143932944b03bb5a2ad1b15a923e2af06c10386099b844f4e971488ee595a6dc49e4f91cae64a1cc5b73a558132aca452f22982766
+  data.tar.gz: 1073890d5d8c29c3f9e17a22ab55da4331ff0b0a1728f12dbd38af99c6da56732b66d9fcc45c5d896af93e2754a0adefa5d6a937437e5ab23ad4867979018b17

data/.gitignore

@@ -9,3 +9,6 @@ tmp
 bin
 bundle
 Gemfile-custom
+smoke_specs/.rspec
+smoke_specs/specs.out
+smoke_specs/spec/examples.txt

data/.travis.yml

@@ -1,21 +1,54 @@
 # This file was generated on 2014-03-30T13:16:22-07:00 from the rspec-dev repo.
 # DO NOT modify it by hand as your changes will get lost the next time it is generated.
 
+# In order to install old Rubies, we need to use old Ubuntu distibution.
+dist: trusty
+language: ruby
+email: false
+
 bundler_args: "--binstubs --standalone --without documentation --path ../bundle"
 script: "script/run_build"
+before_install:
+  - gem update bundler
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - 2.0
+  - 2.0.0
   - 2.1
-  - 2.2
+  - 2.2.10
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
   - ree
   - jruby-18mode
   - jruby
-  - rbx-2
+  - rbx-3
 matrix:
   include:
     - rvm: jruby
       env: JRUBY_OPTS='--2.0'
+    - rvm: 2.6.3
+      env: RSPEC_VERSION='3-0-maintenance'
+    - rvm: 2.6.3
+      env: RSPEC_VERSION='3-1-maintenance'
+    - rvm: 2.6.3
+      env: RSPEC_VERSION='3-2-maintenance'
+    - rvm: 2.6.3
+      env: RSPEC_VERSION='3-3-maintenance'
+    - rvm: 2.6.3
+      env: RSPEC_VERSION='3-4-maintenance'
+    - rvm: 2.6.3
+      env: RSPEC_VERSION='3-5-maintenance'
+    - rvm: 2.6.3
+      env: RSPEC_VERSION='3-6-maintenance'
+    - rvm: 2.6.3
+      env: RSPEC_VERSION='3-7-maintenance''
+    - rvm: 2.6.3
+      env: RSPEC_VERSION='3-8-maintenance''
+  allow_failures:
+    - rvm: jruby
+      env: JRUBY_OPTS='--2.0'
+    - rvm: rbx-3
   fast_finish: true

data/Changelog.md

@@ -1,3 +1,10 @@
+### 1.0.2 / 2019-09-18
+
+Bug Fixes:
+
+* Fix formatters using / extending the legacy HTML formatter which would crash
+  due to a change in the `SnippetExtractor` in RSpec 3.4. (Jon Rowe, #22)
+
 ### 1.0.1 / 2015-11-05
 [Full Changelog](http://github.com/rspec/rspec-legacy_formatters/compare/v1.0.0...v1.0.1)
 

data/Gemfile

@@ -8,8 +8,20 @@ platforms :ruby do
   gem 'github-markup', '0.7.2'
 end
 
+if RUBY_VERSION < '2.2.0' && !!(RbConfig::CONFIG['host_os'] =~ /cygwin|mswin|mingw|bccwin|wince|emx/)
+  gem 'ffi', '< 1.10'
+elsif RUBY_VERSION < '2.0'
+  gem 'ffi', '< 1.9.19' # ffi dropped Ruby 1.8 support in 1.9.19
+elsif defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+  gem 'ffi', '< 1.11.0'
+else
+  gem 'ffi', '~> 1.11.0'
+end
+
 gem 'simplecov', '~> 0.8'
 
+gem 'contracts', '< 0.16' if RUBY_VERSION < '1.9.0'
+
 platforms :ruby_18, :jruby do
   gem 'json'
 end

data/lib/rspec/legacy_formatters/html_formatter.rb

@@ -1,5 +1,6 @@
 require 'rspec/legacy_formatters/base_text_formatter'
 require 'rspec/legacy_formatters/html_printer'
+require 'rspec/legacy_formatters/snippet_extractor'
 
 module RSpec
   module Core

data/lib/rspec/legacy_formatters/snippet_extractor.rb

@@ -1,6 +1,8 @@
 module RSpec
   module Core
     module Formatters
+      remove_const :SnippetExtractor
+
       # @api private
       #
       # Extracts code snippets by looking at the backtrace of the passed error and applies synax highlighting and line numbers using html.
@@ -25,6 +27,14 @@ module RSpec
           @@converter = LegacyNullConverter
         end
 
+        # Copied from the 3.4 version, but with default overrides to cope with
+        # our usage
+        def initialize(source=nil, beginning_line_number=nil, max_line_count=nil)
+          @source = source
+          @beginning_line_number = beginning_line_number
+          @max_line_count = max_line_count
+        end
+
         # @api private
         #
         # Extract lines of code corresponding to  a backtrace.
@@ -36,7 +46,9 @@ module RSpec
         def snippet(backtrace)
           raw_code, line = snippet_for(backtrace[0])
           highlighted = @@converter.convert(raw_code)
-          highlighted << "\n<span class=\"comment\"># gem install syntax to get syntax highlighting</span>" if @@converter.is_a?(NullConverter)
+          if LegacyNullConverter == @@converter || (defined?(NullConverter) && @@converter.is_a?(NullConverter))
+            highlighted << "\n<span class=\"comment\"># gem install syntax to get syntax highlighting</span>"
+          end
           post_process(highlighted, line)
         end
 

data/lib/rspec/legacy_formatters/version.rb

@@ -3,7 +3,7 @@ module RSpec
     # Version information for RSpec LegacyFormatters.
     module Version
       # Current version of RSpec LegacyFormatters, in semantic versioning format.
-      STRING = '1.0.1'
+      STRING = '1.0.2'
     end
   end
 end

data/rspec-legacy_formatters.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jon Rowe"]
   spec.email         = ["hello@jonrowe.co.uk"]
   spec.email         = "rspec@googlegroups.com"
-  spec.homepage      = "http://github.com/rspec/rspec-legacy_formatters"
+  spec.homepage      = "https://github.com/rspec/rspec-legacy_formatters"
   spec.summary       = "rspec-legacy_formatters-#{RSpec::LegacyFormatters::Version::STRING}"
   spec.description   = %q{Support for RSpec 2.x formatters on 3.x}
   spec.license       = "MIT"

data/script/functions.sh

@@ -59,18 +59,20 @@ function rspec_support_compatible {
   fi
 }
 
-function documentation_enforced {
-  if [ -x ./bin/yard ]; then
+function rspec_version_defined {
+  if [ "$RSPEC_VERSION" != "" ]; then
     return 0
   else
     return 1
   fi
 }
 
-function clone_repo {
-  if [ ! -d $1 ]; then # don't clone if the dir is already there
-    travis_retry git clone git://github.com/rspec/$1 --depth 1 --branch $MAINTENANCE_BRANCH
-  fi;
+function documentation_enforced {
+  if [ -x ./bin/yard ]; then
+    return 0
+  else
+    return 1
+  fi
 }
 
 function run_specs_and_record_done {
@@ -85,6 +87,57 @@ function run_specs_and_record_done {
   $rspec_bin spec --backtrace --format progress --profile --format progress --out $SPECS_HAVE_RUN_FILE
 }
 
+function run_specs_as_version {
+  if [ ! -f ./smoke_specs/$SPECS_HAVE_RUN_FILE ]; then # don't rerun specs that have already run
+    pushd ./smoke_specs
+    echo
+    echo "Running smoke specs for $RSPEC_VERSION"
+    echo
+    unset BUNDLE_GEMFILE
+    bundle_install_flags=`cat ../.travis.yml | grep bundler_args | tr -d '"' | grep -o " .*"`
+    travis_retry bundle install $bundle_install_flags
+    cp ../.rspec .rspec
+
+    # First check that we can run our spec suite
+    bin/rspec ../spec --format NyanCatFormatter --format NyanCatFormatter
+
+    set +e
+    # Then check RSpec 2.x formatters
+    bin/rspec spec -r ../lib/rspec/legacy_formatters/documentation_formatter.rb --format RSpec::Core::Formatters::DocumentationFormatter
+    local documentation_status=$?
+
+    bin/rspec spec -r ../lib/rspec/legacy_formatters/json_formatter.rb --format RSpec::Core::Formatters::JsonFormatter
+    local json_status=$?
+
+    bin/rspec spec -r ../lib/rspec/legacy_formatters/html_formatter.rb --format RSpec::Core::Formatters::HtmlFormatter
+    local html_status=$?
+
+    bin/rspec spec -r ../lib/rspec/legacy_formatters/progress_formatter.rb --format RSpec::Core::Formatters::ProgressFormatter
+    local progress_status=$?
+
+    # Then check we can run the smoke suite
+    bin/rspec spec --format NyanCatFormatter --format NyanCatFormatter --out $SPECS_HAVE_RUN_FILE
+    local status=$?
+    set -e
+    popd
+    # 42 is set in the rspec config for the smoke tests,
+    # so we can differentiate between crashes and real failures
+    if
+      (test $status = 42) &&
+      (test $documentation_status = 42) &&
+      (test $json_status = 42) &&
+      (test $html_status = 42) &&
+      (test $progress_status = 42)
+    then
+      echo "Build passed"
+      return 0
+    else
+      echo "Build failed"
+      return 1
+    fi
+  fi;
+}
+
 function run_cukes {
   if [ -d features ]; then
     # force jRuby to use client mode JVM or a compilation mode thats as close as possible,
@@ -109,26 +162,6 @@ function run_cukes {
   fi
 }
 
-function run_specs_one_by_one {
-  for file in `find spec -iname '*_spec.rb'`; do
-    bin/rspec $file -b --format progress
-  done
-}
-
-function run_spec_suite_for {
-  if [ ! -f ../$1/$SPECS_HAVE_RUN_FILE ]; then # don't rerun specs that have already run
-    pushd ../$1
-    echo
-    echo "Running specs for $1"
-    echo
-    unset BUNDLE_GEMFILE
-    bundle_install_flags=`cat .travis.yml | grep bundler_args | tr -d '"' | grep -o " .*"`
-    travis_retry bundle install $bundle_install_flags
-    run_specs_and_record_done
-    popd
-  fi;
-}
-
 function check_documentation_coverage {
   bin/yard stats --list-undoc | ruby -e "
     while line = gets

data/script/run_build

@@ -5,9 +5,14 @@
 set -e -x
 source script/functions.sh
 
-run_specs_and_record_done
-run_cukes
+# We can't run our normal specs with all versions of rspec
+if rspec_version_defined; then
+  run_specs_as_version
+else
+  run_specs_and_record_done
+  run_cukes
 
-if documentation_enforced; then
-  check_documentation_coverage
+  if documentation_enforced; then
+    check_documentation_coverage
+  fi
 fi

data/smoke_specs/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "rspec", :github => "rspec/rspec", :branch => ENV['RSPEC_VERSION']
+%w[core mocks expectations support].each do |name|
+  gem "rspec-#{name}", :github => "rspec/rspec-#{name}", :branch => ENV['RSPEC_VERSION']
+end
+
+gem 'rspec-legacy_formatters', path: '../'
+gem 'nyan-cat-formatter', '0.5.2'

data/smoke_specs/spec/sample_spec.rb

@@ -0,0 +1,11 @@
+RSpec.configure { |c| c.failure_exit_code = 42 }
+
+RSpec.describe 'Prove that legacy formatters runs on this version' do
+  specify "success for #{ENV['RSPEC_VERSION']}" do
+    expect(true).to be true
+  end
+
+  specify "failure for #{ENV['RSPEC_VERSION']}" do
+    expect(true).to be false
+  end
+end

data/smoke_specs/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec/support/spec'
+
+require 'rspec/core/formatters/console_codes'
+
+# This MUST be loaded early, before rspec-core's formatters are loaded.
+require 'rspec/legacy_formatters'
+
+Dir['../spec/support/**/*.rb'].map { |f| require f }

data/spec/support/formatter_support.rb

@@ -42,6 +42,7 @@ module FormatterSupport
   def example
     instance_double("RSpec::Core::Example",
                     :description      => "Example",
+                    :example_group    => group,
                     :full_description => "Example",
                     :execution_result => instance_double(RSpec::Core::Example::ExecutionResult, :exception => Exception.new).as_null_object ,
                     :metadata         => {}
@@ -49,7 +50,12 @@ module FormatterSupport
   end
 
   def group
-    class_double "RSpec::Core::ExampleGroup", :description => "Group"
+    class_double(
+      "RSpec::Core::ExampleGroup",
+      :description => "Group",
+      :parent_groups => [],
+      :top_level? => false
+    )
   end
 
   def start_notification(count)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-legacy_formatters
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Jon Rowe
@@ -43,7 +43,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2015-11-06 00:00:00.000000000 Z
+date: 2019-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -214,12 +214,15 @@ files:
 - rspec-legacy_formatters.gemspec
 - script/functions.sh
 - script/run_build
+- smoke_specs/Gemfile
+- smoke_specs/spec/sample_spec.rb
+- smoke_specs/spec/spec_helper.rb
 - spec/rspec/legacy_formatters_spec.rb
 - spec/spec_helper.rb
 - spec/support/formatter_support.rb
 - spec/support/legacy_formatter_using_sub_classing_example.rb
 - spec/support/old_style_formatter_example.rb
-homepage: http://github.com/rspec/rspec-legacy_formatters
+homepage: https://github.com/rspec/rspec-legacy_formatters
 licenses:
 - MIT
 metadata: {}
@@ -239,9 +242,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: rspec-legacy_formatters-1.0.1
+summary: rspec-legacy_formatters-1.0.2
 test_files: []