query_packwerk 0.1.24 → 0.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 392d286b38084a21900d3cfe40e81f79f7e6eff5ca872327551589688b309d85
-  data.tar.gz: 5bc5556fbc5279b3d8056757067ec696e362ab2860251cc6cefc403223f89ce6
+  metadata.gz: 98b9a4d914a8be019fa0b1795cd527ac2bfd4ce7931b1e5a204704b5bb503847
+  data.tar.gz: 209fa3baaa03c0687daca480890ff32ec6c2111c1c902c3088771614d4127c53
 SHA512:
-  metadata.gz: 5f99589b97b415a4f98d404b5270e368b201353ce0b5107f70f3341b43c9f6590cae133a4cc0cdd6decc6eb1c0d67a373fbef15df439beed841653bcec6ac4a0
-  data.tar.gz: 9ede139265993386cbfbd3e5a9987b00d658865af3d4a3833f0bf41b0d723e84da51c91737b49175a37c52f1668b2671655030ee19a2628e910644416084b7e9
+  metadata.gz: 406b5e9039a31dda4264391d1287fa89684dc21a982521c212734c05055e727ecaea62b9ed234e296a151587fd9cbaee5dd99915573f5ccb90429509f12de046
+  data.tar.gz: e11dfd82ec7324d499e37c0214d7b12ad735d03732f996bcd8e8397f36f684fd99ff6e3b58fa73a1adbc63f7e87d4be455e62814bb690e51cca0d27d7d8d22dc

data/README.md

@@ -27,6 +27,14 @@ The easiest way to use QueryPackwerk is through its interactive console. This wi
 query_packwerk console
 ```
 
+To use the Packwerk context of another directory, pass it as an argument:
+
+```bash
+query_packwerk console path/to/app
+```
+
+Run `query_packwerk console --help` for usage details.
+
 The CLI includes a welcome message with a list of commands. You can access it any time with `welcome`:
 
 ```
@@ -116,7 +124,7 @@ 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, 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.
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, bump `VERSION` in `lib/query_packwerk/version.rb` in your PR and run `bundle install` so `Gemfile.lock` matches. When the PR is merged and CI passes on `main`, the gem is tagged and published to RubyGems automatically. Merges that don't change the version don't publish anything.
 
 ## Contributing
 

data/lib/query_packwerk/cli.rb

@@ -8,12 +8,24 @@ module QueryPackwerk
   class CLI < Thor
     extend T::Sig
 
+    # Thor maps --help to its help command only as the first argument, so commands check options[:help].
+    class_option :help, type: :boolean, aliases: '-h', desc: 'Show this help message'
+    check_unknown_options!
+
     default_command :console
 
-    desc 'console',
-         'Query packwerk in the current directory via console'
+    sig { returns(T::Boolean) }
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'console [DIRECTORY]', 'Query packwerk in DIRECTORY via console'
+    long_desc 'Query packwerk in DIRECTORY via console. DIRECTORY defaults to the current directory.'
     sig { params(directory: String).void }
     def console(directory = Dir.pwd)
+      return help('console') if options[:help]
+      raise Thor::Error, "Could not find directory #{directory.inspect}." unless File.directory?(directory)
+
       QueryPackwerk::Console.start(directory)
     end
   end

data/lib/query_packwerk/file_cache.rb

@@ -9,7 +9,9 @@ module QueryPackwerk
   class FileCache
     extend T::Sig
 
-    RUBY_FILE = T.let(/\.(rb|rake)\z/, Regexp)
+    # The files packwerk parses as Ruby, from Packwerk::Parsers::Factory
+    RUBY_FILE = T.let(/(\.(rb|rake|builder|gemspec|ru)|Gemfile|Rakefile)\z/, Regexp)
+    ERB_FILE = T.let(/\.erb\z/, Regexp)
 
     sig { void }
     def initialize
@@ -62,12 +64,18 @@ module QueryPackwerk
 
     sig { params(file_name: String).returns(RuboCop::AST::Node) }
     def get_file_ast(file_name)
-      @file_ast_cache[file_name] ||= ast_from(get_file(file_name))
+      @file_ast_cache[file_name] ||= begin
+        source = processed_source(ruby_source(file_name))
+        warn_unparseable(file_name, source) unless source.valid_syntax?
+
+        # The AST is also nil for source with no code, like a template that's only HTML
+        source.ast || ast_from('x')
+      end
     end
 
     sig { params(file_name: String).returns(String) }
     def get_file(file_name)
-      @file_cache[file_name] ||= if RUBY_FILE.match?(file_name) && File.exist?(file_name)
+      @file_cache[file_name] ||= if (RUBY_FILE.match?(file_name) || ERB_FILE.match?(file_name)) && File.exist?(file_name)
                                    File.read(file_name)
                                  else
                                    'x'
@@ -84,7 +92,7 @@ module QueryPackwerk
       absolute_const_node = ast_from(class_name)
       relative_const_node = ast_from(class_name.delete_prefix('::'))
 
-      @file_const_cache[const_key] = get_file_ast(file_name).each_descendant.select do |node|
+      @file_const_cache[const_key] = get_file_ast(file_name).each_node.select do |node|
         next false unless node.const_type?
 
         node == absolute_const_node || node == relative_const_node
@@ -133,10 +141,32 @@ module QueryPackwerk
 
     private
 
+    # Blanks out everything in an ERB template except its Ruby code, so line numbers still match the template
+    sig { params(file_name: String).returns(String) }
+    def ruby_source(file_name)
+      source = get_file(file_name)
+      return source unless ERB_FILE.match?(file_name)
+
+      Herb.extract_ruby(source, semicolons: true, comments: false, preserve_positions: true)
+    end
+
+    sig { params(string: String).returns(RuboCop::ProcessedSource) }
+    def processed_source(string)
+      RuboCop::ProcessedSource.new(string, RUBY_VERSION.to_f)
+    end
+
+    sig { params(file_name: String, source: RuboCop::ProcessedSource).void }
+    def warn_unparseable(file_name, source)
+      error = source.diagnostics.find { |diagnostic| diagnostic.level == :error }
+      location = error ? "#{file_name}:#{error.location.line} (#{error.message})" : file_name
+
+      warn "Could not parse #{location}, so its violations are not included"
+    end
+
     # Turns a string into a Ruby AST
     sig { params(string: String).returns(RuboCop::AST::Node) }
     def ast_from(string)
-      RuboCop::ProcessedSource.new(string, RUBY_VERSION.to_f).ast
+      processed_source(string).ast
     end
 
     # We can find a constant, but by going up its parents we can find the full call chain.

data/lib/query_packwerk/version.rb

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

data/lib/query_packwerk/violation.rb

@@ -9,8 +9,6 @@ module QueryPackwerk
   class Violation
     extend T::Sig
 
-    # This does not play nicely with ERB files which may have violations
-    RUBY_FILE = T.let(/\.(rb|rake)\z/, Regexp)
     ALL_CAPS = T.let(/\A[A-Z_]+\z/, Regexp)
 
     sig { returns(QueryPackwerk::Package) }
@@ -168,13 +166,15 @@ module QueryPackwerk
       load_cache!
 
       file_sources = files.flat_map do |file_name|
+        lines = @file_cache.get_file(file_name).lines
+
         @file_cache.get_full_sources(file_name: file_name, class_name: class_name).map do |s|
           line_number = s.loc.line
-          start_pos = line_number - start_offset
-          end_pos = line_number + end_offset
+          start_pos = [line_number - start_offset, 1].max
+          end_pos = [line_number + end_offset, lines.size].min
 
           location = "#{file_name}:#{s.loc.line} (L#{start_pos}..#{end_pos})"
-          context = @file_cache.get_file(file_name).lines.slice(start_pos..end_pos)
+          context = lines[(start_pos - 1)...end_pos]
           full_context = unindent((context || ['']).join)
 
           [@file_cache.anonymize_arguments(s.source), "> #{location}\n\n#{full_context}"]

data/lib/query_packwerk/violations.rb

@@ -192,7 +192,9 @@ module QueryPackwerk
     def sources_with_contexts(start_offset: 3, end_offset: 3)
       load_sources!
 
-      deep_merge_hash_groups(@original_collection) { |v| [v.class_name, v.sources_with_contexts] }
+      deep_merge_hash_groups(@original_collection) do |v|
+        [v.class_name, v.sources_with_contexts(start_offset:, end_offset:)]
+      end
     end
 
     sig { params(start_offset: Integer, end_offset: Integer).returns(String) }

data/lib/query_packwerk.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'sorbet-runtime'
+require 'herb'
 require 'parse_packwerk'
 require 'rubocop'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: query_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.1.24
+  version: 0.1.26
 platform: ruby
 authors:
 - Gusto Engineering
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: herb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: packwerk
   requirement: !ruby/object:Gem::Requirement