dbviewer 0.7.10 → 0.8.0

data/app/views/dbviewer/tables/show.html.erb

@@ -100,7 +100,7 @@
   <div class="card-header d-flex justify-content-between align-items-center">
     <h5 class="mb-0">
       <select id="per-page-select" class="form-select form-select-sm" onchange="window.location.href='<%= table_path(@table_name) %>?<%= per_page_url_params(@table_name) %>'">
-        <% Dbviewer::TablesController.per_page_options.each do |option| %>
+        <% Dbviewer.configuration.per_page_options.each do |option| %>
           <option value="<%= option %>" <%= 'selected' if @per_page == option %>><%= option %></option>
         <% end %>
       </select>
@@ -136,7 +136,7 @@
                 <%= render_sortable_header_row(@records, @order_by, @order_direction, @table_name, @current_page, @per_page, @column_filters) %>
                 <%= render_column_filters_row(form, @records, @columns, @column_filters) %>
               </thead>
-              <%= render_table_body(@records, @metadata) %>
+              <%= render_table_body(@records, @metadata, @table_name) %>
         </table>
         <% end %> <!-- End of form_with -->
       </div>
@@ -348,5 +348,5 @@
   </div>
 </div>
 <% end %>
-<input type="hidden" id="mini_erd_table_path" name="mini_erd_table_path" value="<%= dbviewer.mini_erd_table_path(@table_name, format: :json) %>">
+<input type="hidden" id="mini_erd_table_path" name="mini_erd_table_path" value="<%= dbviewer.mini_erd_api_table_path(@table_name, format: :json) %>">
 <input type="hidden" id="table_name" name="table_name" value="<%= @table_name %>">

data/app/views/layouts/dbviewer/application.html.erb

@@ -5,6 +5,13 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
+  
+  <!-- Favicon -->
+  <link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>👁️</text></svg>">
+  <link rel="icon" href="<%= asset_path('dbviewer/favicon.ico') %>" type="image/x-icon">
+  <link rel="shortcut icon" href="<%= asset_path('dbviewer/favicon.ico') %>" type="image/x-icon">
+  <link rel="icon" type="image/svg+xml" href="<%= asset_path('dbviewer/favicon.svg') %>">
+  <link rel="icon" type="image/png" href="<%= asset_path('dbviewer/favicon.png') %>">
 
   <!-- Prevent theme flash during page load -->
   <script>
@@ -37,6 +44,8 @@
   <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/flatpickr/dist/flatpickr.min.css">
   <script src="https://cdn.jsdelivr.net/npm/flatpickr"></script>
   
+  <%= javascript_include_tag "dbviewer/utility", "data-turbo-track": "reload" %>
+  <%= javascript_include_tag "dbviewer/error_handler", "data-turbo-track": "reload" %>
   <%= javascript_include_tag "dbviewer/layout", "data-turbo-track": "reload" %>
   <%= javascript_include_tag "dbviewer/sidebar", "data-turbo-track": "reload" %>
   <%= stylesheet_link_tag "dbviewer/application", "data-turbo-track": "reload" %>
@@ -47,8 +56,8 @@
   <div class="dbviewer-wrapper">
     <!-- Top Navigation Bar (Fixed) -->
     <nav class="navbar navbar-expand-lg navbar-dark bg-primary dbviewer-navbar fixed-top">
-      <div class="container-fluid">
-        <a class="navbar-brand" href="<%= dbviewer.root_path %>"><i class="bi bi-database-fill me-1"></i>DB Viewer</a>
+      <div class="container-fluid px-0">
+        <a class="navbar-brand d-flex" href="<%= dbviewer.root_path %>"><span class="me-2">👁️</span> DB Viewer</a>
         <div class="d-flex align-items-center">
           <button class="navbar-toggler border-0 px-2 d-lg-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#navbarOffcanvas"
                   aria-controls="navbarOffcanvas" aria-expanded="false" aria-label="Toggle navigation">
