danger-hlint 0.0.2

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+.idea/
+.yardoc

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+script:
+    - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-hlint.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Tommaso Piazza <tommaso.piazza@gmail.com>
+
+MIT License
+
+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,57 @@
+# Danger HLint [![Gem Version](https://badge.fury.io/rb/danger-hlint.svg)](https://badge.fury.io/rb/danger-hlint)
+
+A Danger plugin for [HLint](https://github.com/ndmitchell/hlint)
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'danger-hlint'
+```
+
+## Usage
+
+Methods and attributes from this plugin are available in
+your `Dangerfile` under the `hlint` namespace.
+
+At the moment one single method is exposed: `hlint.lint`
+
+If you want the lint results to show in the diff instead of in the comments, you can use then `inline_mode` option.
+Violations that occur out of the diff will show in danger's fail or warn section.
+
+```ruby
+hlint.lint files inline_mode: true
+```
+
+To pass other parameters to the linter just add them to the method call. The
+names and values of the parameters to the `hlint.lint` method are handed over to linter.
+
+For example, you can specify a hint file by calling
+
+```ruby
+hlint.lint files hint: ".hlint.yaml"
+```
+
+To pass switches to the linter (like `--quiet`) specify `true` as the value in the call
+
+```ruby
+hlint.lint files quiet: true
+```
+
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.
+
+## Attribution
+
+Some methods and ideas are almost copied unchanged from [Danger SwiftLint](https://github.com/ashfurrow/danger-swiftlint)
+
+## License
+
+danger-hlint is released under MIT License

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-hlint.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hlint/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-hlint'
+  spec.version       = Hlint::VERSION
+  spec.authors       = ['Tommaso Piazza']
+  spec.email         = ['tommaso.piazza@gmail.com']
+  spec.description   = %q{A plugin for Danger System to run hlint.}
+  spec.summary       = %q{A plugin for Danger System to run hlint.}
+  spec.homepage      = 'https://github.com/blender/danger-hlint'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # Linting code and docs
+  spec.add_development_dependency "rubocop", "~> 0.41"
+  spec.add_development_dependency "yard", "~> 0.8"
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/danger_hlint.rb

@@ -0,0 +1 @@
+require 'hlint/gem_version'

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require 'hlint/plugin'

data/lib/hlint/gem_version.rb

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

data/lib/hlint/plugin.rb

@@ -0,0 +1,118 @@
+require 'shellwords'
+
+module Danger
+  # This is your plugin class. Any attributes or methods you expose here will
+  # be available from within your Dangerfile.
+  #
+  # 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`.
+  #
+  # 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
+  #
+  # @see  blender/danger-hlint
+  # @tags monday, weekends, time, rattata
+  #
+  class DangerHlint < Plugin
+
+    # The path to the hint/ignore file used by hlint
+    #
+    # @return   [String]
+    attr_accessor :config_file
+
+    # Runs hlint on a list of files
+    #
+    # @return  [void]
+    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
+
+      suggestions = issues.select { |issue| issue['severity'] == 'Suggestion' }
+      warnings = issues.select { |issue| issue['severity'] == 'Warning' }
+      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")
+
+      else
+        # Report if any suggestions, warnings or errors
+        if suggestions.count > 0 || warnings.count > 0 || errors.count > 0
+          message = "### hlint found issues\n\n"
+          message << markdown_issues(warnings, 'Suggestions') unless suggestions.empty?
+          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)
+      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 />")
+
+        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, "")
+
+            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
+    end
+
+    def to_hlint_options(options={})
+      options.
+        # filter not null
+        select {|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
+        map { |key, value| [key.to_s.tr('_', '-'), value] }.
+        # prepend '--' into the argument
+        map { |key, value| ["--#{key}", value] }.
+        # reduce everything into a single string
+        reduce('') { |args, option| "#{args} #{option[0]} #{option[1]}" }.
+        # strip leading spaces
+        strip
+    end
+
+    private :send_inline_comment, :to_hlint_options, :markdown_issues
+
+  end
+end

data/spec/fixtures/HaskellTestFile.hs

@@ -0,0 +1,6 @@
+module HaskellTestFile where
+
+
+
+foo :: [[a]] -> [a]
+foo xs = concat (map id xs)

data/spec/hlint_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module Danger
+  describe Danger::DangerHlint do
+    it 'should be a plugin' do
+      expect(Danger::DangerHlint.new(nil)).to be_a Danger::Plugin
+    end
+
+    #
+    # You should test your custom attributes and methods here
+    #
+    describe 'with Dangerfile' do
+      before do
+        @dangerfile = testing_dangerfile
+        @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)
+
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$:.unshift((ROOT + 'lib').to_s)
+$:.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'pry'
+
+require 'rspec'
+require 'danger'
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require 'danger_plugin'
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    'HAS_JOSH_K_SEAL_OF_APPROVAL' => 'true',
+    'TRAVIS_PULL_REQUEST' => '800',
+    'TRAVIS_REPO_SLUG' => 'artsy/eigen',
+    'TRAVIS_COMMIT_RANGE' => '759adcbd0d8f...13c4dc8bb61d',
+    'DANGER_GITHUB_API_TOKEN' => '123sbdq54erfsd3422gdfio'
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: danger-hlint
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tommaso Piazza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A plugin for Danger System to run hlint.
+email:
+- tommaso.piazza@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-hlint.gemspec
+- lib/danger_hlint.rb
+- lib/danger_plugin.rb
+- lib/hlint/gem_version.rb
+- lib/hlint/plugin.rb
+- spec/fixtures/HaskellTestFile.hs
+- spec/hlint_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/blender/danger-hlint
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A plugin for Danger System to run hlint.
+test_files:
+- spec/fixtures/HaskellTestFile.hs
+- spec/hlint_spec.rb
+- spec/spec_helper.rb