package_protections 1.1.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27281e8109b1edc0fff691f606a70260be38e130810e088d48e2d73d31424fbb
-  data.tar.gz: cd99fe90189671daa334be828aaad40b0928742098cfb1430164f5080d3060ca
+  metadata.gz: 7b99c93d81087956b947c89fbede35844a2c973f20e2bee3c8f474383ff99a88
+  data.tar.gz: 64ad87cf10597e5fceeefa315dd3e665f7a684ac36db30c206012c15c2a0f3f2
 SHA512:
-  metadata.gz: b1d22a6dee650ffbe8dd4027d5815b6c104f0825d9d257a40aee08dd44ad4c458f72b502e3ed28caa848f0aa6c468502edb4e4f6c5acd7943b808a8ca43096a3
-  data.tar.gz: 91ac08c0a0697dad9fbacd7e7d62ab2a22ef058ad074b2d0371b4faf67f9b264aa4b7ed9a597fb09280b44fead58b641aeda165001568ccb7db015dff03d0bc4
+  metadata.gz: 9a5a70b90e8ecf6a00e8b22db867e6cec3a83ba34a8fa6f18b45449c96f3eb9fd248c80f9a047d9462e2976d233c8f6b29957837feef224a94d8ce93e008a55d
+  data.tar.gz: 500e49a77a3ee17aa2c4cb05edf2806e37010b5168ebb9cf1a13e1addbb5db5eb11c0caaa82f4a10451dbf96d304c7e010400b19ba7240b920b29a4c93780a90

data/lib/package_protections/private.rb

@@ -88,27 +88,6 @@ module PackageProtections
       end
     end
 
-    sig do
-      params(
-        package_names: T::Array[String],
-        all_packages: T::Array[ParsePackwerk::Package]
-      ).returns(T::Array[ParsePackwerk::Package])
-    end
-    def self.packages_for_names(package_names, all_packages)
-      all_packages_indexed_by_name = {}
-      all_packages.each { |package| all_packages_indexed_by_name[package.name] = package }
-
-      package_names.map do |package_name|
-        clean_pack_name = package_name.gsub(%r{/$}, '')
-        package = all_packages_indexed_by_name[clean_pack_name]
-        if package.nil?
-          raise "Sorry, we couldn't find a package with name #{package_name}. Here are all of the package names we know about: #{all_packages.map(&:name).sort.inspect}"
-        end
-
-        package
-      end
-    end
-
     sig { params(root_pathname: Pathname).returns(String) }
     def self.rubocop_yml(root_pathname:)
       protected_packages = Dir.chdir(root_pathname) { all_protected_packages }

data/lib/package_protections/rspec/application_fixture_helper.rb

@@ -0,0 +1,54 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module ApplicationFixtureHelper
+  def write_file(path, content = '')
+    pathname = Pathname.new(path)
+    FileUtils.mkdir_p(pathname.dirname)
+    pathname.write(content)
+    path
+  end
+
+  def write_package_yml(
+    pack_name,
+    dependencies: [],
+    enforce_dependencies: true,
+    enforce_privacy: true,
+    protections: {},
+    global_namespaces: [],
+    visible_to: []
+  )
+    defaults = {
+      'prevent_this_package_from_violating_its_stated_dependencies' => 'fail_on_new',
+      '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'
+    }
+    protections_with_defaults = defaults.merge(protections)
+    metadata = { 'protections' => protections_with_defaults }
+    if visible_to.any?
+      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,
+      enforce_dependencies: enforce_dependencies,
+      enforce_privacy: enforce_privacy,
+      metadata: metadata
+    )
+
+    ParsePackwerk.write_package_yml!(package)
+  end
+
+  def delete_app_file(path)
+    File.delete(path)
+  end
+end

data/lib/package_protections/rspec/matchers.rb

@@ -0,0 +1,99 @@
+def offense(
+  package_name, message, file, violation_type
+)
+
+  package = ParsePackwerk.all.find { |p| p.name == package_name }
+  PackageProtections::Offense.new(
+    package: package,
+    message: message,
+    file: file,
+    violation_type: violation_type
+  )
+end
+
+def serialize_offenses_diff(actual_offenses, expected_offense)
+  color_by_match = ->(actual, expected) { actual == expected ? Rainbow(actual).green : "#{Rainbow(actual).red} (expected: #{expected})" }
+
+  actual_offenses.map do |offense|
+    # We color each field red or green depending on if the attributes match our expected
+    <<~SERIALIZED_OFFENSE
+      File: #{color_by_match.call(offense.file, expected_offense.file)}
+      Message: #{color_by_match.call(offense.message, expected_offense.message)}
+      Violation Type: #{color_by_match.call(offense.violation_type, expected_offense.violation_type)}
+      Package: #{color_by_match.call(offense.package.name, expected_offense.package.name)}
+    SERIALIZED_OFFENSE
+  end
+end
+
+def serialize_offenses(actual_offenses)
+  actual_offenses.map do |offense|
+    <<~SERIALIZED_OFFENSE
+      File: #{offense.file}
+      Message: #{offense.message}
+      Violation Type: #{offense.violation_type}
+      Package: #{offense.package.name}
+    SERIALIZED_OFFENSE
+  end
+end
+
+RSpec::Matchers.define(:include_offense) do |expected_offense|
+  match do |actual_offenses|
+    @actual_offenses = actual_offenses
+    @expected_offense = expected_offense
+    if ENV['DEBUG']
+      PackageProtections.print_offenses(actual_offenses)
+    end
+    @matching_offense = actual_offenses.find do |actual_offense|
+      actual_offense.file == expected_offense.file &&
+        actual_offense.message == expected_offense.message &&
+        actual_offense.violation_type == expected_offense.violation_type &&
+        actual_offense.package.name == expected_offense.package.name
+    end
+    !@matching_offense.nil?
+  end
+
+  description do
+    "to have an offense with type `#{expected_offense.type}` tied to package `#{expected_offense.package_name}` with message `#{expected_offense.message}` and instances `#{expected_offense.submessages.join(', ')}`"
+  end
+
+  failure_message do
+    <<~MSG
+      Could not find offense! Here are the found offenses:
+      #{serialize_offenses_diff(@actual_offenses, expected_offense).join("\n\n")}
+    MSG
+  end
+end
+
+RSpec::Matchers.define(:contain_exactly) do |number_of_offenses|
+  match do |actual_offenses|
+    @actual_offenses = actual_offenses || []
+    @offenses = []
+    @actual_offenses.each do |offense|
+      @offenses << offense
+    end
+    @offenses.size == number_of_offenses
+  end
+
+  chain :offense, :number_of_offenses
+  chain :offenses, :number_of_offenses
+
+  description do
+    'to contain offenses'
+  end
+
+  failure_message_when_negated do
+    "Found the following offenses:\n#{@offenses.map { |r| "#{r.package_name}: #{r.message}" }}"
+  end
+
+  failure_message do
+    if @offenses.empty?
+      "Found #{@offenses.size} instead."
+    else
+      <<~MSG
+        Found #{@offenses.size} instead.
+
+        #{serialize_offenses(@offenses).join("\n")}
+      MSG
+    end
+  end
+end

data/lib/package_protections/rspec/support.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Require this file to load code that supports testing using RSpec.
+
+require_relative 'application_fixture_helper'
+require_relative 'matchers'
+
+def get_resulting_rubocop
+  write_file('config/default.yml', <<~YML.strip)
+    <%= PackageProtections.rubocop_yml(root_pathname: Pathname.pwd) %>
+  YML
+  YAML.safe_load(ERB.new(File.read('config/default.yml')).result(binding))
+end
+
+RSpec.configure do |config|
+  config.include ApplicationFixtureHelper
+
+  config.before do
+    PackageProtections.bust_cache!
+  end
+end

data/lib/package_protections.rb

@@ -116,16 +116,6 @@ module PackageProtections
     Private.private_cop_config(identifier)
   end
 
-  sig do
-    params(
-      package_names: T::Array[String],
-      all_packages: T::Array[ParsePackwerk::Package]
-    ).returns(T::Array[ParsePackwerk::Package])
-  end
-  def self.packages_for_names(package_names, all_packages)
-    Private.packages_for_names(package_names, all_packages)
-  end
-
   sig { void }
   def self.bust_cache!
     Private.bust_cache!

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

@@ -20,9 +20,7 @@ module RuboCop
           # This cop only works for files in `app`
           return if !relative_filename.include?('app/')
 
-          match = relative_filename.match(%r{((#{::PackageProtections::EXPECTED_PACK_DIRECTORIES.join("|")})/.*?)/})
-          package_name = match && match[1]
-
+          package_name = ParsePackwerk.package_from_path(relative_filename)&.name
           return if package_name.nil?
 
           return if relative_filepath.extname != '.rb'
@@ -105,7 +103,11 @@ module RuboCop
 
             # The reason for this is precondition is the `MultipleNamespacesProtection` assumes this to work properly.
             # To remove this precondition, we need to modify `MultipleNamespacesProtection` to be more generalized!
-            if ::PackageProtections::EXPECTED_PACK_DIRECTORIES.include?(Pathname.new(package.name).dirname.to_s) || package.name == ParsePackwerk::ROOT_PACKAGE_NAME
+            is_root_package = package.name == ParsePackwerk::ROOT_PACKAGE_NAME
+            in_allowed_directory = ::PackageProtections::EXPECTED_PACK_DIRECTORIES.any? do |expected_package_directory|
+              package.directory.to_s.start_with?(expected_package_directory)
+            end
+            if in_allowed_directory || is_root_package
               nil
             else
               "Package #{package.name} must be located in one of #{::PackageProtections::EXPECTED_PACK_DIRECTORIES.join(', ')} (or be the root) to use this protection"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: package_protections
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -186,6 +186,9 @@ files:
 - lib/package_protections/private/visibility_protection.rb
 - lib/package_protections/protected_package.rb
 - lib/package_protections/protection_interface.rb
+- lib/package_protections/rspec/application_fixture_helper.rb
+- lib/package_protections/rspec/matchers.rb
+- lib/package_protections/rspec/support.rb
 - lib/package_protections/rubocop_protection_interface.rb
 - lib/package_protections/violation_behavior.rb
 - lib/rubocop/cop/package_protections/namespaced_under_package_name.rb