codeowners 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 162d8c21d1f878a18c07817645f62191d2e4996d58533f819e6ebf102e7409fb
-  data.tar.gz: 4e06893a39070f1c34178f62e31e9afea773096bb121d98cdefea1620825bd2a
+  metadata.gz: 66eab678e31ae2c7c45bf32e8b8a92163bb3cef3147475a95775ece36081dce2
+  data.tar.gz: e188c85670d6cc4d1a0bb1d2f2fb6aee9085f1ad3b3ef978027d55ec4afc311d
 SHA512:
-  metadata.gz: 579bbfb6ce368e0407d6d17f644e352b9f9823fd9ed71850189917d272e1ffe6177dd10650f0604172f7a4318d51cd550530c738397f8d90becff8348fbb701a
-  data.tar.gz: 250bb637dfa66ef6cd4455c489e980e5475b1e67f5684cd70791dba1fe58b8d0e126d11031b3cd3b1f5eb1b6e0b5b5eb870f87e3bc6d7234d9713c1d299bbcd0
+  metadata.gz: 0c4e4381b4cdd046065ec83a785d742b058768d9b27cb78b765ecfe230e76e4a1cc608a3f395496196be051601ae7e9f22a3050f64e97e70a0f3761db481a204
+  data.tar.gz: 4037d4d9ba417ffe5ae65c3e50051f245c111f80e3880366b1bde609d936f15cef994a38a1438c64842447dbb2bb2f5685a6fd0c46268a065187699357541b9a

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Codeowners
 Simple CLI to interact with GitHub CODEOWNERS
 
+## v0.0.2 - 2020-06-27
+### Added
+- [Luca Guidi] Added pattern support to `codeowners contributors`
+
 ## v0.0.1 - 2020-06-12
 ### Added
 - [Luca Guidi] Added `codeowners contributors`

data/README.md

