pronto-clang_format 0.1.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fe7b8b5605c1b8f0412b956371ecad612216fcdaf2cddb8ea68c9436f346db3
-  data.tar.gz: 6b2e07eef94cf67d213d1cdeccd103d9eb4aabb9cd458138af1cee08a5cce3f4
+  metadata.gz: 49f3c645df42fafe96470903b922f1f9cbaf902183cdea14649a0c00ddd48999
+  data.tar.gz: 986aadc6c598c278c0c31102092b96d4b68002ade949fef885836be9e4f9fd4d
 SHA512:
-  metadata.gz: a16d084a2da8626789f91b5691cc6236c2742afc51a67923a7989f341eb9344728a89cb08c7d010ad24627709d6209d7018d71f1b4fced8ac514f208b808ca12
-  data.tar.gz: ce6ef55cc378d4ffac01d9c2716c005729b38d03b7d1ddbb4ed13fa43bb0e962760302cc19ec503d8abf54aeea6b7d54f991a37b16295bf179e6cfecf42c33de
+  metadata.gz: 59cc1f84ddaea0c4d4238af82912853c3b96adfe94f5e8b198edacfb63546d47a1241c1fdb5994597aad82930559ec34bd8d9dc5de5b5f3f7a8870674545a21a
+  data.tar.gz: 52fa9526d57234ee6ed2a146360c2bc2d7ce2a759064cd6718ea7713446391aa6fd6eee8825bf0d770ef27226ce127966050082e50b85aadc35eff3b3ac39600

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+ - 2.0.0
+ - 2.1
+ - 2.2
+ - 2.3.0
+ - 2.4.0

data/README.md

@@ -1,3 +1,44 @@
-WIP
+# Pronto runner for clang-format
 
-A pronto runner for clang-format.
+[![Code Climate](https://codeclimate.com/github/micjabbour/pronto-clang_format.png)](https://codeclimate.com/github/micjabbour/pronto-clang_format)
+[![Build Status](https://travis-ci.org/micjabbour/pronto-clang_format.png)](https://travis-ci.org/micjabbour/pronto-clang_format)
+[![Gem Version](https://badge.fury.io/rb/pronto-clang_format.png)](http://badge.fury.io/rb/pronto-clang_format)
+[![Dependency Status](https://gemnasium.com/micjabbour/pronto-clang_format.png)](https://gemnasium.com/micjabbour/pronto-clang_format)
+
+Pronto runner for [clang-format](https://clang.llvm.org/docs/ClangFormat.html), a tool to reformat C/C++/Java/JavaScript/Objective-C/Protobuf code according to configurable style guidelines. [What is Pronto?](https://github.com/prontolabs/pronto)
+
+As an example, this can be used to run clang-format and submit replacements 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-format
+ 2. Ruby
+ 3. Pronto, this can be done after installing Ruby using:
+    ```
+    gem install pronto
+    ```
+After that, pronto-clang_format can be installed using:
+```
+gem install pronto-clang_format
+```
+Pronto will detect and run clang-format as soon as this runner is installed.
+
+## Configuration:
+
+The runner can be configured by setting some environment variables before invoking it. The following table lists these environment
+variables along with a description for each one of them:
+
+| Environment variable           | Description                                                                                           |
+|:-------------------------------|:------------------------------------------------------------------------------------------------------|
+| `PRONTO_CLANG_FORMAT_PATH`     | Path to the clang-format executable that should be run by the runner. This defaults to `clang-format` |
+| `PRONTO_CLANG_FORMAT_STYLE`    | A string that is passed to clang-format's `--style=` option. This defaults to `file`                  |
+| `PRONTO_CLANG_FORMAT_FILE_EXTS`| A comma separated list of file extensions to examine. This defaults to `c, h, cpp, cc, cxx, c++, hh, hxx, hpp, h++, icc, inl, tcc, tpp, ipp`|
+
+
+## Known limitations:
+ * Every replacement reported by clang-format is mapped to no more than one offence, even though the reported replacement might be fixing more than one offence (e.g. trailing whitespace in a line and improper indentation in the following line)
+ * Only one offence is reported per line; to avoid overwhelming one line with too many offences
+ * Categorizers are rudimentary, but more can be added easily to the current chain
+  * This runner is mostly meant to remind the developer to run clang-format on his changed files. It is not about going through the offences one by one and fixing them manually

data/Rakefile

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

data/lib/pronto/clang_format/offence_categorizer/abstract_categorizer.rb

@@ -1,12 +1,16 @@
 module Pronto
   module ClangFormat
     module OffenceCategorizer
-      # base class to implement a chain of responsibility
+      # base class to implement a chain of categorizers
       class AbstractCategorizer
         def initialize(successor = nil)
           @successor = successor
         end
 
+        # Tries to handle the offence using the current categorizer. If it
+        # couldn't, it passes the offence to the next categorizer in the chain.
+        # If this is the last categorizer in the chain, it returns a generic
+        # message
         def handle(offence)
           current_result = handle_current offence
           if !current_result.nil?
@@ -14,8 +18,8 @@ module Pronto
           elsif !@successor.nil?
             @successor.handle offence
           else # unahndled offence
-            "This should be rewritten as: \n```" \
-            "#{offence.affected_lines_after}```"
+            "Improper formatting. This should be rewritten as: \n" \
+            "```#{offence.affected_lines_after}```"
           end
         end
 

data/lib/pronto/clang_format/offence_categorizer/factory.rb

@@ -1,12 +1,14 @@
-require_relative 'indentation_categorizer'
-require_relative 'includes_order_categorizer'
+# require all ruby files in the current directory (all categorizers)
+Dir[File.join(__dir__, '*.rb')].each { |file| require file }
 
 module Pronto
   module ClangFormat
     module OffenceCategorizer
       class Factory
         def self.create_categorizers
-          IncludesOrderCategorizer.new IndentationCategorizer.new
+          IncludesOrderCategorizer.new UsingOrderCategorizer.new \
+          UnnecessaryNewlineCategorizer.new IndentationCategorizer.new \
+          MissingNewlineCategorizer.new TrailingWhitespaceCategorizer.new
         end
       end
     end

data/lib/pronto/clang_format/offence_categorizer/includes_order_categorizer.rb

@@ -8,8 +8,8 @@ module Pronto
           return unless offence.replaced_text.include? 'include'
 
           "Include statements are not ordered alphabetically. "\
-          "They should be rewritten as:\n```" \
-          "#{offence.affected_lines_after}```"
+          "They should be rewritten as:\n" \
+          "```#{offence.affected_lines_after}```"
         end
       end
     end

data/lib/pronto/clang_format/offence_categorizer/indentation_categorizer.rb

@@ -5,7 +5,9 @@ module Pronto
     module OffenceCategorizer
       class IndentationCategorizer < AbstractCategorizer
         def handle_current(offence)
-          "Incorrect indentation" if offence.column <= 1
+          return unless offence.column == 1
+
+          "Incorrect indentation"
         end
       end
     end

data/lib/pronto/clang_format/offence_categorizer/missing_newline_categorizer.rb

@@ -0,0 +1,17 @@
+require_relative 'abstract_categorizer'
+
+module Pronto
+  module ClangFormat
+    module OffenceCategorizer
+      class MissingNewlineCategorizer < AbstractCategorizer
+        def handle_current(offence)
+          return unless offence.replaced_text.count("\n") \
+                      < offence.replacement.count("\n")
+
+          "Missing newline. This should be rewritten as:\n" \
+          "```#{offence.affected_lines_after}```"
+        end
+      end
+    end
+  end
+end

data/lib/pronto/clang_format/offence_categorizer/trailing_whitespace_categorizer.rb

@@ -0,0 +1,15 @@
+require_relative 'abstract_categorizer'
+
+module Pronto
+  module ClangFormat
+    module OffenceCategorizer
+      class TrailingWhitespaceCategorizer < AbstractCategorizer
+        def handle_current(offence)
+          return unless /[[:blank:]]+[\n]/.match(offence.replaced_text)
+
+          "Remove trailing whitespace"
+        end
+      end
+    end
+  end
+end

data/lib/pronto/clang_format/offence_categorizer/unnecessary_newline_categorizer.rb

@@ -0,0 +1,15 @@
+require_relative 'abstract_categorizer'
+
+module Pronto
+  module ClangFormat
+    module OffenceCategorizer
+      class UnnecessaryNewlineCategorizer < AbstractCategorizer
+        def handle_current(offence)
+          return unless offence.column == 0
+
+          "Unnecessary new line"
+        end
+      end
+    end
+  end
+end

data/lib/pronto/clang_format/offence_categorizer/using_order_categorizer.rb

@@ -0,0 +1,15 @@
+require_relative 'abstract_categorizer'
+
+module Pronto
+  module ClangFormat
+    module OffenceCategorizer
+      class UsingOrderCategorizer < AbstractCategorizer
+        def handle_current(offence)
+          return unless offence.replaced_text.include? 'using'
+
+          "Using declarations not ordered alphabetically"
+        end
+      end
+    end
+  end
+end

data/lib/pronto/clang_format/version.rb

@@ -1,5 +1,5 @@
 module Pronto
   module ClangFormat
-    VERSION = '0.1.3'.freeze
+    VERSION = '0.9.0'.freeze
   end
 end

data/pronto-clang_format.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pronto-clang_format
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Michael Jabbour
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pronto
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !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
@@ -62,6 +76,7 @@ extra_rdoc_files:
 - README.md
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -72,6 +87,10 @@ files:
 - lib/pronto/clang_format/offence_categorizer/factory.rb
 - lib/pronto/clang_format/offence_categorizer/includes_order_categorizer.rb
 - lib/pronto/clang_format/offence_categorizer/indentation_categorizer.rb
+- lib/pronto/clang_format/offence_categorizer/missing_newline_categorizer.rb
+- lib/pronto/clang_format/offence_categorizer/trailing_whitespace_categorizer.rb
+- lib/pronto/clang_format/offence_categorizer/unnecessary_newline_categorizer.rb
+- lib/pronto/clang_format/offence_categorizer/using_order_categorizer.rb
 - lib/pronto/clang_format/version.rb
 - lib/pronto/clang_format/wrapper.rb
 - lib/pronto/clang_format_runner.rb