sqlite_dashboard 1.0.0 → 1.0.2

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

@@ -21,13 +21,12 @@
   </div>
 
   <!-- Main content area -->
-  <div class="col-md-10 main-content">
+  <div class="col-md-10 main-content" data-controller="query-executor" data-database-name="<%= @database[:name] %>">
     <!-- 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">
@@ -45,6 +44,12 @@
           <button type="button" class="btn btn-outline-secondary" data-action="click->query-executor#clear">
             <i class="fas fa-eraser"></i> Clear
           </button>
+          <button type="button" class="btn btn-success" data-bs-toggle="modal" data-bs-target="#saveQueryModal">
+            <i class="fas fa-save"></i> Save Query
+          </button>
+          <%= link_to worksheet_path, class: "btn btn-outline-info" do %>
+            <i class="fas fa-file-code"></i> SQL Worksheet
+          <% end %>
         </div>
       <% end %>
     </div>
@@ -56,5 +61,34 @@
         <p>Execute a query to see results</p>
       </div>
     </div>
+
+    <!-- Save Query Modal -->
+    <div class="modal fade" id="saveQueryModal" tabindex="-1" aria-labelledby="saveQueryModalLabel" aria-hidden="true">
+      <div class="modal-dialog">
+        <div class="modal-content">
+          <div class="modal-header">
+            <h5 class="modal-title" id="saveQueryModalLabel">Save Query</h5>
+            <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
+          </div>
+          <div class="modal-body">
+            <div class="mb-3">
+              <label for="query-name" class="form-label">Query Name *</label>
+              <input type="text" class="form-control" id="query-name" data-query-executor-target="queryName" required>
+            </div>
+            <div class="mb-3">
+              <label for="query-description" class="form-label">Description *</label>
+              <textarea class="form-control" id="query-description" rows="2" data-query-executor-target="queryDescription" required></textarea>
+            </div>
+            <div id="save-error" class="alert alert-danger d-none" data-query-executor-target="saveError"></div>
+          </div>
+          <div class="modal-footer">
+            <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Cancel</button>
+            <button type="button" class="btn btn-primary" data-action="click->query-executor#saveQuery">
+              <i class="fas fa-save"></i> Save
+            </button>
+          </div>
+        </div>
+      </div>
+    </div>
   </div>
 </div>

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

@@ -0,0 +1,111 @@
+<div class="row g-0" style="height: 100vh;" data-controller="saved-queries">
+  <!-- Sidebar with saved queries -->
+  <div class="col-md-2 sidebar">
+    <div class="p-3">
+      <h6 class="mb-3">
+        <i class="fas fa-file-code"></i> SQL Worksheet
+      </h6>
+      <%= link_to "← Back to Databases", databases_path, class: "btn btn-sm btn-outline-secondary mb-3" %>
+
+      <h6 class="mb-2">Saved Queries</h6>
+      <div id="saved-queries-list" data-saved-queries-target="list">
+        <div class="text-muted small text-center py-3">
+          <i class="fas fa-spinner fa-spin"></i> Loading...
+        </div>
+      </div>
+
+      <button type="button" class="btn btn-sm btn-primary w-100 mt-3" data-action="click->saved-queries#refresh">
+        <i class="fas fa-sync-alt"></i> Refresh
+      </button>
+    </div>
+  </div>
+
+  <!-- Main content area -->
+  <div class="col-md-10 main-content">
+    <!-- Database Selector -->
+    <div class="mb-3 px-4 pt-2">
+      <label for="database-selector" class="form-label fw-bold">Select Database</label>
+      <select id="database-selector" class="form-select" data-saved-queries-target="databaseSelector">
+        <option value="">-- Select a database --</option>
+        <% @databases.each do |db| %>
+          <option value="<%= db[:id] %>"><%= db[:name] %></option>
+        <% end %>
+      </select>
+    </div>
+
+    <!-- Query Console -->
+    <div class="query-console">
+      <div class="mb-3">
+        <label for="worksheet-query" class="form-label fw-bold">SQL Query</label>
+        <textarea id="worksheet-query"
+                  class="form-control query-textarea"
+                  data-saved-queries-target="queryInput"
+                  placeholder="Enter your SQL query here..."></textarea>
+      </div>
+      <div class="d-flex gap-2 mb-2">
+        <button type="button" class="btn btn-primary" data-action="click->saved-queries#execute">
+          <i class="fas fa-play"></i> Execute Query
+        </button>
+        <button type="button" class="btn btn-outline-secondary" data-action="click->saved-queries#clear">
+          <i class="fas fa-eraser"></i> Clear
+        </button>
+        <button type="button" class="btn btn-success" data-bs-toggle="modal" data-bs-target="#saveQueryModal">
+          <i class="fas fa-save"></i> Save Query
+        </button>
+        <button type="button" class="btn btn-outline-info" data-action="click->saved-queries#exportCSV">
+          <i class="fas fa-file-csv"></i> Export CSV
+        </button>
+        <button type="button" class="btn btn-outline-info" data-action="click->saved-queries#exportJSON">
+          <i class="fas fa-file-code"></i> Export JSON
+        </button>
+      </div>
+    </div>
+
+    <!-- Results Container -->
+    <div class="results-container" id="worksheet-results">
+      <div class="text-muted text-center py-5">
+        <i class="fas fa-database fa-3x mb-3"></i>
+        <p>Select a database and execute a query to see results</p>
+      </div>
+    </div>
+  </div>
+</div>
+
+<!-- Save Query Modal -->
+<div class="modal fade" id="saveQueryModal" tabindex="-1" aria-labelledby="saveQueryModalLabel" aria-hidden="true">
+  <div class="modal-dialog">
+    <div class="modal-content">
+      <div class="modal-header">
+        <h5 class="modal-title" id="saveQueryModalLabel">Save Query</h5>
+        <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
+      </div>
+      <div class="modal-body">
+        <div class="mb-3">
+          <label for="query-name" class="form-label">Query Name *</label>
+          <input type="text" class="form-control" id="query-name" data-saved-queries-target="queryName" required>
+        </div>
+        <div class="mb-3">
+          <label for="query-description" class="form-label">Description *</label>
+          <textarea class="form-control" id="query-description" rows="2" data-saved-queries-target="queryDescription" required></textarea>
+        </div>
+        <div id="save-error" class="alert alert-danger d-none" data-saved-queries-target="saveError"></div>
+      </div>
+      <div class="modal-footer">
+        <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Cancel</button>
+        <button type="button" class="btn btn-primary" data-action="click->saved-queries#saveQuery">
+          <i class="fas fa-save"></i> Save
+        </button>
+      </div>
+    </div>
+  </div>
+</div>
+
+<script>
+  // Initialize the saved queries controller when the page loads
+  document.addEventListener('turbo:load', () => {
+    const element = document.querySelector('[data-controller="saved-queries"]');
+    if (!element) {
+      document.body.setAttribute('data-controller', 'saved-queries');
+    }
+  });
+</script>

