codeowners-checker 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d9d7332bd9c20b04f99d88d0d91ba7430e64ea45af0720f3b96b66aab535bd6
-  data.tar.gz: 52a7866ebda6380f924c18f80ab689e6cd5416f5ea0da8e96b6ea09e1645eca3
+  metadata.gz: 6048aab671d2371c50bde29d63d426f7e2f0ef8f29bb7b5ee62517d0e0c872b9
+  data.tar.gz: 416440eb3334d8de4c4e8d24c2d78ff81483bf45b9b91d6558ca803240d1a57b
 SHA512:
-  metadata.gz: 89a86ecabad2150b1f1f17f202ef70226d071754bd689d349ef412c23d1423446600648f79d7ec1f8508b1a432b154a156d9e9261008c93168de6633f79109f0
-  data.tar.gz: 554ee80bdb5cad8eada8b850dcca17c147511bbbddd114bc03a2ee3d79f28a5e68fd9543a599887e606bf050e519038f9c69a0c5f27eb7e97b10c542ddc0ce49
+  metadata.gz: 3d2d705c35ea5ec8930c1f917c597ebf6d424f08c868f7a251874e97e6c2c1cca7b789fa6a2e7d257d0dffdfbab861932f4a3c784eb3d1fad48f485ef1eae024
+  data.tar.gz: e5b192ef813b86c9e11de1a8a81b2b516f7470422ca22a82f70e4f9f2e0a592b03ceb855bd9b967ed0e5ccb97d299a5efbc0d24fc928a829c525a3721b7bba62

data/README.md

@@ -17,6 +17,23 @@ between two git revisions.
 
 It will configure `@owner` as the default owner in the config file.
 
+#### Whitelist
+
+If you are just starting to use `codeowners-checker` in your project, you might not have clear ownership defined for all parts of the code. In this case using the checker would be very tedious in the beginning, as it prompts for ownership rules for all files.
+
+You can still use `codeowners-checker` in this case without the tedium by providing a whitelist. The whitelist contains patterns to ignore when checking files.
+
+Just place a file called `CODEOWNERS_WHITELIST` next to your `CODEOWNERS` file to enable the whitelist.
+
+Here is an example:
+
+```
+# The format of the file follows the format used by .gitignore
+
+# ignore files under bin
+bin/* 
+```
+For all operations, `codeowners-checker` will ignore files matching the patterns in here.
 
 ### Fetching and validating owners
 
@@ -195,6 +212,8 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+Have a look at [spec/README.md](./spec/README.md) for more information about what tools are available when writing tests.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/toptal/codeowners-checker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/codeowners/checker.rb

@@ -7,6 +7,7 @@ require_relative 'checker/code_owners'
 require_relative 'checker/file_as_array'
 require_relative 'checker/group'
 require_relative 'checker/owners_list'
+require_relative 'checker/whitelist'
 
 module Codeowners
   # Check if code owners are consistent between a git repository and the CODEOWNERS file.
@@ -27,7 +28,7 @@ module Codeowners
     end
 
     def changes_to_analyze
-      @git.diff(@from, @to).name_status
+      @git.diff(@from, @to).name_status.reject(&whitelist)
     end
 
     def added_files
@@ -39,7 +40,7 @@ module Codeowners
     end
 
     def changes_for_patterns(patterns)
-      @git.diff(@from, @to).path(patterns).name_status.keys
+      @git.diff(@from, @to).path(patterns).name_status.keys.reject(&whitelist)
     end
 
     def patterns_by_owner
@@ -74,7 +75,7 @@ module Codeowners
     end
 
     def pattern_has_files(pattern)
-      @git.ls_files(pattern.gsub(%r{^/}, '')).any?
+      @git.ls_files(pattern.gsub(%r{^/}, '')).reject(&whitelist).any?
     end
 
     def defined_owner?(file)
@@ -87,6 +88,18 @@ module Codeowners
       false
     end
 
+    def whitelist?
+      whitelist.exist?
+    end
+
+    def whitelist_filename
+      @whitelist_filename ||= CodeOwners.filename(@repo_dir) + '_WHITELIST'
+    end
+
+    def whitelist
+      @whitelist ||= Whitelist.new(whitelist_filename)
+    end
+
     def codeowners
       @codeowners ||= CodeOwners.new(
         FileAsArray.new(CodeOwners.filename(@repo_dir))
@@ -108,7 +121,9 @@ module Codeowners
     end
 
     def unrecognized_line
-      @unrecognized_line ||= codeowners.select { |line| line.is_a?(Codeowners::Checker::Group::UnrecognizedLine) }
+      @unrecognized_line ||= codeowners.select do |line|
+        line.is_a?(Codeowners::Checker::Group::UnrecognizedLine)
+      end.reject(&whitelist)
     end
 
     private

data/lib/codeowners/checker/version.rb

@@ -2,6 +2,6 @@
 
 module Codeowners
   class Checker
-    VERSION = '1.1.1'
+    VERSION = '1.1.2'
   end
 end

data/lib/codeowners/checker/whitelist.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'pathspec'
+
+module Codeowners
+  class Checker
+    # Manage CODEOWNERS_WHITELIST file reading
+    class Whitelist
+      def initialize(filename)
+        @filename = filename
+      end
+
+      def exist?
+        File.exist?(@filename)
+      end
+
+      def whitelisted?(filename)
+        pathspec.match(filename)
+      end
+
+      def to_proc
+        proc { |item| whitelisted?(item) }
+      end
+
+      private
+
+      def pathspec
+        @pathspec = if File.exist?(@filename)
+                      PathSpec.from_filename(@filename)
+                    else
+                      PathSpec.new([])
+                    end
+      end
+    end
+  end
+end

data/lib/codeowners/cli/main.rb

@@ -24,6 +24,9 @@ module Codeowners
       # for pre-commit: --from HEAD --to index
       def check(repo = '.')
         checker = create_checker(repo)
+        Warner.warn("No whitelist found at #{checker.whitelist_filename}") unless
+          checker.whitelist?
+
         if checker.consistent?
           Reporter.print '✅ File is consistent'
           exit 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codeowners-checker
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Jônatas Davi Paganini
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-03 00:00:00.000000000 Z
+date: 2020-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fuzzy_match
@@ -252,6 +252,7 @@ files:
 - lib/codeowners/checker/owner.rb
 - lib/codeowners/checker/owners_list.rb
 - lib/codeowners/checker/version.rb
+- lib/codeowners/checker/whitelist.rb
 - lib/codeowners/cli/base.rb
 - lib/codeowners/cli/config.rb
 - lib/codeowners/cli/filter.rb