rspec-ontap 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ef09b51496338e3c6b5091d3ce38aecd3020da0
+  data.tar.gz: d59e58f5b115d74d1ef25fe37491bc0cbd33ae9f
+SHA512:
+  metadata.gz: 2cc6d1be7dd968bbe18991b72bcc81672a65554101ceb18f61a89023cecc86d0463ceb4ef27f3b3daa8d8cf092a92bf8e705bcaf5ea5a8ab8069c18f5903e36c
+  data.tar.gz: b1933d4b045be9f482e77f0e8b0e1bfcce2f4bb47e812c939743008dd9ca31e1ce0991dec44709c74f85d37394cb9ed6cc9fe468992cc1ad7f3bbe36a9abc681

data/.index

@@ -0,0 +1,56 @@
+---
+revision: 2013
+type: ruby
+sources:
+- INDEX.yml
+authors:
+- name: Trans
+  email: transfire@gmail.com
+organizations:
+- name: Rubyworks
+requirements:
+- name: rspec
+- name: tapout
+- groups:
+  - build
+  development: true
+  name: mast
+- groups:
+  - build
+  development: true
+  name: indexer
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/rspec-ontap
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/rspec-ontap
+  label: Source Code
+- type: bugs
+  uri: http://github.com/rubyworks/rspec-ontap/issues
+  label: Issue Tracker
+- type: chat
+  uri: irc://chat.us.freenode.net#rubyworks
+  label: IRC Channel
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/rspec-ontap.git
+categories: []
+copyrights:
+- holder: Rubyworks
+  year: '2011'
+  license: BSD-2-Clause
+customs: []
+paths:
+  lib:
+  - lib
+name: rspec-ontap
+title: RSpec-On-Tap
+version: 0.3.0
+summary: RSpec On Tap-Y/J
+description: RSpec-On-Tap is a TAP-Y/J formatter for RSpec.
+created: '2011-12-13'
+date: '2015-01-17'

data/.yardopts

@@ -3,5 +3,7 @@
 --private
 lib/
 -
-[A-Z]*.*
+*.md
+*.txt
+*.yml
 

data/HISTORY.md

@@ -1,5 +1,16 @@
 # Release History
 
+## 0.3.0 / 2014-01-17
+
+This is a major overhaul of the formatter to work with RSpec 3+.
+It will no longer work with older versions of RSpec! Please use
+version 0.2.0 of this plugin if you need that.
+
+Changes:
+
+* Register formmater per new RSpec 3 API.
+* Change callback methods to use v3 Notification classes.
+
 
 ## 0.2.0 / 2012-02-01
 

data/LICENSE.txt

@@ -0,0 +1,21 @@
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -9,27 +9,38 @@
 
 **RSpec On Tap** is a TAP-Y/J formatter for RSpec.
 
