xcpretty-pmd-formatter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf766e59bcf20f61efaa1adcae057abf3bde4334
+  data.tar.gz: 312cea82cc46907955ed4413c10698be8208ac74
+SHA512:
+  metadata.gz: fb5cabfa272bb56ef03b0041a73a8ee8be906b8cd0ae5ca949fdf415803d2ad0d5d0faede0d9d452eac13cc62c804fd77ce7719ea74e3a7e385075e4b1ad3e3d
+  data.tar.gz: 34abd32e125740c9b5f441a1705ed7209f3fc2d908abf2ec12d2bf488848498ca6a25f700c572eefd79b75041693d639236a5407a8dfc7405a693b6bc4cad199

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 szigetics
+
+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,48 @@
+# XCPretty PMD Formatter
+xcpretty custom formatter for parsing warnings and static analyzer issues easily from "xcodebuild ... clean build analyze" output
+
+[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](LICENSE.txt)
+
+Custom formatter for [xcpretty](https://github.com/supermarin/xcpretty) that saves on a PMD file all the errors, and warnings, so you can process them easily later.
+
+## Installation
+
+This formatter is distributed via RubyGems, and depends on a version of `xcpretty` >= 0.0.7 (when custom formatters were introduced). Run:
+
+gem install xcpretty-pmd-formatter
+
+## Usage
+
+Specify `xcpretty-pmd-formatter` as a custom formatter to `xcpretty`:
+
+```bash
+#!/bin/bash
+
+xcodebuild | xcpretty -f `xcpretty-pmd-formatter`
+```
+
+By default, `xcpretty-pmd-formatter` writes the result in `build/reports/errors.pmd`, but you can change that with an environment variable:
+
+```bash
+#!/bin/bash
+
+xcodebuild | XCPRETTY_PMD_FILE_OUTPUT=result.pmd xcpretty -f `xcpretty-pmd-formatter`
+```
+
+## Output format
+
+You can check some example PMDs in the [fixtures folder](spec/fixtures).
+
+## Thanks
+
+* [Marin Usalj](http://github.com/supermarin) and [Delisa Mason](http://github.com/kattrali) for creating [xcpretty](https://github.com/supermarin/xcpretty).
+* [Delisa Mason](http://github.com/kattrali) for creating [xcpretty-travis-formatter](https://github.com/kattrali/xcpretty-travis-formatter), which I used as a guide.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/szigetics/xcpretty-pmd-formatter.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/xcpretty-pmd-formatter

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+print File.expand_path('../../lib/pmd_formatter.rb', __FILE__)

data/lib/pmd_formatter.rb

@@ -0,0 +1,163 @@
+require 'fileutils'
+require 'xml'
+
+class PMDFormatter < XCPretty::Simple
+  FILE_PATH = 'build/reports/errors.pmd'.freeze
+
+  def initialize(use_unicode, colorize)
+    super
+    @warnings = []
+    @ld_warnings = []
+    @compile_warnings = []
+    @errors = []
+    @compile_errors = []
+    @file_missing_errors = []
+    @undefined_symbols_errors = []
+    @duplicate_symbols_errors = []
+    @failures = {}
+  end
+
+  def format_ld_warning(message)
+    @ld_warnings << message
+    write_to_file_if_needed
+    super
+  end
+
+  def format_warning(message)
+    @warnings << message
+    write_to_file_if_needed
+    super
+  end
+
+  def format_compile_warning(file_name, file_path, reason, line, cursor)
+    @compile_warnings << {
+      file_name: file_name,
+      file_path: file_path,
+      reason: reason,
+      line: line,
+      cursor: cursor
+    }
+    write_to_file_if_needed
+    super
+  end
+
+  def format_error(message)
+    @errors << message
+    write_to_file_if_needed
+    super
+  end
+
+  def format_compile_error(file, file_path, reason, line, cursor)
+    @compile_errors << {
+      file_name: file,
+      file_path: file_path,
+      reason: reason,
+      line: line,
+      cursor: cursor
+    }
+    write_to_file_if_needed
+    super
+  end
+
+  def format_file_missing_error(reason, file_path)
+    @file_missing_errors << {
+      file_path: file_path,
+      reason: reason
+    }
+    write_to_file_if_needed
+    super
+  end
+
+  def format_undefined_symbols(message, symbol, reference)
+    @undefined_symbols_errors = {
+      message: message,
+      symbol: symbol,
+      reference: reference
+    }
+    write_to_file_if_needed
+    super
+  end
+
+  def format_duplicate_symbols(message, file_paths)
+    @duplicate_symbols_errors = {
+      message: message,
+      file_paths: file_paths
+    }
+    write_to_file_if_needed
+    super
+  end
+
+  def format_test_summary(message, failures_per_suite)
+    super
+  end
+
+  def finish
+    write_to_file
+    super
+  end
+
+  def pmd_output
+    {
+      warnings: @warnings,
+      ld_warnings: @ld_warnings,
+      compile_warnings: @compile_warnings,
+      errors: @errors,
+      compile_errors: @compile_errors,
+      file_missing_errors: @file_missing_errors,
+      undefined_symbols_errors: @undefined_symbols_errors,
+      duplicate_symbols_errors: @duplicate_symbols_errors
+    }
+  end
+
+  def write_to_file_if_needed
+    write_to_file unless XCPretty::Formatter.method_defined? :finish
+  end
+
+  def write_to_file
+    file_name = ENV['XCPRETTY_PMD_FILE_OUTPUT'] || FILE_PATH
+    dirname = File.dirname(file_name)
+    FileUtils.mkdir_p dirname
+
+    doc = XML::Document.new
+    rootnode = XML::Node.new('pmd')
+    rootnode['version'] = 'xcpretty-pmd-formatter'
+    doc.root = rootnode
+    
+    fileNode1 = XML::Node.new('file')
+    fileNode1['name'] = 'AppDelegate.m'
+    violation1 = XML::Node.new('violation')
+    violation1['begincolumn'] = '5'
+    violation1['endcolumn'] = '0'
+    violation1['beginline'] = '28'
+    violation1['endline'] = '0'
+    violation1['priority'] = '1'
+    violation1['rule'] = 'clang static analyzer'
+    violation1['ruleset'] = 'clang static analyzer'
+    violation1.content = 'code will never be executed [-Wunreachable-code]'
+    fileNode1 << violation1
+    doc.root << fileNode1
+    
+    fileNode2 = XML::Node.new('file')
+    fileNode2['name'] = 'BGE/AppDelegate.m'
+    violation2 = XML::Node.new('violation')
+    violation2['begincolumn'] = '23'
+    violation2['endcolumn'] = '0'
+    violation2['beginline'] = '20'
+    violation2['endline'] = '0'
+    violation2['priority'] = '1'
+    violation2['rule'] = 'clang static analyzer'
+    violation2['ruleset'] = 'clang static analyzer'
+    violation2.content = "Potential leak of an object stored into 'key'"
+    fileNode2 << violation2
+    doc.root << fileNode2
+    
+    docAsStr = doc.to_s
+    # result = docAsStr.gsub(/xml/, 'pmd')
+    # doc.save(file_name, :indent => true, :encoding => XML::Encoding::UTF_8)
+    
+    puts(docAsStr)
+    File.write(file_name, docAsStr)
+  end
+end
+
+PMDFormatter

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: xcpretty-pmd-formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Csaba Szigeti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xcpretty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.38'
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+description: Custom formatter for xcpretty that saves on a PMD file all the errors,
+  and warnings, so you can process them easily later.
+email:
+- szigetics@gmail.com
+executables:
+- xcpretty-pmd-formatter
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/pmd_formatter.rb
+- bin/xcpretty-pmd-formatter
+homepage: https://github.com/szigetics/xcpretty-pmd-formatter
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: xcpretty custom formatter for parsing warnings and static analyzer issues
+  easily from "xcodebuild ... clean build analyze" output
+test_files: []