modularization_statistics 1.33.0 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfd014b44b30778ec250a807009b4803b8e4b81c99e4fcc46d70cfca8feca8bb
-  data.tar.gz: ba83025eaa394685d99a28eadb5a7e30893107396b1c723b055e7ab6c6e09895
+  metadata.gz: a0d44cafa4c07aed6fb4248234f60f70e6a0f9124b7ad6184f515feb22ef972a
+  data.tar.gz: 3a1ae5714c23a52c63c2cff8616a9f739e3bb68a44abd8e76e35b864e792c2c7
 SHA512:
-  metadata.gz: ebad79ae91d8d0731d259574f515375ed2306cb6b89458e969141f5c02ff4c88f67f926e7eec2ffc29659c5486d49f61bcbe51fcec5f4157aa277c9ad46b2c7c
-  data.tar.gz: 3b833b67284142468e86361797fec62761db59e9917db398179593bd2df6e4de4bb392a8ce6b999fe91f7bde496aeabba1165b3341e69ba989ac733e2f27de4c
+  metadata.gz: 750643b2ff0d4705f69c66f049be32d070e50189173e2b44dd3975fde11ed8052c182b24729831e5e4553bc5f23c8d88f76ee5a0b70a85f5f1842c855bbd0d7e
+  data.tar.gz: 434a4e77901c9af6783de0db879daaaf1bb4918835f1a147a0cc5aa0ff7c4c35ba12e306e23db3a65a9b875b97c8503b6e49a2c93b2e2c4014c9c1d01845afd2

data/README.md

