code_ownership 1.23.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c664c64c94e083083f3187002fc77ffb7d40cbc7c5c76ae0291b9d5c11cd224f
-  data.tar.gz: cf6dcc613f67a6e7723fa73a079dabfa8782ddba886441afd8e5608eaa9249ec
+  metadata.gz: 988c067afbabcc65d5b697aea162ba1c288787e4d7d9a84a261b00f76859aa6b
+  data.tar.gz: 6a504214d4470cfd2d1ab103f201069367e39962a390d34382410587a6067e40
 SHA512:
-  metadata.gz: 54373f777f534bd2f600510e1ee94b85151bc5016d076d35ef5ed7d140a1d8b53d1bcea24a1af2badebc5939c52c1e2660e066eb49fcbcc4fb7a330cf227664f
-  data.tar.gz: c94fd3d689b09a27b8db89b339e3037ec8e6c1fe76413226b22662ce068599ecd30a6aa80e0f90e389a0d1a17bb58afebd650ed4c8bd57523336bd688517f819
+  metadata.gz: 16b3e48c3cb734857dd66cf03f9d43d89bb92ee3ab92abfc0550004274531e03eef4abc9157fab33e25d815dd5b5c6f055d65987e7526dcb4952212930935678
+  data.tar.gz: 0f0cc9f4a1b8938e088bc258d5b247d633beaac3c68ddf37ea269fa3740d27d796b9773354e47855e79ecd5e958b49d97fd9f231f42502e62eab508d1d8ea9a1

data/README.md

@@ -5,6 +5,8 @@ Check out `lib/code_ownership.rb` to see the public API.
 
 Check out `code_ownership_spec.rb` to see examples of how code ownership is used.
 
+There is also a [companion VSCode Extension]([url](https://github.com/bigrails/code-ownership-vscode)) for this gem. Just search `Gusto.code-ownership-vscode` in the VSCode Extension Marketplace.
+
 ## Usage: Declaring Ownership
 There are three ways to declare code ownership using this gem.
 ### Package-Based Ownership

data/lib/code_ownership/cli.rb

@@ -6,12 +6,24 @@ require 'pathname'
 module CodeOwnership
   class Cli
     def self.run!(argv)
-      # Someday we might support other subcommands. When we do that, we can call
-      # argv.shift to get the first argument and check if it's a given subcommand.
       command = argv.shift
       if command == 'validate'
         validate!(argv)
+      elsif command == 'for_file'
+        for_file(argv)
+      elsif [nil, "help"].include?(command)
+        puts <<~USAGE
+          Usage: bin/codeownership <subcommand>
+
+          Subcommands:
+            validate - run all validations
+            for_file - find code ownership for a single file
+            help  - display help information about code_ownership
+        USAGE
+      else
+        puts "'#{command}' is not a code_ownership command. See `bin/codeownership help`."
       end
+
     end
 
     def self.validate!(argv)
@@ -55,6 +67,55 @@ module CodeOwnership
       )
     end
 
+    # For now, this just returns team ownership
+    # Later, this could also return code ownership errors about that file.
+    def self.for_file(argv)
+      options = {}
+
+      # Long-term, we probably want to use something like `thor` so we don't have to implement logic
+      # like this. In the short-term, this is a simple way for us to use the built-in OptionParser
+      # while having an ergonomic CLI.
+      files = argv.select { |arg| !arg.start_with?('--') }
+
+      parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: bin/codeownership for_file [options]'
+
+        opts.on('--json', 'Output as JSON') do
+          options[:json] = true
+        end
+
+        opts.on('--help', 'Shows this prompt') do
+          puts opts
+          exit
+        end
+      end
+      args = parser.order!(argv) {}
+      parser.parse!(args)
+
+      if files.count != 1
+        raise "Please pass in one file. Use `bin/codeownership for_file --help` for more info"
+      end
+      
+      team = CodeOwnership.for_file(files.first)
+
+      team_name = team&.name || "Unowned"
+      team_yml = team&.config_yml || "Unowned"
+
+      if options[:json]
+        json = {
+          team_name: team_name,
+          team_yml: team_yml,
+        }
+
+        puts json.to_json
+      else
+        puts <<~MSG
+          Team: #{team_name}
+          Team YML: #{team_yml}
+        MSG
+      end
+    end
+
     private_class_method :validate!
   end
 end

data/lib/code_ownership/private.rb

@@ -50,7 +50,7 @@ module CodeOwnership
       end
 
       if errors.any?
-        errors << 'See https://github.com/bigrails/code_ownership/README.md for more details'
+        errors << 'See https://github.com/bigrails/code_ownership#README.md for more details'
         raise InvalidCodeOwnershipConfigurationError.new(errors.join("\n")) # rubocop:disable Style/RaiseArgs
       end
     end

data/sorbet/rbi/manual.rbi

@@ -0,0 +1,3 @@
+class Hash
+  def to_json; end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_ownership
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.26.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigrails-teams
@@ -151,6 +151,7 @@ files:
 - sorbet/config
 - sorbet/rbi/gems/bigrails-teams@0.1.0.rbi
 - sorbet/rbi/gems/parse_packwerk@0.7.0.rbi
+- sorbet/rbi/manual.rbi
 - sorbet/rbi/todo.rbi
 homepage: https://github.com/bigrails/code_ownership
 licenses: