pronto-dialyzer 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e49ba55878bb58b224f139b50a0e77c7c283fd0
-  data.tar.gz: 6ea04263140baf7f6ca926411bada9a424e3ddca
+  metadata.gz: a26f118ce3d5d50d47feec9aa47f5fe127892fd6
+  data.tar.gz: 56e0cf6be31059b77cb0c5b7d65b131eb99ffa89
 SHA512:
-  metadata.gz: 4f4e7199e68baa32fd067a9b09188032428184edb3d8651add7b273063923414bf2e2abcf8278805614134795aecedbf0bdcb40226e5dce096512933e3d5994c
-  data.tar.gz: b0b62041ed1f794b5fc58b3fc36bf240563a2591dd68edc647c7e42fa7bcc561881e2ed0e42b8fc9d01faf03fd27ee416f525b322618434c0626f96edcdfd148
+  metadata.gz: b3a12f301614e1c058f34d2cdfc82f1bd108d6748d73ea1a36ff87a78bd4fe9dbb63509feb0cd4c4aa062a745515eede59c5bd059ce1ebbce3f60007971a4074
+  data.tar.gz: 992bb88a6dbe86f6c0e0ac09edc1975e1175f0ef8fc0aa17c6632aab78015df3949aa77c4d1920ba19d6f343909328c2b35ceb2a83c56844f6e83e54dd8cadc8

data/README.md

@@ -1,17 +1,31 @@
 # Pronto runner for Dialyzer
 
-This allows you to take the output of Dialyzer and submit its errors with Pronto
+This allows you to take the output of Dialyzer and submit its errors with
+[Pronto]. It works both with Elixir and Erlang.
 
 ## Installation
 
-As an Elixir application will probably not have a Gemfile, install it with:
+As an Elixir/Erlang application will probably not have a `Gemfile`, install it with:
 
     $ gem install pronto-dialyzer
 
+After the gem is installed, [Pronto] will already be detected the Dialyzer
+runner.
+
 ## Usage
 
-It uses the environment variable `PRONTO_DIALYZER_OUTPUT` to define the location
-of Dialyzer's output file. If that is not defined, the default is `dialyzer.out`
+It's important to enable the `-fullpath` option in your Dialyzer configuration
+and send the output to a file with `-o`.
+
+The path for Dialyzer's output file should then be passed to the runner. It uses
+the environment variable `PRONTO_DIALYZER_OUTPUT` to define the location of
+Dialyzer's output file. If this variable is not defined, it will look for the
+file `dialyzer.out`.
+
+### Running on Travis CI
+
+Pronto works perfectly to create comment on PRs and commits. For that, use
+`pronto run` as described in the readme for [Pronto].
 
 ## Contributing
 
@@ -21,3 +35,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/iurifq
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+
+[Pronto]: https://github.com/mmozuras/pronto

data/lib/pronto/dialyzer.rb

@@ -3,10 +3,11 @@ require 'pronto'
 
 module Pronto::Dialyzer
   class Runner < Pronto::Runner
+    BEAM_EXTENSIONS = %w(.ex .erl).freeze
 
     def run
-      return [] unless File.exists?(self.class.dialyzer_output_path)
-      elixir_patches
+      return [] unless dialyzer_output_pathname.exist?
+      beam_patches
         .select { |patch| patch.delta.status != :deleted }
         .flat_map { |patch| affected_lines(patch) }
     end
@@ -14,8 +15,9 @@ module Pronto::Dialyzer
     def affected_lines(patch)
       candidate_lines = patch.lines.select { |line| line.addition? }
       candidate_lines.reduce([]) do |accum, line|
-        affected_line = self.class.dialyzer_lines.find do |dline|
-          patch.repo.path.join(dline.path) == patch.new_file_full_path && dline.lineno == line.new_lineno
+        affected_line = dialyzer_lines.find do |dline|
+          patch.repo.path.join(dline.path) == patch.new_file_full_path &&
+            dline.lineno == line.new_lineno
         end
 
         if affected_line
@@ -30,19 +32,35 @@ module Pronto::Dialyzer
       Pronto::Message.new(dline.path, line, :warning, dline.error)
     end
 
-    def elixir_patches
-      @patches.select {|patch| File.extname(patch.new_file_full_path) == '.ex' }
+    def beam_patches
+      @patches.select do |patch|
+        BEAM_EXTENSIONS.member?(File.extname(patch.new_file_full_path))
+      end
+    end
+
+    def dialyzer_output_pathname
+      @dialyzer_output_path ||= Pathname.new(
+        ENV["PRONTO_DIALYZER_OUTPUT"] || "dialyzer.out"
+      )
     end
 
-    def self.dialyzer_output_path
-      ENV["PRONTO_DIALYZER_OUTPUT"] || "dialyzer.out"
+    def dialyzer_lines
+      @dialyzer_lines ||= matching_lines(
+        dialyzer_output_pathname,
+        /(?<path>.+\.[a-z]{2,3}):(?<lineno>[0-9]+): (?<error_msg>.+)/
+      )
     end
 
-    def self.dialyzer_lines
-      File.readlines(dialyzer_output_path).reduce([]) do |accum, line|
-        match = line.match(/(.+\.ex):([0-9]+): (.+)/)
-        if match
-          accum << OpenStruct.new(path: match[1], lineno: match[2].to_i, error: match[3])
+    private
+
+    def matching_lines(pathname, line_regex)
+      pathname.readlines.reduce([]) do |accum, line|
+        if match = line.match(line_regex)
+          accum << OpenStruct.new(
+            path: match[:path],
+            lineno: match[:lineno].to_i,
+            error: match[:error_msg]
+          )
         else
           accum
         end

data/lib/pronto/dialyzer/version.rb

@@ -1,5 +1,5 @@
 module Pronto
   module Dialyzer
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pronto-dialyzer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Iuri Fernandes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-03 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pronto