sqlite_dashboard 1.0.0

data/app/views/sqlite_dashboard/databases/_error.html.erb

@@ -0,0 +1,5 @@
+<div id="query-results">
+  <div class="error-message">
+    <i class="fas fa-exclamation-circle"></i> <strong>Error:</strong> <%= error %>
+  </div>
+</div>

data/app/views/sqlite_dashboard/databases/execute_query.turbo_stream.erb

@@ -0,0 +1,37 @@
+<%= turbo_stream.replace "query-results" do %>
+  <div id="query-results">
+    <% if @results[:columns].present? %>
+      <div class="table-wrapper">
+        <table class="table table-striped table-hover table-bordered">
+          <thead class="table-dark">
+            <tr>
+              <% @results[:columns].each do |column| %>
+                <th><%= column %></th>
+              <% end %>
+            </tr>
+          </thead>
+          <tbody>
+            <% @results[:rows].each do |row| %>
+              <tr>
+                <% row.each do |value| %>
+                  <td><%= value %></td>
+                <% end %>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      </div>
+      <div class="mt-3">
+        <small class="text-muted">
+          <%= pluralize(@results[:rows].size, 'row') %> returned
+        </small>
+      </div>
+    <% elsif @results[:message].present? %>
+      <div class="success-message">
+        <i class="fas fa-check-circle"></i> <%= @results[:message] %>
+      </div>
+    <% end %>
+  </div>
+<% end %>
+
+<%= turbo_stream.update "query", @query %>

data/app/views/sqlite_dashboard/databases/index.html.erb

@@ -0,0 +1,97 @@
+<div class="databases-index-page">
+  <div class="row g-0" style="min-height: 100vh;">
+    <!-- Sidebar -->
+    <div class="col-md-2 sidebar index-sidebar">
+      <div class="p-3">
+        <div class="sidebar-brand">
+          <i class="fas fa-database"></i>
+          <div>
+            <h6 class="mb-0">SQLite Dashboard</h6>
+            <small class="text-muted">Database Manager</small>
+          </div>
+        </div>
+
+        <div class="sidebar-stats mt-4">
+          <div class="stat-item">
+            <i class="fas fa-server"></i>
+            <div>
+              <div class="stat-value"><%= @databases.count %></div>
+              <div class="stat-label">Database<%= @databases.count != 1 ? 's' : '' %></div>
+            </div>
+          </div>
+        </div>
+
+        <% if @databases.any? %>
+          <div class="mt-4">
+            <h6 class="text-muted mb-2" style="font-size: 0.75rem; text-transform: uppercase; letter-spacing: 0.05em;">Quick Access</h6>
+            <ul class="database-list">
+              <% @databases.each do |database| %>
+                <li>
+                  <%= link_to database_path(database[:id]), class: "database-link" do %>
+                    <i class="fas fa-database"></i>
+                    <span><%= database[:name] %></span>
+                    <i class="fas fa-chevron-right ms-auto"></i>
+                  <% end %>
+                </li>
+              <% end %>
+            </ul>
+          </div>
+        <% end %>
+      </div>
+    </div>
+
+    <!-- Main content -->
+    <div class="col-md-10" style="background-color: var(--main-bg); min-height: 100vh;">
+      <div class="index-main-content">
+        <div class="content-header">
+          <h1 class="page-title">
+            <i class="fas fa-server"></i>
+            Your Databases
+          </h1>
+          <p class="page-subtitle">Select a database to explore and manage</p>
+        </div>
+
+        <% if @databases.any? %>
+          <div class="databases-grid">
+            <% @databases.each do |database| %>
+              <div class="database-card-modern">
+                <div class="database-card-icon">
+                  <i class="fas fa-database"></i>
+                </div>
+                <div class="database-card-content">
+                  <h3 class="database-card-title"><%= database[:name] %></h3>
+                  <p class="database-card-path">
+                    <i class="fas fa-folder-open"></i>
+                    <%= database[:path] %>
+                  </p>
+                </div>
+                <div class="database-card-actions">
+                  <%= link_to database_path(database[:id]), class: "btn btn-primary btn-card-action" do %>
+                    <i class="fas fa-arrow-right"></i>
+                    Open Dashboard
+                  <% end %>
+                </div>
+              </div>
+            <% end %>
+          </div>
+        <% else %>
+          <div class="empty-state-modern">
+            <div class="empty-state-icon">
+              <i class="fas fa-database"></i>
+            </div>
+            <h3>No Databases Configured</h3>
+            <p>Configure databases in your application's initializer to get started</p>
+            <div class="empty-state-code">
+              <pre><code>SqliteDashboard.configure do |config|
+  config.db_files = [
+    { name: "Development", path: Rails.root.join("db/development.sqlite3").to_s },
+    { name: "Production", path: Rails.root.join("db/production.sqlite3").to_s }
+  ]
+end</code></pre>
+            </div>
+          </div>
+        <% end %>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/sqlite_dashboard/databases/show.html.erb

@@ -0,0 +1,60 @@
+<div class="row g-0" style="height: 100vh;">
+  <!-- Sidebar with tables -->
+  <div class="col-md-2 sidebar">
+    <div class="p-3">
+      <h6 class="mb-3">
+        <i class="fas fa-database"></i> <%= @database[:name] %>
+      </h6>
+      <%= link_to "← Back to Databases", databases_path, class: "btn btn-sm btn-outline-secondary mb-3" %>
+
+      <h6 class="mb-2">Tables</h6>
+      <ul class="table-sidebar" data-controller="table-selector">
+        <% @tables.each do |table| %>
+          <li data-action="click->table-selector#selectTable"
+              data-table-name="<%= table %>"
+              data-table-selector-target="tableItem">
+            <i class="fas fa-table"></i> <%= table %>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  </div>
+
+  <!-- Main content area -->
+  <div class="col-md-10 main-content">
+    <!-- Query Console -->
+    <div class="query-console">
+      <%= form_with url: execute_query_database_path(@database[:id]),
+                    method: :post,
+                    data: {
+                      controller: "query-executor",
+                      action: "submit->query-executor#execute"
+                    } do |form| %>
+        <div class="mb-3">
+          <label for="query" class="form-label fw-bold">SQL Query</label>
+          <textarea name="query"
+                    id="query"
+                    class="form-control query-textarea"
+                    data-query-executor-target="queryInput"
+                    placeholder="Enter your SQL query here..."><%= params[:query] || "SELECT * FROM sqlite_master WHERE type='table';" %></textarea>
+        </div>
+        <div class="d-flex gap-2">
+          <button type="submit" class="btn btn-primary">
+            <i class="fas fa-play"></i> Execute Query
+          </button>
+          <button type="button" class="btn btn-outline-secondary" data-action="click->query-executor#clear">
+            <i class="fas fa-eraser"></i> Clear
+          </button>
+        </div>
+      <% end %>
+    </div>
+
+    <!-- Results Container -->
+    <div class="results-container" id="query-results">
+      <div class="text-muted text-center py-5">
+        <i class="fas fa-database fa-3x mb-3"></i>
+        <p>Execute a query to see results</p>
+      </div>
+    </div>
+  </div>
+</div>

data/config/importmap.rb

@@ -0,0 +1,2 @@
+pin "sqlite_dashboard/application"
+pin_all_from File.expand_path("../app/javascript/controllers", __dir__), under: "controllers", to: "sqlite_dashboard/controllers"

data/config/routes.rb

@@ -0,0 +1,13 @@
+SqliteDashboard::Engine.routes.draw do
+  root to: "databases#index"
+
+  resources :databases, only: [:index, :show] do
+    member do
+      post :execute_query
+      post :export_csv
+      post :export_json
+      get :tables
+      get :table_schema
+    end
+  end
+end

data/lib/generators/sqlite_dashboard/install_generator.rb

@@ -0,0 +1,58 @@
+require 'rails/generators'
+
+module SqliteDashboard
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Install SQLite Dashboard in your Rails application"
+
+      source_root File.expand_path("templates", __dir__)
+
+      def create_initializer
+        template "initializer.rb", "config/initializers/sqlite_dashboard.rb"
+      end
+
+      def add_route
+        route_content = <<-RUBY
+
+  # SQLite Dashboard Engine
+  mount SqliteDashboard::Engine => "/sqlite_dashboard"
+        RUBY
+
+        route route_content.strip
+      end
+
+      def display_readme
+        readme "README" if behavior == :invoke
+      end
+
+      private
+
+      def app_name
+        Rails.application.class.module_parent_name.underscore
+      end
+
+      def database_paths
+        paths = []
+
+        # Common Rails database locations
+        if File.exist?(Rails.root.join("storage", "development.sqlite3"))
+          paths << 'Rails.root.join("storage", "development.sqlite3").to_s'
+        end
+
+        if File.exist?(Rails.root.join("db", "development.sqlite3"))
+          paths << 'Rails.root.join("db", "development.sqlite3").to_s'
+        end
+
+        if File.exist?(Rails.root.join("storage", "test.sqlite3"))
+          paths << 'Rails.root.join("storage", "test.sqlite3").to_s'
+        end
+
+        if File.exist?(Rails.root.join("db", "test.sqlite3"))
+          paths << 'Rails.root.join("db", "test.sqlite3").to_s'
+        end
+
+        paths.empty? ? ['"/path/to/your/database.sqlite3"'] : paths
+      end
+    end
+  end
+end

