sqlite_dashboard 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 869bae55994f425455d02e3798d598d4d346a4d6bfa90f11898e0b4a1c36320f
-  data.tar.gz: 030f4f2c91332a9ef73e65eb5a06be94f38c7063c65cf17b538680b1c72b155f
+  metadata.gz: 9b1922be7426fe6320e16ad206a78512a2d4c70ab16b5193def19470ce5db413
+  data.tar.gz: 2d32502f6e3eb01188b9bc9091bc80c3e5dc1bb2bbc10de717c9c3c74c4730e7
 SHA512:
-  metadata.gz: a067bb74a549a6a34c9779ec167a7670c47505b76af208dfd7e2be02564d68bb9e0edda43ddab7c1b16e9ac43d13080d1f62045fee71d1cf1667fa79f00fd382
-  data.tar.gz: 2bfb94bd33407f7f22503934b532fa93f263f40f40ca5ae2dbb1acfcd25e2e1e6b0dc6bc2aa84448e64fa38498b4bdf5bef03b6e8938f72fc3b12ca11849383e
+  metadata.gz: 50368ebf1eaff776214f1c2602a1372b4d33d3ea660674a001d982091383562fc0eb0084ff46dfa11bbe7c5e61c83f215b96f678c22817ae827a8304abb3bd81
+  data.tar.gz: 4342fdd6a7043c89053ef5b004ca1726d1a4380d0f0cd93a81eff40a6fe347d2e7cbecd45cee1f056a04bddd248dc5a06d771a39e3f751dd88663917cf6749a4

data/README.md

@@ -5,18 +5,28 @@
 
 A beautiful, feature-rich SQLite database browser and query interface for Rails applications. Mount it as an engine in your Rails app to inspect and query your SQLite databases through a clean, modern interface.
 
-![SQLite Dashboard Screenshot](https://via.placeholder.com/800x400)
+## Screenshots
+
+### Database Selection
+![Database Dashboard](screenshots/dashboard.png)
+
+### Query Interface & Results
+![Query Details](screenshots/details.png)
 
 ## Features
 
-- 🎨 **Modern UI** with Bootstrap 5 and responsive design
+- 🎨 **Modern UI** with dark sidebar theme and responsive design
 - 🔍 **Multiple Database Support** - Configure and switch between multiple SQLite databases
+- 🗄️ **Auto-Detection** - Automatically discovers SQLite databases from `config/database.yml`
 - ✨ **SQL Syntax Highlighting** - CodeMirror editor with SQL syntax highlighting and autocomplete
-- 📊 **Interactive Query Results** - Paginated, sortable results with horizontal scrolling
+- 📊 **Interactive Query Results** - Client-side pagination with customizable rows per page
+- 💾 **Export Functionality** - Export results to CSV or JSON with custom formatting options
 - 🎯 **Quick Table Browse** - Click any table name to instantly query it
 - ⚡ **Fast & Lightweight** - No build tools required, works with Rails importmap
-- 🔐 **Safe for Development** - Read-only access to prevent accidental data modification
+- 🔒 **Read-Only Mode** - Prevents accidental data modification (configurable)
+- 🚫 **Security Controls** - DROP and ALTER operations always forbidden
 - ⌨️ **Keyboard Shortcuts** - `Ctrl/Cmd + Enter` to execute queries
+- 📱 **Fully Responsive** - Works beautifully on desktop and mobile devices
 
 ## Installation
 
@@ -29,10 +39,32 @@ gem 'sqlite_dashboard'
 And then execute:
 
 ```bash
-$ bundle install
+bundle install
+```
+
+## Quick Start (Recommended)
+
+The easiest way to install SQLite Dashboard is using the built-in generator:
+
+```bash
+rails generate sqlite_dashboard:install
+```
+
+This will:
+- ✅ Create an initializer at `config/initializers/sqlite_dashboard.rb`
+- ✅ Mount the engine in your routes at `/sqlite_dashboard`
+- ✅ Auto-detect your SQLite databases
+- ✅ Display helpful setup instructions
+
+Then start your Rails server and visit:
+
 ```
+http://localhost:3000/sqlite_dashboard
+```
+
+## Manual Configuration
 
-## Configuration
+If you prefer to set up manually:
 
 ### Step 1: Mount the Engine
 
@@ -52,19 +84,23 @@ Create an initializer `config/initializers/sqlite_dashboard.rb`:
 
 ```ruby
 SqliteDashboard.configure do |config|
+  # Option 1: Explicitly define databases
   config.db_files = [
     {
       name: "Development",
-      path: Rails.root.join("storage", "development.sqlite3").to_s
+      path: Rails.root.join("db", "development.sqlite3").to_s
     },
     {
       name: "Test",
-      path: Rails.root.join("storage", "test.sqlite3").to_s
+      path: Rails.root.join("db", "test.sqlite3").to_s
     }
   ]
 
-  # Or add databases dynamically:
-  # config.add_database("Custom DB", "/path/to/database.sqlite3")
+  # Option 2: Or leave empty to auto-detect from database.yml
+  # (Automatically loads SQLite databases for current environment)
+
+  # Security: Control write operations (default: false)
+  config.allow_dml = false  # Read-only mode
 end
 ```
 
@@ -95,6 +131,21 @@ http://localhost:3000/sqlite_dashboard
 - Adjust rows per page (10, 25, 50, 100, 500)
 - Navigate through pages with First, Previous, Next, Last buttons
 - See current position (e.g., "Showing 1 to 25 of 150 rows")
+- Client-side pagination for instant navigation
+
+### Export Query Results
+
+**CSV Export:**
+- Choose separator: comma, semicolon, tab, or pipe
+- Option to include/exclude headers as first row
+- Exports all query results (not just paginated view)
+
+**JSON Export:**
+- Two format options:
+  - Array of objects: `[{"col1": "val1", "col2": "val2"}, ...]`
+  - Object with columns & rows: `{"columns": [...], "rows": [...]}`
+- Pretty print option for formatted/readable JSON
+- Timestamped filenames for easy organization
 
 ### Keyboard Shortcuts
 
@@ -106,7 +157,26 @@ http://localhost:3000/sqlite_dashboard
 
 ⚠️ **Warning**: This gem provides direct SQL access to your databases.
 
-### Recommended Security Measures:
+### Built-in Security Features
+
+1. **Read-Only Mode by Default** - DML operations are disabled by default:
+
+```ruby
+# config/initializers/sqlite_dashboard.rb
+SqliteDashboard.configure do |config|
+  config.allow_dml = false  # Default: prevents INSERT, UPDATE, DELETE, CREATE, TRUNCATE
+end
+```
+
+2. **Always Forbidden Operations** - DROP and ALTER are always blocked, even when `allow_dml = true`:
+
+```ruby
+# These are NEVER allowed for safety:
+# - DROP TABLE/INDEX/VIEW
+# - ALTER TABLE
+```
+
+### Recommended Security Measures
 
 1. **Development Only** - Only mount in development environment:
 
@@ -117,7 +187,7 @@ if Rails.env.development?
 end
 ```
 
-2. **Authentication** - Add authentication with Devise or similar:
+2. **Authentication with Devise** - Add authentication for production use:
 
 ```ruby
 # config/routes.rb
@@ -126,25 +196,23 @@ authenticate :user, ->(user) { user.admin? } do
 end
 ```
 
-3. **Basic Auth** - Quick protection with HTTP Basic Auth:
+3. **HTTP Basic Auth** - Quick protection with HTTP Basic Auth:
 
 ```ruby
-# config/initializers/sqlite_dashboard.rb
+# config/initializers/sqlite_dashboard.rb or config/application.rb
 SqliteDashboard::Engine.middleware.use Rack::Auth::Basic do |username, password|
-  username == ENV['DASHBOARD_USER'] && password == ENV['DASHBOARD_PASS']
+  ActiveSupport::SecurityUtils.secure_compare(username, ENV['DASHBOARD_USER']) &
+  ActiveSupport::SecurityUtils.secure_compare(password, ENV['DASHBOARD_PASS'])
 end
 ```
 
-4. **Read-Only Mode** - Configure read-only database connections:
+4. **Enable DML Only When Needed** - Only allow write operations in trusted environments:
 
 ```ruby
-config.db_files = [
-  {
-    name: "Production (Read-Only)",
-    path: Rails.root.join("db/production.sqlite3").to_s,
-    readonly: true  # Coming in v2.0
-  }
-]
+SqliteDashboard.configure do |config|
+  # Use environment variables or Rails.env checks
+  config.allow_dml = Rails.env.development? || Rails.env.test?
+end
 ```
 
 ## Customization
@@ -329,13 +397,24 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/yourus
 
 ## Roadmap
 
-- [x] **v1.1** - Export results to CSV/JSON
-- [ ] **v1.2** - Query history and saved queries
-- [ ] **v1.3** - Database schema visualization
-- [ ] **v2.0** - Read-only mode enforcement
-- [ ] **v2.1** - Dark mode theme
-- [ ] **v2.2** - Multi-query execution
-- [ ] **v2.3** - Query performance analytics
+### Completed ✅
+- [x] **v1.0** - Core SQLite browser with modern UI
+- [x] **v1.0** - SQL syntax highlighting with CodeMirror
+- [x] **v1.0** - Client-side pagination
+- [x] **v1.0** - Auto-detection from database.yml
+- [x] **v1.0** - CSV & JSON export with options
+- [x] **v1.0** - Read-only mode with DML controls
+- [x] **v1.0** - Dark sidebar theme
+- [x] **v1.0** - Rails generator for easy installation
+
+### Planned 🚀
+- [ ] **v1.1** - Query history and saved queries
+- [ ] **v1.2** - Database schema visualization
+- [ ] **v1.3** - Table relationships diagram
+- [ ] **v1.4** - Query performance analytics
+- [ ] **v2.0** - Multi-query execution
+- [ ] **v2.1** - Full dark mode theme toggle
+- [ ] **v2.2** - SQL query builder UI
 
 ## License
 
@@ -343,7 +422,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Credits
 
-Created by [Your Name](https://github.com/yourusername)
+Created by [Giovanni Panasiti](https://github.com/giovapanasiti)
 
 Special thanks to:
 - [CodeMirror](https://codemirror.net/) for the SQL editor
@@ -352,9 +431,7 @@ Special thanks to:
 
 ## Support
 
-- 🐛 [Report bugs](https://github.com/yourusername/sqlite_dashboard/issues)
-- 💡 [Request features](https://github.com/yourusername/sqlite_dashboard/issues)
-- 📧 [Email support](mailto:your.email@example.com)
+- 📧 [Email support](mailto:giova.panasiti@hey.com)
 
 ---
 

data/app/controllers/sqlite_dashboard/databases_controller.rb

@@ -5,15 +5,22 @@ require 'json'
 module SqliteDashboard
   class DatabasesController < ApplicationController
     before_action :set_database, only: [:show, :execute_query, :export_csv, :export_json, :tables, :table_schema]
+    before_action :set_saved_query, only: [:destroy_saved_query]
 
     def index
       @databases = SqliteDashboard.configuration.databases
+      @saved_queries = SavedQuery.recent.limit(10)
     end
 
     def show
       @tables = fetch_tables
     end
 
+    def worksheet
+      @databases = SqliteDashboard.configuration.databases
+      @saved_queries = SavedQuery.recent.limit(20)
+    end
+
     def execute_query
       @query = params[:query]
 
@@ -166,8 +173,52 @@ module SqliteDashboard
       end
     end
 
+    # Saved Queries actions
+    def saved_queries
+      @saved_queries = SavedQuery.recent
+      database_name = params[:database_name]
+      @saved_queries = @saved_queries.for_database(database_name) if database_name.present?
+
+      render json: @saved_queries
+    end
+
+    def create_saved_query
+      @saved_query = SavedQuery.new(saved_query_params)
+
+      if @saved_query.save
+        render json: @saved_query, status: :created
+      else
+        render json: { error: @saved_query.errors.full_messages.join(", ") }, status: :unprocessable_entity
+      end
+    end
+
+    def show_saved_query
+      @saved_query = SavedQuery.find(params[:id])
+      render json: @saved_query
+    rescue ActiveRecord::RecordNotFound
+      render json: { error: "Saved query not found" }, status: :not_found
+    end
+
+    def destroy_saved_query
+      if @saved_query.destroy
+        render json: { message: "Query deleted successfully" }
+      else
+        render json: { error: "Failed to delete query" }, status: :unprocessable_entity
+      end
+    end
+
     private
 
+    def set_saved_query
+      @saved_query = SavedQuery.find(params[:id])
+    rescue ActiveRecord::RecordNotFound
+      render json: { error: "Saved query not found" }, status: :not_found
+    end
+
+    def saved_query_params
+      params.require(:saved_query).permit(:name, :query, :database_name, :description)
+    end
+
     def set_database
       @database = SqliteDashboard.configuration.databases.find { |db| db[:id] == params[:id].to_i }
       redirect_to databases_path, alert: "Database not found" unless @database