ci_reporter 1.9.3 → 2.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34f5a7865cd653a40cd2653f9d0b4c75133687f2
-  data.tar.gz: 5e2c5a5eafe7c82250edad86fa5db7016b25bcae
+  metadata.gz: 818b7ca178f6055f90139af88c19856b921a2001
+  data.tar.gz: 785075435480302645e4cddddfb130aa9c5716f2
 SHA512:
-  metadata.gz: b890b77ab076f3911848f8233fa20818d2a2151760c0f6386efded88ddf7705fc5ac9f2ee7cbf05e0abaa5c2b78d93368ee6ecb25bc8f33f68bfff7d70ede07d
-  data.tar.gz: 1e7ea879c89329de0706a1c60b7babba94c8e6f0d6a4df2096a1848c50687e99febe4dff089fba78baff5ddf3400657c74804302069b61d4248bb69ad4dc0099
+  metadata.gz: a7fa510d753444985ce7a6224e374cbec231238d77aa4699ccfc4ec721724cc21e8517af4f09553c0616c7ce2af738e7825f0a4a7b4d4fda5e21813935f96137
+  data.tar.gz: 3f817a975671ec431d99af56c292f5c2c821fc5aaa8be906f592069be63f52a23cd1fae81947e1f60c7624eb6e5d442b7b38d065de7da6eba6327cd6dd1815b4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -1,9 +1,5 @@
 rvm:
   - 1.9.3
-  - 2.0.0
+  - 2.0
+  - 2.1
   - jruby
-branches:
-  only:
-    - master
-before_install:
-  - ./.travis.before_install.sh

data/Gemfile

@@ -1,12 +1,3 @@
-#--
-# Copyright (c) 2006-2014 Nick Sieger <nicksieger@gmail.com>
-# See the file LICENSE.txt included with the distribution for
-# software license details.
-#++
-
 source 'https://rubygems.org'
 
 gemspec
-group :development do
-  gem 'jruby-openssl', :platform => :jruby
-end

data/History.txt

@@ -1,7 +1,3 @@
-== 1.9.3 (10/06/14)
-
-- GH #150 include the suite name when filtering test methods (Ben Dean)
-
 == 1.9.2 (04/06/14)
 
 - GH #119: add timestamp attribute (Shawn Zhu)

data/LICENSE.txt

