danger-missing_codeowners 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d13b891d9d0d127146fdcce5e71490ece5feb8ea2d0c9bcfb6bddcd44f83f80
-  data.tar.gz: f9e6c3ecddc3e1941cfcc12550d3c064fd5af29058eaf726eadeecbcb07238aa
+  metadata.gz: 9e93a3e15840e49e1966b6bfae9e59a8bfff84539b3cc1314e6224fab84464d9
+  data.tar.gz: 9288cb2e4e84f5c5dd09e4d0363f28276e3241d56c509f03075088401124fb4c
 SHA512:
-  metadata.gz: 66f7283e8e7997bec66ecfbfa1ce6a19ce19c5e784c900996504e1880df45e0eadbe4c43a85c7976de76bf8ae429b2d7ae63d262bba5debcdfec948e9f157ddb
-  data.tar.gz: 9f7d00160a6b909e7d0ab2be5e0f29c30b0ecef12a4de87db2ede4c1e7cc98ce82aa5d45c61af29ac141ff4f25d7e6241eee2ee4fad8255801d96e197458f506
+  metadata.gz: 173a41e2f5fe25c8a953e2bd1dfc78900ee4012604f70692785f8475ffae110e8a7ddb21fc20c0f70dd50093c1102804d46566ad89e401f3fd6198d70c0f50df
+  data.tar.gz: 4e5a963fb0242853a0a0ad88637f05c2e3ae0c8ff69d8b124e403b79cbccecec866b9f23ea37512b0cdd5594e5a1f0ef6e14b79a9dd6c00e2cbc67f6de2ab06f

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    danger-missing_codeowners (1.0.1)
+    danger-missing_codeowners (1.1.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.3.1)
+    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.6.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,17 +122,18 @@ 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.1)
+    terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.1.0)
     unicode-display_width (2.0.0)
     yard (0.9.26)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-20
 
 DEPENDENCIES
@@ -163,4 +149,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.2.18
+   2.2.29

data/README.md

@@ -14,7 +14,7 @@ gem 'danger-missing_codeowners'
 
 ## Usage
 
-Just call the `verify` methd in your Dangerfile:
+Just call the `verify` method in your Dangerfile:
 
 ```rb
 missing_codeowners.verify
@@ -29,6 +29,12 @@ missing_codeowners.verify_all_files = true
 missing_codeowners.verify
 ```
 
+If you want to control exactly which files should be checked, provide the files to the `verify` function:
+
+```rb
+missing_codeowners.verify(['my_file.swift'])
+```
+
 You can also adjust the severity of the execution. Possible valures are `error` (default) and `warning`:
 
 ```rb
@@ -36,6 +42,18 @@ missing_codeowners.severity = 'warning'
 missing_codeowners.verify
 ```
 
+### Integration Tips
+
+After adding this plugin you may find a lot of files without CODEOWNERS. To help you during this process, you may find useful to bump the maximum number of files the plugin reports per run:
+
+```rb
+missing_codeowners.max_number_of_files_to_report = 500
+```
+
+You can also try to execute Danger locally (create a new Dangerfile with only this plugin, as other plugins may not work locally):
+
+`danger dry_run --dangerfile=<your dangerfile> --base=<your base branch, usually main>`
+
 ## Development
 
 1. Clone this repo
@@ -43,6 +61,19 @@ missing_codeowners.verify
 3. Run `bundle exec rake spec` to run the tests.
 4. Use `bundle exec guard` to automatically have tests run as you make changes.
 
+## Troubleshooting
+
+### Error: invalid byte sequence in US-ASCII
+
+Danger requires the filesystem to be encoded with UTF-8, which is usually the default.
+
+You can try adding these lines to the top of your Dangerfile:
+
+```rb
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+```
+
 ## License
 
 MIT

data/lib/missing_codeowners/gem_version.rb

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

data/lib/missing_codeowners/plugin.rb

@@ -40,26 +40,44 @@ module Danger
     # @return   [Bool]
     attr_accessor :verbose
 
-    # Verifies git added and modified files for missing owners.
+    # 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.
     #
+    # @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
+    def verify(*opts)
       @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).delete_if do |file|
+        @ignored_files.any? { |ignored_file| file.start_with?(ignored_file) }
+      end
 
-      files = files_to_verify
       log "Files to verify:"
-      log files.join("\n")
+      log files_to_verify.join("\n")
 
       codeowners_path = find_codeowners_file
       codeowners_lines = read_codeowners_file(codeowners_path)
       codeowners_spec = parse_codeowners_spec(codeowners_lines)
-      @files_missing_codeowners = files.reject { |file| codeowners_spec.match file }
+      @files_missing_codeowners = files_to_verify.reject { |file| codeowners_spec.match file }
 
       if @files_missing_codeowners.any?
         log "Files missing CODEOWNERS:"
@@ -77,12 +95,15 @@ module Danger
 
     private
 
-    def files_to_verify
+    def files_from_git
       @verify_all_files == true ? git_all_files : git_modified_files
     end
 
     def git_modified_files
-      git.added_files + git.modified_files
+      # This algorithm detects added files, modified files and renamed/moved files
+      renamed_files_hash = git.renamed_files.map { |rename| [rename[:before], rename[:after]] }.to_h
+      post_rename_modified_files = git.modified_files.map { |modified_file| renamed_files_hash[modified_file] || modified_file }
+      (post_rename_modified_files - git.deleted_files) + git.added_files
     end
 
     def git_all_files
@@ -112,9 +133,9 @@ module Danger
         else
           pattern = components[0]
 
-          # There is a different between .gitignore spec and CODEOWNERS in regards to nested directories
+          # There is a difference between .gitignore spec and CODEOWNERS in regards to nested directories
           # See frotz/ example in https://git-scm.com/docs/gitignore
-          # foo/bar (CODEOWNERS) == **/foo/bar (.gitignore)
+          # foo/bar (CODEOWNERS) equals **/foo/bar (.gitignore)
           if pattern.match(%r{^[^/*].*/.+})
             pattern = "**/#{pattern}"
           end

data/spec/missing_codeowners_spec.rb

@@ -128,6 +128,42 @@ module Danger
           expect(@dangerfile.status_report[:markdowns].first.to_s).to include("2 other files")
           expect(@my_plugin.files_missing_codeowners.length).to eq(3)
         end
+
+        it "verifies added/modified/renamed files correctly when verify_all_files is false" do
+          @my_plugin.verify_all_files = false
+
+          allow(@my_plugin.git).to receive(:modified_files).and_return(["file_renamed_to_something_else.swift", "modified_file.swift"])
+          allow(@my_plugin.git).to receive(:renamed_files).and_return([{ before: "file_renamed_to_something_else.swift", after: "renamed_file.swift" }])
+          allow(@my_plugin.git).to receive(:added_files).and_return(["added_file.swift"])
+          allow(@my_plugin.git).to receive(:deleted_files).and_return(["deleted_file.swift"])
+
+          @my_plugin.verify
+
+          expect(@my_plugin.files_missing_codeowners).to include("added_file.swift")
+          expect(@my_plugin.files_missing_codeowners).to include("modified_file.swift")
+          expect(@my_plugin.files_missing_codeowners).to include("renamed_file.swift")
+          expect(@my_plugin.files_missing_codeowners.length).to eq(3)
+        end
+
+        it "verifies only the provided files" do
+          @my_plugin.verify_all_files = true
+
+          allow(@my_plugin.git).to receive(:added_files).and_return(["added_file.swift"])
+
+          @my_plugin.verify(["added_file2.swift"])
+
+          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.2
+  version: 1.1.0
 platform: ruby
 authors:
 - andre-alves
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-06 00:00:00.000000000 Z
+date: 2023-05-25 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.