package_protections 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64a576d5910c24c2f966b5f8db6c025af93a31b866c3956cd98b54adbc7d52da
-  data.tar.gz: e8a696185cdffdb44eb1a136ad4dba73498d249faacadcb731d1559eb7e94847
+  metadata.gz: '0906fd78fb0cee92c4e34663c700eda94ba7e050636cda905a8fe184e115efb1'
+  data.tar.gz: c28f5248b823d626875dc5f7ac5ee33b7a533fbb000d0f6f67e439b7aec102cd
 SHA512:
-  metadata.gz: 63194b36d9bd8edf9faab0136a58994b9a93dcfb49001ab75d057dbb7bf2522b1b235ffae8352ffbe6b3d3f13c8f5f171a3e7498ade041787ff72cd466762958
-  data.tar.gz: 67417571f0fe028ef5960985518f753de09a7b253ff56dd878f4dec89e3ca0e796a9f928da78db68da1cd29e47bd6bbd56ebff4a4882941bf6635033eb2bf76b
+  metadata.gz: '00937a5119e9589c7ea323c76df2c7ed5feb3334356a99b7cb0308f469ba7af53e1cea358a74736aaf49238e5885741ffdfd54b52fc15316023cacf170bd16d4'
+  data.tar.gz: '0972c6fab2b22557de1d9e64efe882747c8088d2653869b6fad65f2a7144e012b61c3b15634c450ea375eb646cfe80f3d1bfbfd722342130a912e896eae1f6f4'

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/rubocop_protection_interface.rb

@@ -108,7 +108,7 @@ module PackageProtections
           T.absurd(violation_behavior)
         end
 
-        package.original_package.directory.glob('**/**/*.*').each do |relative_path_to_file|
+        package.original_package.directory.glob(included_globs_for_pack).each do |relative_path_to_file|
           next unless exclude_list.include?(relative_path_to_file.to_s)
 
           file = relative_path_to_file.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: package_protections
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2022-07-01 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