rename architecture to layers (#158)

* rename architecture to layers

Co-authored-by: Teal Stannard <teal.stannard@gusto.com>

* bump gem version 0.0.42 => 0.0.43

Co-authored-by: Teal Stannard <teal.stannard@gusto.com>

* update packs-specification rbi

Co-authored-by: Teal Stannard <teal.stannard@gusto.com>

* rename architecture -> layer in get_info

Co-authored-by: Teal Stannard <teal.stannard@gusto.com>

---------

Co-authored-by: Teal Stannard <teal.stannard@gusto.com>

Author: schoblaska

Gemfile.lock

@@ -17,12 +17,12 @@ GIT
 PATH
   remote: .
   specs:
-    packs (0.0.42)
+    packs (0.0.43)
       bigdecimal
       code_ownership (>= 1.33.0)
       packs-specification
       packwerk
-      parse_packwerk (>= 0.22.0, <= 0.23.0)
+      parse_packwerk (>= 0.25.0)
       rainbow
       sorbet-runtime
       thor
@@ -85,7 +85,8 @@ GEM
     packs-specification (0.0.10)
       sorbet-runtime
     parallel (1.23.0)
-    parse_packwerk (0.22.0)
+    parse_packwerk (0.25.0)
+      bigdecimal
       sorbet-runtime
     parser (3.2.2.3)
       ast (~> 2.4.1)

README.md

@@ -64,13 +64,13 @@ This command will also sort the list and make it unique.
 ## List the top violations of a specific type for packs/your_pack.
 `bin/packs list_top_violations type [ packs/your_pack ]`
 
-Possible types are: dependency, privacy, architecture.
+Possible types are: dependency, privacy, layer.
 
 Want to see who is depending on you? Not sure how your pack's code is being used in an unstated way? You can use this command to list the top dependency violations.
 
 Want to create interfaces? Not sure how your pack's code is being used? You can use this command to list the top privacy violations.
 
-Want to focus on the big picture first? You can use this command to list the top architecture violations.
+Want to focus on the big picture first? You can use this command to list the top layer violations.
 
 If no pack name is passed in, this will list out violations across all packs.
 

lib/packs.rb

@@ -49,23 +49,23 @@ def self.check(files)
     params(
       pack_name: String,
       enforce_privacy: T::Boolean,
-      enforce_architecture: T::Boolean,
+      enforce_layers: 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_layers: 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,
+      enforce_layers: enforce_layers,
       team: team
     )
   end

lib/packs/cli.rb

@@ -9,14 +9,14 @@ class CLI < Thor
     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'
+    option :enforce_layers, type: :boolean, default: true, aliases: :a, banner: 'Enforce layers'
     sig { params(pack_name: String).void }
     def create(pack_name)
       Packs.create_pack!(
         pack_name: pack_name,
         enforce_dependencies: options[:enforce_dependencies],
         enforce_privacy: options[:enforce_privacy],
-        enforce_architecture: options[:enforce_architecture]
+        enforce_layers: options[:enforce_layers]
       )
       exit_successfully
     end
@@ -39,7 +39,7 @@ def add_dependency(from_pack, to_pack)
       exit_successfully
     end
 
-    POSIBLE_TYPES = T.let(%w[dependency privacy architecture], T::Array[String])
+    POSIBLE_TYPES = T.let(%w[dependency privacy layer], T::Array[String])
     desc 'list_top_violations type [ packs/your_pack ]', 'List the top violations of a specific type for packs/your_pack.'
     long_desc <<~LONG_DESC
       Possible types are: #{POSIBLE_TYPES.join(', ')}.
@@ -48,7 +48,7 @@ def add_dependency(from_pack, to_pack)
 
       Want to create interfaces? Not sure how your pack's code is being used? You can use this command to list the top privacy violations.
 
-      Want to focus on the big picture first? You can use this command to list the top architecture violations.
+      Want to focus on the big picture first? You can use this command to list the top layer violations.
 
       If no pack name is passed in, this will list out violations across all packs.
     LONG_DESC
@@ -131,7 +131,7 @@ def update
     desc 'get_info [ packs/my_pack packs/my_other_pack ]', 'Get info about size and violations for packs'
     option :include_date, type: :boolean, default: false, aliases: :d, banner: "Include today's date as part of the data (useful to take snapshots over time)"
     option :format, type: :string, default: 'detail', aliases: :f, banner: 'Specify the output format (detail, csv)'
-    option :types, type: :string, default: 'privacy,dependency', aliases: :t, banner: 'List of validation types to include (privacy,dependency,architecture)'
+    option :types, type: :string, default: 'privacy,dependency', aliases: :t, banner: 'List of validation types to include (privacy,dependency,layer)'
     sig { params(pack_names: String).void }
     def get_info(*pack_names)
       selected_types = options[:types].to_s.downcase.split(',')

lib/packs/private.rb

@@ -49,11 +49,11 @@ def self.replace_in_file(file:, find:, replace_with:)
         pack_name: String,
         enforce_dependencies: T.nilable(T::Boolean),
         enforce_privacy: T::Boolean,
-        enforce_architecture: T::Boolean,
+        enforce_layers: T::Boolean,
         team: T.nilable(CodeTeams::Team)
       ).void
     end
-    def self.create_pack!(pack_name:, enforce_dependencies:, enforce_privacy:, enforce_architecture:, team:)
+    def self.create_pack!(pack_name:, enforce_dependencies:, enforce_privacy:, enforce_layers:, team:)
       Logging.section('👋 Hi!') do
         intro = Packs.config.user_event_logger.before_create_pack(pack_name)
         Logging.print_bold_green(intro)
