danger-clorox 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae1427713f4cce42f01cc442c765de8bfddcc687
-  data.tar.gz: f41c88a12f1fa9fb8b292a1a779a9105975f25c6
+  metadata.gz: bcfffed4c624b73d0ec58add18053a632d824401
+  data.tar.gz: 97562affdde80593b4043a12890aa69fa30e8a48
 SHA512:
-  metadata.gz: 6d19496bfa6b44008144c71473fb253c0366311315d6fb00fed182259c7aa53fbc97044c47499788bade65a04ceffc737d171850e3d854af65c79eaaee32c552
-  data.tar.gz: b1fe315c112212caaecc7013e89933422b3fd1b3e56453bed01089650196fb209c4fcd959e5147ed043cc4799e5105888001e3493345b38889f98f566ca70aea
+  metadata.gz: a6897dff5b4a63685f4683ba1aa2069e843741e2580f4efe035c96d7fe49afbcc14a908efe508d3f483e5d8227c3b54b0074e538f46c20552efe4c5d50a26ce2
+  data.tar.gz: 66d793d805aa96f2de1b8ce1c11d136617c5386ce0b1eda93d4d33cf2dd970a38a293feb1619043aea76ac07d0b82b8209525c4cd911f298d14380049390ce23

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-clorox (1.0.0)
+    danger-clorox (2.0.0)
       danger
 
 GEM
@@ -9,8 +9,8 @@ GEM
   specs:
     addressable (2.4.0)
     bacon (1.2.0)
-    claide (1.0.0)
-    claide-plugins (0.9.1)
+    claide (1.0.1)
+    claide-plugins (0.9.2)
       cork
       nap
       open4 (~> 1.3)
@@ -18,15 +18,14 @@ GEM
     colored (1.2)
     cork (0.2.0)
       colored (~> 1.2)
-    danger (3.1.0)
+    danger (4.0.0)
       claide (~> 1.0)
-      claide-plugins (> 0.9.0)
+      claide-plugins (>= 0.9.2)
       colored (~> 1.2)
       cork (~> 0.1)
       faraday (~> 0.9)
       faraday-http-cache (~> 1.0)
       git (~> 1)
-      gitlab (~> 3.7.0)
       kramdown (~> 1.5)
       octokit (~> 4.2)
       terminal-table (~> 1)
@@ -35,12 +34,9 @@ GEM
       multipart-post (>= 1.2, < 3)
     faraday-http-cache (1.3.1)
       faraday (~> 0.8)
-    ffi (1.9.10)
+    ffi (1.9.14)
     formatador (0.2.5)
     git (1.3.0)
-    gitlab (3.7.0)
-      httparty (~> 0.13.0)
-      terminal-table
     guard (2.14.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -51,14 +47,10 @@ GEM
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
-    guard-rspec (4.7.2)
+    guard-rspec (4.7.3)
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    httparty (0.13.7)
-      json (~> 1.8)
-      multi_xml (>= 0.5.2)
-    json (1.8.3)
     kramdown (1.12.0)
     listen (3.0.7)
       rb-fsevent (>= 0.9.3)
@@ -66,35 +58,34 @@ GEM
     lumberjack (1.0.10)
     metaclass (0.0.4)
     method_source (0.8.2)
-    mocha (1.1.0)
+    mocha (1.2.1)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.2)
       mocha (>= 0.13.0)
-    multi_xml (0.5.5)
     multipart-post (2.0.0)
     nap (1.1.0)
     nenv (0.3.0)
-    notiffany (0.1.0)
+    notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (4.3.0)
+    octokit (4.4.1)
       sawyer (~> 0.7.0, >= 0.5.3)
     open4 (1.3.4)
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    pry (0.10.3)
+    pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
     rake (10.5.0)
-    rb-fsevent (0.9.7)
+    rb-fsevent (0.9.8)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.0)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -108,10 +99,10 @@ GEM
       faraday (~> 0.8, < 0.10)
     shellany (0.0.1)
     slop (3.6.0)
-    terminal-table (1.7.0)
-      unicode-display_width (~> 1.1)
+    terminal-table (1.7.3)
+      unicode-display_width (~> 1.1.1)
     thor (0.19.1)
