Contents

# typed: strict
# frozen_string_literal: true

module Packwerk
  class PrivacyChecker
    extend T::Sig
    include Checker

    sig { override.returns(Packwerk::ViolationType) }
    def violation_type
      ViolationType::Privacy
    end

    sig do
      override
        .params(reference: Packwerk::Reference)
        .returns(T::Boolean)
    end
    def invalid_reference?(reference)
      return false if reference.constant.public?

      privacy_option = reference.constant.package.enforce_privacy
      return false if enforcement_disabled?(privacy_option)

      return false unless privacy_option == true ||
        explicitly_private_constant?(reference.constant, explicitly_private_constants: privacy_option)

      true
    end

    private

    sig do
      params(
        constant: ConstantDiscovery::ConstantContext,
        explicitly_private_constants: T::Array[String]
      ).returns(T::Boolean)
    end
    def explicitly_private_constant?(constant, explicitly_private_constants:)
      explicitly_private_constants.include?(constant.name) ||
        # nested constants
        explicitly_private_constants.any? { |epc| constant.name.start_with?(epc + "::") }
    end

    sig do
      params(privacy_option: T.nilable(T.any(T::Boolean, T::Array[String])))
        .returns(T::Boolean)
    end
    def enforcement_disabled?(privacy_option)
      [false, nil].include?(privacy_option)
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
packwerk-1.3.2	lib/packwerk/privacy_checker.rb
packwerk-1.3.1	lib/packwerk/privacy_checker.rb
packwerk-1.3.0	lib/packwerk/privacy_checker.rb
packwerk-1.2.0	lib/packwerk/privacy_checker.rb