data/config/routes.rb

@@ -1,6 +1,15 @@
 SqliteDashboard::Engine.routes.draw do
   root to: "databases#index"
 
+  # Saved queries
+  get 'saved_queries', to: 'databases#saved_queries'
+  post 'saved_queries', to: 'databases#create_saved_query'
+  get 'saved_queries/:id', to: 'databases#show_saved_query', as: :saved_query
+  delete 'saved_queries/:id', to: 'databases#destroy_saved_query'
+
+  # SQL Worksheet
+  get 'worksheet', to: 'databases#worksheet', as: :worksheet
+
   resources :databases, only: [:index, :show] do
     member do
       post :execute_query

data/db/migrate/20250101000001_create_sqlite_dashboard_saved_queries.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class CreateSqliteDashboardSavedQueries < ActiveRecord::Migration[7.0]
+  def change
+    create_table :dashboard_saved_queries do |t|
+      t.string :name, null: false
+      t.text :query, null: false
+      t.string :database_name
+      t.text :description
+
+      t.timestamps
+    end
+
+    add_index :dashboard_saved_queries, :name
+    add_index :dashboard_saved_queries, :created_at
+  end
+end

data/lib/generators/sqlite_dashboard/install_generator.rb

@@ -21,6 +21,10 @@ module SqliteDashboard
         route route_content.strip
       end
 
+      def copy_migrations
+        rake "sqlite_dashboard:install:migrations"
+      end
+
       def display_readme
         readme "README" if behavior == :invoke
       end

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.2"
 end

data/sqlite_dashboard.gemspec

@@ -43,6 +43,7 @@ Gem::Specification.new do |spec|
   # Runtime dependencies
   spec.add_dependency "rails", ">= 7.0.0"
   spec.add_dependency "sqlite3", ">= 1.4"
+  spec.add_dependency "csv", ">= 3.0"
 
   # Development dependencies
   spec.add_development_dependency "bundler", ">= 2.0"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sqlite_dashboard
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - SQLite Dashboard Contributors
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-02 00:00:00.000000000 Z
+date: 2025-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +37,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -152,15 +165,20 @@ files:
 - app/controllers/sqlite_dashboard/application_controller.rb
 - app/controllers/sqlite_dashboard/databases_controller.rb
 - app/javascript/controllers/query_executor_controller.js
+- app/javascript/controllers/saved_queries_controller.js
 - app/javascript/controllers/table_selector_controller.js
 - app/javascript/sqlite_dashboard/application.js
+- app/models/sqlite_dashboard/application_record.rb
+- app/models/sqlite_dashboard/saved_query.rb
 - app/views/layouts/sqlite_dashboard/application.html.erb
 - app/views/sqlite_dashboard/databases/_error.html.erb
 - app/views/sqlite_dashboard/databases/execute_query.turbo_stream.erb
 - app/views/sqlite_dashboard/databases/index.html.erb
 - app/views/sqlite_dashboard/databases/show.html.erb
+- app/views/sqlite_dashboard/databases/worksheet.html.erb
 - config/importmap.rb
 - config/routes.rb
+- db/migrate/20250101000001_create_sqlite_dashboard_saved_queries.rb
 - lib/generators/sqlite_dashboard/install_generator.rb
 - lib/generators/sqlite_dashboard/templates/README
 - lib/generators/sqlite_dashboard/templates/initializer.rb
@@ -181,7 +199,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 +213,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.2
 specification_version: 4
 summary: Beautiful SQLite database browser and query interface for Rails
 test_files: []