@@ -1,21 +1,23 @@
-# Copyright (c) 2006-2012 Nick Sieger <nicksieger@gmail.com>
-# 
-# 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.
+Copyright (c) 2006-2014 Nick Sieger <nicksieger@gmail.com>
+Copyright (c) 2014 The CI Reporter authors
+
+MIT License
+
+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,90 @@
+CI::Reporter is an add-on to Ruby testing frameworks like Test::Unit
+or RSpec that allows you to generate XML reports of your test
+runs. The resulting files can be read by a continuous integration
+system that understands Ant's JUnit report XML format, thus allowing
+your CI system to track test/spec successes and failures.
+
+[![Build Status](https://travis-ci.org/nicksieger/ci_reporter.svg?branch=master)](https://travis-ci.org/nicksieger/ci_reporter)
+
+## Usage
+
+CI::Reporter works with projects that use standard Rake tasks for
+running tests. In this fashion, it hooks into testing frameworks using
+environment variables recognized by these custom tasks to inject the
+CI::Reporter code into the test run.
+
+Each supported testing framework is provided by a separate gem:
+
+* [Cucumber][ci-cuke]
+* [Minitest][ci-mt]
+* [RSpec][ci-rspec]
+* [Spinach][ci-spin]
+* [Test::Unit][ci-tu]
+
+[ci-cuke]: https://github.com/ci-reporter/ci_reporter_cucumber
+[ci-mt]: https://github.com/ci-reporter/ci_reporter_minitest
+[ci-rspec]: https://github.com/ci-reporter/ci_reporter_rspec
+[ci-spin]: https://github.com/ci-reporter/ci_reporter_spinach
+[ci-tu]: https://github.com/ci-reporter/ci_reporter_test_unit
+
+## Jenkins setup
+
+1. Tick the box labelled "Publish JUnit test result report" in the job
+configuration
+
+2. Enter "test/reports/*.xml,spec/reports/*.xml" in the "Test report
+XMLs" field (adjust this to suit which tests you are running)
+
+Report files are written, by default, to the
+<code>test/reports</code>, <code>features/reports</code> or
+<code>spec/reports</code> subdirectory of your project.  If you wish
+to customize the location, simply set the environment variable
+CI_REPORTS (either in the environment, on the Rake command line, or in
+your Rakefile) to the location where they should go.
+
+## Conditional reporting
+
+You may not wish to always produce report files. There are two primary
+ways to configure this:
+
+### With environment variables
+
+Use an environment variable in your Rakefile to control if CI:Reporter
+will be invoked:
+
+```ruby
+if ENV['GENERATE_REPORTS'] == 'true'
+  require 'ci/reporter/rake/rspec'
+  task :rspec => 'ci:setup:rspec'
+end
+```
+
+You can either inject this variable in your CI or simply call `rake`
+with the environment variable set:
+
+```
+GENERATE_REPORTS=true rake rspec
+```
+
+### With CI-specific Rake tasks
+
+Instead of modifying your existing Rake tasks, create new ones:
+
+```ruby
+namespace :ci do
+  task :all => ['ci:setup:rspec', 'rspec']
+end
+```
+
+Then use this Rake target in CI:
+
+```
+rake ci:all
+```
+
+## Environment Variables
+
+* `CI_REPORTS`: if set, points to a directory where report files will
+  be written.
+* `CI_CAPTURE`: if set to value "off", stdout/stderr capture will be
+  disabled.

data/Rakefile

@@ -1,103 +1,9 @@
-#--
-# Copyright (c) 2006-2014 Nick Sieger <nicksieger@gmail.com>
-# See the file LICENSE.txt included with the distribution for
-# software license details.
-#++
-
-require 'bundler/setup'
-
-begin
-  require 'hoe'
-  Hoe.plugin :git
-  require File.dirname(__FILE__) + '/lib/ci/reporter/version'
-  hoe = Hoe.spec("ci_reporter") do |p|
-    p.version = CI::Reporter::VERSION
-    p.group_name = "caldersphere"
-    p.readme_file = "README.rdoc"
-    p.urls = ["https://github.com/nicksieger/ci_reporter"]
-    p.author = "Nick Sieger"
-    p.email = "nick@nicksieger.com"
-    p.readme_file = 'README.rdoc'
-    p.summary = "CI::Reporter allows you to generate reams of XML for use with continuous integration systems."
-    p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-    p.description = p.paragraphs_of('README.rdoc', 0...1).join("\n\n")
-    p.extra_rdoc_files += ["README.rdoc"]
-    p.test_globs = ["spec/**/*_spec.rb"]
-    p.extra_deps     << [ 'builder',   '>= 2.1.2'  ]
-    p.extra_dev_deps << [ 'hoe-git',   '~> 1.5.0'  ]
-    p.extra_dev_deps << [ 'cucumber',  '>= 1.3.3'  ]
-    p.extra_dev_deps << [ 'rspec',     '> 2.0.0'   ]
-    p.extra_dev_deps << [ 'test-unit', '> 2.4.9'   ]
-    p.extra_dev_deps << [ 'minitest',  '~> 2.2.0'  ]
-    p.extra_dev_deps << [ 'spinach',   '>= 0.8.7'  ]
-    p.clean_globs += ["spec/reports", "acceptance/reports"]
-    p.license 'MIT'
-  end
-  hoe.spec.rdoc_options += ["-SHN", "-f", "darkfish"]
-
-  task :gemspec do
-    File.open("#{hoe.name}.gemspec", "w") {|f| f << hoe.spec.to_ruby }
-  end
-rescue LoadError
-  puts "You really need Hoe installed to be able to package this gem"
-end
-
-def run_ruby_acceptance(cmd)
-  ENV['CI_REPORTS'] ||= "acceptance/reports"
-  if ENV['RUBYOPT']
-    opts = ENV['RUBYOPT']
-    ENV['RUBYOPT'] = nil
-  else
-    opts = "-rubygems"
-  end
-  begin
-    result_proc = proc {|ok,*| puts "Failures above are expected." unless ok }
-    ruby "-Ilib #{opts} #{cmd}", &result_proc
-  ensure
-    ENV['RUBYOPT'] = opts if opts != "-rubygems"
-    ENV.delete 'CI_REPORTS'
-  end
-end
-
-
-namespace :generate do
-  task :test_unit do
-    run_ruby_acceptance "-rci/reporter/rake/test_unit_loader acceptance/test_unit_example_test.rb"
-  end
-
-  task :minitest do
-    run_ruby_acceptance "-rci/reporter/rake/minitest_loader acceptance/minitest_example_test.rb"
-  end
-
-  task :rspec do
-    rspec = "#{Gem.loaded_specs['rspec-core'].gem_dir}/exe/rspec"
-    run_ruby_acceptance "-S #{rspec} --require ci/reporter/rake/rspec_loader --format CI::Reporter::RSpec acceptance/rspec_example_spec.rb"
-  end
-
-  task :cucumber do
-    cucumber = "#{Gem.loaded_specs['cucumber'].gem_dir}/bin/cucumber"
-    run_ruby_acceptance "-rci/reporter/rake/cucumber_loader -S #{cucumber} --format CI::Reporter::Cucumber acceptance/cucumber"
-  end
-
-  task :spinach do
-    spinach = "#{Gem.loaded_specs['spinach'].gem_dir}/bin/spinach"
-    run_ruby_acceptance "-I../../lib -rci/reporter/rake/spinach_loader -S #{spinach} -r ci_reporter -f acceptance/spinach/features"
-  end
-
-  task :clean do
-    rm_rf "acceptance/reports"
-  end
-
-  task :all => [:clean, :test_unit, :minitest, :rspec, :cucumber, :spinach]
-end
-
-task :acceptance => "generate:all"
-
+require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:acceptance_spec) do |t|
-  t.pattern = FileList['acceptance/verification_spec.rb']
+
+RSpec::Core::RakeTask.new(:rspec) do |t|
+  t.pattern = FileList['spec']
   t.rspec_opts = "--color"
 end
-task :acceptance => :acceptance_spec
 
-task :default => :acceptance
+task :default => :rspec

data/ci_reporter.gemspec

@@ -1,57 +1,28 @@
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ci/reporter/version'
 
-Gem::Specification.new do |s|
-  s.name = "ci_reporter"
-  s.version = "1.9.2"
+Gem::Specification.new do |spec|
+  spec.name          = "ci_reporter"
+  spec.version       = CI::Reporter::VERSION
+  spec.authors       = ["Nick Sieger", "Jake Goulding"]
+  spec.email         = ["nick@nicksieger.com", "jake.goulding@gmail.com"]
+  spec.homepage      = "https://github.com/ci-reporter/ci_reporter"
+  spec.license       = "MIT"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Nick Sieger"]
-  s.date = "2014-04-06"
-  s.description = "CI::Reporter is an add-on to Test::Unit, RSpec and Cucumber that allows you to generate XML reports of your test, spec and/or feature runs. The resulting files can be read by a continuous integration system that understands Ant's JUnit report XML format, thus allowing your CI system to track test/spec successes and failures."
-  s.email = "nick@nicksieger.com"
-  s.extra_rdoc_files = ["History.txt", "LICENSE.txt", "Manifest.txt", "README.rdoc"]
-  s.files = [".gemtest", ".hoerc", ".rspec", ".travis.before_install.sh", ".travis.yml", "Gemfile", "History.txt", "LICENSE.txt", "Manifest.txt", "README.rdoc", "Rakefile", "acceptance/cucumber/cucumber_example.feature", "acceptance/cucumber/step_definitions/development_steps.rb", "acceptance/minitest_example_test.rb", "acceptance/rspec_example_spec.rb", "acceptance/spinach/features/spinach_example.feature", "acceptance/spinach/features/steps/example_spinach_feature.rb", "acceptance/test_unit_example_test.rb", "acceptance/verification_spec.rb", "ci_reporter.gemspec", "lib/ci/reporter/core.rb", "lib/ci/reporter/cucumber.rb", "lib/ci/reporter/minitest.rb", "lib/ci/reporter/rake/cucumber.rb", "lib/ci/reporter/rake/cucumber_loader.rb", "lib/ci/reporter/rake/minitest.rb", "lib/ci/reporter/rake/minitest_loader.rb", "lib/ci/reporter/rake/rspec.rb", "lib/ci/reporter/rake/rspec_loader.rb", "lib/ci/reporter/rake/spinach.rb", "lib/ci/reporter/rake/spinach_loader.rb", "lib/ci/reporter/rake/test_unit.rb", "lib/ci/reporter/rake/test_unit_loader.rb", "lib/ci/reporter/rake/utils.rb", "lib/ci/reporter/report_manager.rb", "lib/ci/reporter/rspec.rb", "lib/ci/reporter/spinach.rb", "lib/ci/reporter/test_suite.rb", "lib/ci/reporter/test_unit.rb", "lib/ci/reporter/version.rb", "spec/ci/reporter/cucumber_spec.rb", "spec/ci/reporter/output_capture_spec.rb", "spec/ci/reporter/rake/rake_tasks_spec.rb", "spec/ci/reporter/report_manager_spec.rb", "spec/ci/reporter/rspec_spec.rb", "spec/ci/reporter/test_suite_spec.rb", "spec/ci/reporter/test_unit_spec.rb", "spec/spec_helper.rb", "stub.rake", "tasks/ci_reporter.rake"]
-  s.homepage = "https://github.com/nicksieger/ci_reporter"
-  s.licenses = ["MIT"]
-  s.rdoc_options = ["--main", "README.rdoc", "-SHN", "-f", "darkfish"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23"
-  s.summary = "CI::Reporter allows you to generate reams of XML for use with continuous integration systems."
-  s.test_files = ["spec/ci/reporter/cucumber_spec.rb", "spec/ci/reporter/output_capture_spec.rb", "spec/ci/reporter/rake/rake_tasks_spec.rb", "spec/ci/reporter/report_manager_spec.rb", "spec/ci/reporter/rspec_spec.rb", "spec/ci/reporter/test_suite_spec.rb", "spec/ci/reporter/test_unit_spec.rb"]
+  spec.summary       = %q{Connects Ruby test frameworks to CI systems via JUnit reports.}
+  spec.description   = %q{CI::Reporter is an add-on to Ruby testing frameworks that allows you to generate XML reports of your test runs. The resulting files can be read by a continuous integration system that understands Ant's JUnit report format.}
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 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|acceptance)/})
+  spec.require_paths    = ["lib"]
+  spec.extra_rdoc_files = ["History.txt", "LICENSE.txt", "README.md"]
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
-      s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
-      s.add_development_dependency(%q<hoe-git>, ["~> 1.5.0"])
-      s.add_development_dependency(%q<cucumber>, [">= 1.3.3"])
-      s.add_development_dependency(%q<rspec>, ["> 2.0.0"])
-      s.add_development_dependency(%q<test-unit>, ["> 2.4.9"])
-      s.add_development_dependency(%q<minitest>, ["~> 2.2.0"])
-      s.add_development_dependency(%q<spinach>, [">= 0.8.7"])
-      s.add_development_dependency(%q<hoe>, ["~> 3.7"])
-    else
-      s.add_dependency(%q<builder>, [">= 2.1.2"])
-      s.add_dependency(%q<rdoc>, ["~> 4.0"])
-      s.add_dependency(%q<hoe-git>, ["~> 1.5.0"])
-      s.add_dependency(%q<cucumber>, [">= 1.3.3"])
-      s.add_dependency(%q<rspec>, ["> 2.0.0"])
-      s.add_dependency(%q<test-unit>, ["> 2.4.9"])
-      s.add_dependency(%q<minitest>, ["~> 2.2.0"])
-      s.add_dependency(%q<spinach>, [">= 0.8.7"])
-      s.add_dependency(%q<hoe>, ["~> 3.7"])
-    end
-  else
-    s.add_dependency(%q<builder>, [">= 2.1.2"])
-    s.add_dependency(%q<rdoc>, ["~> 4.0"])
-    s.add_dependency(%q<hoe-git>, ["~> 1.5.0"])
-    s.add_dependency(%q<cucumber>, [">= 1.3.3"])
-    s.add_dependency(%q<rspec>, ["> 2.0.0"])
-    s.add_dependency(%q<test-unit>, ["> 2.4.9"])
-    s.add_dependency(%q<minitest>, ["~> 2.2.0"])
-    s.add_dependency(%q<spinach>, [">= 0.8.7"])
-    s.add_dependency(%q<hoe>, ["~> 3.7"])
-  end
+  spec.add_dependency "builder", ">= 2.1.2"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rdoc", "~> 4.0"
+  spec.add_development_dependency "rspec", "~> 2.0"
 end

data/gemfiles/.gitignore

@@ -0,0 +1 @@
+Gemfile.*.lock

data/lib/ci/reporter/core.rb

@@ -1,6 +1,2 @@
-# Copyright (c) 2006-2012 Nick Sieger <nicksieger@gmail.com>
-# See the file LICENSE.txt included with the distribution for
-# software license details.
-
 require 'ci/reporter/test_suite'
 require 'ci/reporter/report_manager'

data/lib/ci/reporter/internal.rb

@@ -0,0 +1,31 @@
+module CI
+  module Reporter
+    module Internal
+      def run_ruby_acceptance(cmd)
+        ENV['CI_REPORTS'] ||= "acceptance/reports"
+        if ENV['RUBYOPT']
+          opts = ENV['RUBYOPT']
+          ENV['RUBYOPT'] = nil
+        else
+          opts = "-rubygems"
+        end
+        begin
+          result_proc = proc {|ok,*| puts "Failures above are expected." unless ok }
+          ruby "-Ilib #{opts} #{cmd}", &result_proc
+        ensure
+          ENV['RUBYOPT'] = opts if opts != "-rubygems"
+          ENV.delete 'CI_REPORTS'
+        end
+      end
+
+      def save_env(v)
+        ENV["PREV_#{v}"] = ENV[v]
+      end
+
+      def restore_env(v)
+        ENV[v] = ENV["PREV_#{v}"]
+        ENV.delete("PREV_#{v}")
+      end
+    end
+  end
+end

data/lib/ci/reporter/rake/utils.rb

@@ -1,7 +1,3 @@
-# Copyright (c) 2006-2012 Nick Sieger <nicksieger@gmail.com>
-# See the file LICENSE.txt included with the distribution for
-# software license details.
-
 module CI
   module Reporter
     def self.maybe_quote_filename(fn)