package_protections 2.2.1 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6797406abd58b1f207223519e6351b0c26ee54c7c79d7400f74400b71a16e556
-  data.tar.gz: e7a583cebe8634d730f665c31aaee955d6d1d2b83e5322a07c0d1c1f917abda1
+  metadata.gz: 918d945d5ceb1f2df5f544a50c74ebc8977d36819c4d5204866e90e8518115fc
+  data.tar.gz: e80077db49323a725e67d41c861e78da371f7e5de986c9240e9de1a4308f6686
 SHA512:
-  metadata.gz: f40cb6189fc8d3b4364fce64e2933f929af1ad35a2a956cc9cea4ff46042cf2719379e0e8f8e6e82e1df68dcf1cf07a3326733c68e55bfe50a2d1914a9a3b34b
-  data.tar.gz: ff10108a8577060d176820a74a939da8897bc566117a9f68e5c6f7c832cbd7047448a216913972bb7b47801c524dddd088c10a6f55a750b60ffd2b915a6d0764
+  metadata.gz: 81569a675bd20e6993b018d71f29cffb45d90621b9e6f036a746d89c8674b1d43e9a6d7bed6df7e4689ce3e008dc0a89b8506da9f959daa0611cf43d9adb2dc2
+  data.tar.gz: 3c290042abe91b8bbd285dae9091db68729fb99dd8f0b861c99cbac131f9705caf581d6c117e582e34b73ec38ae3b9f5ac70b885cab41974cd89f6295f03662c

data/lib/package_protections/per_file_violation.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # typed: strict
+
 module PackageProtections
   # Perhaps this should be in ParsePackwerk. For now, this is here to help us break down violations per file.
   # This is analogous to `Packwerk::ReferenceOffense`

data/lib/package_protections/private/metadata_modifiers.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # typed: strict
+
 module PackageProtections
   module Private
     class MetadataModifiers

data/lib/package_protections/private/output.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # typed: strict
+
 module PackageProtections
   module Private
     class Output

data/lib/package_protections/private.rb

@@ -128,7 +128,7 @@ module PackageProtections
       @private_cop_config ||= begin
         protected_packages = all_protected_packages
         protection = T.cast(PackageProtections.with_identifier(identifier), PackageProtections::RubocopProtectionInterface)
-        protected_packages.map { |p| [p.name, protection.custom_cop_config(p)] }.to_h
+        protected_packages.to_h { |p| [p.name, protection.custom_cop_config(p)] }
       end
     end
 

data/lib/package_protections/protected_package.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # typed: strict
+
 module PackageProtections
   class ProtectedPackage < T::Struct
     extend T::Sig

data/lib/package_protections/protection_interface.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # typed: strict
+
 module PackageProtections
   module ProtectionInterface
     extend T::Sig

data/lib/package_protections/rspec/application_fixture_helper.rb

@@ -17,7 +17,6 @@ module ApplicationFixtureHelper
     enforce_dependencies: true,
     enforce_privacy: true,
     protections: {},
-    global_namespaces: [],
     visible_to: []
   )
     defaults = {
@@ -33,10 +32,6 @@ module ApplicationFixtureHelper
       metadata.merge!('visible_to' => visible_to)
     end
 
-    if global_namespaces.any?
-      metadata.merge!('global_namespaces' => global_namespaces)
-    end
-
     package = ParsePackwerk::Package.new(
       name: pack_name,
       dependencies: dependencies,

data/lib/package_protections/rubocop_protection_interface.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # typed: strict
+
 module PackageProtections
   module RubocopProtectionInterface
     class CopConfig < T::Struct
@@ -9,6 +10,7 @@ module PackageProtections
       const :enabled, T::Boolean, default: true
       const :include_paths, T::Array[String], default: []
       const :exclude_paths, T::Array[String], default: []
+      const :metadata, T.untyped, default: {}
 
       sig { returns(String) }
       def to_rubocop_yml_compatible_format
@@ -22,6 +24,10 @@ module PackageProtections
           cop_config['Exclude'] = exclude_paths
         end
 
+        if metadata.any?
+          cop_config.merge!(metadata)
+        end
+
         { name => cop_config }.to_yaml.gsub("---\n", '')
       end
     end

data/lib/package_protections/violation_behavior.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # typed: strict
+
 module PackageProtections
   class IncorrectPublicApiUsageError < StandardError; end
 

data/lib/package_protections.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 # typed: strict
+
 require 'sorbet-runtime'
 require 'open3'
 require 'set'
 require 'parse_packwerk'
 require 'rubocop'
 require 'rubocop-sorbet'
+require 'rubocop-modularization'
 
 #
 # Welcome to PackageProtections!
@@ -66,7 +68,7 @@ module PackageProtections
   sig { params(identifier: Identifier).returns(ProtectionInterface) }
   def self.with_identifier(identifier)
     @map ||= T.let(@map, T.nilable(T::Hash[Identifier, ProtectionInterface]))
-    @map ||= all.map { |protection| [protection.identifier, protection] }.to_h
+    @map ||= all.to_h { |protection| [protection.identifier, protection] }
     @map.fetch(identifier)
   end
 

data/lib/rubocop/cop/package_protections/namespaced_under_package_name.rb

@@ -2,81 +2,14 @@
 
 # For String#camelize
 require 'active_support/core_ext/string/inflections'
-require 'rubocop/cop/package_protections/namespaced_under_package_name/desired_zeitwerk_api'
 
 module RuboCop
   module Cop
     module PackageProtections
-      #
-      # TODO:
-      # This class is in serious need of being split up into helpful abstractions.
-      # A really helpful abstraction would be one that takes a file path and can spit out information about
-      # namespacing, such as the exposed namespace, the file path for a different namespace, and more.
-      #
-      class NamespacedUnderPackageName < Base
+      class NamespacedUnderPackageName < Modularization::NamespacedUnderPackageName
         extend T::Sig
-
-        include RangeHelp
         include ::PackageProtections::RubocopProtectionInterface
 
-        sig { void }
-        def on_new_investigation
-          absolute_filepath = Pathname.new(processed_source.file_path)
-          relative_filepath = absolute_filepath.relative_path_from(Pathname.pwd)
-          relative_filename = relative_filepath.to_s
-
-          # This cop only works for files ruby files in `app`
-          return if !relative_filename.include?('app/') || relative_filepath.extname != '.rb'
-
-          relative_filename = relative_filepath.to_s
-          package_for_path = ParsePackwerk.package_from_path(relative_filename)
-          return if package_for_path.nil?
-
-          namespace_context = self.class.desired_zeitwerk_api.for_file(relative_filename, package_for_path)
-          return if namespace_context.nil?
-
-          allowed_global_namespaces = Set.new([
-                                                namespace_context.expected_namespace,
-                                                *::PackageProtections.config.globally_permitted_namespaces
-                                              ])
-
-          package_name = package_for_path.name
-          actual_namespace = namespace_context.current_namespace
-
-          if allowed_global_namespaces.include?(actual_namespace)
-            # No problem!
-          else
-            package_enforces_namespaces = !::PackageProtections::ProtectedPackage.from(package_for_path).violation_behavior_for(NamespacedUnderPackageName::IDENTIFIER).fail_never?
-            expected_namespace = namespace_context.expected_namespace
-            relative_desired_path = namespace_context.expected_filepath
-            pack_owning_this_namespace = self.class.namespaces_to_packs[actual_namespace]
-
-            if package_enforces_namespaces
-              add_offense(
-                source_range(processed_source.buffer, 1, 0),
-                message: format(
-                  '`%<package_name>s` prevents modules/classes that are not submodules of the package namespace. Should be namespaced under `%<expected_namespace>s` with path `%<expected_path>s`. See https://go/packwerk_cheatsheet_namespaces for more info.',
-                  package_name: package_name,
-                  expected_namespace: expected_namespace,
-                  expected_path: relative_desired_path
-                )
-              )
-            elsif pack_owning_this_namespace
-              add_offense(
-                source_range(processed_source.buffer, 1, 0),
-                message: format(
-                  '`%<pack_owning_this_namespace>s` prevents other packs from sitting in the `%<actual_namespace>s` namespace. This should be namespaced under `%<expected_namespace>s` with path `%<expected_path>s`. See https://go/packwerk_cheatsheet_namespaces for more info.',
-                  package_name: package_name,
-                  pack_owning_this_namespace: pack_owning_this_namespace,
-                  expected_namespace: expected_namespace,
-                  actual_namespace: actual_namespace,
-                  expected_path: relative_desired_path
-                )
-              )
-            end
-          end
-        end
-
         # We override `cop_configs` for this protection.
         # The default behavior disables cops when a package has turned off a protection.
         # However: namespace violations can occur even when one package has TURNED OFF their namespace protection
@@ -87,22 +20,34 @@ module RuboCop
           .returns(T::Array[::PackageProtections::RubocopProtectionInterface::CopConfig])
         end
         def cop_configs(packages)
-          include_paths = T.let([], T::Array[String])
+          include_packs = T.let([], T::Array[String])
           packages.each do |p|
-            included_globs_for_pack.each do |glob|
-              include_paths << p.original_package.directory.join(glob).to_s
+            enabled_for_pack = !p.violation_behavior_for(NamespacedUnderPackageName::IDENTIFIER).fail_never?
+            if enabled_for_pack
+              include_packs << p.name
             end
           end
 
           [
             ::PackageProtections::RubocopProtectionInterface::CopConfig.new(
               name: cop_name,
-              enabled: include_paths.any?,
-              include_paths: include_paths
+              enabled: include_packs.any?,
+              metadata: {
+                'IncludePacks' => include_packs,
+                'GloballyPermittedNamespaces' => ::PackageProtections.config.globally_permitted_namespaces
+              }
             )
           ]
         end
 
+        sig { override.returns(T::Array[String]) }
+        def included_globs_for_pack
+          [
+            'app/**/*',
+            'lib/**/*'
+          ]
+        end
+
         IDENTIFIER = T.let('prevent_this_package_from_creating_other_namespaces'.freeze, String)
 
         sig { override.returns(String) }
@@ -132,14 +77,6 @@ module RuboCop
           end
         end
 
-        sig { override.returns(T::Array[String]) }
-        def included_globs_for_pack
-          [
-            'app/**/*',
-            'lib/**/*'
-          ]
-        end
-
         sig do
           override.params(file: String).returns(String)
         end
@@ -168,31 +105,6 @@ module RuboCop
             See https://go/packwerk_cheatsheet_namespaces for more info.
           MESSAGE
         end
-
-        sig { returns(DesiredZeitwerkApi) }
-        def self.desired_zeitwerk_api
-          # This is cached at the class level so we will cache more expensive operations
-          # across rubocop requests.
-          @desired_zeitwerk_api ||= T.let(nil, T.nilable(DesiredZeitwerkApi))
-          @desired_zeitwerk_api ||= DesiredZeitwerkApi.new
-        end
-
-        sig { returns(T::Hash[String, String]) }
-        def self.namespaces_to_packs
-          @namespaces_to_packs = T.let(nil, T.nilable(T::Hash[String, String]))
-          @namespaces_to_packs ||= begin
-            all_packs_enforcing_namespaces = ParsePackwerk.all.reject do |p|
-              ::PackageProtections::ProtectedPackage.from(p).violation_behavior_for(NamespacedUnderPackageName::IDENTIFIER).fail_never?
-            end
-
-            namespaces_to_packs = {}
-            all_packs_enforcing_namespaces.each do |package|
-              namespaces_to_packs[desired_zeitwerk_api.get_pack_based_namespace(package)] = package.name
-            end
-
-            namespaces_to_packs
-          end
-        end
       end
     end
   end

data/lib/rubocop/cop/package_protections/typed_public_api.rb

@@ -15,7 +15,7 @@ module RuboCop
       #
       # We can apply this same pattern if we want to use other cops in the context of package protections and prevent clashing.
       #
-      class TypedPublicApi < Sorbet::StrictSigil
+      class TypedPublicApi < Modularization::TypedPublicApi
         extend T::Sig
 
         include ::PackageProtections::ProtectionInterface

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: package_protections
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.1
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2022-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-modularization
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +206,6 @@ files:
 - lib/package_protections/rubocop_protection_interface.rb
 - lib/package_protections/violation_behavior.rb
 - lib/rubocop/cop/package_protections/namespaced_under_package_name.rb
-- lib/rubocop/cop/package_protections/namespaced_under_package_name/desired_zeitwerk_api.rb
 - lib/rubocop/cop/package_protections/typed_public_api.rb
 homepage: https://github.com/rubyatscale/package_protections
 licenses:
@@ -210,7 +223,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/rubocop/cop/package_protections/namespaced_under_package_name/desired_zeitwerk_api.rb

@@ -1,110 +0,0 @@
-# typed: strict
-
-module RuboCop
-  module Cop
-    module PackageProtections
-      class NamespacedUnderPackageName < Base
-        #
-        # This is a private class that represents API that we would prefer to be available somehow in Zeitwerk.
-        #
-        class DesiredZeitwerkApi
-          extend T::Sig
-
-          class NamespaceContext < T::Struct
-            const :current_namespace, String
-            const :expected_namespace, String
-            const :expected_filepath, String
-          end
-
-          #
-          # For now, this API includes `package_for_path`
-          # If this were truly zeitwerk API, it wouldn't include any mention of packs and it would likely not need the package at all
-          # Since it could get the actual namespace without knowing anything about packs.
-          # However, we would need to pass to it the desired namespace based on the pack name for it to be able to suggest
-          # a desired filepath.
-          # Likely this means that our own cop should determine the desired namespace and pass that in
-          # and this can determine actual namespace and how to get to expected.
-          #
-          sig { params(relative_filename: String, package_for_path: ParsePackwerk::Package).returns(T.nilable(NamespaceContext)) }
-          def for_file(relative_filename, package_for_path)
-            package_name = package_for_path.name
-
-            # Zeitwerk establishes a standard convention by which namespaces are defined.
-            # The package protections namespace checker is coupled to a specific assumption about how auto-loading works.
-            #
-            # Namely, we expect the following autoload paths: `packs/**/app/**/`
-            # Examples:
-            # 1) `packs/package_1/app/public/package_1/my_constant.rb` produces constant `Package1::MyConstant`
-            # 2) `packs/package_1/app/services/package_1/my_service.rb` produces constant `Package1::MyService`
-            # 3) `packs/package_1/app/services/package_1.rb` produces constant `Package1`
-            # 4) `packs/package_1/app/public/package_1.rb` produces constant `Package1`
-            #
-            # Described another way, we expect any part of the directory labeled NAMESPACE to establish a portion of the fully qualified runtime constant:
-            # `packs/**/app/**/NAMESPACE1/NAMESPACE2/[etc]`
-            #
-            # Therefore, for our implementation, we substitute out the non-namespace producing portions of the filename to count the number of namespaces.
-            # Note this will *not work* properly in applications that have different assumptions about autoloading.
-
-            path_without_package_base = relative_filename.gsub(%r{#{package_name}/app/}, '')
-            if path_without_package_base.include?('concerns')
-              autoload_folder_name = path_without_package_base.split('/').first(2).join('/')
-            else
-              autoload_folder_name = path_without_package_base.split('/').first
-            end
-
-            remaining_file_path = path_without_package_base.gsub(%r{\A#{autoload_folder_name}/}, '')
-            actual_namespace = get_actual_namespace(remaining_file_path, package_name)
-
-            if relative_filename.include?('app/')
-              app_or_lib = 'app'
-            elsif relative_filename.include?('lib/')
-              app_or_lib = 'lib'
-            end
-
-            absolute_desired_path = root_pathname.join(
-              package_name,
-              T.must(app_or_lib),
-              T.must(autoload_folder_name),
-              get_package_last_name(package_for_path),
-              remaining_file_path
-            )
-
-            relative_desired_path = absolute_desired_path.relative_path_from(root_pathname)
-
-            NamespaceContext.new(
-              current_namespace: actual_namespace,
-              expected_namespace: get_pack_based_namespace(package_for_path),
-              expected_filepath: relative_desired_path.to_s
-            )
-          end
-
-          sig { params(pack: ParsePackwerk::Package).returns(String) }
-          def get_pack_based_namespace(pack)
-            get_package_last_name(pack).camelize
-          end
-
-          private
-
-          sig { returns(Pathname) }
-          def root_pathname
-            Pathname.pwd
-          end
-
-          sig { params(pack: ParsePackwerk::Package).returns(String) }
-          def get_package_last_name(pack)
-            T.must(pack.name.split('/').last)
-          end
-
-          sig { params(remaining_file_path: String, package_name: String).returns(String) }
-          def get_actual_namespace(remaining_file_path, package_name)
-            # If the remaining file path is a ruby file (not a directory), then it establishes a global namespace
-            # Otherwise, per Zeitwerk's conventions as listed above, its a directory that establishes another global namespace
-            T.must(remaining_file_path.split('/').first).gsub('.rb', '').camelize
-          end
-        end
-
-        private_constant :DesiredZeitwerkApi
-      end
-    end
-  end
-end