rails_lens 0.2.12 → 0.3.0

data/lib/rails_lens/schema/database_annotator.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module RailsLens
+  module Schema
+    # Annotates abstract base classes (ApplicationRecord, etc.) with database-level objects
+    # like functions, sequences, types, etc.
+    class DatabaseAnnotator
+      attr_reader :base_class
+
+      def initialize(base_class)
+        @base_class = base_class
+      end
+
+      def annotate_file(file_path = nil)
+        file_path ||= model_file_path
+        return unless file_path && File.exist?(file_path)
+
+        annotation_text = generate_annotation
+        return if annotation_text.empty?
+
+        # Remove existing annotations
+        content = File.read(file_path)
+        Annotation.remove(content) if Annotation.extract(content)
+
+        # Use Prism-based insertion
+        class_name = base_class.name.split('::').last
+        if FileInsertionHelper.insert_at_class_definition(file_path, class_name, annotation_text)
+          true
+        else
+          false
+        end
+      end
+
+      def remove_annotations(file_path = nil)
+        file_path ||= model_file_path
+        return unless file_path && File.exist?(file_path)
+
+        content = File.read(file_path)
+        cleaned_content = Annotation.remove(content)
+
+        if cleaned_content == content
+          false
+        else
+          File.write(file_path, cleaned_content)
+          true
+        end
+      end
+
+      def generate_annotation
+        annotation = Annotation.new
+
+        # Detect adapter
+        adapter_name = base_class.connection.adapter_name
+
+        # Always add database dialect for abstract classes
+        annotation.add_line("database_dialect = \"#{adapter_name}\"")
+
+        case adapter_name
+        when /PostgreSQL/i
+          add_postgresql_functions(annotation)
+        when /MySQL/i
+          add_mysql_functions(annotation)
+        when /SQLite/i
+          # SQLite doesn't have stored functions
+        end
+
+        annotation.to_s
+      end
+
+      # Class methods for batch operations
+      def self.annotate_all(options = {})
+        results = { annotated: [], skipped: [], failed: [] }
+
+        abstract_classes = detect_abstract_base_classes
+
+        abstract_classes.each do |klass|
+          annotator = new(klass)
+
+          begin
+            if annotator.annotate_file
+              results[:annotated] << klass.name
+            else
+              results[:skipped] << klass.name
+            end
+          rescue StandardError => e
+            results[:failed] << { model: klass.name, error: e.message }
+          end
+        end
+
+        results
+      end
+
+      def self.remove_all(options = {})
+        results = { removed: [], skipped: [], failed: [] }
+
+        begin
+          abstract_classes = detect_abstract_base_classes
+        rescue StandardError => e
+          RailsLens.logger.error { "Failed to detect abstract base classes: #{e.message}" }
+          return results
+        end
+
+        abstract_classes.each do |klass|
+          annotator = new(klass)
+          if annotator.remove_annotations
+            results[:removed] << klass.name
+          else
+            results[:skipped] << klass.name
+          end
+        rescue StandardError => e
+          results[:failed] << { model: klass.name, error: e.message }
+        end
+
+        results
+      end
+
+      def self.detect_abstract_base_classes
+        return [] unless defined?(Rails)
+
+        classes = []
+
+        # Load all models
+        Rails.application.eager_load!
+
+        # Find abstract base classes that inherit from ActiveRecord::Base
+        ActiveRecord::Base.descendants.each do |klass|
+          next unless klass.abstract_class?
+          next if klass == ActiveRecord::Base
+
+          classes << klass
+        end
+
+        classes
+      end
+
+      private_class_method :detect_abstract_base_classes
+
+      private
+
+      def add_postgresql_functions(annotation)
+        return unless RailsLens.config.schema[:format_options][:show_functions]
+
+        require_relative 'adapters/postgresql'
+        functions = Adapters::Postgresql.fetch_functions(base_class.connection)
+        add_functions_annotation(annotation, functions)
+      end
+
+      def add_mysql_functions(annotation)
+        return unless RailsLens.config.schema[:format_options][:show_functions]
+
+        require_relative 'adapters/mysql'
+        functions = Adapters::Mysql.fetch_functions(base_class.connection)
+        add_functions_annotation(annotation, functions)
+      end
+
+      def add_functions_annotation(annotation, functions)
+        return if functions.empty?
+
+        annotation.add_line('[database_functions]')
+        annotation.add_line('functions = [')
+
+        functions.each_with_index do |func, index|
+          line = '  { '
+          attrs = []
+          attrs << "name = \"#{escape_toml_string(func[:name])}\""
+          attrs << "schema = \"#{escape_toml_string(func[:schema])}\""
+          attrs << "language = \"#{escape_toml_string(func[:language])}\""
+          attrs << "return_type = \"#{escape_toml_string(func[:return_type])}\""
+          attrs << "description = \"#{escape_toml_string(func[:description])}\"" if func[:description]
+          line += attrs.join(', ')
+          line += ' }'
+          line += ',' if index < functions.length - 1
+          annotation.add_line(line)
+        end
+
+        annotation.add_line(']')
+      end
+
+      def escape_toml_string(str)
+        return '' unless str
+
+        str.to_s.gsub('\\', '\\\\').gsub('"', '\\"')
+      end
+
+      def model_file_path
+        return nil unless base_class.name
+
+        # Convert class name to file path (e.g., ApplicationRecord -> application_record.rb)
+        file_name = "#{base_class.name.underscore}.rb"
+
+        # Look in app/models
+        path = Rails.root.join('app', 'models', file_name) if defined?(Rails.root)
+        path if path && File.exist?(path)
+      end
+    end
+  end
+end

