rspec-legacy_formatters 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e497032757ef52f1b99a17d71f81f1666e80698f
+  data.tar.gz: 7fc2b3298d1196c86af0692ac57a13b513d985be
+SHA512:
+  metadata.gz: 48d126abc7927b049e65cb4c155e8b91688b032c3e2e242ab3ff2b7cd658babd3e6bf75a553b0991861010bf5956405b01a9a2a2797be57da62a6cef84c8ea12
+  data.tar.gz: e925aa53cbbca05cbfe021082cfd43ef89ca40b8cb5c4b967cd3d88f2ff5a6077fd66c7fa542554d8f6273aa5e31179c7221b965e8dbf2762d647a9f1a7091d2

data.tar.gz.sig

@@ -0,0 +1 @@
+Zb�h�/������hH6�E��d,3D�����ٍ.Й;�1z}-���FҞ�5��@�i�"�{4&��	N�����:���%�,��6��K��z+�7HZ��F������H�ʪ�0����=���@C�|tVj5�;�P���p��s�����<�阓��F��y<Մ�I^�ک�����~GR��b�p�Ӳ�i�K�r�e��d{C�F����)s��:"J���$���lA�ȟ�e������D���RQh

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+.config
+.yardoc
+Gemfile.lock
+coverage
+pkg
+tmp
+bin
+bundle
+Gemfile-custom

data/.rspec

@@ -0,0 +1,2 @@
+-r spec_helper
+--color

data/.travis.yml

@@ -0,0 +1,16 @@
+# 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.
+
+bundler_args: "--binstubs --standalone --without documentation --path ../bundle"
+script: "script/run_build"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - ree
+  - jruby-18mode
+  - jruby
+  - rbx

data/.yardopts

@@ -0,0 +1,7 @@
+--exclude features
+--no-private
+--markup markdown
+--default-return void
+-
+Changelog.md
+License.txt

data/Changelog.md

@@ -0,0 +1,3 @@
+### 1.0.0.rc1 / 2014-05-16
+
+Initial release.

data/Gemfile

@@ -0,0 +1,30 @@
+source "https://rubygems.org"
+
+gemspec
+
+%w[rspec rspec-core rspec-expectations rspec-mocks rspec-support].each do |lib|
+  library_path = File.expand_path("../../#{lib}", __FILE__)
+  if File.exist?(library_path) && !ENV['USE_GIT_REPOS']
+    gem lib, :path => library_path
+  else
+    gem lib, :git => "git://github.com/rspec/#{lib}.git"
+  end
+end
+
+### deps for rdoc.info
+platforms :ruby do
+  gem 'redcarpet',     '2.1.1'
+  gem 'github-markup', '0.7.2'
+end
+
+gem 'simplecov', '~> 0.8'
+
+platforms :ruby_18, :jruby do
+  gem 'json'
+end
+
+platforms :jruby do
+  gem "jruby-openssl"
+end
+
+eval File.read('Gemfile-custom') if File.exist?('Gemfile-custom')

data/License.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2014 The RSpec Development Team
+
+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,41 @@
+# RSpec::LegacyFormatters
+
+This gem provides support for using legacy formatters (that is, those
+that were written against the RSpec 2 formatter API) with RSpec 3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-legacy_formatters'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-legacy_formatters
+
+## Usage
+
+This gem MUST be required before the legacy formatter is loaded. We recommend
+you use RSpec's `--require` option, either from the command line:
+
+```
+$ rspec --require rspec/legacy_formatters --format MyCustomFormatter
+```
+
+...or by adding it to `.rspec`:
+
+```
+--require rspec/legacy_formatters
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/rspec-legacy_formatters/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler"
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require "rake"
+
+require "rspec/core/rake_task"
+require "rspec/legacy_formatters/version"
+
+require "cucumber/rake/task"
+Cucumber::Rake::Task.new(:cucumber)
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = %w[-w]
+end
+
+task :default => [:spec, :cucumber]
+
+task :verify_private_key_present do
+  private_key = File.expand_path('~/.gem/rspec-gem-private_key.pem')
+  unless File.exist?(private_key)
+    raise "Your private key is not present. This gem should not be built without that."
+  end
+end
+
+task :build => :verify_private_key_present

data/cucumber.yml

@@ -0,0 +1,6 @@
+<%
+exclusions = []
+exclusions << ' --tags ~@no-jruby' if RUBY_PLATFORM == 'java'
+%>
+default: --require features --strict --format progress --tags ~@wip<%= exclusions.join %> features
+wip:     --require features --tags @wip:30 --wip features

data/features/custom_formatter.feature

@@ -0,0 +1,28 @@
+Feature: Custom formatters
+
+  Scenario: a legacy custom formatter
+    Given a file named "custom_formatter.rb" with:
+      """ruby
+      require "rspec/legacy_formatters"
+      require "rspec/core/formatters/base_text_formatter"
+
+      class CustomFormatter < RSpec::Core::Formatters::BaseTextFormatter
+        def initialize(output)
+          super(output)
+        end
+
+        def example_started(proxy)
+          output << "example: " << proxy.description
+        end
+      end
+      """
+    And a file named "example_spec.rb" with:
+      """ruby
+      describe "my group" do
+        specify "my example" do
+        end
+      end
+      """
+    When I run `rspec example_spec.rb --require ./custom_formatter.rb --format CustomFormatter`
+    Then the output should contain "example: my example"
+    And  the exit status should be 0

data/features/regression_tests_for_built_in_formatters.feature

@@ -0,0 +1,86 @@
+Feature: Regression tests for built in formatters
+
+  Background:
+    Given a file named ".rspec" with:
+      """
+      --require rspec/legacy_formatters
+      --require spec_helper
+      """
+      And a file named "spec/spec_helper.rb" with:
+      """
+      RSpec.configure do |rspec|
+        rspec.raise_errors_for_deprecations!
+      end
+      """
+      And a file named "spec/passing_and_failing_spec.rb" with:
+      """ruby
+      RSpec.shared_examples "shared" do
+        it "fails" do
+          expect(1).to eq(2)
+        end
+      end
+
+      RSpec.describe "Some examples" do
+        it "passes" do
+          expect(1).to eq(1)
+        end
+
+        it "fails" do
+          expect(1).to eq(2)
+        end
+
+        it_behaves_like "shared"
+
+        context "nested" do
+          it "passes" do
+            expect(1).to eq(1)
+          end
+
+          it "fails" do
+            expect(1).to eq(2)
+          end
+        end
+      end
+      """
+      And a file named "spec/pending_spec.rb" with:
+      """ruby
+      RSpec.describe "Some pending examples" do
+        context "pending" do
+          it "is reported as pending" do
+            pending; expect(1).to eq(2)
+          end
+
+          it "is reported as failing" do
+            pending; expect(1).to eq(1)
+          end
+        end
+      end
+      """
+
+  Scenario: Use progress formatter with profiling
+    When I run `rspec --format progress --profile --order defined`
+    Then the output should contain ".FF.F*F"
+     And the output should contain "7 examples, 4 failures, 1 pending"
+     And the output should not contain any error backtraces
+
+  Scenario: Use doc formatter with profiling
+    When I run `rspec --format doc --profile --order defined`
+    Then the output should contain "is reported as pending (PENDING: No reason given)"
+     And the output should contain "7 examples, 4 failures, 1 pending"
+     And the output should not contain any error backtraces
+
+  Scenario: Use json formatter with profiling
+    When I run `rspec --format json --profile --order defined`
+    Then the output should contain:
+     """
+     "examples":
+     """
+     And the output should contain "7 examples, 4 failures, 1 pending"
+
+  Scenario: Use html formatter with profiling
+    When I run `rspec --format html --profile --order defined`
+    Then the output should contain:
+     """
+     <span class="comment"># gem install syntax to get syntax highlighting</span>
+     """
+     And the output should contain "7 examples, 4 failures, 1 pending"

data/features/regression_tests_for_custom_formatters.feature

@@ -0,0 +1,94 @@
+Feature: Regression tests for legacy custom formatters
+
+  Background:
+    Given a file named ".rspec" with:
+      """
+      --require rspec/legacy_formatters
+      --require spec_helper
+      """
+      And a file named "spec/spec_helper.rb" with:
+      """
+      # Shelling out to `stty` doesn't work in aruba, so we fake out nyancat formatter
+      # to make it avoid that.  See here:
+      # https://github.com/mattsears/nyan-cat-formatter/blob/704b9f7718eea1620175551b8ac8abec59dd0f86/lib/nyan_cat_formatter.rb#L94-L98
+      JRUBY_VERSION = 'something'
+
+      RSpec.configure do |rspec|
+        rspec.after(:suite) do
+          puts rspec.formatters.map(&:class).inspect
+        end
+      end
+      """
+      And a file named "spec/passing_and_failing_spec.rb" with:
+      """ruby
+      RSpec.describe "Some examples" do
+        it "passes" do
+          expect(1).to eq(1)
+        end
+
+        it "fails" do
+          expect(1).to eq(2)
+        end
+
+        context "nested" do
+          it "passes" do
+            expect(1).to eq(1)
+          end
+
+          it "fails" do
+            expect(1).to eq(2)
+          end
+        end
+      end
+      """
+      And a file named "spec/pending_spec.rb" with:
+      """ruby
+      RSpec.describe "Some pending examples" do
+        context "pending" do
+          it "is reported as pending" do
+            pending; expect(1).to eq(2)
+          end
+
+          it "is reported as failing" do
+            pending; expect(1).to eq(1)
+          end
+        end
+      end
+      """
+
+  Scenario: Use fuubar formatter
+    When I run `rspec --format Fuubar`
+    Then the output should contain "Progress: |============"
+     And the output should contain "6 examples, 3 failures, 1 pending"
+     And the output should not contain any error backtraces
+     And the output should not contain "ProgressFormatter"
+
+  Scenario: Use rspec-instafail formatter
+    When I run `rspec --format RSpec::Instafail`
+    Then the output should contain "6 examples, 3 failures, 1 pending"
+     And the output should not contain any error backtraces
+     And the output should not contain "ProgressFormatter"
+
+  Scenario: Use rspec-extra-formatters JUnit formatter
+    When I run `rspec --require rspec-extra-formatters --format JUnitFormatter`
+    Then the output should contain:
+      """
+      <testsuite errors="0" failures="3" skipped="1" tests="6"
+      """
+     And the output should not contain any error backtraces
+     And the output should not contain "ProgressFormatter"
+
+  Scenario: Use rspec-extra-formatters Tap formatter
+    When I run `rspec --require rspec-extra-formatters --format TapFormatter`
+    Then the output should contain "TAP version 13"
+     And the output should not contain any error backtraces
+     And the output should not contain "ProgressFormatter"
+
+  Scenario: Use fivemat formatter
+    When I run `rspec --format Fivemat --order defined`
+    Then the output should contain "Some examples .F.F"
+     And the output should not contain "ProgressFormatter"
+
+  Scenario: Use nyancat formatter
+    When I run `rspec --format NyanCatFormatter`
+    Then the output should contain "6/6: -*_*+*"

data/features/step_definitions/additional_cli_steps.rb

@@ -0,0 +1,4 @@
+Then /^the output should not contain any error backtraces$/ do
+  step %q{the output should not contain "lib/rspec/core"}
+  step %q{the output should not contain "lib/rspec/legacy_formatters"}
+end

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'aruba/cucumber'
+
+timeouts = { 'java' => 60 }
+
+Before do
+  @aruba_timeout_seconds = timeouts.fetch(RUBY_PLATFORM) { 10 }
+end
+
+Aruba.configure do |config|
+  config.before_cmd do |cmd|
+    set_env('JRUBY_OPTS', "-X-C #{ENV['JRUBY_OPTS']}") # disable JIT since these processes are so short lived
+  end
+end if RUBY_PLATFORM == 'java'

data/lib/rspec/legacy_formatters.rb

@@ -0,0 +1,59 @@
+require "rspec/legacy_formatters/version"
+require "rspec/legacy_formatters/adaptor"
+require 'stringio'
+
+# Require all of rspec-core's formatters (and supporting files).
+# We do this so that if a legacy formatter gem requires any of
+# these files, it'll be a no-op (as the file will have already
+# been required). If we didn't do this, and one of the rspec-core
+# formatters got loaded after our definition here, it could stomp
+# our definition.
+%w[
+  base_formatter
+  base_text_formatter
+  console_codes
+  deprecation_formatter
+  documentation_formatter
+  helpers
+  html_formatter
+  html_printer
+  json_formatter
+  progress_formatter
+  snippet_extractor
+].each do |formatter_file|
+  require "rspec/core/formatters/#{formatter_file}"
+end
+
+%w[
+  base_formatter
+  base_text_formatter
+  documentation_formatter
+  html_formatter
+  json_formatter
+  progress_formatter
+].each do |formatter|
+  require "rspec/legacy_formatters/#{formatter}"
+end
+
+# Namespace for the rspec code.
+module RSpec
+  # Namespace for the rspec-legacy_formatters code.
+  module LegacyFormatters
+
+    # Loads legacy formatters into an adaptor.
+    #
+    # @param formatter_class [Class] a legacy formatter class
+    # @param args [Array(IO)] output streams for formatters
+    # @return [Adaptor] a legacy formatter adaptor with an initialized legacy formatter
+    def self.load_formatter(formatter_class, *args)
+      Adaptor.new(formatter_class, *args)
+    end
+
+  end
+
+  module Core
+    # Needed for Fivemat.
+    # See https://github.com/rspec/rspec-core/pull/1129
+    PendingExampleFixedError = Pending::PendingExampleFixedError
+  end
+end