pronto-clang_format 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da6b480040bfb881723b002a3c288b16bbff3a65ed6553f24cc7774722fa0f77
+  data.tar.gz: 780c8d7b5754c41502acbcd2eda9ec7adabc85fc1fb8958c97934225487d7fd8
+SHA512:
+  metadata.gz: 50ac0304347960daf2d12cf5860ea23ff428f592d63f60edd796b12db076c76758d34a0bd50a03210c029337f6acef21943e83b1900d8c32b9c60c085bdc2ab9
+  data.tar.gz: 14ba65662a824f97ee0e3150524803d04b5261ad1848dec97b33796d8ff442e1dcecce1858277dd49a0726174c822a67750fcd5f417ad967ce97e98b4a76e5d6

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,3 @@
+WIP
+
+A pronto runner for clang-format.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/lib/pronto/clang_format/version.rb

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

data/lib/pronto/clang_format/wrapper.rb

@@ -0,0 +1,63 @@
+require 'open3'
+require 'rexml/document'
+require 'shellwords'
+
+# TODO: make sure clang-format returns its output sorted by offset. If this is always true, switch to using .each_with_index.to_a.reverse.bsearch { |n, i| n < clang_offset }
+module Pronto
+  module ClangFormat
+    class Wrapper
+      def initialize
+        @clang_format_path = ENV['PRONTO_CLANG_FORMAT_PATH'] || 'clang-format'
+      end
+
+      def run(filepath)
+        # TODO: add environment variable for style file
+        stdout, stderr, = Open3.capture3("#{@clang_format_path} "\
+                                         "-output-replacements-xml #{filepath}")
+        if stderr && !stderr.empty?
+          puts "WARN: pronto-clang_format: #{filepath}: #{stderr}"
+        end
+        return [] if stdout.nil? || stdout == 0
+        parse_output(filepath, stdout)
+      end
+
+      def parse_output(filepath, output)
+        doc = REXML::Document.new output
+        doc.root.elements.map do |element|
+          offset = element.attributes['offset'].to_i
+          length = element.attributes['length'].to_i
+          line_no, column = ln_col_for(offset, filepath)
+          {
+            offset: offset,
+            line_no: line_no, column: column, length: length,
+            replacement: element.get_text.value
+          }
+        end
+      end
+
+      private
+
+      # a function that returns line no and column given byte offset in a file
+      def ln_col_for(offset, filepath)
+        preceding_newlines = newline_offsets_in(filepath)
+                             .select { |newline| newline < offset }
+        ln = preceding_newlines.length + 1
+        line_start_offset = preceding_newlines.last || 0
+        col = offset - line_start_offset
+        [ln, col]
+      end
+
+      # a memoized function that returns offsets of newline characters
+      # in a file. used in ln_col_for
+      def newline_offsets_in(filepath)
+        @newline_offsets_in ||= Hash.new do |h, key|
+          # reading as binary to support CRLF and LF
+          text = File.read(key, mode: 'rb')
+          h[key] = (0..(text.length - 1))
+                   .select { |i| text[i] == "\n" }
+        end
+        @newline_offsets_in[filepath]
+      end
+    end
+  end
+end

data/lib/pronto/clang_format.rb

@@ -0,0 +1,2 @@
+require_relative 'clang_format/version'
+require_relative 'clang_format_runner'

data/lib/pronto/clang_format_runner.rb

@@ -0,0 +1,48 @@
+require 'pronto'
+require_relative 'clang_format/wrapper'
+
+module Pronto
+  class ClangFormatRunner < Runner
+    def initialize(_, __ = nil)
+      super
+      @inspector = ::Pronto::ClangFormat::Wrapper.new
+    end
+
+    def run
+      return [] if !@patches || @patches.count.zero?
+      @patches
+        .select { |p| valid_patch(p) }
+        .map { |p| inspect(p) }
+        .flatten.compact
+    end
+    
+    def valid_patch(patch)
+      #TODO: file should be a cpp or c or a header file (make sure we aren't missing anything)
+      #TODO: should we consider patches with added lines only?
+      true
+    end
+
+    def inspect(patch)
+      puts 'inspecting patch'
+      filename = patch.new_file_full_path
+      offences = @inspector.run(filename)
+      offences.map do |offence|
+        patch.added_lines
+          .select { |line| line.new_lineno == offence[:line_no] }
+          .map { |line| new_message(offence, line) }
+      end
+    end
+    
+    def new_message(offence, line)
+      path = line.patch.delta.new_file[:path]
+      Message.new(path, line, :warning, msg_for_offence(offence), nil, self.class)
+    end
+    
+    #TODO: correct line numbers for indentation errors (clang outputs the replacement to start from the preceding line)
+    #TODO: better messages, maybe have categories? (e.g. indentation, missing space, superfluous space, missine newline, superfluous newline, ...)
+    
+    def msg_for_offence(offence)
+      "col: #{offence[:column]}, len: #{offence[:length]}, offset: #{offence[:offset]}, replace with: #{offence[:replacement].dump}"
+    end
+  end
+end

data/pronto-clang_format.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pronto/clang_format/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pronto-clang_format'
+  spec.version       = Pronto::ClangFormat::VERSION
+  spec.authors       = ['Michael Jabbour']
+  spec.email         = ['micjabbour@gmail.com']
+
+  spec.summary       = 'Pronto runner for clang-format, a tool to reformat C++'\
+                       ' sources files according to configurable style guides.'
+  spec.homepage      = 'https://github.com/micjabbour/pronto-clang_format'
+  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'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: pronto-clang_format
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Jabbour
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-24 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'
+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_format.rb
+- lib/pronto/clang_format/version.rb
+- lib/pronto/clang_format/wrapper.rb
+- lib/pronto/clang_format_runner.rb
+- pronto-clang_format.gemspec
+homepage: https://github.com/micjabbour/pronto-clang_format
+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-format, a tool to reformat C++ sources files according
+  to configurable style guides.
+test_files: []