@@ -110,7 +119,7 @@
       <!-- Offcanvas sidebar for mobile/tablet view that slides from right -->
       <div class="offcanvas offcanvas-end d-lg-none" tabindex="-1" id="navbarOffcanvas" aria-labelledby="offcanvasNavbarLabel">
         <div class="offcanvas-header bg-light-subtle">
-          <h5 class="offcanvas-title" id="offcanvasNavbarLabel"><i class="bi bi-database-fill me-2 text-primary"></i>DB Viewer</h5>
+          <h5 class="offcanvas-title" id="offcanvasNavbarLabel">👁️ DB Viewer</h5>
           <button type="button" class="btn-close" data-bs-dismiss="offcanvas" aria-label="Close"></button>
         </div>
         <div class="offcanvas-body bg-body-tertiary">

data/config/routes.rb

@@ -4,7 +4,6 @@ Dbviewer::Engine.routes.draw do
       get "query"
       post "query"
       get "export_csv"
-      get "mini_erd"
     end
   end
 
@@ -26,13 +25,14 @@ Dbviewer::Engine.routes.draw do
   get "dashboard", to: "home#index", as: :dashboard
 
   namespace :api do
-    resources :tables, only: [ :index ] do
+    resources :tables, only: [ :index, :show ] do
       collection do
         get "records"
         get "relationships_count"
       end
       member do
         get "relationship_counts"
+        get "mini_erd"
       end
     end
 

data/lib/dbviewer/configuration.rb

@@ -59,6 +59,24 @@ module Dbviewer
     # When enabled, all DBViewer routes will return 404 responses
     attr_accessor :disabled
 
+    # PII (Personally Identifiable Information) masking configuration
+    # Hash of table.column => masking rule
+    # @example {
+    #   'users.email' => :email,
+    #   'users.phone' => :phone,
+    #   'customers.ssn' => :custom_mask
+    # }
+    attr_accessor :pii_rules
+
+    # Enable/disable PII masking globally
+    attr_accessor :enable_pii_masking
+
+    # Custom PII masking blocks
+    # @example {
+    #   custom_mask: ->(value) { value ? '***REDACTED***' : value }
+    # }
+    attr_accessor :custom_pii_masks
+
     def initialize
       @per_page_options = [ 10, 20, 50, 100 ]
       @default_per_page = 20
@@ -82,6 +100,9 @@ module Dbviewer
         }
       }
       @current_connection = :default
+      @pii_rules = {}
+      @enable_pii_masking = true
+      @custom_pii_masks = {}
     end
   end
 end

data/lib/dbviewer/data_privacy/pii_masker.rb

@@ -0,0 +1,125 @@
+module Dbviewer
+  module DataPrivacy
+    class PiiMasker
+      BUILT_IN_MASKS = {
+        email: ->(value) { mask_email(value) },
+        phone: ->(value) { mask_phone(value) },
+        credit_card: ->(value) { mask_credit_card(value) },
+        ssn: ->(value) { mask_ssn(value) },
+        full_redact: ->(value) { value ? "***REDACTED***" : value },
+        partial: ->(value) { mask_partial(value) }
+      }.freeze
+
+      def self.mask_value(value, table_name, column_name)
+        return value unless should_mask?(table_name, column_name)
+
+        rule = get_masking_rule(table_name, column_name)
+        apply_mask(value, rule)
+      end
+
+      private
+
+      def self.should_mask?(table_name, column_name)
+        return false unless Dbviewer.configuration.enable_pii_masking
+        return false if Dbviewer.configuration.pii_rules.empty?
+
+        key = "#{table_name}.#{column_name}"
+        Dbviewer.configuration.pii_rules.key?(key)
+      end
+
+      def self.get_masking_rule(table_name, column_name)
+        key = "#{table_name}.#{column_name}"
+        Dbviewer.configuration.pii_rules[key]
+      end
+
+      def self.apply_mask(value, rule)
+        return value if value.nil?
+
+        case rule
+        when Symbol
+          apply_built_in_mask(value, rule)
+        when Proc
+          rule.call(value)
+        else
+          apply_built_in_mask(value, :partial)
+        end
+      rescue => e
+        Rails.logger.warn("PII masking failed for rule #{rule}: #{e.message}")
+        "***ERROR***"
+      end
+
+      def self.apply_built_in_mask(value, mask_type)
+        mask_proc = BUILT_IN_MASKS[mask_type]
+        if mask_proc
+          mask_proc.call(value)
+        else
+          # Check if it's a custom mask
+          custom_mask = Dbviewer.configuration.custom_pii_masks[mask_type]
+          if custom_mask && custom_mask.respond_to?(:call)
+            custom_mask.call(value)
+          else
+            mask_partial(value)
+          end
+        end
+      end
+
+      def self.mask_email(value)
+        return value unless value.to_s.include?("@")
+
+        parts = value.to_s.split("@")
+        username = parts[0]
+        domain = parts[1]
+
+        if username.length <= 1
+          masked_username = "*"
+        elsif username.length <= 2
+          masked_username = username
+        else
+          masked_username = "#{username[0..1]}***"
+        end
+
+        "#{masked_username}@#{domain}"
+      end
+
+      def self.mask_phone(value)
+        # Remove all non-digit characters
+        digits = value.to_s.gsub(/\D/, "")
+        return value if digits.length < 4
+
+        # Keep first and last 2 digits, mask the middle
+        if digits.length <= 6
+          "#{digits[0]}#{'*' * (digits.length - 2)}#{digits[-1]}"
+        else
+          "#{digits[0..1]}#{'*' * 3}#{digits[-2..-1]}"
+        end
+      end
+
+      def self.mask_credit_card(value)
+        digits = value.to_s.gsub(/\D/, "")
+        return value if digits.length < 4
+
+        # Show last 4 digits only
+        "****-****-****-#{digits[-4..-1]}"
+      end
+
+      def self.mask_ssn(value)
+        digits = value.to_s.gsub(/\D/, "")
+        return value if digits.length != 9
+
+        # Show last 4 digits only
+        "***-**-#{digits[-4..-1]}"
+      end
+
+      def self.mask_partial(value)
+        str = value.to_s
+        return str if str.length <= 2
+
+        if str.length <= 4
+          "#{str[0]}#{'*' * (str.length - 2)}#{str[-1]}"
+        else
+          "#{str[0..1]}#{'*' * 3}#{str[-2..-1]}"
+        end
+      end
+    end
+  end
+end

data/lib/dbviewer/database/manager.rb

@@ -75,8 +75,8 @@ module Dbviewer
       # @param table_name [String] Name of the table
       # @param column_filters [Hash] Hash of column_name => filter_value for filtering
       # @return [Integer] Number of filtered records
-      def filtered_record_count(table_name, column_filters = {})
-        @table_query_operations.filtered_record_count(table_name, column_filters)
+      def table_record_count(table_name, column_filters = {})
+        @table_query_operations.table_record_count(table_name, column_filters)
       end
 
       # Get the number of columns in a table

data/lib/dbviewer/datatable/query_operations.rb

@@ -48,9 +48,6 @@ module Dbviewer
 
         # Format results
         to_result_set(records, column_names)
-      rescue => e
-        Rails.logger.error("[DBViewer] Error executing table query: #{e.message}")
-        raise e
       end
 
       # Get the total count of records in a table
@@ -58,23 +55,13 @@ module Dbviewer
       # @return [Integer] Number of records
       def table_count(table_name)
         get_model_for(table_name).count
-      rescue => e
-        Rails.logger.error("[DBViewer] Error counting records in table #{table_name}: #{e.message}")
-        0
-      end
-
-      # Get the number of records in a table (alias for table_count)
-      # @param table_name [String] Name of the table
-      # @return [Integer] Number of records
-      def record_count(table_name)
-        table_count(table_name)
       end
 
       # Get the number of records in a table with filters applied
       # @param table_name [String] Name of the table
       # @param column_filters [Hash] Hash of column_name => filter_value for filtering
       # @return [Integer] Number of filtered records
