code_teams 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 755f17a56df0e3c1f337e0497b4b63887b0681626583bdf3a6f66ec4eb9ce46f
-  data.tar.gz: e060b12412a3a5c0ff02af18490a3ef336b8b83d5236ef5eed0f4a75c12ced2b
+  metadata.gz: c4e5cbd18c2a3348571f8b1a2c4cb556aff50b4e87322fefce0b50406fee8818
+  data.tar.gz: 3e8d66d171ce6a98b5eb9371b2edc96ad1f4ad6d9a75c5b324774ad173168363
 SHA512:
-  metadata.gz: 92594da3e4eccae671cd71d1564daf10009d41bd30612a0d5c1b66e3a729466d2c03ccea4c5cad5cf2196bc85be33a06520ec4767e94bb75219f070c8088449f
-  data.tar.gz: 9acbb9c011703218fe398179e723c796452b4564a06817124fd7cd599ea9e93a6d7f01987e0f03f274ddd100074d5d8260a18a85d51da69ae15a458bd992e29b
+  metadata.gz: c28e11c45ab2d51b0dedf49f5ff1b33591ab68904a7e7728e74bb7bfa44bca2a6b5795195f95be1c37728cab5b4ca0f7faa6d0827f64866987bb79c682e31ab0
+  data.tar.gz: c98171075d5059ad935e00bef6c4d0e79a391f7329e078677732b53f0465511a8e862399845b3c062e446b40b2ae123bc1f06c64c3950bcaa9b72fb91293445d

data/README.md

@@ -111,6 +111,32 @@ if errors.any?
 end
 ```
 
+## Testing
+
+`code_teams` provides test helpers for creating temporary teams in your specs without writing YML files to disk. Add the following to your `spec_helper.rb` (or `rails_helper.rb`):
+
+```ruby
+require 'code_teams/testing'
+
+CodeTeams::Testing.enable!
+```
+
+This gives you:
+- A `code_team_with_config` helper method available in all specs
+- Automatic cleanup of testing teams between examples
+
+Example usage in a spec:
+
+```ruby
+RSpec.describe 'my feature' do
+  it 'works with a team' do
+    team = code_team_with_config(name: 'Test Team')
+
+    expect(CodeTeams.find('Test Team')).to eq(team)
+  end
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome!

data/lib/code_teams/plugin.rb

@@ -25,12 +25,12 @@ module CodeTeams
     sig { returns(String) }
     def self.default_data_accessor_name
       # e.g., MyNamespace::MyPlugin -> my_plugin
-      Utils.underscore(Utils.demodulize(name))
+      Utils.underscore(Utils.demodulize(T.must(name)))
     end
 
-    sig { params(base: T.untyped).void }
+    sig { params(base: T.class_of(Plugin)).void }
     def self.inherited(base) # rubocop:disable Lint/MissingSuper
-      all_plugins << T.cast(base, T.class_of(Plugin))
+      all_plugins << base
     end
 
     sig { returns(T::Array[T.class_of(Plugin)]) }

data/lib/code_teams/testing/rspec_helpers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+#
+# typed: false
+
+require 'securerandom'
+require 'code_teams/testing'
+
+module CodeTeams
+  module Testing
+    module RSpecHelpers
+      def code_team_with_config(team_config = {})
+        team_config = team_config.dup
+        team_config[:name] ||= "Fake Team #{SecureRandom.hex(4)}"
+        CodeTeams::Testing.create_code_team(team_config)
+      end
+    end
+  end
+end

data/lib/code_teams/testing.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+#
+# typed: strict
+
+require 'securerandom'
+require 'code_teams'
+require 'code_teams/testing/rspec_helpers'
+
+module CodeTeams
+  # Utilities for tests that need a controlled set of teams without writing YML
+  # files to disk.
+  #
+  # Opt-in by requiring `code_teams/testing`.
+  module Testing
+    extend T::Sig
+
+    THREAD_KEY = T.let(:__code_teams_collection, Symbol)
+    @enabled = T.let(false, T::Boolean)
+
+    sig { void }
+    def self.enable!
+      return if @enabled
+
+      CodeTeams.prepend(CodeTeamsExtension)
+      @enabled = true
+
+      return unless defined?(RSpec)
+
+      T.unsafe(RSpec).configure do |config|
+        config.include CodeTeams::Testing::RSpecHelpers
+
+        config.around do |example|
+          example.run
+          # Bust caches because plugins may hang onto stale data between examples.
+          if CodeTeams::Testing.code_teams.any?
+            CodeTeams.bust_caches!
+            CodeTeams::Testing.reset!
+          end
+        end
+      end
+    end
+
+    sig { params(attributes: T::Hash[Symbol, T.untyped]).returns(CodeTeams::Team) }
+    def self.create_code_team(attributes)
+      attributes = attributes.dup
+      attributes[:name] ||= "Fake Team #{SecureRandom.hex(4)}"
+
+      code_team = CodeTeams::Team.new(
+        config_yml: 'tmp/fake_config.yml',
+        raw_hash: Utils.deep_stringify_keys(attributes)
+      )
+
+      code_teams << code_team
+      code_team
+    end
+
+    sig { returns(T::Array[CodeTeams::Team]) }
+    def self.code_teams
+      existing = Thread.current[THREAD_KEY]
+      return existing if existing.is_a?(Array)
+
+      Thread.current[THREAD_KEY] = []
+      T.cast(Thread.current[THREAD_KEY], T::Array[CodeTeams::Team])
+    end
+
+    sig { void }
+    def self.reset!
+      Thread.current[THREAD_KEY] = []
+    end
+
+    module CodeTeamsExtension
+      extend T::Sig
+
+      sig { params(base: Module).void }
+      def self.prepended(base)
+        base.singleton_class.prepend(ClassMethods)
+      end
+
+      module ClassMethods
+        extend T::Sig
+
+        sig { returns(T::Array[CodeTeams::Team]) }
+        def all
+          CodeTeams::Testing.code_teams + super
+        end
+
+        sig { params(name: String).returns(T.nilable(CodeTeams::Team)) }
+        def find(name)
+          CodeTeams::Testing.code_teams.find { |t| t.name == name } || super
+        end
+      end
+    end
+  end
+end

