simplecov-cobertura 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d45fef6ea611d2031f6ff6848adf6c675cc65acc
+  data.tar.gz: 866477feb2d6bd962c72543b997d7be691d94caf
+SHA512:
+  metadata.gz: ac16e80d816b6d24dcc0d7cab59237210ef0a321ac0a9b71792383e5d778b8c7b9b072eca307788a0ff7187ae854e74315c67a6b78f4c0703fea24ed0e8d7218
+  data.tar.gz: ce0a9b8c6a742d3951713af95a86b723728d6245b10dfee2d9d5e2970da56041260779220c524ec7bd9d176c674830da67d681b48a029c86d32f6192976450b8

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+simplecov-cobertura.iml
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simplecov-cobertura.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,67 @@
+# simplecov-cobertura [![Build Status](https://api.shippable.com/projects/549b1fbbd46935d5fbc0f9f3/badge?branchName=master)](https://app.shippable.com/projects/549b1fbbd46935d5fbc0f9f3/builds/latest) [![Gem Version](https://badge.fury.io/rb/simplecov-cobertura.svg)](http://badge.fury.io/rb/simplecov-cobertura)
+
+Produces [Cobertura](http://cobertura.sourceforge.net/) formatted XML from [SimpleCov](https://github.com/colszowka/simplecov).
+
+Output can be consumed by the [Jenkins Cobertura Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Cobertura+Plugin) for easy 
+coverage visualization.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simplecov-cobertura'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simplecov-cobertura
+
+## Usage
+
+```ruby
+require 'simplecov-cobertura'
+
+SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+```
+
+## Continuous Integration
+Tested in a CI environment against the following Ruby versions:
+* 2.1
+* 2.0.0
+* 1.9
+
+## Known Limitations
+* No support for branch coverage
+
+## Troubleshooting
+If you get an error about not being able to install the libxml-ruby gem, do the following
+    
+    $ sudo apt-get install libxml2-dev
+
+## Contributing
+
+1. Fork it ( https://github.com/dashingrocket/simplecov-cobertura/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 a new Pull Request
+
+## License
+Copyright 2014 Dashing Rocket, Ltd.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'ci/reporter/rake/test_unit'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+end
+
+desc 'Run tests'
+task :default => ['ci:setup:testunit', :test]

data/lib/simplecov-cobertura.rb

@@ -0,0 +1,82 @@
+require 'libxml'
+require 'simplecov'
+
+class SimpleCov::Formatter::CoberturaFormatter
+  RESULT_FILE_NAME = 'coverage.xml'
+  DTD_URL = 'http://cobertura.sourceforge.net/xml/coverage-04.dtd'
+
+  def format(result)
+    xml = result_to_xml result
+    
+    result_path = File.join( SimpleCov.coverage_path, RESULT_FILE_NAME )
+    File.write(result_path, xml)
+    
+    puts "Coverage report generated for #{result.command_name} to #{result_path}"
+    
+    return xml
+  end
+  
+  private
+  def result_to_xml(result)
+    root_dir = SimpleCov.root
+    
+    doc = LibXML::XML::Document.new()
+    doc.root = LibXML::XML::Node.new('coverage')
+    coverage = doc.root
+
+    coverage['line-rate'] = (result.covered_percent/100).round(2).to_s
+    coverage['branch-rate'] = '0'
+    coverage['lines-covered'] = result.covered_lines.to_s
+    coverage['lines-valid'] = (result.covered_lines + result.missed_lines).to_s
+    coverage['branches-covered'] = '0'
+    coverage['branches-valid'] = '0'
+    coverage['branch-rate'] = '0'
+    coverage['complexity'] = '0'
+    coverage['version'] = '0'
+    coverage['timestamp'] = Time.now.to_i.to_s
+
+    coverage << sources = LibXML::XML::Node.new('sources')
+    sources << source = LibXML::XML::Node.new('source')
+    source << root_dir
+
+    coverage << packages = LibXML::XML::Node.new('packages')
+    packages << package = LibXML::XML::Node.new('package')
+    package['name'] = 'simplecov-cobertura'
+    package['line-rate'] = (result.covered_percent/100).round(2).to_s
+    package['branch-rate'] = '0'
+    package['complexity'] = '0'
+
+    package << classes = LibXML::XML::Node.new('classes')
+
+    result.files.each do |file|
+      filename = file.filename
+      path = filename.gsub(File.join(root_dir, ''), '')
+
+      classes << class_ = LibXML::XML::Node.new('class')
+      class_['name'] = File.basename(filename, '.*')
+      class_['filename'] = path
+      class_['line-rate'] = (file.covered_percent/100).round(2).to_s
+      class_['branch-rate'] = '0'
+      class_['complexity'] = '0'
+
+      class_ << methods = LibXML::XML::Node.new('methods')
+      class_ << lines = LibXML::XML::Node.new('lines')
+
+      file.lines.each do |file_line|
+        if file_line.covered? || file_line.missed?
+          lines << line = LibXML::XML::Node.new('line')
+          line['number'] = file_line.line_number.to_s
+          line['branch'] = 'false'
+          line['hits'] = file_line.coverage.to_s
+        end
+      end
+    end
+
+    text = doc.to_s
+    lines = text.split("\n")
+    lines.insert(1, "<!DOCTYPE coverage SYSTEM \"#{DTD_URL}\">")
+    lines.insert(2, '<!-- Generated by simplecov-cobertura -->')
+    lines.join("\n")
+  end
+end
+

data/shippable.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+rvm:
+  - 2.1
+  - 2.0.0
+  - 1.9
+  
+env:
+  - CI_REPORTS=shippable/testresults COVERAGE_REPORTS=shippable/codecoverage
+  
+cache: true
+  
+notifications:
+  email:
+    recipients:
+      - jbowes@dashingrocket.com
+    on_success: change
+    on_failure: always

data/simplecov-cobertura.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simplecov-cobertura'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Jesse Bowes']
+  spec.email         = ['jbowes@dashingrocket.com']
+  spec.summary       = 'SimpleCov Cobertura Formatter'
+  spec.description   = 'Produces Cobertura XML formatted output from SimpleCov'
+  spec.homepage      = 'https://github.com/dashingrocket/simplecov-cobertura'
+  spec.license       = 'Apache-2.0'
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'ci_reporter_test_unit', '~> 1.0'
+
+  spec.add_runtime_dependency 'libxml-ruby', '~> 2.7'
+  spec.add_runtime_dependency 'simplecov', '~> 0.8'
+end

data/test/simplecov-cobertura_test.rb

@@ -0,0 +1,32 @@
+require 'test/unit'
+require 'libxml'
+require 'open-uri'
+require 'simplecov-cobertura'
+
+class CoberturaFormatterTest < Test::Unit::TestCase
+
+  def setup
+    @result = SimpleCov::Result.new("#{__FILE__}" => [1,2])
+    @formatter = SimpleCov::Formatter::CoberturaFormatter.new
+  end
+
+  def teardown
+    # Do nothing
+  end
+
+  def test_format_save_file
+    xml = @formatter.format(@result)
+    result_path = File.join(SimpleCov.coverage_path, SimpleCov::Formatter::CoberturaFormatter::RESULT_FILE_NAME)
+    assert_not_empty(xml)
+    assert_equal(xml, IO.read(result_path))
+  end
+  
+  def test_format_dtd_validates
+    xml = @formatter.format(@result)
+    
+    dtd_text = open(SimpleCov::Formatter::CoberturaFormatter::DTD_URL) { |io| io.read }
+    dtd = LibXML::XML::Dtd.new(dtd_text)
+    doc = LibXML::XML::Document.string(xml)
+    assert_true doc.validate(dtd)
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-cobertura
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jesse Bowes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter_test_unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Produces Cobertura XML formatted output from SimpleCov
+email:
+- jbowes@dashingrocket.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/simplecov-cobertura.rb
+- shippable.yml
+- simplecov-cobertura.gemspec
+- test/simplecov-cobertura_test.rb
+homepage: https://github.com/dashingrocket/simplecov-cobertura
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: SimpleCov Cobertura Formatter
+test_files:
+- test/simplecov-cobertura_test.rb