pronto-clang_tidy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 912e8cbd46b44243e4e4b8826fdd92a3b5188bd34a7308249182546e317df741
+  data.tar.gz: 3f01a9758d7c41795a9dcc92bbd340399eeef9fa582fa40151721fcc4828e26d
+SHA512:
+  metadata.gz: 6e80c9ea8d9eb51df711ed959709e7354b31067222e4016ee332657a2143a729839f93de88571d71f7a147362d2f02fd7a99a6ea8d2822f5b8376ef5eaaff6c0
+  data.tar.gz: 94faf438e390e41c506535442307631b1e39219e42708875cd9422440ad6ffee3fbd200685a1fcd9af6239c919e2d58ba8f099e0481da0e0e2280c38de062178

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Michael Jabbour
+
+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,32 @@
+# Pronto runner for clang-tidy
+
+[![Code Climate](https://codeclimate.com/github/micjabbour/pronto-clang_tidy.png)](https://codeclimate.com/github/micjabbour/pronto-clang_tidy)
+[![Build Status](https://travis-ci.org/micjabbour/pronto-clang_tidy.png)](https://travis-ci.org/micjabbour/pronto-clang_tidy)
+[![Gem Version](https://badge.fury.io/rb/pronto-clang_tidy.png)](http://badge.fury.io/rb/pronto-clang_tidy)
+[![Dependency Status](https://gemnasium.com/micjabbour/pronto-clang_tidy.png)](https://gemnasium.com/micjabbour/pronto-clang_tidy)
+
+Pronto runner for [clang-tidy](http://clang.llvm.org/extra/clang-tidy), a clang-based C++ "linter" tool. [What is Pronto?](https://github.com/prontolabs/pronto)
+
+This runner can be used after running clang-tidy on a codebase to submit the reported offences to web-based git repo managers (e.g. github, gitlab, ...) as comments using Pronto.
+
+## Installation:
+
+First, the following prerequisites need to be installed:
+
+ 1. clang-tidy
+ 2. Ruby
+ 3. Pronto, this can be done after installing Ruby using:
+    ```
+    gem install pronto
+    ```
+After that, pronto-clang_tidy can be installed using:
+```
+gem install pronto-clang_tidy
+```
+Pronto will look for clang-tidy output file and submit its contents as soon as this runner is installed.
+
+## Configuration:
+
+After configuring and running `clang-tidy` on your codebase, redirect and save its standard output to a file (e.g. `clang-tidy.out`).
+
+The name of the clang-tidy output file can be configured by setting the environment variable `PRONTO_CLANG_TIDY_OUTFILE` prior to running pronto. If it is not set, the runner will assume the file name is `clang-tidy.out`.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/pronto/clang_tidy/version.rb

@@ -0,0 +1,5 @@
+module Pronto
+  module ClangTidy
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/pronto/clang_tidy.rb

@@ -0,0 +1,53 @@
+require_relative 'clang_tidy/version'
+require 'pronto'
+
+module Pronto
+  class ClangTidyRunner < Runner
+    def run
+      return [] if !@patches || @patches.count.zero?
+      # loop through all offences in clang-tidy output
+      offences = read_clang_tidy_output
+      return [] if !offences || offences.length.zero?
+      offences.map do |offence|
+        # find the patch that corresponds to the current offence
+        patch = patch_for(offence.file)
+        next if patch.nil?
+        # generate a message for the corresponding added_line in the patch
+        patch.added_lines
+             .select { |added_line| added_line.new_lineno == offence.lineno }
+             .map { |line| new_message(offence, line) }
+      end.flatten.compact
+    end
+
+    private
+
+    def patch_for(filename)
+      @patches.find do |p|
+        p.new_file_full_path == Pathname.new(filename)
+      end
+    end
+
+    def new_message(offence, line)
+      path = line.patch.delta.new_file[:path]
+      Message.new(path, line, :warning, offence.msg, nil, self.class)
+    end
+
+    # reads clang-tidy output file and returns an array of offences
+    def read_clang_tidy_output
+      unless FileTest.file? clang_tidy_output_file
+        puts 'WARN: pronto-clang_tidy: clang-tidy output file not found'
+        return ''
+      end
+      clang_tidy_output = File.read clang_tidy_output_file
+      clang_tidy_output.split("\n").each_slice(3).map do |offence|
+        properties = offence[0].split(':').map(&:strip)
+        OpenStruct.new(file: properties[0], lineno: properties[1].to_i,
+                       level: properties[3], msg: properties[4])
+      end
+    end
+
+    def clang_tidy_output_file
+      ENV['PRONTO_CLANG_TIDY_OUTFILE'] || 'clang-tidy.out'
+    end
+  end
+end

data/pronto-clang_tidy.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pronto/clang_tidy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pronto-clang_tidy'
+  spec.version       = Pronto::ClangTidy::VERSION
+  spec.authors       = ['Michael Jabbour']
+  spec.email         = ['micjabbour@gmail.com']
+
+  spec.summary       = 'Pronto runner for clang-tidy, a clang-based C++ ' \
+                       '"linter" tool.'
+  spec.homepage      = 'https://github.com/micjabbour/pronto-clang_tidy'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.extra_rdoc_files = ['LICENSE.txt', 'README.md']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'pronto', '~> 0.9.0'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: pronto-clang_tidy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Jabbour
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 
+email:
+- micjabbour@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pronto/clang_tidy.rb
+- lib/pronto/clang_tidy/version.rb
+- pronto-clang_tidy.gemspec
+homepage: https://github.com/micjabbour/pronto-clang_tidy
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Pronto runner for clang-tidy, a clang-based C++ "linter" tool.
+test_files: []