clarify violations vs todos

Author: martinemde

lib/query_packwerk.rb

@@ -37,6 +37,10 @@ def violations_for(pack_name)
     QueryPackwerk::Violations.where(producing_pack: full_name(pack_name))
   end
 
+  def todos_for(pack_name)
+    package(pack_name).todos
+  end
+
   # Where the violations occurred
   sig { params(pack_name: String).returns(T::Hash[String, T::Array[String]]) }
   def violation_sources_for(pack_name)

lib/query_packwerk/package.rb

@@ -62,16 +62,16 @@ def directory
     end
 
     sig { returns(QueryPackwerk::Violations) }
-    def violations
+    def todos
       QueryPackwerk::Violations.where(consuming_pack: name)
     end
-    alias todos violations
+    alias dependency_violations todos
 
     sig { returns(QueryPackwerk::Violations) }
-    def consumer_violations
+    def violations
       QueryPackwerk::Violations.where(producing_pack: name)
     end
-    alias incoming_violations consumer_violations
+    alias consumer_violations violations
 
     sig { returns(QueryPackwerk::Packages) }
     def consumers

spec/query_packwerk/package_spec.rb

@@ -55,32 +55,32 @@
     end
   end
 
-  describe '#violations' do
+  describe '#todos' do
     it 'returns violations for the package' do
-      violations = package.violations
-      expect(violations).to be_a(QueryPackwerk::Violations)
-      expect(violations.size).to eq(raw_violations.size)
+      todos = package.todos
+      expect(todos).to be_a(QueryPackwerk::Violations)
+      expect(todos.size).to eq(raw_violations.size)
     end
   end
 
-  describe '#todos' do
-    it 'is an alias for #violations' do
+  describe '#dependency_violations' do
+    it 'is an alias for #todos' do
       # Both methods should return equivalent objects but might not be equal with `==`
-      expect(package.todos.to_a).to match_array(package.violations.to_a)
+      expect(package.todos.to_a).to match_array(package.dependency_violations.to_a)
     end
   end
 
-  describe '#consumer_violations' do
+  describe '#violations' do
     it 'returns violations where this package is the producing pack' do
-      violations = package.consumer_violations
+      violations = package.violations
       expect(violations).to be_a(QueryPackwerk::Violations)
     end
   end
 
-  describe '#incoming_violations' do
-    it 'is an alias for #consumer_violations' do
+  describe '#consumer_violations' do
+    it 'is an alias for #violations' do
       # Both methods should return equivalent objects but might not be equal with `==`
-      expect(package.incoming_violations.to_a).to match_array(package.consumer_violations.to_a)
+      expect(package.consumer_violations.to_a).to match_array(package.violations.to_a)
     end
   end