danger-missing_codeowners 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d13b891d9d0d127146fdcce5e71490ece5feb8ea2d0c9bcfb6bddcd44f83f80
-  data.tar.gz: f9e6c3ecddc3e1941cfcc12550d3c064fd5af29058eaf726eadeecbcb07238aa
+  metadata.gz: c96c6f07f74d912ae60feb08a802ebd4a1aa7807ece970520614c77a5847ec13
+  data.tar.gz: a872b00996c8a7c42e3d73c648fb792a3e22acadb340cc53ff8865f54d43408c
 SHA512:
-  metadata.gz: 66f7283e8e7997bec66ecfbfa1ce6a19ce19c5e784c900996504e1880df45e0eadbe4c43a85c7976de76bf8ae429b2d7ae63d262bba5debcdfec948e9f157ddb
-  data.tar.gz: 9f7d00160a6b909e7d0ab2be5e0f29c30b0ecef12a4de87db2ede4c1e7cc98ce82aa5d45c61af29ac141ff4f25d7e6241eee2ee4fad8255801d96e197458f506
+  metadata.gz: 0ee3995c868961f7431b131748fe39e2b4f24689dd1fe1563e3de74bb33a6bb512fbc0a955029083933ae664193022f929dfc3040c9a8447a5affe62940a1388
+  data.tar.gz: 52a36f59123b2ff15bc68af51a2f2bd93efab45c6f4c3d7e25f525cab493b326db3e8f7886c3690a4e1d4677a415b825f28524cdc4a93ac5bfccf55240515961

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-missing_codeowners (1.0.1)
+    danger-missing_codeowners (1.0.3)
       danger-plugin-api (~> 1.0)
       pathspec (~> 1.0.0)
 
@@ -20,7 +20,7 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (8.3.1)
+    danger (8.4.2)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -36,7 +36,7 @@ GEM
     danger-plugin-api (1.0.0)
       danger (> 2.0)
     diff-lcs (1.4.4)
-    faraday (1.6.0)
+    faraday (1.8.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -141,7 +141,7 @@ GEM
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
     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)
@@ -163,4 +163,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.2.18
+   2.2.28

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.0.3"
 end

data/lib/missing_codeowners/plugin.rb

@@ -40,26 +40,31 @@ module Danger
     # @return   [Bool]
     attr_accessor :verbose
 
-    # Verifies git added and modified files for missing owners.
+    # 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.
+    #
     # @return  [void]
     #
-    def verify
+    def verify(files = nil)
       @verify_all_files ||= false
       @max_number_of_files_to_report ||= 100
       @severity ||= "error"
       @verbose ||= false
 
-      files = files_to_verify
+      files_to_verify = files || files_from_git
+
       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 +82,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 +120,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,33 @@ 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
       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.0.3
 platform: ruby
 authors:
 - andre-alves
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-06 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api