query_packwerk 0.1.0 → 0.1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69878aa37cf34d0896f727625f444787cf166db630cf8334109eccbd61cc40a9
-  data.tar.gz: ba722634ea12a50ea7473bb976567af174a40e14c5ba9aa0b12d782c8e92b49e
+  metadata.gz: 392d286b38084a21900d3cfe40e81f79f7e6eff5ca872327551589688b309d85
+  data.tar.gz: 5bc5556fbc5279b3d8056757067ec696e362ab2860251cc6cefc403223f89ce6
 SHA512:
-  metadata.gz: ad07eb416e3993dbbe823dd2305afbb86fc52c0e0ec652482a58f0058f60330bc5a16ecb969f9356bcc13eb52a669e58ea094eaf4c9486097fbc7862fd8b671b
-  data.tar.gz: 42115b541cc33e22658978aec000c83ce3d8db9385bcd7671e111c0629537be3dda33bcce9909a5b88d9e9c21a15ecce4af74d948aa2ea96d64583cefbd5c7b2
+  metadata.gz: 5f99589b97b415a4f98d404b5270e368b201353ce0b5107f70f3341b43c9f6590cae133a4cc0cdd6decc6eb1c0d67a373fbef15df439beed841653bcec6ac4a0
+  data.tar.gz: 9ede139265993386cbfbd3e5a9987b00d658865af3d4a3833f0bf41b0d723e84da51c91737b49175a37c52f1668b2671655030ee19a2628e910644416084b7e9

data/.rubocop.yml

@@ -3,7 +3,7 @@ plugins:
   - rubocop-performance
 
 AllCops:
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.3
   SuggestExtensions: false
   NewCops: enable
   Exclude:
@@ -41,9 +41,6 @@ Style/Documentation:
 Style/SignalException:
   Enabled: false
 
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 Style/MultilineBlockChain:
   Enabled: false
 
@@ -86,5 +83,5 @@ Style/SuperArguments:
 Style/ArgumentsForwarding:
   Enabled: false
 
-Style/BlockForwarding:
+Naming/BlockForwarding:
   Enabled: false

data/AGENTS.md

@@ -0,0 +1,30 @@
+This file provides guidance to AI coding agents when working with code in this repository.
+
+## What this project is
+
+`query_packwerk` is a Ruby gem for querying and analyzing [packwerk](https://github.com/Shopify/packwerk) violations and dependencies. It provides a fluent API and an interactive console for exploring `package.yml` and `package_todo.yml` files.
+
+## Commands
+
+```bash
+bundle install
+
+# Run all tests (RSpec)
+bundle exec rspec
+
+# Run a single spec file
+bundle exec rspec spec/path/to/spec.rb
+
+# Lint
+bundle exec rubocop
+bundle exec rubocop -a  # auto-correct
+
+# Type checking (Sorbet)
+bundle exec srb tc
+```
+
+## Architecture
+
+- `lib/query_packwerk.rb` — entry point and public API
+- `lib/query_packwerk/` — query classes for violations, packages, and dependency graphs; also includes an interactive console (REPL) interface
+- `spec/` — RSpec tests

data/CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

data/README.md

@@ -1,68 +1,87 @@
 # QueryPackwerk
 
-QueryPackwerk is a Ruby gem for querying and analyzing Packwerk violations in Ruby applications.
-It provides a friendly API for exploring package.yml and package_todo.yml files, making it easier to manage module boundaries and dependencies in your codebase.
+QueryPackwerk is a Ruby gem for querying and analyzing [Packwerk](https://github.com/Shopify/packwerk) violations in Ruby applications.
+It provides a friendly API for exploring `package.yml` and `package_todo.yml` files, making it easier to manage module boundaries and dependencies in your codebase.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+This gem provides a CLI interface that can be used independently from your application.
 
 ```bash
-bundle add query_packwerk
+gem install query_packwerk
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+You can also make it available in a specific application by adding it to your Gemfile:
 
 ```bash
-gem install query_packwerk
+bundle add query_packwerk --group=development
 ```
 
 ## Usage
 
 ### Console Interface
 
-The easiest way to use QueryPackwerk is through its interactive console:
+The easiest way to use QueryPackwerk is through its interactive console. This will use the local directory Packwerk context and provide you with all QueryPackwerk methods.
 
 ```bash
 query_packwerk console
 ```
 
-This will load the Packwerk context from your current directory and provide you with an interactive Ruby console with QueryPackwerk methods available.
+The CLI includes a welcome message with a list of commands. You can access it any time with `welcome`:
+
+```
+query_packwerk:001:0> welcome
+```
+
+Find packages to work with:
+
+```ruby
+# Get a package
+query_packwerk:001:0> package("pack_name")
+
+# Get all packages
+query_packwerk:001:0> Packages.all
+
+# Find a package
+query_packwerk:001:0> Packages.where(name: /service/)
+```
 
-Available commands in the console:
+Explore violations:
 
 ```ruby
 # Get all violations for a pack
-violations_for("pack_name")
+query_packwerk:001:0> violations_for("pack_name")
 
 # Get where violations occurred
-violation_sources_for("pack_name")
+query_packwerk:001:0> violation_sources_for("pack_name")
 
 # Get how often violations occurred
-violation_counts_for("pack_name")
+query_packwerk:001:0> violation_counts_for("pack_name")
 
 # Get the 'shape' of violations
-anonymous_violation_sources_for("pack_name")
+query_packwerk:001:0> anonymous_violation_sources_for("pack_name")
 
 # Get how often each shape occurs
-anonymous_violation_counts_for("pack_name")
+query_packwerk:001:0> anonymous_violation_counts_for("pack_name")
 
 # Get who consumes this pack
-consumers("pack_name")
-
-# Get all packages
-Packages.all
+query_packwerk:001:0> consumers("pack_name")
 
 # Get all violations
-Violations.all
+query_packwerk:001:0> Violations.all
 
+```
+
+If you change any of the package.yml or package_todo.yml files, you can reload the running console:
+
+```ruby
 # Reset the cache
-reload!
+query_packwerk:001:0> reload!
 ```
 
 ### Ruby API
 
-You can also use QueryPackwerk programmatically in your Ruby code:
+QueryPackwerk can also be used programmatically from Ruby:
 
 ```ruby
 require 'query_packwerk'
@@ -97,11 +116,11 @@ QueryPackwerk.anonymous_violation_counts_for("my_pack", threshold: 3)
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, push a PR with the label for the version you want, like 'major', 'minor' or 'patch'. When the PR is merged, the version will be automatically released to RubyGems.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/martinemde/query_packwerk.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubyatscale/query_packwerk.
 
 ## License
 

data/lib/query_packwerk/cli.rb

@@ -1,4 +1,5 @@
 # typed: strict
+# frozen_string_literal: true
 
 require 'thor'
 

data/lib/query_packwerk/console_helpers.rb

@@ -1,144 +1,148 @@
 # typed: true
+# frozen_string_literal: true
 
-module QueryPackwerk::ConsoleHelpers
-  extend T::Sig
+module QueryPackwerk
+  module ConsoleHelpers
+    extend T::Sig
+    include Kernel
 
-  sig { returns(String) }
-  def inspect
-    'query_packwerk console'
-  end
-
-  sig { returns(NilClass) } # returning nil is less ugly in the console.
-  def welcome
-    help_query_packwerk
-    puts
-    help_help
-  end
+    sig { returns(String) }
+    def inspect
+      'query_packwerk console'
+    end
 
-  sig { params(type: T.nilable(T.any(String, Symbol))).returns(NilClass) }
-  def help(type = nil)
-    case type.to_s.downcase
-    when 'violation'
-      help_violation
-    when 'violations'
-      help_violations
-    when 'package'
-      help_package
-    when 'packages'
-      help_packages
-    when '', 'help'
-      help_help
-    else
-      puts "Unknown help topic: #{type}\n"
+    sig { returns(NilClass) } # returning nil is less ugly in the console.
+    def welcome
+      help_query_packwerk
+      puts
       help_help
     end
-  end
 
-  sig { returns(NilClass) }
-  def help_help
-    puts <<~HELP
-      Available help topics:
-        help            # This help
-        help_violation  # Help for QueryPackwerk::Violation
-        help_violations # Help for QueryPackwerk::Violations
-        help_package    # Help for QueryPackwerk::Package
-        help_packages   # Help for QueryPackwerk::Packages
-    HELP
-  end
+    sig { params(type: T.nilable(T.any(String, Symbol))).returns(NilClass) }
+    def help(type = nil)
+      case type.to_s.downcase
+      when 'violation'
+        help_violation
+      when 'violations'
+        help_violations
+      when 'package'
+        help_package
+      when 'packages'
+        help_packages
+      when '', 'help'
+        help_help
+      else
+        puts "Unknown help topic: #{type}\n"
+        help_help
+      end
+    end
 
-  sig { returns(NilClass) }
-  def help_violation
-    puts <<~HELP
-      QueryPackwerk::Violation (lib/query_packwerk/violation.rb)
-      ------------------------------------------------
-      .type                   # Returns the violation type ('privacy' or 'dependency')
-      .class_name             # Returns the violated constant name
-      .files                  # Returns array of files containing the violation
-      .producing_pack         # Returns the Package that owns the violated constant
-      .consuming_pack         # Returns the Package that violated the constant
-      .sources                # Returns array of AST nodes representing the violation occurrences
-      .sources_with_locations # Returns array of [file:line, source] pairs for each violation
-      .source_counts          # Returns hash of how often each violation source occurs
-      .anonymous_sources      # Returns array of violation sources with arguments anonymized
-      .anonymous_sources_with_locations # Returns array of [file:line, source] pairs for each violation with arguments anonymized
-      .count                  # Returns total number of violation occurrences
-    HELP
-  end
+    sig { returns(NilClass) }
+    def help_help
+      puts <<~HELP
+        Available help topics:
+          help            # This help
+          help_violation  # Help for QueryPackwerk::Violation
+          help_violations # Help for QueryPackwerk::Violations
+          help_package    # Help for QueryPackwerk::Package
+          help_packages   # Help for QueryPackwerk::Packages
+      HELP
+    end
 
-  sig { returns(NilClass) }
-  def help_violations
-    puts <<~HELP
-      QueryPackwerk::Violations (lib/query_packwerk/violations.rb)
-      --------------------------------------------------
-      .where(conditions)      # Returns new Violations filtered by conditions
-      .raw_sources            # Returns hash of constant => AST nodes for all violations
-      .sources                # Returns hash of constant => source strings for all violations
-      .sources_with_locations # Returns hash of constant => [file:line, source] pairs
-      .source_counts          # Returns hash of constant => {source => count} with occurrence counts
-      .sources_with_contexts  # Returns hash of constant => [file:line, source] pairs for each violation with context
-      .anonymous_sources      # Returns hash of constant => anonymized sources
-      .anonymous_sources_with_locations # Returns array of [file:line, source] pairs for each violation with arguments anonymized
-      .consumers(threshold)   # Returns hash of consuming package names and violation counts
-      .producers(threshold)   # Returns hash of producing package names and violation counts
-      .including_files(globs) # Returns new Violations filtered to include specific files
-      .excluding_files(globs) # Returns new Violations filtered to exclude specific files
-    HELP
-  end
+    sig { returns(NilClass) }
+    def help_violation
+      puts <<~HELP
+        QueryPackwerk::Violation (lib/query_packwerk/violation.rb)
+        ------------------------------------------------
+        .type                   # Returns the violation type ('privacy' or 'dependency')
+        .class_name             # Returns the violated constant name
+        .files                  # Returns array of files containing the violation
+        .producing_pack         # Returns the Package that owns the violated constant
+        .consuming_pack         # Returns the Package that violated the constant
+        .sources                # Returns array of AST nodes representing the violation occurrences
+        .sources_with_locations # Returns array of [file:line, source] pairs for each violation
+        .source_counts          # Returns hash of how often each violation source occurs
+        .anonymous_sources      # Returns array of violation sources with arguments anonymized
+        .anonymous_sources_with_locations # Returns array of [file:line, source] pairs for each violation with arguments anonymized
+        .count                  # Returns total number of violation occurrences
+      HELP
+    end
 
-  sig { returns(NilClass) }
-  def help_package
-    puts <<~HELP
-      QueryPackwerk::Package (lib/query_packwerk/package.rb)
-      ----------------------------------------------
-      .name                 # Returns the package name
-      .enforce_dependencies # Returns whether package enforces dependencies
-      .enforce_privacy      # Returns whether package enforces privacy
-      .metadata             # Returns the package metadata from package.yml
-      .config               # Returns the package configuration
-      .dependencies         # Returns Packages collection of dependencies
-      .dependency_names     # Returns array of dependency package names
-      .owner                # Returns the package owner or 'Unowned'
-      .directory            # Returns the package directory path
-      .todos                # Returns Violations where this package is the consumer
-      .violations           # Returns Violations where this package is the producer
-      .consumers            # Returns Packages that consume this package
-      .consumer_names       # Returns array of names of consuming packages
-      .consumer_counts      # Returns hash of consumer package names and counts
-    HELP
-  end
+    sig { returns(NilClass) }
+    def help_violations
+      puts <<~HELP
+        QueryPackwerk::Violations (lib/query_packwerk/violations.rb)
+        --------------------------------------------------
+        .where(conditions)      # Returns new Violations filtered by conditions
+        .raw_sources            # Returns hash of constant => AST nodes for all violations
+        .sources                # Returns hash of constant => source strings for all violations
+        .sources_with_locations # Returns hash of constant => [file:line, source] pairs
+        .source_counts          # Returns hash of constant => {source => count} with occurrence counts
+        .sources_with_contexts  # Returns hash of constant => [file:line, source] pairs for each violation with context
+        .anonymous_sources      # Returns hash of constant => anonymized sources
+        .anonymous_sources_with_locations # Returns array of [file:line, source] pairs for each violation with arguments anonymized
+        .consumers(threshold)   # Returns hash of consuming package names and violation counts
+        .producers(threshold)   # Returns hash of producing package names and violation counts
+        .including_files(globs) # Returns new Violations filtered to include specific files
+        .excluding_files(globs) # Returns new Violations filtered to exclude specific files
+      HELP
+    end
 
-  sig { returns(NilClass) }
-  def help_packages
-    puts <<~HELP
-      QueryPackwerk::Packages (lib/query_packwerk/packages.rb)
-      ------------------------------------------------
-      .all                  # Returns all packages in the application
-      .where(conditions)    # Returns new Packages filtered by conditions
-      .violations           # Returns Violations for all packages in collection
-    HELP
-  end
+    sig { returns(NilClass) }
+    def help_package
+      puts <<~HELP
+        QueryPackwerk::Package (lib/query_packwerk/package.rb)
+        ----------------------------------------------
+        .name                 # Returns the package name
+        .enforce_dependencies # Returns whether package enforces dependencies
+        .enforce_privacy      # Returns whether package enforces privacy
+        .metadata             # Returns the package metadata from package.yml
+        .config               # Returns the package configuration
+        .dependencies         # Returns Packages collection of dependencies
+        .dependency_names     # Returns array of dependency package names
+        .owner                # Returns the package owner or 'Unowned'
+        .directory            # Returns the package directory path
+        .todos                # Returns Violations where this package is the consumer
+        .violations           # Returns Violations where this package is the producer
+        .consumers            # Returns Packages that consume this package
+        .consumer_names       # Returns array of names of consuming packages
+        .consumer_counts      # Returns hash of consumer package names and counts
+      HELP
+    end
+
+    sig { returns(NilClass) }
+    def help_packages
+      puts <<~HELP
+        QueryPackwerk::Packages (lib/query_packwerk/packages.rb)
+        ------------------------------------------------
+        .all                  # Returns all packages in the application
+        .where(conditions)    # Returns new Packages filtered by conditions
+        .violations           # Returns Violations for all packages in collection
+      HELP
+    end
 
-  sig { returns(NilClass) }
-  def help_query_packwerk
-    puts <<~HELP
-      QueryPackwerk (lib/query_packwerk.rb)
-      ------------------------------
-      Available commands:
-        package(pack_name)                         # Get a package by name
-        Packages.all                               # Get all packages
+    sig { returns(NilClass) }
+    def help_query_packwerk
+      puts <<~HELP
+        QueryPackwerk (lib/query_packwerk.rb)
+        ------------------------------
+        Available commands:
+          package(pack_name)                         # Get a package by name
+          Packages.all                               # Get all packages
 
-      Package Consumption (how others use this package):
-        violations_for(pack_name)                  # Get all violations where others access this package
-        violation_sources_for(pack_name)           # Get where others access this package
-        violation_counts_for(pack_name)            # Get how often others access this package
-        anonymous_violation_sources_for(pack_name) # Get the 'shape' of how others access this package
-        anonymous_violation_counts_for(pack_name)  # Get how often each access pattern occurs
-        consumers(pack_name)                       # Get which packages consume this package
+        Package Consumption (how others use this package):
+          violations_for(pack_name)                  # Get all violations where others access this package
+          violation_sources_for(pack_name)           # Get where others access this package
+          violation_counts_for(pack_name)            # Get how often others access this package
+          anonymous_violation_sources_for(pack_name) # Get the 'shape' of how others access this package
+          anonymous_violation_counts_for(pack_name)  # Get how often each access pattern occurs
+          consumers(pack_name)                       # Get which packages consume this package
 
-      Package Dependencies (how this package uses others):
-        todos_for(pack_name)                       # Get all todos where this package accesses others
+        Package Dependencies (how this package uses others):
+          todos_for(pack_name)                       # Get all todos where this package accesses others
 
-      Violations.all                               # Get all violations
-    HELP
+        Violations.all                               # Get all violations
+      HELP
+    end
   end
 end

data/lib/query_packwerk/file_cache.rb

@@ -74,7 +74,7 @@ module QueryPackwerk
                                  end
     end
 
-    # Get all occurrencs of the violation's constant in a file
+    # Get all occurrences of the violation's constant in a file
     sig { params(file_name: String, class_name: String).returns(T::Array[RuboCop::AST::Node]) }
     def get_all_const_occurrences(file_name:, class_name:)
       const_key = [file_name, class_name]
@@ -139,8 +139,8 @@ module QueryPackwerk
       RuboCop::ProcessedSource.new(string, RUBY_VERSION.to_f).ast
     end
 
-    # We can find a constant, but by going up its parents we can find out the full call chain
-    # by checking if each parent is a receiver of the child, giving us method calls and
+    # We can find a constant, but by going up its parents we can find the full call chain.
+    # We check if each parent is a receiver of the child, giving us method calls and
     # arguments on a constant as well as where it occurred.
     sig { params(node: RuboCop::AST::Node).returns(RuboCop::AST::Node) }
     def get_full_receiver_chain(node)

data/lib/query_packwerk/package.rb

@@ -21,13 +21,15 @@ module QueryPackwerk
       @original_package.name
     end
 
+    # Mirrors packwerk's public API naming, so it can't take a `?` suffix.
     sig { returns(T::Boolean) }
-    def enforce_dependencies
+    def enforce_dependencies # rubocop:disable Naming/PredicateMethod
       !!@original_package.enforce_dependencies
     end
 
+    # Mirrors packwerk's public API naming, so it can't take a `?` suffix.
     sig { returns(T::Boolean) }
-    def enforce_privacy
+    def enforce_privacy # rubocop:disable Naming/PredicateMethod
       !!@original_package.enforce_privacy
     end
 

data/lib/query_packwerk/packages.rb

@@ -56,6 +56,24 @@ module QueryPackwerk
       @original_collection = original_collection
     end
 
+    sig { returns(T::Boolean) }
+    def empty?
+      @original_collection.empty?
+    end
+
+    sig do
+      params(
+        blk: T.nilable(T.proc.params(arg0: QueryPackwerk::Package).returns(T::Boolean))
+      ).returns(T::Boolean)
+    end
+    def any?(&blk)
+      if blk.nil?
+        !empty?
+      else
+        @original_collection.any?(&blk)
+      end
+    end
+
     # You can query for packages rather than violations to get a broader view, and
     # the violations returned from this will be related to all packs in this class rather than just
     # one.
@@ -68,11 +86,12 @@ module QueryPackwerk
 
     sig { returns(String) }
     def inspect
-      [
-        "#<#{self.class.name} [",
-        to_a.map(&:inspect).join("\n"),
-        ']>'
-      ].join("\n")
+      arr = to_a.map(&:inspect)
+      if arr.empty?
+        "#<#{self.class.name} []>"
+      else
+        "#<#{self.class.name} [\n#{arr.join("\n")}\n]>"
+      end
     end
   end
 end

data/lib/query_packwerk/query_interface.rb

@@ -36,8 +36,6 @@ module QueryPackwerk
     end
 
     # Should be overridden, the base of most of the queries.
-    #
-    # TODO: Consider refactoring to `abstract` interface
     sig { overridable.returns(T::Array[T.untyped]) }
     def original_collection
       []
@@ -127,7 +125,7 @@ module QueryPackwerk
           end
         end
       end
-      # Similar to the above `original_collection` we want to override this by defining
+      # Similar to the above `original_collection`, we want to override this by defining
       # where the InheritingClass can find all of its raw data.
       #
       # Sorbet does not recognize `included(klass)`/`klass.extend(ClassMethods)` when

data/lib/query_packwerk/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module QueryPackwerk
-  VERSION = '0.1.0'
+  VERSION = '0.1.24'
 end

data/lib/query_packwerk/violation.rb

@@ -88,7 +88,7 @@ module QueryPackwerk
 
     # Whether or not the files containing violations match any provided globs
     #
-    # See also: https://ruby-doc.org/core-2.7.6/File.html#method-c-fnmatch
+    # See Ruby documentation for File.fnmatch for more details.
     sig { params(globs: T.any(String, Regexp)).returns(T::Boolean) }
     def includes_files?(*globs)
       globs.any? do |glob|
@@ -188,7 +188,7 @@ module QueryPackwerk
       end
     end
 
-    # Like above frequency of sources, except by method "shape" rather than
+    # Like the above source frequency, except grouped by method "shape" rather than
     # exact arguments
     sig { returns(T::Hash[String, Integer]) }
     def anonymous_source_counts
@@ -272,9 +272,6 @@ module QueryPackwerk
         **runtime_keys(keys)
       }
 
-      # all_values[:is_active_record] = active_record? if !keys || keys.include?(:is_active_record)
-      # all_values[:is_constant] = active_record? if !keys || keys.include?(:is_constant)
-
       keys.nil? ? all_values : all_values.slice(*T.unsafe(keys))
     end
 

data/lib/query_packwerk/violations.rb

@@ -121,6 +121,16 @@ module QueryPackwerk
       @original_collection.sum(&:file_count)
     end
 
+    sig { returns(T::Boolean) }
+    def empty?
+      @original_collection.empty?
+    end
+
+    sig { returns(T::Boolean) }
+    def any?
+      !empty?
+    end
+
     # Gets all sources and their receiving chains grouped by the constant they've violated.
     sig { returns(T.untyped) }
     def raw_sources
@@ -148,8 +158,8 @@ module QueryPackwerk
       deep_merge_groups(@original_collection) { |v| [v.class_name, v.sources_with_locations] }
     end
 
-    # Instead of getting all instances of the source, count how often each occurs, with the option to
-    # provide a threshold to remove lower-occuring items.
+    # Instead of returning all instances of the source, count how often each occurs, with the option to
+    # provide a threshold to remove lower-occurring items.
     sig { params(threshold: Integer).returns(T::Hash[String, T::Hash[String, Integer]]) }
     def source_counts(threshold: 0)
       load_sources!
@@ -253,11 +263,12 @@ module QueryPackwerk
 
     sig { returns(String) }
     def inspect
-      [
-        "#<#{self.class.name} [",
-        to_a.map(&:inspect).join("\n"),
-        ']>'
-      ].join("\n")
+      arr = to_a.map(&:inspect)
+      if arr.empty?
+        "#<#{self.class.name} []>"
+      else
+        "#<#{self.class.name} [\n#{arr.join("\n")}\n]>"
+      end
     end
 
     private

data/lib/query_packwerk.rb

@@ -5,12 +5,12 @@ require 'sorbet-runtime'
 require 'parse_packwerk'
 require 'rubocop'
 
-#
 # QueryPackwerk is a tool for querying Packwerk violations.
 #
 # It is built on top of ParsePackwerk, and provides a Ruby-friendly API
 # for querying package.yml and package_todo.yml files.
 #
+# See also: https://github.com/rubyatscale/parse_packwerk
 module QueryPackwerk
   autoload :Console, 'query_packwerk/console'
   autoload :ConsoleHelpers, 'query_packwerk/console_helpers'
@@ -24,8 +24,8 @@ module QueryPackwerk
   autoload :Version, 'query_packwerk/version'
 
   extend T::Sig
-  # TODO: module_function isn't playing nicely with Sorbet
-  extend self # rubocop:todo Style/ModuleFunction
+
+  module_function
 
   sig { params(name: String).returns(T.nilable(QueryPackwerk::Package)) }
   def package(name)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: query_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.24
 platform: ruby
 authors:
 - Gusto Engineering
 bindir: exe
 cert_chain: []
-date: 2025-03-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
@@ -103,7 +103,9 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- AGENTS.md
 - CHANGELOG.md
+- CLAUDE.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
@@ -124,15 +126,14 @@ files:
 - lib/query_packwerk/version.rb
 - lib/query_packwerk/violation.rb
 - lib/query_packwerk/violations.rb
-- sig/query_packwerk.rbs
-homepage: https://github.com/gusto/query_packwerk
+homepage: https://github.com/rubyatscale/query_packwerk
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/gusto/query_packwerk
-  source_code_uri: https://github.com/gusto/query_packwerk
-  changelog_uri: https://github.com/gusto/query_packwerk/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/rubyatscale/query_packwerk
+  source_code_uri: https://github.com/rubyatscale/query_packwerk
+  changelog_uri: https://github.com/rubyatscale/query_packwerk/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -140,14 +141,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Query Packwerk
 test_files: []

data/sig/query_packwerk.rbs

@@ -1,4 +0,0 @@
-module QueryPackwerk
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end