owners 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64c2797db569920e3c8203794993b523da633e2f
-  data.tar.gz: 92e8420a4de1f80b20a62e1beb0564aba38fa58c
+  metadata.gz: 5b6b42791dcd2801448725619a34e70091c5d84b
+  data.tar.gz: dca77d4996a6a2e9e0fedf15a4b86308f37b5187
 SHA512:
-  metadata.gz: 7b5b94331a57d20452c827b3adb5b64352f969533fb52fa14504810af5ca89071fa5a0c30f43b008a0f981d19c6cfff010798524bb2f526c96573429eb073d28
-  data.tar.gz: 1b286d7dc02d0a0d15d841369bc443b6be22db1b5fa3c9d4a0e2cb632888dec2c6c48092a36be6da44fe72e6dcec1e9a493509e20bfb40ab03c82d30f4466791
+  metadata.gz: 1c40ac244b5ff0bf3aa6c7a465a09291a784bfd97a9f8c5c3cdd8719581e6d9e6583defe885a1d69819a16d75daf7eaeda5fef755a597a4f52b1cab490585c94
+  data.tar.gz: 124a7bfa90f7aa4b59cc241d9b9da38053aca59e41735768972aca871fe21a936097dabef27af8b7d12134e3d0a96a09ba8c8e5bb856133ba8f9ddac06c09b8b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    owners (0.0.7)
+    owners (0.0.8)
       thor
 
 GEM

data/README.md

@@ -34,18 +34,42 @@ jane@your-org.com
 #some_slack_channel
 ```
 
-The `OWNERS` file also supports limiting paths with regular expressions. Any whitespace that separates the subscriber from the path limiters is ignored.
+The `OWNERS` file also supports filtering paths with regular expressions. Any whitespace between these filters and their corresponding subscribers is ignored.
 
 ```
 @data         app/models/.*
 @ui           \.(css|haml|js|scss)$
 bob@demo.com  lib/bobs_special_file.rb
+#whitespace   path/with spaces/is all part/of the filter.txt
+```
+
+Subscribers can be listed multiple times in an `OWNERS` file.
+
+```
+@data app/models
+@data db
+```
+
+Multiple comma separated subscribers can be listed for the same filter.
+
+```
+@data,@team-leads db
+```
+
+Comments are supported by prefixing lines with `//`.
+
+```
+// this comment will be ignored
+//// this one two
+  // even this one with whitespace
+
+@data,@team-leads db
 ```
 
 Find the owners for specific files by passing them to the `Owners.for` method.
 
 ```ruby
-Owners.for(".env", "app/controllers/posts_controller.rb", "app/models/user.rb")
+Owners.for("app/models/user.rb", "db/schema.rb") #=> ["@data", "@team-leads"]
 ```
 
 To find the owners for files changed with `git diff` use the `Owners.for_diff` method.
@@ -54,8 +78,6 @@ To find the owners for files changed with `git diff` use the `Owners.for_diff` m
 Owners.for_diff("your-feature-branch-or-ref", "optional-base-ref-defaults-to-master")
 ```
 
-This method returns a unique array of all the owners who have subscribed to changes for the specified files. These subscribers can then be notified however you see fit!
-
 
 ## CLI
 
@@ -65,6 +87,14 @@ This gem also comes with a convenient `owners` command line interface. Each owne
 owners for .env app/controllers/posts_controller.rb app/models/user.rb
 ```
 
+```
+@infrastructure
+@api
+@data
+```
+
+The `git diff` integration works in the command line as well.
+
 ```bash
 owners for_diff my-feature-branch
 ```

data/example/OWNERS

@@ -1 +1,8 @@
+// comment
 @org/blog
+@multiple,@owners db
+//comment
+
+////// comment
+
+  // comment

data/lib/owners/config.rb

@@ -4,6 +4,8 @@ module Owners
   #
   # @api private
   class Config
+    COMMENT = /^\s*\/\//
+
     def initialize(file, contents = nil)
       @contents = contents || file.read
       @root = File.dirname(file.to_s)
@@ -14,9 +16,8 @@ module Owners
         relative = path.sub(prefix, "")
 
         search do |subscription, results|
-          owner, pattern = subscription.split(/\s+/, 2)
-          regex = Regexp.new(pattern || ".*")
-          results << owner if regex =~ relative
+          owners = subscribers(relative, subscription)
+          results.push(*owners)
         end
       end
     end
@@ -32,7 +33,18 @@ module Owners
     end
 
     def subscriptions
-      @contents.split("\n").reject(&:empty?)
+      @contents.split("\n").reject do |subscription|
+        subscription.empty? || subscription =~ COMMENT
+      end
+    end
+
+    def subscribers(path, subscription)
+      subscribers, pattern = subscription.split(/\s+/, 2)
+      regex = Regexp.new(pattern || ".*")
+
+      subscribers.split(",").tap do |owners|
+        owners.clear unless regex =~ path
+      end
     end
   end
 end

data/lib/owners/version.rb

@@ -1,3 +1,3 @@
 module Owners
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/owners_cli_spec.rb

@@ -35,7 +35,7 @@ RSpec.describe Owners::CLI do
   end
 
   describe "for_diff" do
-    let(:args) { ["for_diff", "0757297", "d0e67df"] }
+    let(:args) { ["for_diff", "781b3b2", "ba7cd78"] }
 
     context "without a specified file" do
       it "parses owners correctly" do

data/spec/owners_spec.rb

@@ -60,14 +60,30 @@ RSpec.describe Owners do
         expect(subject).to eq(["@duplicate", "@org/blog", "@owner", "data@example.com"])
       end
     end
+
+    context "with multiple comma separated owners" do
+      let(:paths) { ["example/db/schema.rb"] }
+
+      it "parses owners correctly" do
+        expect(subject).to eq(["@multiple", "@org/blog", "@owners"])
+      end
+    end
+
+    context "with comments" do
+      let(:paths) { ["example/comment"] }
+
+      it "parses owners correctly" do
+        expect(subject).to eq(["@org/blog"])
+      end
+    end
   end
 
   describe ".for_diff" do
     subject { described_class.for_diff(ref, base_ref) }
 
     context "when comparing one commit" do
-      let(:ref) { "0757297" }
-      let(:base_ref) { "6683118" }
+      let(:ref) { "781b3b2" }
+      let(:base_ref) { "6f4f89a" }
 
       it "parses owners correctly" do
         expect(subject).to eq(["@org/blog"])
@@ -75,8 +91,8 @@ RSpec.describe Owners do
     end
 
     context "when comparing multiple commits" do
-      let(:ref) { "0757297" }
-      let(:base_ref) { "d0e67df" }
+      let(:ref) { "781b3b2" }
+      let(:base_ref) { "ba7cd78" }
 
       it "parses owners correctly" do
         expect(subject).to eq(["@org/blog", "@whitespace", "data@example.com"])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: owners
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Sean Huber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -64,6 +64,7 @@ files:
 - example/app/models/comment.rb
 - example/app/models/post.rb
 - example/app/models/user.rb
+- example/db/migrate.rb
 - lib/owners.rb
 - lib/owners/cli.rb
 - lib/owners/config.rb