xcprofiler 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80fcd7c27be1aca66f3737dee49efe6fbd5eb1e5
+  data.tar.gz: dde766a09f92f390140db73f0d297359137eca50
+SHA512:
+  metadata.gz: 40694281fdc8f23f71fdcb16adcc408299770a2df619ea429898ab6ed5a28ac26ce0adab94c7f619bdbaa1055be6df746a2903e7b91ce488477ec27bb8de2ba8
+  data.tar.gz: da8040fd25d2245e8de385866dfb2c12e410ea3af43b2dbbe29cb3aaec91b7d81bc191d82e54d4c18a93775087f0a9b2318713c7787ac8813de3752abaddc4ce

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: 1pEOUTj3O1iV7D3cX8vNSEqgMoowKRKwW

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+cache: bundler
+script:
+  - "bundle exec rspec spec"
+rvm:
+  # OS X 10.9.5-10.10.0 (2.0.0-p481)
+  - 2.0.0-p481
+  # OS X 10.9.3-10.9.4
+  - 2.0.0-p451
+  - 2.3.1
+matrix:
+  include:
+    - rvm: system
+      osx_image: xcode8.1
+      language: objective-c
+      before_install: sudo gem install bundler
+    - rvm: 2.3.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Kohki Miki
+
+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,103 @@
+# xcprofiler
+
+[![Build Status](https://travis-ci.org/giginet/xcprofiler.svg?branch=master)](https://travis-ci.org/giginet/xcprofiler)
+[![Coverage Status](https://coveralls.io/repos/github/giginet/xcprofiler/badge.svg?branch=master)](https://coveralls.io/github/giginet/xcprofiler?branch=master)
+[![Gem Version](https://badge.fury.io/rb/xcprofiler.svg)](https://badge.fury.io/rb/xcprofiler)
+
+Command line utility to profile compilation time of Swift project.
+
+![](https://raw.githubusercontent.com/giginet/xcprofiler/master/assets/sample_output.png)
+
+This tool developed in working time for Cookpad.
+
+## Installation
+
+```
+gem install xcprofiler
+```
+
+## Usage
+
+1. Add `-Xfrontend -debug-time-function-bodies` build flags in `Other Swift Flags` section on your Xcode project.
+    ![](https://raw.githubusercontent.com/giginet/xcprofiler/master/assets/build_flags.png)
+
+2. Build your project
+3. Execute `xcprofiler`
+
+```
+$ xcprofiler [PRODUCT_NAME or ACTIVITY_LOG_PATH] [options]
+```
+
+`xcprofiler` searches the latest build log on your DerivedData directory.
+
+You can also specify the `.xcactivitylog`.
+
+```
+$ xcprofiler MyApp
+$ xcprofiler ~/Library/Developer/Xcode/DerivedData/MyApp-xxxxxxxxxxx/Logs/Build/0761C73D-3B6C-449A-BE89-6D11DAB748FE.xcactivitylog
+```
+
+Sample output is here
+
+```
++--------------------------------------------------+------+------------------------------------------------------------------------------------------------------------------------------------------+----------+
+| File                                             | Line | Method name                                                                                                                              | Time(ms) |
++--------------------------------------------------+------+------------------------------------------------------------------------------------------------------------------------------------------+----------+
+| Phakchi/Sources/Phakchi/Interaction.swift        | 17   | get {}                                                                                                                                   | 69.9     |
+| Phakchi/Sources/Phakchi/Matcher.swift            | 7    | get {}                                                                                                                                   | 68.9     |
+| Phakchi/Sources/Phakchi/InteractionBuilder.swift | 87   | func clean()                                                                                                                             | 49.8     |
+| Phakchi/Sources/Phakchi/Session.swift            | 74   | public func run(completionBlock: TestCompletionBlock? = default, executionBlock: @escaping TestExecutionBlock)                           | 49.6     |
+| Phakchi/Sources/Phakchi/Session.swift            | 65   | @discardableResult public func willRespondWith(status: Int, headers: Headers? = default, body: Body? = default) -> Self                  | 28.3     |
+| Phakchi/Sources/Phakchi/ControlServer.swift      | 20   | public func startSession(consumerName: String, providerName: String, completion completionBlock: StartSessionCompletionBlock? = default) | 24.6     |
+| Phakchi/Sources/Phakchi/ControlServer.swift      | 24   | (closure)                                                                                                                                | 23.9     |
+| Phakchi/Sources/Phakchi/InteractionBuilder.swift | 19   | private func makeHeaders(_ headers: Headers?, defaultHeaders: Headers?) -> Headers?                                                      | 20.5     |
+| Phakchi/Sources/Phakchi/ServiceClient.swift      | 47   | func registerInteraction(_ interaction: Interaction, completionHandler: CompletionHandler? = default)                                    | 16.4     |
+| Phakchi/Sources/Phakchi/ServiceClient.swift      | 60   | func verify(_ completionHandler: VerificationCompletionHandler? = default)                                                               | 14.3     |
+| Phakchi/Sources/Phakchi/ServiceClient.swift      | 27   | func resumeSessionTask(_ request: URLRequest, completionHandler: CompletionHandler? = default)                                           | 13.3     |
+| Phakchi/Sources/Phakchi/ControlServer.swift      | 32   | public func session(forConsumerName consumerName: String, providerName: String) -> Session?                                              | 9.7      |
+| Phakchi/Sources/Phakchi/InteractionBuilder.swift | 94   | get {}                                                                                                                                   | 5.9      |
+| Phakchi/Sources/Phakchi/ServiceClient.swift      | 15   | func makePactRequest(to endpoint: String, method: HTTPMethod, headers: [String : String] = default) -> URLRequest                        | 5.3      |
+| Phakchi/Sources/Phakchi/ServiceClient.swift      | 51   | func registerInteractions(_ interactions: [Interaction], completionHandler: CompletionHandler? = default)                                | 5.1      |
+| Phakchi/Sources/Phakchi/Encodable.swift          | 39   | get {}                                                                                                                                   | 4.8      |
+| Phakchi/Sources/Phakchi/ServiceClient.swift      | 121  | func start(session consumerName: String, providerName: String, completionHandler: @escaping CreateSessionCompletionHandler)              | 3.7      |
+| Phakchi/Sources/Phakchi/Encodable.swift          | 29   | get {}                                                                                                                                   | 3.4      |
+| Phakchi/Sources/Phakchi/ServiceClient.swift      | 72   | func writePact(for providerName: String, consumerName: String, exportPath: URL?, completionHandler: CompletionHandler? = default)        | 3.3      |
+| Phakchi/Sources/Phakchi/ServiceClient.swift      | 125  | (closure)                                                                                                                                | 3.1      |
++--------------------------------------------------+------+------------------------------------------------------------------------------------------------------------------------------------------+----------+
+```
+
+### Available Options
+
+|option|shorthand|description|
+|------|---------|-----------|
+|--limit|-l|Limit for display|
+|--show-invalids||Show invalid location results|
+|--order|-o|Sort order (default,time,file)|
+
+## Use custom reporters
+
+You can use reporters to output tracking logs.
+
+```ruby
+require 'xcprofiler'
+
+profiler = Xcprofiler::Profiler.by_product_name('MyApp')
+profiler.reporters = [
+  Xcprofiler::StandardOutputReporter.new(limit: 20, order: :time)],
+  Xcprofiler::JSONReporter.new({output_path: 'result.json'})
+]
+profiler.report!
+```
+
+You can also implement your own reporters.
+
+See implementation of [built-in reporters](https://github.com/giginet/xcprofiler/tree/master/lib/xcprofiler/reporters) for detail.
+
+## License
+
+MIT License
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/giginet/xcprofiler.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/xcprofiler

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.push File.expand_path("../../lib", __FILE__)
+
+require 'xcprofiler'
+
+Xcprofiler.execute(ARGV)

data/lib/xcprofiler/derived_data.rb

@@ -0,0 +1,67 @@
+require 'zlib'
+
+module Xcprofiler
+  class DerivedData
+    class << self
+      def all
+        pattern = File.join(derived_data_root, "**", "Logs", "Build", "*.xcactivitylog")
+        by_pattern(pattern)
+      end
+
+      def by_product_name(product_name)
+        pattern = File.join(derived_data_root, "#{product_name}-*", "Logs", "Build", "*.xcactivitylog")
+        by_pattern(pattern)
+      end
+
+      private
+
+      def by_pattern(pattern)
+        derived_data = Dir.glob(pattern).map { |path|
+          DerivedData.new(path)
+        }
+
+        if derived_data.empty?
+          raise DerivedDataNotFound, 'Any matching derived data are not found'
+        end
+
+        derived_data.max_by { |data| data.updated_at }
+      end
+
+      def derived_data_root
+        File.expand_path('~/Library/Developer/Xcode/DerivedData')
+      end
+    end
+
+    def initialize(path)
+      @path = path
+    end
+
+    def updated_at
+      File.mtime(@path)
+    end
+
+    def executions
+      @executions ||= lines.map { |line|
+        if line =~ /^\d*\.?\dms\t/
+          time, file, method_name = line.split(/\t/)
+          Execution.new(time, file, method_name)
+        end
+      }.compact
+    end
+
+    def flag_enabled?
+      lines.any? { |l| l.include?('-Xfrontend -debug-time-function-bodies') }
+    end
+
+    private
+
+    def lines
+      unless @lines
+        Zlib::GzipReader.open(@path) do |gz|
+          @lines = gz.read.split(/\r/)
+        end
+      end
+      @lines
+    end
+  end
+end

data/lib/xcprofiler/exceptions.rb

@@ -0,0 +1,10 @@
+module Xcprofiler
+  class DerivedDataNotFound < Exception
+  end
+
+  class BuildFlagIsNotEnabled < Exception
+  end
+
+  class OutputPathIsNotSpecified < Exception
+  end
+end

data/lib/xcprofiler/execution.rb

@@ -0,0 +1,62 @@
+module Xcprofiler
+  class Execution
+    Struct.new('Position', :path, :line, :column)
+
+    attr_reader :time, :position, :method_name
+
+    def initialize(time, position, method_name)
+      @time = time.to_f
+      unless position =~ /<invalid loc>/
+        path, line, column = position.split(':')
+        @position = Struct::Position.new(path, line.to_i, column.to_i)
+      end
+      @method_name = method_name
+    end
+
+    def to_h
+      {
+        method_name: method_name,
+        time: time,
+        path: path,
+        line: line,
+        column: column
+      }
+    end
+
+    def invalid?
+      !position
+    end
+
+    def path
+      if @position
+        @position.path
+      else
+        nil
+      end
+    end
+
+    def filename
+      if path
+        File.basename(path)
+      else
+        nil
+      end
+    end
+
+    def column
+      if @position
+        @position.column
+      else
+        nil
+      end
+    end
+
+    def line
+      if @position
+        @position.line
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/xcprofiler/profiler.rb

@@ -0,0 +1,40 @@
+require 'terminal-table'
+require 'colorize'
+
+module Xcprofiler
+  class Profiler
+    attr_writer :reporters
+    attr_reader :derived_data
+
+    def self.by_path(activity_log_path)
+      derived_data = DerivedData.new(activity_log_path)
+      Profiler.new(derived_data)
+    end
+
+    def self.by_product_name(product_name)
+      derived_data = DerivedData.by_product_name(product_name)
+      Profiler.new(derived_data)
+    end
+
+    def initialize(derived_data)
+      @derived_data = derived_data
+    end
+
+    def report!
+      if !derived_data.flag_enabled?
+        raise BuildFlagIsNotEnabled, "'-Xfrontend -debug-time-function-bodies' flag is not enabled"
+      end
+
+      reporters.each do |reporter|
+        reporter = reporter
+        reporter.report!(derived_data.executions)
+      end
+    end
+
+    private
+
+    def reporters
+      @reporters ||= [StandardOutputReporter.new(limit: options[:limit], order: options[:order])]
+    end
+  end
+end

data/lib/xcprofiler/reporters/abstract_reporter.rb

@@ -0,0 +1,45 @@
+module Xcprofiler
+  class AbstractReporter
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def report!(executions)
+      raise NotImplementedError, 'Not implemented'
+    end
+
+    protected
+
+    def filter_executions(executions)
+      executions = sort_executions(executions, order)
+      executions = executions.delete_if(&:invalid?) unless show_invalid_locations?
+      executions = executions[0...limit] if limit
+      executions
+    end
+
+    def sort_executions(executions, order)
+      case order
+        when :default
+          executions
+        when :time
+          executions.sort { |a, b| [b.time, (a.filename or ''), (a.line or 0)] <=> [a.time, (b.filename or ''), (b.line or 0)] }
+        when :file
+          executions.sort { |a, b| [(a.filename or ''), (a.line or 0)] <=> [(b.filename or ''), (b.line or 0)] }
+      end
+    end
+
+    def limit
+      options[:limit]
+    end
+
+    def show_invalid_locations?
+      options[:show_invalid_locations] || false
+    end
+
+    def order
+      options[:order] || :time
+    end
+  end
+end

data/lib/xcprofiler/reporters/json_reporter.rb

@@ -0,0 +1,22 @@
+require 'json'
+
+module Xcprofiler
+  class JSONReporter < AbstractReporter
+    def report!(executions)
+      json = filter_executions(executions).map(&:to_h)
+      unless output_path
+        raise OutputPathIsNotSpecified, '[JSONReporter] output_path is not specified'
+      end
+
+      File.open(output_path, "w") do |f|
+        f.write(JSON.pretty_generate(json))
+      end
+    end
+
+    private
+
+    def output_path
+      options[:output_path]
+    end
+  end
+end

data/lib/xcprofiler/reporters/standard_output_reporter.rb

@@ -0,0 +1,20 @@
+require 'terminal-table'
+
+module Xcprofiler
+  class StandardOutputReporter < AbstractReporter
+    def report!(executions)
+      filtered = filter_executions(executions)
+      puts table_for(filtered)
+    end
+
+    def table_for(executions)
+      Terminal::Table.new do |t|
+        t << ['File', 'Line', 'Method name', 'Time(ms)']
+        t << :separator
+        executions.each do |execution|
+          t << [execution.path, execution.line, execution.method_name, execution.time]
+        end
+      end
+    end
+  end
+end

data/lib/xcprofiler/version.rb

@@ -0,0 +1,3 @@
+module Xcprofiler
+  VERSION = "0.2.0"
+end

data/lib/xcprofiler.rb

@@ -0,0 +1,58 @@
+require "xcprofiler/derived_data"
+require "xcprofiler/exceptions"
+require "xcprofiler/execution"
+require "xcprofiler/profiler"
+require "xcprofiler/version"
+require "xcprofiler/reporters/abstract_reporter"
+require "xcprofiler/reporters/standard_output_reporter"
+require "xcprofiler/reporters/json_reporter"
+require "colorize"
+require "optparse"
+require "ostruct"
+
+module Xcprofiler
+  class << self
+    def execute(args)
+      options = OpenStruct.new
+      options.order = :time
+      options.reporters = [:standard_output]
+
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: xcprofiler [product name or .xcactivitylog file] [options]".red
+
+        opts.on("--[no-]show-invalids", "Show invalid location results") { |v| options.show_invalid_locations = v }
+        opts.on("-o [ORDER]", [:default, :time, :file], "Sort order") { |v| options.order = v }
+        opts.on("-l", "--limit [LIMIT]", Integer, "Limit for display") { |v| options.limit = v }
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+      end
+      parser.parse!(args)
+
+      target = args.pop
+      unless target
+        puts parser
+        exit 1
+      end
+
+      order = options[:order] or :time
+
+      begin
+        if target.end_with?('.xcactivitylog')
+          profiler = Profiler.by_path(target)
+        else
+          profiler = Profiler.by_product_name(target)
+        end
+        profiler.reporters = [
+          StandardOutputReporter.new(limit: options[:limit],
+                                     order: order,
+                                     show_invalid_locations: options[:show_invalid_locations])
+        ]
+        profiler.report!
+      rescue Exception => e
+        puts e.message.red
+      end
+    end
+  end
+end

data/xcprofiler.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xcprofiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xcprofiler"
+  spec.version       = Xcprofiler::VERSION
+  spec.authors       = ["giginet"]
+  spec.email         = ["giginet.net@gmail.com"]
+
+  spec.summary       = %q{CLI to profile compilation time of Swift projects}
+  spec.description   = %q{xcprofiler parses activity logs generated by Xcode and reports build time of Swift projects}
+  spec.homepage      = 'https://github.com/giginet/xcprofiler'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
+
+  spec.add_dependency 'terminal-table'
+  spec.add_dependency 'colorize'
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: xcprofiler
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- giginet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: xcprofiler parses activity logs generated by Xcode and reports build
+  time of Swift projects
+email:
+- giginet.net@gmail.com
+executables:
+- xcprofiler
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- assets/build_flags.png
+- assets/sample_output.png
+- bin/xcprofiler
+- lib/xcprofiler.rb
+- lib/xcprofiler/derived_data.rb
+- lib/xcprofiler/exceptions.rb
+- lib/xcprofiler/execution.rb
+- lib/xcprofiler/profiler.rb
+- lib/xcprofiler/reporters/abstract_reporter.rb
+- lib/xcprofiler/reporters/json_reporter.rb
+- lib/xcprofiler/reporters/standard_output_reporter.rb
+- lib/xcprofiler/version.rb
+- xcprofiler.gemspec
+homepage: https://github.com/giginet/xcprofiler
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: CLI to profile compilation time of Swift projects
+test_files: []