Improve violation output to look more like ripgrep to compress the output

Author: martinemde

lib/chatwerk/api.rb

@@ -14,7 +14,7 @@ def packages(package_path: nil)
           has_packwerk_yml = File.exist?('packwerk.yml')
           Views::NoPackagesView.render(has_packwerk_yml:)
         else
-          Views::PackagesView.render(packages:, has_packwerk_yml:)
+          Views::PackagesView.render(packages:)
         end
       rescue StandardError => e
         raise Chatwerk::Error.new(e, package_path:)

lib/chatwerk/views/packages_view.rb

@@ -3,11 +3,11 @@
 module Chatwerk
   module Views
     class PackagesView < BaseView
-      def render
+      def template(packages:, package_path: nil)
         if packages.empty?
-          "No packages found matching #{package_path.inspect}"
+          "No packages found matching #{package_path.inspect}\n"
         else
-          packages.map(&:name).sort.join("\n")
+          packages.map { |p| "#{p.name}\n" }.sort.join
         end
       end
     end

lib/chatwerk/views/violations_details_view.rb

@@ -4,29 +4,44 @@ module Chatwerk
   module Views
     class ViolationsDetailsView < BaseView
       def template(package:, violations:, constant_name:)
-        say "The following code violates package boundaries:\n"
-
         relevant_violations = violations
                               .anonymous_sources_with_locations
                               .select { |c, _| c.start_with?(constant_name) }
 
         if relevant_violations.empty?
-          say Views::NoViolationsView.render(package:, constant_name:)
+          Views::NoViolationsView.render(package:, constant_name:)
         else
-          relevant_violations.each do |name, source|
-            say "# Constant `#{name}`"
-            if source && !source.empty?
-              source.each do |code, files|
-                say "  #{code}"
-                files.each do |file|
-                  say "  - #{file}"
-                end
-              end
-            else
-              say '  No usages found.'
+          grep_formatted_violations(relevant_violations)
+        end
+      end
+
+      private
+
+      def grep_formatted_violations(relevant_violations)
+        # Group violations by file
+        files_to_violations = {}
+
+        relevant_violations.each do |constant, source_info|
+          say "No sources found for #{constant}" if source_info.empty?
+          source_info.each do |code, files|
+            say "No files found for #{constant} with code: #{code}" if files.empty?
+
+            files.each do |file_with_line|
+              file, line = file_with_line.split(':')
+              files_to_violations[file] ||= []
+              files_to_violations[file] << { constant:, code:, line: line }
             end
           end
         end
+
+        # Output violations grouped by file
+        files_to_violations.sort.map do |file, violations|
+          lines = violations.sort_by { |v| v[:line].to_i }.map do |violation|
+            "#{violation[:line]}:   #{violation[:code]}"
+          end.join("\n")
+
+          "#{file}\n#{lines}\n"
+        end.join("\n")
       end
     end
   end

spec/chatwerk/api_spec.rb

@@ -9,7 +9,7 @@
   let(:constant_name) { '::TestPackage::TestClass' }
   let(:package) { instance_double('Packwerk::Package', name: 'packs/test_package') }
   let(:violations) { instance_double('QueryPackwerk::Violations') }
-  let(:anonymous_sources_with_locations) { { '::TestPackage::TestClass' => { 'example usage' => ['app/models/test.rb'] } } }
+  let(:anonymous_sources_with_locations) { { '::TestPackage::TestClass' => { 'example usage' => ['app/models/test.rb:1'] } } }
 
   before do
     allow(Chatwerk::Helpers).to receive(:chdir)
@@ -23,7 +23,7 @@
       end
 
       it 'returns the packages view' do
-        expect(described_class.packages).to eq('packs/test_package')
+        expect(described_class.packages).to eq("packs/test_package\n")
       end
 
       it 'accepts an optional package path filter' do
@@ -40,7 +40,7 @@
       end
 
       it 'returns the no packages view' do
-        expect(described_class.packages.chomp).to eq(<<~STRING.chomp)
+        expect(described_class.packages).to eq(<<~STRING)
           0 packages found.
           `packwerk.yml` file exists in project root: /test/workspace
 
@@ -98,23 +98,17 @@
 
       it 'returns the violations list view' do
         expect(described_class.package_todos(package_path: package_path)).to eq(<<~STRING)
-          The following code violates package boundaries:
-
-          # Constant `::TestPackage::TestClass`
-            example usage
-            - app/models/test.rb
+          app/models/test.rb
+          1:   example usage
         STRING
       end
     end
 
     context 'with constant name' do
       it 'returns the violations details view' do
         expect(described_class.package_todos(package_path: package_path, constant_name: constant_name)).to eq(<<~STRING)
-          The following code violates package boundaries:
-
-          # Constant `::TestPackage::TestClass`
-            example usage
-            - app/models/test.rb
+          app/models/test.rb
+          1:   example usage
         STRING
       end
 