data/lib/rails_lens/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsLens
-  VERSION = '0.2.12'
+  VERSION = '0.3.0'
 end

data/lib/rails_lens.rb

@@ -60,7 +60,7 @@ module RailsLens
 
         current_value = config.send(section)
         if current_value.is_a?(Hash)
-          config.send("#{section}=", current_value.merge(settings.symbolize_keys))
+          config.send("#{section}=", current_value.deep_merge(settings.symbolize_keys))
         else
           config.send("#{section}=", settings.symbolize_keys)
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_lens
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 0.3.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -166,6 +166,7 @@ files:
 - lib/rails_lens/analyzers/association_analyzer.rb
 - lib/rails_lens/analyzers/base.rb
 - lib/rails_lens/analyzers/best_practices_analyzer.rb
+- lib/rails_lens/analyzers/callbacks.rb
 - lib/rails_lens/analyzers/column_analyzer.rb
 - lib/rails_lens/analyzers/composite_keys.rb
 - lib/rails_lens/analyzers/database_constraints.rb
@@ -197,6 +198,7 @@ files:
 - lib/rails_lens/mailer/annotator.rb
 - lib/rails_lens/mailer/extractor.rb
 - lib/rails_lens/model_detector.rb
+- lib/rails_lens/note_codes.rb
 - lib/rails_lens/parsers.rb
 - lib/rails_lens/parsers/class_info.rb
 - lib/rails_lens/parsers/module_info.rb
@@ -205,6 +207,7 @@ files:
 - lib/rails_lens/providers/association_notes_provider.rb
 - lib/rails_lens/providers/base.rb
 - lib/rails_lens/providers/best_practices_notes_provider.rb
+- lib/rails_lens/providers/callbacks_provider.rb
 - lib/rails_lens/providers/column_notes_provider.rb
 - lib/rails_lens/providers/composite_keys_provider.rb
 - lib/rails_lens/providers/database_constraints_provider.rb
@@ -234,6 +237,7 @@ files:
 - lib/rails_lens/schema/adapters/sqlite3.rb
 - lib/rails_lens/schema/annotation.rb
 - lib/rails_lens/schema/annotation_manager.rb
+- lib/rails_lens/schema/database_annotator.rb
 - lib/rails_lens/tasks/annotate.rake
 - lib/rails_lens/tasks/erd.rake
 - lib/rails_lens/tasks/mailers.rake