pronto-clang_tidy 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 258553456e56ce657bf44611c40fc43d418c51600d86b0e30e11a18abe542d8a
-  data.tar.gz: 6853bf8719af3147fb58b44242fc5a9a311284221a2d5aab1423227d64193c05
+  metadata.gz: 756bd9000c3003b901e0fbd36a4771c26a4fbbaec2040079f7ebcd8f21f260fc
+  data.tar.gz: bc48d8809b0f631cf83c6d51bb89c61350eaca0f7799d353a19e284d49012fdc
 SHA512:
-  metadata.gz: 8aa32a8b3bedaaeb47a6adf31a5fe643073e5206470d58f34505354507e68f5fa8190cd5de32399e236ea61b0c7c078c2ee4564d0381dec372a6986a69a07b92
-  data.tar.gz: ad0e9cb98a09fc903d3cb98b441b31a81e5f8417b0809c36f0cc46151f8f4688330229e4164cb3a7d95ca01ca714a84b274861f6d1bb3412aa57c939c0372180
+  metadata.gz: 45f6b218f0e733d0f56d9ee533320a8fc1b6af5f134d3b27db66be0d30fb66288442eb1264dd719096c5420981abd7603a5a67210a404a499dbd52c3852e3749
+  data.tar.gz: 70ad8726b3a64a9b9061a1df7af3a58b5c13809847b6e9778f3e10af6e490d705f20f7ef15fa388dca44ff4abe472ced3f2e3e1aa7c0818843ec847e4cfb4cfd

data/lib/pronto/clang_tidy.rb

@@ -1,84 +1,2 @@
 require_relative 'clang_tidy/version'
-require 'pronto'
-
-module Pronto
-  class ClangTidyRunner < Runner
-    def run
-      offences = read_clang_tidy_output
-      return [] if no_patches? || offences.length.zero?
-      # loop through all offences in clang-tidy output
-      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
-        message_for(patch, offence)
-        # Header warnings are repeated for every compilation unit that includes
-        # them. Use uniq to ignore repeated messages
-      end.flatten.compact.uniq
-    end
-
-    private
-
-    def message_for(patch, offence)
-      line = patch.added_lines.find do |added_line|
-        added_line.new_lineno == offence.lineno
-      end
-      new_message(offence, line) unless line.nil?
-    end
-
-    def no_patches?
-      !@patches || @patches.count.zero?
-    end
-
-    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, pronto_level(offence.level), offence.msg, nil,
-                  self.class)
-    end
-
-    def pronto_level(clang_level)
-      case clang_level
-      when :warning
-        :warning
-      when :error
-        :error
-      when :fatal
-        :fatal
-      else
-        :info
-      end
-    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
-      parse_clang_tidy_output File.read(clang_tidy_output_file)
-    end
-
-    # parses clang-tidy output and returns a list of offences
-    def parse_clang_tidy_output(output)
-      regexp = Regexp.new '(?<filename>^/[^:]+):(?<line>\d+):' \
-                          '(?<col>\d+): (?<level>[^:]+): (?<message>.+$)'
-      offences = []
-      output.scan regexp do |filename, line, _col, level, message|
-        offences << OpenStruct.new(file: filename, lineno: line.to_i,
-                                   level: level.to_sym, msg: message)
-      end
-      offences
-    end
-
-    def clang_tidy_output_file
-      ENV['PRONTO_CLANG_TIDY_OUTFILE'] || 'clang-tidy.out'
-    end
-  end
-end
+require_relative 'clang_tidy_runner'

data/lib/pronto/clang_tidy/diagnostic.rb

@@ -0,0 +1,39 @@
+require 'pathname'
+
+module Pronto
+  module ClangTidy
+    # a class that represents a single diagnostic emitted by clang-tidy
+    class Diagnostic
+      attr_reader :filename, :line_no, :col_no, :level, :message, :hints
+      def initialize(filename, line_no, col_no, level, message)
+        @filename = abs(filename)
+        @line_no = line_no.to_i
+        @col_no = col_no.to_i
+        @level = level.to_sym
+        @message = message
+        @hints = ''
+      end
+
+      def formatted_filename
+        # output a relative path when filename is inside working directory
+        if filename.to_s.start_with?(abs(Pathname.pwd).to_s)
+          filename.relative_path_from(Pathname.pwd)
+        else
+          filename.to_s # absolute otherwise
+        end
+      end
+
+      def format_diagnostic
+        "#{formatted_filename}:#{line_no}:#{col_no}: #{level}: #{message}\n" \
+        "```\n#{hints}```\n"
+      end
+
+      private
+
+      # converts the given String or Pathname to an absolute Pathname
+      def abs(pathname)
+        Pathname.new File.absolute_path Pathname.new pathname
+      end
+    end
+  end
+end

data/lib/pronto/clang_tidy/offence.rb

@@ -0,0 +1,42 @@
+require_relative 'diagnostic'
+
+module Pronto
+  module ClangTidy
+    # a class that groups multiple related diagnostics together
+    #
+    # Clang uses NOTE-level diagnostics to staple more information onto
+    # previous diagnostics. The Offence class groups a diagnostic along with
+    # all subsequent NOTE-level diagnostics into a single entity.
+    class Offence
+      attr_reader :main, :notes
+      def initialize(main_diagnostic)
+        @main = main_diagnostic
+        @notes = []
+      end
+
+      def <<(note_diagnostic)
+        @notes << note_diagnostic
+      end
+
+      # the message to be attached to the main diagnostic's line
+      def main_message
+        result = "#{main.message}\n"
+        notes.each do |note|
+          result << note.format_diagnostic
+        end
+        result
+      end
+
+      # the message to be attached to any of the notes' lines
+      #
+      # this is used only when the main diagnostic's line is not changed
+      def note_message
+        result = main.format_diagnostic
+        notes.each do |note|
+          result << note.format_diagnostic
+        end
+        result
+      end
+    end
+  end
+end