data/lib/generators/sqlite_dashboard/templates/README

@@ -0,0 +1,51 @@
+===============================================================================
+
+SQLite Dashboard has been installed successfully!
+
+Next Steps:
+-----------
+
+1. Review the configuration in:
+   config/initializers/sqlite_dashboard.rb
+
+2. Update the database paths to match your SQLite files
+
+3. Start your Rails server:
+   rails server
+
+4. Visit the dashboard at:
+   http://localhost:3000/sqlite_dashboard
+
+Security Warning:
+-----------------
+SQLite Dashboard provides direct SQL access to your databases.
+
+For production or shared environments, add authentication:
+
+In config/routes.rb, replace the mount line with:
+
+  authenticate :user, ->(user) { user.admin? } do
+    mount SqliteDashboard::Engine => "/sqlite_dashboard"
+  end
+
+Or use HTTP Basic Auth by adding to the initializer:
+
+  SqliteDashboard::Engine.middleware.use Rack::Auth::Basic do |user, pass|
+    user == ENV['DASHBOARD_USER'] && pass == ENV['DASHBOARD_PASS']
+  end
+
+Features:
+---------
+✨ SQL syntax highlighting with autocomplete
+📊 Paginated query results
+🔍 Quick table browsing
+⌨️  Keyboard shortcuts (Ctrl/Cmd + Enter to execute)
+📱 Responsive design
+
+Documentation:
+--------------
+https://github.com/sqlite-dashboard/sqlite_dashboard
+
+Enjoy exploring your SQLite databases! 🎉
+
+===============================================================================

data/lib/generators/sqlite_dashboard/templates/initializer.rb

@@ -0,0 +1,28 @@
+# SQLite Dashboard Configuration
+#
+# Configure which SQLite databases you want to access through the dashboard.
+# Only configure databases you trust, as this provides direct SQL access.
+
+SqliteDashboard.configure do |config|
+  # Array of database configurations
+  # Each database should have a name and path
+  config.db_files = [
+    <% database_paths.each_with_index do |path, index| %>
+    {
+      name: "<%= index == 0 ? 'Development' : index == 1 ? 'Test' : "Database #{index + 1}" %>",
+      path: <%= path %>
+    }<%= index < database_paths.length - 1 ? ',' : '' %>
+    <% end %>
+  ]
+
+  # You can also add databases dynamically:
+  # config.add_database("Custom DB", "/path/to/custom.sqlite3")
+
+  # Security Note:
+  # For production use, wrap the mount in authentication:
+  #
+  # In config/routes.rb:
+  # authenticate :user, ->(user) { user.admin? } do
+  #   mount SqliteDashboard::Engine => "/sqlite_dashboard"
+  # end
+end

data/lib/sqlite_dashboard/configuration.rb

@@ -0,0 +1,89 @@
+module SqliteDashboard
+  class Configuration
+    attr_accessor :db_files, :allow_dml
+
+    def initialize
+      @db_files = []
+      @allow_dml = false
+    end
+
+    def add_database(name, path)
+      @db_files << { name: name, path: path }
+    end
+
+    def databases
+      # If no databases are configured, try to read from config/database.yml
+      databases_list = @db_files.empty? ? load_from_database_yml : @db_files
+
+      databases_list.map.with_index do |db, index|
+        { id: index, name: db[:name] || File.basename(db[:path], ".*"), path: db[:path] }
+      end
+    end
+
+    private
+
+    def load_from_database_yml
+      return [] unless defined?(Rails)
+
+      database_yml_path = Rails.root.join("config", "database.yml")
+      return [] unless File.exist?(database_yml_path)
+
+      begin
+        require 'yaml'
+        require 'erb'
+
+        yaml_content = ERB.new(File.read(database_yml_path)).result
+        config = YAML.safe_load(yaml_content, aliases: true)
+
+        current_env = Rails.env.to_s
+        env_config = config[current_env]
+
+        return [] unless env_config
+
+        databases = []
+
+        # Handle single database configuration
+        if env_config['adapter'] == 'sqlite3' && env_config['database']
+          database_path = resolve_database_path(env_config['database'])
+          databases << {
+            name: "#{current_env.titleize} DB",
+            path: database_path
+          } if database_path && File.exist?(database_path)
+        end
+
+        # Handle multiple databases configuration (Rails 6+)
+        if env_config.key?('primary') || env_config.any? { |k, v| v.is_a?(Hash) && v['adapter'] }
+          env_config.each do |key, db_config|
+            next unless db_config.is_a?(Hash)
+            next unless db_config['adapter'] == 'sqlite3'
+            next unless db_config['database']
+
+            database_path = resolve_database_path(db_config['database'])
+            if database_path && File.exist?(database_path)
+              db_name = key == 'primary' ? "#{current_env.titleize} DB" : "#{current_env.titleize} - #{key.titleize}"
+              databases << {
+                name: db_name,
+                path: database_path
+              }
+            end
+          end
+        end
+
+        databases
+      rescue => e
+        Rails.logger.warn("SqliteDashboard: Failed to load databases from database.yml: #{e.message}") if defined?(Rails.logger)
+        []
+      end
+    end
+
+    def resolve_database_path(database_path)
+      return nil if database_path.blank?
+
+      # Handle absolute paths
+      return database_path if Pathname.new(database_path).absolute?
+
+      # Handle relative paths
+      Rails.root.join(database_path).to_s if defined?(Rails)
+    end
+  end
+end

data/lib/sqlite_dashboard/engine.rb

@@ -0,0 +1,16 @@
+module SqliteDashboard
+  class Engine < ::Rails::Engine
+    isolate_namespace SqliteDashboard
+
+    config.autoload_paths << File.expand_path("../../app/models", __FILE__)
+    config.autoload_paths << File.expand_path("../../app/services", __FILE__)
+
+    initializer "sqlite_dashboard.assets.precompile" do |app|
+      app.config.assets.precompile += %w( sqlite_dashboard/application.js sqlite_dashboard/application.css )
+    end
+
+    initializer "sqlite_dashboard.importmap", before: "importmap" do |app|
+      app.config.importmap.paths << root.join("config/importmap.rb") if app.config.respond_to?(:importmap)
+    end
+  end
+end

data/lib/sqlite_dashboard/version.rb

@@ -0,0 +1,3 @@
+module SqliteDashboard
+  VERSION = "1.0.0"
+end

data/lib/sqlite_dashboard.rb

@@ -0,0 +1,17 @@
+require "sqlite_dashboard/version"
+require "sqlite_dashboard/engine"
+require "sqlite_dashboard/configuration"
+
+module SqliteDashboard
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/sqlite_dashboard.gemspec

@@ -0,0 +1,55 @@
+require_relative "lib/sqlite_dashboard/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "sqlite_dashboard"
+  spec.version     = SqliteDashboard::VERSION
+  spec.authors     = ["SQLite Dashboard Contributors"]
+  spec.email       = ["sqlite-dashboard@example.com"]
+  spec.homepage    = "https://github.com/giovapanasiti/sqlite_dashboard"
+  spec.summary     = "Beautiful SQLite database browser and query interface for Rails"
+  spec.description = <<~DESC
+    A feature-rich, mountable Rails engine that provides a beautiful web interface
+    for browsing and querying SQLite databases. Includes SQL syntax highlighting,
+    pagination, table browsing, and a responsive Bootstrap UI.
+  DESC
+  spec.license     = "MIT"
+
+  spec.metadata = {
+    "homepage_uri"          => spec.homepage,
+    "source_code_uri"       => "https://github.com/giovapanasiti/sqlite_dashboard",
+    "changelog_uri"         => "https://github.com/giovapanasiti/sqlite_dashboard/blob/main/CHANGELOG.md",
+    "bug_tracker_uri"       => "https://github.com/giovapanasiti/sqlite_dashboard/issues",
+    "documentation_uri"     => "https://github.com/giovapanasiti/sqlite_dashboard#readme",
+    "wiki_uri"              => "https://github.com/giovapanasiti/sqlite_dashboard/wiki",
+    "funding_uri"           => "https://github.com/sponsors/sqlite-dashboard",
+    "rubygems_mfa_required" => "true"
+  }
+
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    Dir[
+      "{app,config,db,lib}/**/*",
+      "LICENSE",
+      "Rakefile",
+      "README.md",
+      "CHANGELOG.md",
+      "*.gemspec"
+    ].reject { |f| File.directory?(f) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies
+  spec.add_dependency "rails", ">= 7.0.0"
+  spec.add_dependency "sqlite3", ">= 1.4"
+
+  # Development dependencies
+  spec.add_development_dependency "bundler", ">= 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "rubocop-rails", "~> 2.0"
+  spec.add_development_dependency "rubocop-minitest", "~> 0.15"
+  spec.add_development_dependency "yard", "~> 0.9"
+end