xcpretty 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50b91a1ee68864cc0c7f42210ff068b9f0ac4fbd
-  data.tar.gz: 183872807da2eafa43b7e938d3d00c99d9a7575d
+  metadata.gz: 06619c3a83d263be409e3bee7dc0a009109cf64b
+  data.tar.gz: 8db1bce60835effe0b001a1830ee5ed0ba329674
 SHA512:
-  metadata.gz: 9a81e3342d8eae995237e34a33849e35d894da2cd8853a4e87f63f7f7e40417062f2a5ef4b3dccce30425a445769a39b6e92bbfae5e13feb199dac555f59a979
-  data.tar.gz: 8aa6375079a878afe70a2532f40b441ff70836eea40afaca914f9c7620cb7bc9067b924052b01b9c0cf955e9a0e5e662f50feae5423d8f1d5a65aaf54de9f18e
+  metadata.gz: 35cb3372bbb59ce200426ac5004600fc9baa075d5521828b1251d5da537eece20e8f3ba56743b50ff23295d7a33ce8e3c15311ca2e0e8ccc387bf30c87e56f16
+  data.tar.gz: ba72fb7e9c12f1c7570a20c38b1e08a3d93968af21ceb1adf41c2c676ec282e6fce5748e53617c4de9915cae63dfc544fb06d4b664a3a61fcd438a56f1fdbf4c

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.rspec
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.travis.yml

@@ -1,7 +1,9 @@
+language: ruby
+
 rvm:
   - 2.0.0
   - 1.9.3
   - 1.8.7
-language: ruby
+
 script: rake ci
 

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## master
+
+###### Enhancements
+
+* exit(1) if xcodebuild failure detected
+
+* Print compile errors nicely. Currently we support compiler erorrs,
+  and Pods-not-installed errors. Missing mach-o-linker failures
+
+* Added support for loading arbitrary custom printers (experimental) |
+  [Eloy Durán](https://github.com/alloy) |
+  [#29](https://github.com/mneorr/xcpretty/pulls/29)
+
+* Show help banner in case no data is piped in |
+  [Eloy Durán](https://github.com/alloy) |
+  [#29](https://github.com/mneorr/xcpretty/pulls/29)
+
+## 0.0.6
+
+###### Enhancements
+
+* Added support for reporters
+* Added JUnit reporter
+
 ## 0.0.5
 
 ###### Bug Fixes

data/README.md

@@ -1,8 +1,10 @@
-# XCPretty [![Build Status](https://travis-ci.org/mneorr/XCPretty.png?branch=master)](https://travis-ci.org/mneorr/XCPretty)
+# XCPretty
 
 __XCPretty is a fast and flexible formatter for `xcodebuild`__.<br/>
 It does one thing, and it should do it well.
 
+[![Build Status](https://travis-ci.org/mneorr/XCPretty.png?branch=master)](https://travis-ci.org/mneorr/XCPretty)
+[![Code Climate](https://codeclimate.com/github/mneorr/XCPretty.png)](https://codeclimate.com/github/mneorr/XCPretty)
 ## Installation
 
     $ gem install xcpretty

data/Rakefile

@@ -5,14 +5,19 @@ task :kick do
 end
 
 task :spec do
-  sh 'rspec spec'
+  sh 'rspec spec --color --format nested'
 end
 
 task :cucumber do
   sh 'cucumber'
 end
 
+task :install_tools do
+  sh 'sudo pip install Pygments'
+end
+
 task :ci do
+  Rake::Task[:install_tools].invoke
   Rake::Task[:spec].invoke
   Rake::Task[:cucumber].invoke
 end

data/bin/xcpretty

@@ -1,49 +1,84 @@
 #!/usr/bin/env ruby
-$:.unshift File.expand_path('../../lib', __FILE__)
-require 'xcpretty'
-require 'optparse'
 
 if RUBY_VERSION < '1.8.7'
   abort "error: XCPretty requires Ruby 1.8.7 or higher."
 end
 
+if $0 == __FILE__
+  $:.unshift File.expand_path('../../lib', __FILE__)
+end
+require 'xcpretty'
+require 'optparse'
+
+def class_from_path(path)
+  source = File.read(path)
+  klass = eval(source, nil, path)
+  raise unless klass.is_a?(Class)
+  klass
+end
+
+def load_custom_formatter(path)
+  begin
+    $:.unshift File.dirname(path)
+    class_from_path(path)
+  rescue SyntaxError => e
+    $stderr.puts "[!] Expected formatter source file to return a class. #{e}"
+    exit 1
+  end
+end
+
 report_formats = {
   "junit" => XCPretty::JUnit
 }
 
+constructor = {
+  :unicode => true,
+  :colorize => false,
+  :formatter => XCPretty::Simple
+}
+
+reporter_classes = []
+
 OptionParser.new do |opts|
-  @report_formats = []
   opts.banner = "Usage: xcodebuild [options] | xcpretty"
   opts.on('-t', '--test', 'Use RSpec style output') do
-    @klass = XCPretty::Printer::RSpec
+    constructor[:formatter] = XCPretty::RSpec
   end
   opts.on('-s', '--simple', 'Use simple output (default)') do
-    @klass = XCPretty::Printer::Simple
+    constructor[:formatter] = XCPretty::Simple
+  end
+  opts.on('-f', '--formatter PATH', 'Use formatter returned from evaluating the specified Ruby file') do |path|
+    constructor[:formatter] = load_custom_formatter(path)
   end
   opts.on('-c', '--color', 'Use colorized output') do
-    @colorize = true
+    constructor[:colorize] = true
   end
   opts.on('--no-utf', 'Disable unicode characters in output') do
-    @no_utf = true
+    constructor[:unicode] = false
   end
   opts.on("-r", "--report FORMAT", "Run FORMAT reporter",
                 "  Choices: #{report_formats.keys.join(', ')}") do |format|
-    @report_formats << report_formats[format]
+    reporter_classes << report_formats[format]
   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!
-end
 
-printer = (@klass || XCPretty::Printer::Simple).new
-printer.colorize = @colorize
-printer.use_unicode = !@no_utf
+  if STDIN.tty?
+    $stderr.puts opts.help
+    exit 1
+  else
+    opts.parse!
+  end
+end
 
-reporters = @report_formats.compact.map(&:new)
+printer = XCPretty::Printer.new(constructor)
+reporters = reporter_classes.compact.map(&:new)
 
 ARGF.each_line do |line|
+  XCPretty::ExitStatus.handle(line)
   printer.pretty_print(line)
-  reporters.each {|r| r.handle(line) }
+  reporters.each { |r| r.handle(line) }
 end
 
 reporters.each(&:finish)
+exit(XCPretty::ExitStatus.code)

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

data/features/junit_report.feature

@@ -4,6 +4,7 @@ Feature: Creating a JUnit test report
         Given the tests have started running
 
     Scenario: Showing a test suite
+        Given I have a passing test in my suite
         When I pipe to xcpretty with "--report junit"
         Then I should see a test suite node
 
@@ -20,5 +21,12 @@ Feature: Creating a JUnit test report
     Scenario: Counting tests
         Given I have a passing test in my suite
         And I have a failing test in my suite
+        And the test suite has finished
+        When I pipe to xcpretty with "--report junit"
+        Then I should see 2 tests in my report
+
+    Scenario: Having many test classes
+        Given I have tests in my suite from 2 classes
         When I pipe to xcpretty with "--report junit"
-        Then I should see 2 tests in my report
+        Then I should see 2 test suites
+

data/features/simple_format.feature

@@ -5,6 +5,11 @@ Feature: Showing build output in simple format
         When I pipe to xcpretty with "--simple"
         Then I should see a successful compilation message
 
+    Scenario: Showing xib compilation
+        Given I have a xib to compile
+        When I pipe to xcpretty with "--simple"
+        Then I should see a successful compilation message
+
     Scenario: Showing precompilation
         Given I have a precompiled header
         When I pipe to xcpretty with "--simple"
@@ -15,11 +20,36 @@ Feature: Showing build output in simple format
         When I pipe to xcpretty with "--simple --color"
         Then I should see a yellow completion icon
 
+    Scenario: Showing xib compilation with color
+        Given I have a xib to compile
+        When I pipe to xcpretty with "--simple --color"
+        Then I should see a yellow completion icon
+
     Scenario: Showing precompilation
         Given I have a precompiled header
         When I pipe to xcpretty with "--simple --color"
         Then I should see a yellow completion icon
 
+    Scenario: Showing analyze
+        Given I have a file to analyze
+        When I pipe to xcpretty with "--simple"
+        Then I should see a successful analyze message
+
+    Scenario: Showing shallow analyze
+        Given I have a file to shallow analyze
+        When I pipe to xcpretty with "--simple"
+        Then I should see a successful analyze message
+
+    Scenario: Showing analyze with color
+        Given I have a file to analyze
+        When I pipe to xcpretty with "--simple --color"
+        Then I should see a yellow completion icon
+
+    Scenario: Showing shallow analyze with color
+        Given I have a file to shallow analyze
+        When I pipe to xcpretty with "--simple --color"
+        Then I should see a yellow completion icon
+
     Scenario: Showing the start of a test run
         Given the tests have started running
         When I pipe to xcpretty with "--simple"
@@ -31,12 +61,13 @@ Feature: Showing build output in simple format
         Then I should see the name of suite only
 
     Scenario: Showing the end of a test suite
-        Given I finish a test suite
+        Given the test suite has finished
         When I pipe to xcpretty with "--simple"
         Then I should see that the test suite finished
 
     Scenario: Showing failed test output
         Given I have a failing test in my suite
+        And the test suite has finished
         When I pipe to xcpretty with "--simple"
         Then I should see the name of a failed test
         And I should see the path of a failed test
@@ -50,18 +81,51 @@ Feature: Showing build output in simple format
 
     Scenario: Showing failed test output with color
         Given I have a failing test in my suite
-        And I finish a test suite
+        And the test suite has finished
         When I pipe to xcpretty with "--simple --color"
         Then I should see a red failed test mark
         And the final execution message should be red
 
     Scenario: Showing successful test output with color
         Given I have a passing test in my suite
-        And I finish a test suite
+        And the test suite has finished
         When I pipe to xcpretty with "--simple --color"
         Then I should see a green passing test mark
 
     Scenario: Running tests without UTF-8 support
         Given I have a passing test in my suite
-        And I pipe to xcpretty with "--no-utf"
+        And I pipe to xcpretty with "--no-utf --color"
         Then I should see a non-utf prefixed output
+
+    Scenario: Showing code signing
+        Given I have a file to code sign
+        When I pipe to xcpretty with "--simple"
+        Then I should see a successful code signing message
+
+    Scenario: Showing code signing a framework
+        Given I have a framework to code sign
+        When I pipe to xcpretty with "--simple"
+        Then I should see a successful code signing message
+
+    Scenario: Showing preprocess
+        Given I have a file to preprocess
+        When I pipe to xcpretty with "--simple"
+        Then I should see a successful preprocessing message
+
+    Scenario: Showing a PBXCp copy
+        Given I have a file to copy with PBXCp
+        When I pipe to xcpretty with "--simple"
+        Then I should see a successful copying message
+
+    Scenario: Build fails when Pod install hasn't been run
+        Given podfile.lock wasn't in sync
+        When I pipe to xcpretty with "--simple --color"
+        Then I should see a red error message
+
+  Scenario: Compilation fails because of syntax errors
+      Given there was a syntax error
+      When I pipe to xcpretty with "--simple --color"
+      Then I should see a red compilation error
+      And I should see a failed line
+      And I should see a cyan cursor
+

data/features/steps/formatting_steps.rb

@@ -3,10 +3,22 @@ Given(/^I have a file to compile$/) do
   add_run_input SAMPLE_COMPILE
 end
 
+Given(/^I have a xib to compile$/) do
+  add_run_input SAMPLE_COMPILE_XIB
+end
+
 Given(/^I have a precompiled header$/) do
   add_run_input SAMPLE_PRECOMPILE
 end
 
+Given(/^I have a file to analyze$/) do
+  add_run_input SAMPLE_ANALYZE
+end
+
+Given(/^I have a file to shallow analyze$/) do
+  add_run_input SAMPLE_ANALYZE_SHALLOW
+end
+
 Given(/^I have a failing test in my suite$/) do
   add_run_input SAMPLE_SPECTA_FAILURE
 end
@@ -27,14 +39,54 @@ Given(/^I start a test suite$/) do
   add_run_input SAMPLE_OCUNIT_SUITE_BEGINNING
 end
 
-Given(/^I finish a test suite$/) do
+Given(/^the test suite has finished$/) do
   add_run_input SAMPLE_OCUNIT_SUITE_COMPLETION
+  add_run_input SAMPLE_EXECUTED_TESTS
+end
+
+Given(/^I have a file to code sign$/) do
+  add_run_input SAMPLE_CODESIGN
+end
+
+Given(/^I have a framework to code sign$/) do
+  add_run_input SAMPLE_CODESIGN_FRAMEWORK
+end
+
+Given(/^I have a file to preprocess$/) do
+  add_run_input SAMPLE_PREPROCESS
+end
+
+Given(/^I have a file to copy with PBXCp/) do
+  add_run_input SAMPLE_PBXCP
+end
+
+Given(/^podfile.lock wasn't in sync$/) do
+  add_run_input SAMPLE_PODS_ERROR
+end
+
+Given(/^there was a syntax error$/) do
+  SAMPLE_COMPILE_ERROR.split("\n").each do |line|
+    add_run_input(line)
+  end
 end
 
 When(/^I pipe to xcpretty with "(.*?)"$/) do |flags|
   run_xcpretty(flags)
 end
 
+When(/^I pipe to xcpretty with a custom formatter$/) do
+  formatter_path = File.expand_path('../../../spec/fixtures/custom_formatter.rb', __FILE__)
+  run_xcpretty("-f #{formatter_path}")
+end
+
+When(/^I pipe to xcpretty$/) do
+  run_xcpretty("")
+end
+
+Then(/^I should see a custom compilation message$/) do
+  run_output.should start_with("😎 Compilation party time")
+end
+
 Then(/^I should see a successful compilation message$/) do
   run_output.should start_with("▸ Compiling")
 end
@@ -43,6 +95,22 @@ Then(/^I should see a successful precompilation message$/) do
   run_output.should start_with("▸ Precompiling")
 end
 
+Then(/^I should see a successful analyze message$/) do
+  run_output.should start_with("▸ Analyzing")
+end
+
+Then(/^I should see a successful code signing message$/) do
+  run_output.should start_with("▸ Signing")
+end
+
+Then(/^I should see a successful preprocessing message$/) do
+  run_output.should start_with("▸ Preprocessing")
+end
+
+Then(/^I should see a successful copying message$/) do
+  run_output.should start_with("▸ Copying")
+end
+
 Then(/^I should see a yellow completion icon$/) do
   run_output.should start_with(yellow("▸"))
 end
@@ -105,11 +173,26 @@ Then(/^I should see a green passing test mark$/) do
 end
 
 Then(/^I should see a non-utf prefixed output$/) do
-  run_output.should start_with(".")
+  run_output.should start_with(green("."))
 end
 
+Then(/^I should not see the name of the test group$/) do
+  run_output.should_not include("RACTupleSpec")
+end
 
+Then(/^I should see a red error message$/) do
+  run_output.should include(red("⌦ ") + " " + red(SAMPLE_PODS_ERROR.gsub('error: ', '')))
+end
 
-Then(/^I should not see the name of the test group$/) do
-  run_output.should_not include(SAMPLE_TEST_GROUP_NAME)
+Then(/^I should see a red compilation error$/) do
+  run_output.should include(red("expected identifier"))
 end
+
+Then(/^I should see a failed line$/) do
+  run_output.should include("[[thread.lastMessage should] equal:thread.];")
+end
+
+Then(/^I should see a cyan cursor$/) do
+  run_output.should include(cyan("                                                          ^"))
+end
+