xcpretty-security-patched 0.3.0

data/features/tap_format.feature

@@ -0,0 +1,31 @@
+Feature: Showing Test Anything Protocol-compatible test output
+
+    Scenario: Showing failed tests
+        Given I have a failing test in my suite
+        When I pipe to xcpretty with "--tap"
+        Then I should see text beginning with "not ok 1"
+
+    Scenario: Showing passing tests
+        Given I have a passing test in my suite
+        When I pipe to xcpretty with "--tap"
+        Then I should see text beginning with "ok 1"
+
+    Scenario: Showing pending tests
+        Given I have a pending test in my suite
+        When I pipe to xcpretty with "--tap"
+        Then I should see text containing " # TODO" and beginning with "not ok 1"
+
+    Scenario: Showing how many tests completed
+        Given I have a pending test in my suite
+        And 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 "--tap"
+        Then I should see text matching "1..3"
+
+    Scenario: Showing a running test counter
+        Given I have a passing test in my suite
+        And I have a failing test in my suite
+        When I pipe to xcpretty with "--tap"
+        Then I should see text beginning with "ok 1"
+        And I should see text beginning with "not ok 2"

data/features/test_format.feature

@@ -0,0 +1,49 @@
+Feature: Showing RSpec-style test output
+
+    Scenario: Showing failed tests
+        Given I have a failing test in my suite
+        When I pipe to xcpretty with "--test --no-color"
+        Then I should see a failed test icon
+
+    Scenario: Showing passing tests
+        Given I have a passing test in my suite
+        When I pipe to xcpretty with "--test --no-color"
+        Then I should see a passing test icon in ASCII
+
+    Scenario: Showing pending tests
+        Given I have a pending test in my suite
+        When I pipe to xcpretty with "--test --no-color"
+        Then I should see a pending test icon in ASCII
+
+    Scenario: Showing measuring tests
+        Given I have a measuring test in my suite
+        When I pipe to xcpretty with "--test --no-color"
+        Then I should see a measuring test icon in ASCII
+
+    Scenario: Showing some tests failed with color
+        Given I have a failing test in my suite
+        And the test suite has finished
+        When I pipe to xcpretty with "--test --color"
+        Then I should see a red failed test icon
+        And I should see the path of a failed test
+        And the final execution message should be red
+
+    Scenario: Showing passing tests with color
+        Given I have a passing test in my suite
+        When I pipe to xcpretty with "--test --color"
+        Then I should see a green passing test icon
+
+    Scenario: Showing pending tests with color
+        Given I have a pending test in my suite
+        When I pipe to xcpretty with "--test --color"
+        Then I should see a yellow pending test icon
+
+    Scenario: Showing measuring tests with color
+        Given I have a measuring test in my suite
+        When I pipe to xcpretty with "--test --color"
+        Then I should see a yellow measuring test icon
+
+    Scenario: Showing that all tests passed with color
+        Given all of my tests will pass in my suite
+        When I pipe to xcpretty with "--test --color"
+        Then the final execution message should be green

data/features/xcpretty.feature

@@ -0,0 +1,14 @@
+Feature: CLI behavior
+
+    Scenario: Starting xcpretty without any flags
+        When I run xcpretty
+        Then I should see the help banner
+
+    Scenario: Starting xcpretty with version
+        When I run xcpretty with -v
+        Then I should see the xcpretty version
+
+    Scenario: Performance
+        When I run xcpretty over a big file
+        Then the performance should be way faster than running cat
+

data/lib/xcpretty/ansi.rb

@@ -0,0 +1,72 @@
+module XCPretty
+  module ANSI
+
+    attr_accessor :colorize
+
+    FORMATTED_MATCHER = %r{\e\[(\d+)[;]?(\d+)?m(.*)\e\[0m}
+
+    EFFECT = {
+      reset: '0',
+      bold: '1',
+      underline: '4'
+    }
+
+    COLORS = {
+      black: '30',
+      red: '31',
+      green: '32',
+      yellow: '33',
+      blue: '34',
+      cyan: '36',
+      white: '37',
+      plain: '39'
+    }
+
+    def colorize?
+      !!@colorize
+    end
+
+    def white(text)
+      ansi_parse(text, :plain, :bold)
+    end
+
+    def red(text)
+      ansi_parse(text, :red)
+    end
+
+    def green(text)
+      ansi_parse(text, :green, :bold)
+    end
+
+    def cyan(text)
+      ansi_parse(text, :cyan)
+    end
+
+    def yellow(text)
+      ansi_parse(text, :yellow)
+    end
+
+    def applied_effects(text)
+      effects = []
+      if text =~ FORMATTED_MATCHER
+        colors = COLORS.invert[$1]
+        effect = EFFECT.invert[$2]
+        effects << colors if colors
+        effects << effect if effect
+      end
+      effects
+    end
+
+    def strip(text)
+      text =~ FORMATTED_MATCHER ? $3 : text
+    end
+
+    def ansi_parse(text, color, effect=nil)
+      return text unless colorize?
+      colors_code = COLORS[color] || ''
+      effect_code = EFFECT[effect] ? ';' + EFFECT[effect] : ''
+      "\e[#{colors_code}#{effect_code}m#{text}\e[#{EFFECT[:reset]}m"
+    end
+  end
+end
+

data/lib/xcpretty/formatters/formatter.rb

@@ -0,0 +1,200 @@
+# encoding: utf-8
+require 'xcpretty/ansi'
+require 'xcpretty/parser'
+
+module XCPretty
+
+  # Making a new formatter is easy.
+  # Just make a subclass of Formatter, and override any of these methods.
+  module FormatMethods
+    EMPTY = ''.freeze
+
+    def format_analyze(file_name, file_path);                  EMPTY; end
+    def format_build_target(target, project, configuration);   EMPTY; end
+    def format_aggregate_target(target, project, configuration); EMPTY; end
+    def format_analyze_target(target, project, configuration); EMPTY; end
+    def format_check_dependencies;                             EMPTY; end
+    def format_clean(project, target, configuration);          EMPTY; end
+    def format_clean_target(target, project, configuration);   EMPTY; end
+    def format_clean_remove;                                   EMPTY; end
+    def format_compile(file_name, file_path);                  EMPTY; end
+    def format_compile_command(compiler_command, file_path);   EMPTY; end
+    def format_compile_storyboard(file_name, file_path);       EMPTY; end
+    def format_compile_xib(file_name, file_path);              EMPTY; end
+    def format_copy_header_file(source, target);               EMPTY; end
+    def format_copy_plist_file(source, target);                EMPTY; end
+    def format_copy_strings_file(file_name);                   EMPTY; end
+    def format_cpresource(file);                               EMPTY; end
+    def format_generate_dsym(dsym);                            EMPTY; end
+    def format_linking(file, build_variant, arch);             EMPTY; end
+    def format_libtool(library);                               EMPTY; end
+    def format_passing_test(suite, test, time);                EMPTY; end
+    def format_pending_test(suite, test);                      EMPTY; end
+    def format_measuring_test(suite, test, time);              EMPTY; end
+    def format_failing_test(suite, test, reason, file_path);   EMPTY; end
+    def format_process_pch(file);                              EMPTY; end
+    def format_process_pch_command(file_path);                 EMPTY; end
+    def format_phase_success(phase_name);                      EMPTY; end
+    def format_phase_script_execution(script_name);            EMPTY; end
+    def format_process_info_plist(file_name, file_path);       EMPTY; end
+    def format_codesign(file);                                 EMPTY; end
+    def format_preprocess(file);                               EMPTY; end
+    def format_pbxcp(file);                                    EMPTY; end
+    def format_shell_command(command, arguments);              EMPTY; end
+    def format_test_run_started(name);                         EMPTY; end
+    def format_test_run_finished(name, time);                  EMPTY; end
+    def format_test_suite_started(name);                       EMPTY; end
+    def format_test_summary(message, failures_per_suite);      EMPTY; end
+    def format_touch(file_path, file_name);                    EMPTY; end
+    def format_tiffutil(file);                                 EMPTY; end
+    def format_write_file(file);                               EMPTY; end
+    def format_write_auxiliary_files;                          EMPTY; end
+    def format_other(text)                                     EMPTY; end
+
+    # COMPILER / LINKER ERRORS AND WARNINGS
+    def format_compile_error(file_name, file_path, reason,
+                             line, cursor);                    EMPTY; end
+    def format_error(message);                                 EMPTY; end
+    def format_file_missing_error(error, file_path);           EMPTY; end
+    def format_ld_warning(message);                            EMPTY; end
+    def format_undefined_symbols(message, symbol, reference);  EMPTY; end
+    def format_duplicate_symbols(message, file_paths);         EMPTY; end
+    def format_warning(message);                             message; end
+
+    # TODO: see how we can unify format_error and format_compile_error,
+    #       the same for warnings
+    def format_compile_warning(file_name, file_path, reason,
+                               line, cursor);                  EMPTY; end
+  end
+
+  class Formatter
+
+    include ANSI
+    include FormatMethods
+
+    attr_reader :parser
+
+    def initialize(use_unicode, colorize)
+      @use_unicode = use_unicode
+      @colorize = colorize
+      @parser = Parser.new(self)
+    end
+
+    def finish
+    end
+
+    # Override if you want to catch something specific with your regex
+    def pretty_format(text)
+      parser.parse(text)
+    end
+
+    # If you want to print inline, override #optional_newline with ''
+    def optional_newline
+      "\n"
+    end
+
+    def use_unicode?
+      !!@use_unicode
+    end
+
+    # Will be printed by default. Override with '' if you don't want summary
+    def format_test_summary(executed_message, failures_per_suite)
+      failures = format_failures(failures_per_suite)
+      if failures.empty?
+        final_message = green(executed_message)
+      else
+        final_message = red(executed_message)
+      end
+
+      text = [failures, final_message].join("\n\n\n").strip
+      "\n\n#{text}"
+    end
+
+    ERROR = '❌ '
+    ASCII_ERROR = '[x]'
+
+    WARNING = '⚠️ '
+    ASCII_WARNING = '[!]'
+
+    def format_error(message)
+      "\n#{red(error_symbol + " " + message)}\n\n"
+    end
+
+    def format_compile_error(file, file_path, reason, line, cursor)
+      "\n#{red(error_symbol + " ")}#{file_path}: #{red(reason)}\n\n" \
+        "#{line}\n#{cyan(cursor)}\n\n"
+    end
+
+    def format_file_missing_error(reason, file_path)
+      "\n#{red(error_symbol + " " + reason)} #{file_path}\n\n"
+    end
+
+    def format_compile_warning(file, file_path, reason, line, cursor)
+      "\n#{yellow(warning_symbol + ' ')}#{file_path}: #{yellow(reason)}\n\n" \
+        "#{line}\n#{cyan(cursor)}\n\n"
+    end
+
+    def format_ld_warning(reason)
+      "#{yellow(warning_symbol + ' ' + reason)}"
+    end
+
+    def format_undefined_symbols(message, symbol, reference)
+      "\n#{red(error_symbol + " " + message)}\n" \
+        "> Symbol: #{symbol}\n" \
+        "> Referenced from: #{reference}\n\n"
+    end
+
+    def format_duplicate_symbols(message, file_paths)
+      "\n#{red(error_symbol + " " + message)}\n" \
+        "> #{file_paths.map { |path| path.split('/').last }.join("\n> ")}\n"
+    end
+
+    def format_will_not_be_code_signed(message)
+      "#{yellow(warning_symbol + " " + message)}"
+    end
+
+    def format_other(text)
+      ""
+    end
+
+
+    private
+
+    def format_failures(failures_per_suite)
+      failures_per_suite.map do |suite, failures|
+        formatted_failures = failures.map do |failure|
+          format_failure(failure)
+        end.join("\n\n")
+
+        "\n#{suite}\n#{formatted_failures}"
+      end.join("\n")
+    end
+
+    def format_failure(f)
+      snippet = Snippet.from_filepath(f[:file_path])
+      output = "  #{f[:test_case]}, #{red(f[:reason])}"
+      output += "\n  #{cyan(f[:file_path])}"
+      return output if snippet.contents.empty?
+
+      output += "\n  ```\n"
+      if @colorize
+        output += Syntax.highlight(snippet)
+      else
+        output += snippet.contents
+      end
+
+      output += "  ```"
+      output
+    end
+
+    def error_symbol
+      use_unicode? ? ERROR : ASCII_ERROR
+    end
+
+    def warning_symbol
+      use_unicode? ? WARNING : ASCII_WARNING
+    end
+
+  end
+end
+

data/lib/xcpretty/formatters/knock.rb

@@ -0,0 +1,35 @@
+module XCPretty
+
+  class Knock < Formatter
+
+    FAIL = 'not ok'
+    PASS = 'ok'
+
+    def format_passing_test(suite, test_case, time)
+      "#{PASS} - #{test_case}"
+    end
+
+    def format_failing_test(test_suite, test_case, reason, file)
+      "#{FAIL} - #{test_case}: FAILED" +
+      format_failure_diagnostics(test_suite, test_case, reason, file)
+    end
+
+    def format_test_summary(executed_message, failures_per_suite)
+      ''
+    end
+
+    def format_failure_diagnostics(test_suite, test_case, reason, file)
+      format_diagnostics(reason) +
+      format_diagnostics("  #{file}: #{test_suite} - #{test_case}")
+    end
+
+    private
+
+    def format_diagnostics(text)
+      "\n# #{text}"
+    end
+
+  end
+
+end
+

data/lib/xcpretty/formatters/rspec.rb

@@ -0,0 +1,33 @@
+module XCPretty
+
+  class RSpec < Formatter
+
+    FAIL = "F"
+    PASS = "."
+    PENDING = "P"
+    MEASURING = 'T'
+
+    def optional_newline
+      ''
+    end
+
+    def format_passing_test(suite, test_case, time)
+      green(PASS)
+    end
+
+    def format_failing_test(test_suite, test_case, reason, file)
+      red(FAIL)
+    end
+
+    def format_pending_test(suite, test_case)
+      yellow(PENDING)
+    end
+
+    def format_measuring_test(suite, test_case, time)
+      yellow(MEASURING)
+    end
+
+  end
+
+end
+

data/lib/xcpretty/formatters/simple.rb

@@ -0,0 +1,200 @@
+# encoding: utf-8
+require 'shellwords'
+
+module XCPretty
+
+  class Simple < Formatter
+
+    PASS = "✓"
+    FAIL = "✗"
+    PENDING = "⧖"
+    COMPLETION = "▸"
+    MEASURE = '◷'
+
+    ASCII_PASS = "."
+    ASCII_FAIL = "x"
+    ASCII_PENDING = "P"
+    ASCII_COMPLETION = ">"
+    ASCII_MEASURE = 'T'
+
+    INDENT = "    "
+
+    def format_analyze(file_name, file_path)
+      format("Analyzing", file_name)
+    end
+
+    def format_build_target(target, project, configuration)
+      format("Building", "#{project}/#{target} [#{configuration}]")
+    end
+
+    def format_aggregate_target(target, project, configuration)
+      format("Aggregate", "#{project}/#{target} [#{configuration}]")
+    end
+
+    def format_analyze_target(target, project, configuration)
+      format("Analyzing", "#{project}/#{target} [#{configuration}]")
+    end
+
+    def format_clean_target(target, project, configuration)
+      format("Cleaning", "#{project}/#{target} [#{configuration}]")
+    end
+
+    def format_compile(file_name, file_path)
+      format("Compiling", file_name)
+    end
+
+    def format_compile_xib(file_name, file_path)
+      format("Compiling", file_name)
+    end
+
+    def format_compile_storyboard(file_name, file_path)
+      format("Compiling", file_name)
+    end
+
+    def format_copy_header_file(source, target)
+      format("Copying", File.basename(source))
+    end
+
+    def format_copy_plist_file(source, target)
+      format("Copying", File.basename(source))
+    end
+
+    def format_copy_strings_file(file)
+      format("Copying", file)
+    end
+
+    def format_cpresource(resource)
+      format("Copying", resource)
+    end
+
+    def format_generate_dsym(dsym)
+      format("Generating '#{dsym}'")
+    end
+
+    def format_libtool(library)
+      format("Building library", library)
+    end
+
+    def format_linking(target, build_variants, arch)
+      format("Linking", target)
+    end
+
+    def format_failing_test(suite, test_case, reason, file)
+      INDENT + format_test("#{test_case}, #{reason}", :fail)
+    end
+
+    def format_passing_test(suite, test_case, time)
+      INDENT + format_test("#{test_case} (#{colored_time(time)} seconds)",
+                           :pass)
+    end
+
+    def format_pending_test(suite, test_case)
+      INDENT + format_test("#{test_case} [PENDING]", :pending)
+    end
+
+    def format_measuring_test(suite, test_case, time)
+      INDENT + format_test(
+        "#{test_case} measured (#{colored_time(time)} seconds)", :measure
+      )
+    end
+
+    def format_phase_success(phase_name)
+      format(phase_name.capitalize, "Succeeded")
+    end
+
+    def format_phase_script_execution(script_name)
+      format("Running script", "'#{script_name}'")
+    end
+
+    def format_process_info_plist(file_name, file_path)
+      format("Processing", file_name)
+    end
+
+    def format_process_pch(file)
+      format("Precompiling", file)
+    end
+
+    def format_codesign(file)
+      format("Signing", file)
+    end
+
+    def format_preprocess(file)
+      format("Preprocessing", file)
+    end
+
+    def format_pbxcp(file)
+      format("Copying", file)
+    end
+
+    def format_test_run_started(name)
+      heading("Test Suite", name, "started")
+    end
+
+    def format_test_suite_started(name)
+      heading("", name, "")
+    end
+
+    def format_touch(file_path, file_name)
+      format("Touching", file_name)
+    end
+
+    def format_tiffutil(file_name)
+      format("Validating", file_name)
+    end
+
+    def format_warning(message)
+      INDENT + yellow(message)
+    end
+
+    def format_check_dependencies
+      format('Check Dependencies')
+    end
+
+    private
+
+    def heading(prefix, text, description)
+      [prefix, white(text), description].join(" ").strip
+    end
+
+    def format(command, argument_text="", success=true)
+      symbol = status_symbol(success ? :completion : :fail)
+      [symbol, white(command), argument_text].join(" ").strip
+    end
+
+    def format_test(test_case, status)
+      [status_symbol(status), test_case].join(" ").strip
+    end
+
+    def status_symbol(status)
+      case status
+      when :pass
+        green(use_unicode? ? PASS : ASCII_PASS)
+      when :fail
+        red(use_unicode? ? FAIL : ASCII_FAIL)
+      when :pending
+        yellow(use_unicode? ? PENDING : ASCII_PENDING)
+      when :error
+        red(use_unicode? ? ERROR : ASCII_ERROR)
+      when :completion
+        yellow(use_unicode? ? COMPLETION : ASCII_COMPLETION)
+      when :measure
+        yellow(use_unicode? ? MEASURE : ASCII_MEASURE)
+      else
+        ""
+      end
+    end
+
+    def colored_time(time)
+      case time.to_f
+      when 0..0.025
+        time
+      when 0.026..0.100
+        yellow(time)
+      else
+        red(time)
+      end
+    end
+
+  end
+end
+

data/lib/xcpretty/formatters/tap.rb

@@ -0,0 +1,40 @@
+module XCPretty
+
+  class TestAnything < Knock
+
+    attr_reader :counter
+
+    def initialize(unicode, color)
+      super
+      @counter = 0
+    end
+
+    def format_passing_test(suite, test_case, time)
+      increment_counter
+      "#{PASS} #{counter} - #{test_case}"
+    end
+
+    def format_failing_test(test_suite, test_case, reason, file)
+      increment_counter
+      "#{FAIL} #{counter} - #{test_case}" +
+      format_failure_diagnostics(test_suite, test_case, reason, file)
+    end
+
+    def format_pending_test(test_suite, test_case)
+      increment_counter
+      "#{FAIL} #{counter} - #{test_case} # TODO Not written yet"
+    end
+
+    def format_test_summary(executed_message, failures_per_suite)
+      counter > 0 ? "1..#{counter}" : ''
+    end
+
+    private
+
+    def increment_counter
+      @counter += 1
+    end
+  end
+
+end
+