danger-clorox 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b674b32946188d77a7316cc4effc59201f1c487
-  data.tar.gz: d41d4a774ea2a346f5608ef6728d7fd602217ed1
+  metadata.gz: ae1427713f4cce42f01cc442c765de8bfddcc687
+  data.tar.gz: f41c88a12f1fa9fb8b292a1a779a9105975f25c6
 SHA512:
-  metadata.gz: 4e169b4d61f39882461f8320cf4c8cc911f1e33709d0582384610fea7e338d4f337f1919b9790e9234e83bf1d15d10b7949ca8599b1f6af4d9f99a3d177b59ea
-  data.tar.gz: 8bcd4aebca1eca8c72acc5baac6562334a22b7b05d713eff6c58a51f4d83ab78ea6a5469b2d72106360a19cacef4b7b0fd92d1998c15ddef25513f3b743b3722
+  metadata.gz: 6d19496bfa6b44008144c71473fb253c0366311315d6fb00fed182259c7aa53fbc97044c47499788bade65a04ceffc737d171850e3d854af65c79eaaee32c552
+  data.tar.gz: b1fe315c112212caaecc7013e89933422b3fd1b3e56453bed01089650196fb209c4fcd959e5147ed043cc4799e5105888001e3493345b38889f98f566ca70aea

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 1.1.0
+- Adds support for multiple directories
+
+## 1.0.0
+- Initial version

data/README.md

@@ -15,6 +15,7 @@ gem 'danger-clorox'
 The easiest way to use is just add this to your Dangerfile:
 
 ```rb
+clorox.directories = ["YourProject", "YourProjectNotificationExtension"]
 clorox.check_files
 ```
 

data/lib/danger_plugin.rb

@@ -3,8 +3,11 @@ module Danger
 
   class DangerClorox < Plugin
 
-    # Allows you to specify a directory from where clorox will be run.
-    attr_accessor :directory
+    ROOT_DIR = "/tmp/danger_clorox"
+    EXECUTABLE = "#{ROOT_DIR}/clorox/clorox.py"
+
+    # Allows you to specify directories from where clorox will be run.
+    attr_accessor :directories
 
     # Checks presence of file header comments. Will fail if `clorox` cannot be installed correctly.
     # Generates a `markdown` list of dirty Objective-C and Swift files
@@ -13,7 +16,7 @@ module Danger
     #
     def check_files
       # Installs clorox if needed
-      system "pip install --target /tmp/danger_clorox clorox" unless clorox_installed?
+      system "pip install --target #{ROOT_DIR} clorox" unless clorox_installed?
 
       # Check that this is in the user's PATH after installing
       unless clorox_installed?
@@ -21,13 +24,13 @@ module Danger
         return
       end
 
-      clorox_command = "python /tmp/danger_clorox/clorox/clorox.py "
-      clorox_command += "--path #{directory ? directory : '.'} "
+      clorox_command = "python #{EXECUTABLE} "
+      clorox_command += "--path #{directories ? directories.join(' ') : '.'} "
       clorox_command += "--inspection "
       clorox_command += "--report json"
 
       require 'json'
-      result_json = JSON.parse(`(#{clorox_command})`)
+      result_json = JSON.parse(`#{clorox_command}`)
 
       message = ''
       if result_json['status'] == 'dirty'
@@ -40,25 +43,11 @@ module Danger
       end
     end
 
-    # Parses clorox invocation results into a string
-    # which is formatted as a markdown table.
-    #
-    # @return  [String]
-    #
-    def parse_results(results)
-      message = ""
-      results.each do |r|
-        message << "- #{r} :hankey:\n"
-      end
-
-      message
-    end
-
     # Determine if clorox is currently installed in the system paths.
     # @return  [Bool]
     #
     def clorox_installed?
-      Dir.exists? "/tmp/danger_clorox"
+      File.exists? EXECUTABLE
     end
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module DangerClorox
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

data/spec/danger_plugin_spec.rb

@@ -13,47 +13,62 @@ module Danger
       end
 
       it "handles clorox not being installed" do
-        allow(@clorox).to receive(:`).with("which clorox").and_return("")
+        allow(File).to receive(:exists?).with(Danger::DangerClorox::EXECUTABLE).and_return(false)
         expect(@clorox.clorox_installed?).to be_falsy
       end
 
       it "handles clorox being installed" do
-        allow(@clorox).to receive(:`).with("which clorox").and_return("/bin/wherever/clorox")
+        allow(File).to receive(:exists?).with(Danger::DangerClorox::EXECUTABLE).and_return(true)
         expect(@clorox.clorox_installed?).to be_truthy
       end
 
-      describe :lint_files do
-        before do
-          # So it doesn't try to install on your computer
-          allow(@clorox).to receive(:`).with("which clorox").and_return("/bin/wheverever/clorox")
+      it "handles a single directory" do
+        allow(File).to receive(:exists?).with(Danger::DangerClorox::EXECUTABLE).and_return(true)
+
+        @clorox_response = '{"status": "dirty", "files": ["some/path/FileA.swift", "some/path/FileB.m"]}'
+        allow(@clorox).to receive(:`).with("python #{Danger::DangerClorox::EXECUTABLE} --path some/dir --inspection --report json").and_return(@clorox_response)
+
+        @clorox.directories = ["some/dir"]
+        @clorox.check_files
+      end
+
+      it "handles multiple directories" do
+        allow(File).to receive(:exists?).with(Danger::DangerClorox::EXECUTABLE).and_return(true)
 
-          # Set up our stubbed JSON response
-          @clorox_response = '[{"reason": "Force casts should be avoided.", "file": "/User/me/this_repo/spec/fixtures/SwiftFile.swift", "line": 13, "severity": "Error" }]'
+        @clorox_response = '{"status": "dirty", "files": ["some/path/FileA.swift", "some/path/FileB.m"]}'
+        allow(@clorox).to receive(:`).with("python #{Danger::DangerClorox::EXECUTABLE} --path some/dir some/path --inspection --report json").and_return(@clorox_response)
+
+        @clorox.directories = ["some/dir", "some/path"]
+        @clorox.check_files
+      end
+
+      describe :check_files do
+        before do
+          allow(File).to receive(:exists?).with(Danger::DangerClorox::EXECUTABLE).and_return(true)
         end
 
-        it 'handles a known Clorox report' do
-          allow(@clorox).to receive(:`).with('clorox lint --quiet --reporter json --path spec/fixtures/SwiftFile.swift').and_return(@clorox_response)
+        it 'handles a dirty clorox report' do
+          @clorox_response = '{"status": "dirty", "files": ["some/path/FileA.swift", "some/path/FileB.m"]}'
+          allow(@clorox).to receive(:`).with("python #{Danger::DangerClorox::EXECUTABLE} --path some/dir --inspection --report json").and_return(@clorox_response)
 
-          # Do it
-          @clorox.lint_files("spec/fixtures/*.swift")
+          @clorox.directories = ["some/dir"]
+          @clorox.check_files
 
           output = @clorox.status_report[:markdowns].first
 
-          expect(output).to_not be_empty
-
-          # A title
-          expect(output).to include("Clorox found issues")
-          # A warning
-          expect(output).to include("SwiftFile.swift | 13 | Force casts should be avoided.")
+          expect(output).to include("Clorox has found issues")
+          expect(output).to include("- some/path/FileA.swift")
+          expect(output).to include("- some/path/FileB.m")
         end
 
-        it 'handles no files' do
-          allow(@clorox).to receive(:modified_files).and_return('spec/fixtures/SwiftFile.swift')
-          allow(@clorox).to receive(:`).with('clorox lint --quiet --reporter json --path spec/fixtures/SwiftFile.swift').and_return(@clorox_response)
+        it 'handles a clean clorox report' do
+          @clorox_response = '{"status": "clean", "files": []}'
+          allow(@clorox).to receive(:`).with("python #{Danger::DangerClorox::EXECUTABLE} --path some/dir --inspection --report json").and_return(@clorox_response)
 
-          @clorox.lint_files("spec/fixtures/*.swift")
+          @clorox.directories = ["some/dir"]
+          @clorox.check_files
 
-          expect(@clorox.status_report[:markdowns].first).to_not be_empty
+          expect(@clorox.status_report[:markdowns].first).to be_nil
         end
 
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-clorox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Gustavo Barbosa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-22 00:00:00.000000000 Z
+date: 2016-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -131,6 +131,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .ruby-version
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -141,7 +142,6 @@ files:
 - lib/danger_plugin.rb
 - lib/version.rb
 - spec/danger_plugin_spec.rb
-- spec/fixtures/SwiftFile.swift
 - spec/spec_helper.rb
 homepage: https://github.com/barbosa/danger-clorox
 licenses:
@@ -169,6 +169,5 @@ specification_version: 4
 summary: A Danger plugin for checking presence of file header comments.
 test_files:
 - spec/danger_plugin_spec.rb
-- spec/fixtures/SwiftFile.swift
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/fixtures/SwiftFile.swift

@@ -1 +0,0 @@
-// This file intentional left blank-ish.