xcpretty-travis-profiler-formatter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eed1be6c6fe81977a21ab56e023838b86f769de9
+  data.tar.gz: 886ef24d20a6d02808fe1cb99b3711d01575e058
+SHA512:
+  metadata.gz: 10bbff30e631b277bd964200c57ba642343183e5166998cf241078f229404f5da1630809de64363cb22c4a66ed725906835143808f9eef785037f30f2fd067f1
+  data.tar.gz: e8a27465114ec78f0adbe488286f0b2ec8adaf2accc82bc8212adc62f336655bfcea878367e65385876b659adc0b244fd2c26ab88331ed0bae8d0c7772cb2e14

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Lars Lockefeer
+
+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,42 @@
+# XCPretty Travis Profiler Formatter
+
+Custom formatter for [xcpretty](https://github.com/supermarin/xcpretty) that calculates the compile time for files in Xcode projects and prints them to `stdout` formatted for Travis.
+
+## Installation
+
+Run:
+
+```
+gem install xcpretty-travis-profiler-formatter
+```
+
+## Usage
+
+Specify `xcpretty-travis-profiler-formatter` as a custom formatter to `xcpretty`:
+
+```bash
+#!/bin/bash
+
+xcodebuild -project "Project.xcodeproj" clean build | xcpretty -f `xcpretty-travis-profiler-formatter`
+```
+
+## Sample output
+
+```
+xcodebuild -workspace BrightFutures.xcworkspace -scheme BrightFutures-iOS clean build | xcpretty -f `xcpretty-travis-profiler-formatter`
+
+[...]
+
+[0.2616] Source/BrightFutures/BrightFutures/Async.swift
+[1.0931] Source/BrightFutures/Carthage/Checkouts/Result/Result/ResultType.swift
+[1.1641] Source/BrightFutures/BrightFutures/Errors.swift
+[1.1724] Source/BrightFutures/BrightFutures/Errors.swift
+[1.7121] Source/BrightFutures/Carthage/Checkouts/Result/Result/ResultType.swift
+-----
+[7.4310] Total compilation time
+```
+
+## Author
+
+* Lars Lockefeer ([@larslockefeer](https://twitter.com/larslockefeer))
+* Modified by Daniel Miedema ([@no_good_ones](https://twitter.com/no_good_ones))

data/bin/xcpretty-travis-profiler-formatter

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+print File.expand_path('../../lib/travis_profiler_formatter.rb', __FILE__)

data/lib/travis_profiler_formatter.rb

@@ -0,0 +1,136 @@
+class TravisProfilerFormatter < XCPretty::Formatter
+
+  def initialize(use_unicode, colorize)
+    super(use_unicode, colorize)
+    @compilation_phases = []
+    @current_compilation_phase = []
+    @compilation_phase_end_times = []
+  end
+
+  # For each file that we compile, track the current timestamp
+  def format_compile(file_name, file_path)
+    mark_compilation(file_path, file_name)
+    EMPTY;
+  end
+
+  def format_compile_command(compiler_command, file_path)
+    mark_compilation(file_path, nil)
+    EMPTY;
+  end
+
+  # Every time we enter the linking phase, we wrap up a compilation phase
+  # Store statistics for the current phase and set up for a new phase
+  def format_linking(file, build_variant, arch)
+    start_new_compilation_phase
+    EMPTY;
+  end
+
+  # When the build succeeded, we can generate our statistics and print them to the console
+  def format_phase_success(phase_name)
+    unless @current_compilation_phase.empty?
+      start_new_compilation_phase
+    end
+
+    if phase_name == "BUILD"
+      compile_times = calculate_compile_times
+      compile_times.sort_by { | compilation |
+        compilation[:compile_time]
+      }.each do | compilation |
+        puts "[#{format("%.4f", compilation[:compile_time])}] #{compilation[:file_path]}"
+      end
+
+      total_time = compile_times.reduce(0) { | acc, compilation |
+        acc + compilation[:compile_time]
+      }
+      puts "-----"
+      puts "[#{format("%.4f", total_time)}] Total compilation time"
+    end
+    EMPTY;
+  end
+
+  private
+
+  def mark_compilation(file_path, file_name)
+    @current_compilation_phase.push({
+      :start_time => Time.now,
+      :file_path => file_path,
+      :file_name => file_name
+    })
+  end
+
+  def start_new_compilation_phase
+    @compilation_phase_end_times.push(Time.now)
+    @compilation_phases.push(@current_compilation_phase)
+    @current_compilation_phase = []
+  end
+
+  def calculate_compile_times
+    compile_times = []
+    @compilation_phases.each_with_index do | compilation_phase, i |
+      compilation_phase.each_with_index do | compilation, j |
+        if j < (compilation_phase.count - 1) && compilation[:file_name]
+          compile_times.push({
+            :file_path => compilation[:file_path],
+            :file_name => compilation[:file_name],
+            :compile_time => compilation_phase[j+1][:start_time].to_f - compilation[:start_time].to_f
+          })
+        elsif j == compilation_phase.count - 1 && compilation[:file_name]
+          compile_times.push({
+            :file_path => compilation[:file_path],
+            :file_name => compilation[:file_name],
+            :compile_time => @compilation_phase_end_times[i].to_f - compilation[:start_time].to_f
+          })
+        end
+      end
+    end
+
+    return compile_times
+  end
+
+  ###
+  ### Travis Formatting
+  ###
+  # from https://github.com/kattrali/xcpretty-travis-formatter
+def open_fold(text)
+    return if text == @open_fold
+    close_fold(@open_fold) if @open_fold
+    print "travis_fold:start:#{text}\r"
+    @open_fold = text
+  end
+
+  def close_fold(text)
+    print "travis_fold:end:#{text}\r"
+    @open_fold = nil
+  end
+
+  def format_build_target(target, project, configuration)
+    open_fold("Build")
+    super
+  end
+
+  def format_analyze_target(target, project, configuration)
+    open_fold("Analyze")
+    super
+  end
+
+  def format_clean_target(target, project, configuration)
+    open_fold("Clean")
+    super
+  end
+
+  def format_test_run_started(name)
+    open_fold("Tests-#{scrub(name)}")
+    super
+  end
+
+  def format_test_run_finished(name, time)
+    close_fold("Tests-#{scrub(name)}")
+    super
+  end
+
+  def scrub(text)
+    text.gsub(/\s/,"_").split(".").first
+  end
+end
+
+TravisProfilerFormatter

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: xcpretty-travis-profiler-formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lars Lockefeer
+- Delisa Mason
+- Daniel Miedema
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xcpretty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: "\n  A combination of https://github.com/kattrali/xcpretty-travis-formatter\n
+  \ and https://github.com/larslockefeer/xcpretty-profiler-formatter\n  so that compilation
+  times are shown and its formatted for Travis.\n  "
+email:
+- lars.lockefeer@teampicnic.com
+- iskanamagus@gmail.com
+- daniel@dmiedema.com
+executables:
+- xcpretty-travis-profiler-formatter
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/xcpretty-travis-profiler-formatter
+- lib/travis_profiler_formatter.rb
+homepage: https://github.com/dmiedema/xcpretty-travis-profiler-formatter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: xcpretty formatter that profiles build times for Xcode projects with travis
+  supported output
+test_files: []