code_owners 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc307747a22792a128d695f174820316e1854c24
+  data.tar.gz: 3a8d98cb08c68ae917211a158b29851338c1485a
+SHA512:
+  metadata.gz: 5d041bcf4991ae7a2a93a79fb9d0504707544d78c7b8e5881cb6e48e58628db9bf5f02d12037d755730360a6954b0abd9ce706503509bdac4efb25df65381572
+  data.tar.gz: d6e685e7f8815541e0c6278e7dde16572b74218c02cc81ad8dfa97c1c0e940e05db2ac2b9d7e16985acae63103ca908b9c12fc04f4d3a559dca1b578a3a4cbc5

data/.github/CODEOWNERS

@@ -0,0 +1,13 @@
+# This is a CODEOWNERS file. See https://help.github.com/articles/about-codeowners/
+# this is also intentionally poorly written for testing purposes
+
+
+# empty line followed by a comment?!  madness
+lib/*                   @jcheatham
+spec/*                  @jcheatham
+Rakefile                @jcheatham
+
+*code_owners*           @jcheatham
+
+Gemfile*		@jcheatham
+.git*                   @jcheatham

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    code_owners (1.0.0)
+      rake (~> 12.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    byebug (9.0.6)
+    diff-lcs (1.3)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 9.0)
+  code_owners!
+  rspec (~> 3.7)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jonathan Cheatham
+
+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/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+[:build, :install, :release].each do |task_name|
+  Rake::Task[task_name].prerequisites << :spec
+end
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+desc "Run tests"
+task :default => :spec

data/bin/code_owners

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'code_owners'
+
+CodeOwners.ownerships.each do |ownership_status|
+  owner_info = ownership_status[:owner].dup
+  owner_info += " per line #{ownership_status[:line]}, #{ownership_status[:pattern]}" if owner_info != "UNOWNED"
+  puts "#{ownership_status[:file].ljust(100,' ')} #{owner_info}"
+end

data/code_owners.gemspec

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+name = "code_owners"
+require "#{name}/version"
+
+Gem::Specification.new name, CodeOwners::VERSION do |s|
+  s.date          = "2018-03-29"
+  s.summary       = ".github/CODEOWNERS introspection utility gem"
+  s.description   = "utility gem for .github/CODEOWNERS introspection"
+  s.authors       = "Jonathan Cheatham"
+  s.email         = "coaxis@gmail.com"
+  s.homepage      = "http://github.com/jcheatham/#{s.name}"
+  s.licenses      = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.bindir        = 'bin'
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+  s.executables   = ["code_owners"]
+
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "rake"
+end

data/lib/code_owners.rb

@@ -0,0 +1,47 @@
+require "code_owners/version"
+require "tempfile"
+
+module CodeOwners
+  class << self
+    # github's CODEOWNERS rules (https://help.github.com/articles/about-codeowners/) are allegedly based on the gitignore format.
+    # but you can't tell ls-files to ignore tracked files via an arbitrary pattern file
+    # so we need to jump through some hacky git-fu hoops
+    #
+    # -c "core.excludesfiles=somefile" -> tells git to use this as our gitignore pattern source
+    # check-ignore -> debug gitignore / exclude files
+    # --no-index -> don't look in the index when checking, can be used to debug why a path became tracked
+    # -v -> verbose, outputs details about the matching pattern (if any) for each given pathname
+    # -n -> non-matching, shows given paths which don't match any pattern
+
+    def ownerships
+      patterns, owners = pattern_owners.transpose
+
+      raw_git_ownership(patterns).map do |status|
+        _, _exfile, line, pattern, file = status.match(/^(.*):(\d*):(.*)\t(.*)$/).to_a
+        if line.empty?
+          { file: file, owner: "UNOWNED" }
+        else
+          { file: file, owner: owners[line.to_i - 1], line: line, pattern: pattern }
+        end
+      end
+    end
+
+    # read the github file and spit out a slightly formatted list of patterns and their owners
+    def pattern_owners
+      File.read(".github/CODEOWNERS").split("\n").map do |line|
+        line.gsub(/#.*/, '').gsub(/^$/, " @").split(/\s+@/, 2)
+      end
+    end
+
+    # expects an array of gitignore compliant patterns
+    # generates a check-ignore formatted string for each file in the repo
+    def raw_git_ownership(patterns)
+      Tempfile.open('codeowner_patterns') do |file|
+        file.write(patterns.join("\n"))
+        file.rewind
+        cmd = "git ls-files | xargs -- git -c \"core.excludesfile=#{file.path}\" check-ignore --no-index -v -n"
+        `#{cmd}`.lines.map(&:strip)
+      end
+    end
+  end
+end

data/lib/code_owners/version.rb

@@ -0,0 +1,3 @@
+module CodeOwners
+  VERSION = "1.0.1"
+end

data/spec/code_owners_spec.rb

@@ -0,0 +1,37 @@
+require 'code_owners'
+
+RSpec.describe CodeOwners do
+  describe ".ownerships" do
+    it "assigns owners to things" do
+      expect(CodeOwners).to receive(:pattern_owners).and_return([["pat1", "own1"], ["pat2", "own2"], ["pat3", "own3"]])
+      expect(CodeOwners).to receive(:raw_git_ownership).and_return(
+        [
+          "this_gets_discarded:2:whatever/pattern/thing\tthis/is/a/file",
+          "::\tunowned/file"
+        ]
+      )
+      expect(CodeOwners.ownerships).to eq(
+        [
+          { file: "this/is/a/file", owner: "own2", line: "2", pattern: "whatever/pattern/thing" },
+          { file: "unowned/file",   owner: "UNOWNED"}
+        ]
+      )
+    end
+  end
+
+  describe ".pattern_owners" do
+    it "returns a list of patterns and owners" do
+      patterns, owners = CodeOwners.pattern_owners.transpose
+      expect(owners).to include("jcheatham")
+      expect(patterns).to include("lib/*")
+    end
+  end
+
+  describe ".raw_git_ownership" do
+    it "establishes code owners from a list of patterns" do
+      raw_ownership = CodeOwners.raw_git_ownership(["/lib/*"])
+      expect(raw_ownership.size).to be >= 1
+      expect(raw_ownership).to all( match(/^.*:\d*:.*\t.*$/) )
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: code_owners
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Jonathan Cheatham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-29 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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: utility gem for .github/CODEOWNERS introspection
+email: coaxis@gmail.com
+executables:
+- code_owners
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CODEOWNERS"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- bin/code_owners
+- code_owners.gemspec
+- lib/code_owners.rb
+- lib/code_owners/version.rb
+- spec/code_owners_spec.rb
+homepage: http://github.com/jcheatham/code_owners
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: ".github/CODEOWNERS introspection utility gem"
+test_files: []