db-gui 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b070cff693f1d1416c8b30af8e004ef0c11832b498825f7cabbda62e15f553f6
-  data.tar.gz: 219ad78e67ea7a7fc9fcb10e26daadfe4f58ffd797a6eee6983492128b656c6c
+  metadata.gz: 38eb8b2669f281d3dddb78945f259d5fe8dea12eb31b51f5761ce4ced71381e9
+  data.tar.gz: a0cb8959b31975f176302f20404011e3a8115d5e597461de0f90fe57a5305cf3
 SHA512:
-  metadata.gz: 04ac2266301b0bfb854d698b82ccb5f29e0aff6d23d882140975a4234840b85c3fdd996c1c80c18d89c4473ee4055ebcf169bc51ae560b211cf083c9c6cd4c9a
-  data.tar.gz: 138346868157342145069c35d60b1773e21a86b8b503b615705387e2bc51fb245cfc2d51ba19c99c10ae3bf081c042131b1ed908af1e6fedc12460dc01638a8b
+  metadata.gz: b664e4ed31d076e644451b58bd809dc9e9f58b8526d96d052d41eef238c4f293413f886eb0b4fe7f0d9fe19b66eba563d7d98f936fad43d0032b0e4f590ed9ec
+  data.tar.gz: 43696e4a6cb8ecd26363a5dc9f33588b1b88895aa5c16a63a88caa6fce393c9d2907f05e52b9ce66ecc3e35d6de8549e85e29f34af1191b81a1fda5b03e8cf5e

data/CHANGELOG.md

@@ -1,8 +1,23 @@
 # Change Log
 
+## 0.2.1
+
+- Fix bug in 0.2.0 with crashing whenever running a DB query for the second time.
+
+## 0.2.0
+
+- Edit -> Copy Table menu item to copy table data as a formatted string to the clipboard
+- Edit -> Copy Selected Row menu item to copy selected row data as a formatted string to the clipboard
+
+## 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
 
-- Save last DB command
+- 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

data/README.md

@@ -1,4 +1,4 @@
-# DB GUI (Database Graphical User Interface) 0.1.0
+# DB GUI (Database Graphical User Interface) 0.2.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)
 
@@ -12,7 +12,7 @@ It currently supports PostgreSQL as a start, with the potential of supporting ma
 
 Run:
 ```
-gem install db-gui -v0.1.0
+gem install db-gui -v0.2.1
 ```
 
 ## Usage
@@ -26,6 +26,16 @@ Or, run one of the aliases: `db-ui` / `dbgui` / `db-gui`
 
 Note that it stores the last connection details under `~/.db_gui`, and will auto-connect using that configuration on startup for extra convenience (in the future, there is the potential to support multiple connection configurations).
 
+### Menu Items
+
+**Edit -> Copy Table**
+
+Click on this menu item to copy the table data as a formatted string to the clipboard.
+
+**Edit -> Copy Selected Row**
+
+Click on this menu item to copy the selected row data as a formatted string to the clipboard.
+
 ## Change Log
 
 [CHANGELOG.md](/CHANGELOG.md)

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.1

data/app/db_gui/model/db.rb

@@ -1,27 +1,33 @@
 require 'fileutils'
 require 'timeout'
+require 'clipboard'
 
 class DbGui
   module Model
-    Db = Struct.new(:host, :port, :dbname, :username, :password, keyword_init: true) do
+    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:'
+      NEW_LINE = OS.windows? ? "\r\n" : "\n"
       
       attr_accessor :connected
       alias connected? connected
       attr_accessor :db_command_result
       attr_accessor :db_command
-      attr_accessor :db_command_timeout
+      attr_accessor :db_command_result_selection
     
       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
         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
+        self.db_command_result_selection = 0
         connect if to_h.except(:password).none? {|value| value.nil? || (value.respond_to?(:empty?) && value.empty?) }
       end
       
@@ -46,7 +52,8 @@ class DbGui
       end
       
       def io
-        @io ||= IO.popen("PGPASSWORD=\"#{password}\" psql --host=#{host} --port=#{port} --username=#{username} --dbname=#{dbname}", 'r+')
+        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)
@@ -56,13 +63,22 @@ class DbGui
         @io_command_try += 1
         io.puts(command)
         read_io_into_db_command_result
-      rescue Errno::EPIPE => e
+        @io_command_try = nil
+      rescue Timeout::Error, Errno::EPIPE => e
+        puts e.message
         @io = nil
-        run_io_command(command) unless @io_command_try > 1
+        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
       
@@ -78,16 +94,50 @@ class DbGui
         db_command_result_count_headers_rows[2]
       end
       
+      def db_command_result_error?
+        db_command_result.to_s.strip.start_with?(ERROR_PREFIX)
+      end
+      
+      def copy_table
+        return if db_command_result_rows.empty?
+        Clipboard.copy(formatted_table_string)
+      end
+      
+      def copy_selected_row
+        return if db_command_result_rows.empty?
+        Clipboard.copy(formatted_selected_row_string)
+      end
+      
+      def formatted_table_string
+        column_max_lengths = db_command_result_column_max_lengths
+        db_command_result_rows.map do |row|
+          row.each_with_index.map do |data, column_index|
+            data.ljust(column_max_lengths[column_index])
+          end.join(" | ")
+        end.join(NEW_LINE)
+      end
+      
+      def formatted_selected_row_string
+        selected_row = db_command_result_rows[db_command_result_selection]
+        selected_row.join(' | ')
+      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
+        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
-      rescue Errno::EPIPE => e
-        @io = nil
+        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
@@ -123,11 +173,10 @@ class DbGui
       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
