parse_packwerk 0.20.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee084135635a9bebb7054d2682ce58103b9c8feed46ba7da13dda05035ac1f6e
-  data.tar.gz: 4a21594b8973d2c12676355710d3cfb805ffd317faf4e40218d275f5f0a0dfc8
+  metadata.gz: c6370b4639d8046076ebb15799265eafcad8c1af66795b22d2dd9812d431f8b8
+  data.tar.gz: 73823f09cc2022609f82287464d5d71d62fc8bef90b7542e4ab5d879be9346bf
 SHA512:
-  metadata.gz: 5a23503f3b986ebf6b70608578461ab987b73f0a22ec7343137cb0953934049889f45639a5419215749900bdce30ab9679f835b3265194df3e76eef2a4af278d
-  data.tar.gz: df52df866745a2de2acc946a136828c8d83e45d55f45538eb04b170fc599e2e28468da69b62ed85a83fae7d7b08cceeee13909b8b4a5d17b60d757615c23af23
+  metadata.gz: d1b44126cee4b76567cc56bc9e5e662d1adce14d1044c679b176cac461bc8c1f1563f1fff487de6f45d6901b8fa857815ee8c55a9317d7dfe9d18623af42ff27
+  data.tar.gz: d3da9bbae535e82a114e1d703a454407a5d432d7ee2c4003756a8afdb67d74a71be148518ec724c7e55e9daa9a713c120e6beb8705a8d0a9f7639128db349eba

data/lib/parse_packwerk/configuration.rb

@@ -12,12 +12,12 @@ module ParsePackwerk
     sig { returns(Configuration) }
     def self.fetch
       packwerk_yml_filename = Pathname.new(PACKWERK_YML_NAME)
-      if !File.exist?(packwerk_yml_filename)
-        raw_packwerk_config = {}
-      else
+      if File.exist?(packwerk_yml_filename)
         # when the YML file is empty or only contains comment, it gets parsed
         # as the boolean `false` for some reason. this handles that case
         raw_packwerk_config = YAML.load_file(packwerk_yml_filename) || {}
+      else
+        raw_packwerk_config = {}
       end
 
       Configuration.new(
@@ -32,22 +32,22 @@ module ParsePackwerk
     def self.excludes(config_hash)
       specified_exclude = config_hash['exclude']
       excludes = if specified_exclude.nil?
-        DEFAULT_EXCLUDE_GLOBS.dup
-      else
-        Array(specified_exclude)
-      end
+                   DEFAULT_EXCLUDE_GLOBS.dup
+                 else
+                   Array(specified_exclude)
+                 end
 
-      excludes.push Bundler.bundle_path.join("**").to_s
+      excludes.push Bundler.bundle_path.join('**').to_s
     end
 
     sig { params(config_hash: T::Hash[T.untyped, T.untyped]).returns(T::Array[String]) }
     def self.package_paths(config_hash)
       specified_package_paths = config_hash['package_paths']
       package_paths = if specified_package_paths.nil?
-        DEFAULT_PACKAGE_PATHS.dup
-      else
-        Array(specified_package_paths)
-      end
+                        DEFAULT_PACKAGE_PATHS.dup
+                      else
+                        Array(specified_package_paths)
+                      end
 
       # We add the root package path always
       package_paths.push '.'

data/lib/parse_packwerk/constants.rb

@@ -7,6 +7,7 @@ module ParsePackwerk
   PACKAGE_TODO_YML_NAME = T.let('package_todo.yml'.freeze, String)
   ENFORCE_DEPENDENCIES = T.let('enforce_dependencies'.freeze, String)
   ENFORCE_PRIVACY = T.let('enforce_privacy'.freeze, String)
+  ENFORCE_ARCHITECTURE = T.let('enforce_architecture'.freeze, String)
   DEPENDENCY_VIOLATION_TYPE = T.let('dependency'.freeze, String)
   PRIVACY_VIOLATION_TYPE = T.let('privacy'.freeze, String)
   PUBLIC_PATH = T.let('public_path'.freeze, String)
@@ -19,7 +20,7 @@ module ParsePackwerk
     T::Hash[T.untyped, T.untyped]
   end
 
-  DEFAULT_EXCLUDE_GLOBS = T.let(["{bin,node_modules,script,tmp,vendor}/**/*"], T::Array[String])
+  DEFAULT_EXCLUDE_GLOBS = T.let(['{bin,node_modules,script,tmp,vendor}/**/*'], T::Array[String])
   DEFAULT_PACKAGE_PATHS = T.let(['**/'], T::Array[String])
   DEFAULT_PUBLIC_PATH = T.let('app/public', String)
 end

data/lib/parse_packwerk/extensions.rb

@@ -13,6 +13,11 @@ module ParsePackwerk
     def self.privacy_extension_installed?
       all_extensions_installed? || ParsePackwerk.yml.requires.include?('packwerk/privacy/checker')
     end
+
+    sig { returns(T::Boolean) }
+    def self.architecture_extension_installed?
+      all_extensions_installed? || ParsePackwerk.yml.requires.include?('packwerk/architecture/checker')
+    end
   end
 
   private_constant :Extensions

data/lib/parse_packwerk/package.rb

@@ -5,8 +5,9 @@ module ParsePackwerk
     extend T::Sig
 
     const :name, String
-    const :enforce_dependencies, T.any(T::Boolean, String)
+    const :enforce_dependencies, T.nilable(T.any(T::Boolean, String))
     const :enforce_privacy, T.any(T::Boolean, String), default: false
+    const :enforce_architecture, T.any(T::Boolean, String), default: false
     const :public_path, String, default: DEFAULT_PUBLIC_PATH
     const :metadata, MetadataYmlType
     const :dependencies, T::Array[String]
@@ -18,7 +19,7 @@ module ParsePackwerk
       package_loaded_yml = YAML.load_file(pathname)
       if package_loaded_yml.nil? || package_loaded_yml == false
         message = "Failed to parse `#{pathname}`. Please fix any issues with this package.yml OR add its containing folder to packwerk.yml `exclude`"
-        raise PackageParseError.new(message)
+        raise PackageParseError, message
       end
       package_name = pathname.dirname.cleanpath.to_s
 
@@ -26,6 +27,7 @@ module ParsePackwerk
         name: package_name,
         enforce_dependencies: package_loaded_yml[ENFORCE_DEPENDENCIES],
         enforce_privacy: package_loaded_yml[ENFORCE_PRIVACY] || false,
+        enforce_architecture: package_loaded_yml[ENFORCE_ARCHITECTURE] || false,
         public_path: package_loaded_yml[PUBLIC_PATH] || DEFAULT_PUBLIC_PATH,
         metadata: package_loaded_yml[METADATA] || {},
         dependencies: package_loaded_yml[DEPENDENCIES] || [],
@@ -46,7 +48,7 @@ module ParsePackwerk
 
     sig { returns(Pathname) }
     def directory
-      self.class.directory(self.name)
+      self.class.directory(name)
     end
 
     sig { returns(Pathname) }
@@ -54,7 +56,7 @@ module ParsePackwerk
       directory.join(public_path).cleanpath
     end
 
-    sig { returns(T.any(T::Boolean, String)) }
+    sig { returns(T.nilable(T.any(T::Boolean, String))) }
     def enforces_dependencies?
       enforce_dependencies
     end
@@ -63,5 +65,10 @@ module ParsePackwerk
     def enforces_privacy?
       enforce_privacy
     end
+
+    sig { returns(T.any(T::Boolean, String)) }
+    def enforces_architecture?
+      enforce_architecture
+    end
   end
 end

data/lib/parse_packwerk/package_set.rb

@@ -1,7 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "pathname"
+require 'pathname'
 require 'bundler'
 
 module ParsePackwerk

data/lib/parse_packwerk/package_todo.rb

@@ -9,17 +9,12 @@ module ParsePackwerk
 
     sig { params(package: Package).returns(PackageTodo) }
     def self.for(package)
-      PackageTodo.from(self.yml(package.directory))
+      PackageTodo.from(yml(package.directory))
     end
 
     sig { params(pathname: Pathname).returns(PackageTodo) }
     def self.from(pathname)
-      if !pathname.exist?
-        new(
-          pathname: pathname.cleanpath,
-          violations: []
-        )
-      else
+      if pathname.exist?
         package_todo_loaded_yml = YAML.load_file(pathname)
 
         all_violations = []
@@ -39,9 +34,14 @@ module ParsePackwerk
           pathname: pathname.cleanpath,
           violations: all_violations
         )