@@ -34,6 +34,17 @@ Person One  / +106, -0
 Person Two <person.two@company.com> / +12, -2
 ```
 
+The command accepts also a pattern to match files in bulk.
+
+```shell
+$ codeowners contributors 'path/to/**/*.rb'
+path/to/**/*.rb
+
+Person One <person.one@company.com> / +243, -438
+Person Three <person.three@company.com> / +104, -56
+Person Two <person.two@company.com> / +12, -2
+```
+
 ### Help
 
 For a complete set of options, please run:

data/lib/codeowners/cli.rb

@@ -55,17 +55,43 @@ module Codeowners
         DEFAULT_CODEOWNERS_PATH = ::File.join(".github", "CODEOWNERS").freeze
         private_constant :DEFAULT_CODEOWNERS_PATH
 
-        desc "List code contributors for a file"
+        FORMAT_MAPPING = { "string" => "to_s", "csv" => "to_csv" }.freeze
+        private_constant :FORMAT_MAPPING
 
-        argument :file, required: true, desc: "File to check"
+        FORMAT_VALUES = FORMAT_MAPPING.keys.freeze
+        private_constant :FORMAT_VALUES
+
+        DEFAULT_FORMAT = FORMAT_VALUES.first
+        private_constant :DEFAULT_FORMAT
+
+        DEFAULT_DEBUG = false
+        private_constant :DEFAULT_DEBUG
+
+        desc "List code contributors for a file (or a pattern)"
+
+        argument :file, required: true, desc: "File (or pattern) to check"
 
         option :base_directory, type: :string, default: DEFAULT_BASE_DIRECTORY, desc: "Base directory"
+        option :format, type: :string, default: DEFAULT_FORMAT, values: FORMAT_VALUES, desc: "Output format"
+        option :debug, type: :boolean, default: DEFAULT_DEBUG, desc: "Print debug information to stdout"
+
+        example [
+          "path/to/file.rb # file",
+          "'path/to/**/*.rb' # pattern"
+        ]
 
-        def call(file:, base_directory:, **)
-          result = Codeowners::ListContributors.new(base_directory).call(file)
+        def call(file:, base_directory:, format:, debug:, **)
+          result = Codeowners::ListContributors.new(base_directory).call(file, debug)
           exit(1) unless result.successful?
 
-          out.puts result.to_s
+          out.puts output(result, format)
+        end
+
+        private
+
+        def output(result, format)
+          method_name = FORMAT_MAPPING.fetch(format)
+          result.public_send(method_name.to_sym)
         end
       end
 

data/lib/codeowners/git.rb

@@ -9,9 +9,10 @@ module Codeowners
       @base_directory = Pathname.new(::File.expand_path(base_directory))
     end
 
-    def contributors(file)
+    def contributors(file, debug = false)
       require "codeowners/git/contributors"
-      output = git(["log", "--max-count=500", "--shortstat", %(--pretty=format:"author:%aN email:%ae"), "--no-color", "--", escape(file)])
+      output = git(["log", "--numstat", %(--pretty=format:"author:%aN email:%ae"), "--no-color", "--", escape(file)])
+      print_debug(output, debug)
 
       Contributors.call(file, output)
     end
@@ -42,5 +43,12 @@ module Codeowners
         return stdout.read
       end
     end
+
+    def print_debug(output, debug)
+      return unless debug
+
+      puts output
+      puts "\n" * 10
+    end
   end
 end

data/lib/codeowners/git/contributor.rb

@@ -18,6 +18,10 @@ module Codeowners
       def to_s
         "#{name} <#{email}> / +#{insertions}, -#{deletions}"
       end
+
+      def to_csv
+        "#{name}, #{email}, #{insertions}, #{deletions}"
+      end
     end
   end
 end

data/lib/codeowners/git/contributors.rb

@@ -36,27 +36,37 @@ module Codeowners
         while lines.any?
           commit = lines.take_while { |line| line != "" }
           yield parse(commit.dup) unless commit.empty?
-          lines -= commit
-          lines.shift
+          lines.shift(commit.size + 1)
         end
       end
 
       def self.parse(commit)
-        stats = commit.pop
-        stats = stats.split(", ")
+        authors, stats = commit.partition { |line| line.match?(/author:/) }
 
-        _, insertions, deletions = *stats
-        insertions = insertions.to_i
-        deletions = deletions.to_i
+        [extract_authors(authors), *calculate_stats(stats)]
+      end
 
-        authors = commit.map do |author|
+      def self.extract_authors(authors)
+        authors.map do |author|
           {
-            "name" => author.scan(/author:(.*)email:/).flatten.first.chop,
-            "email" => author.scan(/email:(.*)/).flatten.first
+            "name" => scan(author, /author:(.*)email:/).chop,
+            "email" => scan(author, /email:(.*)/)
           }
+        end.uniq
+      end
+
+      def self.calculate_stats(stats)
+        stats.each_with_object([0, 0]) do |stat, result|
+          stat = stat.split(/[[:space:]]+/)
+
+          insertions, deletions, = *stat
+          result[0] += Integer(insertions)
+          result[1] += Integer(deletions)
         end
+      end
 
-        [authors.uniq, insertions, deletions]
+      def self.scan(string, pattern)
+        string.scan(pattern).flatten.first
       end
 
       def initialize(data)

data/lib/codeowners/list_contributors.rb

@@ -17,14 +17,18 @@ module Codeowners
       def to_s
         [@file, "", *@contributors.map(&:to_s)].join("\n")
       end
+
+      def to_csv
+        @contributors.map(&:to_csv).join("\n")
+      end
     end
 
     def initialize(base_directory, git: Git.new(base_directory))
       @git = git
     end
 
-    def call(file)
-      contributors = @git.contributors(file)
+    def call(file, debug = false)
+      contributors = @git.contributors(file, debug)
       return Result.new if contributors.empty?
 
       contributors = contributors.each.lazy.sort_by { |c| -c.insertions }

data/lib/codeowners/result.rb

@@ -2,6 +2,8 @@
 
 module Codeowners
   class Result
+    attr_reader :owners
+
     def initialize(pattern = nil, owners = [])
       @pattern = pattern
       @owners = owners

data/lib/codeowners/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Codeowners
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeowners
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli