owners 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03249f63f81c9db5877a0f55d0562c78e725afc6
-  data.tar.gz: 4cc529092d6d620a6cc1c652c819f9d7b63d662f
+  metadata.gz: 65952d9a4159c6a54c705d6a4d52a251a34eacb7
+  data.tar.gz: d414a754b03b3549b017bbe3cff45ce511f69487
 SHA512:
-  metadata.gz: ff1c532d637a42f59b985764d90f686629ac3be3fefc8bca062eda6be54f141ca599f86c88aedc6b6e22d5ff940b9a6e20c7ac236bbfc3015150a3a2d50123e7
-  data.tar.gz: c6fe901e8fe7467cb8eda35f12d6d2d468e4c0b8a2999c935d8e092c57de18339926834202490fa6f2e191bdf1791a40b7a7e243caf6a953c57b812653b7e525
+  metadata.gz: 255d1ef9d4f7cf7c984d194e8224bc44c02ec72a26adaa2731955990d556bb111d306924675cd5b0a95cae364fb9738105474cc476774c93e675288a194bb719
+  data.tar.gz: 64a897f374262fb422aef1ea8181ae28ac4c8181318fc05db1a41cee6015626b7c09a5b767bd7df89d1fe705c757eaf4989bceaca9f51d77cadcca7f2c92bb4e

data/.travis.yml

@@ -0,0 +1,11 @@
+addons:
+  code_climate:
+    repo_token: ca03d82be038f1e592be540bc81030c2cc69101d13f99acfd1889bbd47d17824
+
+install: bundle install --jobs 3 --retry 3
+
+rvm:
+  - 2.0.0
+  - ruby-head
+
+script: bundle exec rspec

data/Gemfile

@@ -1,5 +1,5 @@
-source 'https://www.rubygems.org'
+source "https://www.rubygems.org"
 
 gemspec
 
-gem 'codeclimate-test-reporter'
+gem "codeclimate-test-reporter"

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/shuber/owners.svg)](http://travis-ci.org/shuber/owners) [![Code Climate](https://codeclimate.com/github/shuber/owners/badges/gpa.svg)](https://codeclimate.com/github/shuber/owners) [![Coverage](https://codeclimate.com/github/shuber/owners/badges/coverage.svg)](https://codeclimate.com/github/shuber/owners) [![Gem Version](https://badge.fury.io/rb/owners.svg)](http://badge.fury.io/rb/owners)
 
-Take ownership of your code
+Take ownership of your code.
 
 
 ## Installation
@@ -16,7 +16,7 @@ gem install owners
 
 Define an `OWNERS` file in any directory within your repository. This file should contain a newline separated list of subscribers to notify when files within the directory have changed. The `OWNERS` files are searched recursively up the tree to make organizing owners more convenient.
 
-Subscribers can be anything that suits your needs e.g. emails, GitHub handles, or Slack channels.
+Subscribers can be anything that suits your needs e.g. emails, GitHub handles, Slack channels, etc.
 
 ```
 bob@your-org.com
@@ -34,18 +34,20 @@ 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`
+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`.
 
 ```ruby
 Owners.for(".env", "app/controllers/posts_controller.rb", "app/models/user.rb")
 ```
 
-This method returns a unique array of all the owners who have subscribed to changes for the specified 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!
 
 ## API
 
 [YARD Documentation](http://www.rubydoc.info/github/shuber/owners)
 
+* `Owners.file`
+* `Owners.file=`
 * `Owners.for`
 
 

data/lib/owners.rb

@@ -1,10 +1,29 @@
-require 'owners/config'
-require 'owners/path'
-require 'owners/search'
-require 'owners/version'
+require "pathname"
+require "set"
+require "owners/config"
+require "owners/search"
+require "owners/tree"
+require "owners/version"
 
 module Owners
-  def self.for(*paths)
-    Search.new(paths).owners
+  class << self
+    # @api public
+    attr_writer :file
+
+    # The name of the file used to store ownership
+    # subscriptions. Defaults to OWNERS.
+    #
+    # @api public
+    def file
+      @file ||= "OWNERS"
+    end
+
+    # Accepts a list of file paths and returns an array of
+    # owners that have subscribed to the specified files.
+    #
+    # @api public
+    def for(*files)
+      Search.new(files).owners
+    end
   end
 end

data/lib/owners/config.rb

@@ -1,22 +1,32 @@
 module Owners
+  # Parses an OWNERS file and returns an array of owners
+  # that have subscribed to a specified file path.
+  #
+  # @api private
   class Config
-    attr_reader :root
-
     def initialize(file)
-      @config = File.read(file)
-      @root = File.dirname(file)
+      @config = file.read
+      @root = file.dirname.to_s
     end
 
-    def owners
-      subscriptions.each_with_object({}) do |line, hash|
-        owner, path = line.split(/\s+/, 2).push('.*')
-        hash[owner] ||= []
-        hash[owner] << Regexp.new(path)
+    def owners(path)
+      if path.start_with?(@root)
+        relative = path.sub("#{@root}/", "")
+
+        search do |subscription, results|
+          owner, pattern = subscription.split(/\s+/, 2)
+          regex = Regexp.new(pattern || ".*")
+          results << owner if regex =~ relative
+        end
       end
     end
 
     private
 
+    def search(&block)
+      subscriptions.each_with_object([], &block)
+    end
+
     def subscriptions
       @config.split("\n").reject(&:empty?)
     end

data/lib/owners/search.rb

@@ -1,17 +1,44 @@
 module Owners
+  # Accepts an array of file paths and returns an array of
+  # owners that have subscribed to the specified files.
+  #
+  # @api private
   class Search
-    def initialize(paths)
-      @paths = paths
+    def initialize(files)
+      @files = files
     end
 
     def owners
-      paths.flat_map(&:owners).flatten.uniq.sort
+      search do |(path, config), results|
+        owners = config.owners(path.to_s)
+        results.merge(owners) if owners
+      end
     end
 
     private
 
+    def search(&block)
+      attempts.each_with_object(SortedSet.new, &block).to_a
+    end
+
+    def attempts
+      paths.product(configs)
+    end
+
+    def configs
+      subscriptions.map { |file| Config.new(file) }
+    end
+
+    def subscriptions
+      trees.flat_map(&:owner_files).uniq
+    end
+
+    def trees
+      paths.map { |path| Tree.new(path) }
+    end
+
     def paths
-      @paths.map { |path| Path.new(path) }
+      @files.map { |file| Pathname.new(file) }
     end
   end
 end

data/lib/owners/tree.rb

@@ -0,0 +1,32 @@
+module Owners
+  # Traverses up the directory tree starting at a specified
+  # file and returns an array of all OWNERS files.
+  #
+  # @api private
+  class Tree
+    def initialize(file)
+      @file = file
+    end
+
+    def owner_files
+      parents.each_with_object([]) do |parent, files|
+        config = parent.join(Owners.file)
+        files << config if config.file?
+      end
+    end
+
+    private
+
+    def parents
+      parents = []
+      file = @file
+
+      until file == file.dirname
+        file = file.dirname
+        parents << file
+      end
+
+      parents
+    end
+  end
+end

data/lib/owners/version.rb

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

data/owners.gemspec

@@ -1,19 +1,19 @@
-require File.expand_path('../lib/owners/version', __FILE__)
+require File.expand_path("../lib/owners/version", __FILE__)
 
 Gem::Specification.new do |s|
-  s.author                = 'Sean Huber'
-  s.email                 = 'github@shuber.io'
+  s.author                = "Sean Huber"
+  s.email                 = "github@shuber.io"
   s.extra_rdoc_files      = %w(LICENSE)
   s.files                 = `git ls-files`.split("\n")
-  s.homepage              = 'https://github.com/shuber/owners'
-  s.license               = 'MIT'
-  s.name                  = 'owners'
+  s.homepage              = "https://github.com/shuber/owners"
+  s.license               = "MIT"
+  s.name                  = "owners"
   s.rdoc_options          = %w(--charset=UTF-8 --inline-source --line-numbers --main README.md)
   s.require_paths         = %w(lib)
-  s.required_ruby_version = '>= 2.0.0'
-  s.summary               = 'Take ownership of your code'
+  s.required_ruby_version = ">= 2.0.0"
+  s.summary               = "Take ownership of your code"
   s.test_files            = `git ls-files -- spec/*`.split("\n")
   s.version               = Owners::VERSION
 
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency "rspec"
 end

data/spec/owners_spec.rb

@@ -1,47 +1,47 @@
 RSpec.describe Owners do
-  describe '.for' do
+  describe ".for" do
     subject { described_class.for(*paths) }
 
-    context 'with one path' do
-      let(:paths) { ['example/app/controllers/users_controller.rb'] }
+    context "with one path" do
+      let(:paths) { ["example/app/controllers/users_controller.rb"] }
 
-      it 'parses owners correctly' do
-        expect(subject).to eq(['@org/auth', '@org/blog'])
+      it "parses owners correctly" do
+        expect(subject).to eq(["@org/auth", "@org/blog"])
       end
     end
 
-    context 'with multiple paths' do
+    context "with multiple paths" do
       let(:paths) {[
-        'example/app/controllers/posts_controller.rb',
-        'example/app/models/user.rb',
+        "example/app/controllers/posts_controller.rb",
+        "example/app/models/user.rb",
       ]}
 
-      it 'parses owners correctly' do
-        expect(subject).to eq(['@org/auth', '@org/blog', 'data@example.com'])
+      it "parses owners correctly" do
+        expect(subject).to eq(["@org/auth", "@org/blog", "data@example.com"])
       end
     end
 
-    context 'with no matches' do
-      let(:paths) { ['some-path-without-owners'] }
+    context "with no matches" do
+      let(:paths) { ["some-path-without-owners"] }
 
-      it 'parses owners correctly' do
+      it "parses owners correctly" do
         expect(subject).to be_empty
       end
     end
 
-    context 'with a regex matcher' do
-      let(:paths) { ['example/app/models/blog.rb'] }
+    context "with a regex matcher" do
+      let(:paths) { ["example/app/models/blog.rb"] }
 
-      it 'parses owners correctly' do
-        expect(subject).to eq(['@blogger', '@org/blog', 'data@example.com'])
+      it "parses owners correctly" do
+        expect(subject).to eq(["@blogger", "@org/blog", "data@example.com"])
       end
     end
 
-    context 'with a rule containing whitespace' do
-      let(:paths) { ['example/app/models/post.rb'] }
+    context "with a rule containing whitespace" do
+      let(:paths) { ["example/app/models/post.rb"] }
 
-      it 'parses owners correctly' do
-        expect(subject).to eq(['@org/blog', '@whitespace', 'data@example.com'])
+      it "parses owners correctly" do
+        expect(subject).to eq(["@org/blog", "@whitespace", "data@example.com"])
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,12 +1,12 @@
-if ENV['CODECLIMATE_REPO_TOKEN']
-  require 'codeclimate-test-reporter'
+if ENV["CODECLIMATE_REPO_TOKEN"]
+  require "codeclimate-test-reporter"
   CodeClimate::TestReporter.start
 else
-  require 'simplecov'
-  SimpleCov.start { add_filter('/vendor/bundle/') }
+  require "simplecov"
+  SimpleCov.start { add_filter("/vendor/bundle/") }
 end
 
-require File.expand_path('../../lib/owners', __FILE__)
+require File.expand_path("../../lib/owners", __FILE__)
 
 RSpec.configure do |config|
   config.filter_run :focus

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: owners
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Sean Huber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-21 00:00:00.000000000 Z
+date: 2015-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -33,6 +33,7 @@ extra_rdoc_files:
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -47,9 +48,8 @@ files:
 - example/app/models/user.rb
 - lib/owners.rb
 - lib/owners/config.rb
-- lib/owners/core_ext
-- lib/owners/path.rb
 - lib/owners/search.rb
+- lib/owners/tree.rb
 - lib/owners/version.rb
 - owners.gemspec
 - spec/owners_spec.rb

data/lib/owners/path.rb

@@ -1,41 +0,0 @@
-module Owners
-  class Path
-    CONFIG = 'OWNERS'
-
-    def initialize(file)
-      @file = file
-    end
-
-    def owners
-      configs.each_with_object([]) do |config, owners|
-        path = @file.sub("#{config.root}/", '')
-
-        config.owners.each do |owner, regexes|
-          regexes.each do |regex|
-            if path =~ regex
-              owners << owner
-            end
-          end
-        end
-      end
-    end
-
-    private
-
-    def configs
-      configs = []
-      file = @file
-
-      until ['.', '/'].include?(file)
-        file = File.dirname(file)
-        config = File.join(file, CONFIG)
-
-        if File.exists?(config) && !File.directory?(config)
-          configs << Config.new(config)
-        end
-      end
-
-      configs
-    end
-  end
-end