owners 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2c5d1368d6ed27a906ece70e3a6edf976a9b0ac
-  data.tar.gz: 8c1436b5ed74e1fbfcef72b046f861ba2d9bb889
+  metadata.gz: e5b8497545c8bae9b0559c54ab774eca59b76902
+  data.tar.gz: 713afb83cfb32bd97564fe357b00af5fd75f18fa
 SHA512:
-  metadata.gz: 0d4d45161eea9276c36647ab495ab5390d94b92a52532469094f53eead63a1f4e95010dd9ce77b0b1b27e7cc87d94cf7292818be4f705355c509167f5846e89b
-  data.tar.gz: 867e795bb099861807809d7248eb6224cc66a40f828fc34d0b81a0492795a16ffab4d24acfa39df9ccc3ca3827187aefc616feeff2b2a12b0d268d231b690789
+  metadata.gz: e680ddde0602250c8265365b241d3da884f6f6f55c0e249f1a2da57a63c94b099c0818e675a2b7b58ccdcb9d4e29d4b45430b92059736e7cfad645901586763d
+  data.tar.gz: 83aa63b203e8abec894387322c26265ab28c06f6586e2b1c721f1cd258999a7cf9c2724cc0fee2341b30533c3db6f364108d070add048b682886e2cc69156932

data/Gemfile.lock

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

data/README.md

@@ -48,11 +48,10 @@ Find the owners for specific files by passing them to the `Owners.for` method.
 Owners.for(".env", "app/controllers/posts_controller.rb", "app/models/user.rb")
 ```
 
-This works well when comparing the files changed between `git` branches.
+To find the owners for files changed with `git diff` use the `Owners.for_diff` method.
 
 ```ruby
-files = `git diff --name-only master`.split("\n")
-Owners.for(*files)
+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!
@@ -66,6 +65,10 @@ 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
 ```
 
+```bash
+owners for_diff my-feature-branch
+```
+
 See `owners help` for more information.
 
 
@@ -76,6 +79,7 @@ See `owners help` for more information.
 * `Owners.file`
 * `Owners.file=`
 * `Owners.for`
+* `Owners.for_diff`
 
 
 ## Testing

data/example/app/controllers/posts_controller.rb

@@ -0,0 +1 @@
+# touched

data/example/app/models/post.rb

@@ -0,0 +1 @@
+# touched

data/lib/owners.rb

@@ -27,5 +27,27 @@ module Owners
     def for(*files)
       Search.new(files).owners
     end
+
+    # Accepts a git ref and an optional base ref and returns
+    # an array of owners that have subscribed to the changes.
+    #
+    # The base ref defaults to "master".
+    #
+    # @api public
+    def for_diff(ref, base = "master")
+      files = `git diff --name-only #{base}...#{ref}`.split("\n")
+
+      # TODO: why doesn't this work? It works in the command line...
+      # blobs = `git ls-tree -r #{ref} | **/#{file}`.split("\n")
+      blobs = `git ls-tree -r #{ref} | egrep "(^|/)#{file}$"`.split("\n")
+
+      configs = blobs.reduce({}) do |hash, line|
+        _, _, sha, file = line.split(/\s+/, 4)
+        contents = `git show #{sha}`
+        hash.update(file => contents)
+      end
+
+      Search.new(files, configs).owners
+    end
   end
 end

data/lib/owners/cli.rb

@@ -8,5 +8,14 @@ module Owners
         puts owner
       end
     end
+
+    desc "for_diff REF [BASE_REF]", "List owners for a set of git changes"
+    method_option :file, desc: "The name of the OWNERS file"
+    def for_diff(ref, base_ref = "master")
+      Owners.file = options[:file] if options[:file]
+      Owners.for_diff(ref, base_ref).each do |owner|
+        puts owner
+      end
+    end
   end
 end

data/lib/owners/config.rb

@@ -4,14 +4,14 @@ module Owners
   #
   # @api private
   class Config
-    def initialize(file)
-      @contents = file.read
-      @root = file.dirname.to_s
+    def initialize(file, contents = nil)
+      @contents = contents || file.read
+      @root = File.dirname(file.to_s)
     end
 
     def owners(path)
-      if path.start_with?(@root)
-        relative = path.sub("#{@root}/", "")
+      if path =~ prefix
+        relative = path.sub(prefix, "")
 
         search do |subscription, results|
           owner, pattern = subscription.split(/\s+/, 2)
@@ -23,6 +23,10 @@ module Owners
 
     private
 
+    def prefix
+      /\.?\/?#{@root}\//
+    end
+
     def search(&block)
       subscriptions.each_with_object([], &block)
     end

data/lib/owners/search.rb

@@ -4,8 +4,9 @@ module Owners
   #
   # @api private
   class Search
-    def initialize(files)
+    def initialize(files, configs = nil)
       @files = files
+      @configs = configs
     end
 
     def owners
@@ -26,7 +27,11 @@ module Owners
     end
 
     def configs
-      subscriptions.map { |file| Config.new(file) }
+      if @configs
+        @configs.map { |file, contents| Config.new(file, contents) }
+      else
+        subscriptions.map { |file| Config.new(file) }
+      end
     end
 
     def subscriptions

data/lib/owners/version.rb

@@ -1,3 +1,3 @@
 module Owners
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/owners_cli_spec.rb

@@ -1,21 +1,45 @@
 RSpec.describe Owners::CLI do
+  subject { capture { command } }
+
+  let(:command) { described_class.start(args) }
+
+  def capture
+    stdout = $stdout
+    $stdout = StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = stdout
+  end
+
   describe "for" do
-    subject { capture { command } }
-    let(:command) { described_class.start(args) }
     let(:args) { ["for", "example/app/controllers/users_controller.rb"] }
 
-    def capture
-      stdout = $stdout
-      $stdout = StringIO.new
-      yield
-      $stdout.string
-    ensure
-      $stdout = stdout
+    context "without a specified file" do
+      it "parses owners correctly" do
+        expect(subject).to eq("@org/auth\n@org/blog\n")
+      end
     end
 
+    context "with a specified file" do
+      before { args << "--file" << "SOMETHING_ELSE" }
+
+      it "overrides the default OWNERS filename" do
+        begin
+          expect(subject).to eq("")
+        ensure
+          Owners.file = nil
+        end
+      end
+    end
+  end
+
+  describe "for_diff" do
+    let(:args) { ["for_diff", "0757297", "d0e67df"] }
+
     context "without a specified file" do
       it "parses owners correctly" do
-        expect(subject).to eq("@org/auth\n@org/blog\n")
+        expect(subject).to eq("@org/blog\n@whitespace\ndata@example.com\n")
       end
     end
 

data/spec/owners_spec.rb

@@ -61,4 +61,26 @@ RSpec.describe Owners do
       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" }
+
+      it "parses owners correctly" do
+        expect(subject).to eq(["@org/blog"])
+      end
+    end
+
+    context "when comparing multiple commits" do
+      let(:ref) { "0757297" }
+      let(:base_ref) { "d0e67df" }
+
+      it "parses owners correctly" do
+        expect(subject).to eq(["@org/blog", "@whitespace", "data@example.com"])
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: owners
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Sean Huber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2015-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -54,6 +54,7 @@ files:
 - README.md
 - bin/owners
 - example/OWNERS
+- example/OWNERS.csv
 - example/app/OWNERS
 - example/app/controllers/posts_controller.rb
 - example/app/controllers/users_controller.rb