packs 0.0.22 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfd963aed9035b204092449d956a985ebdd62eec89bd32d522b2a8ca7a82ad74
-  data.tar.gz: 7a4e8471530a3847b42f9b1bd3f8523fa920e3b2e3f6c83036279d25ff9173b2
+  metadata.gz: e9fe9bf45b169182149107b9617affd7f2b678c23568d040f16a4bcb6dfd1b1f
+  data.tar.gz: ade3de604d5b0a7fb3b25770eb08dce6a953028f32c66008882b80c16e4a9006
 SHA512:
-  metadata.gz: 23442ca91f171f85f9b2d523cc91bd34ace4186dbbb8b6f92f57ca896c473c3bcc0556c27a2e869d55285ff8c40e72df4a019af678c2f60a674af6230dae5d1a
-  data.tar.gz: 8754d2368251ab1ec8073191e38791dffd6c79f07c6a8eaaa49cd69d6dae0b99def340fde2c050140fdce8017612d2266d22b13b81ddafa8cbe6f67192cbeb7a
+  metadata.gz: 30171b07e4b4ad796dfdd0cd1ca4425bae6f974e75cf7a70e3f2c46ad296117d5002a29303830f033913d34be90e894d5dc21230cf5cec3a64c9bc8d7af5a370
+  data.tar.gz: 3ea267d582ea488d4f425321f2e111c0b9adeca1b092649ccb82f88314fe8572b7a4f922936822dc84a9ad8c3c39adbe57c7a60b6dd0b7bdbe76502da7a8b795

data/README.md

@@ -1,9 +1,36 @@
-# Packs
+# packs
 