-      def filtered_record_count(table_name, column_filters = {})
+      def table_record_count(table_name, column_filters = {})
         return table_count(table_name) unless column_filters.present?
 
         model = get_model_for(table_name)
@@ -83,9 +70,6 @@ module Dbviewer
         # Apply filters in the same way as table_records
         query = apply_column_filters(query, table_name, column_filters)
         query.count
-      rescue => e
-        Rails.logger.error("[DBViewer] Error counting filtered records in table #{table_name}: #{e.message}")
-        0
       end
 
       ## -- Delegator

data/lib/dbviewer/engine.rb

@@ -15,5 +15,34 @@ module Dbviewer
     initializer "dbviewer.notifications" do
       Dbviewer::Query::NotificationSubscriber.subscribe
     end
+
+    # Configure assets for the engine
+    initializer "dbviewer.assets" do |app|
+      # Add engine assets path to asset load paths
+      app.config.assets.paths << root.join("app", "assets", "javascripts").to_s
+      app.config.assets.paths << root.join("app", "assets", "stylesheets").to_s
+      app.config.assets.paths << root.join("app", "assets", "images").to_s
+
+      # Make sure we precompile individual JavaScript files
+      app.config.assets.precompile += %w[
+        dbviewer/utility.js
+        dbviewer/error_handler.js
+        dbviewer/home.js
+        dbviewer/layout.js
+        dbviewer/sidebar.js
+        dbviewer/query.js
+        dbviewer/entity_relationship_diagram.js
+        dbviewer/table.js
+      ]
+
+      # Make sure stylesheets are precompiled too
+      app.config.assets.precompile += %w[
+        dbviewer/application.css
+        dbviewer/home.css
+        dbviewer/query.css
+        dbviewer/table.css
+        dbviewer/entity_relationship_diagram.css
+      ]
+    end
   end
 end

data/lib/dbviewer/version.rb

@@ -1,3 +1,3 @@
 module Dbviewer
-  VERSION = "0.7.10"
+  VERSION = "0.8.0"
 end

data/lib/dbviewer.rb

@@ -23,11 +23,40 @@ require "dbviewer/database/metadata_manager"
 require "dbviewer/datatable/query_operations"
 require "dbviewer/datatable/query_params"
 
+require "dbviewer/data_privacy/pii_masker"
+
 require "propshaft"
 
 module Dbviewer
   # Main module for the database viewer
 
+  # Helper class for configuring PII masking rules
+  class PiiConfigurator
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    # Define a PII masking rule
+    # @param column_spec [String] Table and column in format "table.column"
+    # @param with [Symbol, Proc] Masking rule - either built-in symbol or custom proc
+    def mask(column_spec, with:)
+      @configuration.pii_rules[column_spec] = with
+    end
+
+    # Define a custom masking function
+    # @param name [Symbol] Name of the custom mask
+    # @param block [Proc] The masking function
+    def custom_mask(name, block)
+      @configuration.custom_pii_masks[name] = block
+    end
+
+    # Enable or disable PII masking globally
+    # @param enabled [Boolean] Whether to enable PII masking
+    def enabled=(enabled)
+      @configuration.enable_pii_masking = enabled
+    end
+  end
+
   class << self
     # Module accessor for configuration
     attr_writer :configuration
@@ -73,6 +102,22 @@ module Dbviewer
       connection_errors
     end
 
+    # Configure PII masking rules using a block
+    #
+    # @example
+    #   Dbviewer.configure_pii do |pii|
+    #     pii.mask 'users.email', with: :email
+    #     pii.mask 'users.phone', with: :phone
+    #     pii.mask 'users.ssn', with: :ssn
+    #     pii.mask 'customers.credit_card', with: :credit_card
+    #     pii.mask 'profiles.secret', with: :full_redact
+    #     pii.mask 'accounts.api_key', with: ->(value) { value ? 'api_***' : value }
+    #     pii.custom_mask :my_custom, ->(value) { "CUSTOM: #{value[0]}***" }
+    #   end
+    def configure_pii
+      yield(PiiConfigurator.new(configuration)) if block_given?
+    end
+
     private
 
     # Configure the query logger with current configuration settings

data/lib/generators/dbviewer/install_generator.rb

@@ -7,6 +7,12 @@ module Dbviewer
       def copy_initializer_file
         copy_file "initializer.rb", "config/initializers/dbviewer.rb"
       end
+
+      def copy_pii_example
+        copy_file "pii_configuration_example.rb", "config/initializers/dbviewer_pii_example.rb"
+        say "Created example PII configuration at config/initializers/dbviewer_pii_example.rb", :green
+        say "Review and customize the PII masking rules, then rename to dbviewer_pii.rb to activate.", :yellow
+      end
     end
   end
 end

data/lib/generators/dbviewer/templates/pii_configuration_example.rb

@@ -0,0 +1,99 @@
+# Example DBViewer PII Configuration
+#
+# This file shows how to configure PII (Personally Identifiable Information) masking
+# in DBViewer to protect sensitive data in your database views.
+#
+# Place this configuration in your Rails initializer file (e.g., config/initializers/dbviewer.rb)
+
+Dbviewer.configure do |config|
+  # Enable/disable PII masking globally (default: true)
+  config.enable_pii_masking = true
+
+  # Other DBViewer configurations...
+  # config.default_per_page = 20
+  # config.enable_data_export = false
+end
+
+# Configure PII masking rules
+Dbviewer.configure_pii do |pii|
+  # Built-in masking types:
+
+  # Email masking: john.doe@example.com -> jo***@example.com
+  pii.mask "users.email", with: :email
+  pii.mask "customers.email_address", with: :email
+
+  # Phone masking: +1234567890 -> +1***90
+  pii.mask "users.phone", with: :phone
+  pii.mask "profiles.mobile_number", with: :phone
+
+  # Social Security Number masking: 123456789 -> ***-**-6789
+  pii.mask "users.ssn", with: :ssn
+  pii.mask "employees.social_security", with: :ssn
+
+  # Credit card masking: 1234567890123456 -> ****-****-****-3456
+  pii.mask "payments.card_number", with: :credit_card
+
+  # Full redaction: any_value -> ***REDACTED***
+  pii.mask "users.api_key", with: :full_redact
+  pii.mask "accounts.secret_token", with: :full_redact
+
+  # Partial masking (default): john_doe -> jo***oe
+  pii.mask "users.username", with: :partial
+
+  # Custom masking with lambda/proc:
+  pii.mask "users.address", with: ->(value) {
+    return value if value.nil?
+    "#{value.split(' ').first} ***"  # Show only first word
+  }
+
+  # Define custom masking functions that can be reused:
+  pii.custom_mask :ip_mask, ->(value) {
+    return value if value.nil?
+    parts = value.split(".")
+    return value if parts.length != 4
+    "#{parts[0]}.#{parts[1]}.***.***.***"
+  }
+
+  # Use custom mask:
+  pii.mask "logs.ip_address", with: :ip_mask
+  pii.mask "sessions.client_ip", with: :ip_mask
+
+  # More examples:
+
+  # Customer data
+  pii.mask "customers.first_name", with: :partial
+  pii.mask "customers.last_name", with: :partial
+  pii.mask "customers.date_of_birth", with: ->(value) {
+    return value if value.nil?
+    date = Date.parse(value.to_s) rescue nil
+    date ? "#{date.year}/***/**" : value
+  }
+
+  # Employee data
+  pii.mask "employees.salary", with: ->(value) { value ? "$***,***" : value }
+  pii.mask "employees.bank_account", with: :full_redact
+
+  # User profiles
+  pii.mask "profiles.biography", with: ->(value) {
+    return value if value.nil? || value.length <= 50
+    "#{value[0..50]}... [TRUNCATED FOR PRIVACY]"
+  }
+
+  # System logs with PII
+  pii.mask "audit_logs.user_data", with: :full_redact
+  pii.mask "error_logs.request_params", with: ->(value) {
+    # Redact JSON containing potential PII
+    return value if value.nil?
+    begin
+      JSON.parse(value)
+      "{ [REDACTED JSON DATA] }"
+    rescue
+      value
+    end
+  }
+end
+
+# You can also disable PII masking globally:
+# Dbviewer.configure_pii do |pii|
+#   pii.enabled = false
+# end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbviewer
 version: !ruby/object:Gem::Version
-  version: 0.7.10
+  version: 0.8.0
 platform: ruby
 authors:
 - Wailan Tirajoh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-19 00:00:00.000000000 Z
+date: 2025-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -77,28 +77,33 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/images/dbviewer/emoji-favicon.txt
+- app/assets/images/dbviewer/favicon.ico
+- app/assets/images/dbviewer/favicon.png
+- app/assets/images/dbviewer/favicon.svg
 - app/assets/javascripts/dbviewer/entity_relationship_diagram.js
+- app/assets/javascripts/dbviewer/error_handler.js
 - app/assets/javascripts/dbviewer/home.js
 - app/assets/javascripts/dbviewer/layout.js
 - app/assets/javascripts/dbviewer/query.js
 - app/assets/javascripts/dbviewer/sidebar.js
 - app/assets/javascripts/dbviewer/table.js
+- app/assets/javascripts/dbviewer/utility.js
 - app/assets/stylesheets/dbviewer/application.css
 - app/assets/stylesheets/dbviewer/entity_relationship_diagram.css
 - app/assets/stylesheets/dbviewer/home.css
 - app/assets/stylesheets/dbviewer/logs.css
 - app/assets/stylesheets/dbviewer/query.css
 - app/assets/stylesheets/dbviewer/table.css
-- app/controllers/concerns/dbviewer/connection_management.rb
-- app/controllers/concerns/dbviewer/data_export.rb
-- app/controllers/concerns/dbviewer/database_information.rb
 - app/controllers/concerns/dbviewer/database_operations.rb
-- app/controllers/concerns/dbviewer/datatable_support.rb
+- app/controllers/concerns/dbviewer/database_operations/connection_management.rb
+- app/controllers/concerns/dbviewer/database_operations/data_export.rb
+- app/controllers/concerns/dbviewer/database_operations/database_information.rb
+- app/controllers/concerns/dbviewer/database_operations/datatable_operations.rb
+- app/controllers/concerns/dbviewer/database_operations/query_operations.rb
+- app/controllers/concerns/dbviewer/database_operations/relationship_management.rb
+- app/controllers/concerns/dbviewer/database_operations/table_operations.rb
 - app/controllers/concerns/dbviewer/disabled_state_validation.rb
-- app/controllers/concerns/dbviewer/pagination_concern.rb
-- app/controllers/concerns/dbviewer/query_operations.rb
-- app/controllers/concerns/dbviewer/relationship_management.rb
-- app/controllers/concerns/dbviewer/table_operations.rb
 - app/controllers/dbviewer/api/base_controller.rb
 - app/controllers/dbviewer/api/database_controller.rb
 - app/controllers/dbviewer/api/entity_relationship_diagrams_controller.rb
@@ -139,6 +144,7 @@ files:
 - lib/dbviewer/cache/base.rb
 - lib/dbviewer/cache/in_memory.rb
 - lib/dbviewer/configuration.rb
+- lib/dbviewer/data_privacy/pii_masker.rb
 - lib/dbviewer/database/dynamic_model_factory.rb
 - lib/dbviewer/database/manager.rb
 - lib/dbviewer/database/metadata_manager.rb
@@ -161,6 +167,7 @@ files:
 - lib/dbviewer/version.rb
 - lib/generators/dbviewer/install_generator.rb
 - lib/generators/dbviewer/templates/initializer.rb
+- lib/generators/dbviewer/templates/pii_configuration_example.rb
 - lib/tasks/dbviewer_tasks.rake
 homepage: https://github.com/wailantirajoh/dbviewer
 licenses: