code_ownership 1.24.0 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 159aa45c6ffe9f310d507c4d06499d69120e0476e4963153e7868360e84c5a55
-  data.tar.gz: d75353d8bfc1acb396fb3f5038869276edfda3344dcd696d101ba06486bcb191
+  metadata.gz: a58e46098c8c50b7888308dff49901380c69ccad8211946ff5c67d94bfd9c541
+  data.tar.gz: 68078aa4407fa01ad485574543dc47af49039d9b0b8a8e55af75a81ff4018ef6
 SHA512:
-  metadata.gz: 850c1fe50565aba5a2dd7c907d90fe1143a2a8c9a375b9234044811782eb7d01ce8a83197539d4026d70df6a3321c1c814d3e2dcb20290c11bf375317f41297d
-  data.tar.gz: 2bcedfdc8a6339a47994ed60379971e2518118a4b22dc1a998d3935878e47e37306693547b162c53b608161672821dab599216bab72c47df45efce57b675b404
+  metadata.gz: 8cbdffd0dc477b6ed6c69dd61df2d2f6f732b3ae90acb141193e3ec1f3bd6af364c199c3abf2b29f4faddf393e75f39438aacc9f51590b3cc20736fb7deeda3d
+  data.tar.gz: e9604ec12ccbe6e1ae14fec8222a7cc93887d7e1ababbbcf318b7a3bbd6277f98add5ff47ff3244b068b030364177460022a8a2419a398c819d227396d2d19ee

data/README.md

@@ -5,6 +5,8 @@ Check out `lib/code_ownership.rb` to see the public API.
 
 Check out `code_ownership_spec.rb` to see examples of how code ownership is used.
 
+There is also a [companion VSCode Extension]([url](https://github.com/bigrails/code-ownership-vscode)) for this gem. Just search `Gusto.code-ownership-vscode` in the VSCode Extension Marketplace.
+
 ## Usage: Declaring Ownership
 There are three ways to declare code ownership using this gem.
 ### Package-Based Ownership

data/lib/code_ownership/cli.rb

@@ -11,7 +11,19 @@ module CodeOwnership
         validate!(argv)
       elsif command == 'for_file'
         for_file(argv)
+      elsif [nil, "help"].include?(command)
+        puts <<~USAGE
+          Usage: bin/codeownership <subcommand>
+
+          Subcommands:
+            validate - run all validations
+            for_file - find code ownership for a single file
+            help  - display help information about code_ownership
+        USAGE
+      else
+        puts "'#{command}' is not a code_ownership command. See `bin/codeownership help`."
       end
+
     end
 
     def self.validate!(argv)

data/lib/code_ownership/private/validations/github_codeowners_up_to_date.rb

@@ -25,24 +25,66 @@ module CodeOwnership
             # https://help.github.com/en/articles/about-code-owners
           HEADER
 
-          contents = [
-            header,
+          expected_content_lines = [
+            *header.split("\n"),
+            nil, # For line between header and codeowners_file_lines
             *codeowners_file_lines,
             nil, # For end-of-file newline
-          ].join("\n")
+          ]
+          
+          expected_contents = expected_content_lines.join("\n")
+          actual_contents = codeowners_filepath.exist? ? codeowners_filepath.read : ""
+          actual_content_lines = actual_contents.split("\n")
 
-          codeowners_up_to_date = codeowners_filepath.exist? && codeowners_filepath.read == contents
+          codeowners_up_to_date = actual_contents == expected_contents
 
           errors = T.let([], T::Array[String])
 
           if !codeowners_up_to_date
             if autocorrect
-              codeowners_filepath.write(contents)
+              codeowners_filepath.write(expected_contents)
               if stage_changes
                 `git add #{codeowners_filepath}`
               end
             else
-              errors << "CODEOWNERS out of date. Ensure pre-commit hook is set up correctly and used. You can also run bin/codeownership validate to update the CODEOWNERS file\n"
+              # If there is no current file or its empty, display a shorter message.
+              missing_lines = expected_content_lines - actual_content_lines
+              extra_lines = actual_content_lines - expected_content_lines
+              missing_lines_text = if missing_lines.any?
+                <<~COMMENT
+                  CODEOWNERS should contain the following lines, but does not:
+                  #{(expected_content_lines - actual_content_lines).map { |line| "- \"#{line}\""}.join("\n")}
+                COMMENT
+              end
+
+              extra_lines_text = if extra_lines.any?
+                <<~COMMENT
+                  CODEOWNERS should not contain the following lines, but it does:
+                  #{(actual_content_lines - expected_content_lines).map { |line| "- \"#{line}\""}.join("\n")}
+                COMMENT
+              end
+
+              diff_text = if missing_lines_text && extra_lines_text
+                 "#{missing_lines_text}\n#{extra_lines_text}".chomp
+              elsif missing_lines_text
+                missing_lines_text
+              elsif extra_lines_text
+                extra_lines_text
+              else
+                ""
+              end
+
+              if actual_contents == ""
+                errors << <<~CODEOWNERS_ERROR
+                  CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file
+                CODEOWNERS_ERROR
+              else
+                errors << <<~CODEOWNERS_ERROR
+                  CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file
+
+                  #{diff_text.chomp}
+                CODEOWNERS_ERROR
+              end
             end
           end
 

data/lib/code_ownership/private.rb

@@ -50,7 +50,7 @@ module CodeOwnership
       end
 
       if errors.any?
-        errors << 'See https://github.com/bigrails/code_ownership/README.md for more details'
+        errors << 'See https://github.com/bigrails/code_ownership#README.md for more details'
         raise InvalidCodeOwnershipConfigurationError.new(errors.join("\n")) # rubocop:disable Style/RaiseArgs
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_ownership
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.27.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2022-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigrails-teams