codeowner_parser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e3d800c48813130b197b5d40a14826d2c71db2bd094a993476a4377013ecdf0
+  data.tar.gz: 51800ac4ca1a4c7af5f24b340bcc5aaddbe1b2bdd2c79dba4e105cc87623f49c
+SHA512:
+  metadata.gz: 820cbc3bd94c9e9fd4eb7310783ce55849cf77b667751b877c07eb7f316bb0953d84c05d57ef47c7f49d71abd3c97380ef1cee4c4806183ab32d627e050738b4
+  data.tar.gz: 4449255307def71780dbb9382af0df992d6e5c5e0d2d2ebb25f2214f1c850df7346a0e9a0c6509b4559cac8cf75ed99bb0c9e5e220c5c7f7c4e3c95fbe7b96b7

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/.examples.txt
+/Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,30 @@
+require:
+- rubocop-rspec
+- rubocop-performance
+
+# Line length is more trouble than it's worth, IMO. Be reasonable.
+Layout/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    # Specs are generally long.
+    - 'spec/**/*'
+
+RSpec/NestedGroups:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+# Enable newly released cops:
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in codeowner_parser.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+
+gem 'rspec', '~> 3.9'
+gem 'rubocop', '~> 0.81.0'
+gem 'rubocop-performance', '1.5', require: false
+gem 'rubocop-rspec', '~> 1.38', require: false
+
+gem 'byebug'
+gem 'pry-byebug'

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2020 William Johnston
+
+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,53 @@
+# CodeownerParser
+
+The goal of this gem is primarily to parse a CODEOWNER file and return the team associated with a file given the file path.
+
+An ancillary goal is to allow you to route errors to a different team by file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'codeowner_parser'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install codeowner_parser
+
+## Usage
+
+See [GitHub's documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#example-of-a-codeowners-file) for examples of codeowner files.
+
+```ruby
+require 'codeowner_parser'
+
+str = <<~CODEOWNERS
+*       @global-owner1 @global-owner2
+*.js    @js-owner
+*.go docs@example.com
+/build/logs/ @doctocat
+docs/*  docs@example.com
+apps/ @octocat
+/docs/ @doctocat
+CODEOWNERS
+
+parser = CodeownerParser.parse(str)
+parser.owner('/build/docs/blah.json')
+# => docs@example.com
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/will-in-wi/codeowner_parser.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+desc 'Run Rubocop'
+RuboCop::RakeTask.new(:rubocop)
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'codeowner_parser'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/codeowner_parser.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/codeowner_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'codeowner_parser'
+  spec.version       = CodeownerParser::VERSION
+  spec.authors       = ['William Johnston']
+  spec.email         = ['william@johnstonhaus.us']
+
+  spec.summary       = 'Parse a CODEOWNER file and return the team associated with a file given the file path'
+  # spec.description   = 'Parse a CODEOWNER file and return the team associated with a file given the file path'
+  spec.homepage      = 'https://github.com/will-in-wi/codeowner_parser'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/will-in-wi/codeowner_parser/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/codeowner_parser.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'codeowner_parser/version'
+require 'codeowner_parser/file'
+
+# A parser for CODEOWNER files.
+module CodeownerParser
+  class Error < StandardError; end
+
+  def self.parse(file)
+    CodeownerParser::File.new(file)
+  end
+end

data/lib/codeowner_parser/file.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'codeowner_parser/rule'
+
+module CodeownerParser
+  # Parses an entire codeowners file.
+  class File
+    def initialize(file_string)
+      @file_string = file_string
+
+      raise ArgumentError, 'CODEOWNER file cannot be nil' if @file_string.nil?
+
+      # Precompute for repeated access. Reverse because of reverse precedence.
+      @rules = rules.reverse
+    end
+
+    def owner(path)
+      applicative_rule = @rules.find { |rule| rule.applies?(path) }
+      return [] if applicative_rule.nil?
+
+      applicative_rule.owner
+    end
+
+    private
+
+    def rules
+      @file_string.split("\n").inject([]) do |memo, line|
+        # Delete everything after a comment.
+        line, = line.split('#')
+        line = (line || '').strip
+        next memo if line == ''
+
+        memo << Rule.new(line)
+      end
+    end
+  end
+end

data/lib/codeowner_parser/rule.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module CodeownerParser
+  # Handles an individual rule and determines applicability.
+  class Rule
+    attr_reader :owner
+
+    def initialize(rule_string)
+      @rule_path, *@owner = rule_string.split(/\s+/)
+      # Precompute this so that we aren't doing so repeatedly for additional checks.
+      @rule_regex = path_regex
+    end
+
+    def applies?(path)
+      @rule_regex =~ path
+    end
+
+    private
+
+    def path_regex
+      literals = @rule_path.split('*', -1)
+      regex = ''
+      # If path started with a slash, this is rooted.
+      regex += '\A' if literals.first.start_with?('/')
+      # Join with a wildcard for anything other than a slash.
+      regex += literals.map { |literal| Regexp.escape(literal) }.join('[^\/]+')
+      # If path did not end with a slash, do not search into subdirectories.
+      regex += '\Z' unless literals.last.end_with?('/')
+
+      Regexp.compile(regex)
+    end
+  end
+end

data/lib/codeowner_parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CodeownerParser
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: codeowner_parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- William Johnston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-14 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- william@johnstonhaus.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- codeowner_parser.gemspec
+- lib/codeowner_parser.rb
+- lib/codeowner_parser/file.rb
+- lib/codeowner_parser/rule.rb
+- lib/codeowner_parser/version.rb
+homepage: https://github.com/will-in-wi/codeowner_parser
+licenses: []
+metadata:
+  homepage_uri: https://github.com/will-in-wi/codeowner_parser
+  source_code_uri: https://github.com/will-in-wi/codeowner_parser
+  changelog_uri: https://github.com/will-in-wi/codeowner_parser/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Parse a CODEOWNER file and return the team associated with a file given the
+  file path
+test_files: []