danger-missing_codeowners 1.0.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c96c6f07f74d912ae60feb08a802ebd4a1aa7807ece970520614c77a5847ec13
-  data.tar.gz: a872b00996c8a7c42e3d73c648fb792a3e22acadb340cc53ff8865f54d43408c
+  metadata.gz: fcd83e0d8b50b255205c5ecfbceed72c29db635c92fc27d2f2b9420b6ba5a8a6
+  data.tar.gz: 43a2e6402320a69e456f6c19524c8388b2be03195bf25656157fea8840069f66
 SHA512:
-  metadata.gz: 0ee3995c868961f7431b131748fe39e2b4f24689dd1fe1563e3de74bb33a6bb512fbc0a955029083933ae664193022f929dfc3040c9a8447a5affe62940a1388
-  data.tar.gz: 52a36f59123b2ff15bc68af51a2f2bd93efab45c6f4c3d7e25f525cab493b326db3e8f7886c3690a4e1d4677a415b825f28524cdc4a93ac5bfccf55240515961
+  metadata.gz: fac672eff7a5197a07065fcfd8ab2c5b7546d4ed33071e2a6d4e00fa6366f8579d9e4fd9af726ba03ac8776c571af6bc02c8d624c24a3ed5792102567821cc97
+  data.tar.gz: b82d354dcc331dc13abb1958374edb8dc72c55a71eb056bd8f1a4f846682101167a17fdb1af9c6576aea3a3d412e357b23c218beb5fad7797e3367865a7c99c2

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    danger-missing_codeowners (1.0.3)
+    danger-missing_codeowners (1.2.0)
       danger-plugin-api (~> 1.0)
       pathspec (~> 1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    claide (1.0.3)
+    claide (1.1.0)
     claide-plugins (0.9.2)
       cork
       nap
@@ -20,46 +20,32 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (8.4.2)
+    danger (9.3.0)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
-      faraday (>= 0.9.0, < 2.0)
+      faraday (>= 0.9.0, < 3.0)
       faraday-http-cache (~> 2.0)
-      git (~> 1.7)
+      git (~> 1.13.0)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
-      octokit (~> 4.7)
+      octokit (~> 5.0)
       terminal-table (>= 1, < 4)
     danger-plugin-api (1.0.0)
       danger (> 2.0)
     diff-lcs (1.4.4)
-    faraday (1.8.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+    faraday (2.7.5)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-http-cache (2.2.0)
+    faraday-http-cache (2.5.0)
       faraday (>= 0.8)
-    faraday-httpclient (1.0.1)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
+    faraday-net_http (3.0.2)
     ffi (1.15.3)
     formatador (0.3.0)
-    git (1.9.1)
+    git (1.13.2)
+      addressable (~> 2.8)
       rchardet (~> 1.8)
     guard (2.18.0)
       formatador (>= 0.2.4)
@@ -75,7 +61,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
@@ -84,16 +70,15 @@ GEM
       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.21.0)
-      faraday (>= 0.9)
-      sawyer (~> 0.8.0, >= 0.5.3)
+    octokit (5.6.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
     open4 (1.3.4)
     parallel (1.20.1)
     parser (3.0.2.0)
@@ -102,7 +87,7 @@ GEM
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.6)
+    public_suffix (5.0.1)
     rainbow (3.0.0)
     rake (10.5.0)
     rb-fsevent (0.11.0)
@@ -137,9 +122,9 @@ GEM
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    sawyer (0.8.2)
+    sawyer (0.9.2)
       addressable (>= 2.3.5)
-      faraday (> 0.8, < 2.0)
+      faraday (>= 0.17.3, < 3)
     shellany (0.0.1)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
@@ -148,6 +133,8 @@ GEM
     yard (0.9.26)
 
 PLATFORMS
+  arm64-darwin-21
+  ruby
   x86_64-darwin-20
 
 DEPENDENCIES
@@ -163,4 +150,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.2.28
+   2.2.29

data/lib/missing_codeowners/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MissingCodeowners
-  VERSION = "1.0.3"
+  VERSION = "1.2.0"
 end

data/lib/missing_codeowners/plugin.rb

@@ -40,6 +40,12 @@ module Danger
     # @return   [Bool]
     attr_accessor :verbose
 
+    # The list of files to ignore. These are naive prefixes, so `foo/`
+    # will match `foo/bar`. No globbing.
+    #
+    # @return [Array<String>]
+    attr_accessor :ignored_files
+
     # Verifies files for missing owners.
     # Generates a `markdown` list of warnings for the prose in a corpus of
     # .markdown and .md files.
@@ -47,16 +53,23 @@ module Danger
     # @param   [String] files
     #          The list of files you want to verify, defaults to nil.
     #          if nil, modified and added files from the diff will be used.
+    # @param   [String] ignored_files
+    #          The list of files you want to ignore, defaults to [].
+    #          The files are treated as prefixes, so `foo/` will match `foo/bar`.
     #
     # @return  [void]
     #
-    def verify(files = nil)
+    def verify(*opts, &block)
       @verify_all_files ||= false
       @max_number_of_files_to_report ||= 100
       @severity ||= "error"
       @verbose ||= false
+      @ignored_files ||= opts.first.kind_of?(Hash) ? opts.first[:ignored_files] : []
+      files = opts.first.kind_of?(Hash) ? opts.first[:files] : opts.first
 
-      files_to_verify = files || files_from_git
+      files_to_verify = (files || files_from_git).delete_if do |file|
+        @ignored_files.any? { |ignored_file| file.start_with?(ignored_file) }
+      end
 
       log "Files to verify:"
       log files_to_verify.join("\n")
@@ -73,8 +86,12 @@ module Danger
         markdown format_missing_owners_message(@files_missing_codeowners, @max_number_of_files_to_report)
         danger_message = "Add CODEOWNERS rules to match all files."
         @severity == "error" ? (fail danger_message) : (warn danger_message)
+
+        yield @files_missing_codeowners if block
       else
         log "No files missing CODEOWNERS."
+
+        yield [] if block
       end
 
       log "-----"

data/spec/missing_codeowners_spec.rb

@@ -75,6 +75,26 @@ module Danger
           expect(@my_plugin.files_missing_codeowners.length).to eq(0)
         end
 
+        it "calls the block with an empty array if there are no missing files" do
+          allow(@my_plugin).to receive(:git_modified_files).and_return(["any_file.yml", "any_file.go"])
+
+          @my_plugin.verify do |x|
+            expect(x).to eq []
+          end
+
+          expect(@my_plugin.files_missing_codeowners.length).to eq(0)
+        end
+
+        it "calls the block with the list of missing files if there are missing files" do
+          allow(@my_plugin).to receive(:git_modified_files).and_return(["myfile"])
+
+          @my_plugin.verify do |x|
+            expect(x).to eq ["myfile"]
+          end
+
+          expect(@my_plugin.files_missing_codeowners.length).to eq(1)
+        end
+
         it "fails when there are files without CODEOWNERS rules and severity is error" do
           @my_plugin.verify_all_files = true
           allow(@my_plugin).to receive(:git_all_files).and_return(["app/source.swift", ".swiftlint.yml"])
@@ -155,6 +175,15 @@ module Danger
           expect(@my_plugin.files_missing_codeowners).to include("added_file2.swift")
           expect(@my_plugin.files_missing_codeowners.length).to eq(1)
         end
+
+        it "ignores explicitly ignored files" do
+          allow(@my_plugin).to receive(:git_modified_files).and_return(["ignored_file.swift", "added_file.swift"])
+
+          @my_plugin.verify(ignored_files: ["ignored_file.swift"])
+
+          expect(@my_plugin.files_missing_codeowners).to include("added_file.swift")
+          expect(@my_plugin.files_missing_codeowners.length).to eq(1)
+        end
       end
 
       context "and invalid CODEOWNERS file" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-missing_codeowners
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.2.0
 platform: ruby
 authors:
 - andre-alves
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-24 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -209,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A Danger plugin for checking if files have owners.