data/lib/code_teams/utils.rb

@@ -1,7 +1,14 @@
+# frozen_string_literal: true
+#
+# typed: strict
+
 module CodeTeams
   module Utils
+    extend T::Sig
+
     module_function
 
+    sig { params(string: String).returns(String) }
     def underscore(string)
       string.gsub('::', '/')
         .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
@@ -10,8 +17,24 @@ module CodeTeams
         .downcase
     end
 
+    sig { params(string: String).returns(String) }
     def demodulize(string)
-      string.split('::').last
+      T.must(string.split('::').last)
+    end
+
+    # Recursively converts symbol keys to strings. Top-level input should be a Hash.
+    sig { params(value: T.untyped).returns(T.untyped) }
+    def deep_stringify_keys(value)
+      case value
+      when Hash
+        value.each_with_object({}) do |(k, v), acc|
+          acc[k.to_s] = deep_stringify_keys(v)
+        end
+      when Array
+        value.map { |v| deep_stringify_keys(v) }
+      else
+        value
+      end
     end
   end
 end

data/lib/code_teams.rb

@@ -13,28 +13,27 @@ module CodeTeams
   extend T::Sig
 
   class IncorrectPublicApiUsageError < StandardError; end
+  class TeamNotFoundError < StandardError; end
 
   UNKNOWN_TEAM_STRING = 'Unknown Team'
   @plugins_registered = T.let(false, T::Boolean)
 
   sig { returns(T::Array[Team]) }
   def self.all
-    @all = T.let(@all, T.nilable(T::Array[Team]))
-    @all ||= for_directory('config/teams')
+    @all ||= T.let(for_directory('config/teams'), T.nilable(T::Array[Team]))
   end
 
   sig { params(name: String).returns(T.nilable(Team)) }
   def self.find(name)
-    @index_by_name = T.let(@index_by_name, T.nilable(T::Hash[String, CodeTeams::Team]))
-    @index_by_name ||= begin
-      result = {}
-      all.each { |t| result[t.name] = t }
-      result
-    end
-
+    @index_by_name ||= T.let(all.to_h { |t| [t.name, t] }, T.nilable(T::Hash[String, CodeTeams::Team]))
     @index_by_name[name]
   end
 
+  sig { params(name: String).returns(Team) }
+  def self.find!(name)
+    find(name) || raise(TeamNotFoundError, "No team found with name: #{name}")
+  end
+
   sig { params(dir: String).returns(T::Array[Team]) }
   def self.for_directory(dir)
     unless @plugins_registered
@@ -85,7 +84,7 @@ module CodeTeams
       )
     end
 
-    sig { params(raw_hash: T::Hash[T.untyped, T.untyped]).returns(Team) }
+    sig { params(raw_hash: T::Hash[String, T.untyped]).returns(Team) }
     def self.from_hash(raw_hash)
       new(
         config_yml: nil,
@@ -104,7 +103,7 @@ module CodeTeams
       end
     end
 
-    sig { returns(T::Hash[T.untyped, T.untyped]) }
+    sig { returns(T::Hash[String, T.untyped]) }
     attr_reader :raw_hash
 
     sig { returns(T.nilable(String)) }
@@ -113,7 +112,7 @@ module CodeTeams
     sig do
       params(
         config_yml: T.nilable(String),
-        raw_hash: T::Hash[T.untyped, T.untyped]
+        raw_hash: T::Hash[String, T.untyped]
       ).void
     end
     def initialize(config_yml:, raw_hash:)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code_teams
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Gusto Engineers
@@ -34,6 +34,8 @@ files:
 - lib/code_teams.rb
 - lib/code_teams/plugin.rb
 - lib/code_teams/plugins/identity.rb
+- lib/code_teams/testing.rb
+- lib/code_teams/testing/rspec_helpers.rb
 - lib/code_teams/utils.rb
 homepage: https://github.com/rubyatscale/code_teams
 licenses:
@@ -57,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A low-dependency gem for declaring and querying engineering teams
 test_files: []