-Packs is a gem that helps in creating and maintaining packs. It exists to help perform some basic operations needed for pack setup and configuration. It provides a basic ruby file packager utility for [`packwerk`](https://github.com/Shopify/packwerk/). It assumes you are using [`packs-rails`](https://github.com/rubyatscale/packs-rails) to organize your packages.
+`packs` are a specification for an extensible packaging system to help modularize Ruby applications.
+
+A `pack` (short for `package`) is a folder of Ruby code with a `package.yml` at the root that is intended to represent a well-modularized domain.
+
+This gem provides a development CLI, `bin/packs`, to make using `packs` easier.
+
+# Configuration
+By default, this library will look for `packs` in the folder `packs/*/package.yml` (as well as nested packs at `packs/*/*/package.yml`). To change where `packs` are located, create a `packs.yml` file:
+```yml
+pack_paths:
+  - "{packs,utilities,deprecated}/*" # packs with multiple roots!
+  - "{packs,utilities,deprecated}/*/*" # nested packs!
+  - gems/* # gems can be packs too!
+```
+
+# Ecosystem
+The rest of the [rubyatscale](https://github.com/rubyatscale) ecosystem is intended to help make using packs and improving the boundaries between them more clear.
+
+Here are some example integrations with `packs`:
+- [`packs-specification`](https://github.com/rubyatscale/packs-specification) is a low-dependency gem that allows your production environment to query simple information about packs
+- [`packs-rails`](https://github.com/rubyatscale/packs-rails) can be used to integrate `packs` into your `rails` application
+- [`rubocop-packs`](https://github.com/rubyatscale/rubocop-packs) contains cops to improve boundaries around `packs` 
+- [`packwerk`](https://github.com/Shopify/packwerk) and [`packwerk-extensions`](https://github.com/rubyatscale/packwerk-extensions) help you describe and constrain your package graph in terms of dependencies between packs and pack public API
+- [`code_ownership`](https://github.com/rubyatscale/code_ownership) gives your application the capability to determine the owner of a pack
+- [`pack_stats`](https://github.com/rubyatscale/pack_stats) makes it easy to send metrics about pack adoption and modularization to your favorite metrics provider, such as DataDog (which has built-in support).
+
+# How is a pack different from a gem?
+A ruby [`gem`](https://guides.rubygems.org/what-is-a-gem/) is the Ruby community solution for packaging and distributing Ruby code. A gem is a great place to start new projects, and a great end state for code that's been extracted from an existing codebase. `packs` are intended to help gradually modularize an application that has some conceptual boundaries, but is not yet ready to be factored into gems.
 
 ## Usage
-Make sure to run `bundle binstub use_packs` to generate `bin/packs` within your application.
+Make sure to run `bundle binstub packs` to generate `bin/packs` within your application.
 
 ## CLI Documentation
 ## Describe available commands or one specific command
@@ -90,16 +117,16 @@ Releases happen automatically through github actions once a version update is co
 To keep things organized, here are some recommended homes:
 
 ### Issues:
-https://github.com/rubyatscale/use_packs/issues
+https://github.com/rubyatscale/packs/issues
 
 ### Questions:
-https://github.com/rubyatscale/use_packs/discussions/categories/q-a
+https://github.com/rubyatscale/packs/discussions/categories/q-a
 
 ### General discussions:
-https://github.com/rubyatscale/use_packs/discussions/categories/general
+https://github.com/rubyatscale/packs/discussions/categories/general
 
 ### Ideas, new features, requests for change:
-https://github.com/rubyatscale/use_packs/discussions/categories/ideas
+https://github.com/rubyatscale/packs/discussions/categories/ideas
 
 ### Showcasing your work:
-https://github.com/rubyatscale/use_packs/discussions/categories/show-and-tell
+https://github.com/rubyatscale/packs/discussions/categories/show-and-tell

data/lib/packs/cli.rb

@@ -10,6 +10,7 @@ module Packs
     sig { params(pack_name: String).void }
     def create(pack_name)
       Packs.create_pack!(pack_name: pack_name)
+      exit_successfully
     end
 
     desc 'add_dependency packs/from_pack packs/to_pack', 'Add packs/to_pack to packs/from_pack/package.yml list of dependencies'
@@ -27,6 +28,7 @@ module Packs
         pack_name: from_pack,
         dependency_name: to_pack
       )
+      exit_successfully
     end
 
     desc 'list_top_dependency_violations packs/your_pack', 'List the top dependency violations of packs/your_pack'
@@ -44,6 +46,7 @@ module Packs
         pack_name: pack_name,
         limit: options[:limit]
       )
+      exit_successfully
     end
 
     desc 'list_top_privacy_violations packs/your_pack', 'List the top privacy violations of packs/your_pack'
@@ -61,6 +64,7 @@ module Packs
         pack_name: pack_name,
         limit: options[:limit]
       )
+      exit_successfully
     end
 
     desc 'make_public path/to/file.rb path/to/directory', 'Make files or directories public API'
@@ -75,6 +79,7 @@ module Packs
         paths_relative_to_root: paths,
         per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new]
       )
+      exit_successfully
     end
 
     desc 'move packs/destination_pack path/to/file.rb path/to/directory', 'Move files or directories from one pack to another'
@@ -91,6 +96,7 @@ module Packs
         paths_relative_to_root: paths,
         per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new]
       )
+      exit_successfully
     end
 
     desc 'lint_package_todo_yml_files', 'Lint `package_todo.yml` files to check for formatting issues'
@@ -108,37 +114,40 @@ module Packs
     desc 'validate', 'Run bin/packwerk validate (detects cycles)'
     sig { void }
     def validate
-      system('bin/packwerk validate')
+      Private.exit_with(Packs.validate)
     end
 
     desc 'check [ packs/my_pack ]', 'Run bin/packwerk check'
     sig { params(paths: String).void }
     def check(*paths)
-      Packs.execute(['check', *paths])
+      Private.exit_with(Packs.check(paths))
     end
 
     desc 'update', 'Run bin/packwerk update-todo'
     sig { void }
     def update
-      system('bin/packwerk update-todo')
+      Private.exit_with(Packs.update)
     end
 
     desc 'get_info [ packs/my_pack packs/my_other_pack ]', 'Get info about size and violations for packs'
     sig { params(pack_names: String).void }
     def get_info(*pack_names)
       Private.get_info(packs: parse_pack_names(pack_names))
+      exit_successfully
     end
 
     desc 'visualize [ packs/my_pack packs/my_other_pack ]', 'Visualize packs'
     sig { params(pack_names: String).void }
     def visualize(*pack_names)
       Private.visualize(packs: parse_pack_names(pack_names))
+      exit_successfully
     end
 
     desc 'rename', 'Rename a pack'
     sig { void }
     def rename
       puts Private.rename_pack
+      exit_successfully
     end
 
     desc 'move_to_parent packs/child_pack packs/parent_pack ', 'Set packs/child_pack as a child of packs/parent_pack'
@@ -149,6 +158,7 @@ module Packs
         pack_name: child_pack_name,
         per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new]
       )
+      exit_successfully
     end
 
     private
@@ -159,6 +169,11 @@ module Packs
       def parse_pack_names(pack_names)
         pack_names.empty? ? Packs.all : pack_names.map { |p| Packs.find(p.gsub(%r{/$}, '')) }.compact
       end
+
+      sig { void }
+      def exit_successfully
+        Private.exit_with(true)
+      end
     end
   end
 end

data/lib/packs/private/interactive_cli/use_cases/check.rb

@@ -16,7 +16,7 @@ module Packs
 
           sig { override.params(prompt: TTY::Prompt).void }
           def perform!(prompt)
-            system('bin/packwerk check')
+            Private.exit_with(Packs.check([]))
           end
         end
       end

