code_owners 1.0.4 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: f5e06c6fbdfd8cead1030d3d76b302885321095972e7fcab54d1ba887f1fceb0
-  data.tar.gz: 54438d6312527c987d98f181f6242777badf72dad7b7561c39d3bc491dae5f2b
+SHA1:
+  metadata.gz: 0c170835202aa29d1d863ac544a039dfa2aaca9b
+  data.tar.gz: 732f6a87815efa4092ea1404b55180d9bde78f39
 SHA512:
-  metadata.gz: 05ba4fbc4d3c3613b458b30a7370c832622ffc1ffee7cb4f2cefb408277a167cde5c5204a2fa53f2584b3a62c01abddce662a1ada86d22c30c97612fd53359ab
-  data.tar.gz: dfbd672e42dcd6944cfd3a9f246a8fd4e813cf77eeedf2b3bba7c1d38e58919335833c5ca49b1c8a45a61cec14da580b2fcabc4d1f2eeaf587da42f0a60bb692
+  metadata.gz: b205789714617196c0e067504e8beae29dc585a6601a79279475a3a17cc36b249d61e896c6972d8d2fc2b4780e5df406a86c92226ef6013fd6fb262087733ae6
+  data.tar.gz: 4e7766d5ee8b1adf676974e8dce8345ce93d2b4b9e868d4295578d35b5656897621c0dcf00e227377024946e2d7429c695e2bf86539fbd24a5992fdce2c9e4fd

data/Gemfile.lock

@@ -1,27 +1,27 @@
 PATH
   remote: .
   specs:
-    code_owners (1.0.4)
+    code_owners (1.0.8)
       rake
 
 GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.3)
-    rake (12.3.1)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rake (13.0.6)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
 
 PLATFORMS
   ruby
@@ -31,4 +31,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/README.md

@@ -5,6 +5,12 @@ Install
 
     gem install code_owners
 
+Requirements
+============
+
+* Ruby
+* Git
+
 Usage
 =====
 
@@ -24,12 +30,12 @@ Development
 
 Maybe put it in a cleanliness test, like:
 
-```
-  it "does not introduce new unowned files" do
-    unowned_files = CodeOwners.ownerships.select { |f| f[:owner] == "UNOWNED" }
-    # this number should only decrease, never increase!
-    assert_equal 12345, unowned_files.count, "Claim ownership of your new files in .github/CODEOWNERS to fix this test!"
-  end
+```ruby
+it "does not introduce new unowned files" do
+unowned_files = CodeOwners.ownerships.select { |f| f[:owner] == CodeOwners::NO_OWNER }
+# this number should only decrease, never increase!
+assert_equal 12345, unowned_files.count, "Claim ownership of your new files in .github/CODEOWNERS to fix this test!"
+end
 ```
 
 Author

data/bin/code_owners

@@ -1,10 +1,45 @@
 #!/usr/bin/env ruby
 
+unless system('git --version > /dev/null')
+  STDERR.puts 'Git does not appear to be installed.'
+  exit 2
+end
+
+unless system('git rev-parse --is-inside-work-tree > /dev/null')
+  STDERR.puts 'The current working directory must be a Git repo.'
+  exit 3
+end
+
 $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
 require 'code_owners'
+require 'code_owners/version'
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "usage: code_owners [options]"
+  opts.on('-u', '--unowned', TrueClass, 'Display unowned files only') do |u|
+    options[:unowned] = u
+  end
+  opts.on('-e', '--error-unowned', TrueClass, 'Exit with error status if any files are unowned') do |e|
+    options[:error_unowned] = e
+  end
+  opts.on('-v', '--version', TrueClass, 'Display the version of the gem') do |_|
+    puts "Version: #{CodeOwners::VERSION}"
+    exit 0
+  end
+end.parse!
 
+unowned_error = false
 CodeOwners.ownerships.each do |ownership_status|
   owner_info = ownership_status[:owner].dup
+  if owner_info != CodeOwners::NO_OWNER
+    next if options[:unowned]
+  else
+    unowned_error ||= options[:error_unowned]
+  end
   owner_info += " per line #{ownership_status[:line]}, #{ownership_status[:pattern]}" if owner_info != "UNOWNED"
   puts "#{ownership_status[:file].ljust(100,' ')} #{owner_info}"
 end
+
+exit(unowned_error && 1 || 0)

data/code_owners.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new name, CodeOwners::VERSION do |s|
   s.description   = "utility gem for .github/CODEOWNERS introspection"
   s.authors       = "Jonathan Cheatham"
   s.email         = "coaxis@gmail.com"
-  s.homepage      = "http://github.com/jcheatham/#{s.name}"
+  s.homepage      = "https://github.com/jcheatham/#{s.name}"
   s.licenses      = "MIT"
 
-  s.files         = `git ls-files`.split("\n")
+  s.files         = `git -c "core.quotepath=off" ls-files`.split("\n")
   s.bindir        = 'bin'
   s.test_files    = `git ls-files -- test/*`.split("\n")
   s.require_paths = ["lib"]

data/lib/code_owners/version.rb

@@ -1,3 +1,3 @@
 module CodeOwners
-  VERSION = "1.0.4"
+  VERSION = "1.0.8"
 end

data/lib/code_owners.rb

@@ -2,7 +2,9 @@ require "code_owners/version"
 require "tempfile"
 
 module CodeOwners
+  NO_OWNER = 'UNOWNED'
   class << self
+
     # github's CODEOWNERS rules (https://help.github.com/articles/about-codeowners/) are allegedly based on the gitignore format.
     # but you can't tell ls-files to ignore tracked files via an arbitrary pattern file
     # so we need to jump through some hacky git-fu hoops
@@ -13,24 +15,53 @@ module CodeOwners
     # -v -> verbose, outputs details about the matching pattern (if any) for each given pathname
     # -n -> non-matching, shows given paths which don't match any pattern
 
-    def ownerships
-      patterns, owners = pattern_owners.transpose
+    def log(message)
+      puts message
+    end
 
-      git_owner_info(patterns).map do |line, pattern, file|
+    def ownerships
+      patterns = pattern_owners
+      git_owner_info(patterns.map { |p| p[0] }).map do |line, pattern, file|
         if line.empty?
-          { file: file, owner: "UNOWNED" }
+          { file: file, owner: NO_OWNER, line: nil, pattern: nil }
         else
-          { file: file, owner: owners[line.to_i - 1], line: line, pattern: pattern }
+          {
+            file: file,
+            owner: patterns.fetch(line.to_i-1)[1],
+            line: line,
+            pattern: pattern
+          }
         end
       end
     end
 
+    def search_codeowners_file
+      paths = ["CODEOWNERS", "docs/CODEOWNERS", ".github/CODEOWNERS"]
+      for path in paths
+        current_file_path = File.join(current_repo_path, path)
+        return current_file_path if File.exist?(current_file_path)
+      end
+      abort("[ERROR] CODEOWNERS file does not exist.")
+    end
+
     # read the github file and spit out a slightly formatted list of patterns and their owners
+    # Empty/invalid/commented lines are still included in order to preserve line numbering
     def pattern_owners
-      codeowner_path = File.join(current_repo_path, ".github/CODEOWNERS")
-      File.read(codeowner_path).split("\n").map do |line|
-        line.gsub(/#.*/, '').gsub(/^$/, " @").split(/\s+@/, 2)
-      end
+      codeowner_path = search_codeowners_file
+      patterns = []
+      File.read(codeowner_path).split("\n").each_with_index { |line, i|
+        path_owner = line.split(/\s+@/, 2)
+        if line.match(/^\s*(?:#.*)?$/)
+          patterns.push ['', ''] # Comment/empty line
+        elsif path_owner.length != 2 || (path_owner[0].empty? && !path_owner[1].empty?)
+          log "Parse error line #{(i+1).to_s}: \"#{line}\""
+          patterns.push ['', ''] # Invalid line
+        else
+          path_owner[1] = '@'+path_owner[1]
+          patterns.push path_owner
+        end
+      }
+      return patterns
     end
 
     def git_owner_info(patterns)
@@ -46,7 +77,7 @@ module CodeOwners
       Tempfile.open('codeowner_patterns') do |file|
         file.write(patterns.join("\n"))
         file.rewind
-        `cd #{current_repo_path} && git ls-files | xargs -- git -c \"core.excludesfile=#{file.path}\" check-ignore --no-index -v -n`
+        `cd #{current_repo_path} && git -c \"core.quotepath=off\" ls-files | xargs -- git -c \"core.quotepath=off\" -c \"core.excludesfile=#{file.path}\" check-ignore --no-index -v -n`
       end
     end
 

data/spec/code_owners_spec.rb

@@ -1,38 +1,71 @@
 require 'code_owners'
+require 'tmpdir'
 
-RSpec.describe CodeOwners do
+RSpec.describe CodeOwners do |rspec|
   describe ".ownerships" do
     it "assigns owners to things" do
-      expect(CodeOwners).to receive(:pattern_owners).and_return([["pat1", "own1"], ["pat2", "own2"], ["pat3", "own3"]])
+      expect(CodeOwners).to receive(:pattern_owners).and_return([["pat1", "own1"], ["pat2*", "own2"], ["pat3", "own3"]])
       expect(CodeOwners).to receive(:git_owner_info).and_return(
         [
-          ["2", "whatever/pattern/thing", "this/is/a/file"],
+          ["2", "pat2*", "pat2file"],
           ["", "", "unowned/file"]
         ]
       )
       expect(CodeOwners.ownerships).to eq(
         [
-          { file: "this/is/a/file", owner: "own2", line: "2", pattern: "whatever/pattern/thing" },
-          { file: "unowned/file",   owner: "UNOWNED"}
+          { file: "pat2file", owner: "own2", line: "2", pattern: "pat2*" },
+          { file: "unowned/file", owner: "UNOWNED", line: nil, pattern: nil }
         ]
       )
     end
   end
 
   describe ".pattern_owners" do
+    around(:each) do |example|
+      Dir.mktmpdir { |d|
+        @d = d
+        f = File.new(File.join(d, 'CODEOWNERS'), 'w+')
+        f.write <<-CODEOWNERS
+lib/* @jcheatham
+some/path/** @someoneelse
+other/path/* @someoneelse @anotherperson
+invalid/codeowners/line 
+     @AnotherInvalidLine
+#comment-line (empty line next)
+
+# another comment line
+CODEOWNERS
+        f.close
+        example.run
+      }
+    end
+
     it "returns a list of patterns and owners" do
-      patterns, owners = CodeOwners.pattern_owners.transpose
-      expect(owners).to include("jcheatham")
-      expect(patterns).to include("lib/*")
+      expect(CodeOwners).to receive(:current_repo_path).and_return(@d)
+      expect(CodeOwners).to receive(:log).twice
+      pattern_owners = CodeOwners.pattern_owners
+      expect(pattern_owners).to include(["other/path/*", "@someoneelse @anotherperson"])
     end
 
     it "works when invoked in a repo's subdirectory" do
-      Dir.chdir("spec") do
-        patterns, owners = CodeOwners.pattern_owners.transpose
-        expect(owners).to include("jcheatham")
-        expect(patterns).to include("lib/*")
+      expect(CodeOwners).to receive(:current_repo_path).and_return(@d)
+      expect(CodeOwners).to receive(:log).twice
+      subdir = File.join(@d, 'spec')
+      Dir.mkdir(subdir)
+      Dir.chdir(subdir) do
+        pattern_owners = CodeOwners.pattern_owners
+        expect(pattern_owners).to include(["lib/*", "@jcheatham"])
       end
     end
+
+    it "prints validation errors and skips lines that aren't the expected format" do
+      expect(CodeOwners).to receive(:current_repo_path).and_return(@d)
+      expect(CodeOwners).to receive(:log).with("Parse error line 4: \"invalid/codeowners/line \"")
+      expect(CodeOwners).to receive(:log).with("Parse error line 5: \"     @AnotherInvalidLine\"")
+      pattern_owners = CodeOwners.pattern_owners
+      expect(pattern_owners).not_to include(["", "@AnotherInvalidLine"])
+      expect(pattern_owners).to include(["", ""])
+    end
   end
 
   describe ".git_owner_info" do
@@ -54,4 +87,16 @@ RSpec.describe CodeOwners do
       expect(raw_ownership).to match(/^(?:.*:\d*:.*\t.*\n)+$/)
     end
   end
+
+  describe "code_owners" do
+    VERSION_REGEX = /Version: \d+\.\d+\.\d+(-[a-z0-9]+)?/i
+
+    it "prints a version number with the short option" do
+      expect(`bin#{File::SEPARATOR}code_owners -v`).to match VERSION_REGEX
+    end
+
+    it "prints a version number with the short option" do
+      expect(`bin#{File::SEPARATOR}code_owners --version`).to match VERSION_REGEX
+    end
+  end
 end

data/spec/files//342/230/203.txt

@@ -0,0 +1 @@
+☃☃☃☃☃☃☃☃☃

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: code_owners
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.8
 platform: ruby
 authors:
 - Jonathan Cheatham
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2018-03-29 00:00:00.000000000 Z
@@ -57,11 +57,12 @@ files:
 - lib/code_owners.rb
 - lib/code_owners/version.rb
 - spec/code_owners_spec.rb
-homepage: http://github.com/jcheatham/code_owners
+- spec/files/☃.txt
+homepage: https://github.com/jcheatham/code_owners
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,9 +77,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.5.2.3
+signing_key:
 specification_version: 4
 summary: ".github/CODEOWNERS introspection utility gem"
 test_files: []