rails_lens 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2df49b10f106235177d40b7029a8519ab45d7ab88395eb26fd56855e69a1ada
-  data.tar.gz: 483fc63985bf291ff4a069793aaa9ff8a4e82d1c83c405dedce717fddc5d9dc6
+  metadata.gz: 41ebdd3c52cca1c77790aa896dcc5962acb92c44eec90a2dceeda98f310aefb7
+  data.tar.gz: 72e49695a796e9d030fd80aedab53d7dea055db82c98e8023a6a2bb4293e139f
 SHA512:
-  metadata.gz: 20e9000c791458cb09cc530ba00e88b3033290c4b8124e6f10afc0d5ba0cf9af9bee932517753987da5f1955d4a13dd92d6c8315cf651962f45449b88bd02183
-  data.tar.gz: 70bf1e3d3321abe358bf68d2e99a0d2a018e6f8c8e70cbe86d42e2c7358fdf0870c8d5f806628f63a2913fc431993576480fe03c10f1a8157148c5358ecf67da
+  metadata.gz: d0e890e0ae21326d6176542668277a1c8e5d6336f013dec8cc8854f892c0136c6a40fb4557789dc661c47de70fbf82c0e59dcc75769b4a41e613f681e75f9a9f
+  data.tar.gz: d5c0d6aaecbd3a46986cc86507b3550347bd09e69f4126721fdb9acec05110a2f622fa2555d8c37151144efdd89ef5b87129576d3bc66c02f2b8cdd3404fcb77

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.2.2](https://github.com/seuros/rails_lens/compare/rails_lens/v0.2.1...rails_lens/v0.2.2) (2025-07-31)
+
+
+### Bug Fixes
+
+* remove from format from the erd visualize ([#5](https://github.com/seuros/rails_lens/issues/5)) ([c2efdc7](https://github.com/seuros/rails_lens/commit/c2efdc7011425fcd8b46dce54d811ce166b0c660))
+
+## [0.2.1](https://github.com/seuros/rails_lens/compare/rails_lens/v0.2.0...rails_lens/v0.2.1) (2025-07-30)
+
+
+### Bug Fixes
+
+* resolve GitHub issue [#2](https://github.com/seuros/rails_lens/issues/2) CLI and provider errors ([6d92c67](https://github.com/seuros/rails_lens/commit/6d92c679f1da9186ec4f357c243b41bc57eecd94))
+* resolve GitHub issue [#2](https://github.com/seuros/rails_lens/issues/2) CLI and provider errors ([a583373](https://github.com/seuros/rails_lens/commit/a583373b40ee7fdde32b3e97295448b1ecaa7ca5))
+
 ## [0.2.0](https://github.com/seuros/rails_lens/compare/rails_lens-v0.1.0...rails_lens/v0.2.0) (2025-07-30)
 
 

data/README.md

@@ -1,5 +1,10 @@
 # Rails Lens 🔍
 
+![Gem Version](https://img.shields.io/gem/v/rails_lens)
+![GitHub stars](https://img.shields.io/github/stars/seuros/rails_lens)
+![Downloads](https://img.shields.io/gem/dt/rails_lens)
+![License](https://img.shields.io/github/license/seuros/rails_lens)
+
 > **Precision optics for the Rails universe** - Where every model has perfect clarity through spacetime
 
 Rails Lens provides intelligent model annotations and ERD generation for Rails applications with database-specific adapters, multi-database support, and advanced code analysis.
@@ -26,6 +31,71 @@ Rails Lens provides intelligent model annotations and ERD generation for Rails a
 **✨ Advanced Features:**
 - STI hierarchy mapping • Delegated types • Polymorphic associations • Enum analysis • LRDL-optimized output
 
+## Showcase: Real-World Example
+
+Rescued from AWS limbo, Rails Lens delivers cosmic schema clarity. See this `Announcement` model:
+
+```ruby
+# frozen_string_literal: true
+
+# <rails-lens:schema:begin>
+# table = "announcements"
+# database_dialect = "PostgreSQL"
+#
+# columns = [
+#   { name = "id", type = "integer", primary_key = true, nullable = false },
+#   { name = "body", type = "text", nullable = true },
+#   { name = "audience", type = "string", nullable = true },
+#   { name = "scheduled_at", type = "datetime", nullable = true },
+#   { name = "created_at", type = "datetime", nullable = false },
+#   { name = "updated_at", type = "datetime", nullable = false }
+# ]
+#
+# == Polymorphic Associations
+# Polymorphic Targets:
+# - entry (as: :entryable)
+#
+# == Enums
+# - audience: { all_users: "all_users", crew_only: "crew_only", officers_only: "officers_only", command_staff: "command_staff" } (string)
+#
+# == Notes
+# - Column 'body' should probably have NOT NULL constraint
+# - Column 'audience' should probably have NOT NULL constraint
+# - String column 'audience' has no length limit - consider adding one
+# - Large text column 'body' is frequently queried - consider separate storage
+# <rails-lens:schema:end>
+class Announcement < ApplicationRecord
+  enum :audience, { all_users: 'all_users', crew_only: 'crew_only', officers_only: 'officers_only', command_staff: 'command_staff' }, suffix: true
+  has_one :entry, as: :entryable, dependent: :destroy
+  validates :audience, presence: true
+  validates :body, presence: true
+  scope :recent, -> { order(created_at: :desc) }
+end
+```
+
+**ERD Visualization:**
+```mermaid
+erDiagram
+    Announcement ||--o{ Entry : entryable
+    Announcement {
+        integer id PK
+        text body
+        string audience
+        datetime scheduled_at
+        datetime created_at
+        datetime updated_at
+    }
+    Entry {
+        integer id PK
+        string entryable_type
+        integer entryable_id
+        datetime created_at
+        datetime updated_at
+    }
+```
+
+**No grepping, no LLM hallucinations. Try it:** `gem install rails_lens`
+
 ## Requirements
 
 - Ruby >= 3.4.0

data/lib/rails_lens/analyzers/delegated_types.rb

@@ -17,7 +17,12 @@ module RailsLens
 
         lines << "Type Column: #{delegated_type_info[:type_column]}"
         lines << "ID Column: #{delegated_type_info[:id_column]}"
-        lines << "Types: #{delegated_type_info[:types].join(', ')}"
+        types_list = if delegated_type_info[:types].respond_to?(:keys)
+                       delegated_type_info[:types].keys
+                     else
+                       Array(delegated_type_info[:types])
+                     end
+        lines << "Types: #{types_list.join(', ')}"
 
         lines.join("\n")
       end

data/lib/rails_lens/cli.rb

@@ -8,6 +8,11 @@ module RailsLens
   class CLI < Thor
     include CLIErrorHandler
 
+    # Thor configuration: exit with proper status codes on failure (modern behavior)
+    def self.exit_on_failure?
+      true
+    end
+
     class_option :config, type: :string, default: '.rails-lens.yml', desc: 'Configuration file path'
     class_option :dry_run, type: :boolean, desc: 'Show what would be done without making changes'
     class_option :verbose, type: :boolean, desc: 'Verbose output'
@@ -15,6 +20,7 @@ module RailsLens
 
     desc 'annotate', 'Annotate Rails models with schema information'
     option :models, type: :array, desc: 'Specific models to annotate'
+    option :include_abstract, type: :boolean, desc: 'Include abstract classes'
     option :position, type: :string, enum: %w[before after top bottom], desc: 'Annotation position'
     option :routes, type: :boolean, desc: 'Annotate controller routes'
     option :mailers, type: :boolean, desc: 'Annotate mailer methods'

data/lib/rails_lens/erd/visualizer.rb

@@ -63,9 +63,19 @@ module RailsLens
           end
 
           group_models.each do |model|
+            # Additional safety check: Skip abstract models that might have slipped through
+            next if model.abstract_class?
+
+            # Skip models without valid tables or columns
+            next unless model.table_exists? && model.columns.present?
+
             model_display_name = format_model_name(model)
+
             output << "  #{model_display_name} {"
+            # Track opening brace position for error recovery
+            brace_position = output.size
 
+            columns_added = false
             model.columns.each do |column|
               type_str = format_column_type(column)
               name_str = column.name
@@ -73,23 +83,35 @@ module RailsLens
               key_str = keys.map(&:to_s).join(' ')
 
               output << "    #{type_str} #{name_str}#{" #{key_str}" unless key_str.empty?}"
+              columns_added = true
             end
 
-            output << '  }'
-            output << ''
-
-            Rails.logger.debug { "Added entity: #{model_display_name}" } if options[:verbose]
+            # Only close the entity if we successfully added columns
+            if columns_added
+              output << '  }'
+              output << ''
+              Rails.logger.debug { "Added entity: #{model_display_name}" } if options[:verbose]
+            else
+              # Remove the opening brace if no columns were added
+              output.slice!(brace_position..-1)
+              Rails.logger.debug { "Skipped entity #{model_display_name}: no columns found" } if options[:verbose]
+            end
           rescue StandardError => e
             Rails.logger.debug { "Warning: Could not add entity #{model.name}: #{e.message}" }
-            # Don't add partial entity if there's an error
-            # Remove the opening brace line if it was added
-            output.pop if output.last&.end_with?(' {')
+            # Remove any partial entity content added since the opening brace
+            if output.size > brace_position
+              output.slice!(brace_position..-1)
+            end
           end
         end
 
         # Add relationships
         output << '  %% Relationships'
         models.each do |model|
+          # Skip abstract models in relationship generation too
+          next if model.abstract_class?
+          next unless model.table_exists? && model.columns.present?
+
           add_model_relationships(output, model, models)
         end
 
@@ -152,6 +174,10 @@ module RailsLens
 
           next unless target_model && models.include?(target_model)
 
+          # Skip relationships to abstract models
+          next if target_model.abstract_class?
+          next unless target_model.table_exists? && target_model.columns.present?
+
           case association.macro
           when :belongs_to
             add_belongs_to_relationship(output, model, association, target_model)
@@ -164,10 +190,12 @@ module RailsLens
           end
         end
 
-        # Check for closure_tree self-reference
-        return unless model.respond_to?(:_ct)
-
-        output << "  #{format_model_name(model)} }o--o{ #{format_model_name(model)} : \"closure_tree\""
+        # Check for closure_tree self-reference - but only if model is not abstract
+        # rubocop:disable Style/GuardClause
+        if model.respond_to?(:_ct) && !model.abstract_class?
+          output << "  #{format_model_name(model)} }o--o{ #{format_model_name(model)} : \"closure_tree\""
+        end
+        # rubocop:enable Style/GuardClause
       end
 
       def add_belongs_to_relationship(output, model, association, target_model)

data/lib/rails_lens/model_detector.rb

@@ -125,7 +125,7 @@ module RailsLens
 
         # Exclude abstract models and models without valid tables
         before_count = models.size
-        models = filter_models_concurrently(models, trace_filtering)
+        models = filter_models_concurrently(models, trace_filtering, options)
         log_filter_step('Abstract/invalid table removal', before_count, models.size, trace_filtering)
 
         # Exclude tables from configuration
@@ -183,7 +183,7 @@ module RailsLens
         end
       end
 
-      def filter_models_concurrently(models, trace_filtering)
+      def filter_models_concurrently(models, trace_filtering, options = {})
         # Use concurrent futures to check table existence in parallel
         futures = models.map do |model|
           Concurrent::Future.execute do
@@ -191,10 +191,13 @@ module RailsLens
             reason = nil
 
             begin
-              # Skip abstract models
-              if model.abstract_class?
+              # Skip abstract models unless explicitly included
+              if model.abstract_class? && !options[:include_abstract]
                 should_exclude = true
                 reason = 'abstract class'
+              # For abstract models that are included, skip table checks
+              elsif model.abstract_class? && options[:include_abstract]
+                reason = 'abstract class (included)'
               # Skip models without configured tables
               elsif !model.table_name
                 should_exclude = true
@@ -203,8 +206,12 @@ module RailsLens
               elsif !model.table_exists?
                 should_exclude = true
                 reason = "table '#{model.table_name}' does not exist"
+              # Additional check: Skip models that don't have any columns
+              elsif model.columns.empty?
+                should_exclude = true
+                reason = "table '#{model.table_name}' has no columns"
               else
-                reason = "table '#{model.table_name}' exists"
+                reason = "table '#{model.table_name}' exists with #{model.columns.size} columns"
               end
             rescue ActiveRecord::StatementInvalid, ActiveRecord::ConnectionNotDefined => e
               should_exclude = true
@@ -212,6 +219,10 @@ module RailsLens
             rescue NameError, NoMethodError => e
               should_exclude = true
               reason = "method error checking model - #{e.message}"
+            rescue StandardError => e
+              # Catch any other errors and exclude the model to prevent ERD corruption
+              should_exclude = true
+              reason = "unexpected error checking model - #{e.message}"
             end
 
             if trace_filtering

data/lib/rails_lens/providers/schema_provider.rb

@@ -18,18 +18,31 @@ module RailsLens
           adapter_name = connection.adapter_name
 
           lines = []
+
+          # Get connection name
+          begin
+            connection_name = connection.pool.db_config.name
+            lines << "connection = \"#{connection_name}\""
+          rescue StandardError
+            lines << 'connection = "unknown"'
+          end
+
           lines << "database_dialect = \"#{adapter_name}\""
 
-          # Add basic database information
+          # Add database version information
+          begin
+            db_version = connection.database_version
+            lines << "database_version = \"#{db_version}\""
+          rescue StandardError
+            lines << 'database_version = "unknown"'
+          end
+
+          # Add database name if available
           begin
-            db_name = begin
-              connection.database_version
-            rescue StandardError
-              'unknown'
-            end
-            lines << "database_version = \"#{db_name}\""
+            db_name = connection.current_database
+            lines << "database_name = \"#{db_name}\"" if db_name
           rescue StandardError
-            # Skip if can't get version
+            # Skip if can't get database name
           end
 
           lines << ''

data/lib/rails_lens/schema/adapters/mysql.rb

@@ -117,7 +117,7 @@ module RailsLens
         rescue ActiveRecord::StatementInvalid => e
           Rails.logger.debug { "Failed to fetch storage engine for #{table_name}: #{e.message}" }
           nil
-        rescue Mysql2::Error => e
+        rescue => e
           Rails.logger.debug { "MySQL error fetching storage engine: #{e.message}" }
           nil
         end
@@ -137,7 +137,7 @@ module RailsLens
         rescue ActiveRecord::StatementInvalid => e
           Rails.logger.debug { "Failed to fetch charset for #{table_name}: #{e.message}" }
           nil
-        rescue Mysql2::Error => e
+        rescue => e
           Rails.logger.debug { "MySQL error fetching charset: #{e.message}" }
           nil
         end
@@ -155,7 +155,7 @@ module RailsLens
         rescue ActiveRecord::StatementInvalid => e
           Rails.logger.debug { "Failed to fetch collation for #{table_name}: #{e.message}" }
           nil
-        rescue Mysql2::Error => e
+        rescue => e
           Rails.logger.debug { "MySQL error fetching collation: #{e.message}" }
           nil
         end
@@ -202,7 +202,7 @@ module RailsLens
           # Table doesn't exist or no permission to query information_schema
           Rails.logger.debug { "Failed to check partitions for #{table_name}: #{e.message}" }
           false
-        rescue Mysql2::Error => e
+        rescue => e
           # MySQL specific errors (connection issues, etc)
           Rails.logger.debug { "MySQL error checking partitions: #{e.message}" }
           false
@@ -231,7 +231,7 @@ module RailsLens
         rescue ActiveRecord::StatementInvalid => e
           # Permission denied or table doesn't exist
           Rails.logger.debug { "Failed to fetch partitions for #{table_name}: #{e.message}" }
-        rescue Mysql2::Error => e
+        rescue => e
           # MySQL specific errors
           Rails.logger.debug { "MySQL error fetching partitions: #{e.message}" }
         end
@@ -269,7 +269,7 @@ module RailsLens
         rescue ActiveRecord::StatementInvalid => e
           # Permission denied or table doesn't exist
           Rails.logger.debug { "Failed to fetch partitions for #{table_name}: #{e.message}" }
-        rescue Mysql2::Error => e
+        rescue => e
           # MySQL specific errors
           Rails.logger.debug { "MySQL error fetching partitions: #{e.message}" }
         end

data/lib/rails_lens/schema/annotation_manager.rb

@@ -112,8 +112,8 @@ module RailsLens
             next
           end
 
-          # Skip models without tables or with missing tables
-          unless model.table_exists?
+          # Skip models without tables or with missing tables (but not abstract classes)
+          unless model.abstract_class? || model.table_exists?
             results[:skipped] << model.name
             warn "Skipping #{model.name} - table does not exist" if options[:verbose]
             next

data/lib/rails_lens/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_lens
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Abdelkader Boudih