package_protections 2.3.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0b3c74ccdd20872e0cf789b6cf062e918ff25d6aa2c70515939f3cd57c4f17
-  data.tar.gz: '08c71c84b5a76786ff42b5c9e065afdea30a3ceb38775d0ca0b20c9e10ca568b'
+  metadata.gz: 15fbea313e27bfc23cc01afc2bbae8e5851a3008b376952c05868cf50dfe3603
+  data.tar.gz: 0dfd11a1d3985011213dac38f6e60e46f8891ead717fd273b11ece18056929a9
 SHA512:
-  metadata.gz: ccea3e0cf794040c52d283816e3905571973917e4d777b655dabbc15f871bb76672097f5c00897972e239a5146b14c6aa10b5ecdec1c6e6998be93bf2d0654ce
-  data.tar.gz: 7c33132a1fb7d27aaaa154254315776498dbe58654ebe6f3cfbbd2d3e8efe4b2067fa3dcde1cf6cb8ef06e1d5be79b00915bd7bc2343b8bd7544e7328607213c
+  metadata.gz: 89215ad6809c4dc4de07dc07f87cbbd7f163feeed780c23ca43ea93e4fa0e47b9a0fcda22a183b6df8eb72c7624c0435998eb9b378b1bc425bf9e5b6432c724b
+  data.tar.gz: da424f1faa7130c10d8dd07cdcc3d94a6c9c9f69ed1ca892703ca604de112fcb4878308e244fea894b5039cfd25f0f8c79447cebd06197401a80e6420fbd770c

data/lib/package_protections/private/configuration.rb

@@ -5,32 +5,26 @@ module PackageProtections
     class Configuration
       extend T::Sig
 
-      sig { params(protections: T::Array[ProtectionInterface]).void }
-      attr_writer :protections
+      sig { returns(T::Array[ProtectionInterface]) }
+      attr_accessor :protections
+
+      sig { returns(T::Array[String]) }
+      attr_accessor :globally_permitted_namespaces
 
-      sig { params(globally_permitted_namespaces: T::Array[String]).void }
-      attr_writer :globally_permitted_namespaces
+      sig { returns(T::Array[String]) }
+      attr_accessor :acceptable_parent_classes
 
       sig { void }
       def initialize
         @protections = T.let(default_protections, T::Array[ProtectionInterface])
         @globally_permitted_namespaces = T.let([], T::Array[String])
+        @acceptable_parent_classes = T.let([], T::Array[String])
       end
-
-      sig { returns(T::Array[ProtectionInterface]) }
-      def protections
-        @protections
-      end
-
-      sig { returns(T::Array[String]) }
-      def globally_permitted_namespaces
-        @globally_permitted_namespaces
-      end
-
       sig { void }
       def bust_cache!
         @protections = default_protections
         @globally_permitted_namespaces = []
+        @acceptable_parent_classes = []
       end
 
       sig { returns(T::Array[ProtectionInterface]) }
@@ -40,7 +34,9 @@ module PackageProtections
           Private::IncomingPrivacyProtection.new,
           RuboCop::Cop::PackageProtections::TypedPublicApi.new,
           RuboCop::Cop::PackageProtections::NamespacedUnderPackageName.new,
-          Private::VisibilityProtection.new
+          Private::VisibilityProtection.new,
+          RuboCop::Cop::PackageProtections::OnlyClassMethods.new,
+          RuboCop::Cop::PackageProtections::RequireDocumentedPublicApis.new
         ]
       end
     end

data/lib/package_protections/rspec/application_fixture_helper.rb

@@ -24,7 +24,8 @@ module ApplicationFixtureHelper
       'prevent_other_packages_from_using_this_packages_internals' => 'fail_on_new',
       'prevent_this_package_from_exposing_an_untyped_api' => 'fail_on_new',
       'prevent_this_package_from_creating_other_namespaces' => 'fail_on_new',
-      'prevent_other_packages_from_using_this_package_without_explicit_visibility' => 'fail_never'
+      'prevent_other_packages_from_using_this_package_without_explicit_visibility' => 'fail_never',
+      'prevent_this_package_from_exposing_instance_method_public_apis' => 'fail_never'
     }
     protections_with_defaults = defaults.merge(protections)
     metadata = { 'protections' => protections_with_defaults }

data/lib/package_protections.rb

@@ -8,7 +8,7 @@ require 'set'
 require 'parse_packwerk'
 require 'rubocop'
 require 'rubocop-sorbet'
-require 'rubocop-modularization'
+require 'rubocop-packs'
 
 #
 # Welcome to PackageProtections!
@@ -40,6 +40,8 @@ module PackageProtections
   # Implementation of rubocop-based protections
   require 'rubocop/cop/package_protections/namespaced_under_package_name'
   require 'rubocop/cop/package_protections/typed_public_api'
+  require 'rubocop/cop/package_protections/only_class_methods'
+  require 'rubocop/cop/package_protections/require_documented_public_apis'
 
   class << self
     extend T::Sig

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

@@ -6,7 +6,7 @@ require 'active_support/core_ext/string/inflections'
 module RuboCop
   module Cop
     module PackageProtections
-      class NamespacedUnderPackageName < Base
+      class NamespacedUnderPackageName < Packs::NamespaceConvention
         extend T::Sig
         include ::PackageProtections::RubocopProtectionInterface
 

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

@@ -0,0 +1,58 @@
+# typed: true
+
+module RuboCop
+  module Cop
+    module PackageProtections
+      class OnlyClassMethods < Packs::ClassMethodsAsPublicApis
+        extend T::Sig
+        include ::PackageProtections::RubocopProtectionInterface
+
+        IDENTIFIER = 'prevent_this_package_from_exposing_instance_method_public_apis'.freeze
+
+        sig { override.returns(String) }
+        def humanized_protection_description
+          <<~MESSAGE
+            Public API methods can only be static methods.
+            This is failing because these files are in `.rubocop_todo.yml` under `#{cop_name}`.
+            If you want to be able to ignore these files, you'll need to open the file's package's `package.yml` file and
+            change `#{IDENTIFIER}` to `#{::PackageProtections::ViolationBehavior::FailOnNew.serialize}`
+          MESSAGE
+        end
+
+        sig do
+          override.params(file: String).returns(String)
+        end
+        def message_for_fail_on_any(file)
+          "`#{file}` must only contain static (class or module level) methods"
+        end
+
+        sig { override.returns(T::Array[String]) }
+        def included_globs_for_pack
+          [
+            'app/public/**/*'
+          ]
+        end
+
+        sig { override.returns(String) }
+        def identifier
+          IDENTIFIER
+        end
+
+        sig { override.returns(String) }
+        def humanized_protection_name
+          'Class Method Public APIs'
+        end
+
+        sig { override.returns(String) }
+        def cop_name
+          'PackageProtections/OnlyClassMethods'
+        end
+
+        sig { override.returns(::PackageProtections::ViolationBehavior) }
+        def default_behavior
+          ::PackageProtections::ViolationBehavior::FailNever
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# typed: true
+
+module RuboCop
+  module Cop
+    module PackageProtections
+      class RequireDocumentedPublicApis < Packs::RequireDocumentedPublicApis
+        extend T::Sig
+        include ::PackageProtections::RubocopProtectionInterface
+
+        IDENTIFIER = 'prevent_this_package_from_exposing_undocumented_public_apis'.freeze
+
+        include ::PackageProtections::RubocopProtectionInterface
+
+        sig { override.returns(String) }
+        def identifier
+          IDENTIFIER
+        end
+
+        sig { override.returns(T::Array[String]) }
+        def included_globs_for_pack
+          [
+            'app/public/**/*'
+          ]
+        end
+
+        sig { override.params(behavior: ::PackageProtections::ViolationBehavior, package: ParsePackwerk::Package).returns(T.nilable(String)) }
+        def unmet_preconditions_for_behavior(behavior, package)
+          if !behavior.fail_never?
+            readme_path = package.directory.join('README.md')
+            if !readme_path.exist?
+              "This package must have a readme at #{readme_path} to use this protection"
+            end
+          end
+        end
+
+        sig do
+          override.params(file: String).returns(String)
+        end
+        def message_for_fail_on_any(file)
+          "`#{file}` must contain documentation on every method (between signature and method)"
+        end
+
+        sig { override.returns(String) }
+        def cop_name
+          'PackageProtections/RequireDocumentedPublicApis'
+        end
+
+        sig { override.returns(String) }
+        def humanized_protection_name
+          'Documented Public APIs'
+        end
+
+        sig { override.returns(::PackageProtections::ViolationBehavior) }
+        def default_behavior
+          ::PackageProtections::ViolationBehavior::FailNever
+        end
+
+        sig { override.returns(String) }
+        def humanized_protection_description
+          <<~MESSAGE
+            All public API must have a documentation comment (between the signature and method).
+            This is failing because these files are in `.rubocop_todo.yml` under `#{cop_name}`.
+            If you want to be able to ignore these files, you'll need to open the file's package's `package.yml` file and
+            change `#{IDENTIFIER}` to `#{::PackageProtections::ViolationBehavior::FailOnNew.serialize}`
+          MESSAGE
+        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 < Modularization::TypedPublicApi
+      class TypedPublicApi < Packs::TypedPublicApi
         extend T::Sig
 
         include ::PackageProtections::ProtectionInterface

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: package_protections
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Gusto Engineers
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-modularization
+  name: rubocop-packs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -206,6 +206,8 @@ 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/only_class_methods.rb
+- lib/rubocop/cop/package_protections/require_documented_public_apis.rb
 - lib/rubocop/cop/package_protections/typed_public_api.rb
 homepage: https://github.com/rubyatscale/package_protections
 licenses: