db-gui 0.0.4 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8036df4dccc81646a039ae1f596d9337146eb11d8c797db665baec7720af497
-  data.tar.gz: d3b32fe1f26b471a278c0c120f1bd4ddf1e48d8d3c914454527df3814eb34ad5
+  metadata.gz: 32291b6eecdc2752f695361d340e0f00c6e32bfb9b9d57821bbfafe884a6adbf
+  data.tar.gz: c0e66b0a2362651790810c50166c27a75e44fe1da68df13c10019a43f3db22f0
 SHA512:
-  metadata.gz: d74eb9ca5bcd71c75e0588f5f94f80277402066ebf26a2e49619c1f22fcc831c76fdf7c1f8707ea776ee9b7f88aee94550b3aa197d58823cc431c1bfbdb2e66b
-  data.tar.gz: f1154b733b50e78dcb388ffdfc3415562ba07a1541cc40e527560ac1e44f3d2c1b9ffabad22484acdf3fa18f8486bb9ff0f526c80d8d0eb6303f8adb17e88a98
+  metadata.gz: 99f98299b9d09171625237220c2c0d2d687bcfbd703c3e6c9e46fa5bc67308b68bfa5d9637fac2e5940b0e05c83ddfe0a52ca2156dcbfb03e41203d775ca506e
+  data.tar.gz: 1d280fbf96dc8efd81054d36808218f3cd21c2eff8a63f2a6575dd815de6e05d94c6e388f80ec146b657c9e93f283f8f11bb9f19868b514f0160b6f9d9c21cb2

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## 0.1.1
+
+- Automatically extend DB command timeout after timing out by retrying 6 times (7 times total) with exponential timeout increases
+- Avoid DB command timeout if DB result row count is received
+- Show error when DB command fails
+
+## 0.1.0
+
+- Remember last DB command
+- Move saved configuration from ~/.db_gui as a file to ~/.db_gui as a directory with multiple files underneath: ~/.db_gui/.db_configs & ~/.db_gui/.db_commands
+
 ## 0.0.4
 
 - Make SQL command entry a non_wrapping_multiline_entry

data/README.md