-    unicode-display_width (1.1.0)
+    unicode-display_width (1.1.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,3 +1,5 @@
+[![CircleCI](https://circleci.com/gh/barbosa/danger-clorox.svg?style=svg)](https://circleci.com/gh/barbosa/danger-clorox)
+
 # Danger Clorox
 
 A [Danger](https://github.com/danger/danger) plugin for [Clorox](https://github.com/barbosa/clorox) that runs on macOS.
@@ -12,16 +14,29 @@ gem 'danger-clorox'
 
 ## Usage
 
-The easiest way to use is just add this to your Dangerfile:
+### Basic
+
+Add the following line to your Danger file to check files inside the current directory:
+```rb
+clorox.check
+```
+
+### Advanced
+
+Specify the directories where you want to run the script:
+```rb
+clorox.check ["YourProject", "YourProjectNotificationExtension"]
+```
 
+Set the script level so it displays failures/warnings in the specific markdown table
 ```rb
-clorox.directories = ["YourProject", "YourProjectNotificationExtension"]
-clorox.check_files
+clorox.level = "failure"
+clorox.check ["YourProject", "YourProjectNotificationExtension"]
 ```
 
 ## 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/).
+Original structure, sequence, and organization of repo taken from [danger-prose](https://github.com/dbgrandi/danger-prose) by [David Grandinetti](https://github.com/dbgrandi/) and [danger-swiftlint](https://github.com/ashfurrow/danger-swiftlint) by [Ash Furrow](https://github.com/ashfurrow/).
 
 ## License
 

data/lib/danger_plugin.rb

@@ -1,20 +1,44 @@
 module Danger
 
 
+  # Checks the presence of Xcode file headers.
+  # This is done using the [clorox](https://pypi.python.org/pypi/clorox) python egg.
+  # Results are passed out as a list in markdown.
+  #
+  # @example Running clorox from current directory
+  #
+  #          # clorox.check_files
+  #
+  # @example Running clorox from specific directories
+  #
+  #          clorox.directories = ["MyApp", "MyAppTests", "MyAppExtension"]
+  #          clorox.check_files
+  #
+  # @see barbosa/danger-clorox
+  # @tags xcode, clorox, comments
+  #
   class DangerClorox < Plugin
 
     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
+    LEVEL_WARNING = "warning"
+    LEVEL_FAILURE = "failure"
+
+    # Allows you to set a level to the checker
+    # Possible values are "warning" and "failure"
+    # defaults to "warning"
+    #
+    # @return [String]
+    attr_accessor :level
 
     # 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
     #
-    # @return  [void]
+    # @param directories [Array<String>] Directories from where clorox will be run. Defaults to current dir.
+    # @return [void]
     #
-    def check_files
+    def check(directories=["."])
       # Installs clorox if needed
       system "pip install --target #{ROOT_DIR} clorox" unless clorox_installed?
 
@@ -30,16 +54,12 @@ module Danger
       clorox_command += "--report json"
 
       require 'json'
-      result_json = JSON.parse(`#{clorox_command}`)
-
-      message = ''
-      if result_json['status'] == 'dirty'
-        message = "### Clorox has found issues\n"
-        message << "Please, remove the header from the files below (those comments on the top of your file):\n\n"
-        result_json['files'].each do |r|
-          message << "- #{r}\n"
+      result = JSON.parse(`#{clorox_command}`)
+      if result['status'] == 'dirty'
+        result['files'].each do |file|
+          message = "#{file} contains Xcode's file header"
+          level == LEVEL_FAILURE ? fail(message) : warn(message)
         end
-        markdown message
       end
     end
 

data/lib/version.rb

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

data/spec/danger_plugin_spec.rb

@@ -28,8 +28,7 @@ module Danger
         @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
+        @clorox.check ["some/dir"]
       end
 
       it "handles multiple directories" do
@@ -38,8 +37,7 @@ module Danger
         @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
+        @clorox.check ["some/dir", "some/path"]
       end
 
       describe :check_files do
@@ -51,22 +49,18 @@ module Danger
           @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
+          @clorox.check ["some/dir"]
 
-          output = @clorox.status_report[:markdowns].first
-
-          expect(output).to include("Clorox has found issues")
-          expect(output).to include("- some/path/FileA.swift")
-          expect(output).to include("- some/path/FileB.m")
+          warnings = @clorox.status_report[:warnings]
+          expect(warnings).to include("some/path/FileA.swift contains Xcode's file header")
+          expect(warnings).to include("some/path/FileB.m contains Xcode's file header")
         end
 
         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.directories = ["some/dir"]
-          @clorox.check_files
+          @clorox.check ["some/dir"]
 
           expect(@clorox.status_report[:markdowns].first).to be_nil
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-clorox
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Gustavo Barbosa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-26 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger