codeowners-checker 1.0.5 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fea710f9cf51fa064b3ac9fdd73290673959ebb8f1d3420fc10db85f38d427be
-  data.tar.gz: 81277d6cfdcb325372374a3ef09ef7d91526672b78c25f5b5e42bb756a150ab0
+  metadata.gz: 6d9d7332bd9c20b04f99d88d0d91ba7430e64ea45af0720f3b96b66aab535bd6
+  data.tar.gz: 52a7866ebda6380f924c18f80ab689e6cd5416f5ea0da8e96b6ea09e1645eca3
 SHA512:
-  metadata.gz: 9170ec3459dcaeabb7cdd6abdde1faab7739db931f5bdb01e9a202cd6b2b794a1561a033272f6fd3c41798f8dc662ceb939e2ea17a121aca26ec8318639db875
-  data.tar.gz: 481e5e568f458f408e2d260538dfaba02da323f2267cca7969b662ece7ec61b163f7419f04221cac7a784c26aae59bbca48e677d394e5f66c37e218dd5f509bf
+  metadata.gz: 89a86ecabad2150b1f1f17f202ef70226d071754bd689d349ef412c23d1423446600648f79d7ec1f8508b1a432b154a156d9e9261008c93168de6633f79109f0
+  data.tar.gz: 554ee80bdb5cad8eada8b850dcca17c147511bbbddd114bc03a2ee3d79f28a5e68fd9543a599887e606bf050e519038f9c69a0c5f27eb7e97b10c542ddc0ce49

data/README.md

@@ -33,7 +33,11 @@ Example OWNERS:
 GitHub credentials are taken from the following environment variables. You might want to put them into your .bashrc or equivalent:
 
     $ export GITHUB_TOKEN='your GitHub PAT' # your personal access token from GitHub
-    $ export GITHUB_ORGANIZATION='company' # name of your GitHub organization
+
+The Github organization used to retrieve the groups/teams is automatically set according to the git remote URL. You can check and change this value using:
+
+    $ codeowners-checker config list
+    $ codeowners-checker config organization <organization>
 
 You can generate your PAT in [Settings -> Developer settings -> Personal access tokens on GitHub](https://github.com/settings/tokens) and `read:org` scope is **required**.
 
@@ -187,7 +191,7 @@ Or you can filter any owner as a parameter:
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. 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).
 

data/codeowners-checker.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'fuzzy_match', '~> 2.1'
   spec.add_dependency 'git', '~> 1.5'
   spec.add_dependency 'json', '~> 2.1'
+  spec.add_dependency 'pathspec', '~> 0.2.0'
   spec.add_dependency 'rest-client', '~> 2.1'
   spec.add_dependency 'thor', '~> 0.20.3'
   spec.add_development_dependency 'bundler', '~> 1.16'

data/lib/codeowners/checker/group/pattern.rb

@@ -2,6 +2,7 @@
 
 require_relative 'line'
 require_relative '../owner'
+require 'pathspec'
 
 module Codeowners
   class Checker
@@ -10,7 +11,7 @@ module Codeowners
       # Parse the line into pattern, owners and whitespaces.
       class Pattern < Line
         attr_accessor :owners, :whitespace
-        attr_reader :pattern
+        attr_reader :pattern, :spec
 
         def self.match?(line)
           _pattern, *owners = line.split(/\s+/)
@@ -35,24 +36,18 @@ module Codeowners
         def parse(line)
           @pattern, *@owners = line.split(/\s+/)
           @whitespace = line.split('@').first.count(' ') - 1
+          @spec = parse_spec(@pattern)
         end
 
         def match_file?(file)
-          File.fnmatch(pattern.gsub(%r{^/}, ''), file, fn_options)
-        end
-
-        def fn_options
-          if pattern.include?('**')
-            File::FNM_DOTMATCH
-          else
-            File::FNM_DOTMATCH | File::FNM_PATHNAME
-          end
+          spec.match file
         end
 
         def pattern=(new_pattern)
           @whitespace += @pattern.size - new_pattern.size
           @whitespace = 1 if @whitespace < 1
 
+          @spec = parse_spec(new_pattern)
           @pattern = new_pattern
         end
 
@@ -68,6 +63,10 @@ module Codeowners
         def to_s
           to_file(preserve_whitespaces: false)
         end
+
+        def parse_spec(pattern)
+          PathSpec.from_lines(pattern)
+        end
       end
     end
   end

data/lib/codeowners/checker/owners_list.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'file_as_array'
+require_relative '../config'
 
 module Codeowners
   class Checker
@@ -9,10 +10,17 @@ module Codeowners
       attr_accessor :validate_owners, :filename
       attr_writer :owners
 
-      def initialize(repo)
+      def initialize(repo, _config = nil)
         @validate_owners = true
         # doing gsub here ensures the files are always in the same directory
         @filename = CodeOwners.filename(repo).gsub('CODEOWNERS', 'OWNERS')
+        @config ||= Codeowners::Config.new
+      end
+
+      def self.persist!(repo, owners, config = nil)
+        owner_list = new(repo, config)
+        owner_list.owners = owners
+        owner_list.persist!
       end
 
       def persist!
@@ -30,7 +38,7 @@ module Codeowners
 
         @owners ||=
           if github_credentials_exist?
-            Codeowners::GithubFetcher.get_owners(ENV['GITHUB_ORGANIZATION'], ENV['GITHUB_TOKEN'])
+            Codeowners::GithubFetcher.get_owners(@config.default_organization, ENV['GITHUB_TOKEN'])
           else
             FileAsArray.new(@filename).content
           end
