sauce_documentation 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97f09861c2efaf81d2a24b4f8636bb6658315aed
+  data.tar.gz: 13c0df048a70140d662eec5908e63e10e415f4eb
+SHA512:
+  metadata.gz: f1a1999e7d836795c08d9341429224d6e1ccecf9bbc783609e3c320fe761e303e665692661aa34b1153146b896a9b232ea64008c7b53f3c1ea27331162c02086
+  data.tar.gz: 6b8fe614763f9143363036b8e65d29c87a0a129040957b1f0b0196f3c8d616a5c747c23e42a9368aa7ca009780d613db76c08aaef62857168f83f5412842cfac

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,2 @@
+coverage/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Style/Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.3
+script:
+  - bundle exec thor spec
+  - bundle exec thor cover
+notifications:
+  email:
+    on_success: never
+    on_failure: never

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'coveralls', require: false

data/README.md

@@ -0,0 +1,37 @@
+# Sauce Documentation Formater 
+[![Gem Version](https://badge.fury.io/rb/sauce_documentation_formatter.svg)](https://rubygems.org/gems/sauce_documentation_formatter)
+[![Build Status](https://travis-ci.org/bootstraponline/sauce_documentation_formatter.svg)](https://travis-ci.org/bootstraponline/sauce_documentation_formatter/builds)
+[![Dependency Status](https://gemnasium.com/bootstraponline/sauce_documentation_formatter.svg)](https://gemnasium.com/bootstraponline/sauce_documentation_formatter)
+[![Coverage Status](https://coveralls.io/repos/bootstraponline/sauce_documentation_formatter/badge.svg?nocache2)](https://coveralls.io/r/bootstraponline/sauce_documentation_formatter)
+
+## Usage
+
+```ruby
+# spec_helper.rb
+require 'sauce_documentation'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    config.add_formatter SauceDocumentation
+  end
+end
+```
+
+Identical to RSpec Documentation formatter except the `example.metadata[:sauce_test_link]`
+is used to output the sauce test link.
+
+# Example output
+
+```
+  2) SauceDocumentation fails and outputs sauce link
+     Failure/Error: expect(3).to eq(4)
+       
+       expected: 4
+            got: 3
+       
+       (compared using ==)
+       
+       https://saucelabs.com/beta/tests/1234
+       
+     # ./formatter_spec/sauce_documentation_spec.rb:16:in `block (2 levels) in <top (required)>'
+```

data/Thorfile

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'appium_thor'
+
+Appium::Thor::Config.set do
+  gem_name 'sauce_documentation'
+  github_owner 'bootstraponline'
+  version_file 'lib/sauce_documentation/version.rb'
+end
+
+# Must use '::' otherwise Default will point to Thor::Sandbox::Default
+# Debug by calling Thor::Base.subclass_files via Pry
+#
+# https://github.com/erikhuda/thor/issues/484
+#
+# rubocop:disable Style/ClassAndModuleChildren
+class ::Default < Thor
+  desc 'spec', 'Run RSpec tests'
+  def spec
+    exec 'bundle exec rspec spec'
+  end
+
+  desc 'cover', 'Push coverage results to coveralls'
+  def cover
+    require 'coveralls'
+    Coveralls.push!
+  end
+
+  # so many errors.
+  desc 'cop', 'Execute rubocop'
+  def cop
+    exec 'bundle exec rubocop --display-cop-names lib/'
+  end
+end

data/formatter_spec/sauce_documentation_spec.rb

@@ -0,0 +1,18 @@
+require_relative 'spec_helper'
+
+describe 'SauceDocumentation' do
+  def add_sauce_link
+    RSpec.current_example.metadata[:sauce_test_link] = 'https://saucelabs.com/beta/tests/1234'
+  end
+
+  it 'fails and does not output sauce link' do
+    # if we're not using sauce_rspec then we should see the regular failure
+    # except omit the link
+    expect(1).to eq(2)
+  end
+
+  it 'fails and outputs sauce link' do
+    add_sauce_link
+    expect(3).to eq(4)
+  end
+end

data/formatter_spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require_relative 'start_coverage'
+
+require 'rspec'
+require_relative '../lib/sauce_documentation'
+
+RSpec.configure do |config|
+  config.add_formatter SauceDocumentation
+end

data/formatter_spec/start_coverage.rb

@@ -0,0 +1,6 @@
+require 'simplecov'
+require 'coveralls'
+
+# Omit coveralls formatter since we're merging suite results via a Thor task
+# https://coveralls.zendesk.com/hc/en-us/articles/201769485-Ruby-Rails
+SimpleCov.start { add_filter File.basename(__dir__) }

data/lib/sauce_documentation/sauce_documentation.rb

@@ -0,0 +1,45 @@
+class SauceDocumentation < RSpec::Core::Formatters::DocumentationFormatter
+  RSpec::Core::Formatters.register self, :dump_failures
+
+  #
+  # Modifying the exception backtrace causes the default formatter to prepend #
+  #
+  # If the link is outputted after failure.fully_formatted then the backtrace
+  # will always appear before the Sauce job link
+  #
+  # By updating the exception message with instance_eval, the job link will
+  # show up after the message and before the backtrace without additional
+  # formatting.
+  #
+
+  def dump_failures(notification)
+    failure_notifications = notification.failure_notifications
+    return if failure_notifications.empty?
+
+    failure_notifications.each do |failure|
+      exception = failure.exception
+      next unless exception
+
+      sauce_test_link = failure.example.metadata[:sauce_test_link]
+      next unless sauce_test_link
+
+      # Use nonbreaking space to bypass message.strip and ensure we have
+      # a newline after the message and before the stack trace.
+      nbsp = "\u00A0"
+      message = "#{exception.message}\n#{sauce_test_link}\n#{nbsp}"
+      exception.instance_eval <<-RUBY
+        def message
+          %q(#{message})
+        end
+
+        def to_s
+          message
+        end
+      RUBY
+    end
+
+    # Use default RSpec logic to format the failures now that we've
+    # attached the Sauce test link to the exceptions
+    super
+  end
+end

data/lib/sauce_documentation/version.rb

@@ -0,0 +1,4 @@
+module SauceDocumentationMetadata
+  VERSION = '0.0.3' unless defined? ::SauceDocumentationMetadata::VERSION
+  DATE    = '2015-10-19' unless defined? ::SauceDocumentationMetadata::DATE
+end

data/lib/sauce_documentation.rb

@@ -0,0 +1,2 @@
+require_relative 'sauce_documentation/version'
+require_relative 'sauce_documentation/sauce_documentation'

data/release_notes.md

@@ -0,0 +1,4 @@
+#### v0.0.3 2015-10-19
+
+- [04105e3](https://github.com/bootstraponline/sauce_documentation/commit/04105e3076fd854dcc767b6eee16e5d553880854) Release 0.0.3
+- [47ca8db](https://github.com/bootstraponline/sauce_documentation/commit/47ca8db285f55ca963acf5b57294c28aa99e8498) Fix gemname

data/sauce_documentation.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/sauce_documentation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sauce_documentation'
+  spec.version       = SauceDocumentationMetadata::VERSION
+  spec.date          = SauceDocumentationMetadata::DATE
+  spec.license       = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+  spec.description   = spec.summary = 'Sauce documentation formatter for RSpec'
+  spec.description   += '.' # avoid identical warning
+  spec.authors       = spec.email = ['code@bootstraponline.com']
+  spec.homepage      = 'https://github.com/bootstraponline/sauce_rspec'
+  spec.require_paths = ['lib']
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.add_runtime_dependency 'rspec', '>= 3.3.0'
+
+  spec.add_development_dependency 'pry', '~> 0.10.2'
+  spec.add_development_dependency 'rubocop', '~> 0.34.2'
+  spec.add_development_dependency 'appium_thor', '~> 1.0.1'
+  spec.add_development_dependency 'simplecov', '~> 0.10.0'
+  spec.add_development_dependency 'coveralls', '~> 0.8.3'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: sauce_documentation
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- code@bootstraponline.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.34.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.34.2
+- !ruby/object:Gem::Dependency
+  name: appium_thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+description: Sauce documentation formatter for RSpec.
+email:
+- code@bootstraponline.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Thorfile
+- formatter_spec/sauce_documentation_spec.rb
+- formatter_spec/spec_helper.rb
+- formatter_spec/start_coverage.rb
+- lib/sauce_documentation.rb
+- lib/sauce_documentation/sauce_documentation.rb
+- lib/sauce_documentation/version.rb
+- release_notes.md
+- sauce_documentation.gemspec
+homepage: https://github.com/bootstraponline/sauce_rspec
+licenses:
+- http://www.apache.org/licenses/LICENSE-2.0.txt
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Sauce documentation formatter for RSpec
+test_files: []
+has_rdoc: