code_owners 1.0.6 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: b742a1fbaa41ae70ad7acc4f258ce685517c74d91855fe554ce29fbb02ca9d99
-  data.tar.gz: 9535aa63120da63e000b8fee5500d696e9d0ee097a12a9bfb052aab5f6b2fb00
+SHA1:
+  metadata.gz: add8d9474667ea07ea6ad3e207e9a0e085109ac9
+  data.tar.gz: 86f55b021ef6314614ac2e5f2a59dfec43adbcd1
 SHA512:
-  metadata.gz: f2bed6c4f9a8991d6319b31b9d41e6fddc63bdb9cb584a6629106f90514944384f9d67a18134a0afd3c68ff13fb46c8c994af08ad8a1cfebec040d360343ca4f
-  data.tar.gz: bad817126846774d0e62706229351b2abd189bfeb570d16d994d2e01cdc7998bee78dab90979f41fcb3546824f744714a644c28fcc09fe0e8bfb78a2ba29d2b0
+  metadata.gz: 6bc09a62ef1d0b86e7a9be070b27c5ed0e21be5b797f29b2597b3c06ffecc8210fd50906319f67028bc8e8a4df3aa2b575ab5ae49a083f2af029f43182d9d074
+  data.tar.gz: 62e13f5c44667eff192eabb510dca677a2088e58ce123e3dbaf4ccd16c8ebf9eb1dffa8125d5524161de36df730b9eea83093776ea6a55fb40c72df6f741eec3

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    code_owners (1.0.6)
+    code_owners (1.0.9)
       rake
 
 GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.3)
-    rake (12.3.3)
+    rake (13.0.6)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -31,4 +31,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.17.2
+   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.6"
+  VERSION = "1.0.9"
 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
@@ -17,11 +19,15 @@ module CodeOwners
       puts message
     end
 
+    def file_ownerships
+      Hash[ ownerships.map { |o| [o[:file], o] } ]
+    end
+
     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", line: nil, pattern: nil }
+          { file: file, owner: NO_OWNER, line: nil, pattern: nil }
         else
           {
             file: file,
@@ -75,7 +81,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 -z | xargs -0 -- git -c \"core.quotepath=off\" -c \"core.excludesfile=#{file.path}\" check-ignore --no-index -v -n`
       end
     end
 

data/spec/code_owners_spec.rb

@@ -2,6 +2,23 @@ require 'code_owners'
 require 'tmpdir'
 
 RSpec.describe CodeOwners do |rspec|
+  describe ".file_ownerships" do
+    it "returns a hash of ownerships keyed by file path" do
+      expect(CodeOwners).to receive(:ownerships).and_return(
+        [
+          { file: "pat2file", owner: "own2", line: "2", pattern: "pat2*" },
+          { file: "unowned/file", owner: "UNOWNED", line: nil, pattern: nil }
+        ]
+      )
+      expect(CodeOwners.file_ownerships).to eq(
+        {
+          "pat2file" => { file: "pat2file", owner: "own2", line: "2", pattern: "pat2*" },
+          "unowned/file" => { file: "unowned/file", owner: "UNOWNED", line: nil, pattern: nil }
+        }
+      )
+    end
+  end
+
   describe ".ownerships" do
     it "assigns owners to things" do
       expect(CodeOwners).to receive(:pattern_owners).and_return([["pat1", "own1"], ["pat2*", "own2"], ["pat3", "own3"]])
@@ -29,7 +46,7 @@ RSpec.describe CodeOwners do |rspec|
 lib/* @jcheatham
 some/path/** @someoneelse
 other/path/* @someoneelse @anotherperson
-invalid/codeowners/line 
+invalid/code owners/line
      @AnotherInvalidLine
 #comment-line (empty line next)
 
@@ -60,7 +77,7 @@ CODEOWNERS
 
     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 4: \"invalid/code owners/line\"")
       expect(CodeOwners).to receive(:log).with("Parse error line 5: \"     @AnotherInvalidLine\"")
       pattern_owners = CodeOwners.pattern_owners
       expect(pattern_owners).not_to include(["", "@AnotherInvalidLine"])
@@ -86,5 +103,24 @@ CODEOWNERS
       expect(raw_ownership.size).to be >= 1
       expect(raw_ownership).to match(/^(?:.*:\d*:.*\t.*\n)+$/)
     end
+
+    context "when path includes a space" do
+      it "returns the path in single line" do
+        raw_ownership = CodeOwners.raw_git_owner_info(["/spec/files/*"])
+        expect(raw_ownership).to match(/.+:\d+:.+\tspec\/files\/file name\.txt\n/)
+      end
+    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/file name.txt

@@ -0,0 +1 @@
+This file's name includes a space.

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.6
+  version: 1.0.9
 platform: ruby
 authors:
 - Jonathan Cheatham
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2018-03-29 00:00:00.000000000 Z
@@ -57,11 +57,13 @@ files:
 - lib/code_owners.rb
 - lib/code_owners/version.rb
 - spec/code_owners_spec.rb
-homepage: http://github.com/jcheatham/code_owners
+- spec/files/file name.txt
+- 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,8 +78,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.14.4
+signing_key:
 specification_version: 4
 summary: ".github/CODEOWNERS introspection utility gem"
 test_files: []