dbviewer 0.4.4 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b726fcc60badaa82692f22151b9656152810ecaa9a5c59e39e0a27e0c595add5
-  data.tar.gz: a88f8817f599d276ad814bce26fa2314bd79c7c4a5979123aa524457c7c0d534
+  metadata.gz: a9caec4627e8912e40d85d63c9105cdc80b2bae4227e145372693855a40fbc29
+  data.tar.gz: ca759885a1ec9522860d9926e1814f68457fa453832f7b3ea3298aa5c86222eb
 SHA512:
-  metadata.gz: c0a0cfc7172bf1ea0e3146bfeb3cb739e247a8412c0fd204828fdb0e2a4f261fdbd75ef070da765c1a6cde0d1ae0bd60b842346c71512a547c9d05dd592930ae
-  data.tar.gz: 5304c49470fe85760bf0e6aef851cb3c199963be104518c46dad24dac6e22eaae597802786c339b9a779a810a8c849f9c1b558f73672abbb7f432429bbd9c519
+  metadata.gz: d71176e418170a1d82439a1266687d6f125c27dd96dcf008fb05ccecc169d11dafb52f1c5940549e030f3487fe8c2408f73dda51e7ddae8e05b598cde621943f
+  data.tar.gz: cebdde38e2e4500a265b20b86d1e6daee3ed7ba95447b348635efb00e963f7d895b8f147ab94b2b8c50656940c74279ebfbd17a90ff3921341cec2a0121b84cd

data/README.md

@@ -169,7 +169,13 @@ end
 
 ## ⚙️ Configuration Options
 
-You can configure DBViewer by creating an initializer in your application:
+You can configure DBViewer by using our generator to create an initializer in your application:
+
+```bash
+rails generate dbviewer:initializer
+```
+
+This will create a file at `config/initializers/dbviewer.rb` with the default configuration:
 
 ```ruby
 # config/initializers/dbviewer.rb
@@ -183,16 +189,18 @@ Dbviewer.configure do |config|
   config.query_timeout = 30                          # SQL query timeout in seconds
 
   # Query logging options
-  config.enable_query_logging = true                 # Enable or disable query logging completely (default: true)
+  config.enable_query_logging = false                # Enable or disable query logging completely (default: true)
   config.query_logging_mode = :memory                # Storage mode for SQL queries (:memory or :file)
   config.query_log_path = "log/dbviewer.log"         # Path for query log file when in :file mode
   config.max_memory_queries = 1000                   # Maximum number of queries to store in memory
 
   # Authentication options
-  config.admin_credentials = { username: "admin", password: "your_secure_password" } # Basic HTTP auth credentials
+  # config.admin_credentials = { username: "admin", password: "your_secure_password" } # Basic HTTP auth credentials
 end
 ```
 
+You can also create this file manually if you prefer.
+
 The configuration is accessed through `Dbviewer.configuration` throughout the codebase. You can also access it via `Dbviewer.config` which is an alias for backward compatibility.
 
 ## 🪵 Query Logging
@@ -302,13 +310,13 @@ The simplest way to update is using Bundler:
 
 - Update your Gemfile with the desired version:
 
-   ```ruby
-   # For the latest version
-   gem "dbviewer", group: :development
-   
-   # Or specify a version
-   gem "dbviewer", "~> 0.3.2", group: :development
-   ```
+  ```ruby
+  # For the latest version
+  gem "dbviewer", group: :development
+
+  # Or specify a version
+  gem "dbviewer", "~> 0.3.2", group: :development
+  ```
 
 - Run bundle update:
 

data/lib/dbviewer/engine.rb

@@ -6,6 +6,11 @@ module Dbviewer
     config.autoload_paths << File.expand_path("../../", __FILE__)
     config.eager_load_paths << File.expand_path("../../", __FILE__)
 
+    # Register generators
+    config.app_generators do |g|
+      g.templates.unshift File.expand_path("../../generators/dbviewer/templates", __dir__)
+    end
+
     # Initialize the engine safely
     initializer "dbviewer.setup", after: :load_config_initializers do |app|
       Dbviewer.init

data/lib/dbviewer/version.rb

@@ -1,3 +1,3 @@
 module Dbviewer
-  VERSION = "0.4.4"
+  VERSION = "0.4.6"
 end

data/lib/generators/dbviewer/initializer_generator.rb

@@ -0,0 +1,12 @@
+module Dbviewer
+  module Generators
+    class InitializerGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Creates a DBViewer initializer file at config/initializers/dbviewer.rb"
+
+      def copy_initializer_file
+        copy_file "initializer.rb", "config/initializers/dbviewer.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+Dbviewer.configure do |config|
+  config.per_page_options = [ 10, 20, 50, 100, 250 ]
+  config.default_per_page = 20
+  config.max_query_length = 10000
+  config.cache_expiry = 300
+  config.max_records = 10000
+  config.enable_data_export = false
+  config.query_timeout = 30
+
+  # Query logging options
+  config.enable_query_logging = false
+  config.query_logging_mode = :memory
+  config.query_log_path = "log/dbviewer.log"
+  config.max_memory_queries = 1000
+
+  # Authentication options
+  # config.admin_credentials = { username: "admin", password: "your_secure_password" } # Basic HTTP auth credentials
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbviewer
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.6
 platform: ruby
 authors:
 - Wailan Tirajoh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-24 00:00:00.000000000 Z
+date: 2025-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -95,6 +95,8 @@ files:
 - lib/dbviewer/table_query_operations.rb
 - lib/dbviewer/table_query_params.rb
 - lib/dbviewer/version.rb
+- lib/generators/dbviewer/initializer_generator.rb
+- lib/generators/dbviewer/templates/initializer.rb
 - lib/tasks/dbviewer_tasks.rake
 homepage: https://github.com/wailantirajoh/dbviewer
 licenses: