rails_console_pro 0.1.0

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task" if defined?(RuboCop)
+
+RuboCop::RakeTask.new if defined?(RuboCop)
+
+task default: :spec
+

data/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ':memory:'

data/docs/ASSOCIATION_NAVIGATION.md

@@ -0,0 +1,85 @@
+# Association Navigation
+
+Interactive navigation through model associations to explore your data relationships.
+
+## Usage
+
+```ruby
+# Start navigation from a model
+navigate User
+
+# Or as a method
+navigate(User)
+
+# Navigate from a model class name (string)
+navigate "User"
+```
+
+## Interactive Menu
+
+When you run `navigate User`, you'll see:
+
+```
+═══════════════════════════════════════════════════════════
+🧭 ASSOCIATION NAVIGATOR
+═══════════════════════════════════════════════════════════
+
+📍 Current Location: User
+   (1,234 records in database)
+
+🔗 Available Associations:
+
+  belongs_to:
+     1. ↖️  account → Account [account_id]
+
+  has_many:
+     2. ⇒  posts → Post [user_id] (dependent: destroy) [~5 per record]
+     3. ⇒  comments → Comment [user_id] [~12 per record]
+
+  has_one:
+     4. →  profile → Profile [user_id]
+
+📌 Navigation Options:
+   b  - Go back to previous model
+   q  - Exit navigator
+   s  - Show sample records for current model
+   c  - Show count for all associations
+
+➤ Enter choice: 
+```
+
+## Commands
+
+- **Number or name**: Navigate to that association
+- **b**: Go back to previous model
+- **q**: Exit navigator
+- **s**: Show sample records for current model
+- **c**: Show count for all associations
+
+## Code Example
+
+```ruby
+# Start navigation
+navigate User
+
+# In the menu, select an association by number or name
+# For example, enter "2" to navigate to Post model
+# Then enter "q" to exit
+
+# View sample records
+navigate User
+# Then type "s" to see sample User records
+
+# View association counts
+navigate User
+# Then type "c" to see counts for all associations
+```
+
+## Features
+
+- **Visual Icons**: Different icons for each association type
+- **Breadcrumb Navigation**: See your navigation path
+- **Sample Records**: View sample data from current model
+- **Association Counts**: See record counts for all associations
+- **History**: Navigate back through your path
+

data/docs/EXPORT.md

@@ -0,0 +1,95 @@
+# Export Capabilities
+
+Export data to JSON, YAML, and HTML formats for sharing and analysis.
+
+## Usage
+
+```ruby
+# Export using Pry command
+export schema(User) user_schema.json
+export stats(User) user_stats.json
+export explain(User.where(active: true)) query_explain.json
+
+# Export as method
+schema(User).export_to_file('user_schema.json')
+stats(User).export_to_file('user_stats.yaml')
+diff(user1, user2).export_to_file('diff.html')
+```
+
+## Supported Formats
+
+### JSON
+
+```ruby
+# Export to JSON
+export schema(User) user_schema.json
+
+# Or programmatically
+schema(User).to_json
+schema(User).export_to_file('user_schema.json', format: :json)
+```
+
+### YAML
+
+```ruby
+# Export to YAML
+export stats(User) user_stats.yaml
+
+# Or programmatically
+stats(User).to_yaml
+stats(User).export_to_file('user_stats.yaml', format: :yaml)
+```
+
+### HTML
+
+```ruby
+# Export to HTML
+export diff(user1, user2) comparison.html
+
+# Or programmatically
+diff(user1, user2).to_html
+diff(user1, user2).export_to_file('comparison.html', format: :html)
+```
+
+## Code Examples
+
+```ruby
+# Export schema
+schema_result = schema(User)
+schema_result.export_to_file('user_schema.json')
+
+# Export statistics
+stats_result = stats(User)
+stats_result.export_to_file('user_stats.yaml', format: :yaml)
+
+# Export explain result
+explain_result = explain(User.where(active: true))
+explain_result.export_to_file('query_explain.html', format: :html)
+
+# Export ActiveRecord objects
+user = User.first
+user.export_to_file('user.json')
+
+# Export collections
+users = User.limit(10)
+users.export_to_file('users.json')
+```
+
+## Exportable Objects
+
+- Schema inspection results (`schema(User)`)
+- SQL explain results (`explain(query)`)
+- Model statistics (`stats(User)`)
+- Object diffs (`diff(obj1, obj2)`)
+- ActiveRecord objects
+- ActiveRecord relations
+- Arrays and hashes
+
+## Features
+
+- **Automatic Format Detection**: Format inferred from file extension
+- **Pretty JSON**: Human-readable JSON output
+- **Styled HTML**: Beautiful HTML with CSS styling
+- **YAML Support**: Clean YAML output
+- **Error Handling**: Graceful handling of unsupported formats
+

data/docs/FORMATTING.md

@@ -0,0 +1,86 @@
+# Beautiful Formatting
+
+Automatic colored and styled output for ActiveRecord objects, relations, and collections.
+
+## Automatic Formatting
+
+The gem automatically formats ActiveRecord objects when displayed in the console:
+
+```ruby
+# ActiveRecord objects
+user = User.first
+# Automatically displayed with colors and formatting
+
+# Relations
+User.where(active: true)
+# Automatically formatted with pagination
+
+# Collections
+User.limit(10).to_a
+# Automatically formatted with nice layout
+```
+
+## Example Output
+
+```
+┌─────────────────────────────────────────────────────────┐
+│ User #1                                                  │
+├─────────────────────────────────────────────────────────┤
+│ id:         1                                            │
+│ email:      john@example.com                             │
+│ name:       John Doe                                     │
+│ active:     true                                         │
+│ created_at: 2024-01-01 12:00:00 UTC                     │
+│ updated_at: 2024-01-02 10:30:00 UTC                     │
+└─────────────────────────────────────────────────────────┘
+```
+
+## Pagination
+
+Large collections are automatically paginated:
+
+```ruby
+# Collection with more than 10 items
+User.all
+# Shows: "Showing 1-10 of 1234 records. Press Enter for more..."
+
+# Relations are paginated automatically
+Post.where(published: true)
+# Shows paginated results
+```
+
+## Configuration
+
+Customize formatting in your initializer:
+
+```ruby
+RailsConsolePro.configure do |config|
+  # Color scheme
+  config.color_scheme = :dark  # or :light
+  
+  # Pagination settings
+  config.pagination_enabled = true
+  config.pagination_threshold = 10
+  config.pagination_page_size = 5
+  
+  # Custom colors
+  config.set_color(:header, :bright_blue)
+  config.set_color(:key, :cyan)
+  config.set_color(:value, :white)
+end
+```
+
+## Formatted Objects
+
+- **ActiveRecord objects**: Single records with all attributes
+- **ActiveRecord relations**: Paginated collections
+- **Arrays**: Formatted lists
+- **Command results**: Schema, stats, explain, diff results
+
+## Features
+
+- **Color Coding**: Different colors for different data types
+- **Automatic Pagination**: Large collections are paginated
+- **Clean Layout**: Well-organized, readable output
+- **Dark/Light Themes**: Choose your preferred color scheme
+

data/docs/MODEL_STATISTICS.md

@@ -0,0 +1,72 @@
+# Model Statistics
+
+Get comprehensive statistics about your models including record counts, growth rates, table sizes, and index usage.
+
+## Usage
+
+```ruby
+# Get statistics for a model
+stats User
+
+# Or as a method
+stats(User)
+```
+
+## Example Output
+
+```
+═══════════════════════════════════════════════════════════
+📈 STATISTICS: User
+═══════════════════════════════════════════════════════════
+
+Record Count: 1,234
+
+Growth Rate:
+  Last 24 hours: +15 records
+  Last 7 days: +98 records
+  Last 30 days: +456 records
+
+Table Size:
+  Total: 2.5 MB
+  Data: 1.8 MB
+  Indexes: 0.7 MB
+
+Index Usage:
+  ✓ index_users_on_email          (frequently used)
+  ✓ index_users_on_created_at     (frequently used)
+  ⚠ index_users_on_last_login     (rarely used)
+
+Column Statistics:
+  email: 1,234 unique values
+  active: 85% true, 15% false
+  created_at: 2020-01-01 to 2024-12-31
+```
+
+## Code Example
+
+```ruby
+# Get statistics
+stats User
+
+# Get stats result object
+result = stats(User)
+result.record_count    # => 1234
+result.growth_rate     # => { "24h" => 15, "7d" => 98, "30d" => 456 }
+result.table_size      # => { "total" => "2.5 MB", "data" => "1.8 MB" }
+result.index_usage     # => { ... }
+
+# Export statistics
+stats(User).to_json
+
+# Export to file
+export stats(User) user_stats.json
+```
+
+## Statistics Included
+
+- **Record Count**: Total number of records
+- **Growth Rate**: New records in last 24h, 7d, 30d (requires `created_at` column)
+- **Table Size**: Database table size and index size
+- **Index Usage**: Which indexes are used frequently
+- **Column Statistics**: Unique values, distributions, ranges (for smaller tables)
+

data/docs/OBJECT_DIFFING.md

@@ -0,0 +1,87 @@
+# Object Diffing
+
+Compare two ActiveRecord objects or hashes and highlight their differences.
+
+## Usage
+
+```ruby
+# Compare two ActiveRecord objects
+user1 = User.first
+user2 = User.last
+diff user1, user2
+
+# Compare two hashes
+diff({ name: "John", age: 30 }, { name: "Jane", age: 30 })
+
+# Or as a method
+diff(user1, user2)
+```
+
+## Example Output
+
+```
+═══════════════════════════════════════════════════════════
+🔄 OBJECT DIFF
+═══════════════════════════════════════════════════════════
+
+Comparing:
+  User #1 vs User #2
+
+Status: ❌ Objects are different
+
+Differences:
+  name:
+    Old: "John Doe"
+    New: "Jane Doe"
+  
+  email:
+    Old: "john@example.com"
+    New: "jane@example.com"
+  
+  active:
+    Old: true
+    New: false
+
+Identical Attributes:
+  id: 1
+  created_at: 2024-01-01 12:00:00 UTC
+  updated_at: 2024-01-01 12:00:00 UTC
+```
+
+## Code Example
+
+```ruby
+# Compare two users
+user1 = User.find(1)
+user2 = User.find(2)
+diff user1, user2
+
+# Compare hashes
+diff(
+  { name: "John", age: 30, city: "NYC" },
+  { name: "Jane", age: 30, city: "LA" }
+)
+
+# Get diff result
+result = diff(user1, user2)
+result.identical?      # => false
+result.differences     # => { name: { old_value: "...", new_value: "..." } }
+
+# Export diff result
+diff(user1, user2).to_json
+```
+
+## Supported Object Types
+
+- **ActiveRecord objects**: Compares all attributes
+- **Hash objects**: Compares all keys and values
+- **Objects with attributes**: Any object responding to `attributes`
+- **Simple values**: Direct comparison
+
+## Features
+
+- **Highlight Differences**: Only shows attributes that differ
+- **Show Identical Attributes**: Lists attributes that are the same
+- **Multiple Object Types**: Works with ActiveRecord, Hash, and more
+- **Export Support**: Export diff results to JSON/YAML/HTML
+

data/docs/SCHEMA_INSPECTION.md

@@ -0,0 +1,60 @@
+# Schema Inspection
+
+Inspect database schemas with detailed information about columns, indexes, associations, validations, and scopes.
+
+## Usage
+
+```ruby
+# Simple usage
+schema User
+
+# Or as a method
+schema(User)
+```
+
+## Example Output
+
+```
+═══════════════════════════════════════════════════════════
+📊 SCHEMA: User
+═══════════════════════════════════════════════════════════
+
+Columns:
+  id               :integer          PRIMARY KEY, NOT NULL
+  email            :string           NOT NULL, UNIQUE
+  name             :string           NULLABLE
+  created_at       :datetime         NOT NULL
+  updated_at       :datetime         NOT NULL
+
+Indexes:
+  index_users_on_email          UNIQUE (email)
+  index_users_on_created_at     (created_at)
+
+Associations:
+  has_many   :posts
+  has_one    :profile
+  belongs_to :account
+
+Validations:
+  validates :email, presence: true, uniqueness: true
+
+Scopes:
+  scope :active, -> { where(active: true) }
+```
+
+## Code Example
+
+```ruby
+# Inspect a model
+schema User
+
+# Get schema result object
+result = schema(User)
+
+# Export schema to JSON
+schema(User).to_json
+
+# Export to file
+export schema(User) user_schema.json
+```
+

data/docs/SQL_EXPLAIN.md

@@ -0,0 +1,70 @@
+# SQL Explain
+
+Analyze SQL query execution plans with performance recommendations and index usage.
+
+## Usage
+
+```ruby
+# Explain a relation
+explain User.where(active: true)
+
+# Explain with conditions
+explain User, active: true
+
+# Explain a complex query
+explain Post.joins(:user).where(users: { active: true })
+```
+
+## Example Output
+
+```
+═══════════════════════════════════════════════════════════
+🔍 SQL EXPLAIN ANALYSIS
+═══════════════════════════════════════════════════════════
+
+SQL Query:
+SELECT "users".* FROM "users" WHERE "users"."active" = true
+
+Execution Time: 45ms
+
+Query Plan:
+Index Scan using index_users_on_active on users
+  Index Cond: (active = true)
+  Rows: 1,234
+
+Indexes Used:
+  ✓ index_users_on_active
+
+Performance Recommendations:
+  ✓ Query executed efficiently
+  ✓ Appropriate index usage detected
+```
+
+## Code Example
+
+```ruby
+# Analyze a simple query
+explain User.where(active: true)
+
+# Analyze a join query
+explain Post.joins(:user).where(users: { active: true })
+
+# Get explain result
+result = explain(User.where(active: true))
+result.execution_time  # => 45 (milliseconds)
+result.indexes_used    # => ["index_users_on_active"]
+result.recommendations # => ["Query executed efficiently"]
+
+# Export explain result
+explain(User.where(active: true)).to_json
+```
+
+## Performance Recommendations
+
+The explain command automatically detects:
+- Sequential scans (suggests adding indexes)
+- Full table scans
+- Slow queries (>100ms)
+- Missing index usage
+- LIKE queries with leading wildcards
+

data/lib/generators/rails_console_pro/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RailsConsolePro
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc "Creates a Rails Console Pro initializer file"
+
+      def create_initializer
+        template "rails_console_pro.rb", "config/initializers/rails_console_pro.rb"
+      end
+    end
+  end
+end
+

data/lib/generators/rails_console_pro/templates/rails_console_pro.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Rails Console Pro Configuration
+# See https://github.com/yourusername/rails_console_pro for documentation
+
+RailsConsolePro.configure do |config|
+  # Enable/disable features
+  config.enabled = true
+  config.schema_command_enabled = true
+  config.explain_command_enabled = true
+  config.stats_command_enabled = true
+  config.diff_command_enabled = true
+  config.navigate_command_enabled = true
+  config.export_enabled = true
+
+  # Printer toggles
+  config.active_record_printer_enabled = true
+  config.relation_printer_enabled = true
+  config.collection_printer_enabled = true
+
+  # Color scheme (dark or light)
+  config.color_scheme = :dark
+
+  # Style customization
+  config.max_depth = 10
+  config.show_sql_by_default = false
+  config.show_welcome_message = true
+  config.border_char = "─"
+  config.header_width = 60
+
+  # Pagination settings
+  config.pagination_enabled = true
+  config.pagination_threshold = 10  # Automatically paginate collections with 10+ items
+  config.pagination_page_size = 5   # Show 5 records per page
+
+  # Customize colors (optional)
+  # config.set_color(:header, :bright_blue)
+  # config.set_color(:attribute_key, :cyan)
+
+  # Customize type colors (optional)
+  # config.set_type_color(:string, :green)
+  # config.set_type_color(:integer, :bright_blue)
+end
+