danger-ormolu 0.0.1

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-ormolu.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,149 @@
+PATH
+  remote: .
+  specs:
+    danger-ormolu (0.0.1)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    claide (1.0.3)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.3)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (8.2.2)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.4.4)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    faraday-net_http (1.0.1)
+    ffi (1.14.2)
+    formatador (0.2.5)
+    git (1.8.1)
+      rchardet (~> 1.8)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.20.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rchardet (1.8.0)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.9.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    terminal-table (1.6.0)
+    thor (1.1.0)
+    unicode-display_width (2.0.0)
+    yard (0.9.26)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  danger-ormolu!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop
+  yard
+
+BUNDLED WITH
+   2.1.4

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,15 @@
+ISC License
+
+Copyright (c) 2021, Gautier DI FOLCO <gautier.difolco@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# danger-ormolu
+
+A danger plugin for the Haskell code formatter ormolu
+
+## Installation
+
+    $ gem install danger-ormolu
+
+## Usage
+Be sure to have `ormolu` and `diff` in your `PATH`, include it in your `Gemfile`:
+
+```
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# gem "rails"
+gem 'danger'
+gem 'danger-ormolu'
+```
+
+Finally use this line in your `Dangerfile`:
+
+```
+# get all affected files by the changes in the current diff
+affected_files = git.added_files + git.modified_files
+
+# limit files to .hs files
+haskell_files = affected_files.select { |file| file.end_with?('.hs') }
+
+ormolu.check haskell_files
+```
+    Methods and attributes from this plugin are available in
+    your `Dangerfile` under the `ormolu` namespace.
+
+## 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.

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-ormolu.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ormolu/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-ormolu'
+  spec.version       = Ormolu::VERSION
+  spec.authors       = ['Gautier DI FOLCO']
+  spec.email         = ['gautier.difolco@gmail.com']
+  spec.description   = %q{A danger plugin for ormolu}
+  spec.summary       = %q{A danger plugin for the Haskell code formatter ormolu}
+  spec.homepage      = 'https://github.com/blackheaven/danger-ormolu'
+  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', '~> 2.0'
+  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"
+  spec.add_development_dependency "yard"
+
+  # 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_ormolu.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'ormolu/gem_version'

data/lib/danger_plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'ormolu/plugin'

data/lib/ormolu/gem_version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ormolu
+  VERSION = '0.0.1'
+end

data/lib/ormolu/plugin.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Danger
+  # Lint haskell files against ormolu formatting
+  #
+  # @example Ensure the files are correctly formatted
+  #
+  #          ormolu.check files
+  #
+  # @see  blackheaven/danger-ormolu
+  # @tags haskell, formatting, ormolu
+  #
+  class DangerOrmolu < Plugin
+    # Check that the files are correctly formatted
+    # @param files [Array<String>]
+    # @return [void]
+    #
+    def check(files)
+      files
+        .each do |file|
+          result = `ormolu --mode stdout --check-idempotence "#{file}" | diff "#{file}" -`
+          next if result.empty?
+
+          extract_diffs(result.lines)
+            .each do |diff|
+              inconsistence(file, diff[:line], diff[:diff])
+            end
+        end
+    end
+
+    private
+
+    def inconsistence(file, line, diff)
+      message = "Style error, fix it through \n\n```haskell\n#{diff}\n``` \n"
+      warn(message, file: file, line: line)
+    end
+
+    def extract_diffs(lines)
+      lines
+        .reverse
+        .slice_when { |l| l =~ /^\d.*/ }
+        .to_a
+        .map(&:reverse)
+        .reverse
+        .map do |chunk|
+          { line: chunk.first[/^\d+/].to_i, diff: chunk.flatten }
+        end
+    end
+  end
+end

data/spec/fixtures/HaskellTestFile.hs

@@ -0,0 +1,16 @@
+module Main where
+
+-- | Here we have 'Foo'.
+
+data Foo
+  =
+  -- | One
+    Foo
+  |
+  -- | Two
+    Bar Int
+  |
+  -- | Three
+    Baz
+  deriving
+    (Eq, Show)

data/spec/ormolu_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require File.expand_path('spec_helper', __dir__)
+
+module Danger
+  describe Danger::DangerOrmolu do
+    it 'should be a plugin' do
+      expect(Danger::DangerOrmolu.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
+        @ormolu = @dangerfile.ormolu
+        allow(@ormolu.git).to receive(:added_files).and_return([])
+        allow(@ormolu.git).to receive(:modified_files).and_return([])
+      end
+
+      # Some examples for writing tests
+      # You should replace these with your own.
+
+      it 'collects Warnings' do
+        expect(@ormolu).to receive(:warn).exactly(4).times
+        @ormolu.check([File.expand_path('spec/fixtures/HaskellTestFile.hs')])
+      end
+    end
+  end
+end