owners 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20bc5ff50e8b6c0614a56bf72251c9dc8a1d059c
-  data.tar.gz: a765f585fde8b708ee5ff77c3214af251eff0407
+  metadata.gz: 3ee93e4fe5cb329bf5df70608c572efa974963c4
+  data.tar.gz: 578b7e1c7ece642fa707b8499756c1424e2e77b0
 SHA512:
-  metadata.gz: 6ccafca0dd0655c27e80103e06f7cc61dce514bb1f8c556b048851de1eddb43752db874eb331c85ec64d499fb620368b2d503376040d5eb1375bc80b24013e5e
-  data.tar.gz: bfbd3c7370a857c1c090b2332e42ae1ff7007c7c4322ba992c168afb34fa6e2bd43ca56a442750fb5335a8e208ee77e275c7c2d217b11e11ad12915ceea49de2
+  metadata.gz: 6f2c6ee735c8135a86454cf69e08888e18f102dfdc75546c64afcbc00caba068edf90d8e3a5c284378314b60bc0762c68d12ef9a7bf00deea1be24992954c780
+  data.tar.gz: 6038c4e460cb1aa68ee140e6e464890fae548ea1e0c177ce9cda055826012da6fc002bf797d7a56385cdb65c9ae75be447d3c19da37c74f28e9faf06493ccd3a

data/Gemfile.lock

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

data/README.md

@@ -123,6 +123,14 @@ end
   OWNERS:7 => (?-mix:.env)
 ```
 
+#### Finding files without owners
+
+Stay on top of owner subscriptions by finding files that don't have any owners yet.
+
+```ruby
+Owners.missing_for(".env", "some/other/file.rb") #=> ["some/other/file.rb"]
+```
+
 #### Git diff integration
 
 To find the owners for files changed with `git diff` use the `Owners.for_diff` method.
@@ -193,6 +201,7 @@ See `owners help` for more information.
 * `Owners.file=`
 * `Owners.for`
 * `Owners.for_diff`
+* `Owners.missing_for`
 * `Owners::Owner#type`
 * `Owners::Owner#subscriptions`
 * `Owners::Subscription#file`

data/lib/owners.rb

@@ -2,6 +2,7 @@ require "delegate"
 require "pathname"
 require "set"
 require "thor"
+require "timeout"
 require_relative "owners/cli"
 require_relative "owners/config"
 require_relative "owners/owner"
@@ -28,7 +29,7 @@ module Owners
     #
     # @api public
     def for(*files)
-      Search.new(files).results
+      Search.new(files).owners
     end
 
     # Accepts a git ref and an optional base ref and returns
@@ -50,7 +51,16 @@ module Owners
         hash.update(file => contents)
       end
 
-      Search.new(files, configs).results
+      Search.new(files, configs).owners
+    end
+
+    # Accepts a list of file paths and returns an array of
+    # the ones that do not have subscribed owners.
+    #
+    # @api public
+    def missing_for(*files)
+      paths = Search.new(files, shallow: true).paths
+      files - paths
     end
   end
 end

data/lib/owners/cli.rb

@@ -1,5 +1,7 @@
 module Owners
   class CLI < Thor
+    include Timeout
+
     class_option :debug,
       aliases: %w(-d),
       desc: "Output additional subscription debugging info",
@@ -12,6 +14,8 @@ module Owners
 
     desc "for [FILES...]", "List owners for a set of files"
     def for(*files)
+      files = stdin_files unless files.any?
+
       Owners.file = options[:file] if options[:file]
       Owners.for(*files).each do |owner|
         output(owner)
@@ -26,6 +30,16 @@ module Owners
       end
     end
 
+    desc "missing_for [FILES...]", "List files that don't have owners"
+    def missing_for(*files)
+      files = stdin_files unless files.any?
+
+      Owners.file = options[:file] if options[:file]
+      Owners.missing_for(*files).each do |owner|
+        output(owner)
+      end
+    end
+
     no_commands do
       def output(owner)
         say owner
@@ -43,6 +57,12 @@ module Owners
           end
         end
       end
+
+      def stdin_files
+        timeout(1) { $stdin.read.split("\n") }
+      rescue Timeout::Error
+        []
+      end
     end
   end
 end

data/lib/owners/config.rb

@@ -21,10 +21,11 @@ module Owners
       @root = File.dirname(@file)
     end
 
