code_ownership 1.28.2 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf48240fd31979132287823a3f9d40d6b03776df405583c31a56cb87e6dfbe40
-  data.tar.gz: 1cbd9b0fee826c7a23dd71335043eab358f99157bb7f677a94b8d4abc1782f4e
+  metadata.gz: 8008aad63593c3be910dc1e7f45f2518150d0e76a92f8a021279902995499402
+  data.tar.gz: 551585001712db071af3e33607bfd121ff48524fa66776f8ee48a299da28ef1a
 SHA512:
-  metadata.gz: 68721e648bcd3e8888f3f94d33baf0d38b642c3d6104db0964e6aff3194860407e72c9ad88ffec357285006bff87490b49b92a238fbbf83d37509d34868ea0fe
-  data.tar.gz: 0d878620986f0fe3e6168fa8ea0db1a1a530d27c0f35410f70b3f876146df2b184f9db3486ef9e4e74c0583a067b48ad4462af6877d7452e5d1574bec61ebd8f
+  metadata.gz: a2b94a65f309e158505b6dd4aa740cf3cfedc7076d9ccb0e7fbc1fe04ce147c8355cbe9cfd687a6b0e05e5ad755bb703f8fc1b530ad40f9b24fb9a4d8326a18f
+  data.tar.gz: 895352504690505cce06da848c5a400b3e48f1a9e10d49baa5a1e0093bd29c70c6042eaaa9c21dea14cbe8b0e7e44d15a8bf124150528f33280abee5eb101d97

data/README.md

@@ -92,6 +92,17 @@ Under the hood, this finds the file where the class is defined and returns the o
 
 See `code_ownership_spec.rb` for an example.
 
+### `for_team`
+`CodeOwnership.for_team` can be used to generate an ownership report for a team.
+```ruby
+CodeOwnership.for_team('My Team')
+```
+
+You can shovel this into a markdown file for easy viewing using the CLI:
+```
+bin/codeownership for_team 'My Team' > tmp/ownership_report.md
+```
+
 ## Usage: Generating a `CODEOWNERS` file
 
 A `CODEOWNERS` file defines who owns specific files or paths in a repository. When you run `bin/codeownership validate`, a `.github/CODEOWNERS` file will automatically be generated and updated.

data/lib/code_ownership/cli.rb

@@ -11,6 +11,8 @@ module CodeOwnership
         validate!(argv)
       elsif command == 'for_file'
         for_file(argv)
+      elsif command == 'for_team'
+        for_team(argv)
       elsif [nil, "help"].include?(command)
         puts <<~USAGE
           Usage: bin/codeownership <subcommand>
@@ -18,6 +20,7 @@ module CodeOwnership
           Subcommands:
             validate - run all validations
             for_file - find code ownership for a single file
+            for_team - find code ownership information for a team
             help  - display help information about code_ownership
         USAGE
       else
@@ -116,6 +119,28 @@ module CodeOwnership
       end
     end
 
+    def self.for_team(argv)
+      options = {}
+
+      parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: bin/codeownership for_team \'Team Name\''
+
+        opts.on('--help', 'Shows this prompt') do
+          puts opts
+          exit
+        end
+      end
+      teams = argv.select { |arg| !arg.start_with?('--') }
+      args = parser.order!(argv) {}
+      parser.parse!(args)
+
+      if teams.count != 1
+        raise "Please pass in one team. Use `bin/codeownership for_team --help` for more info"
+      end
+      
+      puts CodeOwnership.for_team(teams.first)
+    end
+
     private_class_method :validate!
   end
 end

data/lib/code_ownership.rb

@@ -35,6 +35,36 @@ module CodeOwnership
     @for_file[file] = owner
   end
 
+  sig { params(team: T.any(CodeTeams::Team, String)).returns(String) }
+  def for_team(team)
+    team = T.must(CodeTeams.find(team)) if team.is_a?(String)
+    ownership_information = T.let([], T::Array[String])
+
+    ownership_information << "# Code Ownership Report for `#{team.name}` Team"
+    Private.mappers.each do |mapper|
+      ownership_information << "## #{mapper.description}"
+      codeowners_lines = mapper.codeowners_lines_to_owners
+      ownership_for_mapper = []
+      codeowners_lines.each do |line, team_for_line|
+        next if team_for_line.nil?
+        if team_for_line.name == team.name
+          ownership_for_mapper << "- #{line}"
+        end
+      end
+
+      if ownership_for_mapper.empty?
+        ownership_information << 'This team owns nothing in this category.'
+      else
+        ownership_information += ownership_for_mapper
+      end
+
+      
+      ownership_information << ""
+    end
+
+    ownership_information.join("\n")
+  end
+
   class InvalidCodeOwnershipConfigurationError < StandardError
   end
 

data/sorbet/config

@@ -1,4 +1,5 @@
 --dir
 .
 --ignore=/spec
+--ignore=/vendor/bundle
 --enable-experimental-requires-ancestor

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_ownership
 version: !ruby/object:Gem::Version
-  version: 1.28.2
+  version: 1.29.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-18 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams
@@ -176,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A gem to help engineering teams declare ownership of code