data/lib/packs/private/interactive_cli/use_cases/interface.rb

@@ -10,9 +10,9 @@ module Packs
 
           interface!
 
-          sig { params(base: Class).void }
+          sig { params(base: T::Class[T.anything]).void }
           def self.included(base)
-            @use_cases ||= T.let(@use_cases, T.nilable(T::Array[Class]))
+            @use_cases ||= T.let(@use_cases, T.nilable(T::Array[T::Class[T.anything]]))
             @use_cases ||= []
             @use_cases << base
           end

data/lib/packs/private/interactive_cli/use_cases/update.rb

@@ -16,7 +16,7 @@ module Packs
 
           sig { override.params(prompt: TTY::Prompt).void }
           def perform!(prompt)
-            system('bin/packwerk update')
+            Private.exit_with(Packs.update)
           end
         end
       end

data/lib/packs/private/interactive_cli/use_cases/validate.rb

@@ -16,7 +16,7 @@ module Packs
 
           sig { override.params(prompt: TTY::Prompt).void }
           def perform!(prompt)
-            system('bin/packwerk validate')
+            Private.exit_with(Packs.validate)
           end
         end
       end

data/lib/packs/private.rb

@@ -8,7 +8,6 @@ require 'sorbet-runtime'
 require 'packs/private/file_move_operation'
 require 'packs/private/pack_relationship_analyzer'
 require 'packs/private/interactive_cli'
-require 'packs/private/packwerk_wrapper'
 
 module Packs
   module Private
@@ -295,7 +294,7 @@ module Packs
         config: package.config
       )
       ParsePackwerk.write_package_yml!(new_package)
-      PackwerkWrapper.validate!
+      Packs.validate
     end
 
     sig { params(file_move_operation: FileMoveOperation, per_file_processors: T::Array[Packs::PerFileProcessorInterface]).void }
@@ -404,7 +403,7 @@ module Packs
       return if @loaded_client_configuration
 
       @loaded_client_configuration = true
-      client_configuration = Pathname.pwd.join('config/use_packs.rb')
+      client_configuration = Pathname.pwd.join('config/packs.rb')
       require client_configuration.to_s if client_configuration.exist?
     end
 
@@ -523,13 +522,13 @@ module Packs
     sig { void }
     def self.lint_package_todo_yml_files!
       contents_before = Private.get_package_todo_contents
-      Packs.execute(['update-todo'])
+      Packs.update
       contents_after = Private.get_package_todo_contents
       diff = Private.diff_package_todo_yml(contents_before, contents_after)
 
       if diff == ''
         # No diff generated by `update-todo`
-        safe_exit 0
+        exit_with true
       else
         output = <<~OUTPUT
           All `package_todo.yml` files must be up-to-date and that no diff is generated when running `bin/packwerk update-todo`.
@@ -551,7 +550,7 @@ module Packs
 
         puts output
         Packs.config.on_package_todo_lint_failure.call(output)
-        safe_exit 1
+        exit_with false
       end
     end
 
@@ -608,10 +607,16 @@ module Packs
     end
 
     # This function exists to give us something to stub in test
-    sig { params(code: Integer).void }
-    def self.safe_exit(code)
+    sig { params(code: T::Boolean).void }
+    def self.exit_with(code)
       exit code
     end
+
+    # This function exists to give us something to stub in test
+    sig { params(command: String).returns(T::Boolean) }
+    def self.system_with(command)
+      T.cast(system(command), T::Boolean)
+    end
   end
 
   private_constant :Private

data/lib/packs/user_event_logger.rb

@@ -193,7 +193,7 @@ module Packs
 
     sig { returns(String) }
     def documentation_link
-      'https://github.com/rubyatscale/use_packs#readme'
+      'https://github.com/rubyatscale/packs#readme'
     end
   end
 end

data/lib/packs.rb

@@ -36,6 +36,21 @@ module Packs
     Private::InteractiveCli.start!
   end
 
+  sig { returns(T::Boolean) }
+  def self.update
+    Private.system_with('bin/packwerk update-todo')
+  end
+
+  sig { returns(T::Boolean) }
+  def self.validate
+    Private.system_with('bin/packwerk validate')
+  end
+
+  sig { params(files: T::Array[String]).returns(T::Boolean) }
+  def self.check(files)
+    Private.system_with("bin/packwerk check #{files.join(' ')}")
+  end
+
   sig do
     params(
       pack_name: String,
@@ -222,32 +237,6 @@ module Packs
     Specification.bust_cache!
   end
 
-  #
-  # execute_command is like `run` except it does not `exit`
-  #
-  sig { params(argv: T.untyped, formatter: T.nilable(Packwerk::OffensesFormatter)).void }
-  def self.execute(argv, formatter = nil)
-    Private::PackwerkWrapper.with_safe_exit_if_no_files_found do
-      Private::PackwerkWrapper.packwerk_cli(formatter).execute_command(argv)
-    end
-  end
-
-  sig { params(files: T::Array[String]).returns(T::Array[Packwerk::ReferenceOffense]) }
-  def self.get_offenses_for_files(files)
-    formatter = Private::PackwerkWrapper::OffensesAggregatorFormatter.new
-    Private::PackwerkWrapper.packwerk_cli_execute_safely(['check', *files], formatter)
-    formatter.aggregated_offenses.compact
-  end
-
-  sig { params(files: T::Array[String]).returns(T::Array[Packwerk::ReferenceOffense]) }
-  def self.get_offenses_for_files_by_package(files)
-    packages = Private::PackwerkWrapper.package_names_for_files(files)
-    argv = ['check', '--packages', packages.join(',')]
-    formatter = Private::PackwerkWrapper::OffensesAggregatorFormatter.new
-    Private::PackwerkWrapper.packwerk_cli_execute_safely(argv, formatter)
-    formatter.aggregated_offenses.compact
-  end
-
   sig { void }
   def self.lint_package_todo_yml_files!
     Private.lint_package_todo_yml_files!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packs
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.24
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-10 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership
@@ -276,6 +276,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: spoom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: tapioca
   requirement: !ruby/object:Gem::Requirement
@@ -331,7 +345,6 @@ files:
 - lib/packs/private/interactive_cli/use_cases/validate.rb
 - lib/packs/private/interactive_cli/use_cases/visualize.rb
 - lib/packs/private/pack_relationship_analyzer.rb
-- lib/packs/private/packwerk_wrapper.rb
 - lib/packs/private/packwerk_wrapper/offenses_aggregator_formatter.rb
 - lib/packs/rubocop_post_processor.rb
 - lib/packs/user_event_logger.rb

data/lib/packs/private/packwerk_wrapper.rb

@@ -1,70 +0,0 @@
-# typed: strict
-
-require 'packwerk'
-require 'packs/private/packwerk_wrapper/offenses_aggregator_formatter'
-
-module Packs
-  module Private
-    module PackwerkWrapper
-      extend T::Sig
-
-      #
-      # execute_command is like `run` except it does not `exit`
-      #
-      sig { params(argv: T.untyped, formatter: T.nilable(Packwerk::OffensesFormatter)).void }
-      def self.packwerk_cli_execute_safely(argv, formatter = nil)
-        with_safe_exit_if_no_files_found do
-          packwerk_cli(formatter).execute_command(argv)
-        end
-      end
-
-      sig { params(block: T.proc.returns(T.untyped)).void }
-      def self.with_safe_exit_if_no_files_found(&block)
-        block.call
-      rescue SystemExit => e
-        # Packwerk should probably exit positively here rather than raising an error -- there should be no
-        # errors if the user has excluded all files being checked.
-        unless e.message == 'No files found or given. Specify files or check the include and exclude glob in the config file.'
-          raise
-        end
-      end
-
-      sig { params(formatter: T.nilable(Packwerk::OffensesFormatter)).returns(Packwerk::Cli) }
-      def self.packwerk_cli(formatter)
-        # This is mostly copied from exe/packwerk within the packwerk gem, but we use our own formatters
-        # Note that packwerk does not allow you to pass in your own progress formatter currently
-        ENV['RAILS_ENV'] = 'test'
-
-        style = Packwerk::OutputStyles::Coloured.new
-        Packwerk::Cli.new(style: style, offenses_formatter: formatter)
-      end
-
-      sig { params(files: T::Array[String]).returns(T::Array[Packwerk::ReferenceOffense]) }
-      def self.get_offenses_for_files(files)
-        formatter = OffensesAggregatorFormatter.new
-        packwerk_cli_execute_safely(['check', *files], formatter)
-        formatter.aggregated_offenses.compact
-      end
-
-      sig { void }
-      def self.validate!
-        formatter = OffensesAggregatorFormatter.new
-        packwerk_cli_execute_safely(['validate'], formatter)
-      end
-
-      sig { params(files: T::Array[String]).returns(T::Array[Packwerk::ReferenceOffense]) }
-      def self.get_offenses_for_files_by_package(files)
-        packages = package_names_for_files(files)
-        argv = ['check', '--packages', packages.join(',')]
-        formatter = OffensesAggregatorFormatter.new
-        packwerk_cli_execute_safely(argv, formatter)
-        formatter.aggregated_offenses.compact
-      end
-
-      sig { params(files: T::Array[String]).returns(T::Array[String]) }
-      def self.package_names_for_files(files)
-        files.map { |f| ParsePackwerk.package_from_path(f).name }.compact.uniq
-      end
-    end
-  end
-end