-    def subscriptions(path)
+    def subscriptions(path, shallow)
       search do |subscription, results|
         if subscription.subscribed?(path)
           results << subscription
+          return results if shallow
         end
       end
     end

data/lib/owners/search.rb

@@ -6,16 +6,23 @@ module Owners
   class Search
     RELATIVE = /^\.?\//
 
-    def initialize(files, configs = nil)
+    def initialize(files, configs = nil, shallow: false)
       @files = files.map(&:dup)
       @configs = configs
+      @shallow = shallow
     end
 
-    def results
-      owners.each do |owner|
-        subscriptions.each do |path, subscription|
-          if subscription.subscribers.include?(owner)
-            owner.subscriptions[path] << subscription
+    def paths
+      subscriptions_by_file.keys
+    end
+
+    def owners
+      subscribers.map do |subscriber|
+        Owner.new(subscriber).tap do |owner|
+          subscriptions.each do |path, subscription|
+            if subscription.subscribers.include?(owner)
+              owner.subscriptions[path] << subscription
+            end
           end
         end
       end
@@ -23,10 +30,6 @@ module Owners
 
     private
 
-    def owners
-      subscribers.map { |subscriber| Owner.new(subscriber) }
-    end
-
     def subscribers
       subscriptions_by_file
         .values
@@ -44,7 +47,8 @@ module Owners
     def subscriptions_by_file
       search do |(path, config), results|
         relative = path.sub("./", "")
-        results[relative] += config.subscriptions(path)
+        matches = config.subscriptions(path, @shallow)
+        results[relative] += matches if matches.any?
       end
     end
 
@@ -54,7 +58,7 @@ module Owners
     end
 
     def attempts
-      paths.map(&:to_s).product(configs)
+      pathnames.map(&:to_s).product(configs)
     end
 
     def configs
@@ -66,10 +70,10 @@ module Owners
     end
 
     def trees
-      paths.map { |path| Tree.new(path) }
+      pathnames.map { |path| Tree.new(path) }
     end
 
-    def paths
+    def pathnames
       @files.map do |file|
         file.prepend("./") unless file =~ RELATIVE
         Pathname.new(file)

data/lib/owners/version.rb

@@ -1,3 +1,3 @@
 module Owners
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/spec/owners_cli_spec.rb

@@ -1,14 +1,17 @@
 RSpec.describe Owners::CLI do
-  subject { capture { command } }
+  subject { capture(stdin) { command } }
 
   let(:command) { described_class.start(args) }
+  let(:stdin) { StringIO.new }
 
-  def capture
+  def capture(stdin)
+    stdin, $stdin = $stdin, stdin
     stdout = $stdout
     $stdout = StringIO.new
     yield
     $stdout.string
   ensure
+    $stdin = stdin
     $stdout = stdout
   end
 
@@ -33,7 +36,7 @@ RSpec.describe Owners::CLI do
       end
     end
 
-    context "without debugging" do
+    context "with debugging" do
       before { args << "-d" }
 
       it "parses owners correctly" do
@@ -53,6 +56,34 @@ group
         expect(subject).to eq(expected)
       end
     end
+
+    context "with stdin" do
+      let(:stdin) { StringIO.new("example/app/controllers/users_controller.rb") }
+
+      context "without paths" do
+        let(:args) { ["for"] }
+
+        it "reads paths from stdin" do
+          expect(subject).to eq("@org/auth\n@org/blog\n")
+        end
+      end
+
+      context "with paths" do
+        it "does not read paths from stdin" do
+          expect(subject).to eq("@org/auth\n@org/blog\n")
+        end
+      end
+
+      context "after timeout" do
+        let(:args) { ["for"] }
+        let(:stdin) { double("stdin") }
+
+        it "assumes no files were specified" do
+          expect(stdin).to receive(:read) { raise Timeout::Error }
+          expect(subject).to eq("")
+        end
+      end
+    end
   end
 
   describe "for_diff" do
@@ -76,4 +107,18 @@ group
       end
     end
   end
+
+  describe ".missing_for" do
+    context "with multiple paths" do
+      let(:args) {[
+        "missing_for",
+        "example/app/controllers/posts_controller.rb",
+        "path/without/owner.rb",
+      ]}
+
+      it "parses missing files missing owners correctly" do
+        expect(subject).to eq("path/without/owner.rb\n")
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: owners
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Sean Huber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2016-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec