code_owners 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24ab19a06481e09c20a3f95fea27072d53295a71fbc1bde5be7eac2e9eb35c23
-  data.tar.gz: a944a07f298772b8cbe20526a8e32415601a29fba24d5f8943602cfbbbe68e6a
+  metadata.gz: b742a1fbaa41ae70ad7acc4f258ce685517c74d91855fe554ce29fbb02ca9d99
+  data.tar.gz: 9535aa63120da63e000b8fee5500d696e9d0ee097a12a9bfb052aab5f6b2fb00
 SHA512:
-  metadata.gz: f1436b88d8d02715528137180e920d55f944a9d81fd8c6f5e4795da75d45efd221818fb79c2276e73399a81378bf33491bd2183ad570a4ab9bade020020b404d
-  data.tar.gz: e4d28dd008b14ba0c42c04ae588f1753d90efe9fa3425b521175013f450b27f76c25d03420d18a4805a426f7fb17efb096e58ae5fb07e3a6c9b476f46d118aa4
+  metadata.gz: f2bed6c4f9a8991d6319b31b9d41e6fddc63bdb9cb584a6629106f90514944384f9d67a18134a0afd3c68ff13fb46c8c994af08ad8a1cfebec040d360343ca4f
+  data.tar.gz: bad817126846774d0e62706229351b2abd189bfeb570d16d994d2e01cdc7998bee78dab90979f41fcb3546824f744714a644c28fcc09fe0e8bfb78a2ba29d2b0

data/Gemfile.lock

@@ -1,27 +1,27 @@
 PATH
   remote: .
   specs:
-    code_owners (1.0.5)
+    code_owners (1.0.6)
       rake
 
 GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.3)
-    rake (12.3.2)
-    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 (12.3.3)
+    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

data/lib/code_owners.rb

@@ -13,14 +13,22 @@ 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: "UNOWNED", 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
@@ -35,11 +43,23 @@ module CodeOwners
     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 = search_codeowners_file
-      File.read(codeowner_path).split("\n").map do |line|
-        line.gsub(/#.*/, '').gsub(/^$/, " @").split(/\s+@/, 2)
-      end
+      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)

data/lib/code_owners/version.rb

@@ -1,3 +1,3 @@
 module CodeOwners
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code_owners
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Jonathan Cheatham