danger-swiftlint 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ab53ea91e7386c252bd97c2ed1eb870cc15cd49
-  data.tar.gz: 0005c7f2952722f6900127a316a2a92c57ba7aca
+  metadata.gz: 45256bbc01984eff36a6cf720d67107645266af9
+  data.tar.gz: 240ceace20e2aa1fc123af81b818843c16dcf2ed
 SHA512:
-  metadata.gz: 07b86f7d1fcb2a48a328d79f97f22d7a8abbf20e3026b7c51704f20f8c6eddb978dea223bfbca99dbccb881deb2e829a16c3b5219ea2e9fd5f4050306c8c8ddf
-  data.tar.gz: 1ff32813a484950a474c56e0ba786842c6e9e592eb4f233eab459fb79291942c7692476d14d1b924351a08e1f7cae43fb81e4d05f59e28936dc96c263f101c10
+  metadata.gz: 9b0169c3e7df727a1f5b00bc6199c95342ab4ab6aabc7662af24a3235074de8154624cf753260d9c191b2d2adc11cc0e873c6551562c54976315a53431768a46
+  data.tar.gz: 1471ed2849802043844808db74261b518dafe17cc76e82b240092751279b4ce9f5ca834526bc46020c790f24bf8ac1ba254670b93008643c833c74ff6bfa26cc

data/.gitignore

@@ -1,3 +1,6 @@
+# Swiftlint extension binary but keep the bin folder
+ext/swiftlint/bin
+
 *.gem
 *.rbc
 /.config

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0-p247
+2.3.0

data/Changelog.md

@@ -2,7 +2,15 @@
 
 ## Current Master
 
-- Nothing yet!
+## 0.4.0
+
+- Support for inline comments. See [#29](https://github.com/ashfurrow/danger-swiftlint/issues/28)
+
+- Adds SwiftLint installation as part of the gem install process, should make
+  it easier to track which upstream fixes should or shouldn't be done by
+  danger-swiftlint. See [#25](https://github.com/ashfurrow/danger-swiftlint/issues/25)
+
+- Add `danger-swiftlint` CLI, with `swiftlint_version` command to print the version of the SwiftLint binary installed by the plugin. See [#32](https://github.com/ashfurrow/danger-swiftlint/pull/32)
 
 ## 0.3.0
 

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    danger-swiftlint (0.3.0)
+    danger-swiftlint (0.4.0)
       danger
+      rake (~> 10.0)
+      thor (~> 0.19)
 
 GEM
   remote: https://rubygems.org/
@@ -17,12 +19,13 @@ GEM
       open4 (~> 1.3)
     coderay (1.1.1)
     colored (1.2)
+    colored2 (3.1.2)
     cork (0.2.0)
       colored (~> 1.2)
-    danger (4.0.3)
+    danger (4.3.0)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
-      colored (~> 1.2)
+      colored2 (~> 3.1)
       cork (~> 0.1)
       faraday (~> 0.9)
       faraday-http-cache (~> 1.0)
@@ -31,7 +34,7 @@ GEM
       octokit (~> 4.2)
       terminal-table (~> 1)
     diff-lcs (1.2.5)
-    faraday (0.10.0)
+    faraday (0.11.0)
       multipart-post (>= 1.2, < 3)
     faraday-http-cache (1.3.1)
       faraday (~> 0.8)
@@ -52,7 +55,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    kramdown (1.13.1)
+    kramdown (1.13.2)
     listen (3.0.7)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
@@ -78,7 +81,7 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    public_suffix (2.0.4)
+    public_suffix (2.0.5)
     rake (10.5.0)
     rb-fsevent (0.9.7)
     rb-inotify (0.9.7)
@@ -104,7 +107,7 @@ GEM
     terminal-table (1.7.3)
       unicode-display_width (~> 1.1.1)
     thor (0.19.1)
-    unicode-display_width (1.1.2)
+    unicode-display_width (1.1.3)
 
 PLATFORMS
   ruby
@@ -120,8 +123,7 @@ DEPENDENCIES
   mocha-on-bacon
   prettybacon
   pry
-  rake (~> 10.0)
   rspec (~> 3.4)
 
 BUNDLED WITH
-   1.13.1
+   1.14.6

data/README.md

@@ -29,6 +29,13 @@ swiftlint.config_file = '.swiftlint.yml'
 swiftlint.lint_files
 ```
 
+If you want the lint result shows in diff instead of comment, you can use `inline_mode` option. Violations that out of the diff will show in danger's fail or warn section.
+
+```rb
+swiftlint.lint_files inline_mode: true
+```
+
+
 ## Attribution
 
 Original structure, sequence, and organization of repo taken from [danger-prose](https://github.com/dbgrandi/danger-prose) by [David Grandinetti](https://github.com/dbgrandi/).

data/Rakefile

@@ -1,3 +1,4 @@
+import 'ext/swiftlint/Rakefile'
 require 'bundler/gem_tasks'
 require "rspec/core/rake_task"
 

data/bin/danger-swiftlint

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+if $PROGRAM_NAME == __FILE__
+  $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+end
+require 'thor'
+require 'version'
+
+class DangerSwiftlintCLI < Thor
+  desc 'version', 'The version of the installed danger-swiftlint plugin'
+  def version
+    puts DangerSwiftlint::VERSION
+  end
+
+  desc 'swiftlint_version', 'The SwiftLint version used by the plugin'
+  def swiftlint_version
+    puts DangerSwiftlint::SWIFTLINT_VERSION
+  end
+end
+
+DangerSwiftlintCLI.start(ARGV)

data/danger-swiftlint.gemspec

@@ -6,8 +6,8 @@ require 'version'
 Gem::Specification.new do |spec|
   spec.name          = 'danger-swiftlint'
   spec.version       = DangerSwiftlint::VERSION
-  spec.authors       = ['Ash Furrow', 'David Grandinetti', 'Orta Therox']
-  spec.email         = ['ash@ashfurrow.com', 'dbgrandi@gmail.com', 'orta.therox@gmail.com']
+  spec.authors       = ['Ash Furrow', 'David Grandinetti', 'Orta Therox', 'Thiago Felix', 'Giovanni Lodi']
+  spec.email         = ['ash@ashfurrow.com', 'dbgrandi@gmail.com', 'orta.therox@gmail.com', 'thiago@thiagofelix.com', 'gio@mokacoding.com']
   spec.description   = %q{A Danger plugin for linting Swift with SwiftLint.}
   spec.summary       = %q{A Danger plugin for linting Swift with SwiftLint.}
   spec.homepage      = 'https://github.com/ashfurrow/danger-swiftlint'
@@ -16,12 +16,15 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split($/)
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
+  spec.extensions    = %w(ext/swiftlint/Rakefile)
+  spec.executables   = ['danger-swiftlint']
 
   spec.add_dependency 'danger'
+  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'rake', '~> 10.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'
@@ -29,12 +32,12 @@ Gem::Specification.new do |spec|
   # 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 test
-  # via 
+  # via
   #    binding.pry
   # This will stop test execution and let you inspect the results
   spec.add_development_dependency "pry"

data/ext/swiftlint/Rakefile

@@ -0,0 +1,24 @@
+require_relative '../../lib/version'
+
+namespace :swiftlint do
+
+  desc "Download and install swiftlint tool"
+  task :install do
+    REPO = "https://github.com/realm/SwiftLint"
+    VERSION = DangerSwiftlint::SWIFTLINT_VERSION
+    ASSET = "portable_swiftlint.zip"
+    URL = "#{REPO}/releases/download/#{VERSION}/#{ASSET}"
+    DESTINATION = File.expand_path(File.join(File.dirname(__FILE__), 'bin'))
+
+    puts "Downloading swiftlint@#{VERSION}"
+    sh [
+      "mkdir -p #{DESTINATION}",
+      "curl -s -L #{URL} -o #{ASSET}",
+      "unzip -q #{ASSET} -d #{DESTINATION}",
+      "rm #{ASSET}"
+    ].join(" && ")
+  end
+
+end
+
+task default: 'swiftlint:install'

data/ext/swiftlint/swiftlint.rb

@@ -0,0 +1,58 @@
+
+class Swiftlint
+  class << self
+    # Runs swiftlint
+    # @param key (Symbol) the key which is used as command paramters or key in the fastlane tools
+    # @param env_name (String) the name of the environment variable, which is only used if no other values were found
+    # @param description (String) A description shown to the user
+    # @param sensitive (Boolean) Set if the variable is sensitive, such as a password or API token, to prevent echoing when prompted for the parameter
+    def run(cmd='lint', options={})
+
+      # change pwd before run swiftlint
+      if options.has_key? :pwd
+        Dir.chdir options.delete(:pwd)
+      end
+
+      # run swiftlint with provided options
+      `#{swiftlint_path} #{cmd} #{swiftlint_arguments(options)}`
+    end
+
+    # Shortcut for running the lint command
+    def lint(options)
+      run('lint', options)
+    end
+
+    # Return true if swiftlint is installed or false otherwise
+    def is_installed?
+      File.exist?(swiftlint_path)
+    end
+
+    private
+
+    # Parse options into shell arguments how swift expect it to be
+    # more information: https://github.com/Carthage/Commandant
+    # @param options (Hash) hash containing swiftlint options
+    def swiftlint_arguments 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
+
+    # Path where swiftlint should be found
+    def swiftlint_path
+      File.expand_path(File.join(File.dirname(__FILE__), 'bin', 'swiftlint'))
+    end
+  end
+end

data/lib/danger_plugin.rb

@@ -1,3 +1,8 @@
+require 'find'
+require 'yaml'
+require 'shellwords'
+require_relative '../ext/swiftlint/swiftlint'
+
 module Danger
 
   # Lint Swift files inside your projects.
@@ -15,114 +20,115 @@ module Danger
   #
   class DangerSwiftlint < Plugin
 
-    # Allows you to specify a config file location for swiftlint.
+    # The path to SwiftLint's configuration file
     attr_accessor :config_file
 
-    # Allows you to specify a directory from where swiftlint will be run. 
+    # Allows you to specify a directory from where swiftlint will be run.
     attr_accessor :directory
 
     # Lints Swift files. Will fail if `swiftlint` cannot be installed correctly.
-    # Generates a `markdown` list of warnings for the prose in a corpus of .markdown and .md files. 
+    # Generates a `markdown` list of warnings for the prose in a corpus of .markdown and .md files.
     #
     # @param   [String] files
     #          A globbed string which should return the files that you want to lint, defaults to nil.
     #          if nil, modified and added files from the diff will be used.
     # @return  [void]
     #
-    def lint_files(files=nil)
-      # Installs SwiftLint if needed
-      system "brew install swiftlint" unless swiftlint_installed?
-
-      # Check that this is in the user's PATH after installing
-      unless swiftlint_installed?
-        fail "swiftlint is not in the user's PATH, or it failed to install"
-        return
-      end
-
-      require 'tempfile'
-      Tempfile.open('.swiftlint_danger.yml') do |temp_config_file|
-        on_the_fly_configuration_path = nil
-        excluded_dirs = []
-        if config_file
-          require 'yaml'
-          original_config = YAML.load_file(config_file)
-
-          danger_compatible_config = original_config
-          danger_compatible_config.tap { |hash| hash.delete('included') }
-
-          excluded_dirs = danger_compatible_config['excluded']
-            .map { |path| File.dirname(config_file) + '/' + path }
-            .select { |path| File.exists?(File.expand_path(path)) || Dir.exists?(File.expand_path(path)) }
-
-          File.write(temp_config_file.path, danger_compatible_config.to_yaml)
-
-          on_the_fly_configuration_path = temp_config_file.path
-        end
-
-        swiftlint_command = "swiftlint lint --quiet --reporter json"
-        swiftlint_command += " --config #{on_the_fly_configuration_path}" if on_the_fly_configuration_path
-
-        require 'json'
-
-        if directory
-          swiftlint_command = "cd #{directory} && #{swiftlint_command}" if directory
-
-          result_json = JSON.parse(`(#{swiftlint_command})`).flatten
-        else
-          # Either use files provided, or use the modified + added
-          swift_files = files ? Dir.glob(files) : (git.modified_files + git.added_files)
-
-          swift_files.select! do |line| line.end_with?(".swift") end
-
-          require 'find'
-          swift_files = swift_files.reject do |file|
-            found = false
-            excluded_dirs.each do |excluded_dir|
-              found = Find.find(File.expand_path(excluded_dir)).include?(File.expand_path(file))
-              break if found
-            end
-            found
-          end
-
-          # Make sure we don't fail when paths have spaces
-          swift_files = swift_files.map { |file| "\"#{file}\"" }
-
-          result_json = swift_files
-          .uniq
-          .collect { |f| `(#{swiftlint_command} --path #{f})`.strip }
-          .reject { |s| s == '' }
-          .map { |s| JSON.parse(s).flatten }
-          .flatten
-        end
-
-        # Convert to swiftlint results
-        warnings = result_json.select do |results| 
-          results['severity'] == 'Warning'
-        end
-        errors = result_json.select do |results| 
-          results['severity'] == 'Error' 
-        end
-
-        message = ''
-
-        # We got some error reports back from swiftlint
+    def lint_files(files=nil, inline_mode: false)
+      # Fails if swiftlint isn't installed
+      raise "swiftlint is not installed" unless Swiftlint.is_installed?
+
+      # Extract excluded paths
+      excluded_paths = excluded_files_from_config(config_file)
+
+      # Extract swift files (ignoring excluded ones)
+      files = find_swift_files(files, excluded_paths)
+
+      # Prepare swiftlint options
+      options = {
+        config: config_file,
+        reporter: 'json',
+        quiet: true,
+        pwd: directory || Dir.pwd
+      }
+
+      # Lint each file and collect the results
+      issues = run_swiftlint(files, options)
+
+      # Filter warnings and errors
+      warnings = issues.select { |issue| issue['severity'] == 'Warning' }
+      errors = issues.select { |issue| issue['severity'] == 'Error' }
+
+      if inline_mode
+        # Reprt with inline comment
+        send_inline_comment(warnings, "warn")
+        send_inline_comment(errors, "fail")
+      else
+        # Report if any warning or error
         if warnings.count > 0 || errors.count > 0
           message = "### SwiftLint found issues\n\n"
+          message << markdown_issues(warnings, 'Warnings') unless warnings.empty?
+          message << markdown_issues(errors, 'Errors') unless errors.empty?
+          markdown message
         end
+      end
+    end
 
-        message << parse_results(warnings, 'Warnings') unless warnings.empty?
-        message << parse_results(errors, 'Errors') unless errors.empty?
+    # Run swiftlint on each file and aggregate collect the issues
+    #
+    # @return [Array] swiftlint issues
+    def run_swiftlint(files, options)
+      files
+        .map { |file| options.merge({path: file})}
+        .map { |options| Swiftlint.lint(options)}
+        .reject { |s| s == '' }
+        .map { |s| JSON.parse(s).flatten }
+        .flatten
+    end
 
-        markdown message unless message.empty?
+    # Find swift files from the files glob
+    # If files are not provided it will use git modifield and added files
+    #
+    # @return [Array] swift files
+    def find_swift_files(files=nil, excluded_files=[])
+      # Assign files to lint
+      files = files ? Dir.glob(files) : git.modified_files + git.added_files
+
+      # Filter files to lint
+      return files.
+        # Ensure only swift files are selected
+        select { |file| file.end_with?('.swift') }.
+        # Make sure we don't fail when paths have spaces
+        map { |file| Shellwords.escape(file) }.
+        # Remove dups
+        uniq.
+        # Reject files excluded on configuration
+        reject { |file|
+          excluded_files.any? { |excluded| Find.find(excluded).include?(File.expand_path(file)) }
+        }
+    end
+
+    # Parses the configuration file and return the excluded files
+    #
+    # @return [Array] list of files excluded
+    def excluded_files_from_config(filepath)
+      config = if filepath
+        YAML.load_file(config_file)
+      else
+        {"excluded" => []}
       end
+
+      # Extract excluded paths
+      return config['excluded'].
+        map { |path| File.join(File.dirname(config_file), path) }.
+        map { |path| File.expand_path(path) }.
+        select { |path| File.exists?(path) || Dir.exists?(path) }
     end
 
-    # Parses swiftlint invocation results into a string
-    # which is formatted as a markdown table.
+    # Create a markdown table from swiftlint issues
     #
     # @return  [String]
-    #
-    def parse_results (results, heading)
+    def markdown_issues (results, heading)
       message = "#### #{heading}\n\n"
 
       message << "File | Line | Reason |\n"
@@ -139,11 +145,15 @@ module Danger
       message
     end
 
-    # Determine if swiftlint is currently installed in the system paths.
-    # @return  [Bool]
+    # Send inline comment with danger's warn or fail method
     #
-    def swiftlint_installed?
-      `which swiftlint`.strip.empty? == false
+    # @return [void]
+    def send_inline_comment (results, method)
+      dir = "#{Dir.pwd}/"
+      results.each do |r|
+	filename = r['file'].gsub(dir, "")
+	send(method, r['reason'], file: filename, line: r['line'])
+      end
     end
   end
 end

data/lib/version.rb

@@ -1,3 +1,4 @@
 module DangerSwiftlint
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
+  SWIFTLINT_VERSION = "0.16.1".freeze
 end

data/spec/danger_plugin_spec.rb

@@ -8,104 +8,64 @@ module Danger
 
     describe 'with Dangerfile' do
       before do
-        @dangerfile = testing_dangerfile
         @swiftlint = testing_dangerfile.swiftlint
-
-        @swiftlint.config_file = nil
       end
 
       it "handles swiftlint not being installed" do
-        allow(@swiftlint).to receive(:`).with("which swiftlint").and_return("")
-        expect(@swiftlint.swiftlint_installed?).to be_falsy
-      end
-
-      it "handles swiftlint being installed" do
-        allow(@swiftlint).to receive(:`).with("which swiftlint").and_return("/bin/wherever/swiftlint")
-        expect(@swiftlint.swiftlint_installed?).to be_truthy
+        allow(Swiftlint).to receive(:is_installed?).and_return(false)
+        expect { @swiftlint.lint_files }.to raise_error("swiftlint is not installed")
       end
 
       it 'does not markdown an empty message' do
-        allow(@swiftlint).to receive(:`)
-          .with('swiftlint lint --quiet --reporter json --path "spec/fixtures/SwiftFile.swift"')
-          .and_return('[]')
-
+        allow(Swiftlint).to receive(:lint).and_return('[]')
         expect(@swiftlint.status_report[:markdowns].first).to be_nil
       end
 
       describe :lint_files do
         before do
-          # So it doesn't try to install on your computer
-          allow(@swiftlint).to receive(:`).with("which swiftlint").and_return("/bin/wheverever/swiftlint")
+          allow(Swiftlint).to receive(:is_installed?).and_return(true)
+          allow(@swiftlint.git).to receive(:added_files).and_return([])
+          allow(@swiftlint.git).to receive(:modified_files).and_return([])
 
-          # Set up our stubbed JSON response
           @swiftlint_response = '[{ "rule_id" : "force_cast", "reason" : "Force casts should be avoided.", "character" : 19, "file" : "/Users/me/this_repo/spec//fixtures/SwiftFile.swift", "severity" : "Error", "type" : "Force Cast", "line" : 13 }]'
         end
 
-        it 'handles a known SwiftLint report with give files' do
-          allow(@swiftlint).to receive(:`).with('(swiftlint lint --quiet --reporter json --path "spec/fixtures/SwiftFile.swift")').and_return(@swiftlint_response)
+        it 'accept files as arguments' do
+          expect(Swiftlint).to receive(:lint)
+            .with(hash_including(:path => 'spec/fixtures/SwiftFile.swift'))
+            .and_return(@swiftlint_response)
 
-          # Do it
           @swiftlint.lint_files("spec/fixtures/*.swift")
 
           output = @swiftlint.status_report[:markdowns].first.to_s
-
-          expect(output).to_not be_empty
-
-          # A title
           expect(output).to include("SwiftLint found issues")
-          # A warning
           expect(output).to include("SwiftFile.swift | 13 | Force casts should be avoided.")
         end
 
-        it 'handles no given files by looking up the git diff' do
+        it 'uses git diff when files are not provided' do
           allow(@swiftlint.git).to receive(:modified_files).and_return(['spec/fixtures/SwiftFile.swift'])
           allow(@swiftlint.git).to receive(:added_files).and_return([])
-
-          allow(@swiftlint).to receive(:`).with('(swiftlint lint --quiet --reporter json --path "spec/fixtures/SwiftFile.swift")').and_return(@swiftlint_response)
+          allow(Swiftlint).to receive(:lint)
+            .with(hash_including(:path => 'spec/fixtures/SwiftFile.swift'))
+            .and_return(@swiftlint_response)
 
           @swiftlint.lint_files
 
-          expect(@swiftlint.status_report[:markdowns].first.to_s).to_not be_empty
-        end
-
-        it 'uses a config file generated on the fly by removing the "included" values from the given one' do
-          fake_temp_file = Tempfile.new('fake.yml')
-
-          begin
-            allow(Tempfile).to receive(:open) { |&block| block.call(fake_temp_file) }
-
-            @swiftlint.config_file = 'spec/fixtures/some_config.yml'
-
-            expect(YAML.load_file(@swiftlint.config_file)['included']).to_not be_nil
-
-            allow(@swiftlint).to receive(:`).with('(swiftlint lint --quiet --reporter json --config ' + fake_temp_file.path + ' --path "spec/fixtures/SwiftFile.swift")') do
-              # The tempfile lifetime is limited to the execution of the lint
-              # command, as such if we were to assert it after the command has
-              # run the file wouldn't exist anymore.
-              #
-              # By injecting the assertion here, whithin the method execution,
-              # we access the file while it still exists.
-              expect(YAML.load_file(fake_temp_file.path)['included']).to be_nil
-
-              @swiftlint_response
-            end
-
-            @swiftlint.lint_files("spec/fixtures/*.swift")
-
-            expect(@swiftlint.status_report[:markdowns].first.to_s).to_not be_empty
-          ensure
-            fake_temp_file.close
-            fake_temp_file.unlink
-          end
+          output = @swiftlint.status_report[:markdowns].first.to_s
+          expect(output).to_not be_empty
         end
 
         it 'uses a custom directory' do
           @swiftlint.directory = 'some_dir'
-          allow(@swiftlint).to receive(:`).with('(cd some_dir && swiftlint lint --quiet --reporter json)').and_return(@swiftlint_response)
 
-          @swiftlint.lint_files
+          allow(Swiftlint).to receive(:lint)
+            .with(hash_including(:pwd => @swiftlint.directory))
+            .and_return(@swiftlint_response)
+
+          @swiftlint.lint_files("spec/fixtures/*.swift")
 
-          expect(@swiftlint.status_report[:markdowns].first.to_s).to_not be_empty
+          output = @swiftlint.status_report[:markdowns].first.to_s
+          expect(output).to_not be_empty
         end
 
         it 'does not crash if JSON reporter returns an empty string rather than an object' do
@@ -120,36 +80,38 @@ module Danger
           # To our code this would simply look like an empty result, which
           # would then become an empty string, which cannot be parsed into a
           # JSON object.
-          response = ''
-          allow(@swiftlint).to receive(:`).with('(swiftlint lint --quiet --reporter json --path "spec/fixtures/SwiftFile.swift")').and_return(response)
-
-          @swiftlint.lint_files("spec/fixtures/*.swift")
 
-          output = @swiftlint.status_report[:markdowns].first.to_s
+          allow(Swiftlint).to receive(:lint).and_return('')
 
-          # If we get to this point then we haven't crashed, happy days
-          expect(output).to be_empty
+          expect { @swiftlint.lint_files }.not_to raise_error
         end
 
         it 'does not lint files in the excluded paths' do
-          allow(@swiftlint.git).to receive(:modified_files).and_return(['spec/fixtures/SwiftFile.swift', 'spec/fixtures/excluded_dir/SwiftFileThatShouldNotBeIncluded.swift'])
           allow(@swiftlint.git).to receive(:added_files).and_return([])
+          allow(@swiftlint.git).to receive(:modified_files).and_return([
+            'spec/fixtures/SwiftFile.swift',
+            'spec/fixtures/excluded_dir/SwiftFileThatShouldNotBeIncluded.swift'
+          ])
 
-          fake_temp_file = Tempfile.new('fake.yml')
+          expect(Swiftlint).to receive(:lint)
+            .with(hash_including(:path => 'spec/fixtures/SwiftFile.swift'))
+            .and_return(@swiftlint_response)
+            .once
+
+          @swiftlint.config_file = 'spec/fixtures/some_config.yml'
+          @swiftlint.lint_files
+        end
 
-          begin
-            allow(Tempfile).to receive(:open) { |&block| block.call(fake_temp_file) }
+        it 'generates errors instead of markdown when use inline mode' do
+          allow(Swiftlint).to receive(:lint)
+            .with(hash_including(:path => 'spec/fixtures/SwiftFile.swift'))
+            .and_return(@swiftlint_response)
 
-            # The only call that should be received is this one, if @swiftlint
-            # will be called with any other param the test will fail
-            allow(@swiftlint).to receive(:`).with('(swiftlint lint --quiet --reporter json --config ' + fake_temp_file.path + ' --path "spec/fixtures/SwiftFile.swift")').and_return(@swiftlint_response)
+          @swiftlint.lint_files("spec/fixtures/*.swift", inline_mode: true)
 
-            @swiftlint.config_file = 'spec/fixtures/some_config.yml'
-            @swiftlint.lint_files
-          ensure
-            fake_temp_file.close
-            fake_temp_file.unlink
-          end
+          status = @swiftlint.status_report
+          expect(status[:errors]).to_not be_empty
+          expect(status[:markdowns]).to be_empty
         end
       end
     end

data/spec/spec_helper.rb

@@ -9,6 +9,10 @@ RSpec.configure do |config|
   config.color = true
 end
 
+RSpec::Matchers.define :including do |x|
+  match { |actual| actual.include? x  }
+end
+
 require 'bundler/setup'
 require 'pry'
 

data/spec/swiftlint_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../spec_helper', __FILE__)
+require_relative '../ext/swiftlint/swiftlint'
+
+describe Swiftlint do
+  it 'is_installed? works based on bin/swiftlint file' do
+    expect(File).to receive(:exist?).with(/bin\/swiftlint/).and_return(true)
+    expect(Swiftlint.is_installed?).to be_truthy
+
+    expect(File).to receive(:exist?).with(/bin\/swiftlint/).and_return(false)
+    expect(Swiftlint.is_installed?).to be_falsy
+  end
+
+  it 'runs lint by default with options being optional' do
+    expect(Swiftlint).to receive(:`).with(including('swiftlint lint'))
+    Swiftlint.run()
+  end
+
+  it 'runs accepting symbolized options' do
+    cmd = 'swiftlint lint --no-use-stdin  --cache-path /path --enable-all-rules'
+    expect(Swiftlint).to receive(:`).with(including(cmd))
+
+    Swiftlint.run('lint',
+                  use_stdin: false,
+                  cache_path: '/path',
+                  enable_all_rules: true)
+  end
+end
+

metadata

@@ -1,16 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: danger-swiftlint
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ash Furrow
 - David Grandinetti
 - Orta Therox
+- Thiago Felix
+- Giovanni Lodi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -27,19 +29,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '0.19'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -47,13 +49,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -129,8 +145,12 @@ email:
 - ash@ashfurrow.com
 - dbgrandi@gmail.com
 - orta.therox@gmail.com
-executables: []
-extensions: []
+- thiago@thiagofelix.com
+- gio@mokacoding.com
+executables:
+- danger-swiftlint
+extensions:
+- ext/swiftlint/Rakefile
 extra_rdoc_files: []
 files:
 - ".gitignore"
@@ -142,7 +162,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/danger-swiftlint
 - danger-swiftlint.gemspec
+- ext/swiftlint/Rakefile
+- ext/swiftlint/swiftlint.rb
 - lib/danger_plugin.rb
 - lib/version.rb
 - spec/danger_plugin_spec.rb
@@ -150,6 +173,7 @@ files:
 - spec/fixtures/excluded_dir/SwiftFileThatShouldNotBeIncluded.swift
 - spec/fixtures/some_config.yml
 - spec/spec_helper.rb
+- spec/swiftlint_spec.rb
 homepage: https://github.com/ashfurrow/danger-swiftlint
 licenses:
 - MIT
@@ -170,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A Danger plugin for linting Swift with SwiftLint.
@@ -180,3 +204,4 @@ test_files:
 - spec/fixtures/excluded_dir/SwiftFileThatShouldNotBeIncluded.swift
 - spec/fixtures/some_config.yml
 - spec/spec_helper.rb
+- spec/swiftlint_spec.rb