owners 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65952d9a4159c6a54c705d6a4d52a251a34eacb7
-  data.tar.gz: d414a754b03b3549b017bbe3cff45ce511f69487
+  metadata.gz: d94ac158a395b3d6032f898cbd8bf71758cfe415
+  data.tar.gz: 1c2e72fe393c988b077028866b47c94f57804fc3
 SHA512:
-  metadata.gz: 255d1ef9d4f7cf7c984d194e8224bc44c02ec72a26adaa2731955990d556bb111d306924675cd5b0a95cae364fb9738105474cc476774c93e675288a194bb719
-  data.tar.gz: 64a897f374262fb422aef1ea8181ae28ac4c8181318fc05db1a41cee6015626b7c09a5b767bd7df89d1fe705c757eaf4989bceaca9f51d77cadcca7f2c92bb4e
+  metadata.gz: 79ca73ab78b0ab0503e2a78c17fb9d5a32607eef4c3cacfa33071669db8126f6f6a56c65b860610925812093e00fc31e2595b0755187db5b6650a7cd333fd92b
+  data.tar.gz: bca896ff7b7912e506e7460f5f530645e51d7c43eae4e418e66b3a0d1d1f9d39c94a922822bd60e36dd83d38e6faef6fdb2a607151161a2574b0acbc09582a36

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    owners (0.0.0)
+    owners (0.0.2)
+      thor
 
 GEM
   remote: https://www.rubygems.org/
@@ -29,6 +30,7 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.9.0)
     simplecov-html (0.9.0)
+    thor (0.19.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -4,6 +4,14 @@
 
 Take ownership of your code.
 
+Knowing who owns a project or section of a code base is very helpful when asking questions or requesting feedback. This gem allows developers to define `OWNERS` files throughout their repository to provide a human and machine readable way to determine who the maintainers are for specific files of code.
+
+These files can be used to:
+
+* find the right people to ask when you have questions
+* notify maintainers when changes occur in the files that they care about
+* enforce approval from the appropriate people in pull requests
+
 
 ## Installation
 
@@ -26,7 +34,7 @@ jane@your-org.com
 #some_slack_channel
 ```
 
-The `OWNERS` file also supports limiting paths with regular expressions or exact matches. Any whitespace that separates the subscriber from the path limiters are ignored.
+The `OWNERS` file also supports limiting paths with regular expressions. Any whitespace that separates the subscriber from the path limiters is ignored.
 
 ```
 @data         app/models/.*
@@ -34,14 +42,33 @@ The `OWNERS` file also supports limiting paths with regular expressions or exact
 bob@demo.com  lib/bobs_special_file.rb
 ```
 
-Once your `OWNERS` files are defined, you can search for a list of owners by calling `Owners.for` with a list of paths e.g. output from `git diff --name-only`.
+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")
 ```
 
+This works well when comparing the files changed between `git` branches.
+
+```ruby
+files = `git diff --name-only master`.split("\n")
+Owners.for(*files)
+```
+
 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
+
+This gem also comes with a convenient `owners` command line interface. Each owner is printed out and separated by newlines.
+
+```bash
+owners for .env app/controllers/posts_controller.rb app/models/user.rb
+```
+
+See `owners help` for more information.
+
+
 ## API
 
 [YARD Documentation](http://www.rubydoc.info/github/shuber/owners)

data/bin/owners

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative "../lib/owners"
+Owners::CLI.start

data/lib/owners.rb

@@ -1,9 +1,11 @@
 require "pathname"
 require "set"
-require "owners/config"
-require "owners/search"
-require "owners/tree"
-require "owners/version"
+require "thor"
+require_relative "owners/cli"
+require_relative "owners/config"
+require_relative "owners/search"
+require_relative "owners/tree"
+require_relative "owners/version"
 
 module Owners
   class << self

data/lib/owners/cli.rb

@@ -0,0 +1,12 @@
+module Owners
+  class CLI < Thor
+    desc "for [FILES...]", "List owners for a set of files"
+    method_option :file, desc: "The name of the OWNERS file"
+    def for(*files)
+      Owners.file = options[:file] if options[:file]
+      Owners.for(*files).each do |owner|
+        puts owner
+      end
+    end
+  end
+end

data/lib/owners/version.rb

@@ -1,3 +1,3 @@
 module Owners
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/owners.gemspec

@@ -16,4 +16,5 @@ Gem::Specification.new do |s|
   s.version               = Owners::VERSION
 
   s.add_development_dependency "rspec"
+  s.add_dependency "thor"
 end

data/spec/owners_cli_spec.rb

@@ -0,0 +1,34 @@
+RSpec.describe Owners::CLI do
+  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
+    end
+
+    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
+end

data/spec/owners_spec.rb

@@ -21,6 +21,14 @@ RSpec.describe Owners do
       end
     end
 
+    context "with no paths" do
+      let(:paths) { [] }
+
+      it "parses owners correctly" do
+        expect(subject).to eq([])
+      end
+    end
+
     context "with no matches" do
       let(:paths) { ["some-path-without-owners"] }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: owners
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sean Huber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-22 00:00:00.000000000 Z
+date: 2015-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: github@shuber.io
 executables: []
@@ -38,6 +52,7 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
+- bin/owners
 - example/OWNERS
 - example/app/OWNERS
 - example/app/controllers/posts_controller.rb
@@ -47,11 +62,13 @@ files:
 - example/app/models/post.rb
 - example/app/models/user.rb
 - lib/owners.rb
+- lib/owners/cli.rb
 - lib/owners/config.rb
 - lib/owners/search.rb
 - lib/owners/tree.rb
 - lib/owners/version.rb
 - owners.gemspec
+- spec/owners_cli_spec.rb
 - spec/owners_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/shuber/owners
@@ -84,5 +101,6 @@ signing_key:
 specification_version: 4
 summary: Take ownership of your code
 test_files:
+- spec/owners_cli_spec.rb
 - spec/owners_spec.rb
 - spec/spec_helper.rb