xcpretty 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb26660a637d4fc3689593415923419565e2c116
+  data.tar.gz: 65f2722cb1e05a4fac3be83b94a95a7101e6a0cb
+SHA512:
+  metadata.gz: 93be071f3e1f0b6c8723a4233c088fd19f538ff435ac473552f36b2fe3ac80efbaad6bafbe6ac9b7783a559e360586160d34d98ac24ad4cf68acb4632a02c09d
+  data.tar.gz: ef12b9807450c1f7a8f81ee845dbc60d28856f31750f1fbdc1965895ca48b2589697b8de76dbb6c5f66b4882fcbd44ade764aa3b27b37a71fa9ce51c87bc730d

data/.gitignore

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

data/.kick

@@ -0,0 +1,17 @@
+recipe :ruby
+recipe :ignore
+
+ignore(%r{^(spec/fixtures)})
+
+process do |files|
+  cuke_files = files.take_and_map do |path|
+    if path =~ %r{^features/\w+\.feature$}
+      path
+    elsif path =~ %r{^bin}
+      # run all features when bin/xcpretty changes
+      Dir.glob("features/**/*.feature")
+    end
+  end
+
+  execute "cucumber -f progress #{cuke_files.join(' ')}"
+end

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm: 2.0.0
+language: ruby
+script: rake ci
+

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xcpretty.gemspec
+gemspec
+
+group :test do
+  gem 'kicker'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marin Usalj
+
+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,96 @@
+# XCPretty
+
+__XCPretty is a fast and flexible formatter for `xcodebuild`__.<br/>
+It does one thing, and it should do it well.
+
+## Installation
+
+    $ gem install xcpretty
+
+## Usage
+
+XCPretty is designed to be piped with `xcodebuild` and thus keeping 100% compatibility with it.
+This means, when `xcodebuild` works, `xcpretty` works.
+It's even a bit faster than `xcodebuild` only, since it saves your terminal some prints.
+
+## Formats
+
+- simple (default)
+![xcpretty --simple](http://i.imgur.com/SMx0gUD.gif)
+
+- test (RSpec style, shown above)
+![xcpretty alpha](http://i.imgur.com/VeTQQub.gif)
+
+- tun / tap (not yet implemented. possible solution for most CI servers)
+
+## XCPretty isn't
+
+Unlike [xctool](https://github.com/facebook/xctool), `xcpretty` isn't a build tool.
+It relies on `xcodebuild` to do the build process, and it formats the output.
+
+## Why?
+
+There are many usages of this tool. Let me give you some ideas:
+
+- Xcode's test tools are close to useless. Failures in a sidebar, non-dettachable console,... You can use `xcpretty` to build your next Xcode test runner plugin
+- Run tests each time you hit save. The output is minimal, so go and wire it up with Kicker or Guard and be a real hipster!
+- Mine Bitcoins. You can't with this tool, but you'll be so productive that you can earn all the money and buy them!!!1!
+
+
+## Benchmark
+
+A smaller project ([ObjectiveSugar](https://github.com/mneorr/objectivesugar)) with a fast suite
+
+#### XCPretty
+```
+$ time xcodebuild -workspace ObjectiveSugar.xcworkspace -scheme ObjectiveSugar -sdk iphonesimulator test | xcpretty -tc
+....................................................................................
+
+Executed 84 tests, with 0 failures (0 unexpected) in 0.070 (0.094) seconds
+        4.08 real         5.82 user         2.08 sys
+```
+#### xcodebuild
+```
+$ time xcodebuild -workspace ObjectiveSugar.xcworkspace -scheme ObjectiveSugar -sdk iphonesimulator test
+... ommitted output ...
+Executed 84 tests, with 0 failures (0 unexpected) in 0.103 (0.129) seconds
+** TEST SUCCEEDED **
+
+        4.35 real         6.07 user         2.21 sys
+```
+#### XCtool
+```
+$ time xctool -workspace ObjectiveSugar.xcworkspace -scheme ObjectiveSugar -sdk iphonesimulator test
+... ommitted output ...
+** TEST SUCCEEDED: 84 passed, 0 failed, 0 errored, 84 total ** (26964 ms)
+
+28.05 real         6.59 user         2.24 sys
+```
+
+A bit bigger project, without CocoaPods ([ReactiveCocoa](https://github.com/ReactiveCocoa/ReactiveCocoa))
+
+#### XCPretty
+```
+$ time xcodebuild -project ReactiveCocoa.xcodeproj -scheme ReactiveCocoa test | xcpretty -tc
+..........................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................
+
+Executed 922 tests, with 0 failures (0 unexpected) in 6.437 (6.761) seconds
+        8.72 real         5.73 user         0.81 sys
+```
+#### xcodebuild
+```
+$ time xcodebuild -project ReactiveCocoa.xcodeproj -scheme ReactiveCocoa test
+... ommitted output ...
+Executed 922 tests, with 0 failures (0 unexpected) in 6.542 (6.913) seconds
+** TEST SUCCEEDED **
+
+        8.82 real         5.65 user         0.75 sys
+```
+#### XCtool
+```
+$ time xctool -project ReactiveCocoa.xcodeproj -scheme ReactiveCocoa test
+... ommitted output ...
+** TEST SUCCEEDED: 922 passed, 0 failed, 0 errored, 922 total ** (9584 ms)
+
+       10.80 real         6.72 user         0.76 sys
+```

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+
+task :kick do
+  sh 'kicker -r ruby'
+end
+
+task :spec do
+  sh 'rspec spec'
+end
+
+task :cucumber do
+  sh 'cucumber'
+end
+
+task :ci do
+  Rake::Task[:spec].invoke
+  Rake::Task[:cucumber].invoke
+end
+

data/bin/xcpretty

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'xcpretty'
+require 'optparse'
+
+if RUBY_VERSION < '1.9.3'
+  abort "error: XCPretty requires Ruby 1.9.3 or higher."
+end
+
+def printer
+  @printer ||= XCPretty::Printer::Simple.new
+end
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: xcodebuild [options] | xcpretty"
+  opts.on('-t', '--test', 'Use RSpec style output') do
+    @printer = XCPretty::Printer::RSpec.new
+  end
+  opts.on('-s', '--simple', 'Use simple output (default)') do
+    @printer = XCPretty::Printer::Simple.new
+  end
+  opts.on('-c', '--color', 'Use colorized output') do
+    @colorize = 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!
+  printer.colorize = @colorize
+end
+
+ARGF.each_line do |line|
+  printer.pretty_print(line)
+end

data/features/simple_format.feature

@@ -0,0 +1,21 @@
+Feature: Showing build output in simple format
+
+Scenario: Showing file compilation
+Given I have a file to compile
+When I run piping with options "--simple"
+Then I should see a successful compilation message
+
+Scenario: Showing precompilation
+Given I have a precompiled header
+When I run piping with options "--simple"
+Then I should see a successful precompilation message
+
+Scenario: Showing file compilation with colorization
+Given I have a file to compile
+When I run piping with options "--simple --color"
+Then I should see a green success icon
+
+Scenario: Showing precompilation
+Given I have a precompiled header
+When I run piping with options "--simple --color"
+Then I should see a green success icon

data/features/steps/formatting_steps.rb

@@ -0,0 +1,58 @@
+Given(/^I have a file to compile$/) do
+  add_run_input SAMPLE_COMPILE
+end
+
+Given(/^I have a precompiled header$/) do
+  add_run_input SAMPLE_PRECOMPILE
+end
+
+Given(/^I have a failing test in my suite$/) do
+  add_run_input SAMPLE_SPECTA_FAILURE
+end
+
+Given(/^all of my tests will pass in my suite$/) do
+  3.times { add_run_input SAMPLE_OCUNIT_TEST }
+end
+
+Given(/^I have a passing test in my suite$/) do
+  add_run_input SAMPLE_OCUNIT_TEST
+end
+
+When(/^I run piping with options "(.*?)"$/) do |flags|
+  run_xcpretty(flags)
+end
+
+Then(/^I should see a successful compilation message$/) do
+  run_output.should start_with("Compiling")
+end
+
+Then(/^I should see a successful precompilation message$/) do
+  run_output.should start_with("Precompiling")
+end
+
+Then(/^I should see a green success icon$/) do
+  run_output.should start_with("#{GREEN_START}✓#{COLOR_END}")
+end
+
+Then(/^I should see a failed test icon$/) do
+  run_output.should == "F"
+end
+
+Then(/^I should see a passing test icon$/) do
+  run_output.should == "."
+end
+
+Then(/^I should see a red failed test icon$/) do
+  run_output.should include("#{RED_START}F#{COLOR_END}")
+end
+
+Then(/^the final execution message should be (red|green)$/) do |color|
+  last_line = run_output.lines.last
+  start_color = color == "red" ? RED_START : GREEN_START
+  last_line.should start_with(start_color)
+  last_line.should end_with(COLOR_END)
+end
+
+Then(/^I should see a green passing test icon$/) do
+  run_output.should include("#{GREEN_START}.#{COLOR_END}")
+end

data/features/support/env.rb

@@ -0,0 +1,35 @@
+$:.unshift File.expand_path('../../..', __FILE__)
+
+require "tempfile"
+require "spec/fixtures/constants.rb"
+
+INPUT_FILE  = "xcpretty_input"
+RED_START   = "\e[31m"
+COLOR_END   = "\e[0m"
+GREEN_START = "\e[32;1m"
+
+def run_xcpretty flags
+  add_run_input SAMPLE_EXECUTED_TESTS
+  add_run_input SAMPLE_KIWI_SUITE_COMPLETION
+  input_file = Tempfile.new(INPUT_FILE)
+  File.write(input_file.path, run_input)
+  @output = %x(cat '#{input_file.path}' | bin/xcpretty #{flags})
+  input_file.unlink
+end
+
+def add_run_input text
+  run_input << "\n#{text}"
+end
+
+def run_input
+  @input ||= ""
+end
+
+def run_output
+  @output ||= ""
+end
+
+After do
+  @input  = ""
+  @output = ""
+end

data/features/test_format.feature

@@ -0,0 +1,27 @@
+Feature: Showing RSpec-style test output
+
+Scenario: Showing failed tests
+Given I have a failing test in my suite
+When I run piping with options "--test"
+Then I should see a failed test icon
+
+Scenario: Showing passing tests
+Given I have a passing test in my suite
+When I run piping with options "--test"
+Then I should see a passing test icon
+
+Scenario: Showing some tests failed with colorization
+Given I have a failing test in my suite
+When I run piping with options "--test --color"
+Then I should see a red failed test icon
+And the final execution message should be red
+
+Scenario: Showing passing tests with colorization
+Given I have a passing test in my suite
+When I run piping with options "--test --color"
+Then I should see a green passing test icon
+
+Scenario: Showing that all tests passed with color
+Given all of my tests will pass in my suite
+When I run piping with options "--test --color"
+Then the final execution message should be green

data/lib/xcpretty/printer.rb

@@ -0,0 +1,105 @@
+require "paint"
+
+module XCPretty
+
+	module Printer
+
+		attr_accessor :colorize
+
+    # @regex Captured groups
+    # $1 = file
+    # $2 = test_case
+    # $3 = failure_message
+		FAILING_TEST_MATCHER = /(.+:\d+):\serror:\s[\+\-]\[(.*)\]\s:(?:\s'.*'\s\[FAILED\],)?\s(.*)/
+
+    # @regex Captured groups
+    # $1 = test_case
+    # $2 = time
+    PASSING_TEST_MATCHER = /Test Case\s'-\[(.*)\]'\spassed\s\((\d*\.\d{3})\sseconds\)/
+
+    TESTS_DONE_MATCHER = /Test Suite ('.*\.(oc|xc)test(.*)') finished at/
+    EXECUTED_MATCHER = /^Executed/
+
+		Paint::SHORTCUTS[:printer] = {
+		  :white => Paint.color(:bold),
+      :red   => Paint.color(:red),
+      :green => Paint.color(:green, :bright),
+      :link  => Paint.color(:cyan),
+    }
+
+		include Paint::Printer
+
+		def pretty_print(text)
+      update_test_state(text)
+      formatted_text = pretty_format(text)
+      formatted_text = format_test_summary(text) if formatted_text.empty?
+
+      STDOUT.print(formatted_text + optional_newline) unless formatted_text.empty?
+    end
+
+    def update_test_state(text)
+      case text
+      when FAILING_TEST_MATCHER
+        store_failure($1, $2, $3)
+      when TESTS_DONE_MATCHER
+        @tests_done = true
+      end
+    end
+
+    def format_test_summary(text)
+      if text =~ EXECUTED_MATCHER && @tests_done && !@printed_summary
+        @printed_summary = true
+        test_summary(text)
+      else
+        ""
+      end
+    end
+
+    def optional_newline
+      ""
+    end
+
+    def project_build_info(text)
+      target = text.split('TARGET').last.split('OF PROJECT').first
+      clean_target = target.split('-').last.strip
+      project = text.split('OF PROJECT').last.split('WITH').first.strip
+      configuration = text.split('CONFIGURATION').last.split('===').first.strip
+      {
+        :target => clean_target,
+        :project => project,
+        :configuration => configuration
+      }
+    end
+
+    def test_summary(executed_message)
+      formatted_failures = failures.map do |f|
+        reason = colorize? ? red(f[:failure_message]) : f[:failure_message]
+        path   = colorize? ? link(f[:file]) : f[:file]
+        "#{f[:test_case]}, #{reason}\n#{path}"
+      end.join("\n\n")
+      final_message = if colorize?
+        failures.any? ? red(executed_message) : green(executed_message)
+      else
+        executed_message
+      end
+      text = [formatted_failures, final_message].join("\n\n\n").strip
+      "\n\n#{text}"
+    end
+
+    def failures
+      @failures ||= []
+    end
+
+		def store_failure(file, test_case, failure_message)
+      failures << {
+        file: file,
+        test_case: test_case,
+        failure_message: failure_message
+      }
+    end
+
+    def colorize?
+    	!!@colorize
+    end
+	end
+end

data/lib/xcpretty/printers/rspec.rb

@@ -0,0 +1,24 @@
+module XCPretty
+  module Printer
+
+    class RSpec
+      
+      include Printer
+
+      FAIL = "F"
+      PASS = "."
+
+      def pretty_format(text)
+        case text
+        when PASSING_TEST_MATCHER
+          colorize? ? green(PASS) : PASS
+        when FAILING_TEST_MATCHER
+          colorize? ? red(FAIL) : FAIL
+        else
+          ""
+        end
+      end
+      
+    end
+  end
+end

data/lib/xcpretty/printers/simple.rb

@@ -0,0 +1,124 @@
+require 'shellwords'
+
+module XCPretty
+  module Printer
+
+    class Simple
+      
+      include Printer
+
+      PASS = "✓"
+      FAIL = "✗"
+
+      def pretty_format(text)
+        case text
+        when /^ProcessPCH/
+          print_pch(text)
+        when /^CompileC/
+          print_compiling(text)
+        when /^Clean.Remove/
+          ""
+        when /^Check dependencies/
+          ""
+        when /^=== CLEAN TARGET/
+          print_clean_target(text)
+        when /^=== BUILD TARGET/
+          print_build_target(text)
+        when /^PhaseScriptExecution/
+          print_run_script(text)
+        when /^Libtool/
+          print_libtool(text)
+        when /^CpResource/
+          print_cpresource(text)
+        when /^CopyStringsFile/
+          print_copy_strings_file(text)
+        when /^GenerateDSYMFile/
+          print_generating_dsym(text)
+        when /^ProcessInfoPlistFile/
+          print_processing_info_plist(text)
+        when /^Ld/
+          print_linking(text)
+        when PASSING_TEST_MATCHER
+          print_passing_test($1, $2)
+        when FAILING_TEST_MATCHER
+          print_failing_test($2, $3)
+        else
+          ""
+        end
+      end
+
+      def optional_newline
+        "\n"
+      end
+
+      def print_failing_test(test_case, reason)
+        format("", "#{test_case}, #{reason}", false)
+      end
+
+      def print_passing_test(test_case, time)
+        format("", "#{test_case} (#{time} seconds)")
+      end
+
+      def print_linking(text)
+        format("Linking", text.shellsplit[1].split('/').last)
+      end
+
+      def print_pch(text)
+        format("Precompiling", Shellwords.shellsplit(text)[2])
+      end
+
+      def print_processing_info_plist(text)
+        format("Processing", text.lines.first.shellsplit.last.split('/').last)
+      end
+
+      def print_compiling(text)
+        format("Compiling", text.shellsplit[2].split('/').last)
+      end
+
+      def print_clean_target(text)
+        info = project_build_info(text)
+        format("Cleaning", "#{info[:project]}/#{info[:target]} [#{info[:configuration]}]")
+      end
+
+      def print_build_target(text)
+        info = project_build_info(text)
+        format("Building", "#{info[:project]}/#{info[:target]} [#{info[:configuration]}]")
+      end
+
+      def print_run_script(text)
+        format("Running script", "'#{text.lines.first.shellsplit[1..-2].join(' ').gsub('\ ',' ')}'")
+      end
+
+      def print_libtool(text)
+        format("Building library", text.shellsplit[1].split('/').last)
+      end
+
+      def print_cpresource(text)
+        format("Copying", text.shellsplit[1])
+      end
+
+      def print_copy_strings_file(text)
+        format("Copying", text.shellsplit.last.split('/').last)
+      end
+
+      def print_generating_dsym(text)
+        format("Generating DSYM file")
+      end
+
+      def format(command, argument_text="", success=true)
+        command_text = colorize? ? white(command) : command
+        [status_symbol(success), command_text, argument_text].join(" ").strip
+      end
+
+      def status_symbol(success)
+        if success && colorize?
+          green(PASS)
+        elsif colorize?
+          red(FAIL)
+        else
+          ""
+        end
+      end
+    end
+  end
+end

data/lib/xcpretty/version.rb

@@ -0,0 +1,3 @@
+module XCPretty
+  VERSION = "0.0.1"
+end

data/lib/xcpretty.rb

@@ -0,0 +1,8 @@
+require "xcpretty/version"
+require "xcpretty/printer"
+require "xcpretty/printers/simple"
+require "xcpretty/printers/rspec"
+
+module XCPretty
+  # Your code goes here...
+end