code_teams 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 443aa599a4db945ed8020950a938cdaad99818c52728883115b72cd5eda5c68a
-  data.tar.gz: 298e59f227cc4a07dd64fd2bc03dde9b57e46965dd7eb5be9ce72153928631a3
+  metadata.gz: 755f17a56df0e3c1f337e0497b4b63887b0681626583bdf3a6f66ec4eb9ce46f
+  data.tar.gz: e060b12412a3a5c0ff02af18490a3ef336b8b83d5236ef5eed0f4a75c12ced2b
 SHA512:
-  metadata.gz: 744e2d89ba032674399ca1f449b5f139cc11fb9818e6411346c638c12232f727971e46500f4acbad832412299612f1ef3b3fbc38a6e77a582e1ea2779cbd3b73
-  data.tar.gz: ade5869ed1e8b5d4f5768b61c4c66df84ef0c6f0bd9190dbedbafabe9c0d8bfdd2e1ff83f3d83d6310934575ded45e274955651d9591c7fcf4fccbadea37fede
+  metadata.gz: 92594da3e4eccae671cd71d1564daf10009d41bd30612a0d5c1b66e3a729466d2c03ccea4c5cad5cf2196bc85be33a06520ec4767e94bb75219f070c8088449f
+  data.tar.gz: 9acbb9c011703218fe398179e723c796452b4564a06817124fd7cd599ea9e93a6d7f01987e0f03f274ddd100074d5d8260a18a85d51da69ae15a458bd992e29b

data/README.md

@@ -30,10 +30,7 @@ class MyGithubPlugin < CodeTeams::Plugin
   end
 
   def member?(user)
-    members = github.members
-    return false unless members
-
-    members.include?(user)
+    github.members.include?(user)
   end
 
   sig { override.params(teams: T::Array[CodeTeams::Team]).returns(T::Array[String]) }
@@ -62,24 +59,50 @@ github:
 ```
 
 1) You can now use the following API to get GitHub information about that team:
-```ruby
-team = CodeTeams.find('My Team')
-MyGithubPlugin.for(team).github
-```
+
+    ```ruby
+    team = CodeTeams.find('My Team')
+    members = team.github.members
+    github_name = team.github.team
+    ```
+
+    Alternatively, you can assign an accessor method name that differs from the plugin's class name:
+
+    ```ruby
+    class MyPlugin < CodeTeams::Plugin
+      data_accessor_name :other_name
+
+      def other_name
+        # ...
+      end
+    end
+
+    # You can then use:
+    team.other_name
+    # similarly to the Github example above
+    # You can then access data in the following manner:
+    team.other_name.attribute_name
+    ```
+
+    However, to avoid confusion, it's recommended to use the naming convention 
+    whenever possible so that your accessor name matches your plugin's name
+
 2) Running team validations (see below) will ensure all teams have a GitHub team specified
 
-Your plugins can be as simple or as complex as you want. Here are some other things we use plugins for:
-- Identifying which teams own which feature flags
-- Mapping teams to specific portions of the code through `code_ownership`
-- Allowing teams to protect certain files and require approval on modification of certain files
-- Specifying owned dependencies (Ruby gems, JavaScript packages, and more)
-- Specifying how to get in touch with the team via Slack (their channel and handle)
+    Your plugins can be as simple or as complex as you want. Here are some other things we use plugins for:
+
+    - Identifying which teams own which feature flags
+    - Mapping teams to specific portions of the code through `code_ownership`
+    - Allowing teams to protect certain files and require approval on modification of certain files
+    - Specifying owned dependencies (Ruby gems, JavaScript packages, and more)
+    - Specifying how to get in touch with the team via Slack (their channel and handle)
 
 ## Configuration
 You'll want to ensure that all teams are valid in your CI environment. We recommend running code like this in CI:
 ```ruby
 require 'code_teams'
-errors = ::CodeTeams.validation_errors(::CodeTeams.all)
+
+errors = CodeTeams.validation_errors(CodeTeams.all)
 if errors.any?
   abort <<~ERROR
     Team validation failed with the following errors:

data/lib/code_teams/plugin.rb

@@ -10,11 +10,24 @@ module CodeTeams
 
     abstract!
 
+    @data_accessor_name = T.let(nil, T.nilable(String))
+
     sig { params(team: Team).void }
     def initialize(team)
       @team = team
     end
 
+    sig { params(key: String).returns(String) }
+    def self.data_accessor_name(key = default_data_accessor_name)
+      @data_accessor_name ||= key
+    end
+
+    sig { returns(String) }
+    def self.default_data_accessor_name
+      # e.g., MyNamespace::MyPlugin -> my_plugin
+      Utils.underscore(Utils.demodulize(name))
+    end
+
     sig { params(base: T.untyped).void }
     def self.inherited(base) # rubocop:disable Lint/MissingSuper
       all_plugins << T.cast(base, T.class_of(Plugin))
@@ -28,7 +41,7 @@ module CodeTeams
     end
 
     sig { params(teams: T::Array[Team]).returns(T::Array[String]) }
-    def self.validation_errors(teams) # rubocop:disable Lint/UnusedMethodArgument
+    def self.validation_errors(teams)
       []
     end
 
@@ -42,9 +55,9 @@ module CodeTeams
       "#{team.name} is missing required key `#{key}`"
     end
 
-    sig { returns(T::Hash[T.nilable(String), T::Hash[Class, Plugin]]) }
+    sig { returns(T::Hash[T.nilable(String), T::Hash[T.class_of(Plugin), Plugin]]) }
     def self.registry
-      @registry ||= T.let(@registry, T.nilable(T::Hash[String, T::Hash[Class, Plugin]]))
+      @registry ||= T.let(@registry, T.nilable(T::Hash[String, T::Hash[T.class_of(Plugin), Plugin]]))
       @registry ||= {}
       @registry
     end

data/lib/code_teams/utils.rb

@@ -0,0 +1,17 @@
+module CodeTeams
+  module Utils
+    module_function
+
+    def underscore(string)
+      string.gsub('::', '/')
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .tr('-', '_')
+        .downcase
+    end
+
+    def demodulize(string)
+      string.split('::').last
+    end
+  end
+end

data/lib/code_teams.rb

@@ -3,11 +3,11 @@
 # typed: strict
 
 require 'yaml'
-require 'set'
 require 'pathname'
 require 'sorbet-runtime'
 require 'code_teams/plugin'
 require 'code_teams/plugins/identity'
+require 'code_teams/utils'
 
 module CodeTeams
   extend T::Sig
@@ -15,6 +15,7 @@ module CodeTeams
   class IncorrectPublicApiUsageError < StandardError; end
 
   UNKNOWN_TEAM_STRING = 'Unknown Team'
+  @plugins_registered = T.let(false, T::Boolean)
 
   sig { returns(T::Array[Team]) }
   def self.all
@@ -36,6 +37,11 @@ module CodeTeams
 
   sig { params(dir: String).returns(T::Array[Team]) }
   def self.for_directory(dir)
+    unless @plugins_registered
+      Team.register_plugins
+      @plugins_registered = true
+    end
+
     Pathname.new(dir).glob('**/*.yml').map do |path|
       Team.from_yml(path.to_s)
     rescue Psych::SyntaxError
@@ -60,6 +66,7 @@ module CodeTeams
   # The primary reason this is helpful is for clients of CodeTeams who want to test their code, and each test context has different set of teams
   sig { void }
   def self.bust_caches!
+    @plugins_registered = false
     Plugin.bust_caches!
     @all = nil
     @index_by_name = nil
@@ -86,6 +93,17 @@ module CodeTeams
       )
     end
 
+    sig { void }
+    def self.register_plugins
+      Plugin.all_plugins.each do |plugin|
+        # e.g., def github (on Team)
+        define_method(plugin.data_accessor_name) do
+          # e.g., MyGithubPlugin.for(team).github
+          plugin.for(T.cast(self, Team)).public_send(plugin.data_accessor_name)
+        end
+      end
+    end
+
     sig { returns(T::Hash[T.untyped, T.untyped]) }
     attr_reader :raw_hash
 
@@ -116,16 +134,16 @@ module CodeTeams
     sig { params(other: Object).returns(T::Boolean) }
     def ==(other)
       if other.is_a?(CodeTeams::Team)
-        self.name == other.name
+        name == other.name
       else
         false
       end
     end
 
-    alias_method :eql?, :==
+    alias eql? ==
 
     sig { returns(Integer) }
-    def hash # rubocop:disable Rails/Delegate
+    def hash
       name.hash
     end
   end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: code_teams
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Gusto Engineers
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -24,62 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: sorbet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: A low-dependency gem for declaring and querying engineering teams
 email:
 - dev@gusto.com
@@ -91,6 +34,7 @@ files:
 - lib/code_teams.rb
 - lib/code_teams/plugin.rb
 - lib/code_teams/plugins/identity.rb
+- lib/code_teams/utils.rb
 homepage: https://github.com/rubyatscale/code_teams
 licenses:
 - MIT
@@ -99,7 +43,6 @@ metadata:
   source_code_uri: https://github.com/rubyatscale/code_teams
   changelog_uri: https://github.com/rubyatscale/code_teams/releases
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -107,15 +50,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A low-dependency gem for declaring and querying engineering teams
 test_files: []