xcpretty-bb 0.1.12.bb1

data/README.md

@@ -0,0 +1,93 @@
+![logo](http://i.imgur.com/i2fElxx.png)
+
+__`xcpretty` is a fast and flexible formatter for `xcodebuild`__.<br/>
+It does one thing, and it should do it well.
+
+[![Gem version](http://img.shields.io/gem/v/xcpretty.svg)](http://rubygems.org/gems/xcpretty)
+[![Build Status](https://travis-ci.org/supermarin/xcpretty.svg?branch=master)](https://travis-ci.org/supermarin/xcpretty)
+[![Code Climate](http://img.shields.io/codeclimate/github/supermarin/xcpretty.svg)](https://codeclimate.com/github/supermarin/xcpretty)
+
+## Installation
+``` bash
+$ gem install xcpretty
+```
+
+## Usage
+``` bash
+$ xcodebuild [flags] | xcpretty -c
+```
+`xcpretty` is designed to be piped with `xcodebuild` and thus keeping 100%
+compatibility with it. It's even a bit faster than `xcodebuild` itself, since
+it saves your terminal some prints.
+
+__Important:__ If you're running `xcpretty` on a CI like Travis or Jenkins, you
+may want to exit with same status code as `xcodebuild`.
+CI systems usually use status codes to determine if the build has failed.
+
+``` bash
+$ set -o pipefail && xcodebuild [flags] | xcpretty -c
+#
+# OR
+#
+$ xcodebuild [flags] | xcpretty -c && exit ${PIPESTATUS[0]}
+```
+
+## Raw xcodebuild output
+You might want to use `xcpretty` together with `tee` to store the raw log in a
+file, and get the pretty output in the terminal. This might be useful if you
+want to inspect a failure in detail and aren't able to tell from the pretty
+output.
+
+Here's a way of doing it:
+``` bash
+$ xcodebuild [flags] | tee xcodebuild.log | xcpretty -c
+```
+
+## Formats
+
+- `--[no-]color`: Show build icons in color. (you can add it to `--simple` or `--test` format).
+  Defaults to auto-detecting color availability.
+- `--[no-]utf`: Use unicode characters in build output or only ASCII.
+  Defaults to auto-detecting the current locale
+
+- `--simple`, `-s` (default)
+![xcpretty --simple](http://i.imgur.com/LdmozBS.gif)
+
+- `--test`, `-t` (RSpec style)
+![xcpretty alpha](http://i.imgur.com/VeTQQub.gif)
+- `--tap` ([Test Anything Protocol](http://testanything.org)-compatible output)
+- `--knock`, `-k` (a [simplified version](https://github.com/chneukirchen/knock) of the Test Anything Protocol)
+
+
+## Reporters
+
+- `--report junit`, `-r junit`: Creates a JUnit-style XML report at `build/reports/junit.xml`, compatible with Jenkins and TeamCity CI.
+
+- `--report html`, `-r html`: Creates a simple HTML report at `build/reports/tests.html`.
+![xcpretty html](http://i.imgur.com/0Rnux3v.gif)
+
+- `--report json-compilation-database`, `-r json-compilation-database`: Creates a [JSON compilation database](http://clang.llvm.org/docs/JSONCompilationDatabase.html) at `build/reports/compilation.json`. This is a format to replay single compilations independently of the build system.
+
+Writing a report to a custom path can be specified using `--output PATH`.
+
+## Extensions
+
+`xcpretty` supports custom formatters through the use of the
+`--formatter` flag, which takes a path to a file as an argument. The
+file must contain a Ruby subclass of `XCPretty::Formatter`, and
+return that class at the end of te file. The class
+can override the `format_*` methods to hook into output parsing
+events.
+
+### Known extensions
+
+* [xcpretty-travis-formatter](https://github.com/kattrali/xcpretty-travis-formatter): support for cleaner output in TravisCI using code folding
+
+The recommended format is a gem containing the formatter and named
+with an `xcpretty-` prefix, for easier discovery.
+
+
+## Team
+
+- [Marin Usalj](http://github.com/supermarin) http://supermar.in
+- [Delisa Mason](http://github.com/kattrali) http://delisa.me

data/Rakefile

@@ -0,0 +1,26 @@
+require "bundler/gem_tasks"
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+task :kick do
+  sh 'bundle exec kicker -r ruby'
+end
+
+Cucumber::Rake::Task.new(:cucumber) do |task|
+end
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = %w(--color --format=doc)
+end
+
+RuboCop::RakeTask.new(:lint) do |task|
+  task.fail_on_error = false
+end
+
+task :ci do
+  Rake::Task[:spec].invoke
+  Rake::Task[:cucumber].invoke
+  Rake::Task[:lint].invoke
+end
+

data/assets/report.html.erb

@@ -0,0 +1,172 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>Test Results | xcpretty</title>
+    <style type="text/css">
+      body { font-family:Avenir Next, Helvetica Neue, sans-serif; color: #4A4A4A; background-color: #F0F3FB; margin:0;}
+      h1 { font-weight: normal; font-size: 24px; margin: 10px 0 0 0;}
+      h3 { font-weight: normal; margin: 2px; font-size: 1.1em;}
+      header { position: fixed;width: 100%;background: rgba(249, 254, 255, 0.9);margin: 0;padding: 10px;}
+      header:before, header:after { content:""; display:table;}
+      header:after { clear:both;}
+      a:link { color: #A1D761;}
+      footer { clear: both;position: relative;z-index: 10;height: 40px;margin-top: -10px; margin-left:30px; font-size:12px;}
+      table { width:100%; border-collapse: collapse;}
+      tr td:first-child { width:7%}
+      .left { float: left; margin-left:30px;}
+      .right { float: right; margin-right: 40px; margin-top: 0; margin-bottom:0;}
+      .test-suite { margin: 0 0 30px 0;}
+      .test-suite > .heading { font-family:Menlo, Monaco, monospace; font-weight: bold; border-color: #A1D761; background-color: #B8E986; border-width: 1px;}
+      .test-suite.failing > .heading { border-color: #C84F5E; background-color: #E58591;}
+      .test-suite > .heading > .title { margin-top: 4px; margin-left: 10px;}
+      .tests { overflow: scroll;margin: 0 30px 0 60px;}
+      .test, .test-suite > .heading { height: 30px; overflow: hidden; margin: 0 30px;}
+      .test, .test-suite > .heading { border-width: 1px; border-collapse: collapse; border-style: solid; }
+      .test { margin-left: 30px; border-top:none;}
+      .test.failing { border-color: #C84F5E; background-color: #F4DDE0;}
+      .test.passing { border-color: #A1D761;}
+      .test.failing { background-color: #E7A1AA;}
+      .test.passing { background-color: #CAF59F;}
+      .test.failing.odd { background-color: #EEC7CC;}
+      .test.passing.odd { background-color: #E5FBCF;}
+      .details { background-color: #F4DDE0; border: 1px solid #C84F5E;}
+      .test .test-detail:last-child { padding-bottom: 8px;}
+      .test .title { float: left; font-size: 0.9em; margin-top: 8px; font-family: Menlo, Monaco, monospace;}
+      .test .time { float: left;margin: 4px 10px 0 20px;}
+      .test-detail { font-family:Menlo, Monaco, monospace; font-size: 0.9em; margin: 5px 0 5px 0px;}
+      .screenshots { height: auto; overflow: hidden; padding: 4px 4px 0 4px; background-color: #B8E986; border: #A1D761; border-width: 0 1px; border-style: solid; }
+      .screenshots.failing { border-color: #C84F5E; background-color: #E58591; }
+      .screenshot { max-height: 60px; float: left; transition: max-height 0.2s; margin: 0 4px 4px 0 }
+      .screenshot.selected { max-height: 568px; }
+      #test-suites { display: inline-block; width: 100%;margin-top:100px;}
+      #segment-bar { margin-top: 10px;margin-left: 14px;float:right;}
+      #segment-bar a:first-child { border-radius: 9px 0 0 9px; border-right: none;}
+      #segment-bar a:last-child { border-radius: 0 9px 9px 0; border-left: none;}
+      #segment-bar > a { color: #565656; border: 2px solid  #7B7B7B; width: 80px; font-weight: bold; display:inline-block;text-align:center; font-weight: normal;}
+      #segment-bar > a.selected { background-color: #979797; color: #F0F3FB;}
+      #counters { float: left;margin: 10px;text-align: right;}
+      #counters h2 { font-size: 16px; font-family: Avenir, sans-serif; font-weight: lighter; display:inline;}
+      #counters .number { font-size: 20px;}
+      #fail-count { color: #D0021B; margin-left:10px;}
+      @media (max-width: 640px) {
+        h1, #counters, #segment-bar { margin: 5px auto; text-align:center;}
+        header, #segment-bar { width: 100%; position: relative; background:none;}
+        .left, .right { float:none; margin:0;}
+        #test-suites { margin-top: 0;}
+        #counters { float:none;}
+      }
+    </style>
+    <script type="text/javascript">
+      var hide = function(element) { element.style.display = 'none';}
+      var show = function(element) { element.style.display = '';}
+      var isHidden = function(element) { return element.style.display == 'none';}
+      var isSelected = function(element) { return element.classList.contains("selected");}
+      var deselect = function(element) { return element.classList.remove("selected");}
+      var select = function(element) { return element.classList.add("selected");}
+      var toggle = function(element) { isHidden(element) ? show(element) : hide(element);};
+      var toggleTests = function(heading) { toggle(heading.parentNode.children[1]);};
+      var toggleDetails = function(detailClass) {
+        var details = document.querySelectorAll('.' + detailClass);
+        for (var i = details.length - 1; i >= 0; i--) { toggle(details[i]);};
+      };
+      var hideAll = function(collection) {
+        for (var i = collection.length - 1; i >= 0; i--) { hide(collection[i]); };
+      }
+      var showAll = function(collection) {
+        for (var i = collection.length - 1; i >= 0; i--) { show(collection[i]); };
+      }
+      var selectSegment = function(segment) {
+        if (isSelected(segment)) return;
+        var segments = document.querySelectorAll('#segment-bar > a');
+        for (var i = segments.length - 1; i >= 0; i--) { deselect(segments[i]);};
+        select(segment);
+        if (segment.id == "all-segment") {
+          showAll(document.querySelectorAll('.test-suite'));
+          showAll(document.querySelectorAll('.test'));
+        } else if (segment.id == "failing-segment") {
+          hideAll(document.querySelectorAll('.test.passing'));
+          showAll(document.querySelectorAll('.test.failing'));
+          hideAll(document.querySelectorAll('.test-suite.passing'));
+          showAll(document.querySelectorAll('.test-suite.failing'));
+        } else if (segment.id == "passing-segment") {
+          hideAll(document.querySelectorAll('.test.failing'));
+          showAll(document.querySelectorAll('.test.passing'));
+          hideAll(document.querySelectorAll('.test-suite.failing'));
+          showAll(document.querySelectorAll('.test-suite.passing'));
+        }
+      }
+      var toggleScreenshot = function(suiteName, index) {
+        var screenshot = document.getElementById("screenshot-" + suiteName + "-" + index);
+        isSelected(screenshot) ? deselect(screenshot) : select(screenshot);
+      }
+    </script>
+  </head>
+  <body>
+    <header>
+      <section class="left">
+        <h1>Test Results</h1>
+      </section>
+      <section class="right">
+        <section id="counters">
+          <h2 id="test-count"><span class="number"><%= test_count %></span> tests</h2>
+          <% if fail_count > 0 %>
+            <h2 id="fail-count"><span class="number"><%= fail_count %></span> failures</h2>
+          <% end %>
+        </section>
+        <section id="segment-bar">
+          <a id="all-segment" onclick="selectSegment(this);" class="selected">All</a><a id="failing-segment" onclick="selectSegment(this);">Failing</a><a id="passing-segment" onclick="selectSegment(this);">Passing</a>
+        </section>
+      </section>
+    </header>
+    <section id="test-suites">
+      <% test_suites.each do |name, info| %>
+        <% next unless info[:tests].size > 0 %>
+        <section class="test-suite <%= info[:failing] ? 'failing' : 'passing'%>" id="<%= name %>">
+          <section class="heading" onclick="toggleTests(this);">
+            <h3 class="title"><%= name %></h3>
+          </section>
+          <section class="tests">
+            <% unless info[:screenshots].empty? %>
+            <div class="screenshots <%= info[:failing] ? 'failing' : 'passing'%>">
+              <% info[:screenshots].each_with_index do |screenshot, index| %>
+                  <a href="javascript:toggleScreenshot('<%=name %>', <%=index %>)">
+                    <img class="screenshot" id="screenshot-<%=name %>-<%=index %>" src="<%=screenshot %>" />
+                  </a>
+              <% end %>
+            </div>
+            <% end %>
+            <table>
+            <% info[:tests].each_with_index do |test, index| %>
+              <% detail_class = test[:name].gsub(/\s/,'') %>
+              <tr class="test <%= test[:failing] ? 'failing' : 'passing'%> <%= index % 2 != 0 ? 'odd' :''%>"  onclick="toggleDetails('<%= detail_class %>');">
+                <td>
+                  <% if test[:time] %>
+                    <h3 class="time"><%= test[:time] %>s</h3>
+                  <% end %>
+                </td>
+                <td><h3 class="title"><%= test[:name] %></h3></td>
+              </tr>
+              <% if test[:reason] || test[:snippet] %>
+                <tr class="details <%= detail_class %>">
+                  <td></td>
+                  <td>
+                    <% if test[:reason] %>
+                      <section class="test-detail reason"><%= test[:reason] %></section>
+                    <% end %>
+                    <% if test[:snippet] %>
+                      <section class="test-detail snippet"><%= test[:snippet] %></section>
+                      <section class="test-detail"><%= test[:file] %></section>
+                    <% end %>
+                  </td>
+                </tr>
+              <% end %>
+            <% end %>
+            </table>
+          </section>
+        </section>
+      <% end %>
+    </section>
+    <footer>Report generated with <a href="https://github.com/supermarin/xcpretty">xcpretty</a></footer>
+  </body>
+</html>

data/bin/xcpretty

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+
+if RUBY_VERSION < '2.0.0'
+  abort "error: XCPretty requires Ruby 2.0.0 or higher."
+end
+
+if $PROGRAM_NAME == __FILE__
+  $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+end
+require 'xcpretty'
+require 'optparse'
+
+report_options = []
+report_classes = []
+report_formats = {
+  "junit"                     => XCPretty::JUnit,
+  "html"                      => XCPretty::HTML,
+  "json-compilation-database" => XCPretty::JSONCompilationDatabase
+}
+
+printer_opts = {
+  unicode: XCPretty::Term.unicode?,
+  colorize: XCPretty::Term.color?,
+  formatter: XCPretty::Simple
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: xcodebuild [options] | xcpretty"
+  opts.on('-t', '--test', 'Use RSpec style output') do
+    printer_opts[:formatter] = XCPretty::RSpec
+  end
+  opts.on('-s', '--simple', 'Use simple output (default)') do
+    printer_opts[:formatter] = XCPretty::Simple
+  end
+  opts.on('-k', '--knock', 'Use knock output') do
+    printer_opts[:formatter] = XCPretty::Knock
+  end
+  opts.on('--tap', 'Use TAP output') do
+    printer_opts[:formatter] = XCPretty::TestAnything
+  end
+  opts.on('-f', '--formatter PATH', 'Use formatter returned from evaluating the specified Ruby file') do |path|
+    printer_opts[:formatter] = XCPretty.load_custom_formatter(path)
+  end
+  opts.on('--[no-]color', 'Use colorized output. Defaults is auto') do |value|
+    printer_opts[:colorize] = value
+  end
+  opts.on('--[no-]utf', 'Use unicode characters in output. Default is auto.') do |value|
+    printer_opts[:unicode] = value
+  end
+  opts.on("-r", "--report FORMAT", "Run FORMAT reporter",
+          "  Choices: #{report_formats.keys.join(', ')}") do |format|
+    report_classes << report_formats[format]
+    report_options << {}
+  end
+  opts.on('-o', '--output PATH', 'Write report output to PATH') do |path|
+    unless opts = report_options.last
+      XCPretty.exit_with_error('Expected report format to be specified before output path')
+    end
+    opts[:path] = path
+  end
+  opts.on('--screenshots', 'Collect screenshots in the HTML report') do
+    unless opts = report_options.last
+      XCPretty.exit_with_error('Expected screenshot argument to be specified after report format')
+    end
+    opts[:screenshots] = true
+  end
+  opts.on_tail('-h', '--help', 'Show this message') { puts opts; exit }
+  opts.on_tail("-v", "--version", "Show version") { puts XCPretty::VERSION; exit }
+  opts.parse!
+
+  if STDIN.tty?
+    XCPretty.exit_with_error(opts.help)
+  end
+end
+
+printer = XCPretty::Printer.new(printer_opts)
+reporters = report_classes.compact.each_with_index.map { |k, i| k.new(report_options[i]) }
+
+STDIN.each_line do |line|
+  printer.pretty_print(line)
+  reporters.each { |r| r.handle(line) }
+end
+
+reporters.each(&:finish)
+

data/features/custom_formatter.feature

@@ -0,0 +1,15 @@
+Feature: Loading an arbitrary Ruby file as a formatter
+
+    Scenario: The file loaded does not contain a Ruby class
+        When I pipe to xcpretty with "--formatter /bin/bash"
+        Then the exit status code should be 1
+
+    Scenario: The file loaded contains a Ruby class
+        Given I have a file to compile
+        When I pipe to xcpretty with a custom formatter
+        Then the exit status code should be 0
+
+    Scenario: Showing output using a custom formatter
+        Given I have a file to compile
+        When I pipe to xcpretty with a custom formatter
+        Then I should see a custom compilation message