@@ -123,8 +117,6 @@
 
         it 'returns the no violations view' do
           expect(described_class.package_todos(package_path: package_path, constant_name: constant_name).strip).to eq(<<~STRING.strip)
-            The following code violates package boundaries:
-
             No violations found in "packs/test_package" for "::TestPackage::TestClass".
             Ensure that constant_name is given in the format of "::ConstantName" or "::ConstantName::NestedConstant".
           STRING
@@ -157,33 +149,25 @@
 
       it 'returns the violations list view' do
         expect(described_class.package_violations(package_path: package_path)).to eq(<<~STRING)
-          The following code violates package boundaries:
-
-          # Constant `::TestPackage::TestClass`
-            example usage
-            - app/models/test.rb
+          app/models/test.rb
+          1:   example usage
         STRING
       end
     end
 
     context 'with constant name' do
       it 'returns the violations details view' do
         expect(described_class.package_violations(package_path: package_path, constant_name: constant_name)).to eq(<<~STRING)
-          The following code violates package boundaries:
-
-          # Constant `::TestPackage::TestClass`
-            example usage
-            - app/models/test.rb
+          app/models/test.rb
+          1:   example usage
         STRING
       end
 
       context 'when no violations found' do
         let(:anonymous_sources_with_locations) { {} }
 
         it 'returns the no violations view' do
-          expect(described_class.package_violations(package_path: package_path, constant_name: constant_name).strip).to eq(<<~STRING.strip)
-            The following code violates package boundaries:
-
+          expect(described_class.package_violations(package_path: package_path, constant_name: constant_name)).to eq(<<~STRING)
             No violations found in "packs/test_package" for "::TestPackage::TestClass".
             Ensure that constant_name is given in the format of "::ConstantName" or "::ConstantName::NestedConstant".
           STRING

spec/chatwerk/views/package_view_spec.rb

@@ -16,7 +16,7 @@
                                 todos: [],
                                 violations: [])
 
-      expect(described_class.render(package:).chomp).to eq(<<~OUTPUT)
+      expect(described_class.render(package:)).to eq(<<~OUTPUT)
         ---
         name: orders
         enforce_dependencies: true
@@ -29,6 +29,7 @@
         - consumer1
         todos_count: 0
         violations_count: 0
+
       OUTPUT
     end
   end

spec/chatwerk/views/packages_view_spec.rb

@@ -10,7 +10,7 @@
       ]
       package_path = 'app/packages'
 
-      expect(described_class.render(packages:, package_path:)).to eq(<<~OUTPUT.chomp)
+      expect(described_class.render(packages:, package_path:)).to eq(<<~OUTPUT)
         orders
         payments
         users
@@ -23,7 +23,7 @@
       packages = []
       package_path = 'app/invalid_path'
 
-      expect(described_class.render(packages:, package_path:)).to eq(<<~OUTPUT.chomp)
+      expect(described_class.render(packages:, package_path:)).to eq(<<~OUTPUT)
         No packages found matching "app/invalid_path"
       OUTPUT
     end

spec/chatwerk/views/violations_details_view_spec.rb

@@ -7,21 +7,22 @@
       constant_name = '::Core::User'
       sources = {
         '::Core::User' => {
-          'User.find(order.user_id)' => ['app/packages/orders/app/models/order.rb:45', 'app/packages/orders/app/services/order_service.rb:12'],
-          'User.create(user_params)' => ['app/packages/orders/app/controllers/orders_controller.rb:28']
+          'User.find(_)' => ['app/packages/orders/app/models/order.rb:45', 'app/packages/orders/app/services/order_service.rb:12'],
+          'User.create(_)' => ['app/packages/orders/app/controllers/orders_controller.rb:28', 'app/packages/orders/app/models/order.rb:48']
         }
       }
       violations = instance_double('QueryPackwerk::Violations', anonymous_sources_with_locations: sources)
 
       expect(described_class.render(package:, violations:, constant_name:)).to eq(<<~OUTPUT)
-        The following code violates package boundaries:
+        app/packages/orders/app/controllers/orders_controller.rb
+        28:   User.create(_)
 
-        # Constant `::Core::User`
-          User.find(order.user_id)
-          - app/packages/orders/app/models/order.rb:45
-          - app/packages/orders/app/services/order_service.rb:12
-          User.create(user_params)
-          - app/packages/orders/app/controllers/orders_controller.rb:28
+        app/packages/orders/app/models/order.rb
+        45:   User.find(_)
+        48:   User.create(_)
+
+        app/packages/orders/app/services/order_service.rb
+        12:   User.find(_)
       OUTPUT
     end
   end
@@ -36,10 +37,7 @@
       violations = instance_double('QueryPackwerk::Violations', anonymous_sources_with_locations: sources)
 
       expect(described_class.render(package:, violations:, constant_name:)).to eq(<<~OUTPUT)
-        The following code violates package boundaries:
-
-        # Constant `::Core::Product`
-          No usages found.
+        No sources found for ::Core::Product
       OUTPUT
     end
   end