+      else
+        new(
+          pathname: pathname.cleanpath,
+          violations: []
+        )
       end
     end
-    
+
     sig { params(dirname: Pathname).returns(Pathname) }
     def self.yml(dirname)
       dirname.join(PACKAGE_TODO_YML_NAME).cleanpath

data/lib/parse_packwerk.rb

@@ -62,16 +62,20 @@ module ParsePackwerk
   sig { params(package: ParsePackwerk::Package).void }
   def self.write_package_yml!(package)
     FileUtils.mkdir_p(package.directory)
-    
+
     File.open(package.yml, 'w') do |file|
       merged_config = package.config
 
-      merged_config.merge!('enforce_dependencies' => package.enforce_dependencies,)
+      merged_config.merge!('enforce_dependencies' => package.enforce_dependencies)
 
       if Extensions.privacy_extension_installed?
         merged_config.merge!('enforce_privacy' => package.enforce_privacy)
       end
 
+      if Extensions.architecture_extension_installed?
+        merged_config.merge!('enforce_architecture' => package.enforce_architecture)
+      end
+
       unless package.public_path == DEFAULT_PUBLIC_PATH
         merged_config.merge!('public_path' => package.public_path)
       end
@@ -87,11 +91,11 @@ module ParsePackwerk
       end
 
       sorted_keys = key_sort_order
-      merged_config = merged_config.to_a.sort_by{|key, value| T.unsafe(sorted_keys).index(key) || 1000 }.to_h
+      merged_config = merged_config.to_a.sort_by { |key, _value| T.unsafe(sorted_keys).index(key) || 1000 }.to_h
 
       raw_yaml = YAML.dump(merged_config)
       # Add indentation for dependencies
-      raw_yaml.gsub!(/^- /,"  - ")
+      raw_yaml.gsub!(/^- /, '  - ')
       stylized_yaml = raw_yaml.gsub("---\n", '')
       file.write(stylized_yaml)
     end
@@ -99,7 +103,7 @@ module ParsePackwerk
 
   sig { returns(T::Array[String]) }
   def self.key_sort_order
-    %w(
+    %w[
       enforce_dependencies
       enforce_privacy
       enforce_visibility
@@ -111,7 +115,7 @@ module ParsePackwerk
       ignored_dependencies
       visible_to
       metadata
-    )
+    ]
   end
 
   # We memoize packages_by_name for fast lookup.
@@ -124,7 +128,7 @@ module ParsePackwerk
       # We want to match more specific paths first
       # Packwerk does this too and is necessary for package_from_path to work correctly.
       sorted_packages = all_packages.sort_by { |package| -package.name.length }
-      sorted_packages.map{|p| [p.name, p]}.to_h
+      sorted_packages.to_h { |p| [p.name, p] }
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parse_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.22.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-21 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: hashdiff
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,35 +81,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sorbet
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: tapioca
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashdiff
+  name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: tapioca
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="