@@ -38,8 +46,8 @@ module Codeowners
 
       def github_credentials_exist?
         token = ENV['GITHUB_TOKEN']
-        organization = ENV['GITHUB_ORGANIZATION']
-        token && organization
+        organization = @config.default_organization
+        token && !organization.empty?
       end
 
       def invalid_owners(codeowners)

data/lib/codeowners/checker/version.rb

@@ -2,6 +2,6 @@
 
 module Codeowners
   class Checker
-    VERSION = '1.0.5'
+    VERSION = '1.1.1'
   end
 end

data/lib/codeowners/cli/base.rb

@@ -3,6 +3,7 @@
 require 'thor'
 
 require_relative '../config'
+require_relative 'warner'
 
 module Codeowners
   module Cli
@@ -13,6 +14,7 @@ module Codeowners
       def initialize(args = [], options = {}, config = {})
         super
         @config ||= config[:config] || default_config
+        Warner.check_warnings
       end
 
       private

data/lib/codeowners/cli/config.rb

@@ -8,10 +8,10 @@ module Codeowners
     class Config < Base
       default_task :list
 
-      desc 'list', 'List the default owner configured in the config file'
+      desc 'list', 'List the default values configured in the config file'
       def list
         puts(config.to_h.map { |name, value| "#{name}: #{value.inspect}" })
-        help_stderr if config.default_owner.empty?
+        help_stderr if config.default_owner.empty? || config.default_organization.empty?
       end
 
       desc 'owner <name>', 'Configure a default owner name'
@@ -19,6 +19,12 @@ module Codeowners
         config.default_owner = name
         puts "Default owner configured to #{name}"
       end
+
+      desc 'organization <name>', 'Configure a default organization name'
+      def organization(name)
+        config.default_organization = name
+        puts "Default organization configured to #{name}"
+      end
     end
   end
 end

data/lib/codeowners/cli/owners_list_handler.rb

@@ -8,22 +8,24 @@ module Codeowners
     class OwnersListHandler < Base
       default_task :fetch
 
+      FETCH_OWNER_MESSAGE = 'Fetching owners list from GitHub ...'
+      ASK_GITHUB_ORGANIZATION = 'GitHub organization (e.g. github): '
+      ASK_GITHUB_TOKEN = 'Enter GitHub token: '
+
       desc 'fetch [REPO]', 'Fetches .github/OWNERS based on github organization'
       def fetch(repo = '.')
         @repo = repo
         owners = owners_from_github
-        owners_list = Checker::OwnersList.new(repo)
-        owners_list.owners = owners
-        owners_list.persist!
+        Checker::OwnersList.persist!(repo, owners)
       end
 
       no_commands do
         def owners_from_github
-          organization = ENV['GITHUB_ORGANIZATION']
-          organization ||= ask('GitHub organization (e.g. github): ')
+          organization = config.default_organization
+          organization = ask(ASK_GITHUB_ORGANIZATION) if organization.empty?
           token = ENV['GITHUB_TOKEN']
-          token ||= ask('Enter GitHub token: ', echo: false)
-          puts 'Fetching owners list from GitHub ...'
+          token ||= ask(ASK_GITHUB_TOKEN, echo: false)
+          puts FETCH_OWNER_MESSAGE
           Codeowners::GithubFetcher.get_owners(organization, token)
         end
       end

data/lib/codeowners/cli/warner.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Codeowners
+  module Cli
+    # Checks and prints deprecation warnings.
+    module Warner
+      class << self
+        def check_warnings
+          check_github_env
+        end
+
+        def warn(msg)
+          puts "[WARNING] #{msg}"
+        end
+
+        protected
+
+        def check_github_env
+          return if ENV['GITHUB_ORGANIZATION'].nil? || ENV['GITHUB_ORGANIZATION'].empty?
+
+          warn 'Usage of GITHUB_ORGANIZATION ENV variable has been deprecated.'\
+            'Run `codeowners-checker config organization #{organization}` instead.'
+        end
+      end
+    end
+  end
+end

data/lib/codeowners/config.rb

@@ -40,10 +40,34 @@ module Codeowners
       @git.config('user.owner', name)
     end
 
+    def default_organization
+      config_org = @git.config('user.organization')
+      return config_org.strip unless config_org.nil? || config_org.strip.empty?
+
+      parse_organization_from_origin || ''
+    end
+
+    def default_organization=(name)
+      @git.config('user.organization', name)
+    end
+
     def to_h
       {
-        default_owner: default_owner
+        default_owner: default_owner,
+        default_organization: default_organization
       }
     end
+
+    protected
+
+    def parse_organization_from_origin
+      origin_url = @git.config('remote.origin.url')
+      return if origin_url.nil? || origin_url.strip.empty?
+
+      org_regexp = origin_url.match(%r{^https?://.+?/(?<org>.+?)/|:(?<org>.+?)/})
+      return if org_regexp.nil? || org_regexp[:org].strip.empty?
+
+      org_regexp[:org].strip
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codeowners-checker
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.1
 platform: ruby
 authors:
 - Jônatas Davi Paganini
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-23 00:00:00.000000000 Z
+date: 2020-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fuzzy_match
@@ -54,6 +54,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pathspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -247,6 +261,7 @@ files:
 - lib/codeowners/cli/main.rb
 - lib/codeowners/cli/owners_list_handler.rb
 - lib/codeowners/cli/suggest_file_from_pattern.rb
+- lib/codeowners/cli/warner.rb
 - lib/codeowners/cli/wizards.rb
 - lib/codeowners/cli/wizards/new_file_wizard.rb
 - lib/codeowners/cli/wizards/new_owner_wizard.rb