danger-xcode_warnings 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bee619f39b0fd91e1cec3b021d23d79d5bdfca95272ed1625695e0f713057587
-  data.tar.gz: 5ec6b7d4429620ecfee75a8cd02225f47551f453d87e263555263fe2a966c4a2
+  metadata.gz: 2f94dacd6aee8f4012677af4107ea3fb65cd9317bdc437d130a579a334e33eef
+  data.tar.gz: f2f701e8545958f3e0b5dc65612b6d7944eee1c936089d70919cbfd0d6c5627c
 SHA512:
-  metadata.gz: df7ef828a16ffbd853fff8bece28ddb304851279d063b6c5077aa674fa275def8fec8f10ddb73688ebc51d7e084a76ea21ac90a9a2f72eb004f2c312c54d74f6
-  data.tar.gz: 2db67e9ebd809bd986899c0b50cec34e3b690ff503d51b53f87ea94844e2ee282ac358d5c8557ccd84f3db831113dd216a1d98ab7a76898744f1a0950f8fc98c
+  metadata.gz: 3366a501dd6cb01111c1a8aecb5d0353b181c45721a0c6f776253e3aafce2323ceb65ffbb9dbceee314a9cf660357e528e80b87b3ebbe3ba5a2e9fcb018e84f5
+  data.tar.gz: 6e21b5cb8dc22eefeb2f52d0b41d5aedf65488e02d31123d47fef2bddb4e89d1b196de48febccac6b388a7e15176ccd7f868211eaeeb3a9914b0b6c3fe9b2498

data/.travis.yml

@@ -5,8 +5,8 @@ cache:
 
 rvm:
   - 2.3.1
-  - 2.4.1
-  - 2.5.1
+  - 2.4.5
+  - 2.5.3
 
 branches:
   only:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-xcode_warnings (0.1.2)
+    danger-xcode_warnings (0.2.0)
       danger-plugin-api (~> 1.0)
 
 GEM
@@ -19,7 +19,7 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (6.0.9)
+    danger (6.1.0)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)

data/README.md

@@ -1,38 +1,101 @@
 # danger-xcode_warnings
 
