danger-ikr-xcode_summary 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41a577e0180e6da6dfda10ba73ad60a971d8b057962652a30a80459781addb9d
+  data.tar.gz: b9733b8146591866849264d3dae64bd2329d5b079e4a0e68501e375a6d38fc3f
+SHA512:
+  metadata.gz: b11d9e601b7437f02bc8718a06ea158437c99d7de1db838394f431527f77609cf6f1430d668a68f78d4c7630c2c22a98f23bb7d40a07eb76ebf994c1a270ac37
+  data.tar.gz: cc1131f3bad8a88ff3257757fbaf750b3169c2b224001de2021e31f92ef9e37caeb96058e77f99e10174395568fd52362e56d8bfa24a8e226ab7670f86873130

data/.gitattributes

@@ -0,0 +1 @@
+*.xcresult binary

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+.idea/
+.yardoc

data/.rubocop.yml

@@ -0,0 +1,92 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# HoundCI doesn't like this rule
+Layout/DotPosition:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 320
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Layout/LineLength:
+  Max: 130
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+Metrics/ModuleLength:
+  Enabled: false
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+os: osx
+osx_image: xcode11
+
+rvm:
+  - 2.6.0
+  - 2.5.3
+
+# install bundler 2.x
+before_install:
+    - gem update --system
+    - gem install bundler
+
+script:
+    - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-xcode_summary.gemspec
+gemspec
+
+gem 'danger'
+gem 'rubocop'
+gem 'yard'

data/Gemfile.lock

@@ -0,0 +1,173 @@
+PATH
+  remote: .
+  specs:
+    danger-ikr-xcode_summary (1.2.0)
+      danger-plugin-api (~> 1.0)
+      xcresult (~> 0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    claide (1.1.0)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.3)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (8.6.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (>= 1, < 4)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.5.0)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    git (1.11.0)
+      rchardet (~> 1.8)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.22.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rchardet (1.8.0)
+    regexp_parser (2.3.1)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.28.2)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    xcresult (0.2.1)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 2.2.10)
+  danger
+  danger-ikr-xcode_summary!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (~> 3.0)
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.4)
+  rubocop
+  yard
+
+BUNDLED WITH
+   2.3.0

data/Guardfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# 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) 2016 Diogo Tridapalli <me@diogot.com> and Marcelo Fabri <me@marcelofabri.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,132 @@
+# danger-xcode_summary
+
+[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](LICENSE.txt)
+[![Gem Version](https://badge.fury.io/rb/danger-xcode_summary.svg)](https://badge.fury.io/rb/danger-xcode_summary)
+[![Build Status](https://travis-ci.org/diogot/danger-xcode_summary.svg?branch=master)](https://travis-ci.org/diogot/danger-xcode_summary)
+
+A [Danger](http://danger.systems) plugin that shows all build errors, warnings and unit tests results generated from `xcodebuild`.
+
+## How does it look?
+
+<table>
+  <thead>
+    <tr>
+      <th width="50"></th>
+      <th width="100%">
+          1 Error
+      </th>
+     </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><g-emoji alias="no_entry_sign" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f6ab.png">🚫</g-emoji></td>
+      <td>
+<strong>MyWeightTests.MyWeightTests</strong>: testError, failed - :w:  <br>  <a href="https://github.com/Invariante/MyWeight/blob/0101261efd67cd1fb0d682d88476fdee3d17cf86/MyWeightTests/MyWeightTests.swift#L26">MyWeightTests/MyWeightTests.swift#L26</a>
+</td>
+    </tr>
+  </tbody>
+</table>
+
+<table>
+  <thead>
+    <tr>
+      <th width="50"></th>
+      <th width="100%">
+          2 Warnings
+      </th>
+     </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><g-emoji alias="warning" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/26a0.png">⚠️</g-emoji></td>
+      <td>
+<strong><a href="https://github.com/Invariante/MyWeight/blob/0101261efd67cd1fb0d682d88476fdee3d17cf86/MyWeight/ViewController.swift#L35">MyWeight/ViewController.swift#L35</a></strong>: initialization of immutable value ‘bla’ was never used; consider replacing with assignment to ‘_’ or removing it  <br><code>
+        let bla = "unused variable"
+</code>
+</td>
+    </tr>
+    <tr>
+      <td><g-emoji alias="warning" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/26a0.png">⚠️</g-emoji></td>
+      <td>
+<strong><a href="https://github.com/Invariante/MyWeight/blob/0101261efd67cd1fb0d682d88476fdee3d17cf86/Bla.m#L32">Bla.m#L32</a></strong>: Value stored to ‘theme’ is never read  <br><code>
+            theme = *ptr++;
+</code>
+</td>
+    </tr>
+  </tbody>
+</table>
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'danger-xcode_summary'
+```
+
+## Usage
+
+Just add this line to your `Dangerfile`:
+
+```ruby
+xcode_summary.report 'MyApp.xcresult'
+```
+
+You need to pass the path of the `xcresult` generated after compiling your app.
+By default, this is inside the `DerivedData` for your project, but you can use the `-resultBundlePath`
+flag when calling `xcodebuild` to customize its path. You can read more about it in this [blog post from the folks at PSPDFKit](https://pspdfkit.com/blog/2021/deflaking-ci-tests-with-xcresults/#using-xcresult-bundles).
+
+You can also ignore warnings from certain files by setting `ignored_files`: 
+Warning: `ignored_files` patterns applied on relative paths.  
+
+```ruby
+# Ignoring warnings from Pods
+xcode_summary.ignored_files = 'Pods/**'
+
+# Ignoring specific warnings
+xcode_summary.ignored_results { |result|
+  result.message.include? 'ld' # Ignore ld_warnings
+}
+
+xcode_summary.report 'MyApp.xcresult'
+```
+
+You can use `ignores_warnings` to supress warnings and shows only errors.
+
+```ruby
+xcode_summary.ignores_warnings = true
+```
+
+You can use `inline_mode`.
+When this value is enabled, each warnings and errors are commented on each lines.
+
+```ruby
+# Comment on each lines
+xcode_summary.inline_mode = true
+xcode_summary.report 'MyApp.xcresult'
+```
+
+You can use `strict` to reporting errors as warnings thereby don't block merge PR.
+
+ ```ruby
+ # If value is `false`, then errors will be reporting as warnings
+ xcode_summary.strict = false
+ ```
+
+You can get warning and error number by calling `warning_error_count`. The return will be a JSON string contains warning and error count, e.g `{"warnings":1,"errors":3}`:
+
+```ruby
+result = xcode_summary.warning_error_count 'MyApp.xcresult'
+```
+
+## License
+
+danger-xcode_summary is released under the MIT license. See [LICENSE.txt](LICENSE.txt) for details.
+
+## 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,25 @@
+# frozen_string_literal: true
+
+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-xcode_summary.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xcode_summary/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-ikr-xcode_summary'
+  spec.version       = XcodeSummary::VERSION
+  spec.authors       = ['Diogo Tridapalli', 'Marcelo Fabri', 'Inder']
+  spec.email         = ['rathore619@gmail.com']
+  spec.description   = 'Show formatted xcodebuild output in your PRs.'
+  spec.summary       = 'A [Danger](http://danger.systems) plugin that shows all build errors, ' \
+                       'warnings and unit tests results generated from `xcodebuild`.'
+  spec.homepage      = 'https://github.com/InderKumarRathore/danger-xcode_summary'
+  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.required_ruby_version = ">= 2.4.0"
+
+  spec.add_dependency 'xcresult', '~> 0.2'
+  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '>= 2.2.10'
+  spec.add_development_dependency 'rake', '~> 13.0'
+
+  #  Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # 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'
+
+  # This gives you the chance to run a REPL inside your test
+  # via
+  #    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,3 @@
+# frozen_string_literal: true
+
+require 'xcode_summary/plugin'

data/lib/danger_xcode_summary.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'xcode_summary/gem_version'

data/lib/xcode_summary/gem_version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module XcodeSummary
+  VERSION = '1.2.0'
+end