danger-hlint 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f714598e5fe9ebdbed959a92bacb4772deb26787
-  data.tar.gz: 8806ceb2b76218caf2f1058ce46e0fe60dbfe5f2
+  metadata.gz: bd14c1da49d7c97a0f54878aa2ad2e3f9d7b7485
+  data.tar.gz: 0e03a82a957390f5cef8b47b2e31559d684cbb8d
 SHA512:
-  metadata.gz: 5ee44c558bd05a2e3467f010efdd34e3e7579496dc59a31e790508569e7bc8112b54a7a43412e9867b2ae8af9d347478ee189e41f2396ff4a6985c2460a7beb3
-  data.tar.gz: 9bf3bdd6d17cd7e507d31119603f8bfc3b2805bbb88d9bd6a026d29896d8e86075268d52383581020bc1ba2887f572cd3a071073c622d09e037f92945fb3d4bb
+  metadata.gz: 4ba752949ec302c3244e0417fc18739231e939cce135c4a77f0041208a9134a316382435634464bcd3c1d702ac9d1ccf6ad392cd5b006e3d0131097f2b045b09
+  data.tar.gz: 4cd241884902f3faa17c8c7764fdedcbbed6998f6d734f035995856a49723c3be76e58bdb4260c80525277e65ff19fe97961cba8dcaf88d943487eda6ab74809

data/lib/hlint/gem_version.rb

@@ -1,3 +1,3 @@
 module Hlint
-  VERSION = "0.0.2".freeze
+  VERSION = '0.0.3'.freeze
 end

data/lib/hlint/plugin.rb

@@ -1,53 +1,53 @@
 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.
-  #
-  # @example Ensure people are well warned about merging on Mondays
-  #
-  #          danger_hlint.warn_on_mondays
+  #          danger_hlint.lint(["Lib.hs"], inline_mode: true:
   #
   # @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={})
-
-      final_options = options.merge({ json: true })
+    def lint(files, inline_mode = false, options = {})
+      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
@@ -59,10 +59,9 @@ module Danger
           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"
@@ -72,8 +71,8 @@ module Danger
         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
@@ -81,23 +80,23 @@ module Danger
       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
@@ -113,6 +112,5 @@ module Danger
     end
 
     private :send_inline_comment, :to_hlint_options, :markdown_issues
-
   end
 end

data/spec/hlint_spec.rb

@@ -15,22 +15,15 @@ module Danger
         @hlint = @dangerfile.hlint
         allow(@hlint.git).to receive(:added_files).and_return([])
         allow(@hlint.git).to receive(:modified_files).and_return([])
-
-        @hlint_response = '[{"module":"HaskellTestFile","decl":"foo","severity":"Warning","hint":"Use concatMap","file":"./HaskellTestFile.hs","startLine":6,"startColumn":10,"endLine":6,"endColumn":28,"from":"concat (map id xs)","to":"concatMap id xs","note":[],"refactorings":"[Replace {rtype = Expr, pos = SrcSpan {startLine = 6, startCol = 10, endLine = 6, endCol = 28}, subts = [(\"f\",SrcSpan {startLine = 6, startCol = 22, endLine = 6, endCol = 24}),(\"x\",SrcSpan {startLine = 6, startCol = 25, endLine = 6, endCol = 27})], orig = \"concatMap f x\"}]"}
-,{"module":"HaskellTestFile","decl":"foo","severity":"Warning","hint":"Use id","file":"./HaskellTestFile.hs","startLine":6,"startColumn":18,"endLine":6,"endColumn":24,"from":"map id","to":"id","note":[],"refactorings":"[Replace {rtype = Expr, pos = SrcSpan {startLine = 6, startCol = 18, endLine = 6, endCol = 24}, subts = [], orig = \"id\"}]"}]'
-
       end
 
       # Some examples for writing tests
       # You should replace these with your own.
 
-      it "collects Warnings" do
-        expect(DangerHlint).to receive(:lint)
-          .with(File.expand_path('spec/fixtures/HaskellTestFile.hs'), hash_including(:inline_mode => true))
-          .and_return(@hlint_response)
-
+      it 'collects Warnings' do
+        @hlint.lint([File.expand_path('spec/fixtures/HaskellTestFile.hs')], inline_mode: true)
+        expect(@hlint.warnings).to all(include('severity' => 'Warning'))
       end
-
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require 'pathname'
 ROOT = Pathname.new(File.expand_path('../../', __FILE__))
-$:.unshift((ROOT + 'lib').to_s)
-$:.unshift((ROOT + 'spec').to_s)
+$LOAD_PATH.unshift((ROOT + 'lib').to_s)
+$LOAD_PATH.unshift((ROOT + 'spec').to_s)
 
 require 'bundler/setup'
 require 'pry'
@@ -11,7 +11,7 @@ require 'danger'
 
 # Use coloured output, it's the best.
 RSpec.configure do |config|
-  config.filter_gems_from_backtrace "bundler"
+  config.filter_gems_from_backtrace 'bundler'
   config.color = true
   config.tty = true
 end
@@ -34,7 +34,7 @@ def testing_ui
 
   cork = Cork::Board.new(out: @output)
   def cork.string
-    out.string.gsub(/\e\[([;\d]+)?m/, "")
+    out.string.gsub(/\e\[([;\d]+)?m/, '')
   end
   cork
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-hlint
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tommaso Piazza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
+date: 2017-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api