danger-missing_codeowners 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bcc8b0409118eaa0ddbab4a903a7573e734444cc7362c29e1eb1725cc617e70b
+  data.tar.gz: cf214013da36794cc4ab47da98914e3630eeed04e20fc42988188a0a12196206
+SHA512:
+  metadata.gz: 217d2d8cc83f6e9b8d4eb64e30ee9cb8140da863665b8677ceafa25a85736b6b1dfce4d5d8aa3052335c578d997197e488dae1468e3279138c34374b546f16cb
+  data.tar.gz: 2fb655ba4b7c3966b6758b091e502f5489bc77d3a0e5106fd317bb4a5198d0a6761ddd6a100b31b6a4432b8179474c2426d2675f39b2bb0da20de090ba5be805

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+.idea/
+.yardoc

data/.rubocop.yml

@@ -0,0 +1,151 @@
+# Defaults can be found here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+# If you don't like these settings, just delete this file :)
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Layout/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 350
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# danger specific
+
+Style/BlockComments:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# FIXME: 25
+Metrics/BlockLength:
+  Max: 345
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/MixinGrouping:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%":  ()
+    "%i": ()
+    "%q": ()
+    "%Q": ()
+    "%r": "{}"
+    "%s": ()
+    "%w": ()
+    "%W": ()
+    "%x": ()
+
+Security/YAMLLoad:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+script:
+    - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in danger-missing_codeowners.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,166 @@
+PATH
+  remote: .
+  specs:
+    danger-missing_codeowners (1.0.0)
+      danger-plugin-api (~> 1.0)
+      pathspec (~> 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    claide (1.0.3)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.3)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (8.3.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (>= 1, < 4)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.4.4)
+    faraday (1.6.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    ffi (1.15.3)
+    formatador (0.3.0)
+    git (1.9.1)
+      rchardet (~> 1.8)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.21.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pathspec (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rchardet (1.8.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.4)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.8.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    terminal-table (3.0.1)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.1.0)
+    unicode-display_width (2.0.0)
+    yard (0.9.26)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  danger-missing_codeowners!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop
+  yard
+
+BUNDLED WITH
+   2.2.18

data/Guardfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2021 andre-alves-ifood <andre.alves@ifood.com.br>
+
+MIT License
+
+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,48 @@
+# danger-missing_codeowners
+
+A [Danger Ruby](https://github.com/danger/danger) plugin for inspecting [CODEOWNERS](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners) and finding which files have no owners.
+
+Works with GitHub and GitLab.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```rb
+gem 'danger-missing_codeowners'
+```
+
+## Usage
+
+Just call the `verify` methd in your Dangerfile:
+
+```rb
+missing_codeowners.verify
+```
+
+By default danger-missing_codeowners will only verify files that were added or modified in the pull request diff.
+
+To verify all files, use the `verify_all_files` option:
+
+```rb
+missing_codeowners.verify_all_files = true
+missing_codeowners.verify
+```
+
+You can also adjust the severity of the execution. Possible valures are `error` (default) and `warning`:
+
+```rb
+missing_codeowners.severity = 'warning'
+missing_codeowners.verify
+```
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task["specs"].invoke
+  Rake::Task["rubocop"].invoke
+  Rake::Task["spec_docs"].invoke
+end
+
+desc "Run RuboCop on the lib/specs directory"
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ["lib/**/*.rb", "spec/**/*.rb"]
+end
+
+desc "Ensure that the plugin passes `danger plugins lint`"
+task :spec_docs do
+  sh "bundle exec danger plugins lint"
+end

data/danger-missing_codeowners.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "missing_codeowners/gem_version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "danger-missing_codeowners"
+  spec.version       = MissingCodeowners::VERSION
+  spec.authors       = ["andre-alves"]
+  spec.email         = ["andre.ver93@gmail.com"]
+  spec.description   = "A Danger plugin for checking if files have owners. Works with GitHub and GitLab."
+  spec.summary       = "A Danger plugin for checking if files have owners."
+  spec.homepage      = "https://github.com/andre-alves/danger-missing_codeowners"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "danger-plugin-api", "~> 1.0"
+  spec.add_runtime_dependency "pathspec", "~> 1.0.0"
+
+  # General ruby development
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  # Testing support
+  spec.add_development_dependency "rspec", "~> 3.4"
+
+  # Linting code and docs
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "yard"
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency "listen", "3.0.7"
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency "pry"
+end

data/lib/danger_missing_codeowners.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "missing_codeowners/gem_version"

data/lib/danger_plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "missing_codeowners/plugin"

data/lib/missing_codeowners/gem_version.rb

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

data/lib/missing_codeowners/plugin.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require "pathspec"
+
+module Danger
+  # Parses the CODEOWNERS file and verifies if files have at least one owner.
+  # Works with GitHub and GitLab.
+  # Results are passed out as a table in markdown.
+  #
+  # @example Verifying files missing codeowners.
+  #
+  #          missing_codeowners.verify
+  #
+  # @see  andre-alves/danger-missing_codeowners
+  # @tags codeowners
+  #
+  class DangerMissingCodeowners < Plugin
+    # The list of files that are missing owners.
+    #
+    # @return   [Array<String>]
+    attr_accessor :files_missing_codeowners
+
+    # Whether all files or only ones in PR diff to be reported. Default is false.
+    #
+    # @return   [Bool]
+    attr_accessor :verify_all_files
+
+    # The maximum number of files missing owners Danger should report. Default is 100.
+    #
+    # @return   [Int]
+    attr_accessor :max_number_of_files_to_report
+
+    # Defines the severity level of the execution. Possible values are: 'error' or 'warning'. Default is 'error'.
+    #
+    # @return   [String]
+    attr_accessor :severity
+
+    # Provides additional logging diagnostic information. Default is false.
+    #
+    # @return   [Bool]
+    attr_accessor :verbose
+
+    # Verifies git added and modified files for missing owners.
+    # Generates a `markdown` list of warnings for the prose in a corpus of
+    # .markdown and .md files.
+    #
+    # @return  [void]
+    #
+    def verify
+      @verify_all_files ||= false
+      @max_number_of_files_to_report ||= 100
+      @severity ||= "error"
+      @verbose ||= false
+
+      files = files_to_verify
+      codeowners_path = find_codeowners_file
+      codeowners_lines = read_codeowners_file(codeowners_path)
+      codeowners_spec = parse_codeowners_spec(codeowners_lines)
+      @files_missing_codeowners = files.reject { |file| codeowners_spec.match file }
+
+      return if @files_missing_codeowners.empty?
+
+      log "Files missing CODEOWNERS:"
+      log @files_missing_codeowners.join("\n")
+
+      markdown format_missing_owners_message(@files_missing_codeowners, @max_number_of_files_to_report)
+      danger_message = "Add CODEOWNERS rules to match all files."
+
+      @severity == "error" ? (fail danger_message) : (warn danger_message)
+    end
+
+    private
+
+    def files_to_verify
+      @verify_all_files == true ? git_all_files : git_modified_files
+    end
+
+    def git_modified_files
+      git.added_files + git.modified_files
+    end
+
+    def git_all_files
+      # The git object provided by Danger doesn't have ls_files
+      `git ls-files`.split($/)
+    end
+
+    def find_codeowners_file
+      directories = ["", ".gitlab", ".github", "docs"]
+      paths = directories.map { |dir| File.join(dir, "CODEOWNERS") }
+      Dir.glob(paths).first || paths.first
+    end
+
+    def read_codeowners_file(path)
+      log "Reading the CODEOWNERS file from path: #{path}"
+      File.readlines(path).map(&:chomp)
+    end
+
+    def parse_codeowners_spec(lines)
+      patterns = []
+      lines.each do |line|
+        components = line.split(/\s+(@\S+|\S+@\S+)/).reject { |c| c.strip.empty? }
+        if line.match(/^\s*((?:#.*)|(?:\[.*)|(?:\^.*))?$/)
+          next # Comment, group or empty line
+        elsif components.length < 2
+          raise "[ERROR] Invalid CODEOWNERS line: '#{line}'"
+        else
+          pattern = components[0]
+          patterns << pattern
+          log "Adding pattern: '#{pattern}'"
+        end
+      end
+      PathSpec.from_lines(patterns)
+    end
+
+    def format_missing_owners_message(files, max_count)
+      message = "### Files missing CODEOWNERS\n\n".dup
+      message << "| File |\n"
+      message << "| ---- |\n"
+      files.take(max_count).each do |file|
+        message << "| #{file} |\n"
+      end
+
+      other_files_length = files.length - max_count
+      if other_files_length.positive?
+        message << "...and #{other_files_length} other files.\n"
+      end
+
+      message
+    end
+
+    def log(text)
+      puts(text) if @verbose
+    end
+  end
+end

data/spec/fixtures/CODEOWNERS

@@ -0,0 +1,46 @@
+# This is an example of a CODEOWNERS file
+# lines starting with a `#` will be ignored.
+
+# app/ @commented-rule
+
+# We can specify a default match using wildcards:
+*.yml @default-codeowner
+
+# We can also specify "multiple tab or space" separated codeowners:
+*.yml @multiple @code  @owners
+
+# Files with a `#` can still be accessed by escaping the pound sign
+\#file_with_pound.rb @owner-file-with-pound
+
+# You can use both usernames or email addresses to match
+LICENSE janedoe@gitlab.com @username
+
+# Group names can be used to match groups and nested groups to specify
+# them as owners for a file
+README @group/with-nested/subgroup
+
+# Ending a path in a `/` will specify the Code Owners for every file
+# nested in that directory, on any level
+/configs/ @all-configs
+
+# Ending a path in `/*` will specify Code Owners for every file in
+# that directory, but not nested deeper. This will match
+# `docs/index.md` but not `docs/projects/index.md`
+/docs/* @root-docs
+
+# This will make a `lib` directory nested anywhere in the repository match
+lib/ @lib-owner
+
+# Nested Wildcards is also supported
+widgets/**/Sources/ @widgets-owner
+
+# If the path contains spaces, escape them like this:
+path\ with\ spaces/ @space-owner
+
+# Code Owners section:
+
+[Database]
+model/db/   @gl-database
+
+^[Optional Group]
+*.go  @golang

data/spec/fixtures/INVALID_CODEOWNERS

@@ -0,0 +1,5 @@
+# Example of Invalid CODEOWNERS
+
+*.yml @default-codeowner
+*.go @golang
+invalid.txt group

data/spec/missing_codeowners_spec.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require File.expand_path("spec_helper", __dir__)
+
+module Danger
+  describe Danger::DangerMissingCodeowners do
+    it "should be a plugin" do
+      expect(Danger::DangerMissingCodeowners.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe "with Dangerfile" do
+      before do
+        @dangerfile = testing_dangerfile
+        @my_plugin = @dangerfile.missing_codeowners
+        @my_plugin.verbose = true
+      end
+
+      context "and valid CODEOWNERS file" do
+        before do
+          allow(@my_plugin).to receive(:find_codeowners_file)
+            .and_return("#{File.dirname(__FILE__)}/fixtures/CODEOWNERS")
+        end
+
+        it "fails when there are modified files without CODEOWNERS rules and severity is error" do
+          allow(@my_plugin).to receive(:git_modified_files)
+            .and_return([
+                          "app/source.swift",
+                          ".swiftlint.yml",
+                          "configs/header.xml",
+                          "configs/nested/header.xml",
+                          "project/configs/header.xml",
+                          "docs/index.md",
+                          "docs/projects/index.md",
+                          "widgets/a/Sources/file.java",
+                          "widgets/b/Sources/file.java",
+                          "widgets/Sources/file.java",
+                          "widgets/a/Tests/file.java",
+                          "widgets/Tests/file.java",
+                          "path with spaces/ok.php",
+                          "path with spaces2/missing.php",
+                          "sources/#file_with_pound.rb",
+                          "sources/#file_with_pound2.rb",
+                          "module/LICENSE",
+                          "module/README",
+                          "nested/lib/source.js",
+                          "lib/source.js",
+                          "model/db/",
+                          "sources/something.go"
+                        ])
+
+          @my_plugin.verify
+
+          markdown = @dangerfile.status_report[:markdowns].first.to_s
+          expect(markdown).to include("app/source.swift")
+          expect(markdown).to include("project/configs/header.xml")
+          expect(markdown).to include("path with spaces2/missing.php")
+          expect(markdown).to include("docs/projects/index.md")
+          expect(markdown).to include("widgets/a/Tests/file.java")
+          expect(markdown).to include("widgets/Tests/file.java")
+          expect(markdown).to include("sources/#file_with_pound2.rb")
+          expect(@my_plugin.files_missing_codeowners.length).to eq(7)
+          expect(@dangerfile.status_report[:errors]).to eq(["Add CODEOWNERS rules to match all files."])
+        end
+
+        it "succeeds when all modified files have CODEOWNERS rules" do
+          allow(@my_plugin).to receive(:git_modified_files).and_return(["any_file.yml", "any_file.go"])
+
+          @my_plugin.verify
+
+          expect(@my_plugin.files_missing_codeowners.length).to eq(0)
+        end
+
+        it "fails when there are files without CODEOWNERS rules and severity is error" do
+          @my_plugin.verify_all_files = true
+          allow(@my_plugin).to receive(:git_all_files).and_return(["app/source.swift", ".swiftlint.yml"])
+
+          @my_plugin.verify
+
+          markdown = @dangerfile.status_report[:markdowns].first.to_s
+          expect(markdown).to include("app/source.swift")
+          expect(@my_plugin.files_missing_codeowners.length).to eq(1)
+          expect(@dangerfile.status_report[:errors]).to eq(["Add CODEOWNERS rules to match all files."])
+        end
+
+        it "warns when there are files without CODEOWNERS rules and severity is warning" do
+          @my_plugin.verify_all_files = true
+          @my_plugin.severity = "warning"
+          allow(@my_plugin).to receive(:git_all_files).and_return(["app/source.swift", ".swiftlint.yml"])
+
+          @my_plugin.verify
+
+          markdown = @dangerfile.status_report[:markdowns].first.to_s
+          expect(markdown).to include("app/source.swift")
+          expect(@my_plugin.files_missing_codeowners.length).to eq(1)
+          expect(@dangerfile.status_report[:warnings]).to eq(["Add CODEOWNERS rules to match all files."])
+        end
+
+        it "succeeds when all files have CODEOWNERS rules" do
+          @my_plugin.verify_all_files = true
+          allow(@my_plugin).to receive(:git_all_files).and_return(["any_file.yml", "any_file.go"])
+
+          @my_plugin.verify
+
+          expect(@my_plugin.files_missing_codeowners.length).to eq(0)
+        end
+
+        it "does not truncates the markdown when there are not too many files missing owners" do
+          @my_plugin.max_number_of_files_to_report = 3
+          allow(@my_plugin).to receive(:git_modified_files).and_return(["a.xml", "b.xml", "c.xml"])
+
+          @my_plugin.verify
+
+          expect(@dangerfile.status_report[:markdowns].first.to_s).to_not include("other files")
+          expect(@my_plugin.files_missing_codeowners.length).to eq(3)
+        end
+
+        it "truncates the markdown when there are too many files missing owners" do
+          @my_plugin.max_number_of_files_to_report = 1
+          allow(@my_plugin).to receive(:git_modified_files).and_return(["a.xml", "b.xml", "c.xml"])
+
+          @my_plugin.verify
+
+          expect(@dangerfile.status_report[:markdowns].first.to_s).to include("2 other files")
+          expect(@my_plugin.files_missing_codeowners.length).to eq(3)
+        end
+      end
+
+      context "and invalid CODEOWNERS file" do
+        before do
+          allow(@my_plugin).to receive(:find_codeowners_file)
+            .and_return("#{File.dirname(__FILE__)}/fixtures/INVALID_CODEOWNERS")
+        end
+
+        it "raises exception with invalid line" do
+          allow(@my_plugin).to receive(:git_modified_files).and_return(["any_file.yml", "any_file.go"])
+
+          expect { @my_plugin.verify }.to raise_error(RuntimeError)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "pathname"
+ROOT = Pathname.new(File.expand_path("..", __dir__))
+$:.unshift("#{ROOT}lib".to_s)
+$:.unshift("#{ROOT}spec".to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "rspec"
+require "danger"
+
+if `git remote -v` == ""
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
+    "TRAVIS_PULL_REQUEST" => "800",
+    "TRAVIS_REPO_SLUG" => "artsy/eigen",
+    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
+    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: danger-missing_codeowners
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- andre-alves
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pathspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: yard
+  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: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: A Danger plugin for checking if files have owners. Works with GitHub
+  and GitLab.
+email:
+- andre.ver93@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-missing_codeowners.gemspec
+- lib/danger_missing_codeowners.rb
+- lib/danger_plugin.rb
+- lib/missing_codeowners/gem_version.rb
+- lib/missing_codeowners/plugin.rb
+- spec/fixtures/CODEOWNERS
+- spec/fixtures/INVALID_CODEOWNERS
+- spec/missing_codeowners_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/andre-alves/danger-missing_codeowners
+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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: A Danger plugin for checking if files have owners.
+test_files:
+- spec/fixtures/CODEOWNERS
+- spec/fixtures/INVALID_CODEOWNERS
+- spec/missing_codeowners_spec.rb
+- spec/spec_helper.rb