danger-xcprofiler 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 58787f96f3db5f505748ca1532c89bc7686fc084
-  data.tar.gz: fbe9fd4ef7f9e6e970b2a4ac2e86af6ae8639967
+SHA256:
+  metadata.gz: ffb92acc3f723fffe36d95a54d3e39d743c2ac24425e7cf4468992535c353ede
+  data.tar.gz: 236ecd6d8f3af89039d22a608b8ce261669e6cfd5dc7f27a0387ef6ce17d1f93
 SHA512:
-  metadata.gz: 17e3d2e656fac5bb7ae49c74ac8a51427f71abf96a4cee082c7e1515c40dab02aa284d37bcd6ab85949e652d19d2b8803af09b109f72b2608b7411e0cb2328d3
-  data.tar.gz: ee1878fb82f7845d4540d3661d199e62f1735b25d0f730e291a2ead922f7f7846e41769777b6e5b9b3f2ef4b9d6710a752b2caac3ac94ad8feed195042279e0b
+  metadata.gz: c77695577fb7b5a8c527bada81931274cd86da2d213ce350078ea2b64935711b95e0d2039a0e2bbce5efc087b39e4b998ef991ef7da5de559b812c9bf72f2c3e
+  data.tar.gz: 99efe20d66d9ee8a2529f00ef436afe8dd7514b8456c6bd25b20fa9467d263408558c0020a7896402900ae07568b046597cc5c06acb3ae3b9a2f07b0b68c637b

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: |
+        bundle exec rake
+        bundle exec rubocop

data/.rubocop.yml

@@ -1,3 +1,9 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Metrics/ModuleLength:
+  Max: 120
+
 Metrics/MethodLength:
   Enabled: false
 
@@ -11,4 +17,17 @@ Metrics/BlockLength:
 Style/Documentation:
   Enabled: false
 
+Metrics/AbcSize:
+  Max: 25
+
+Lint/DuplicateMethods:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
 
+Metrics/CyclomaticComplexity:
+  Max: 10

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/README.md

@@ -1,6 +1,5 @@
 # danger-xcprofiler
-[![Build Status](https://travis-ci.org/giginet/danger-xcprofiler.svg?branch=master)](https://travis-ci.org/giginet/danger-xcprofiler)
-[![Coverage Status](https://coveralls.io/repos/github/giginet/danger-xcprofiler/badge.svg?branch=master)](https://coveralls.io/github/giginet/danger-xcprofiler?branch=master)
+![GitHub Action](https://github.com/giginet/danger-xcprofiler/actions/workflows/ruby.yml/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/danger-xcprofiler.svg)](https://badge.fury.io/rb/danger-xcprofiler)
 
 [danger](https://github.com/danger/danger) plugin for asserting Swift compilation time.
@@ -25,6 +24,12 @@ Just add this line to your Dangerfile:
 xcprofiler.report 'MyApp'
 ```
 
+Or specify an xcactivitylog path
+```ruby
+logDir = Dir[File.join('DerivedData/Logs/Build/', '*.xcactivitylog')].first
+xcprofiler.report nil, nil, logDir
+```
+
 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. 

data/danger-xcprofiler.gemspec

@@ -1,8 +1,6 @@
-# coding: utf-8
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'xcprofiler/gem_version.rb'
+require 'xcprofiler/gem_version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'danger-xcprofiler'
@@ -19,22 +17,21 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.6'
+
   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'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
 
   # Testing support
-  spec.add_development_dependency 'rspec', '~> 3.4'
-
-  # Calculating code coverage
-  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rspec'
 
   # Linting code and docs
-  spec.add_development_dependency 'rubocop', '~> 0.41'
-  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'yard'
 
   # Makes testing easy via `bundle exec guard`
   spec.add_development_dependency 'guard', '~> 2.14'

data/lib/xcprofiler/danger_reporter.rb

@@ -3,22 +3,33 @@ require 'pathname'
 
 module Danger
   class DangerReporter < Xcprofiler::AbstractReporter
-    def initialize(dangerfile, thresholds, inline_mode, working_dir)
+    def initialize(dangerfile, thresholds, inline_mode, working_dir, ignored_files)
       super({})
       @dangerfile = dangerfile
       @thresholds = thresholds
       @inline_mode = inline_mode
       @working_dir = working_dir
+      @ignored_files = ignored_files
     end
 
     def report!(executions)
+      executions.reject! { |execution| ignored_files.any? { |pattern| File.fnmatch(pattern, execution.path) } }
+
+      if @inline_mode
+        inline_report(executions)
+      else
+        markdown_report(executions)
+      end
+    end
+
+    private
+
+    def inline_report(executions)
       executions.each do |execution|
         options = {}
-        if @inline_mode
-          options[:file] = relative_path(execution.path)
-          options[:line] = execution.line
-        end
-        message = message(execution)
+        options[:file] = relative_path(execution.path)
+        options[:line] = execution.line
+        message = "`#{execution.method_name}` takes #{execution.time} ms to build"
 
         if execution.time >= @thresholds[:fail]
           @dangerfile.fail(message, options)
@@ -28,17 +39,42 @@ module Danger
       end
     end
 
-    private
+    def markdown_report(executions)
+      warning_executions = executions.select do |e|
+        e.time >= @thresholds[:warn] && e.time < @thresholds[:fail]
+      end
+      error_executions = executions.select do |e|
+        e.time >= @thresholds[:fail]
+      end
 
-    def message(execution)
-      message = "`#{execution.method_name}` takes #{execution.time} ms to build"
-      return message if @inline_mode
-      "[#{execution.filename}] #{message}"
+      return if warning_executions.empty? && error_executions.empty?
+
+      message = "### Xcprofiler found issues\n\n"
+      message << markdown_issues(warning_executions, 'Warnings') unless warning_executions.empty?
+      message << markdown_issues(error_executions, 'Errors') unless error_executions.empty?
+      @dangerfile.markdown(message, {})
     end
 
     def relative_path(path)
       working_dir = Pathname.new(@working_dir)
       Pathname.new(path).relative_path_from(working_dir).to_s
     end
+
+    def markdown_issues(executions, heading)
+      message = "#### #{heading}\n\n"
+
+      message << "| File | Line | Method Name | Build Time (ms) |\n"
+      message << "| ---- | ---- | ----------- | --------------- |\n"
+
+      executions.each do |e|
+        message << "| #{e.filename} | #{e.line} | #{e.method_name} | #{e.time} |\n"
+      end
+
+      message
+    end
+
+    def ignored_files
+      [@ignored_files].flatten.compact
+    end
   end
 end

data/lib/xcprofiler/gem_version.rb

@@ -1,3 +1,3 @@
 module DangerXcprofiler
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/lib/xcprofiler/plugin.rb

@@ -12,6 +12,10 @@ module Danger
   #          xcprofiler.thresholds = { warn: 100, fail: 500 }
   #          xcprofiler.report 'MyApp'
   #
+  # @example Specify a custom DerivedData directory
+  #
+  #          xcprofiler.report 'MyApp' './DerivedData'
+  #
   # @see  giginet/danger-xcprofiler
   # @tags xcode, ios, danger
   class DangerXcprofiler < Plugin
@@ -33,13 +37,28 @@ module Danger
     # @return   [Boolean]
     attr_accessor :inline_mode
 
+    # A globbed string or array of strings which should match the files
+    # that you want to ignore warnings on. Defaults to nil.
+    # An example would be `'**/Pods/**'` to ignore warnings in Pods that your project uses.
+    #
+    # @param    [String or [String]] value
+    # @return   [[String]]
+    attr_accessor :ignored_files
+
     # Search the latest .xcactivitylog by the passing product_name and profile compilation time
     # @param    [String] product_name Product name for the target project.
+    # @param    [String] derived_data_path Path to the directory containing the DerivedData.
+    # @param    [String] log_path Path to the xcactivitylog to process.
     # @return   [void]
-    def report(product_name)
-      profiler = Xcprofiler::Profiler.by_product_name(product_name)
+    def report(product_name, derived_data_path = nil, log_path = nil)
+      profiler = if log_path&.end_with?('.xcactivitylog')
+                   Xcprofiler::Profiler.by_path(log_path)
+                 else
+                   Xcprofiler::Profiler.by_product_name(product_name, derived_data_path)
+                 end
+
       profiler.reporters = [
-        DangerReporter.new(@dangerfile, thresholds, inline_mode, working_dir)
+        DangerReporter.new(@dangerfile, thresholds, inline_mode, working_dir, ignored_files)
       ]
       profiler.report!
     rescue Xcprofiler::DerivedDataNotFound, Xcprofiler::BuildFlagIsNotEnabled => e
@@ -57,8 +76,9 @@ module Danger
     end
 
     def inline_mode
-      return false if @inline_mode.nil? == false
-      true
+      return true if @inline_mode.nil?
+
+      !!@inline_mode
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,10 +1,7 @@
-require 'coveralls'
-Coveralls.wear!
-
 require 'pathname'
-ROOT = Pathname.new(File.expand_path('../../', __FILE__))
-$LOAD_PATH.unshift((ROOT + 'lib').to_s)
-$LOAD_PATH.unshift((ROOT + 'spec').to_s)
+ROOT = Pathname.new(File.expand_path('..', __dir__))
+$LOAD_PATH.unshift("#{ROOT}lib".to_s)
+$LOAD_PATH.unshift("#{ROOT}spec".to_s)
 
 require 'bundler/setup'
 require 'pry'

data/spec/xcprofiler_spec.rb

@@ -1,6 +1,7 @@
-require File.expand_path('../spec_helper', __FILE__)
+require File.expand_path('spec_helper', __dir__)
 require 'xcprofiler'
 
+# rubocop:disable Metrics/ModuleLength
 module Danger
   describe Danger::DangerXcprofiler do
     it 'should be a plugin' do
@@ -24,7 +25,8 @@ module Danger
         @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(@dangerfile).to receive(:markdown)
+        allow(Xcprofiler::Profiler).to receive(:by_product_name).with(product_name, nil).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|
@@ -33,6 +35,25 @@ module Danger
         end
       end
 
+      context 'with ignored files' do
+        let(:time0) { 49.9 }
+        let(:time1) { 50 }
+        it 'skips matching warning' do
+          @xcprofiler.ignored_files = ['path/**']
+          @xcprofiler.report(product_name)
+          expect(@dangerfile).to_not have_received(:warn).with('`doSomething()` takes 50.0 ms to build',
+                                                               file: 'path/to/Source.swift',
+                                                               line: 20)
+        end
+        it 'includes non-matching warning' do
+          @xcprofiler.ignored_files = ['other/path/**']
+          @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 slow execution' do
         let(:time0) { 49.9 }
         let(:time1) { 50 }
@@ -92,21 +113,30 @@ module Danger
         context 'with slow execution' do
           let(:time0) { 49.9 }
           let(:time1) { 50 }
+          message = "### Xcprofiler found issues\n\n"
+          message << "#### Warnings\n\n"
+          message << "| File | Line | Method Name | Build Time (ms) |\n"
+          message << "| ---- | ---- | ----------- | --------------- |\n"
+          message << "| Source.swift | 20 | doSomething() | 50.0 |\n"
           it 'asserts warning' do
             @xcprofiler.report(product_name)
-            expect(@dangerfile).to have_received(:warn)
-              .with('[Source.swift] `doSomething()` takes 50.0 ms to build', {})
+            expect(@dangerfile).to have_received(:markdown).with(message, {})
           end
         end
 
         context 'with very slow execution' do
+          message = "### Xcprofiler found issues\n\n"
+          message << "#### Errors\n\n"
+          message << "| File | Line | Method Name | Build Time (ms) |\n"
+          message << "| ---- | ---- | ----------- | --------------- |\n"
+          message << "| Source.swift | 20 | doSomething() | 100.0 |\n"
           it 'asserts failure' do
             @xcprofiler.report(product_name)
-            expect(@dangerfile).to have_received(:fail)
-              .with('[Source.swift] `doSomething()` takes 100.0 ms to build', {})
+            expect(@dangerfile).to have_received(:markdown).with(message, {})
           end
         end
       end
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-xcprofiler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - giginet
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-11 00:00:00.000000000 Z
+date: 2021-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xcprofiler
@@ -42,46 +42,32 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '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: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -98,30 +84,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.41'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.41'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -185,10 +171,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-version"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -207,7 +193,7 @@ homepage: https://github.com/giginet/danger-xcprofiler
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -215,16 +201,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: danger plugin for asserting Swift compilation time.
 test_files:

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.travis.yml

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