add enforce_architecture flag wherever enforce_privacy is used (#138)

* add enforce_architecture flag wherever enforce_privacy is used

Co-authored-by: Ashley Willard <ashley.willard@gusto.com>
Co-authored-by: Perry Hertler <perry.hertler@gusto.com>

* bump version (0.0.37 -> 0.0.38)

---------

Co-authored-by: Ashley Willard <ashley.willard@gusto.com>
Co-authored-by: Perry Hertler <perry.hertler@gusto.com>

Author: 3 people

Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/Shopify/packwerk.git
-  revision: e850241a4572a984bc9def8307faef7271c6890b
+  revision: c27be1b1bc917d088fa46484414f303d81217117
   branch: main
   specs:
     packwerk (3.1.0)
@@ -17,11 +17,11 @@ GIT
 PATH
   remote: .
   specs:
-    packs (0.0.37)
+    packs (0.0.38)
       code_ownership (>= 1.33.0)
       packs-specification
       packwerk
-      parse_packwerk
+      parse_packwerk (>= 0.22.0)
       rainbow
       sorbet-runtime
       thor
@@ -81,7 +81,7 @@ GEM
     packs-specification (0.0.10)
       sorbet-runtime
     parallel (1.23.0)
-    parse_packwerk (0.20.1)
+    parse_packwerk (0.22.0)
       sorbet-runtime
     parser (3.2.2.3)
       ast (~> 2.4.1)

lib/packs.rb

@@ -49,20 +49,23 @@ def self.check(files)
     params(
       pack_name: String,
       enforce_privacy: T::Boolean,
+      enforce_architecture: T::Boolean,
       enforce_dependencies: T.nilable(T::Boolean),
       team: T.nilable(CodeTeams::Team)
     ).void
   end
   def self.create_pack!(
     pack_name:,
     enforce_privacy: true,
+    enforce_architecture: true,
     enforce_dependencies: nil,
     team: nil
   )
     Private.create_pack!(
       pack_name: pack_name,
       enforce_privacy: enforce_privacy,
       enforce_dependencies: enforce_dependencies,
+      enforce_architecture: enforce_architecture,
       team: team
     )
   end

lib/packs/cli.rb

@@ -7,12 +7,16 @@ class CLI < Thor
     extend T::Sig
 
     desc 'create packs/your_pack', 'Create pack with name packs/your_pack'
+    option :enforce_dependencies, type: :boolean, default: nil, aliases: :d, banner: 'Enforce dependencies'
     option :enforce_privacy, type: :boolean, default: true, aliases: :p, banner: 'Enforce privacy'
+    option :enforce_architecture, type: :boolean, default: true, aliases: :a, banner: 'Enforce architecture'
     sig { params(pack_name: String).void }
     def create(pack_name)
       Packs.create_pack!(
         pack_name: pack_name,
-        enforce_privacy: options[:enforce_privacy]
+        enforce_dependencies: options[:enforce_dependencies],
+        enforce_privacy: options[:enforce_privacy],
+        enforce_architecture: options[:enforce_architecture]
       )
       exit_successfully
     end

lib/packs/private.rb

@@ -47,20 +47,27 @@ def self.replace_in_file(file:, find:, replace_with:)
     sig do
       params(
         pack_name: String,
-        enforce_privacy: T::Boolean,
         enforce_dependencies: T.nilable(T::Boolean),
+        enforce_privacy: T::Boolean,
+        enforce_architecture: T::Boolean,
         team: T.nilable(CodeTeams::Team)
       ).void
     end
-    def self.create_pack!(pack_name:, enforce_privacy:, enforce_dependencies:, team:)
+    def self.create_pack!(pack_name:, enforce_dependencies:, enforce_privacy:, enforce_architecture:, team:)
       Logging.section('👋 Hi!') do
         intro = Packs.config.user_event_logger.before_create_pack(pack_name)
         Logging.print_bold_green(intro)
       end
 
       pack_name = Private.clean_pack_name(pack_name)
 
-      package = create_pack_if_not_exists!(pack_name: pack_name, enforce_privacy: enforce_privacy, enforce_dependencies: enforce_dependencies, team: team)
+      package = create_pack_if_not_exists!(
+        pack_name: pack_name,
+        enforce_dependencies: enforce_dependencies,
+        enforce_privacy: enforce_privacy,
+        enforce_architecture: enforce_architecture,
+        team: team
+      )
       add_public_directory(package) if package.enforce_privacy
       add_readme_todo(package)
 
@@ -160,8 +167,9 @@ def self.move_to_folder!(pack_name:, destination:, per_file_processors: [Packs::
 
       new_package = ParsePackwerk::Package.new(
         name: new_package_name,
-        enforce_privacy: package.enforce_privacy,
         enforce_dependencies: package.enforce_dependencies,
+        enforce_privacy: package.enforce_privacy,
+        enforce_architecture: package.enforce_architecture,
         dependencies: package.dependencies,
         violations: package.violations,
         metadata: package.metadata,
@@ -196,8 +204,9 @@ def self.move_to_folder!(pack_name:, destination:, per_file_processors: [Packs::
 
         new_other_package = ParsePackwerk::Package.new(
           name: other_package.name,
-          enforce_privacy: other_package.enforce_privacy,
           enforce_dependencies: other_package.enforce_dependencies,
+          enforce_privacy: other_package.enforce_privacy,
+          enforce_architecture: other_package.enforce_architecture,
           dependencies: new_dependencies.uniq.sort,
           violations: other_package.violations,
           metadata: other_package.metadata,
@@ -238,7 +247,12 @@ def self.move_to_parent!(
       parent_name = Private.clean_pack_name(parent_name)
       parent_package = ParsePackwerk.all.find { |p| p.name == parent_name }
       if parent_package.nil?
-        parent_package = create_pack_if_not_exists!(pack_name: parent_name, enforce_privacy: true, enforce_dependencies: true)
+        parent_package = create_pack_if_not_exists!(
+          pack_name: parent_name,
+          enforce_dependencies: true,
+          enforce_privacy: true,
+          enforce_architecture: true
+        )
       end
 
       # First we create a new pack that has the exact same properties of the old one!
@@ -249,6 +263,7 @@ def self.move_to_parent!(
         name: new_package_name,
         enforce_privacy: package.enforce_privacy,
         enforce_dependencies: package.enforce_dependencies,
+        enforce_architecture: package.enforce_architecture,
         dependencies: package.dependencies,
         violations: package.violations,
         metadata: package.metadata,
@@ -289,8 +304,9 @@ def self.move_to_parent!(
 
         new_other_package = ParsePackwerk::Package.new(
           name: other_package.name,
-          enforce_privacy: other_package.enforce_privacy,
           enforce_dependencies: other_package.enforce_dependencies,
+          enforce_privacy: other_package.enforce_privacy,
+          enforce_architecture: other_package.enforce_architecture,
           dependencies: new_dependencies.uniq.sort,
           violations: other_package.violations,
           metadata: other_package.metadata,
@@ -382,6 +398,7 @@ def self.add_dependency!(pack_name:, dependency_name:)
         name: pack_name,
         dependencies: (package.dependencies + [dependency_name]).uniq.sort,
         enforce_privacy: package.enforce_privacy,
+        enforce_architecture: package.enforce_architecture,
         enforce_dependencies: package.enforce_dependencies,
         violations: package.violations,
         metadata: package.metadata,
@@ -447,12 +464,13 @@ def self.add_readme_todo(package)
     sig do
       params(
         pack_name: String,
-        enforce_privacy: T::Boolean,
         enforce_dependencies: T.nilable(T::Boolean),
+        enforce_privacy: T::Boolean,
+        enforce_architecture: T::Boolean,
         team: T.nilable(CodeTeams::Team)
       ).returns(ParsePackwerk::Package)
     end
-    def self.create_pack_if_not_exists!(pack_name:, enforce_privacy:, enforce_dependencies:, team: nil)
+    def self.create_pack_if_not_exists!(pack_name:, enforce_dependencies:, enforce_privacy:, enforce_architecture:, team: nil)
       allowed_locations = Packs::Specification.config.pack_paths
       if allowed_locations.none? { |location| File.fnmatch(location, pack_name) }
         raise StandardError, "Packs only supports packages in the the following directories: #{allowed_locations}. Please make sure to pass in the name of the pack including the full directory path, e.g. `packs/my_pack`."
@@ -475,6 +493,7 @@ def self.create_pack_if_not_exists!(pack_name:, enforce_privacy:, enforce_depend
         package = ParsePackwerk::Package.new(
           enforce_dependencies: should_enforce_dependencies || false,
           enforce_privacy: enforce_privacy,
+          enforce_architecture: enforce_architecture,
           dependencies: [],
           violations: [],
           metadata: {},

packs.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'packs'
-  spec.version       = '0.0.37'
+  spec.version       = '0.0.38'
   spec.authors       = ['Gusto Engineers']
   spec.email         = ['dev@gusto.com']
 
@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'code_ownership', '>= 1.33.0'
   spec.add_dependency 'packs-specification'
   spec.add_dependency 'packwerk'
-  spec.add_dependency 'parse_packwerk'
+  spec.add_dependency 'parse_packwerk', '>= 0.22.0'
   spec.add_dependency 'rainbow'
   spec.add_dependency 'sorbet-runtime'
   spec.add_dependency 'thor'

sorbet/rbi/gems/.gitattributes

@@ -0,0 +1 @@
+**/*.rbi linguist-generated=true