@@ -65,7 +65,7 @@ def self.create_pack!(pack_name:, enforce_dependencies:, enforce_privacy:, enfor
         pack_name: pack_name,
         enforce_dependencies: enforce_dependencies,
         enforce_privacy: enforce_privacy,
-        enforce_architecture: enforce_architecture,
+        enforce_layers: enforce_layers,
         team: team
       )
       add_public_directory(package) if package.enforce_privacy
@@ -169,7 +169,7 @@ def self.move_to_folder!(pack_name:, destination:, per_file_processors: [Packs::
         name: new_package_name,
         enforce_dependencies: package.enforce_dependencies,
         enforce_privacy: package.enforce_privacy,
-        enforce_architecture: package.enforce_architecture,
+        enforce_layers: package.enforce_layers,
         dependencies: package.dependencies,
         violations: package.violations,
         metadata: package.metadata,
@@ -206,7 +206,7 @@ def self.move_to_folder!(pack_name:, destination:, per_file_processors: [Packs::
           name: other_package.name,
           enforce_dependencies: other_package.enforce_dependencies,
           enforce_privacy: other_package.enforce_privacy,
-          enforce_architecture: other_package.enforce_architecture,
+          enforce_layers: other_package.enforce_layers,
           dependencies: new_dependencies.uniq.sort,
           violations: other_package.violations,
           metadata: other_package.metadata,
@@ -251,7 +251,7 @@ def self.move_to_parent!(
           pack_name: parent_name,
           enforce_dependencies: true,
           enforce_privacy: true,
-          enforce_architecture: true
+          enforce_layers: true
         )
       end
 
@@ -263,7 +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,
+        enforce_layers: package.enforce_layers,
         dependencies: package.dependencies,
         violations: package.violations,
         metadata: package.metadata,
@@ -306,7 +306,7 @@ def self.move_to_parent!(
           name: other_package.name,
           enforce_dependencies: other_package.enforce_dependencies,
           enforce_privacy: other_package.enforce_privacy,
-          enforce_architecture: other_package.enforce_architecture,
+          enforce_layers: other_package.enforce_layers,
           dependencies: new_dependencies.uniq.sort,
           violations: other_package.violations,
           metadata: other_package.metadata,
@@ -398,7 +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_layers: package.enforce_layers,
         enforce_dependencies: package.enforce_dependencies,
         violations: package.violations,
         metadata: package.metadata,
@@ -466,11 +466,11 @@ def self.add_readme_todo(package)
         pack_name: String,
         enforce_dependencies: T.nilable(T::Boolean),
         enforce_privacy: T::Boolean,
-        enforce_architecture: T::Boolean,
+        enforce_layers: T::Boolean,
         team: T.nilable(CodeTeams::Team)
       ).returns(ParsePackwerk::Package)
     end
-    def self.create_pack_if_not_exists!(pack_name:, enforce_dependencies:, enforce_privacy:, enforce_architecture:, team: nil)
+    def self.create_pack_if_not_exists!(pack_name:, enforce_dependencies:, enforce_privacy:, enforce_layers:, 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`."
@@ -493,7 +493,7 @@ def self.create_pack_if_not_exists!(pack_name:, enforce_dependencies:, enforce_p
         package = ParsePackwerk::Package.new(
           enforce_dependencies: should_enforce_dependencies || false,
           enforce_privacy: enforce_privacy,
-          enforce_architecture: enforce_architecture,
+          enforce_layers: enforce_layers,
           dependencies: [],
           violations: [],
           metadata: {},
@@ -600,7 +600,7 @@ def self.packwerk_package_to_pack(package)
         include_date: T::Boolean
       ).void
     end
-    def self.get_info(packs: Packs.all, format: :detail, types: %i[privacy dependency architecture], include_date: false)
+    def self.get_info(packs: Packs.all, format: :detail, types: %i[privacy dependency layer], include_date: false)
       require 'csv' if format == :csv
 
       today = Date.today.iso8601

lib/packs/private/interactive_cli/use_cases/get_info.rb

@@ -30,7 +30,7 @@ def perform!(prompt)
 
             types = prompt.multi_select(
               'What violation types do you want stats for?',
-              %w[Privacy Dependency Architecture]
+              %w[Privacy Dependency Layer]
             )
 
             include_date = !prompt.no?('Should the current date be included in the report?')

lib/packs/private/interactive_cli/use_cases/query.rb

@@ -30,7 +30,7 @@ def perform!(prompt)
 
             limit = prompt.ask('Specify the limit of constants to analyze', default: 10, convert: :integer)
 
-            selection = prompt.select('Are you interested in dependency, or privacy violations?', %w[Dependency Privacy Architecture], default: 'Privacy')
+            selection = prompt.select('Are you interested in dependency, privacy, or layer violations?', %w[Dependency Privacy Layer], default: 'Privacy')
 
             Packs.list_top_violations(
               type: selection.downcase,

packs.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'packs'
-  spec.version       = '0.0.42'
+  spec.version       = '0.0.43'
   spec.authors       = ['Gusto Engineers']
   spec.email         = ['dev@gusto.com']
 
@@ -32,7 +32,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', '>= 0.22.0', '<= 0.23.0'
+  spec.add_dependency 'parse_packwerk', '>= 0.25.0'
   spec.add_dependency 'rainbow'
   spec.add_dependency 'sorbet-runtime'
   spec.add_dependency 'thor'