sqlite_dashboard 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 869bae55994f425455d02e3798d598d4d346a4d6bfa90f11898e0b4a1c36320f
-  data.tar.gz: 030f4f2c91332a9ef73e65eb5a06be94f38c7063c65cf17b538680b1c72b155f
+  metadata.gz: b4be508c9964d5d3bc9e646bc297639297b468a52a3c38e9bae24d91579c63c0
+  data.tar.gz: 403c530bbcaacfc2d7eca3181a32386971d5b1bf5bd7348ce8e7e70668cc08c6
 SHA512:
-  metadata.gz: a067bb74a549a6a34c9779ec167a7670c47505b76af208dfd7e2be02564d68bb9e0edda43ddab7c1b16e9ac43d13080d1f62045fee71d1cf1667fa79f00fd382
-  data.tar.gz: 2bfb94bd33407f7f22503934b532fa93f263f40f40ca5ae2dbb1acfcd25e2e1e6b0dc6bc2aa84448e64fa38498b4bdf5bef03b6e8938f72fc3b12ca11849383e
+  metadata.gz: 85079f70645f372357282f1c5c506b261b8775f8d81e6b4284568ba1a8a1f294fcf789dc8162636815a20183b66b8b0056a5747b2574d94f9eec8f816fac6464
+  data.tar.gz: c6b9832a41c012ab642d1981dfce35f13554fac43271336e818c1778b106452432900f48953a33a93f1802e7f0aca8f3d5919c667f5cce5b03c80ef5b1122bbf

data/README.md

@@ -9,14 +9,18 @@ A beautiful, feature-rich SQLite database browser and query interface for Rails
 
 ## 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 +33,32 @@ gem 'sqlite_dashboard'
 And then execute:
 
 ```bash
-$ bundle install
+bundle install
 ```
 
-## Configuration
+## 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
+
+If you prefer to set up manually:
 
 ### Step 1: Mount the Engine
 
@@ -52,19 +78,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 +125,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 +151,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 +181,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 +190,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 +391,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
 

data/lib/generators/sqlite_dashboard/templates/README

@@ -1,6 +1,8 @@
 ===============================================================================
 
-SQLite Dashboard has been installed successfully!
+  ✨ SQLite Dashboard has been installed successfully! ✨
+
+===============================================================================
 
 Next Steps:
 -----------
@@ -8,7 +10,7 @@ Next Steps:
 1. Review the configuration in:
    config/initializers/sqlite_dashboard.rb
 
-2. Update the database paths to match your SQLite files
+2. (Optional) Update database paths or use auto-detection from database.yml
 
 3. Start your Rails server:
    rails server
@@ -16,35 +18,64 @@ Next Steps:
 4. Visit the dashboard at:
    http://localhost:3000/sqlite_dashboard
 
-Security Warning:
------------------
-SQLite Dashboard provides direct SQL access to your databases.
+Features:
+---------
+✨ SQL syntax highlighting with CodeMirror
+📊 Paginated query results
+🔍 Quick table browsing with sidebar navigation
+💾 Export to CSV and JSON with custom options
+⌨️  Keyboard shortcuts (Ctrl/Cmd + Enter to execute)
+🎨 Modern, responsive UI with dark sidebar theme
+🔒 Read-only mode by default (configurable)
+🗄️  Auto-detects databases from config/database.yml
+⚡ Client-side pagination for fast browsing
+
+Security Configuration:
+-----------------------
+By default, SQLite Dashboard runs in READ-ONLY mode.
+
+To enable write operations, set in the initializer:
+  config.allow_dml = true
 
-For production or shared environments, add authentication:
+Note: DROP and ALTER are always forbidden for safety.
 
-In config/routes.rb, replace the mount line with:
+Production Security:
+--------------------
+IMPORTANT: Add authentication before deploying to production!
+
+Option 1 - Devise/Clearance 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:
+Option 2 - HTTP Basic Auth:
+  Add to config/application.rb or the initializer:
 
   SqliteDashboard::Engine.middleware.use Rack::Auth::Basic do |user, pass|
-    user == ENV['DASHBOARD_USER'] && pass == ENV['DASHBOARD_PASS']
+    ActiveSupport::SecurityUtils.secure_compare(user, ENV['DASHBOARD_USER']) &
+    ActiveSupport::SecurityUtils.secure_compare(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
+Export Features:
+----------------
+📄 CSV Export: Choose separator (comma, semicolon, tab, pipe)
+   - Optional headers row
+   - Exports all query results (not just paginated view)
+
+🔧 JSON Export: Two format options
+   - Array of objects: [{"col1": "val1"}, ...]
+   - Object with columns & rows: {"columns": [...], "rows": [...]}
+   - Pretty print option for readable formatting
 
 Documentation:
 --------------
-https://github.com/sqlite-dashboard/sqlite_dashboard
+https://github.com/giovapanasiti/sqlite_dashboard
+
+Support:
+--------
+Report issues: https://github.com/giovapanasiti/sqlite_dashboard/issues
 
 Enjoy exploring your SQLite databases! 🎉
 

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

@@ -4,6 +4,10 @@
 # Only configure databases you trust, as this provides direct SQL access.
 
 SqliteDashboard.configure do |config|
+  # =============================================================================
+  # Database Configuration
+  # =============================================================================
+
   # Array of database configurations
   # Each database should have a name and path
   config.db_files = [
@@ -18,11 +22,35 @@ SqliteDashboard.configure do |config|
   # You can also add databases dynamically:
   # config.add_database("Custom DB", "/path/to/custom.sqlite3")
 
-  # Security Note:
+  # If no databases are configured, SQLite Dashboard will automatically
+  # detect and use SQLite databases from config/database.yml for the current environment
+
+  # =============================================================================
+  # Security Configuration
+  # =============================================================================
+
+  # Allow DML operations (INSERT, UPDATE, DELETE, CREATE, TRUNCATE)
+  # Default: false (read-only mode)
+  # Note: DROP and ALTER are always forbidden for safety
+  config.allow_dml = false
+
+  # Set to true to allow INSERT, UPDATE, DELETE, CREATE, TRUNCATE operations
+  # config.allow_dml = true
+
+  # =============================================================================
+  # Production 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
+  #
+  # Or use HTTP Basic Auth (add to config/application.rb or an initializer):
+  # SqliteDashboard::Engine.middleware.use Rack::Auth::Basic do |user, pass|
+  #   ActiveSupport::SecurityUtils.secure_compare(user, ENV['DASHBOARD_USER']) &
+  #   ActiveSupport::SecurityUtils.secure_compare(pass, ENV['DASHBOARD_PASS'])
+  # end
 end

data/lib/sqlite_dashboard/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sqlite_dashboard
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - SQLite Dashboard Contributors
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -181,7 +180,6 @@ metadata:
   wiki_uri: https://github.com/giovapanasiti/sqlite_dashboard/wiki
   funding_uri: https://github.com/sponsors/sqlite-dashboard
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -196,8 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Beautiful SQLite database browser and query interface for Rails
 test_files: []