fix: Merge pull request #32 from seuros/feat/compact-toml-annotations

Release-as: 0.3.0

Author: seuros

lib/rails_lens/analyzers/association_analyzer.rb

@@ -15,14 +15,13 @@ def analyze
 
       def analyze_inverse_of
         associations_needing_inverse.map do |association|
-          "Association '#{association.name}' should specify inverse_of"
+          NoteCodes.note(association.name.to_s, NoteCodes::INVERSE_OF)
         end
       end
 
       def analyze_n_plus_one_risks
         has_many_associations.map do |association|
-          # Warn about N+1 query risks for has_many associations
-          "Association '#{association.name}' has N+1 query risk. Consider using includes/preload"
+          NoteCodes.note(association.name.to_s, NoteCodes::N_PLUS_ONE)
         end
       end
 
@@ -32,9 +31,8 @@ def analyze_counter_caches
         belongs_to_associations.each do |association|
           next if association.polymorphic?
 
-          # Check if the associated model has a matching counter column
           if should_have_counter_cache?(association) && !has_counter_cache?(association)
-            notes << "Consider adding counter cache for '#{association.name}'"
+            notes << NoteCodes.note(association.name.to_s, NoteCodes::COUNTER_CACHE)
           end
         end
 
@@ -74,8 +72,6 @@ def bidirectional_association?(association)
       end
 
       def should_have_counter_cache?(association)
-        # A counter cache is needed if there is a has_many association
-        # on the other side of the belongs_to, and no counter_cache is defined.
         return false unless association.macro == :belongs_to
 
         inverse_association = association.inverse_of

lib/rails_lens/analyzers/best_practices_analyzer.rb

@@ -8,7 +8,7 @@ def analyze
         notes.concat(analyze_timestamps)
         notes.concat(analyze_soft_deletes)
         notes.concat(analyze_sti_columns)
-        notes.concat(analyze_naming_conventions)
+        notes.concat(analyze_large_text_columns)
         notes
       end
 
@@ -17,63 +17,38 @@ def analyze
       def analyze_timestamps
         notes = []
 
-        notes << 'Missing timestamp columns (created_at, updated_at)' unless has_timestamps?
+        notes << NoteCodes::NO_TIMESTAMPS unless has_timestamps?
 
         if has_column?('created_at') && !has_column?('updated_at')
-          notes << 'Has created_at but missing updated_at'
+          notes << NoteCodes::PARTIAL_TS
         elsif !has_column?('created_at') && has_column?('updated_at')
-          notes << 'Has updated_at but missing created_at'
+          notes << NoteCodes::PARTIAL_TS
         end
 
         notes
       end
 
       def analyze_soft_deletes
-        notes = []
-
-        soft_delete_columns.each do |column|
-          notes << "Soft delete column '#{column.name}' should be indexed" unless indexed?(column)
+        soft_delete_columns.reject { |col| indexed?(col) }.map do |column|
+          NoteCodes.note(column.name, NoteCodes::INDEX)
         end
-
-        notes
       end
 
       def analyze_sti_columns
         notes = []
 
         if sti_model? && type_column
-          notes << "STI type column '#{type_column.name}' should be indexed" unless indexed?(type_column)
-
-          notes << "STI type column '#{type_column.name}' should have NOT NULL constraint" if type_column.null
+          notes << NoteCodes.note(type_column.name, NoteCodes::INDEX) unless indexed?(type_column)
+          notes << NoteCodes.note(type_column.name, NoteCodes::STI_NOT_NULL) if type_column.null
         end
 
         notes
       end
 
-      def analyze_naming_conventions
-        notes = []
-
-        # Check for non-conventional column names
-        columns.each do |column|
-          if column.name.match?(/^(is|has)_/i)
-            notes << "Column '#{column.name}' uses non-conventional prefix - consider removing 'is_' or 'has_'"
-          end
-
-          if column.name.match?(/Id$/) # Capital I
-            notes << "Column '#{column.name}' should use snake_case (e.g., '#{column.name.underscore}')"
-          end
-        end
-
-        # Check table naming
-        # Extract the actual table name without schema prefix for PostgreSQL
-        # PostgreSQL uses schema.table format (e.g., "ai.skills" -> "skills")
-        unqualified_table = table_name.to_s.split('.').last
-
-        if !unqualified_table.match?(/^[a-z_]+$/) || unqualified_table != unqualified_table.pluralize
-          notes << "Table name '#{table_name}' doesn't follow Rails conventions (should be plural, snake_case)"
+      def analyze_large_text_columns
+        columns.select { |c| c.type == :text }.map do |column|
+          NoteCodes.note(column.name, NoteCodes::STORAGE)
         end
-
-        notes
       end
 
       def has_timestamps?