code_teams 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16b7aa715a2d1234dfff0c938a28e33631141e4fadf5489af3a872fc22f8c0ed
-  data.tar.gz: e6457f4a124c8f654fea97059de74814bb0e21859b95408eb4b2028de30508bc
+  metadata.gz: 9fd90de1ce7aec137a02a8ae637a0e07c7d77921af1842e1b9b7d53a0586f756
+  data.tar.gz: 7423dfedbda6246ef5b7fe923161719342541e39541f1eff5879d5ad43257764
 SHA512:
-  metadata.gz: dec7b2ed15177d10c82a16009179c76f571bf28f4bd1a56d0b9c4a132989f2e95ebddb11b3e0eb429567317e76bb33ace537f0cb3b447061519d77ca39efddf9
-  data.tar.gz: 4fa9956fd388b92ca1d5c4b3a7cbf2a439813c57e793edea0883c9e327c56eb8ae139898ed93b06b03bd346665567c37335e7d508afbb11eea05a85181cbe232
+  metadata.gz: 2547bcf7dca0a65cd7e12f7ffffad3ce583d03f78f199978372aea0f4818061bd5089668ec39c188821945ecd11ca61cc8ef0639f73da16f15f6b80625100902
+  data.tar.gz: a1a1559ccefc40fcfedb6ef78fad40d8cf21eccee582c4ced6894aa1f963059d747a24848bd4b15f931cd3dc2a1c732ec4854f2994d0e4cca7ad53e50edaa6fd

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,99 @@
+# 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
+      # Plugin's registry is keyed by team name, and the hook above only busts it after an
+      # example that built a fake team. An example reading only real teams therefore leaves
+      # real-team plugin instances behind, and a fake team sharing a real team's name would
+      # inherit that cached data. Drop the registry so the fake registers first.
+      Plugin.bust_caches!
+      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: T::Module[T.anything]).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,17 +1,40 @@
+# 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')
+        .gsub(/(?<=[A-Z])(?=[A-Z][a-z])/, '_')
         .gsub(/([a-z\d])([A-Z])/, '\1_\2')
         .tr('-', '_')
         .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

@@ -84,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,
@@ -103,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)) }
@@ -112,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.2.0
+  version: 1.3.1
 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:
@@ -50,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="