gitab_codeowners_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 248bb34aa3abedfe0a23e84f69b414a163dec461d08ad3cfc0791e7e6054705f
+  data.tar.gz: 850e195414b819b11d3d656ed900e64a57edb7d32f3c605c9b989c9f8d85c111
+SHA512:
+  metadata.gz: 866c40d6768afa3988c636fba6014733b25dbe1f5af203c12bc02ca35658393e12ec783ab060d8477842ca3a8e6d008f61ca6d560d2811273dad1b04b721325f
+  data.tar.gz: d5fdc32df5bb6a918b05ca7e83d5f2835ac3e51bddf626a72fc3d514a6b64e26581971497baf738ffd7b971bc74de438e9b842fbec430d7daed258b9022c28ce

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.gitlab-ci.yml

@@ -0,0 +1,9 @@
+include:
+  - project: "nstmrt/rubygems/templates"
+    ref: master
+    file: "build-rubygems.yml"
+
+tests:
+  stage: test
+  before_script:
+    - gem install bundler:2.3.15

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "gitlab_codeowners_checker.gemspec"
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+2.5.8

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gitab_codeowners_checker.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    gitab_codeowners_checker (0.1.0)
+      thor (> 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  gitab_codeowners_checker!
+  rake (~> 13.0)
+  rubocop (~> 0.81)
+
+BUNDLED WITH
+   2.3.15

data/README.md

@@ -0,0 +1,51 @@
+# GitabCodeownersChecker
+
+GitabCodeownersChecker is a CLI utility that is aimed to help with:
+
+- finding project files without CODEOWNERS mention
+- checking if CODEOWNERS references are set for specific files
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem install 'gitab_codeowners_checker' --source 'https://nexus.sbmt.io/repository/ruby-gems-sbermarket/'
+```
+
+## Usage
+
+## Getting help
+
+```shell
+gitlab-codeowners-checker help check_codeowners
+```
+
+## List project files without owners
+
+```shell
+gitlab-codeowners-checker check_codeowners -p app/controllers app/jobs app/consumers -i app/controllers/concerns -e rb -r /app/instamart/
+```
+
+## Checking specific files
+
+```shell
+gitlab-codeowners-checker check_codeowners -r /app/instamart/ --files app/jobs/shoppers/separate_reviews/export_shipment_review_rate_job.rb app/jobs/shipments/store_fiscal_data_job.rb
+```
+
+### Checking files changed within MR
+
+```shell
+gitlab-codeowners-checker check_codeowners -r /app/instamart/ --files $({ git diff $(git merge-base --fork-point origin/master) --name-only --diff-filter=MA | uniq | grep '\.rb$'; })
+```
+
+
+## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.sbmt.io/nstmrt/rubygems/gitlab-codeowners-checker.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'gitab_codeowners_checker'
+
+# 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/exe/gitlab-codeowners-checker

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'thor'
+require_relative '../lib/gitab_codeowners_checker'
+
+class CLI < Thor
+  desc 'check_codeowners', 'check codowners'
+  method_option :files, aliases: '-f', type: :array, desc: 'a list of files to check'
+  method_option :root_path, aliases: '-r', desc: 'path to application root folder', default: Dir.pwd
+  method_option :file_ext, aliases: '-e', desc: 'a file extenstion to filter files (example - "rb")'
+  method_option :paths, aliases: '-p', type: :array, desc: 'a list of paths to select'
+  method_option :ignore_paths, aliases: '-i', type: :array, desc: 'a list of paths to ignore'
+  def check_codeowners # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    opts = {
+      root_path: options.fetch(:root_path) || '.',
+      paths: options[:paths],
+      ignore_paths: options[:ignore_paths],
+      file_ext: options[:file_ext] || ''
+    }.compact
+
+    project = GitlabCodeownersChecks::Project.new(opts)
+    checker = GitlabCodeownersChecker::Checkers::NoOwner.new(
+      files: options[:files] || project.file_paths,
+      codeowners: project.codeowners
+    )
+
+    return if checker.files_without_owner.empty?
+
+    warn('Files without codeowners:')
+    checker.files_without_owner.each { |file| warn file }
+    exit(1)
+  end
+end
+
+CLI.start(ARGV)

data/gitab_codeowners_checker.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gitab_codeowners_checker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gitab_codeowners_checker'
+  spec.version       = GitabCodeownersChecker::VERSION
+  spec.authors       = ['Nikita Babushkin']
+  spec.email         = ['nikita.babushkin@sbermarket.ru']
+
+  spec.summary       = 'Check every project file has codeowners.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://gitlab.sbmt.io/nstmrt/rubygems/gitlab-codeowners-checker'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'thor', '> 1'
+  spec.add_development_dependency 'rubocop', '~> 0.81'
+end

data/lib/gitab_codeowners_checker/checkers/no_owner.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../project'
+
+module GitlabCodeownersChecker
+  module Checkers
+    class NoOwner
+      def initialize(files:, codeowners:)
+        @files = files
+        @codeowners = codeowners
+      end
+
+      def files_without_owner
+        @files_without_owner ||= @files.each_with_object([]) do |f, acc|
+          acc.push(f) unless @codeowners.patterns.find { |p| p.match?(f) }
+        end
+      end
+    end
+  end
+end

data/lib/gitab_codeowners_checker/codeowners_file.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative './pattern'
+
+module GitlabCodeownersChecker
+  class CodeownersFile
+    def initialize(path)
+      @path = path
+    end
+    attr_reader :path
+
+    def patterns
+      @patterns ||= begin
+        File.readlines(@path).each_with_object([]) do |line, acc|
+          acc.push(Pattern.from_file_line(line)) if contains_pattern?(line)
+        end
+      end
+    end
+
+    private
+
+    def contains_pattern?(str)
+      str.include?('@')
+    end
+  end
+end

data/lib/gitab_codeowners_checker/pattern.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GitlabCodeownersChecker
+  class Pattern
+    def self.from_file_line(str)
+      path, *owners = str.split(' ')
+      pattern = path[-1] == '/' ? /\A#{Regexp.escape(path)}.+/ : path
+      new(pattern, owners)
+    end
+
+    def initialize(pattern, owners)
+      @pattern = pattern
+      @owners = owners
+    end
+    attr_reader :pattern, :owners
+
+    def match?(str)
+      @pattern.is_a?(Regexp) ? @pattern.match?(str) : str == @pattern
+    end
+  end
+end

data/lib/gitab_codeowners_checker/project.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GitlabCodeownersChecks
+  class Project
+    def initialize(root_path:, codeowners_path: nil, paths: [''], ignore_paths: [], file_ext: '')
+      @root_path = root_path
+      @paths = paths
+      @ignore_paths = ignore_paths
+      @file_ext = file_ext
+      codeowners_path ||= 'CODEOWNERS'
+      @codeowners = GitlabCodeownersChecker::CodeownersFile.new(
+        Pathname.new(codeowners_path).absolute? ? codeowners_path : File.join(@root_path, codeowners_path)
+      )
+    end
+    attr_reader :root_path, :codeowners
+
+    def file_paths
+      @file_paths ||= @paths.flat_map do |ptc|
+        abs_path = File.join(@root_path, ptc, "**/*#{@file_ext}")
+        Dir.glob(abs_path).map { |path| path.sub(@root_path, '') }.reject do |path|
+          @ignore_paths.any? { |pti| path.start_with?(pti) }
+        end
+      end.sort
+    end
+  end
+end

data/lib/gitab_codeowners_checker/version.rb

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

data/lib/gitab_codeowners_checker.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'gitab_codeowners_checker/version'
+require_relative 'gitab_codeowners_checker/codeowners_file'
+require_relative 'gitab_codeowners_checker/checkers/no_owner'
+
+module GitabCodeownersChecker
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: gitab_codeowners_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikita Babushkin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.81'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.81'
+description: Check every project file has codeowners.
+email:
+- nikita.babushkin@sbermarket.ru
+executables:
+- gitlab-codeowners-checker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gitlab-codeowners-checker
+- gitab_codeowners_checker.gemspec
+- lib/gitab_codeowners_checker.rb
+- lib/gitab_codeowners_checker/checkers/no_owner.rb
+- lib/gitab_codeowners_checker/codeowners_file.rb
+- lib/gitab_codeowners_checker/pattern.rb
+- lib/gitab_codeowners_checker/project.rb
+- lib/gitab_codeowners_checker/version.rb
+homepage: https://gitlab.sbmt.io/nstmrt/rubygems/gitlab-codeowners-checker
+licenses: []
+metadata:
+  homepage_uri: https://gitlab.sbmt.io/nstmrt/rubygems/gitlab-codeowners-checker
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Check every project file has codeowners.
+test_files: []