package_protections 0.67.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0457664569f574f7252c13cd8236b6e267a114bd900a24da1aa4a89c4b5d13da'
-  data.tar.gz: 8495e9bc7343afa5c793ef7027c2e453dbe13424de49514e235dcd3f64327031
+  metadata.gz: a1189b0779bbda54403506984a5719d37ac3444776e34150defe591ecb96fc81
+  data.tar.gz: 1006d4722077a1581cf3509358eb4f5b58d5e443bd6c9d203309472bb26f980d
 SHA512:
-  metadata.gz: 04cfbf3ce493c4dbb3a9ddfbeb89d725a1fbcc7d5d209e1a51e45ecee6fb56320dacb9fb271d3ca58d1b5d176b209a6410630de041d7e4f749368f7820443ed4
-  data.tar.gz: 67412edbc0ac4a0c64460419c482a141963120c89bb46c297bb84575c83b9f38920bfa7cee9549a7f8c135275eca0927127fa89c5f1879480d283201e757b60f
+  metadata.gz: 383d9bac29ac9e7be26d41de6d7af08eeb85d635e471f91a1a1ad08fd565aaaa25f42763d9e0bfc75cded4beb6d911bff267744d2a6408651132b93c4a30d70b
+  data.tar.gz: 1fd35343e9db0689656378111537df0369910874f0a59f38dcb2fa1bc712c6233e45e945cccec591c3f6a71da89e64b62aeffaa2cd565146a217aa43d09900a1

data/README.md

@@ -8,7 +8,7 @@ The intent of this gem is two fold:
 This gem ships with the following checks
 1) Your package is not introducing dependencies that are not intended (via `packwerk` `enforce_dependencies`)
 2) Other packages are not using the private API of your package (via `packwerk` `enforce_privacy`)
-3) Your package has a typed public API (via the `rubocop` `Sorbet/StrictSigil` cop)
+3) Your package has a typed public API (via the `rubocop` `PackageProtections/TypedPublicApi` cop)
 4) Your package only creates a single namespace (via the `rubocop` `PackageProtections/NamespacedUnderPackageName` cop)
 4) Your package is only visible to a select number of packages (via the `packwerk` `enforce_privacy` cop)
 
@@ -146,16 +146,16 @@ Your CI pipeline can execute the public API ta and fail if there are any offense
 ## Discussions, Issues, Questions, and More
 To keep things organized, here are some recommended homes:
 ### Issues:
-https://github.com/bigrails/package_protections/issues
+https://github.com/rubyatscale/package_protections/issues
 
 ### Questions:
-https://github.com/bigrails/package_protections/discussions/categories/q-a
+https://github.com/rubyatscale/package_protections/discussions/categories/q-a
 
 ### General discussions:
-https://github.com/bigrails/package_protections/discussions/categories/general
+https://github.com/rubyatscale/package_protections/discussions/categories/general
 
 ### Ideas, new features, requests for change:
-https://github.com/bigrails/package_protections/discussions/categories/ideas
+https://github.com/rubyatscale/package_protections/discussions/categories/ideas
 
 ### Showcasing your work:
-https://github.com/bigrails/package_protections/discussions/categories/show-and-tell
+https://github.com/rubyatscale/package_protections/discussions/categories/show-and-tell

data/lib/package_protections/private/typed_api_protection.rb

@@ -10,7 +10,7 @@ module PackageProtections
       include RubocopProtectionInterface
 
       IDENTIFIER = 'prevent_this_package_from_exposing_an_untyped_api'
-      COP_NAME = 'Sorbet/StrictSigil'
+      COP_NAME = 'PackageProtections/TypedPublicApi'
 
       sig { override.returns(String) }
       def identifier

data/lib/package_protections/protected_package.rb

@@ -17,14 +17,14 @@ module PackageProtections
       invalid_identifiers = metadata.keys - valid_identifiers
 
       if invalid_identifiers.any?
-        raise IncorrectPublicApiUsageError.new("Invalid configuration for package `#{original_package.name}`. The metadata keys #{invalid_identifiers.inspect} are not valid behaviors under the `protection` metadata namespace. Valid keys are #{valid_identifiers.inspect}. See https://github.com/bigrails/package_protections#readme for more info") # rubocop:disable Style/RaiseArgs
+        raise IncorrectPublicApiUsageError.new("Invalid configuration for package `#{original_package.name}`. The metadata keys #{invalid_identifiers.inspect} are not valid behaviors under the `protection` metadata namespace. Valid keys are #{valid_identifiers.inspect}. See https://github.com/rubyatscale/package_protections#readme for more info") # rubocop:disable Style/RaiseArgs
       end
 
       protections = {}
       metadata.each_key do |protection_key|
         protection = PackageProtections.with_identifier(protection_key)
         if !protection
-          raise IncorrectPublicApiUsageError.new("Invalid configuration for package `#{original_package.name}`. The metadata key #{protection_key} is not a valid behaviors under the `protection` metadata namespace. Valid keys are #{valid_identifiers.inspect}. See https://github.com/bigrails/package_protections#readme for more info") # rubocop:disable Style/RaiseArgs
+          raise IncorrectPublicApiUsageError.new("Invalid configuration for package `#{original_package.name}`. The metadata key #{protection_key} is not a valid behaviors under the `protection` metadata namespace. Valid keys are #{valid_identifiers.inspect}. See https://github.com/rubyatscale/package_protections#readme for more info") # rubocop:disable Style/RaiseArgs
         end
 
         protections[protection.identifier] = get_violation_behavior(protection, metadata, original_package)
@@ -57,7 +57,7 @@ module PackageProtections
       behavior = ViolationBehavior.from_raw_value(metadata[protection.identifier])
       unmet_preconditions = protection.unmet_preconditions_for_behavior(behavior, package)
       if !unmet_preconditions.nil?
-        raise IncorrectPublicApiUsageError.new("#{protection.identifier} protection does not have the valid preconditions. #{unmet_preconditions}. See https://github.com/bigrails/package_protections#readme for more info") # rubocop:disable Style/RaiseArgs
+        raise IncorrectPublicApiUsageError.new("#{protection.identifier} protection does not have the valid preconditions. #{unmet_preconditions}. See https://github.com/rubyatscale/package_protections#readme for more info") # rubocop:disable Style/RaiseArgs
       end
 
       behavior

data/lib/package_protections/violation_behavior.rb

@@ -19,7 +19,7 @@ module PackageProtections
     rescue KeyError
       # Let's not encourage "unknown." That's mostly considered an internal value if nothing is specified.
       acceptable_values = ViolationBehavior.values.map(&:serialize) - ['unknown']
-      raise IncorrectPublicApiUsageError.new("The metadata value #{value} is not a valid behavior. Double check your spelling! Acceptable values are #{acceptable_values}. See https://github.com/bigrails/package_protections#readme for more info") # rubocop:disable Style/RaiseArgs
+      raise IncorrectPublicApiUsageError.new("The metadata value #{value} is not a valid behavior. Double check your spelling! Acceptable values are #{acceptable_values}. See https://github.com/rubyatscale/package_protections#readme for more info") # rubocop:disable Style/RaiseArgs
     end
 
     sig { returns(T::Boolean) }

data/lib/package_protections.rb

@@ -10,7 +10,7 @@ require 'rubocop-sorbet'
 
 #
 # Welcome to PackageProtections!
-# See https://github.com/bigrails/package_protections#readme for more info
+# See https://github.com/rubyatscale/package_protections#readme for more info
 #
 # This file is a reference for the available API to `package_protections`, but all implementation details are private
 # (which is why we delegate to `Private` for the actual implementation).
@@ -37,6 +37,7 @@ module PackageProtections
 
   # Implementation of rubocop-based protections
   require 'rubocop/cop/package_protections/namespaced_under_package_name'
+  require 'rubocop/cop/package_protections/typed_public_api'
 
   class << self
     extend T::Sig

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

@@ -0,0 +1,22 @@
+# typed: ignore
+
+module RuboCop
+  module Cop
+    module PackageProtections
+      #
+      # This inherits from `Sorbet::StrictSigil` and doesn't change any behavior of it.
+      # The only reason we do this is so that configuration for this cop can live under a different cop namespace.
+      # This prevents this cop's configuration from clashing with other configurations for the same cop.
+      # A concrete example of this would be if a user is using this package protection to make sure public APIs are typed,
+      # and separately the application as a whole requiring strict typing in certain parts of the application.
+      #
+      # To prevent problems associated with needing to manage identical configurations for the same cop, we simply call it
+      # something else in the context of this protection.
+      #
+      # 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
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: package_protections
 version: !ruby/object:Gem::Version
-  version: 0.67.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-10 00:00:00.000000000 Z
+date: 2022-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -191,13 +191,14 @@ files:
 - lib/package_protections/rubocop_protection_interface.rb
 - lib/package_protections/violation_behavior.rb
 - lib/rubocop/cop/package_protections/namespaced_under_package_name.rb
-homepage: https://github.com/bigrails/package_protections
+- lib/rubocop/cop/package_protections/typed_public_api.rb
+homepage: https://github.com/rubyatscale/package_protections
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/bigrails/package_protections
-  source_code_uri: https://github.com/bigrails/parse_packwerk
-  changelog_uri: https://github.com/bigrails/parse_packwerk/releases
+  homepage_uri: https://github.com/rubyatscale/package_protections
+  source_code_uri: https://github.com/rubyatscale/parse_packwerk
+  changelog_uri: https://github.com/rubyatscale/parse_packwerk/releases
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []