lib/hlint/plugin.rb in danger-hlint-0.0.2 vs lib/hlint/plugin.rb in danger-hlint-0.0.3

@@ -1,55 +1,55 @@
 require 'shellwords'
 
 module Danger
-  # This is your plugin class. Any attributes or methods you expose here will
-  # be available from within your Dangerfile.
+  # Lint Haskell files inside your project using [HLint](https://github.com/ndmitchell/hlint)
   #
-  # To be published on the Danger plugins site, you will need to have
-  # the public interface documented. Danger uses [YARD](http://yardoc.org/)
-  # for generating documentation from your plugin source, and you can verify
-  # by running `danger plugins lint` or `bundle exec rake spec`.
+  # @example Lint a list of files
   #
-  # You should replace these comments with a public description of your library.
+  #          danger_hlint.lint(["Lib.hs"], inline_mode: true:
   #
-  # @example Ensure people are well warned about merging on Mondays
-  #
-  #          danger_hlint.warn_on_mondays
-  #
   # @see  blender/danger-hlint
-  # @tags monday, weekends, time, rattata
+  # @tags hlint, haskell
   #
   class DangerHlint < Plugin
-
-    # The path to the hint/ignore file used by hlint
+    # The list of suggestions found by hlint in JSON format
     #
     # @return   [String]
-    attr_accessor :config_file
+    attr_accessor :suggestions
 
+    # The list of warnings found by hlint in JSON format
+    #
+    # @return [String]
+    attr_accessor :warnings
+
+    # The list of errors found by hlint in JSON format
+    #
+    # @return [String]
+    attr_accessor :errors
+
     # Runs hlint on a list of files
     #
     # @return  [void]
-    def lint(files, inline_mode=false, options={})
+    def lint(files, inline_mode = false, options = {})
+      final_options = options.merge(json: true)
 
-      final_options = options.merge({ json: true })
-
       issues = files
-                .map { |file| Shellwords.escape(file) }
-                .map { |file| `hlint lint #{file} #{to_hlint_options(final_options)} 2>/dev/null`}
-                .reject { |s| s == '' }
-                .map { |lint_result| JSON.parse(lint_result).flatten }
-                .flatten
+               .map { |file| Shellwords.escape(file) }
+               .map { |file| `hlint lint #{file} #{to_hlint_options(final_options)} 2>/dev/null` }
+               .reject { |s| s == '' }
+               .map { |lint_result| JSON.parse(lint_result).flatten }
+               .flatten
 
-      suggestions = issues.select { |issue| issue['severity'] == 'Suggestion' }
-      warnings = issues.select { |issue| issue['severity'] == 'Warning' }
-      errors = issues.select { |issue| issue['severity'] == 'Error' }
+      self.suggestions = issues.select { |issue| issue['severity'] == 'Suggestion' }
+      self.warnings = issues.select { |issue| issue['severity'] == 'Warning' }
+      self.errors = issues.select { |issue| issue['severity'] == 'Error' }
 
       if inline_mode
         # Reprt with inline comment
-        send_inline_comment(suggestions, "warn")
-        send_inline_comment(warnings, "warn")
-        send_inline_comment(errors, "fail")
+        send_inline_comment(suggestions, 'warn')
+        send_inline_comment(warnings, 'warn')
+        send_inline_comment(errors, 'fail')
 
       else
         # Report if any suggestions, warnings or errors
         if suggestions.count > 0 || warnings.count > 0 || errors.count > 0
           message = "### hlint found issues\n\n"
@@ -57,49 +57,48 @@
           message << markdown_issues(warnings, 'Warnings') unless warnings.empty?
           message << markdown_issues(errors, 'Errors') unless errors.empty?
           markdown message
         end
       end
-
     end
 
-    def markdown_issues (results, heading)
+    def markdown_issues(results, heading)
       message = "#### #{heading}\n\n"
 
       message << "File | Line  | Hint | Found | Suggested\n"
       message << "| --- | ----- | ----- | ----- | ----- |\n"
 
       results.each do |r|
         filename = r['file'].split('/').last
         line = r['startLine']
         hint = r['hint']
-        from = r['from'].gsub("\n", "<br />")
-        to   = r['to'].gsub("\n", "<br />")
+        from = r['from'].gsub("\n", '<br />')
+        to   = r['to'].gsub("\n", '<br />')
 
         message << "#{filename} | #{line} | #{hint} | #{from} | #{to}\n"
       end
 
       message
     end
 
-    def send_inline_comment (results, method)
-          dir = "#{Dir.pwd}/"
-          results.each do |r|
-            filename = r['file'].gsub(dir, "")
+    def send_inline_comment(results, method)
+      dir = "#{Dir.pwd}/"
+      results.each do |r|
+        filename = r['file'].gsub(dir, '')
 
-            prompt = r['severity'] == 'Suggestion' || r['severity'] == 'Warning' ? "Why Not" : ""
-            prompt = r['severity'] == 'Error' ? "Error description" : prompt
+        prompt = r['severity'] == 'Suggestion' || r['severity'] == 'Warning' ? 'Why Not' : ''
+        prompt = r['severity'] == 'Error' ? 'Error description' : prompt
 
-            message = "Found #{r['hint']}\n\n```haskell\n#{r['from']}\n``` \n\n #{prompt} \n\n ```haskell\n#{r['to']}\n```"
-            send(method, message, file: filename, line: r['startLine'])
-          end
+        message = "Found #{r['hint']}\n\n```haskell\n#{r['from']}\n``` \n\n #{prompt} \n\n ```haskell\n#{r['to']}\n```"
+        send(method, message, file: filename, line: r['startLine'])
+      end
     end
 
-    def to_hlint_options(options={})
+    def to_hlint_options(options = {})
       options.
         # filter not null
-        select {|key, value| !value.nil?}.
+        reject { |_key, value| value.nil? }.
         # map booleans arguments equal true
         map { |key, value| value.is_a?(TrueClass) ? [key, ''] : [key, value] }.
         # map booleans arguments equal false
         map { |key, value| value.is_a?(FalseClass) ? ["no-#{key}", ''] : [key, value] }.
         # replace underscore by hyphen
@@ -111,8 +110,7 @@
         # strip leading spaces
         strip
     end
 
     private :send_inline_comment, :to_hlint_options, :markdown_issues
-
   end
 end