danger-xcprofiler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4517483c48363b161682735098cb155421e85f2a
+  data.tar.gz: 1d83c34b91abe07910c18828b5995146c69106a3
+SHA512:
+  metadata.gz: 834d6a44e9f21f0822392719f81b8bb81714ab624a07df1f47bbaf2771a9cb0080b09a0b355553bf2f3c5da4f2cd2822716f497e8cfda64b79108e3ee8ee13d4
+  data.tar.gz: a22b24a903276c06eeaad1b36d2f363cec26b5c5c74875456678b2f8c49d73253191c9c6d406962cfbd91e519031bf8b1d8eb97ede8bb2994f45dfab6dba7119

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+pkg
+.idea/
+Gemfile.lock
+.yardoc/*

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Style/Documentation:
+  Enabled: false
+
+

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+script:
+    - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-xcprofiler.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Kohki Miki <koki-miki@cookpad.com>
+
+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,49 @@
+# danger-xcprofiler
+[![Build Status](https://travis-ci.org/giginet/danger-xcprofiler.svg?branch=master)](https://travis-ci.org/giginet/danger-xcprofiler)
+
+[danger](https://github.com/danger/danger) plugin for asserting Swift compilation time.
+
+See detail for README of [xcprofiler](https://github.com/giginet/xcprofiler).
+
+![](assets/warning.png)
+
+## Installation
+
+Add this line to your Gemfile:
+
+```sh
+gem 'danger-xcprofiler'
+```
+
+## Usage
+
+Just add this line to your Dangerfile:
+
+```ruby
+xcprofiler.report 'MyApp'
+```
+
+If compilation times of each methods are exceeded the thresholds, `danger` adds inline comment to your PR.
+
+Default thresholds is 50ms for warning, 100ms for failure. 
+
+If you want to change thresholds see the following:
+
+```ruby
+# Defines inline_mode
+xcprofiler.inline_mode = false
+# Defines thresholds (ms)
+xcprofiler.thresholds = {
+  warn: 100,
+  fail: 500
+}
+xcprofiler.report 'MyApp'
+```
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-xcprofiler.gemspec

@@ -0,0 +1,51 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xcprofiler/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-xcprofiler'
+  spec.version       = DangerXcprofiler::VERSION
+  spec.authors       = ['giginet']
+  spec.email         = ['giginet.net@gmail.com']
+  spec.description   = 'danger plugin for asserting Swift compilation time.'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/giginet/danger-xcprofiler'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'xcprofiler'
+  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # Linting code and docs
+  spec.add_development_dependency 'rubocop', '~> 0.41'
+  spec.add_development_dependency 'yard', '~> 0.8'
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require 'xcprofiler/plugin'

data/lib/danger_xcprofiler.rb

@@ -0,0 +1 @@
+require 'xcprofiler/gem_version'

data/lib/xcprofiler/danger_reporter.rb

@@ -0,0 +1,37 @@
+require 'xcprofiler'
+require 'pathname'
+
+module Danger
+  class DangerReporter < Xcprofiler::AbstractReporter
+    def initialize(dangerfile, thresholds, inline_mode, working_dir)
+      super({})
+      @dangerfile = dangerfile
+      @thresholds = thresholds
+      @inline_mode = inline_mode
+      @working_dir = working_dir
+    end
+
+    def report!(executions)
+      executions.each do |execution|
+        options = {}
+        if @inline_mode
+          options[:file] = relative_path(execution.path)
+          options[:line] = execution.line
+        end
+        message = "`#{execution.method_name}` takes #{execution.time} ms to build"
+        if execution.time >= @thresholds[:fail]
+          @dangerfile.fail(message, options)
+        elsif execution.time >= @thresholds[:warn]
+          @dangerfile.warn(message, options)
+        end
+      end
+    end
+
+    private
+
+    def relative_path(path)
+      working_dir = Pathname.new(@working_dir)
+      Pathname.new(path).relative_path_from(working_dir).to_s
+    end
+  end
+end

data/lib/xcprofiler/gem_version.rb

@@ -0,0 +1,3 @@
+module DangerXcprofiler
+  VERSION = '0.1.0'.freeze
+end

data/lib/xcprofiler/plugin.rb

@@ -0,0 +1,64 @@
+require 'xcprofiler'
+require_relative 'danger_reporter'
+
+module Danger
+  # Asserts compilation time of each methods if these are exceeded the specified thresholds
+  # @example Asserting compilation time of 'MyApp'
+  #
+  #          xcprofiler.report 'MyApp'
+  #
+  # @example Define thresholds (ms)
+  #
+  #          xcprofiler.thresholds = { warn: 100, fail: 500 }
+  #          xcprofiler.report 'MyApp'
+  #
+  # @see  giginet/danger-xcprofiler
+  # @tags xcode, ios, danger
+  class DangerXcprofiler < Plugin
+    # Defines path for working directory
+    # Default value is `Dir.pwd`
+    # @param     [String] value
+    # @return    [String]
+    attr_accessor :working_dir
+
+    # Defines threshold of compilation time (ms) to assert warning/failure
+    # Default value is `{ warn: 100, fail: 500 }`
+    # @param    [Hash<String, String>] value
+    # @return   [Hash<String, String>]
+    attr_accessor :thresholds
+
+    # Defines if using inline comment to assert
+    # Default value is `true`
+    # @param    [Boolean] value
+    # @return   [Boolean]
+    attr_accessor :inline_mode
+
+    # Search the latest .xcactivitylog by the passing product_name and profile compilation time
+    # @param    [String] product_name Product name for the target project.
+    # @return   [void]
+    def report(product_name)
+      profiler = Xcprofiler::Profiler.by_product_name(product_name)
+      profiler.reporters = [
+        DangerReporter.new(@dangerfile, thresholds, inline_mode, working_dir)
+      ]
+      profiler.report!
+    rescue Xcprofiler::DerivedDataNotFound, Xcprofiler::BuildFlagIsNotEnabled => e
+      warn(e.message)
+    end
+
+    private
+
+    def working_dir
+      @working_dir || Dir.pwd
+    end
+
+    def thresholds
+      @thresholds || { warn: 50, fail: 100 }
+    end
+
+    def inline_mode
+      return false if @inline_mode.nil? == false
+      true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$LOAD_PATH.unshift((ROOT + 'lib').to_s)
+$LOAD_PATH.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'pry'
+
+require 'rspec'
+require 'danger'
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace 'bundler'
+  config.color = true
+  config.tty = true
+end
+
+require 'danger_plugin'
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, '')
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    'HAS_JOSH_K_SEAL_OF_APPROVAL' => 'true',
+    'TRAVIS_PULL_REQUEST' => '800',
+    'TRAVIS_REPO_SLUG' => 'artsy/eigen',
+    'TRAVIS_COMMIT_RANGE' => '759adcbd0d8f...13c4dc8bb61d',
+    'DANGER_GITHUB_API_TOKEN' => '123sbdq54erfsd3422gdfio'
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

data/spec/xcprofiler_spec.rb

@@ -0,0 +1,114 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'xcprofiler'
+
+module Danger
+  describe Danger::DangerXcprofiler do
+    it 'should be a plugin' do
+      expect(Danger::DangerXcprofiler.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe 'with Dangerfile' do
+      let(:product_name) { 'MyApp' }
+      let(:derived_data) { double('derived_data') }
+      let(:profiler) { Xcprofiler::Profiler.new(derived_data) }
+      let(:location) { 'path/to/Source.swift:20:30' }
+      let(:method_name) { 'doSomething()' }
+      let(:time0) { 0 }
+      let(:time1) { 0 }
+      let(:execution0) { Xcprofiler::Execution.new(time0, location, method_name) }
+      let(:execution1) { Xcprofiler::Execution.new(time1, location, method_name) }
+
+      before do
+        @dangerfile = testing_dangerfile
+        @xcprofiler = @dangerfile.xcprofiler
+        @xcprofiler.working_dir = ''
+        allow(@dangerfile).to receive(:warn)
+        allow(@dangerfile).to receive(:fail)
+        allow(Xcprofiler::Profiler).to receive(:by_product_name).with(product_name).and_return(profiler)
+        allow(derived_data).to receive(:flag_enabled?).and_return(true)
+        allow(derived_data).to receive(:executions).and_return([execution0, execution1])
+        [execution0, execution1].each do |execution|
+          allow(execution).to receive(:invalid?).and_return(false)
+          allow(execution).to receive(:location).and_return(location)
+        end
+      end
+
+      context 'with slow execution' do
+        let(:time0) { 49.9 }
+        let(:time1) { 50 }
+        it 'asserts warning' do
+          @xcprofiler.report(product_name)
+          expect(@dangerfile).to have_received(:warn).with('`doSomething()` takes 50.0 ms to build',
+                                                           file: 'path/to/Source.swift',
+                                                           line: 20)
+        end
+      end
+
+      context 'with very slow execution' do
+        let(:time0) { 99.9 }
+        let(:time1) { 100 }
+        it 'asserts failure' do
+          @xcprofiler.report(product_name)
+          expect(@dangerfile).to have_received(:fail).with('`doSomething()` takes 100.0 ms to build',
+                                                           file: 'path/to/Source.swift',
+                                                           line: 20)
+        end
+      end
+
+      context 'with threshold' do
+        before do
+          @xcprofiler.thresholds = {
+            warn: 10,
+            fail: 20
+          }
+        end
+
+        context 'with slow execution' do
+          let(:time0) { 100 }
+          let(:time1) { 10 }
+          it 'asserts warning' do
+            @xcprofiler.report(product_name)
+            expect(@dangerfile).to have_received(:warn).with('`doSomething()` takes 10.0 ms to build',
+                                                             file: 'path/to/Source.swift',
+                                                             line: 20)
+          end
+        end
+
+        context 'with very slow execution' do
+          let(:time0) { 9.9 }
+          let(:time1) { 20 }
+          it 'asserts failure' do
+            @xcprofiler.report(product_name)
+            expect(@dangerfile).to have_received(:fail).with('`doSomething()` takes 20.0 ms to build',
+                                                             file: 'path/to/Source.swift',
+                                                             line: 20)
+          end
+        end
+      end
+
+      context 'with inline_mode = false' do
+        before do
+          @xcprofiler.inline_mode = false
+        end
+
+        context 'with slow execution' do
+          let(:time0) { 49.9 }
+          let(:time1) { 50 }
+          it 'asserts warning' do
+            @xcprofiler.report(product_name)
+            expect(@dangerfile).to have_received(:warn).with('`doSomething()` takes 50.0 ms to build', {})
+          end
+        end
+
+        context 'with very slow execution' do
+          let(:time0) { 99.9 }
+          let(:time1) { 100 }
+          it 'asserts failure' do
+            @xcprofiler.report(product_name)
+            expect(@dangerfile).to have_received(:fail).with('`doSomething()` takes 100.0 ms to build', {})
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: danger-xcprofiler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- giginet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xcprofiler
+  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: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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'
+- !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: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: danger plugin for asserting Swift compilation time.
+email:
+- giginet.net@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/warning.png
+- danger-xcprofiler.gemspec
+- lib/danger_plugin.rb
+- lib/danger_xcprofiler.rb
+- lib/xcprofiler/danger_reporter.rb
+- lib/xcprofiler/gem_version.rb
+- lib/xcprofiler/plugin.rb
+- spec/spec_helper.rb
+- spec/xcprofiler_spec.rb
+homepage: https://github.com/giginet/danger-xcprofiler
+licenses:
+- MIT
+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.2
+signing_key: 
+specification_version: 4
+summary: danger plugin for asserting Swift compilation time.
+test_files:
+- spec/spec_helper.rb
+- spec/xcprofiler_spec.rb