@@ -1,8 +1,7 @@
-# DB GUI (Database Graphical User Interface) 0.0.4
+# DB GUI (Database Graphical User Interface) 0.1.1
 ## [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=40 /> Glimmer DSL for LibUI Application](https://github.com/AndyObtiva/glimmer-dsl-libui)
 [![Gem Version](https://badge.fury.io/rb/db-gui.svg)](http://badge.fury.io/rb/db-gui)
 
-
 This is an early alpha database graphical user interface that enables interaction with a relational SQL database.
 
 It currently supports PostgreSQL as a start, with the potential of supporting many other databases in the future.
@@ -13,7 +12,7 @@ It currently supports PostgreSQL as a start, with the potential of supporting ma
 
 Run:
 ```
-gem install db-gui -v0.0.4
+gem install db-gui -v0.1.1
 ```
 
 ## Usage

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.1.1

data/app/db_gui/model/db.rb

@@ -0,0 +1,179 @@
+require 'fileutils'
+require 'timeout'
+
+class DbGui
+  module Model
+    Db = Struct.new(:host, :port, :dbname, :username, :password, :db_command_timeout, keyword_init: true) do
+      DIR_DB_GUI = File.expand_path(File.join('~', '.db_gui'))
+      FileUtils.rm(DIR_DB_GUI) if File.file?(DIR_DB_GUI)
+      FileUtils.mkdir_p(DIR_DB_GUI)
+      FILE_DB_CONFIGS = File.expand_path(File.join(DIR_DB_GUI, '.db_configs'))
+      FILE_DB_COMMANDS = File.expand_path(File.join(DIR_DB_GUI, '.db_commands'))
+      COUNT_RETRIES = ENV.fetch('DB_COMMAND_COUNT_RETRIES', 7)
+      REGEX_ROW_COUNT = /^\((\d+) row/
+      ERROR_PREFIX = 'ERROR:'
+      
+      attr_accessor :connected
+      alias connected? connected
+      attr_accessor :db_command_result
+      attr_accessor :db_command
+    
+      def initialize
+        load_db_config
+        load_db_command
+        self.port ||= 5432 # PostgreSQL default port
+        self.db_command_result = ''
+        self.db_command_timeout ||= ENV.fetch('DB_COMMAND_TIMEOUT_IN_MILLISECONDS', 300).to_i
+        connect if to_h.except(:password).none? {|value| value.nil? || (value.respond_to?(:empty?) && value.empty?) }
+      end
+      
+      def toggle_connection
+        if connected?
+          disconnect
+        else
+          connect
+        end
+      end
+      
+      def connect
+        io
+        self.connected = true
+        save_db_config
+      end
+      
+      def disconnect
+        io.close
+        @io = nil
+        self.connected = false
+      end
+      
+      def io
+        db_connection_command = "PGPASSWORD=\"#{password}\" psql --host=#{host} --port=#{port} --username=#{username} --dbname=#{dbname}"
+        @io ||= IO.popen(db_connection_command, 'r+', err: [:child, :out])
+      end
+      
+      def run_io_command(command)
+        command = command.strip
+        command = "#{command};" unless command.end_with?(';')
+        @io_command_try ||= 0
+        @io_command_try += 1
+        io.puts(command)
+        read_io_into_db_command_result
+        @io_command_try = nil
+      rescue Timeout::Error, Errno::EPIPE => e
+        puts e.message
+        @io = nil
+        if @io_command_try > COUNT_RETRIES
+          @io_command_try = nil
+        else
+          self.db_command_timeout *= 2
+          puts "Retrying DB Command...  {try: #{@io_command_try + 1}, db_command_timeout: #{db_command_timeout}}"
+          run_io_command(command) unless db_command_result_error?
+        end
+      end
+      
+      def run_db_command
+        run_io_command(db_command)
+        save_db_config
+        save_db_command
+      end
+      
+      def db_command_result_count
+        db_command_result_count_headers_rows[0]
+      end
+      
+      def db_command_result_headers
+        db_command_result_count_headers_rows[1]
+      end
+      
+      def db_command_result_rows
+        db_command_result_count_headers_rows[2]
+      end
+      
+      def db_command_result_error?
+        db_command_result.to_s.strip.start_with?(ERROR_PREFIX)
+      end
+      
+      private
+      
+      def read_io_into_db_command_result
+        self.db_command_result = read_db_command_result = ''
+        while (!(@line.to_s.match(REGEX_ROW_COUNT) || @line.to_s.strip == "^") && (@line = io_gets))
+          read_db_command_result += @line.to_s
+        end
+        self.db_command_result = read_db_command_result
+      rescue
+        if read_db_command_result.to_s.strip.start_with?(ERROR_PREFIX)
+          self.db_command_result = read_db_command_result
+        else
+          raise
+        end
+      ensure
+        @line = nil
+      end
+      
+      def save_db_config
+        db_config_hash = to_h
+        db_configs_array = [db_config_hash] # TODO in the future, support storing multiple DB configs
+        db_configs_file_content = YAML.dump(db_configs_array)
+        File.write(FILE_DB_CONFIGS, db_configs_file_content)
+      end
+      
+      def load_db_config
+        db_configs_file_content = File.read(FILE_DB_CONFIGS)
+        db_configs_array = [YAML.load(db_configs_file_content)].flatten
+        db_config_hash = db_configs_array.first # TODO in the future, support loading multiple DB configs
+        db_config_hash.each do |attribute, value|
+          self.send("#{attribute}=", value)
+        end
+      rescue => e
+        puts "No database configurations stored yet. #{e.message}"
+      end
+      
+      def save_db_command
+        db_commands_array = [db_command] # TODO in the future, support storing multiple DB configs
+        db_commands_file_content = YAML.dump(db_commands_array)
+        File.write(FILE_DB_COMMANDS, db_commands_file_content)
+      end
+      
+      def load_db_command
+        db_commands_file_content = File.read(FILE_DB_COMMANDS)
+        db_commands_array = YAML.load(db_commands_file_content)
+        self.db_command = db_commands_array.first
+      rescue => e
+        puts "No database commands stored yet. #{e.message}"
+      end
+      
+      def io_gets
+        Timeout.timeout(db_command_timeout/1000.0) { io.gets }
+      rescue
+        @io = nil
+        raise
+      end
+      
+      def db_command_result_count_headers_rows
+        if @db_command_result_count_headers_rows.nil? || db_command_result != @last_db_command_result
+          @db_command_result_count_headers_rows = compute_db_command_result_count_headers_rows
+          @last_db_command_result = db_command_result
+        end
+        @db_command_result_count_headers_rows
+      end
+      
+      def compute_db_command_result_count_headers_rows
+        count = 0
+        headers = rows = []
+        db_command_result_lines = db_command_result.lines.reject { |line| line == "\n" }
+        if db_command_result_lines.any?
+          headers = db_command_result_lines.first.split('|').map(&:strip)
+          count_footer = db_command_result_lines.last
+          count_match = count_footer.match(REGEX_ROW_COUNT)
+          if count_match
+            count = count_match[1].to_i
+            rows = db_command_result_lines[2..-2].map {|row| row.split('|').map(&:strip) }
+          end
+        end
+        [count, headers, rows]
+      end
+    end
+  end
+end

data/app/db_gui/view/db_command_form.rb

@@ -1,4 +1,4 @@
-require 'db_gui/model/db_config'
+require 'db_gui/model/db'
 
 class DbGui
   module View
@@ -7,12 +7,12 @@ class DbGui
       
       TIMEOUT_MAX_IN_MILLISECONDS = (ENV['TIMEOUT_MAX_IN_MILLISECONDS'] || 60*60*1000).to_i
       
-      option :db_config
+      option :db
       
       body {
         vertical_box {
           non_wrapping_multiline_entry {
-            text <=> [db_config, :db_command]
+            text <=> [db, :db_command]
           }
           
           horizontal_box {
@@ -20,7 +20,7 @@ class DbGui
           
             button('Run') {
               on_clicked do
-                db_config.run_db_command
+                db.run_db_command
               end
             }
             
@@ -29,7 +29,7 @@ class DbGui
             }
             spinbox(0, TIMEOUT_MAX_IN_MILLISECONDS) {
               stretchy false
-              value <=> [db_config, :db_command_timeout]
+              value <=> [db, :db_command_timeout, on_read: :to_i]
             }
             
             label('Row(s): ') {
@@ -37,7 +37,7 @@ class DbGui
             }
             label {
               stretchy false
-              text <= [db_config, :db_command_result_count, computed_by: :db_command_result, on_read: :to_s]
+              text <= [db, :db_command_result_count, computed_by: :db_command_result, on_read: :to_s]
             }
           }
         }

data/app/db_gui/view/db_command_result_table.rb

@@ -1,22 +1,24 @@
-require 'db_gui/model/db_config'
+require 'db_gui/model/db'
 
 class DbGui
   module View
     class DbCommandResultTable
       include Glimmer::LibUI::CustomControl
       
-      option :db_config
+      option :db
       
       body {
         vertical_box {
-          content(db_config, :db_command_result) {
-            if db_config.db_command_result_count > 0
+          content(db, :db_command_result) {
+            if db.db_command_result_error?
+              label(db.db_command_result)
+            elsif db.db_command_result_count > 0
               table {
-                db_config.db_command_result_headers.each do |header|
+                db.db_command_result_headers.each do |header|
                   text_column(header)
                 end
                 
-                cell_rows db_config.db_command_result_rows
+                cell_rows db.db_command_result_rows
               }
             else
               label('No data')

data/app/db_gui/view/db_config_form.rb

@@ -1,52 +1,52 @@
-require 'db_gui/model/db_config'
+require 'db_gui/model/db'
 
 class DbGui
   module View
     class DbConfigForm
       include Glimmer::LibUI::CustomControl
       
-      option :db_config
+      option :db
       
       body {
         vertical_box {
           form {
             entry {
               label 'Host:'
-              text <=> [db_config, :host]
-              enabled <= [db_config, :connected, on_read: :!]
+              text <=> [db, :host]
+              enabled <= [db, :connected, on_read: :!]
             }
             
             spinbox(0, 1_000_000) {
               label 'Port:'
-              value <=> [db_config, :port]
-              enabled <= [db_config, :connected, on_read: :!]
+              value <=> [db, :port]
+              enabled <= [db, :connected, on_read: :!]
             }
             
             entry {
               label 'Database Name:'
-              text <=> [db_config, :dbname]
-              enabled <= [db_config, :connected, on_read: :!]
+              text <=> [db, :dbname]
+              enabled <= [db, :connected, on_read: :!]
             }
             
             entry {
               label 'Username:'
-              text <=> [db_config, :username]
-              enabled <= [db_config, :connected, on_read: :!]
+              text <=> [db, :username]
+              enabled <= [db, :connected, on_read: :!]
             }
             
             password_entry {
               label 'Password:'
-              text <=> [db_config, :password]
-              enabled <= [db_config, :connected, on_read: :!]
+              text <=> [db, :password]
+              enabled <= [db, :connected, on_read: :!]
             }
           }
           
           button {
             stretchy false
-            text <= [db_config, :connected, on_read: -> (connected) { connected ? 'Disconnect (currently connected)' : 'Connect (currently disconnected)' }]
+            text <= [db, :connected, on_read: -> (connected) { connected ? 'Disconnect (currently connected)' : 'Connect (currently disconnected)' }]
               
             on_clicked do
-              db_config.toggle_connection
+              db.toggle_connection
             end
           }
         }

data/app/db_gui/view/db_gui_application.rb

@@ -1,4 +1,4 @@
-require 'db_gui/presenter/db_gui_presenter'
+require 'db_gui/model/db'
 
 require 'db_gui/view/db_config_form'
 require 'db_gui/view/db_command_form'
@@ -9,10 +9,10 @@ class DbGui
     class DbGuiApplication
       include Glimmer::LibUI::Application
     
-      attr_reader :presenter
+      attr_reader :db
           
       before_body do
-        @presenter = Presenter::DbGuiPresenter.new
+        @db = Model::Db.new
 #         menu_bar # TODO implement
       end
   
@@ -24,13 +24,13 @@ class DbGui
           margined true
          
           vertical_box {
-            db_config_form(db_config: presenter.db_config) {
+            db_config_form(db:) {
               stretchy false
             }
             
-            db_command_form(db_config: presenter.db_config)
+            db_command_form(db:)
             
-            db_command_result_table(db_config: presenter.db_config)
+            db_command_result_table(db:)
           }
         }
       }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db-gui
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.1
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-21 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer-dsl-libui
@@ -86,8 +86,7 @@ files:
 - VERSION
 - app/db-gui.rb
 - app/db_gui/launch.rb
-- app/db_gui/model/db_config.rb
-- app/db_gui/presenter/db_gui_presenter.rb
+- app/db_gui/model/db.rb
 - app/db_gui/view/db_command_form.rb
 - app/db_gui/view/db_command_result_table.rb
 - app/db_gui/view/db_config_form.rb

data/app/db_gui/model/db_config.rb

@@ -1,137 +0,0 @@
-require 'timeout'
-
-class DbGui
-  module Model
-    # TODO consider renaming to DB connection
-    DbConfig = Struct.new(:host, :port, :dbname, :username, :password, keyword_init: true) do
-      FILE_DB_CONFIG = File.expand_path(File.join('~', '.db_gui'))
-      
-      attr_accessor :connected
-      alias connected? connected
-      attr_accessor :db_command_result
-      attr_accessor :db_command
-      attr_accessor :db_command_timeout
-    
-      def initialize
-        self.port = 5432 # PostgreSQL default port
-        self.db_command_result = ''
-        self.db_command_timeout = (ENV['DB_COMMAND_TIMEOUT_IN_MILLISECONDS'] || 300).to_i
-        load_db_config
-        connect if to_a.none? {|value| value.nil? || (value.respond_to?(:empty?) && value.empty?) }
-      end
-      
-      def toggle_connection
-        if connected?
-          disconnect
-        else
-          connect
-        end
-      end
-      
-      def connect
-        io
-        self.connected = true
-        save_db_config
-      end
-      
-      def disconnect
-        io.close
-        @io = nil
-        self.connected = false
-      end
-      
-      def io
-        @io ||= IO.popen("PGPASSWORD=\"#{password}\" psql --host=#{host} --port=#{port} --username=#{username} --dbname=#{dbname}", 'r+')
-      end
-      
-      def run_io_command(command)
-        command = command.strip
-        command = "#{command};" unless command.end_with?(';')
-        @io_command_try ||= 0
-        @io_command_try += 1
-        io.puts(command)
-        read_io_into_db_command_result
-      rescue Errno::EPIPE => e
-        @io = nil
-        run_io_command(command) unless @io_command_try > 1
-      end
-      
-      def run_db_command
-        run_io_command(db_command)
-      end
-      
-      def db_command_result_count
-        db_command_result_count_headers_rows[0]
-      end
-      
-      def db_command_result_headers
-        db_command_result_count_headers_rows[1]
-      end
-      
-      def db_command_result_rows
-        db_command_result_count_headers_rows[2]
-      end
-      
-      private
-      
-      def read_io_into_db_command_result
-        self.db_command_result = ''
-        while (line = io_gets)
-          result = line.to_s
-          self.db_command_result += result
-        end
-      rescue Errno::EPIPE => e
-        @io = nil
-      end
-      
-      def save_db_config
-        db_config_hash = to_h
-        db_config_file_content = YAML.dump(db_config_hash)
-        File.write(FILE_DB_CONFIG, db_config_file_content)
-      end
-      
-      def load_db_config
-        db_config_file_content = File.read(FILE_DB_CONFIG)
-        db_config_hash = YAML.load(db_config_file_content)
-        db_config_hash.each do |attribute, value|
-          self.send("#{attribute}=", value)
-        end
-      rescue => e
-        puts "No database configuration is stored yet. #{e.message}"
-      end
-      
-      def io_gets
-        # TODO figure out a way of knowing the end of input without timing out
-        Timeout.timeout(db_command_timeout/1000.0) { io.gets }
-      rescue
-        @io = nil
-        nil
-      end
-      
-      def db_command_result_count_headers_rows
-        if @db_command_result_count_headers_rows.nil? || db_command_result != @last_db_command_result
-          @db_command_result_count_headers_rows = compute_db_command_result_count_headers_rows
-          @last_db_command_result = db_command_result
-        end
-        @db_command_result_count_headers_rows
-      end
-      
-      def compute_db_command_result_count_headers_rows
-        count = 0
-        headers = rows = []
-        db_command_result_lines = db_command_result.lines
-        db_command_result_lines.pop if db_command_result_lines.last == "\n"
-        if db_command_result_lines.any?
-          headers = db_command_result_lines.first.split('|').map(&:strip)
-          count_footer = db_command_result_lines.last
-          count_match = count_footer.match(/^\((\d+) row/)
-          if count_match
-            count = count_match[1].to_i
-            rows = db_command_result_lines[2..-2].map {|row| row.split('|').map(&:strip) }
-          end
-        end
-        [count, headers, rows]
-      end
-    end
-  end
-end

data/app/db_gui/presenter/db_gui_presenter.rb

@@ -1,13 +0,0 @@
-require 'db_gui/model/db_config'
-
-class DbGui
-  module Presenter
-    class DbGuiPresenter
-      attr_reader :db_config
-      
-      def initialize
-        @db_config = Model::DbConfig.new
-      end
-    end
-  end
-end