danger-swiftformat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 129504b9697fb37eb0dc46c0f2f2852667119e7f
+  data.tar.gz: bc8d5744ddb99d28de270ebfee1244b58e9dcd44
+SHA512:
+  metadata.gz: eab4ef630332a2551cb8d75b61a9d60bb57b5e8d1f9d93e7f68d32841b9581aacfa93072cf672c9f35d3e0ed6782ca9ab9d90bfc732cff364d0eead0d76603b3
+  data.tar.gz: 79038b5585e8150badcc6a4f46e1b758cbb4217e61e5de0308650c97d2d78a6d2cb9a451f913b58ae1ffb1e22dd17c622cc0e2653edb0ae64da57cb1adeba66c

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,152 @@
+# Defaults can be found here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+# If you don't like these settings, just delete this file :)
+
+AllCops:
+  TargetRubyVersion: 2.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# It's better to be more explicit about the type
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Layout/IndentHash:
+  Enabled: false
+
+Layout/AlignHash:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Layout/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 350
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# danger specific
+
+Style/BlockComments:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# FIXME: 25
+Metrics/BlockLength:
+  Max: 345
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/MixinGrouping:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%":  ()
+    "%i": ()
+    "%q": ()
+    "%Q": ()
+    "%r": "{}"
+    "%s": ()
+    "%w": ()
+    "%W": ()
+    "%x": ()
+
+Security/YAMLLoad:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2
+
+script:
+    - bundle exec rake spec

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,136 @@
+PATH
+  remote: .
+  specs:
+    danger-swiftformat (0.0.1)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.3.0)
+    claide (1.0.2)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.2)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (5.5.5)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 1.0)
+      git (~> 1)
+      kramdown (~> 1.5)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.3)
+    faraday (0.13.1)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.1)
+      faraday (~> 0.8)
+    ffi (1.9.18)
+    formatador (0.2.5)
+    git (1.3.0)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.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 (1.16.2)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    method_source (0.9.0)
+    multipart-post (2.0.0)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.7.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.1)
+    rainbow (3.0.0)
+    rake (12.3.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.52.0)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    ruby_dep (1.5.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    shellany (0.0.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (0.20.0)
+    unicode-display_width (1.3.0)
+    yard (0.9.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  danger-swiftformat!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (~> 3.1)
+  pry
+  rake (~> 12.3)
+  rspec (~> 3.7)
+  rubocop (~> 0.52)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   1.16.0

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 Vincent Garrigues <vincent.garrigues@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,34 @@
+# danger-swiftformat [![Build Status](https://travis-ci.org/garriguv/danger-ruby-swiftformat.svg?branch=master)](https://travis-ci.org/garriguv/danger-ruby-swiftformat)
+
+A [danger] plugin to check Swift formatting using [SwiftFormat].
+
+This plugin is heavily inspired by [danger-swiftlint].
+
+## Installation
+
+    $ gem install danger-swiftformat
+
+## Usage
+
+Add the following to your `Gemfile`
+
+    require 'danger-swiftformat'
+
+In your `Dangerfile`
+
+```ruby
+swiftformat.binary_path = "/path/to/swiftformat" # optional, but recommended ;)
+swiftformat.check_format(fail_on_error: 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.
+
+[danger]: https://danger.systems/ruby/
+[SwiftFormat]: https://github.com/nicklockwood/SwiftFormat
+[danger-swiftlint]: https://github.com/ashfurrow/danger-ruby-swiftlint

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: :spec
+
+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 = %w(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-swiftformat.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swiftformat/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-swiftformat'
+  spec.version       = Swiftformat::VERSION
+  spec.authors       = ['Vincent Garrigues']
+  spec.email         = ['vincent.garrigues@gmail.com']
+  spec.description   = %q{A danger plugin for checking Swift formatting using SwiftFormat.}
+  spec.summary       = %q{A danger plugin for checking Swift formatting using SwiftFormat.}
+  spec.homepage      = 'https://github.com/garriguv/danger-swiftformat'
+  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.16'
+  spec.add_development_dependency 'rake', '~> 12.3'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.7'
+
+  # Linting code and docs
+  spec.add_development_dependency "rubocop", "~> 0.52"
+  spec.add_development_dependency "yard", "~> 0.9"
+
+  # 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.1'
+
+  # 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_plugin.rb

@@ -0,0 +1,3 @@
+require "swiftformat/plugin"
+require "swiftformat/swiftformat"
+require "swiftformat/cmd"

data/lib/danger_swiftformat.rb

@@ -0,0 +1 @@
+require "swiftformat/gem_version"

data/lib/swiftformat/cmd.rb

@@ -0,0 +1,9 @@
+module Danger
+  class Cmd
+    def self.run(cmd)
+      stdout, _stderr, _status = Open3.capture3(*cmd)
+
+      stdout.strip
+    end
+  end
+end

data/lib/swiftformat/gem_version.rb

@@ -0,0 +1,3 @@
+module Swiftformat
+  VERSION = "0.0.1".freeze
+end

data/lib/swiftformat/plugin.rb

@@ -0,0 +1,70 @@
+module Danger
+  # A danger plugin to check Swift formatting using SwiftFormat.
+  #
+  # @example Check that the added and modified files are properly formatted:
+  #
+  #          swiftformat.check_format
+  #
+  # @see  garriguv/danger-swiftformat
+  # @tags swiftformat
+  #
+  class DangerSwiftformat < Plugin
+    # The path to SwiftFormat's executable
+    #
+    # @return [String]
+    attr_accessor :binary_path
+
+    # Runs swiftformat
+    #
+    # @param [Boolean] fail_on_error
+    #
+    # @return [void]
+    #
+    def check_format(fail_on_error: false)
+      # Check if SwiftFormat is installed
+      raise "Could not find SwiftFormat executable" unless swiftformat.installed?
+
+      # Find Swift files
+      swift_files = find_swift_files
+
+      # Run swiftformat
+      results = swiftformat.check_format(swift_files)
+
+      # Stop processing if the errors array is empty
+      return if results[:errors].empty?
+
+      # Process the errors
+      message = "### SwiftFormat found issues:\n\n"
+      message << "| File | Rules |\n"
+      message << "| ---- | ----- |\n"
+      results[:errors].each do |error|
+        message << "| #{error[:file]} | #{error[:rules].join(', ')} |\n"
+      end
+      markdown message
+
+      if fail_on_error
+        fail "SwiftFormat found issues"
+      end
+    end
+
+    # Find the files on which SwiftFormat should be run
+    #
+    # @return [Array<String]
+    def find_swift_files
+      files = (git.modified_files - git.deleted_files) + git.added_files
+
+      files
+        .select { |file| file.end_with?(".swift") }
+        .map { |file| Shellwords.escape(file) }
+        .uniq
+        .sort
+    end
+
+    # Constructs the SwiftFormat class
+    #
+    # @return [SwiftFormat]
+    def swiftformat
+      @swiftformat ||= SwiftFormat.new(binary_path)
+    end
+  end
+end

data/lib/swiftformat/swiftformat.rb

@@ -0,0 +1,48 @@
+module Danger
+  class SwiftFormat
+    def initialize(path = nil)
+      @path = path || "swiftformat"
+    end
+
+    def installed?
+      Cmd.run([@path, "--version"])
+    end
+
+    def check_format(files)
+      output = Cmd.run([@path] + files + %w(--dryrun --verbose))
+      raise "error running swiftformat: empty output" if output.empty?
+      process(output)
+    end
+
+    private
+
+    def process(output)
+      {
+          errors: errors(output),
+          stats: {
+              run_time: run_time(output)
+          }
+      }
+    end
+
+    ERRORS_REGEX = /rules applied:(.*)\n.*updated (.*)$/
+
+    def errors(output)
+      errors = []
+      output.scan(ERRORS_REGEX) do |match|
+        next if match.count < 2
+        errors << {
+            file: match[1],
+            rules: match[0].split(",").map(&:strip)
+        }
+      end
+      errors
+    end
+
+    RUNTIME_REGEX = /.*swiftformat completed.*(.+\..+)s/
+
+    def run_time(output)
+      RUNTIME_REGEX.match(output)[1]
+    end
+  end
+end

data/spec/fixtures/swiftformat_output.txt

@@ -0,0 +1,9 @@
+running swiftformat...
+formatting /Users/garriguv/FirstClass.swift
+-- no changes
+formatting /Users/garriguv/FileWithErrors.swift
+-- no changes
+formatting /Users/garriguv/OtherFile.swift
+-- no changes
+
+swiftformat completed. 0/3 files would have been updated in 0.08s

data/spec/fixtures/swiftformat_output_with_errors.txt

@@ -0,0 +1,10 @@
+running swiftformat...
+formatting /Users/garriguv/FirstClass.swift
+-- no changes
+formatting /Users/garriguv/FileWithErrors.swift
+ -- rules applied: consecutiveBlankLines, spaceAroundParens, trailingSpace
+would have updated /Users/garriguv/FileWithErrors.swift
+formatting /Users/garriguv/OtherFile.swift
+-- no changes
+
+swiftformat completed. 1/3 files would have been updated in 0.08s

data/spec/spec_helper.rb

@@ -0,0 +1,69 @@
+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"
+
+if `git remote -v` == ""
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# 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
+
+def fixture(name)
+  File.open("spec/fixtures/#{name}", "r", &:read)
+end

data/spec/swiftformat/plugin_spec.rb

@@ -0,0 +1,83 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+module Danger
+  describe Danger::DangerSwiftformat do
+    it "should be a plugin" do
+      expect(Danger::DangerSwiftformat.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe "with Dangerfile" do
+      before do
+        @dangerfile = testing_dangerfile
+        @sut = @dangerfile.swiftformat
+      end
+
+      it "fails if SwiftFormat is not installed" do
+        allow_any_instance_of(SwiftFormat).to receive(:installed?).and_return(false)
+
+        expect { @sut.check_format }.to raise_error("Could not find SwiftFormat executable")
+      end
+
+      context "with binary_path" do
+        let(:binary_path) { "path/to/swiftformat" }
+
+        it "passes the binary_path to the constructor" do
+          swiftformat = double("swiftformat")
+          allow(SwiftFormat).to receive(:new).with(binary_path).and_return(swiftformat)
+
+          @sut.binary_path = binary_path
+
+          expect(@sut.swiftformat).to eq(swiftformat)
+        end
+      end
+
+      describe "#check_format" do
+        let(:success_output) { { errors: [], stats: { run_time: "0.08s" } } }
+        let(:error_output) { { errors: [{ file: "Modified.swift", rules: %w(firstRule secondRule) }], stats: { run_time: "0.16s" } } }
+
+        before do
+          allow_any_instance_of(SwiftFormat).to receive(:installed?).and_return(true)
+          allow(@sut.git).to receive(:added_files).and_return(["Added.swift"])
+          allow(@sut.git).to receive(:modified_files).and_return(["Modified.swift"])
+          allow(@sut.git).to receive(:deleted_files).and_return(["Deleted.swift"])
+        end
+
+        context "when swiftformat does not find any errors" do
+          before do
+            allow_any_instance_of(SwiftFormat).to receive(:check_format).with(%w(Added.swift Modified.swift)).and_return(success_output)
+          end
+
+          it "should not do anything" do
+            @sut.check_format(fail_on_error: true)
+
+            status = @sut.status_report
+            expect(status[:errors]).to be_empty
+            expect(status[:markdowns]).to be_empty
+          end
+        end
+
+        context "when swiftformat finds errors" do
+          before do
+            allow_any_instance_of(SwiftFormat).to receive(:check_format).with(%w(Added.swift Modified.swift)).and_return(error_output)
+          end
+
+          it "should output some markdown and error if fail_on_error is true" do
+            @sut.check_format(fail_on_error: true)
+
+            status = @sut.status_report
+            expect(status[:errors]).to_not be_empty
+            expect(status[:markdowns]).to_not be_empty
+          end
+
+          it "should output some markdown and not error if fail_on_error is false" do
+            @sut.check_format(fail_on_error: false)
+
+            status = @sut.status_report
+            expect(status[:errors]).to be_empty
+            expect(status[:markdowns]).to_not be_empty
+          end
+        end
+      end
+    end
+  end
+end

data/spec/swiftformat/swiftformat_spec.rb

@@ -0,0 +1,87 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+RSpec.describe Danger::SwiftFormat do
+  describe "#installed?" do
+    context "when no path is given" do
+      it "should use the default path" do
+        sut = Danger::SwiftFormat.new
+        cmd = class_double("Danger::Cmd").as_stubbed_const(transfer_nested_constants: true)
+
+        expect(cmd).to receive(:run).with(%w(swiftformat --version))
+
+        sut.installed?
+      end
+    end
+
+    context "when path provided" do
+      let(:path) { "/path/to/swiftformat" }
+
+      it "should use the provided path" do
+        sut = Danger::SwiftFormat.new(path)
+        cmd = class_double("Danger::Cmd").as_stubbed_const(transfer_nested_constants: true)
+
+        expect(cmd).to receive(:run).with(%w(/path/to/swiftformat --version))
+
+        sut.installed?
+      end
+    end
+  end
+
+  describe "#check_format" do
+    before do
+      @sut = Danger::SwiftFormat.new
+      @cmd = class_double("Danger::Cmd").as_stubbed_const(transfer_nested_constants: true)
+    end
+
+    it "should run swiftformat on the specified files" do
+      files = %w(/path/to/file.swift /path/to/directory/)
+      expect(@cmd).to receive(:run)
+        .with(%w(swiftformat /path/to/file.swift /path/to/directory/ --dryrun --verbose))
+        .and_return(fixture("swiftformat_output.txt"))
+
+      @sut.check_format(files)
+    end
+
+    it "should return a formatted output including rules when there are errors" do
+      expect(@cmd).to receive(:run)
+        .with(%w(swiftformat . --dryrun --verbose))
+        .and_return(fixture("swiftformat_output_with_errors.txt"))
+
+      output = {
+          errors: [
+            {
+                file: "/Users/garriguv/FileWithErrors.swift",
+                rules: %w(consecutiveBlankLines spaceAroundParens trailingSpace)
+            }
+          ],
+          stats: {
+              run_time: "0.08"
+          }
+      }
+      expect(@sut.check_format(%w(.))).to eq(output)
+    end
+
+    it "should also return a formatted output if there were no errors" do
+      expect(@cmd).to receive(:run)
+        .with(%w(swiftformat . --dryrun --verbose))
+        .and_return(fixture("swiftformat_output.txt"))
+
+      output = {
+          errors: [],
+          stats: {
+              run_time: "0.08"
+          }
+      }
+
+      expect(@sut.check_format(%w(.))).to eq(output)
+    end
+
+    it "should raise an error if the output is empty" do
+      expect(@cmd).to receive(:run)
+        .with(%w(swiftformat . --dryrun --verbose))
+        .and_return("")
+
+      expect { @sut.check_format(%w(.)) }.to raise_error("error running swiftformat: empty output")
+    end
+  end
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: danger-swiftformat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vincent Garrigues
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-21 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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !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 danger plugin for checking Swift formatting using SwiftFormat.
+email:
+- vincent.garrigues@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-swiftformat.gemspec
+- lib/danger_plugin.rb
+- lib/danger_swiftformat.rb
+- lib/swiftformat/cmd.rb
+- lib/swiftformat/gem_version.rb
+- lib/swiftformat/plugin.rb
+- lib/swiftformat/swiftformat.rb
+- spec/fixtures/swiftformat_output.txt
+- spec/fixtures/swiftformat_output_with_errors.txt
+- spec/spec_helper.rb
+- spec/swiftformat/plugin_spec.rb
+- spec/swiftformat/swiftformat_spec.rb
+homepage: https://github.com/garriguv/danger-swiftformat
+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.13
+signing_key: 
+specification_version: 4
+summary: A danger plugin for checking Swift formatting using SwiftFormat.
+test_files:
+- spec/fixtures/swiftformat_output.txt
+- spec/fixtures/swiftformat_output_with_errors.txt
+- spec/spec_helper.rb
+- spec/swiftformat/plugin_spec.rb
+- spec/swiftformat/swiftformat_spec.rb