data/lib/pronto/clang_tidy/parser.rb

@@ -0,0 +1,53 @@
+module Pronto
+  module ClangTidy
+    # a class that provides functions to parse a clang-tidy output file and
+    # returns an array of Offence objects
+    class Parser
+      def initialize(output_filename)
+        @output_filename = output_filename
+      end
+
+      # reads clang-tidy output file and returns an array of offences
+      def read_clang_tidy_output
+        unless FileTest.file? @output_filename
+          puts 'WARN: pronto-clang_tidy: clang-tidy output file not found'
+          return []
+        end
+        parse_clang_tidy_output File.read(@output_filename)
+      end
+
+      private
+
+      # parses clang-tidy output and returns a list of offences
+      def parse_clang_tidy_output(output)
+        # a regular expression that matches diagnostics' headers
+        header_regexp = Regexp.new '(?<filename>^/[^:]+):(?<line_no>\d+):' \
+                                   '(?<col_no>\d+): (?<level>[^:]+): ' \
+                                   '(?<message>.+$)'
+        diagnostics = []
+        output.each_line do |line|
+          if (match_data = header_regexp.match(line))
+            diagnostics << Diagnostic.new(*match_data.captures)
+          else
+            diagnostics.last.hints << line unless diagnostics.empty?
+          end
+        end
+        group_diagnostics(diagnostics)
+      end
+
+      # turns an array of diagnostics into an array of offences by grouping
+      # note-level diagnostics with their corresponding diagnostic
+      def group_diagnostics(diags)
+        offences = []
+        diags.each do |diag|
+          if diag.level != :note
+            offences << Offence.new(diag)
+          else
+            offences.last << diag unless offences.empty?
+          end
+        end
+        offences
+      end
+    end
+  end
+end

data/lib/pronto/clang_tidy/version.rb

@@ -1,5 +1,5 @@
 module Pronto
   module ClangTidy
-    VERSION = '0.9.2'.freeze
+    VERSION = '0.9.3'.freeze
   end
 end

data/lib/pronto/clang_tidy_runner.rb

@@ -0,0 +1,87 @@
+require 'pronto'
+require_relative 'clang_tidy/diagnostic'
+require_relative 'clang_tidy/offence'
+require_relative 'clang_tidy/parser'
+
+Diagnostic = ::Pronto::ClangTidy::Diagnostic
+Offence = ::Pronto::ClangTidy::Offence
+Parser = ::Pronto::ClangTidy::Parser
+
+module Pronto
+  class ClangTidyRunner < Runner
+    def run
+      offences = Parser.new(clang_tidy_output_file).read_clang_tidy_output
+      return [] if no_patches? || offences.length.zero?
+      # loop through all offences in clang-tidy output
+      offences.map do |offence|
+        build_message_for(offence)
+        # Header warnings are repeated for every compilation unit that includes
+        # them. Use uniq to ignore repeated messages
+      end.flatten.compact.uniq
+    end
+
+    private
+
+    def no_patches?
+      !@patches || @patches.count.zero?
+    end
+
+    # creates a new pronto message for offence
+    def build_message_for(offence)
+      # find the line for the main diag in the current offence
+      main_line = find_line_for_diag(offence.main)
+      # if the main diagnostic in the offence points to a changed line
+      if main_line
+        new_message(main_line, offence.main.level, offence.main_message)
+      else
+        # try to find a note from the offence that belongs to changed a line
+        note_line = find_first_line_for_diags(offence.notes)
+        new_message(note_line, offence.main.level, offence.note_message)
+      end
+    end
+
+    # searches through patches for the diagnostic's line and returns it
+    # returns nil if the line was not changed
+    def find_line_for_diag(diag)
+      file_patch = @patches.find do |patch|
+        patch.new_file_full_path == Pathname.new(diag.filename)
+      end
+      return nil if file_patch.nil?
+      file_patch.added_lines.find do |added_line|
+        added_line.new_lineno == diag.line_no
+      end
+    end
+
+    # searches through the diags_array to find a diag that points to a changed
+    # line and returns that line
+    # returns nil when none of the diags point to a changed line
+    def find_first_line_for_diags(diags_array)
+      diags_array.map { |diag| find_line_for_diag(diag) }
+                 .compact.first
+    end
+
+    def new_message(line, offence_level, offence_message)
+      return nil if line.nil?
+      path = line.patch.delta.new_file[:path]
+      Message.new(path, line, pronto_level(offence_level),
+                  offence_message, nil, self.class)
+    end
+
+    def pronto_level(clang_level)
+      case clang_level
+      when :warning
+        :warning
+      when :error
+        :error
+      when :fatal
+        :fatal
+      else
+        :info
+      end
+    end
+
+    def clang_tidy_output_file
+      ENV['PRONTO_CLANG_TIDY_OUTFILE'] || 'clang-tidy.out'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pronto-clang_tidy
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Michael Jabbour
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-24 00:00:00.000000000 Z
+date: 2018-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pronto
@@ -82,7 +82,11 @@ files:
 - README.md
 - Rakefile
 - lib/pronto/clang_tidy.rb
+- lib/pronto/clang_tidy/diagnostic.rb
+- lib/pronto/clang_tidy/offence.rb
+- lib/pronto/clang_tidy/parser.rb
 - lib/pronto/clang_tidy/version.rb
+- lib/pronto/clang_tidy_runner.rb
 - pronto-clang_tidy.gemspec
 homepage: https://github.com/micjabbour/pronto-clang_tidy
 licenses: