owners 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03249f63f81c9db5877a0f55d0562c78e725afc6
+  data.tar.gz: 4cc529092d6d620a6cc1c652c819f9d7b63d662f
+SHA512:
+  metadata.gz: ff1c532d637a42f59b985764d90f686629ac3be3fefc8bca062eda6be54f141ca599f86c88aedc6b6e22d5ff940b9a6e20c7ac236bbfc3015150a3a2d50123e7
+  data.tar.gz: c6fe901e8fe7467cb8eda35f12d6d2d468e4c0b8a2999c935d8e092c57de18339926834202490fa6f2e191bdf1791a40b7a7e243caf6a953c57b812653b7e525

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+rdoc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    owners (0.0.0)
+
+GEM
+  remote: https://www.rubygems.org/
+  specs:
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    multi_json (1.11.0)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter
+  owners!
+  rspec
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Sean Huber - github@shuber.io
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# [![Sean Huber](https://cloud.githubusercontent.com/assets/2419/6550752/832d9a64-c5ea-11e4-9717-6f9aa6e023b5.png)](https://github.com/shuber) owners
+
+[![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
+
+
+## Installation
+
+```
+gem install owners
+```
+
+
+## Usage
+
+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.
+
+```
+bob@your-org.com
+jane@your-org.com
+@some_github_handle
+@your_github_org/group
+#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.
+
+```
+@data         app/models/.*
+@ui           \.(css|haml|js|scss)$
+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`
+
+```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.
+
+## API
+
+[YARD Documentation](http://www.rubydoc.info/github/shuber/owners)
+
+* `Owners.for`
+
+
+## Testing
+
+```
+bundle exec rspec
+```
+
+
+## Contributing
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with the version or history.
+* Send me a pull request. Bonus points for topic branches.
+
+
+## License
+
+[MIT](https://github.com/shuber/owners/blob/master/LICENSE)  - Copyright © 2015 Sean Huber

data/example/OWNERS

@@ -0,0 +1 @@
+@org/blog

data/example/app/OWNERS

@@ -0,0 +1 @@
+@org/auth user

data/example/app/models/OWNERS

@@ -0,0 +1,3 @@
+data@example.com
+@blogger ^blog\.rb$
+@whitespace      post.rb

data/lib/owners.rb

@@ -0,0 +1,10 @@
+require 'owners/config'
+require 'owners/path'
+require 'owners/search'
+require 'owners/version'
+
+module Owners
+  def self.for(*paths)
+    Search.new(paths).owners
+  end
+end

data/lib/owners/config.rb

@@ -0,0 +1,24 @@
+module Owners
+  class Config
+    attr_reader :root
+
+    def initialize(file)
+      @config = File.read(file)
+      @root = File.dirname(file)
+    end
+
+    def owners
+      subscriptions.each_with_object({}) do |line, hash|
+        owner, path = line.split(/\s+/, 2).push('.*')
+        hash[owner] ||= []
+        hash[owner] << Regexp.new(path)
+      end
+    end
+
+    private
+
+    def subscriptions
+      @config.split("\n").reject(&:empty?)
+    end
+  end
+end

data/lib/owners/path.rb

@@ -0,0 +1,41 @@
+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

data/lib/owners/search.rb

@@ -0,0 +1,17 @@
+module Owners
+  class Search
+    def initialize(paths)
+      @paths = paths
+    end
+
+    def owners
+      paths.flat_map(&:owners).flatten.uniq.sort
+    end
+
+    private
+
+    def paths
+      @paths.map { |path| Path.new(path) }
+    end
+  end
+end

data/lib/owners/version.rb

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

data/owners.gemspec

@@ -0,0 +1,19 @@
+require File.expand_path('../lib/owners/version', __FILE__)
+
+Gem::Specification.new do |s|
+  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.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.test_files            = `git ls-files -- spec/*`.split("\n")
+  s.version               = Owners::VERSION
+
+  s.add_development_dependency 'rspec'
+end

data/spec/owners_spec.rb

@@ -0,0 +1,48 @@
+RSpec.describe Owners do
+  describe '.for' do
+    subject { described_class.for(*paths) }
+
+    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'])
+      end
+    end
+
+    context 'with multiple paths' do
+      let(:paths) {[
+        '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'])
+      end
+    end
+
+    context 'with no matches' do
+      let(:paths) { ['some-path-without-owners'] }
+
+      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'] }
+
+      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'] }
+
+      it 'parses owners correctly' do
+        expect(subject).to eq(['@org/blog', '@whitespace', 'data@example.com'])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: owners
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Sean Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: github@shuber.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- example/OWNERS
+- example/app/OWNERS
+- example/app/controllers/posts_controller.rb
+- example/app/controllers/users_controller.rb
+- example/app/models/OWNERS
+- example/app/models/blog.rb
+- example/app/models/post.rb
+- 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/version.rb
+- owners.gemspec
+- spec/owners_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/shuber/owners
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+- "--inline-source"
+- "--line-numbers"
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Take ownership of your code
+test_files:
+- spec/owners_spec.rb
+- spec/spec_helper.rb