shouldit-formatters-rspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad79f17f3eea5fba84f42361f962561d9a6b084d
+  data.tar.gz: 7cb8b55308ac7eba75d4d82567abef73cbfddc7a
+SHA512:
+  metadata.gz: 52c83e51b4627617220c3ff79c279f74d05842a8b6d9da00445e3de27aff34938276ce6ac9b5a947445f7504b02477630738a67052fd1213b969e4a0d8ad8093
+  data.tar.gz: a024aa3504cc2c146f857c5601351d90de1cf5b8bb798fc7a4ddc4896cf3969fb6334f9393011e8f09e33e6f03ac87ceda61399aacc1457bc2da95a1ffde9df9

data/.gitignore

@@ -0,0 +1 @@
+.bundle

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org' do
+  gemspec
+end

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    shouldit-formatters-rspec (0.0.1)
+      rspec-core (~> 3.2)
+      rspec-expectations (~> 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec-core (3.3.0)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 10.4)
+  shouldit-formatters-rspec!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013-2014 British Broadcasting Corporation. http://www.bbc.co.uk
+
+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,24 @@
+# ShouldIT RSpec Formatter
+
+Formats RSpec output as ShouldIT compatible JSON. Compatible with RSpec 3.2+
+
+## Usage
+
+Add `shouldit-formatter-rspec` to your Gemfile
+
+    gem 'shouldit-formatters-rspec'
+
+Configure RSpec to write results to a file
+
+    require 'shouldit/formatters'
+
+    RSpec.configure do |config|
+      config.output_stream = File.open('spec/results.json', 'w')
+      config.formatter = ShouldIT::Formatters::RSpecFormatter
+    end
+
+Configure ShouldIT to watch for changes in `shouldit.conf.json`
+
+    {
+      "results": "spec/results.json"
+    }

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/shouldit.rb

@@ -0,0 +1 @@
+require_relative 'shouldit/formatters'

data/lib/shouldit/formatters.rb

@@ -0,0 +1 @@
+require_relative 'formatters/rspec_formatter'

data/lib/shouldit/formatters/rspec_formatter.rb

@@ -0,0 +1,60 @@
+require 'rspec/core'
+require 'rspec/core/formatters/base_formatter'
+require 'json'
+
+module ShouldIT
+  module Formatters
+    class RSpecFormatter < ::RSpec::Core::Formatters::BaseFormatter
+      VERSION = '0.0.1'
+
+      ::RSpec::Core::Formatters.register self, :stop, :close
+
+      attr_reader :output, :specs
+
+      def initialize(output)
+        super
+
+        @specs = {}
+      end
+
+      def stop(notification)
+        examples = notification.examples.map do |example|
+          map_example(example)
+        end
+
+        build_output(examples)
+      end
+
+      def map_example(example)
+        {
+          group: group_for(example.metadata),
+          description: example.metadata[:description],
+          result: result_for(example.metadata)
+        }
+      end
+
+      def group_for(metadata)
+        metadata[:full_description].gsub(metadata[:description], '').strip
+      end
+
+      def result_for(metadata)
+        metadata[:execution_result].status.upcase.to_s
+      end
+
+      def build_output(examples)
+        examples.each do |example|
+          group = @specs[example[:group]] || {}
+
+          @specs[example[:group]] = group.merge({
+            example[:description] => example[:result]
+          })
+        end
+      end
+
+      def close(_notification)
+        output.write @specs.to_json
+        output.close if IO === output && output != $stdout
+      end
+    end
+  end
+end

data/shouldit-formatters-rspec.gemspec

@@ -0,0 +1,23 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+require 'shouldit'
+
+Gem::Specification.new do |s|
+  s.name        = 'shouldit-formatters-rspec'
+  s.version     = ShouldIT::Formatters::RSpecFormatter::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Richard McIntyre', 'Luke Barratt']
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/should-it/shouldit-formatters-rspec'
+  s.summary     = 'ShouldIT RSpec Formatter'
+  s.description = 'Formats RSpec output as ShouldIT compatible JSON'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'rspec-core', '~> 3.2'
+  s.add_runtime_dependency 'rspec-expectations', '~> 3.2'
+
+  s.add_development_dependency 'rake', '~> 10.4'
+end

data/spec/lib/rspec/json_formatter_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'support/formatter_support'
+require 'shouldit'
+
+RSpec.describe ShouldIT::Formatters::RSpecFormatter do
+  include FormatterSupport
+
+  let(:group_description) { 'ShouldIT Example Group' }
+
+  let(:example_group) do
+    RSpec.describe group_description do
+      it 'Pass' do
+        expect(true).to eq(true)
+      end
+
+      it 'Fail' do
+        fail
+      end
+
+      it 'Pending'
+
+      context 'Nested' do
+        it 'Pass' do
+          expect(false).to eq(false)
+        end
+      end
+    end
+  end
+
+  before do
+    reporter.report(example_group.examples.size) do |runner|
+      example_group.run(runner)
+    end
+  end
+
+  it 'Renders as JSON' do
+    expect(JSON.parse(formatter_output.string)).to be_truthy
+  end
+
+  it 'Groups tests by descriptions' do
+    expect(formatter.specs).to have_key(group_description)
+  end
+
+  it 'Groups tests by nested contexts' do
+    expect(formatter.specs).to have_key("#{group_description} Nested")
+  end
+
+  it 'Contains the description and corresponding result' do
+    group_output = formatter.specs[group_description]
+
+    example_map = {
+      'Pass' => 'PASSED',
+      'Fail' => 'FAILED',
+      'Pending' => 'PENDING'
+    }
+
+    example_map.each do |description, result|
+      expect(group_output[description]).to eq(result)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec/core'
+
+RSpec.configure do |config|
+  config.color = true
+  config.order = :random
+  config.formatter = :documentation
+end

data/spec/support/formatter_support.rb

@@ -0,0 +1,35 @@
+module FormatterSupport
+  def reporter
+    @reporter ||= setup_reporter
+  end
+
+  def config
+    @configuration ||= begin
+      RSpec::Core::Configuration.new.tap do |config|
+        config.output_stream = formatter_output
+      end
+    end
+  end
+
+  def formatter
+    @formatter ||= begin
+      setup_reporter
+      @formatter
+    end
+  end
+
+  def setup_reporter
+    config.add_formatter described_class
+    @formatter = config.formatters.first
+    @reporter = config.reporter
+  end
+
+  def setup_profiler
+    config.profile_examples = true
+    reporter.setup_profiler
+  end
+
+  def formatter_output
+    @formatter_output ||= StringIO.new
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: shouldit-formatters-rspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Richard McIntyre
+- Luke Barratt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-12 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.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: Formats RSpec output as ShouldIT compatible JSON
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/shouldit.rb
+- lib/shouldit/formatters.rb
+- lib/shouldit/formatters/rspec_formatter.rb
+- shouldit-formatters-rspec.gemspec
+- spec/lib/rspec/json_formatter_spec.rb
+- spec/spec_helper.rb
+- spec/support/formatter_support.rb
+homepage: https://github.com/should-it/shouldit-formatters-rspec
+licenses:
+- MIT
+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.5
+signing_key: 
+specification_version: 4
+summary: ShouldIT RSpec Formatter
+test_files:
+- spec/lib/rspec/json_formatter_spec.rb
+- spec/spec_helper.rb
+- spec/support/formatter_support.rb