@@ -43,6 +43,61 @@ ModularizationStatistics.report_to_datadog!(
 )
 ```
 
+It's recommended to run this in CI on the main/development branch so each new commit has metrics emitted for it.
+
+# Tracking Privacy and Dependency Violations Reliably
+With [`packwerk`](https://github.com/Shopify/packwerk), privacy and dependency violations do not show up until a package has set `enforce_privacy` and `enforce_dependency` (respectively) to `true`. As such, when you're first starting off, you'll see no violations, and then periodic large increases as teams start using these protections. If you're interested in looking at privacy and dependency violations over time as if all packages were enforcing dependencies and privacy the whole time, we recommend setting these values to be true before running modularization statistics in your CI.
+
+```ruby
+require 'modularization_statistics'
+
+namespace(:modularization) do
+  desc(
+    'Publish modularization stats to datadog. ' \
+      'Example: bin/rails "modularization:upload_statistics"'
+  )
+  task(:upload_statistics, [:verbose] => :environment) do |_, args|
+    ignored_paths = Pathname.glob('spec/fixtures/**/**')
+    source_code_pathnames = Pathname.glob('{app,components,lib,packs,spec}/**/**').select(&:file?) - ignored_paths
+
+    # To correctly track violations, we rewrite all `package.yml` files with
+    # `enforce_dependencies` and `enforce_privacy` set to true, then update deprecations.
+    old_packages = ParsePackwerk.all
+    old_packages.each do |package|
+      new_package = ParsePackwerk::Package.new(
+        dependencies: package.dependencies,
+        enforce_dependencies: true,
+        enforce_privacy: true,
+        metadata: package.metadata,
+        name: package.name
+      )
+      ParsePackwerk.write_package_yml!(new_package)
+    end
+
+    Packwerk::Cli.new.execute_command(['update-deprecations'])
+
+    # Now we reset it back so that the protection values are the same as the native packwerk configuration
+    old_packages.each do |package|
+      new_package = ParsePackwerk::Package.new(
+        dependencies: package.dependencies,
+        enforce_dependencies: package.enforce_dependencies,
+        enforce_privacy: package.enforce_privacy,
+        metadata: package.metadata,
+        name: package.name
+      )
+      ParsePackwerk.write_package_yml!(new_package)
+    end
+
+    ModularizationStatistics.report_to_datadog!(
+      datadog_client: Dogapi::Client.new(ENV.fetch('DATADOG_API_KEY')),
+      app_name: Rails.application.class.module_parent_name,
+      source_code_pathnames: source_code_pathnames,
+      verbose: args[:verbose] == 'true' || false
+    )
+  end
+end
+```
+
 # Using Other Observability Tools
 
 Right now this tool sends metrics to DataDog early. However, if you want to use this with other tools, you can call `ModularizationStatistics.get_metrics(...)` to get generic metrics that you can then send to whatever observability provider you use.

data/lib/modularization_statistics/private/source_code_file.rb

@@ -7,7 +7,7 @@ module ModularizationStatistics
 
       const :is_componentized_file, T::Boolean
       const :is_packaged_file, T::Boolean
-      const :team_owner, T.nilable(Teams::Team)
+      const :team_owner, T.nilable(CodeTeams::Team)
       const :pathname, Pathname
 
       sig { returns(T::Boolean) }

data/lib/modularization_statistics.rb

@@ -4,7 +4,7 @@ require 'sorbet-runtime'
 require 'json'
 require 'yaml'
 require 'benchmark'
-require 'teams'
+require 'code_teams'
 require 'code_ownership'
 require 'pathname'
 require 'modularization_statistics/private/source_code_file'

data/sorbet/rbi/gems/{code_ownership@1.23.0.rbi → code_ownership@1.28.0.rbi}

@@ -12,18 +12,18 @@ module CodeOwnership
   sig do
     params(
       backtrace: T.nilable(T::Array[::String]),
-      excluded_teams: T::Array[::Teams::Team]
-    ).returns(T.nilable(::Teams::Team))
+      excluded_teams: T::Array[::CodeTeams::Team]
+    ).returns(T.nilable(::CodeTeams::Team))
   end
   def for_backtrace(backtrace, excluded_teams: T.unsafe(nil)); end
 
-  sig { params(klass: T.nilable(T.any(::Class, ::Module))).returns(T.nilable(::Teams::Team)) }
+  sig { params(klass: T.nilable(T.any(::Class, ::Module))).returns(T.nilable(::CodeTeams::Team)) }
   def for_class(klass); end
 
-  sig { params(file: ::String).returns(T.nilable(::Teams::Team)) }
+  sig { params(file: ::String).returns(T.nilable(::CodeTeams::Team)) }
   def for_file(file); end
 
-  sig { params(package: ::ParsePackwerk::Package).returns(T.nilable(::Teams::Team)) }
+  sig { params(package: ::ParsePackwerk::Package).returns(T.nilable(::CodeTeams::Team)) }
   def for_package(package); end
 
   sig { params(files: T::Array[::String], autocorrect: T::Boolean, stage_changes: T::Boolean).void }
@@ -40,6 +40,7 @@ end
 
 class CodeOwnership::Cli
   class << self
+    def for_file(argv); end
     def run!(argv); end
 
     private
@@ -64,7 +65,7 @@ module CodeOwnership::Private
     sig { params(files: T::Array[::String]).returns(T::Hash[::String, T::Array[::String]]) }
     def files_by_mapper(files); end
 
-    sig { params(team_name: ::String, location_of_reference: ::String).returns(::Teams::Team) }
+    sig { params(team_name: ::String, location_of_reference: ::String).returns(::CodeTeams::Team) }
     def find_team!(team_name, location_of_reference); end
 
     sig { returns(T::Array[::CodeOwnership::Private::OwnershipMappers::Interface]) }
@@ -107,19 +108,19 @@ class CodeOwnership::Private::OwnershipMappers::FileAnnotations
   sig { override.void }
   def bust_caches!; end
 
-  sig { override.returns(T::Hash[::String, T.nilable(::Teams::Team)]) }
+  sig { override.returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
   def codeowners_lines_to_owners; end
 
   sig { override.returns(::String) }
   def description; end
 
-  sig { params(filename: ::String).returns(T.nilable(::Teams::Team)) }
+  sig { params(filename: ::String).returns(T.nilable(::CodeTeams::Team)) }
   def file_annotation_based_owner(filename); end
 
-  sig { override.params(file: ::String).returns(T.nilable(::Teams::Team)) }
+  sig { override.params(file: ::String).returns(T.nilable(::CodeTeams::Team)) }
   def map_file_to_owner(file); end
 
-  sig { override.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::Teams::Team)]) }
+  sig { override.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
   def map_files_to_owners(files); end
 
   sig { params(filename: ::String).void }
@@ -134,16 +135,16 @@ module CodeOwnership::Private::OwnershipMappers::Interface
   sig { abstract.void }
   def bust_caches!; end
 
-  sig { abstract.returns(T::Hash[::String, T.nilable(::Teams::Team)]) }
+  sig { abstract.returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
   def codeowners_lines_to_owners; end
 
   sig { abstract.returns(::String) }
   def description; end
 
-  sig { abstract.params(file: ::String).returns(T.nilable(::Teams::Team)) }
+  sig { abstract.params(file: ::String).returns(T.nilable(::CodeTeams::Team)) }
   def map_file_to_owner(file); end
 
-  sig { abstract.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::Teams::Team)]) }
+  sig { abstract.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
   def map_files_to_owners(files); end
 end
 
@@ -153,19 +154,19 @@ class CodeOwnership::Private::OwnershipMappers::JsPackageOwnership
   sig { override.void }
   def bust_caches!; end
 
-  sig { override.returns(T::Hash[::String, T.nilable(::Teams::Team)]) }
+  sig { override.returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
   def codeowners_lines_to_owners; end
 
   sig { override.returns(::String) }
   def description; end
 
-  sig { override.params(file: ::String).returns(T.nilable(::Teams::Team)) }
+  sig { override.params(file: ::String).returns(T.nilable(::CodeTeams::Team)) }
   def map_file_to_owner(file); end
 
-  sig { override.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::Teams::Team)]) }
+  sig { override.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
   def map_files_to_owners(files); end
 
-  sig { params(package: ::CodeOwnership::Private::ParseJsPackages::Package).returns(T.nilable(::Teams::Team)) }
+  sig { params(package: ::CodeOwnership::Private::ParseJsPackages::Package).returns(T.nilable(::CodeTeams::Team)) }
   def owner_for_package(package); end
 
   private
@@ -180,19 +181,19 @@ class CodeOwnership::Private::OwnershipMappers::PackageOwnership
   sig { override.void }
   def bust_caches!; end
 
-  sig { override.returns(T::Hash[::String, T.nilable(::Teams::Team)]) }
+  sig { override.returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
   def codeowners_lines_to_owners; end
 
   sig { override.returns(::String) }
   def description; end
 
-  sig { override.params(file: ::String).returns(T.nilable(::Teams::Team)) }
+  sig { override.params(file: ::String).returns(T.nilable(::CodeTeams::Team)) }
   def map_file_to_owner(file); end
 
-  sig { override.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::Teams::Team)]) }
+  sig { override.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
   def map_files_to_owners(files); end
 
-  sig { params(package: ::ParsePackwerk::Package).returns(T.nilable(::Teams::Team)) }
+  sig { params(package: ::ParsePackwerk::Package).returns(T.nilable(::CodeTeams::Team)) }
   def owner_for_package(package); end
 
   private
@@ -207,16 +208,16 @@ class CodeOwnership::Private::OwnershipMappers::TeamGlobs
   sig { override.void }
   def bust_caches!; end
 
-  sig { override.returns(T::Hash[::String, T.nilable(::Teams::Team)]) }
+  sig { override.returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
   def codeowners_lines_to_owners; end
 
   sig { override.returns(::String) }
   def description; end
 
-  sig { override.params(file: ::String).returns(T.nilable(::Teams::Team)) }
+  sig { override.params(file: ::String).returns(T.nilable(::CodeTeams::Team)) }
   def map_file_to_owner(file); end
 
-  sig { override.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::Teams::Team)]) }
+  sig { override.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
   def map_files_to_owners(files); end
 end
 
@@ -248,7 +249,7 @@ end
 CodeOwnership::Private::ParseJsPackages::ROOT_PACKAGE_NAME = T.let(T.unsafe(nil), String)
 module CodeOwnership::Private::TeamPlugins; end
 
-class CodeOwnership::Private::TeamPlugins::Github < ::Teams::Plugin
+class CodeOwnership::Private::TeamPlugins::Github < ::CodeTeams::Plugin
   sig { returns(::CodeOwnership::Private::TeamPlugins::Github::GithubStruct) }
   def github; end
 end
@@ -267,7 +268,7 @@ class CodeOwnership::Private::TeamPlugins::Github::GithubStruct < ::Struct
   end
 end
 
-class CodeOwnership::Private::TeamPlugins::Ownership < ::Teams::Plugin
+class CodeOwnership::Private::TeamPlugins::Ownership < ::CodeTeams::Plugin
   sig { returns(T::Array[::String]) }
   def owned_globs; end
 end

data/sorbet/rbi/gems/{bigrails-teams@0.1.0.rbi → code_teams@1.0.0.rbi}

@@ -1,78 +1,78 @@
 # typed: true
 
 # DO NOT EDIT MANUALLY
-# This is an autogenerated file for types exported from the `bigrails-teams` gem.
-# Please instead update this file by running `bin/tapioca gem bigrails-teams`.
+# This is an autogenerated file for types exported from the `code_teams` gem.
+# Please instead update this file by running `bin/tapioca gem code_teams`.
 
-module Teams
+module CodeTeams
   class << self
-    sig { returns(T::Array[::Teams::Team]) }
+    sig { returns(T::Array[::CodeTeams::Team]) }
     def all; end
 
     sig { void }
     def bust_caches!; end
 
-    sig { params(name: ::String).returns(T.nilable(::Teams::Team)) }
+    sig { params(name: ::String).returns(T.nilable(::CodeTeams::Team)) }
     def find(name); end
 
-    sig { params(dir: ::String).returns(T::Array[::Teams::Team]) }
+    sig { params(dir: ::String).returns(T::Array[::CodeTeams::Team]) }
     def for_directory(dir); end
 
     sig { params(string: ::String).returns(::String) }
     def tag_value_for(string); end
 
-    sig { params(teams: T::Array[::Teams::Team]).returns(T::Array[::String]) }
+    sig { params(teams: T::Array[::CodeTeams::Team]).returns(T::Array[::String]) }
     def validation_errors(teams); end
   end
 end
 
-class Teams::IncorrectPublicApiUsageError < ::StandardError; end
+class CodeTeams::IncorrectPublicApiUsageError < ::StandardError; end
 
-class Teams::Plugin
+class CodeTeams::Plugin
   abstract!
 
-  sig { params(team: ::Teams::Team).void }
+  sig { params(team: ::CodeTeams::Team).void }
   def initialize(team); end
 
   class << self
-    sig { returns(T::Array[T.class_of(Teams::Plugin)]) }
+    sig { returns(T::Array[T.class_of(CodeTeams::Plugin)]) }
     def all_plugins; end
 
-    sig { params(team: ::Teams::Team).returns(T.attached_class) }
+    sig { params(team: ::CodeTeams::Team).returns(T.attached_class) }
     def for(team); end
 
     sig { params(base: T.untyped).void }
     def inherited(base); end
 
-    sig { params(team: ::Teams::Team, key: ::String).returns(::String) }
+    sig { params(team: ::CodeTeams::Team, key: ::String).returns(::String) }
     def missing_key_error_message(team, key); end
 
-    sig { params(teams: T::Array[::Teams::Team]).returns(T::Array[::String]) }
+    sig { params(teams: T::Array[::CodeTeams::Team]).returns(T::Array[::String]) }
     def validation_errors(teams); end
 
     private
 
-    sig { params(team: ::Teams::Team).returns(T.attached_class) }
+    sig { params(team: ::CodeTeams::Team).returns(T.attached_class) }
     def register_team(team); end
 
-    sig { returns(T::Hash[T.nilable(::String), T::Hash[::Class, ::Teams::Plugin]]) }
+    sig { returns(T::Hash[T.nilable(::String), T::Hash[::Class, ::CodeTeams::Plugin]]) }
     def registry; end
   end
 end
 
-module Teams::Plugins; end
+module CodeTeams::Plugins; end
 
-class Teams::Plugins::Identity < ::Teams::Plugin
-  sig { returns(::Teams::Plugins::Identity::IdentityStruct) }
+class CodeTeams::Plugins::Identity < ::CodeTeams::Plugin
+  sig { returns(::CodeTeams::Plugins::Identity::IdentityStruct) }
   def identity; end
 
   class << self
-    sig { override.params(teams: T::Array[::Teams::Team]).returns(T::Array[::String]) }
+    sig { override.params(teams: T::Array[::CodeTeams::Team]).returns(T::Array[::String]) }
     def validation_errors(teams); end
   end
 end
 
-class Teams::Plugins::Identity::IdentityStruct < ::Struct
+class CodeTeams::Plugins::Identity::IdentityStruct < ::Struct
   def name; end
   def name=(_); end
 
@@ -84,7 +84,7 @@ class Teams::Plugins::Identity::IdentityStruct < ::Struct
   end
 end
 
-class Teams::Team
+class CodeTeams::Team
   sig { params(config_yml: T.nilable(::String), raw_hash: T::Hash[T.untyped, T.untyped]).void }
   def initialize(config_yml:, raw_hash:); end
 
@@ -109,12 +109,12 @@ class Teams::Team
   def to_tag; end
 
   class << self
-    sig { params(raw_hash: T::Hash[T.untyped, T.untyped]).returns(::Teams::Team) }
+    sig { params(raw_hash: T::Hash[T.untyped, T.untyped]).returns(::CodeTeams::Team) }
     def from_hash(raw_hash); end
 
-    sig { params(config_yml: ::String).returns(::Teams::Team) }
+    sig { params(config_yml: ::String).returns(::CodeTeams::Team) }
     def from_yml(config_yml); end
   end
 end
 
-Teams::UNKNOWN_TEAM_STRING = T.let(T.unsafe(nil), String)
+CodeTeams::UNKNOWN_TEAM_STRING = T.let(T.unsafe(nil), String)

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: modularization_statistics
 version: !ruby/object:Gem::Version
-  version: 1.33.0
+  version: 1.34.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2022-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bigrails-teams
+  name: code_teams
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -181,21 +181,21 @@ files:
 - lib/modularization_statistics/tag.rb
 - lib/modularization_statistics/tags.rb
 - sorbet/config
-- sorbet/rbi/gems/bigrails-teams@0.1.0.rbi
-- sorbet/rbi/gems/code_ownership@1.23.0.rbi
+- sorbet/rbi/gems/code_ownership@1.28.0.rbi
+- sorbet/rbi/gems/code_teams@1.0.0.rbi
 - sorbet/rbi/gems/dogapi@1.45.0.rbi
 - sorbet/rbi/gems/manual.rbi
 - sorbet/rbi/gems/package_protections@0.64.0.rbi
 - sorbet/rbi/gems/parse_packwerk@0.10.0.rbi
 - sorbet/rbi/gems/rspec@3.10.0.rbi
 - sorbet/rbi/todo.rbi
-homepage: https://github.com/bigrails/modularization_statistics
+homepage: https://github.com/rubyatscale/modularization_statistics
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/bigrails/modularization_statistics
-  source_code_uri: https://github.com/bigrails/modularization_statistics
-  changelog_uri: https://github.com/bigrails/modularization_statistics/releases
+  homepage_uri: https://github.com/rubyatscale/modularization_statistics
+  source_code_uri: https://github.com/rubyatscale/modularization_statistics
+  changelog_uri: https://github.com/rubyatscale/modularization_statistics/releases
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []