rails_pulse 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c6b5219e5da388e0ec200a6382527d227ab0e2ee20faa11e3ce8e49992ce6b8
-  data.tar.gz: 1a713357c2ab7eb454b269f358c9b9fb1939eef9e3d17c8cb7cf9a12cab8206c
+  metadata.gz: 4d5eb9055acbfc951ef6874c484b10f0c4c9a02f4886148fd917ec1f83cdc386
+  data.tar.gz: fe1db6e87b0788868ab99a4c5ee2c818fb2720b8aaa88a59d86023a8a4bc0f92
 SHA512:
-  metadata.gz: cf37a0c4d1ac19450ae702ee22b4f460d8b16528a00603d1cbb0fbad6ff5d6b8caf1dca90ff9ec0834683f56651af76ec0d14465c244d3e95482c76a8fcf9ccc
-  data.tar.gz: f150bd31c92462f5c1594368816aaaa60fe6e17ec4e4e0cb67d8b0ff7c0732be9d544df040548c6c80050fea6e66d6f21cf960dcec1b4af6bec4cbb4c318bb24
+  metadata.gz: 17141eaefe36c4ee6e857fe36ae3ee7c9e500cb6b3dc07ba79b2ba20248cb1a01920d5f0441c09279af0ab04efa020ffe144aeef1f4fb00036094378c1e2fc65
+  data.tar.gz: 8bf37d00fc3b161eb84587eef5562cebe493adb6a0729897f00aed9d38a69b1847ba82781473a8d2b3deb4ad1acea764b014460a758bc12ef686028096974355

data/README.md

@@ -60,7 +60,13 @@ Rails Pulse is a comprehensive performance monitoring and debugging gem that pro
 
 ## Screenshots
 
-<img src="app/assets/images/rails_pulse/dashboard.png" alt="Rails Pulse" />
+<table>
+  <tr>
+    <td><img src="app/assets/images/rails_pulse/dashboard.png" alt="Rails Pulse Dashboard" width="400" /></td>
+    <td><img src="app/assets/images/rails_pulse/request.png" alt="Rails Pulse Requests" width="400" /></td>
+  </tr>
+</table>
+
 
 ## Getting Started
 
@@ -81,15 +87,22 @@ bundle install
 Generate the installation files:
 
 ```bash
+# Install with single database setup (default - recommended)
 rails generate rails_pulse:install
-```
 
-Load the database schema:
+# Or install with separate database setup
+rails generate rails_pulse:install --database=separate
+```
 
+**For single database setup (default):**
 ```bash
-rails db:prepare
+rails db:migrate    # Creates Rails Pulse tables in your main database
 ```
 
+**For separate database setup:**
+1. Configure `config/database.yml` with your Rails Pulse database settings
+2. Run: `rails db:prepare` to create and load the schema
+
 Add the Rails Pulse route to your application:
 
 ```ruby
@@ -101,10 +114,10 @@ end
 Schedule background jobs:
 
 ```ruby
-# Schedule to run 5 minutes past every hour
+# Schedule to run 5 minutes past every hour. cron: 5 * * * *
 RailsPulse::SummaryJob.perform_later
 
-# Schedule to run daily
+# Schedule to run daily. cron: 0 1 * * *
 RailsPulse::CleanupJob.perform_later
 ```
 
@@ -116,6 +129,10 @@ Rails Pulse automatically starts collecting performance data once installed. Acc
 http://localhost:3000/rails_pulse
 ```
 
+**Database Setup:**
+- **Single Database (default)**: Rails Pulse tables are created in your main database - no additional configuration needed
+- **Separate Database**: See the [Separate Database Support](#separate-database-support) section for setup instructions
+
 ### Basic Configuration
 
 Customize Rails Pulse in `config/initializers/rails_pulse.rb`:
@@ -281,20 +298,36 @@ RailsPulse::CleanupJob.perform_later
 
 ## Separate Database Support
 
-Rails Pulse supports storing performance monitoring data in a **separate database**. By default, Rails Pulse stores data in your main application database alongside your existing tables.
+Rails Pulse offers two database setup options to fit your application's needs:
+
+### Option 1: Single Database (Default - Recommended)
+
+Stores Rails Pulse data in your main application database alongside your existing tables. This is the simplest setup and works great for most applications.
+
+**Advantages:**
+- Zero additional configuration required
+- Simpler backup and deployment strategies
+- Works with any database (SQLite, PostgreSQL, MySQL)
+
+**Installation:**
+```bash
+rails generate rails_pulse:install
+rails db:migrate
+```
 
-Use a separate database when you want:
+### Option 2: Separate Database
 
+Stores Rails Pulse data in a dedicated database, completely isolated from your main application.
+
+**Use a separate database when you want:**
 - **Isolating monitoring data** from your main application database
 - **Using different database engines** optimized for time-series data
 - **Scaling monitoring independently** from your application
 - **Simplified backup strategies** with separate retention policies
 
-**For shared database setup (default)**, no database configuration is needed - simply run `rails db:prepare` after installation.
-
 ### Configuration
 
-To use a separate database, configure the `connects_to` option in your Rails Pulse initializer:
+To use a separate database, install with the `--database=separate` flag, then configure the `connects_to` option in your Rails Pulse initializer:
 
 ```ruby
 RailsPulse.configure do |config|
@@ -350,17 +383,30 @@ production:
     pool: 5
 ```
 
-### Schema Loading
+### Installation Steps
 
-After installation, load the Rails Pulse database schema:
+**For separate database setup:**
 
-```bash
-rails db:prepare
-```
+1. **Generate installation files:**
+   ```bash
+   rails generate rails_pulse:install --database=separate
+   ```
+
+2. **Configure `config/database.yml`** (see examples above)
+
+3. **Create and load the schema:**
+   ```bash
+   rails db:prepare
+   ```
+   This automatically creates the database and loads the Rails Pulse schema.
+
+**Schema Management:**
 
-This command works for both:
-- Shared database setup (default): Loads tables into your main application database
-- Separate database setup: Automatically loads tables into your configured Rails Pulse database
+The schema file `db/rails_pulse_schema.rb` serves as your single source of truth for the database structure. It:
+- Defines all Rails Pulse tables in one place
+- Is loaded by the installation migration
+- Should not be deleted or modified
+- Future updates will provide migrations in `db/rails_pulse_migrate/`
 
 ## Testing
 
@@ -447,7 +493,7 @@ Test individual databases locally:
 # Test with SQLite (default)
 rails test:all
 
-# Test with PostgreSQL  
+# Test with PostgreSQL
 DB=postgresql FORCE_DB_CONFIG=true rails test:all
 
 # Test with MySQL (local only)

data/Rakefile

@@ -1,109 +1,192 @@
 require "bundler/setup"
+require "bundler/gem_tasks"
 
 # Load environment variables from .env file
 require "dotenv/load" if File.exist?(".env")
 
 APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
 load "rails/tasks/engine.rake"
-load "rails/tasks/statistics.rake"
 
-require "bundler/gem_tasks"
+desc "Setup database for testing"
+task :test_setup do
+  database = ENV['DB'] || 'sqlite3'
+
+  puts "\n" + "=" * 50
+  puts "🛠️  Rails Pulse Test Setup"
+  puts "=" * 50
+  puts "Database: #{database.upcase}"
+  puts "=" * 50
+  puts
+
+  begin
+    # Remove schema.rb to ensure clean migration
+    schema_file = "test/dummy/db/schema.rb"
+    if File.exist?(schema_file)
+      puts "🧹 Removing existing schema.rb file..."
+      File.delete(schema_file)
+    end
 
-# Test tasks
-namespace :test do
-  desc "Run unit tests (models, helpers, services, instrumentation)"
-  task :unit do
-    sh "rails test test/models test/helpers test/services test/support test/instrumentation"
-  end
+    case database.downcase
+    when 'sqlite3', 'sqlite'
+      puts "📦 Setting up SQLite database..."
+      sh "RAILS_ENV=test bin/rails db:drop db:create db:migrate"
+
+    when 'mysql2', 'mysql'
+      puts "🐬 Setting up MySQL database..."
+      sh "DB=mysql2 RAILS_ENV=test rails db:drop db:create db:migrate"
+
+    when 'postgresql', 'postgres'
+      puts "🐘 Setting up PostgreSQL database..."
+      sh "DB=postgresql RAILS_ENV=test rails db:drop db:create db:migrate"
+
+    else
+      puts "⚠️  Unknown database: #{database}"
+      puts "Supported databases: sqlite3, mysql2, postgresql"
+      exit 1
+    end
 
-  desc "Run functional tests (controllers)"
-  task :functional do
-    sh "rails test test/controllers"
+    puts "\n✅ Database setup complete!"
+    puts "Ready to run: rake test"
+
+  rescue => e
+    puts "\n❌ Database setup failed!"
+    puts "Error: #{e.message}"
+    puts "\nTroubleshooting:"
+    puts "• Ensure #{database} is installed and running"
+    puts "• Check database credentials in test/dummy/config/database.yml"
+    puts "• Verify RAILS_ENV=test environment is configured"
+    exit 1
   end
+end
 
-  desc "Run integration tests"
-  task :integration do
-    sh "rails test test/integration test/system"
+desc "Run test suite"
+task :test do
+  database = ENV['DB'] || 'sqlite3'
+
+  # Get Rails version from Gemfile.lock or fallback
+  rails_version = begin
+    require 'rails'
+    Rails.version
+  rescue LoadError
+    # Try to get from Gemfile.lock
+    gemfile_lock = File.read('Gemfile.lock') rescue nil
+    if gemfile_lock && gemfile_lock.match(/rails \(([^)]+)\)/)
+      $1
+    else
+      'unknown'
+    end
   end
 
-  desc "Run all tests"
-  task :all do
-    sh "rails test"
+  puts "\n" + "=" * 50
+  puts "💛 Rails Pulse Test Suite"
+  puts "=" * 50
+  puts "Database: #{database.upcase}"
+  puts "Rails: #{rails_version}"
+  puts "=" * 50
+  puts
+
+  sh "rails test test/controllers test/helpers test/instrumentation test/jobs test/models test/services test/system"
+end
+
+desc "Setup database for specific Rails version and database"
+task :test_setup_for_version, [ :database, :rails_version ] do |t, args|
+  database = args[:database] || ENV['DB'] || 'sqlite3'
+  rails_version = args[:rails_version] || 'rails-8-0'
+
+  puts "\n" + "=" * 50
+  puts "🛠️  Rails Pulse Test Setup"
+  puts "=" * 50
+  puts "Database: #{database.upcase}"
+  puts "Rails: #{rails_version.upcase.gsub('-', ' ')}"
+  puts "=" * 50
+  puts
+
+  begin
+    # Remove schema.rb to ensure clean migration
+    schema_file = "test/dummy/db/schema.rb"
+    if File.exist?(schema_file)
+      puts "🧹 Removing existing schema.rb file..."
+      File.delete(schema_file)
+    end
+
+    if rails_version == "rails-8-0" && database == "sqlite3"
+      # Use current default setup
+      puts "📦 Setting up #{database.upcase} database with Rails 8.0..."
+      sh "RAILS_ENV=test bin/rails db:drop db:create db:migrate"
+    else
+      # Use appraisal with specific database and Rails version
+      puts "📦 Setting up #{database.upcase} database with #{rails_version.upcase.gsub('-', ' ')}..."
+      sh "DB=#{database} bundle exec appraisal #{rails_version} rails db:drop db:create db:migrate RAILS_ENV=test"
+    end
+
+    puts "\n✅ Database setup complete for #{database.upcase} + #{rails_version.upcase.gsub('-', ' ')}!"
+
+  rescue => e
+    puts "\n❌ Database setup failed!"
+    puts "Error: #{e.message}"
+    exit 1
   end
+end
 
-  desc "Run tests across all database and Rails version combinations (local only - CI uses sqlite3 + postgresql)"
-  task :matrix do
-    databases = [ "sqlite3", "postgresql", "mysql2" ]
-    rails_versions = [ "rails-7-2", "rails-8-0" ]
-
-    failed_combinations = []
-
-    databases.each do |database|
-      rails_versions.each do |rails_version|
-        puts "\n" + "=" * 80
-        puts "🧪 Local Testing: #{database.upcase} + #{rails_version.upcase}"
-        puts "(CI only tests SQLite3 + PostgreSQL for reliability)"
-        puts "=" * 80
-
-        begin
-          gemfile = "gemfiles/#{rails_version.gsub('-', '_')}.gemfile"
-
-          # Set environment variables
-          env_vars = {
-            "DB" => database,
-            "BUNDLE_GEMFILE" => gemfile,
-            "FORCE_DB_CONFIG" => "true"
-          }
-
-          # Add database-specific environment variables
-          case database
-          when "postgresql"
-            env_vars.merge!({
-              "POSTGRES_USERNAME" => ENV.fetch("POSTGRES_USERNAME", "postgres"),
-              "POSTGRES_PASSWORD" => ENV.fetch("POSTGRES_PASSWORD", ""),
-              "POSTGRES_HOST" => ENV.fetch("POSTGRES_HOST", "localhost"),
-              "POSTGRES_PORT" => ENV.fetch("POSTGRES_PORT", "5432")
-            })
-          when "mysql2"
-            env_vars.merge!({
-              "MYSQL_USERNAME" => ENV.fetch("MYSQL_USERNAME", "root"),
-              "MYSQL_PASSWORD" => ENV.fetch("MYSQL_PASSWORD", "password"),
-              "MYSQL_HOST" => ENV.fetch("MYSQL_HOST", "localhost"),
-              "MYSQL_PORT" => ENV.fetch("MYSQL_PORT", "3306")
-            })
-          end
-
-          # Build environment string
-          env_string = env_vars.map { |k, v| "#{k}=#{v}" }.join(" ")
-
-          # Run the test command
-          sh "#{env_string} bundle exec rails test:all"
-
-          puts "✅ PASSED: #{database} + #{rails_version}"
-
-        rescue => e
-          puts "❌ FAILED: #{database} + #{rails_version}"
-          puts "Error: #{e.message}"
-          failed_combinations << "#{database} + #{rails_version}"
+desc "Test all database and Rails version combinations"
+task :test_matrix do
+  databases = %w[sqlite3 postgresql mysql2]
+  rails_versions = %w[rails-7-2 rails-8-0]
+
+  failed_combinations = []
+  total_combinations = databases.size * rails_versions.size
+  current = 0
+
+  puts "\n" + "=" * 60
+  puts "🚀 Rails Pulse Full Test Matrix"
+  puts "=" * 60
+  puts "Testing #{total_combinations} combinations..."
+  puts "=" * 60
+
+  databases.each do |database|
+    rails_versions.each do |rails_version|
+      current += 1
+
+      puts "\n[#{current}/#{total_combinations}] Testing: #{database.upcase} + #{rails_version.upcase.gsub('-', ' ')}"
+      puts "-" * 50
+
+      begin
+        # First setup the database for this specific combination
+        Rake::Task[:test_setup_for_version].reenable
+        Rake::Task[:test_setup_for_version].invoke(database, rails_version)
+
+        # Then run the tests
+        if rails_version == "rails-8-0" && database == "sqlite3"
+          # Current default setup
+          sh "bundle exec rake test"
+        else
+          # Use appraisal with specific database
+          sh "DB=#{database} bundle exec appraisal #{rails_version} rake test"
         end
-      end
-    end
 
-    puts "\n" + "=" * 80
-    puts "🏁 Local Test Matrix Results"
-    puts "(CI automatically tests SQLite3 + PostgreSQL only)"
-    puts "=" * 80
+        puts "✅ PASSED: #{database} + #{rails_version}"
 
-    if failed_combinations.empty?
-      puts "✅ All combinations passed!"
-    else
-      puts "❌ Failed combinations:"
-      failed_combinations.each { |combo| puts "  - #{combo}" }
-      exit 1
+      rescue => e
+        puts "❌ FAILED: #{database} + #{rails_version}"
+        puts "   Error: #{e.message}"
+        failed_combinations << "#{database} + #{rails_version}"
+      end
     end
   end
+
+  puts "\n" + "=" * 60
+  puts "🏁 Test Matrix Results"
+  puts "=" * 60
+
+  if failed_combinations.empty?
+    puts "🎉 All #{total_combinations} combinations passed!"
+  else
+    puts "✅ Passed: #{total_combinations - failed_combinations.size}/#{total_combinations}"
+    puts "❌ Failed combinations:"
+    failed_combinations.each { |combo| puts "   • #{combo}" }
+    exit 1
+  end
 end
 
-# Override default test task
-desc "Run all tests"
-task test: "test:all"
+
+task default: :test

data/app/assets/stylesheets/rails_pulse/application.css

@@ -4,25 +4,48 @@
 
 a {
   text-decoration: underline;
-  color: #0048b5;
+  color: var(--color-link);
 }
 
 #header {
-  background-color: #ffc91f;
+  background-color: var(--header-bg);
 }
 
 #header a {
-  color: black
+  color: var(--header-link);
+  text-decoration: none;
 }
 
 #header a:hover {
-  background-color: #ffe284;
+  background-color: transparent;
+  text-decoration: underline;
 }
 
 a:hover {
   cursor: pointer;
 }
 
+/* Dark mode */
+
+/* Dark scheme tweaks via component variables */
+html[data-color-scheme="dark"] .card {
+  /* Scope card surfaces slightly darker than page */
+  --color-bg: rgb(47, 47, 47);
+  --color-border: rgb(64, 64, 64);
+}
+
+/* Header colors are handled by --header-* tokens in base.css */
+
+html[data-color-scheme="dark"] .badge--positive-inverse,
+html[data-color-scheme="dark"] .badge--negative-inverse {
+  --badge-background: rgb(47, 47, 47);
+}
+
+html[data-color-scheme="dark"] .input {
+  --input-background: #535252;
+  --input-border-color: #7e7d7d;
+}
+
 .hidden {
   display: none;
 }
@@ -66,7 +89,7 @@ a:hover {
   height: 16px;
   padding: 2px;
   position: absolute;
-  top: 11px;
+  top: 20px;
 }
 
 /* REQUEST OPERATIONS BAR */

data/app/assets/stylesheets/rails_pulse/components/badge.css

@@ -56,3 +56,16 @@
   --badge-border-color: transparent;
   --badge-color: var(--color-negative);
 }
+
+/* Trend badge icon lightening (dark mode only) */
+.badge--trend rails-pulse-icon { color: var(--badge-color, currentColor); }
+html[data-color-scheme="dark"] .badge--trend rails-pulse-icon {
+  /* Lighten icon relative to badge text color for contrast */
+  color: color-mix(in srgb, var(--badge-color) 55%, white 45%);
+}
+
+/* Trend amount lightening (dark mode only) */
+.badge--trend .badge__trend-amount { color: var(--badge-color, currentColor); }
+html[data-color-scheme="dark"] .badge--trend .badge__trend-amount {
+  color: color-mix(in srgb, var(--badge-color) 55%, white 45%);
+}

data/app/assets/stylesheets/rails_pulse/components/base.css

@@ -5,6 +5,10 @@
   --color-text-reversed: white;
   --color-text-subtle: var(--zinc-500);
   --color-link: var(--blue-700);
+  /* Header tokens */
+  --header-bg: #ffc91f;
+  --header-link: black;
+  --header-link-hover-bg: #ffe284;
   --color-border-light: var(--zinc-100);
   --color-border: var(--zinc-200);
   --color-border-dark: var(--zinc-400);
@@ -30,8 +34,9 @@ html[data-color-scheme="dark"] {
   --color-bg: var(--zinc-800);
   --color-text: white;
   --color-text-reversed: black;
-  --color-text-subtle: var(--zinc-400);
-  --color-link: var(--blue-400);
+  --color-text-subtle: var(--zinc-300);
+  /* Use brand yellow for links in dark mode */
+  --color-link: #ffc91f;
   --color-border-light: var(--zinc-900);
   --color-border: var(--zinc-800);
   --color-border-dark: var(--zinc-600);
@@ -39,6 +44,11 @@ html[data-color-scheme="dark"] {
   --color-selected-dark: var(--blue-800);
   --color-highlight: var(--yellow-900);
 
+  /* Header tokens */
+  --header-bg: rgb(32, 32, 32);
+  --header-link: #ffc91f;
+  --header-link-hover-bg: #ffe284; /* keep existing hover color */
+
   /* Accent colors */
   --color-primary: var(--zinc-50);
   --color-secondary: var(--zinc-800);

data/app/assets/stylesheets/rails_pulse/components/collapsible.css

@@ -0,0 +1,30 @@
+.collapsible-code.collapsed pre {
+  max-height: 4.5em;
+  overflow: hidden;
+  position: relative;
+}
+
+.collapsible-code.collapsed pre::after {
+  content: '';
+  position: absolute;
+  bottom: 0;
+  left: 0;
+  right: 0;
+  height: 1em;
+  background: linear-gradient(transparent, var(--color-border-light));
+  pointer-events: none;
+}
+
+.collapsible-toggle {
+  margin-top: 0.5rem;
+  font-size: 0.875rem;
+  color: var(--color-link);
+  text-decoration: underline;
+  transform: lowercase;
+  cursor: pointer;
+  border: none;
+  background: none;
+  padding: 0;
+  font-weight: normal;
+  margin-left: 10px;
+}

data/app/assets/stylesheets/rails_pulse/components/popover.css

@@ -31,6 +31,5 @@
     left: var(--popover-x, 0) !important;
     top: var(--popover-y, 0) !important;
     margin: 0 !important;
-    inset: unset !important;
   }
 }

data/app/assets/stylesheets/rails_pulse/components/row.css

@@ -3,22 +3,74 @@
   justify-content: space-between;
   width: 100%;
   gap: var(--column-gap, 0.5rem);
+  align-items: stretch;
 }
 
 .row > * {
   flex: 1;
   min-width: 0;
+  display: flex;
+  flex-direction: column;
 }
 
-/* Stack items on smaller screens */
+/* Ensure metric cards and their panels stretch to full height */
+.row > .grid-item {
+  display: flex;
+  flex-direction: column;
+}
+
+.row > .grid-item > * {
+  flex: 1;
+}
+
+/* Responsive layout for screens smaller than 768px */
 @media (max-width: 768px) {
   .row {
-      flex-direction: column;
+      display: flex;
+      flex-wrap: wrap;
+      justify-content: space-between;
       gap: 0.5rem;
+      align-items: flex-start;
   }
 
   .row > * {
+      flex: 0 0 calc(50% - 0.25rem);
+      min-width: 0;
+      height: auto;
+  }
+
+  .row > .grid-item {
+      height: auto;
+  }
+
+  .row > .grid-item > * {
       flex: none;
-      width: 100%;
+  }
+
+  /* Tables should stack in single column on mobile */
+  .row:has(.table-container) > * {
+      flex: 0 0 100%;
+  }
+
+  /* Single column for very small screens */
+  @media (max-width: 480px) {
+    .row > * {
+        flex: 0 0 100%;
+    }
+
+    .row > .grid-item {
+        min-height: auto;
+    }
+
+    /* Make metric cards more compact on mobile */
+    .row > .grid-item .card {
+        padding: var(--size-3);
+    }
+
+    /* Make charts smaller on mobile */
+    .row > .grid-item .chart-container {
+        height: 60px !important;
+        max-height: 60px;
+    }
   }
 }