+        raise
       end
       
       def db_command_result_count_headers_rows
@@ -141,12 +190,11 @@ class DbGui
       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"
+        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(/^\((\d+) row/)
+          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) }
@@ -154,6 +202,18 @@ class DbGui
         end
         [count, headers, rows]
       end
+      
+      def db_command_result_column_max_lengths
+        column_count = db_command_result_rows.first.size
+        column_max_lengths = []
+        db_command_result_rows.each do |row|
+          row.each_with_index do |value, column_index|
+            column_max_lengths[column_index] ||= 0
+            column_max_lengths[column_index] = [column_max_lengths[column_index], value.size].max
+          end
+        end
+        column_max_lengths
+      end
     end
   end
 end

data/app/db_gui/view/db_command_form.rb

@@ -29,7 +29,7 @@ class DbGui
             }
             spinbox(0, TIMEOUT_MAX_IN_MILLISECONDS) {
               stretchy false
-              value <=> [db, :db_command_timeout]
+              value <=> [db, :db_command_timeout, on_read: :to_i]
             }
             
             label('Row(s): ') {

data/app/db_gui/view/db_command_result_table.rb

@@ -10,13 +10,21 @@ class DbGui
       body {
         vertical_box {
           content(db, :db_command_result) {
-            if db.db_command_result_count > 0
+            if db.db_command_result_error?
+              label(db.db_command_result)
+            elsif db.db_command_result_count > 0
               table {
                 db.db_command_result_headers.each do |header|
                   text_column(header)
                 end
                 
                 cell_rows db.db_command_result_rows
+                selection_mode :one
+                selection db.db_command_result_selection
+                
+                on_selection_changed do |t, selection, added_selection, removed_selection|
+                  db.db_command_result_selection = selection
+                end
               }
             else
               label('No data')

data/app/db_gui/view/db_gui_application.rb

@@ -13,7 +13,7 @@ class DbGui
           
       before_body do
         @db = Model::Db.new
-#         menu_bar # TODO implement
+        menu_bar
       end
   
       body {
@@ -35,38 +35,48 @@ class DbGui
         }
       }
   
-#       def menu_bar
-#         menu('File') {
-#           menu_item('Preferences...') {
-#             on_clicked do
-#               display_preferences_dialog
-#             end
-#           }
-#
-#           quit_menu_item if OS.mac?
-#         }
-#         menu('Help') {
-#           if OS.mac?
-#             about_menu_item {
-#               on_clicked do
-#                 display_about_dialog
-#               end
-#             }
-#           end
-#
-#           menu_item('About') {
-#             on_clicked do
-#               display_about_dialog
-#             end
-#           }
-#         }
-#       end
-#
-#       def display_about_dialog
-#         message = "Db Gui #{VERSION}\n\n#{LICENSE}"
-#         msg_box('About', message)
-#       end
-#
+      def menu_bar
+        menu('Edit') {
+          menu_item('Copy Table') {
+            enabled <= [db, :db_command_result_rows, computed_by: :db_command_result, on_read: -> (data) { !data.empty? }]
+            
+            on_clicked do
+              db.copy_table
+            end
+          }
+
+          menu_item('Copy Selected Row') {
+            enabled <= [db, :db_command_result_rows, computed_by: :db_command_result, on_read: -> (data) { !data.empty? }]
+            
+            on_clicked do
+              db.copy_selected_row
+            end
+          }
+
+          quit_menu_item if OS.mac?
+        }
+        menu('Help') {
+          if OS.mac?
+            about_menu_item {
+              on_clicked do
+                display_about_dialog
+              end
+            }
+          end
+
+          menu_item('About') {
+            on_clicked do
+              display_about_dialog
+            end
+          }
+        }
+      end
+
+      def display_about_dialog
+        message = "DB GUI #{VERSION}\n\n#{LICENSE}"
+        msg_box('About', message)
+      end
+
 #       def display_preferences_dialog
 #         window {
 #           title 'Preferences'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: db-gui
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andy Maleh
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer-dsl-libui
@@ -24,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.7
+- !ruby/object:Gem::Dependency
+  name: clipboard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,12 +80,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: DB GUI (Database Graphical User Interface) - Enables Interaction with
-  Relational SQL Databases
+  Relational SQL Databases. This alpha version only supports PostgreSQL at the moment.
 email: andy.am@gmail.com
 executables:
 - db-gui
-- dbgui
 - db-ui
+- dbgui
 - dbui
 extensions: []
 extra_rdoc_files:
@@ -102,7 +115,6 @@ homepage: http://github.com/AndyObtiva/db-gui
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -118,8 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: DB GUI
 test_files: []