+The latest version works with **RSpec 3+ only**.
+
 You can learn more about TAP-Y/J [here](https://github.com/rubyworks/tapout).
 
 
 ## Usage
 
-Usage is simply a matter of passing the name of the format class to
-the `rspec` command via the `-f` option.
+Usage is simply a matter of requiring the plugin and passing the name of the
+format class to the `rspec` command via the `-f` option.
 
-    $ rspec -r rspec/ontap -f TapY spec/*.rb
+    $ rspec -r rspec/ontap -f RSpec::TapY spec/*.rb
 
-or
+This can be shortened to just:
 
     $ rspec -f RSpec::TapY spec/*.rb
 
-With TAP-Y in hand, the `tapout` tool can then be used to produce a
-variety of other output formats. For example:
+This works because RSpec will automatically require a related path -- in this
+case `rspec/tap_y` -- if the class if initially undefined. The library file
+`rspec/tap_y` itself simply requires `rspec/ontap` (the same is true for
+`rspec/tap_j`).
+
+With TAP-Y output in hand, the `tapout` tool can then be used to produce a
+variety of other output formats. First, make sure Tapout is installed:
+
+    $ gem install tapout
+
+Then, for example:
 
     $ rspec -f RSpec::TapY spec/*.rb | tapout progress
 
-See the [TapOut project](http://rubyworks.github.com/tapout) for more
-information.
+See the [TapOut project](http://rubyworks.github.com/tapout) for more information.
+
 
 
 ## Installation
@@ -38,6 +49,12 @@ Installation follows the usual pattern:
 
     $ gem install rspec-ontap
 
+Or using your Gemfile, add something like:
+
+    group :test do
+      gem "rspec-ontap", :require => false
+    end
+
 
 ## Copyrights
 
@@ -45,5 +62,5 @@ Copyright (c) 2011 Rubyworks. All Rights Reserved.
 
 RSpecOnTap is distributable in accordance with the *FreeBSD* license.
 
-See COPYING.md for details.
+See LICENSE.txt for details.
 

data/lib/rspec/ontap.rb

@@ -13,8 +13,6 @@ module RSpec
     #
     attr_accessor :example_group_stack
 
-    #
-    #
     #
     def initialize(output)
       super(output)
@@ -29,15 +27,16 @@ module RSpec
     # This will only be invoked once, and the next one to be invoked
     # is #example_group_started
     #
-    def start(example_count)
-      super(example_count)
+    def start(notification)
+      # there is a super method for this
+      super(notification)
 
       @start_time = Time.now
 
       doc = {
         'type'  => 'suite',
         'start' => @start_time.strftime('%Y-%m-%d %H:%M:%S'),
-        'count' => example_count,
+        'count' => notification.count,
         'seed'  => @seed,
         'rev'   => REVISION
       }
@@ -51,12 +50,13 @@ module RSpec
     # The next method to be invoked after this is +example_passed+,
     # +example_pending+, or +example_finished+
     #
-    def example_group_started(example_group)
-      super(example_group) #@example_group = example_group
+    def example_group_started(notification)
+      # there is a super method for this
+      super(notification)
       doc = {
         'type'    => 'case',
         'subtype' => 'describe',
-        'label'   => "#{example_group.description}",
+        'label'   => "#{notification.group.description}",
         'level'   => @example_group_stack.size
       }
       @example_group_stack << example_group
@@ -65,20 +65,24 @@ module RSpec
 
     # This method is invoked at the end of the execution of each example group.
     # +example_group+ is the example_group.
-    def example_group_finished(example_group)
+    def example_group_finished(notification)
+      #super(notification)
       @example_group_stack.pop
     end
 
+    # Set up stdout and stderr to be captured.
+    #
+    # IMPORTANT: Comment out the `reset_output` line to debug!!!!!!!!!
     #
-    def example_started(example)
-      examples << example
-      # set up stdout and stderr to be captured
+    def example_started(notification)
       reset_output
     end
 
     #
-    def example_passed(example)
-      super(example)
+    def example_passed(notification)
+      #super(notification)
+
+      example = notification.example
 
       file, line = example.location.split(':')
       file = self.class.relative_path(file)
@@ -110,8 +114,10 @@ module RSpec
     end
 
     #
-    def example_pending(example)
-      super(example)
+    def example_pending(notification)
+      #super(notification)
+
+      example = notification.example
 
       file, line = example.location.split(':')
       file = self.class.relative_path(file)
@@ -140,12 +146,15 @@ module RSpec
       return doc
     end
 
-    def example_failed(example)
-      super(example)
+    #
+    def example_failed(notification)
+      #super(notification)
+
+      example = notification.example
 
       file, line = example.location.split(':')
 
-      file = self.class.relative_path(file)
+      file = relative_path(file)
       line = line.to_i
 
       if RSpec::Expectations::ExpectationNotMetError === example.exception
@@ -159,7 +168,7 @@ module RSpec
         status = 'error'
       end
 
-      backtrace = format_backtrace(example.exception.backtrace, example)
+      backtrace = format_backtrace(example.exception.backtrace, example.metadata)
 
       efile, eline = parse_source_location(backtrace)
 
@@ -206,20 +215,20 @@ module RSpec
       return doc
     end
 
-    # @todo Is this a note?
-    def message(message)
-    end
+    # This method is invoked after the dumping of examples and failures.
+    def dump_summary(summary_notification)
+      #super(summary_notification)
 
-    #def stop
-    #end
+      duration      = summary_notification.duration
+      example_count = summary_notification.examples.size
+      failure_count = summary_notification.failed_examples.size
+      pending_count = summary_notification.pending_examples.size
 
-    # This method is invoked after the dumping of examples and failures.
-    def dump_summary(duration, example_count, failure_count, pending_count)
-      super(duration, example_count, failure_count, pending_count)
+      failed_examples = summary_notification.failed_examples
 
       error_count = 0
 
-      @failed_examples.each do |e|
+      failed_examples.each do |e|
         if RSpec::Expectations::ExpectationNotMetError === e.exception
           #failure_count += 1
         else
@@ -249,8 +258,45 @@ module RSpec
     #def dump_pending
     #end
 
-    def seed(number)
-      @seed = number
+    def seed(notification)
+      @seed = notification.seed
+    end
+
+    # Add any messages as notes.
+    def message(message_notification)
+      doc = {
+        'type' => 'note',
+        'text' => message_notification.message
+      }
+      return doc
+    end
+
+    #
+    # NOTE: None of the following are being used. If ever added, be sure
+    #       to activate in register calls below.
+    #
+
+    # (not used)
+    def stop(examples_notification)
+      super(examples_notification)
+    end
+
+    # (not used)
+    def start_dump(null_notification)
+    end
+
+    # (not used)
+    def dump_pending(examples_notification)
+    end
+
+    # (not used)
+    def dump_failures(examples_notification)
+    end
+
+    # (not used)
+    def close(null_notification)
+      # there is a super method for this
+      super(null_notification)
     end
 
   private
@@ -308,6 +354,8 @@ module RSpec
 
     #
     def captured_output
+      return unless (@_newout && @_newerr)
+
       stdout = @_newout.string.chomp("\n")
       stderr = @_newerr.string.chomp("\n")
 
@@ -335,58 +383,125 @@ module RSpec
       $stderr = ostderr
     end
 
+    #
+    def relative_path_regex
+      @relative_path_regex ||= /(\A|\s)#{File.expand_path('.')}(#{File::SEPARATOR}|\s|\Z)/
+    end
+
+    # Get relative path of file.
+    #
+    # line - current code line [String] 
+    #
+    # Returns relative path to line. [String] 
+    def relative_path(line)
+      line = line.sub(relative_path_regex, "\\1.\\2".freeze)
+      line = line.sub(/\A([^:]+:\d+)$/, '\\1'.freeze)
+      return nil if line == '-e:1'.freeze
+      line
+    rescue SecurityError
+      nil
+    end
+
+    #
+    def format_backtrace(*args)
+      backtrace_formatter.format_backtrace(*args)
+    end
+
+    #
+    def backtrace_formatter
+      RSpec.configuration.backtrace_formatter
+    end
+
   end
 
   #
   class TapY < TapBaseFormatter
-    def initialize(*whatever)
+    ::RSpec::Core::Formatters.register self, 
+        :start,
+        :example_group_started,
+        :example_group_finished,
+        :example_started,
+        :example_passed,
+        :example_failed,
+        :example_pending,
+        :dump_summary,
+        :seed,
+        :message,
+        #:stop,
+        #:start_dump,
+        #:dump_pending,
+        #:dump_failures,
+        :close
+
+    def initialize(*args)
       require 'yaml'
-      super(*whatever)
+      super(*args)
     end
-    def start(example_count)
-      output.puts super(example_count).to_yaml
+    def start(*args)
+      output.puts super(*args).to_yaml
     end
-    def example_group_started(example_group)
-      output.puts super(example_group).to_yaml
+    def example_group_started(*args)
+      output.puts super(*args).to_yaml
     end
-    def example_passed(example)
-      output.puts super(example).to_yaml
+    def example_passed(*args)
+      output.puts super(*args).to_yaml
     end
-    def example_pending(example)
-      output.puts super(example).to_yaml
+    def example_pending(*args)
+      output.puts super(*args).to_yaml
     end
-    def example_failed(example)
-      output.puts super(example).to_yaml
+    def example_failed(*args)
+      output.puts super(*args).to_yaml
     end
-    def dump_summary(duration, example_count, failure_count, pending_count)
-      output.puts super(duration, example_count, failure_count, pending_count).to_yaml
+    #def dump_summary(duration, example_count, failure_count, pending_count)
+    #  output.puts super(duration, example_count, failure_count, pending_count).to_yaml
+    #  output.puts "..."
+    #end
+    def dump_summary(*args)
+      output.puts super(*args).to_yaml
       output.puts "..."
     end
   end
 
   #rspec -f RSpec::TapY spec/*.rb | tapout progress
   class TapJ < TapBaseFormatter
-    def initialize(*whatever)
+    ::RSpec::Core::Formatters.register self, 
+        :start,
+        :example_group_started,
+        :example_group_finished,
+        :example_started,
+        :example_passed,
+        :example_failed,
+        :example_pending,
+        :dump_summary,
+        :seed,
+        :message,
+        #:stop,
+        #:start_dump,
+        #:dump_pending,
+        #:dump_failures,
+        :close
+
+    def initialize(*args)
       require 'json'
-      super(*whatever)
+      super(*args)
     end
-    def start(example_count)
-      output.puts super(example_count).to_json
+    def start(*args)
+      output.puts super(*args).to_json
     end
-    def example_group_started(example_group)
-      output.puts super(example_group).to_json
+    def example_group_started(*args)
+      output.puts super(*args).to_json
     end
-    def example_passed(example)
-      output.puts super(example).to_json
+    def example_passed(*args)
+      output.puts super(*args).to_json
     end
-    def example_pending(example)
-      output.puts super(example).to_json
+    def example_pending(*args)
+      output.puts super(*args).to_json
     end
-    def example_failed(example)
-      output.puts super(example).to_json
+    def example_failed(*args)
+      output.puts super(*args).to_json
     end
-    def dump_summary(duration, example_count, failure_count, pending_count)
-      output.puts super(duration, example_count, failure_count, pending_count).to_json
+    def dump_summary(*args)
+      output.puts super(*args).to_json
     end
   end
 

metadata

@@ -1,90 +1,112 @@
 --- !ruby/object:Gem::Specification
 name: rspec-ontap
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Trans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-01 00:00:00.000000000 Z
+date: 2015-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &11523640 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11523640
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tapout
-  requirement: &11522360 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11522360
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mast
+  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: detroit
-  requirement: &11521320 !ruby/object:Gem::Requirement
-    none: false
+  name: indexer
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11521320
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: RSpec-On-Tap is a TAP-Y/J formatter for RSpec.
 email:
 - transfire@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- COPYING.rdoc
-- HISTORY.md
+- LICENSE.txt
 - README.md
+- HISTORY.md
 files:
-- .ruby
+- .index
 - .yardopts
 - lib/rspec/ontap.rb
 - lib/rspec/tap_j.rb
 - lib/rspec/tap_y.rb
-- HISTORY.md
 - README.md
-- COPYING.rdoc
+- HISTORY.md
+- LICENSE.txt
 homepage: http://rubyworks.github.com/rspec-ontap
 licenses:
 - BSD-2-Clause
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: RSpec On Tap-Y/J
 test_files: []
+has_rdoc: 

data/.ruby

@@ -1,38 +0,0 @@
----
-source:
-- var
-authors:
-- name: Trans
-  email: transfire@gmail.com
-copyrights:
-- holder: Rubyworks
-  year: '2011'
-  license: BSD-2-Clause
-replacements: []
-alternatives: []
-requirements:
-- name: rspec
-- name: tapout
-- name: detroit
-  groups:
-  - build
-  development: true
-dependencies: []
-conflicts: []
-repositories: []
-resources:
-  home: http://rubyworks.github.com/rspec-ontap
-  code: http://github.com/rubyworks/rspec-ontap
-  mail: http://google.groups.com/groups/rubyworks-mailinglist
-extra: {}
-load_path:
-- lib
-revision: 0
-created: '2011-12-13'
-summary: RSpec On Tap-Y/J
-title: RSpec-On-Tap
-version: 0.2.0
-name: rspec-ontap
-description: RSpec-On-Tap is a TAP-Y/J formatter for RSpec.
-organization: Rubyworks
-date: '2012-02-01'

data/COPYING.rdoc

@@ -1,32 +0,0 @@
-= COPYRIGHT NOTICES
-
-== RSpecOnTap
-
-Copyright:: (c) 2008 Rubyworks
-License:: BSD-2-Clause
-Website:: http://rubyworks.github.com/rspec-ontap
-
-  Copyright 2008 Rubyworks. All rights reserved.
-
-  Redistribution and use in source and binary forms, with or without
-  modification, are permitted provided that the following conditions are met:
-
-     1. Redistributions of source code must retain the above copyright notice,
-        this list of conditions and the following disclaimer.
-
-     2. Redistributions in binary form must reproduce the above copyright
-        notice, this list of conditions and the following disclaimer in the
-        documentation and/or other materials provided with the distribution.
-
-  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
-  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
-  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
-  COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
-  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
-  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
-  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
-  OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
-  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-