-[![version](https://img.shields.io/badge/version-0.1.0-blue.svg)](https://github.com/Scior/Linna)
+[![version](https://img.shields.io/badge/version-0.2.0-blue.svg)](https://github.com/Scior/danger-xcode_warnings)
 [![Build Status](https://travis-ci.org/Scior/danger-xcode_warnings.svg?branch=master)](https://travis-ci.org/Scior/danger-xcode_warnings)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-A Danger plugin to show warnings from xcodebuild.
+A Danger plugin to format and show warnings from xcodebuild.
+
+![Sample](doc/sample.png)
+
+## Features
+
+- Extract the compiler and linker warnings from the build log and format them for Danger
+  - Both `xcodebuild` and `xcpretty` format are supported
+- Gather the build timing summary and show
 
 ## Installation
 
 ```sh
-gem install specific_install
-gem specific_install git@github.com:Scior/danger-xcode_warnings.git
+gem install danger-xcode_warnings
 ```
 
 Or using Bundler,
 
 ```ruby
-gem 'danger-xcode_warnings', :git => 'https://github.com/Scior/danger-xcode_warnings.git'
+gem 'danger-xcode_warnings'
 ```
 
 ## Usage
 
-Simply collect the log from `xcodebuild`,
+### With xcodebuild
+
+Firstly, collect the log from `xcodebuild`.
+
+```sh
+xcodebuild clean build -workspace ... > build.log
+# If you want to show the log with xcpretty
+xcodebuild clean build -workspace ... | tee build.log | xcpretty
+```
+
+And then, call `analyze_file` method in your `Dangerfile` to analyze the build log,
+
+```ruby
+xcode_warnings.analyze_file 'build.log'
+```
+
+with some shell scripts with your CI, like:
+
+```sh
+bundle install
+bundle exec danger
+```
+
+### With xcpretty
+
+If you want to analyze the xcpretty log, you MUST set the `use_xcpretty` flag in your `Dangerfile`:
+
+```ruby
+xcode_warnings.use_xcpretty = true
+xcode_warnings.analyze_file 'build.log'
+```
+
+Your build script for CI should be like,
 
 ```sh
-xcodebuild clean build >> buildlog.log
+xcodebuild clean build -workspace ... | xcpretty > build.log
 ```
 
-and analyze on your `Dangerfile`.
+### Show linker warnings
+
+To show linker warnings, set the `show_linker_warnings` to `true` before analyzing the log:
 
 ```ruby
-xcode_warnings.analyze_file 'buildlog.log'
+xcode_warnings.show_linker_warnings = true
+xcode_warnings.analyze_file 'build.log'
 ```
 
+### Gathering build timing sumamry
+
+To gather the build timing summary, you have to add `-showBuildTimingSummary` option to your build script:
+
+```sh
+xcodebuild clean build -workspace ... -showBuildTimingSummary > build.log
+```
+
+Then, set the `build_timing_summary` flag to `true`.
+
+```ruby
+xcode_warnings.build_timing_summary = true
+xcode_warnings.analyze_file 'build.log'
+```
+
+### See also
+
+`RubyDoc` for this plugin is here:
+
+- <https://www.rubydoc.info/gems/danger-xcode_warnings>
+
 ## Development
 
 1. Clone this repo

data/lib/xcode_warnings/gem_version.rb

@@ -1,3 +1,3 @@
 module XcodeWarnings
-  VERSION = "0.1.2".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/xcode_warnings/log_parser.rb

@@ -1,5 +1,5 @@
 #
-# Parser for the xcodebuild log.
+# Parser class for the xcodebuild log.
 #
 class LogParser
   # The keyword for detecing warnings.
@@ -20,7 +20,7 @@ class LogParser
   # @return [void]
   attr_accessor :show_build_timing_summary
 
-  # Parses the log text into array of Warnings.
+  # Parses the log text into an array of Warnings.
   #
   # @param [String] text The text to parse.
   # @return [Array] Array of `Warning`.
@@ -39,10 +39,17 @@ class LogParser
     return nil unless @show_build_timing_summary
 
     lines = text.lines.map!(&:chomp)
-    index = lines.index("Build Timing Summary")
+    index = lines.reverse.index("Build Timing Summary")
     return nil if index.nil?
 
-    lines[index + 1..-1].select { |s| s =~ /.+/ }.join("\n")
+    build_times = lines[-index..-1]
+      .select { |s| s =~ /.+/ }
+      .reject { |s| s.include?("*") }
+    total_time = build_times
+      .map { |s| s.split(" | ")[1].split[0].to_f }
+      .inject(:+)
+
+    "#{build_times.join("\n")}\nTotal Build Time: **#{total_time}s**"
   end
 
   private

data/lib/xcode_warnings/log_parser_xcpretty.rb

@@ -0,0 +1,71 @@
+#
+# Parser class for the xcpretty log.
+#
+class LogParserXCPretty
+  # The keyword for detecing warnings.
+  KEYWORD_WARNING = "\u26A0".freeze
+
+  # Struct represents warnings.
+  Warning = Struct.new(:file, :line, :message)
+
+  # Whether show build warnings or not.
+  # @return [void]
+  attr_accessor :show_build_warnings
+
+  # Whether show linker warnings or not.
+  # @return [void]
+  attr_accessor :show_linker_warnings
+
+  # Parses the log text into an array of Warnings.
+  #
+  # @param [String] text The text to parse.
+  # @return [Array] Array of `Warning`.
+  #
+  def parse_warnings(text)
+    warning_texts = text.each_line.select { |s| s.include?(KEYWORD_WARNING) }.uniq
+    warning_texts.map! { |s| parse_warning_text(s) }.compact
+  end
+
+  # Parses the log text into a build timing summary message.
+  #
+  # @param [String] text The text to parse.
+  # @return [String] Message of build timing summary.
+  #
+  def parse_build_timing_summary(text)
+    return nil unless @show_build_timing_summary
+
+    lines = text.lines.map!(&:chomp)
+    index = lines.reverse.index("Build Timing Summary")
+    return nil if index.nil?
+
+    build_times = lines[-index..-1]
+      .select { |s| s =~ /.+/ }
+      .reject { |s| s.include?("*") }
+    total_time = build_times
+      .map { |s| s.split(" | ")[1].split[0].to_f }
+      .inject(:+)
+
+    "#{build_times.join("\n")}\nTotal Build Time: **#{total_time}s**"
+  end
+
+  private
+
+  def parse_warning_text(text)
+    puts text
+    position, message = text.split(" ", 3).slice(1, 2)
+    if position.start_with?("ld")
+      # Linker warning
+      return nil unless @show_linker_warnings
+
+      return Warning.new(nil, nil, message.chomp)
+    end
+
+    # Build warnings
+    return nil unless @show_build_warnings
+
+    path, line, _column = position.split(":")
+    return nil if path.nil?
+
+    Warning.new(path.gsub("#{Dir.pwd}/", ""), line, message.chomp)
+  end
+end

data/lib/xcode_warnings/plugin.rb

@@ -1,4 +1,5 @@
 require_relative "./log_parser"
+require_relative "./log_parser_xcpretty"
 require_relative "./message_formatter"
 
 module Danger
@@ -14,15 +15,20 @@ module Danger
     # @return [void]
     attr_accessor :show_build_warnings
 
-    # Whether show linker warnings or not.
+    # Whether show linker warnings or not. The default value is `false`.
     # @return [void]
     attr_accessor :show_linker_warnings
 
-    # Whether show build timing summary or not.
+    # Whether show build timing summary or not. The default value is `false`.
     # @return [void]
     attr_accessor :show_build_timing_summary
 
+    # Whether use xcpretty for formatting logs. The default value is `false`.
+    # @return [void]
+    attr_accessor :use_xcpretty
+
     # rubocop:disable Lint/DuplicateMethods
+
     def show_build_warnings
       @show_build_warnings.nil? ? true : @show_build_warnings
     end
@@ -34,6 +40,10 @@ module Danger
     def show_build_timing_summary
       @show_build_timing_summary || false
     end
+
+    def use_xcpretty
+      @use_xcpretty || false
+    end
     # rubocop:enable Lint/DuplicateMethods
 
     # Parses the log text from xcodebuild and show warnings.
@@ -44,10 +54,14 @@ module Danger
     # @return [void]
     #
     def analyze(log_text, inline: false, sticky: true)
-      parser = LogParser.new
+      if use_xcpretty
+        parser = LogParserXCPretty.new
+      else
+        parser = LogParser.new
+        parser.show_build_timing_summary = show_build_timing_summary
+      end
       parser.show_build_warnings = show_build_warnings
       parser.show_linker_warnings = show_linker_warnings
-      parser.show_build_timing_summary = show_build_timing_summary
 
       parsed = parser.parse_warnings(log_text)
       parsed.each do |warning|

data/spec/fixtures/log_with_build_timing_summary

@@ -27,3 +27,6 @@ CompileSwiftSources (1 task) | 2.000 seconds
 Ld (1 task) | 0.000 seconds
 
 LinkStoryboards (1 task) | 0.000 seconds
+
+** BUILD SUCCEEDED **
+

data/spec/fixtures/log_xcpretty

@@ -0,0 +1,6 @@
+
+▸ Compiling UIColor+.swift
+⚠️  /Users/fujino/iOS/ColorStock/ColorStock/Utility/Extension/UIColor+.swift:13:17: initializer 'init(r:g:b:)' took 177ms to type-check (limit: 100ms)
+▸ Linking RxDataSources
+▸ Linking NotificationService
+⚠️  ld: linking against a dylib which is not safe for use in application extensions: /hoge

data/spec/xcode_warnings_spec.rb

@@ -1,81 +1,151 @@
 require File.expand_path("spec_helper", __dir__)
 
+# rubocop:disable Metrics/ModuleLength
 module Danger
   describe Danger::DangerXcodeWarnings do
     it "should be a plugin" do
       expect(Danger::DangerXcodeWarnings.new(nil)).to be_a Danger::Plugin
     end
 
-    #
-    # You should test your custom attributes and methods here
-    #
     describe "with Dangerfile" do
       before do
         @dangerfile = testing_dangerfile
         @xcode_warnings = @dangerfile.xcode_warnings
       end
 
-      it "Warns 3 lines with default settings" do
-        @xcode_warnings.analyze_file "spec/fixtures/log_with_4_errors"
-
-        expect(@dangerfile.status_report[:warnings]).to eq [
-          "**/Users/fujino/iOS/ColorStock/ColorStock/Utility/Extension/UIColor+.swift#L13** initializer 'init(r:g:b:)' took 177ms to type-check (limit: 100ms)",
-          "**/Users/fujino/iOS/ColorStock/ColorStock/Presentation/ViewModel/Implementation/ColorSelectorViewModel.swift#L75** instance method 'makeFlowLayout(with:)' took 104ms to type-check (limit: 100ms)",
-          "**/Users/fujino/iOS/ColorStock/ColorStock/Data/Entity/Color.swift#L22** variable 'hoge' was never used; consider replacing with '_' or removing it"
-        ]
-        expect(@dangerfile.status_report[:messages]).to eq [
-          "Detected 3 build-time warnings."
-        ]
+      context "with default settings" do
+        before do
+          @xcode_warnings.analyze_file "spec/fixtures/log_with_4_errors"
+        end
+
+        it "warn 3 lines" do
+          expect(@dangerfile.status_report[:warnings]).to eq [
+            "**/Users/fujino/iOS/ColorStock/ColorStock/Utility/Extension/UIColor+.swift#L13** initializer 'init(r:g:b:)' took 177ms to type-check (limit: 100ms)",
+            "**/Users/fujino/iOS/ColorStock/ColorStock/Presentation/ViewModel/Implementation/ColorSelectorViewModel.swift#L75** instance method 'makeFlowLayout(with:)' took 104ms to type-check (limit: 100ms)",
+            "**/Users/fujino/iOS/ColorStock/ColorStock/Data/Entity/Color.swift#L22** variable 'hoge' was never used; consider replacing with '_' or removing it"
+          ]
+        end
+        it "put a single message" do
+          expect(@dangerfile.status_report[:messages]).to eq [
+            "Detected 3 build-time warnings."
+          ]
+        end
       end
 
-      it "Warns 4 lines with all settings enabled" do
-        @xcode_warnings.show_build_warnings = true
-        @xcode_warnings.show_linker_warnings = true
-        @xcode_warnings.analyze_file "spec/fixtures/log_with_4_errors"
-
-        expect(@dangerfile.status_report[:warnings]).to eq [
-          "linking against a dylib which is not safe for use in application extensions: /hoge",
-          "**/Users/fujino/iOS/ColorStock/ColorStock/Utility/Extension/UIColor+.swift#L13** initializer 'init(r:g:b:)' took 177ms to type-check (limit: 100ms)",
-          "**/Users/fujino/iOS/ColorStock/ColorStock/Presentation/ViewModel/Implementation/ColorSelectorViewModel.swift#L75** instance method 'makeFlowLayout(with:)' took 104ms to type-check (limit: 100ms)",
-          "**/Users/fujino/iOS/ColorStock/ColorStock/Data/Entity/Color.swift#L22** variable 'hoge' was never used; consider replacing with '_' or removing it"
-        ]
-        expect(@dangerfile.status_report[:messages]).to eq [
-          "Detected 4 build-time warnings."
-        ]
+      context "enable showing build and linker warnings" do
+        before do
+          @xcode_warnings.show_build_warnings = true
+          @xcode_warnings.show_linker_warnings = true
+          @xcode_warnings.analyze_file "spec/fixtures/log_with_4_errors"
+        end
+
+        it "warn 4 lines" do
+          expect(@dangerfile.status_report[:warnings]).to eq [
+            "linking against a dylib which is not safe for use in application extensions: /hoge",
+            "**/Users/fujino/iOS/ColorStock/ColorStock/Utility/Extension/UIColor+.swift#L13** initializer 'init(r:g:b:)' took 177ms to type-check (limit: 100ms)",
+            "**/Users/fujino/iOS/ColorStock/ColorStock/Presentation/ViewModel/Implementation/ColorSelectorViewModel.swift#L75** instance method 'makeFlowLayout(with:)' took 104ms to type-check (limit: 100ms)",
+            "**/Users/fujino/iOS/ColorStock/ColorStock/Data/Entity/Color.swift#L22** variable 'hoge' was never used; consider replacing with '_' or removing it"
+          ]
+        end
+        it "put a single message" do
+          expect(@dangerfile.status_report[:messages]).to eq [
+            "Detected 4 build-time warnings."
+          ]
+        end
       end
 
-      it "Doesn't warn lines with all settings disabled" do
-        @xcode_warnings.show_build_warnings = false
-        @xcode_warnings.show_linker_warnings = false
-        @xcode_warnings.analyze_file "spec/fixtures/log_with_4_errors"
+      context "disable all settings" do
+        before do
+          @xcode_warnings.show_build_warnings = false
+          @xcode_warnings.show_linker_warnings = false
+          @xcode_warnings.analyze_file "spec/fixtures/log_with_4_errors"
+        end
 
-        expect(@dangerfile.status_report[:warnings]).to eq []
-        expect(@dangerfile.status_report[:messages]).to eq []
+        it "show no warnings" do
+          expect(@dangerfile.status_report[:warnings]).to eq []
+        end
+        it "show no messages" do
+          expect(@dangerfile.status_report[:messages]).to eq []
+        end
       end
 
-      it "Show build timing summary" do
-        @xcode_warnings.show_build_timing_summary = true
-        @xcode_warnings.analyze_file "spec/fixtures/log_with_build_timing_summary"
-
-        expect(@dangerfile.status_report[:warnings]).to eq []
-        expect(@dangerfile.status_report[:messages]).to eq [
-          "CompileStoryboard (2 tasks) | 10.000 seconds\n" \
-          "CompileSwiftSources (1 task) | 2.000 seconds\n" \
-          "Ld (1 task) | 0.000 seconds\n" \
-          "LinkStoryboards (1 task) | 0.000 seconds"
-        ]
+      context "enable showing build timing summary" do
+        before do
+          @xcode_warnings.show_build_timing_summary = true
+          @xcode_warnings.analyze_file "spec/fixtures/log_with_build_timing_summary"
+        end
+
+        it "show no warnings" do
+          expect(@dangerfile.status_report[:warnings]).to eq []
+        end
+        it "show build timing summary" do
+          expect(@dangerfile.status_report[:messages]).to eq [
+            "CompileStoryboard (2 tasks) | 10.000 seconds\n" \
+            "CompileSwiftSources (1 task) | 2.000 seconds\n" \
+            "Ld (1 task) | 0.000 seconds\n" \
+            "LinkStoryboards (1 task) | 0.000 seconds\n" \
+            "Total Build Time: **12.0s**"
+          ]
+        end
       end
 
-      it "Doesn't warn with the clean build log" do
-        @xcode_warnings.analyze_file "spec/fixtures/log_without_error"
+      context "with the clean build log" do
+        before do
+          @xcode_warnings.analyze_file "spec/fixtures/log_without_error"
+        end
+
+        it "show no warnings" do
+          expect(@dangerfile.status_report[:warnings]).to eq []
+        end
+        it "show no messages" do
+          expect(@dangerfile.status_report[:messages]).to eq []
+        end
+      end
 
-        expect(@dangerfile.status_report[:warnings]).to eq []
-        expect(@dangerfile.status_report[:messages]).to eq []
+      context "file not found" do
+        it "do nothing" do
+          @xcode_warnings.analyze_file "spec/fixtures/hoge"
+        end
       end
 
-      it "Couldn't find the file" do
-        @xcode_warnings.analyze_file "spec/fixtures/hoge"
+      context "use xcpretty log with default settings" do
+        before do
+          @xcode_warnings.use_xcpretty = true
+          @xcode_warnings.analyze_file "spec/fixtures/log_xcpretty"
+        end
+
+        it "warn 2 lines" do
+          expect(@dangerfile.status_report[:warnings]).to eq [
+            "**/Users/fujino/iOS/ColorStock/ColorStock/Utility/Extension/UIColor+.swift#L13** initializer 'init(r:g:b:)' took 177ms to type-check (limit: 100ms)"
+          ]
+        end
+        it "put a single message" do
+          expect(@dangerfile.status_report[:messages]).to eq [
+            "Detected 1 build-time warnings."
+          ]
+        end
+      end
+
+      context "use xcpretty log and enable linker warnings" do
+        before do
+          @xcode_warnings.use_xcpretty = true
+          @xcode_warnings.show_linker_warnings = true
+          @xcode_warnings.analyze_file "spec/fixtures/log_xcpretty"
+        end
+
+        it "warn 2 lines" do
+          expect(@dangerfile.status_report[:warnings]).to eq [
+            "**/Users/fujino/iOS/ColorStock/ColorStock/Utility/Extension/UIColor+.swift#L13** initializer 'init(r:g:b:)' took 177ms to type-check (limit: 100ms)",
+            "linking against a dylib which is not safe for use in application extensions: /hoge"
+          ]
+        end
+        it "put 2 messages" do
+          expect(@dangerfile.status_report[:messages]).to eq [
+            "Detected 2 build-time warnings."
+          ]
+        end
       end
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-xcode_warnings
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Scior
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2019-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -168,15 +168,18 @@ files:
 - README.md
 - Rakefile
 - danger-xcode_warnings.gemspec
+- doc/sample.png
 - lib/danger_plugin.rb
 - lib/danger_xcode_warnings.rb
 - lib/xcode_warnings/gem_version.rb
 - lib/xcode_warnings/log_parser.rb
+- lib/xcode_warnings/log_parser_xcpretty.rb
 - lib/xcode_warnings/message_formatter.rb
 - lib/xcode_warnings/plugin.rb
 - spec/fixtures/log_with_4_errors
 - spec/fixtures/log_with_build_timing_summary
 - spec/fixtures/log_without_error
+- spec/fixtures/log_xcpretty
 - spec/spec_helper.rb
 - spec/xcode_warnings_spec.rb
 homepage: https://github.com/Scior/danger-xcode_warnings
@@ -207,5 +210,6 @@ test_files:
 - spec/fixtures/log_with_4_errors
 - spec/fixtures/log_with_build_timing_summary
 - spec/fixtures/log_without_error
+- spec/fixtures/log_xcpretty
 - spec/spec_helper.rb
 - spec/xcode_warnings_spec.rb