query_packwerk 0.1.0

data/lib/query_packwerk.rb

@@ -0,0 +1,92 @@
+# typed: strict
+# frozen_string_literal: true
+
+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.
+#
+module QueryPackwerk
+  autoload :Console, 'query_packwerk/console'
+  autoload :ConsoleHelpers, 'query_packwerk/console_helpers'
+  autoload :QueryInterface, 'query_packwerk/query_interface'
+  autoload :Violations, 'query_packwerk/violations'
+  autoload :Violation, 'query_packwerk/violation'
+  autoload :Packages, 'query_packwerk/packages'
+  autoload :Package, 'query_packwerk/package'
+  autoload :RuleRewriter, 'query_packwerk/rule_rewriter'
+  autoload :FileCache, 'query_packwerk/file_cache'
+  autoload :Version, 'query_packwerk/version'
+
+  extend T::Sig
+  # TODO: module_function isn't playing nicely with Sorbet
+  extend self # rubocop:todo Style/ModuleFunction
+
+  sig { params(name: String).returns(T.nilable(QueryPackwerk::Package)) }
+  def package(name)
+    Packages.where(name: name).first
+  end
+
+  # Get all violations where other packages access code from this package
+  # (i.e., this package is the producer, others are consumers)
+  sig { params(pack_name: String).returns(QueryPackwerk::Violations) }
+  def violations_for(pack_name)
+    QueryPackwerk::Violations.where(producing_pack: full_name(pack_name))
+  end
+
+  # Get all todos where this package accesses code from other packages
+  # (i.e., this package is the consumer, others are producers)
+  sig { params(pack_name: String).returns(QueryPackwerk::Violations) }
+  def todos_for(pack_name)
+    QueryPackwerk::Violations.where(consuming_pack: full_name(pack_name))
+  end
+
+  # Get where the violations occurred (where other packages access this package)
+  sig { params(pack_name: String).returns(T::Hash[String, T::Array[String]]) }
+  def violation_sources_for(pack_name)
+    violations_for(pack_name).sources_with_locations
+  end
+
+  # Get how often the violations occurred
+  sig { params(pack_name: String, threshold: Integer).returns(T::Hash[String, T::Hash[String, Integer]]) }
+  def violation_counts_for(pack_name, threshold: 0)
+    violations_for(pack_name).source_counts(threshold: threshold)
+  end
+
+  # Get the 'shape' of all violations (how other packages access this package)
+  sig { params(pack_name: String).returns(T::Hash[String, T::Array[String]]) }
+  def anonymous_violation_sources_for(pack_name)
+    violations_for(pack_name).anonymous_sources
+  end
+
+  # Get how often each 'shape' of violation occurs (counts of how other packages access this package)
+  sig { params(pack_name: String, threshold: Integer).returns(T::Hash[String, T::Hash[String, Integer]]) }
+  def anonymous_violation_counts_for(pack_name, threshold: 0)
+    violations_for(pack_name).anonymous_source_counts(threshold: threshold)
+  end
+
+  # Get which packages consume code from this package (who depends on this package)
+  sig { params(pack_name: String, threshold: Integer).returns(T::Hash[String, Integer]) }
+  def consumers(pack_name, threshold: 0)
+    violations_for(pack_name).consumers(threshold: threshold)
+  end
+
+  # In case anyone is still using shorthand for pack names
+  sig { params(pack_name: String).returns(String) }
+  def full_name(pack_name)
+    return pack_name if pack_name.match?(%r{\A(packs|components)/})
+
+    "packs/#{pack_name}"
+  end
+
+  sig { void }
+  def reload!
+    Packages.reload!
+    Violations.reload!
+  end
+end

data/sig/query_packwerk.rbs

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

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: query_packwerk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gusto Engineering
+bindir: exe
+cert_chain: []
+date: 2025-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: packwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parse_packwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Query Packwerk violations and dependencies.
+email:
+- dev@gusto.com
+executables:
+- query_packwerk
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- exe/query_packwerk
+- lib/query_packwerk.rb
+- lib/query_packwerk/cli.rb
+- lib/query_packwerk/console.rb
+- lib/query_packwerk/console_helpers.rb
+- lib/query_packwerk/file_cache.rb
+- lib/query_packwerk/package.rb
+- lib/query_packwerk/packages.rb
+- lib/query_packwerk/query_interface.rb
+- lib/query_packwerk/rule_rewriter.rb
+- lib/query_packwerk/rule_rewriter/anonymize_arguments_rule.rb
+- lib/query_packwerk/rule_rewriter/anonymize_keyword_arguments_rule.rb
+- lib/query_packwerk/rule_rewriter/base_rule.rb
+- lib/query_packwerk/rule_rewriter/rule_set_rewriter.rb
+- 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
+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
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Query Packwerk
+test_files: []