db-gui 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a23c4423702e92a9b634a90e32d385ac6482ebe1259656a467469c483bfb50e
-  data.tar.gz: a5dd6514f0d2dd0e0c06b9adc06b1df13ca36be01a3e205eb37aa101568c9117
+  metadata.gz: 1a78c9674da527b498d11f7147b066c48d4b9de25f4ad3bffc6d3c7f908e7380
+  data.tar.gz: 7d8c82fae0cdc343a6ef2dae98a0b820cd73fa9c6c4c128f60d1ecc751429a0a
 SHA512:
-  metadata.gz: e3d60b076358330b17e79cc29f54e15f0fb72a7a5f2459bd1e319268d5c56dae9be0107bc0d3b6b3c1fcd7603c3e5666d7c9fecf3a83d7187b727cd8b8addc44
-  data.tar.gz: 01c2e579505a3f05aea916a5b977911bbd344844bab274e7d457f88e66d7626e6bee9f6addba5fbb15df1b273045242bf8f2d8a84743a4d23f6488d284ef136c
+  metadata.gz: '021209590135c5c94cea318db98b73362c944909d5da2e168544a8524c357f4382baef9776205575459fd0f32f26ec4b86be6de943ec9f04ab0a534574b103d8'
+  data.tar.gz: 5596987aded997443eff090340dcf0b407c335e84cf2194194ec30101493d96a0b662b61fb51cae55b67a493f17d443c171dd63cc37fdd2ceb8f14c6fad0c453

data/CHANGELOG.md

@@ -1,9 +1,19 @@
 # Change Log
 
+## 0.3.0
+
+- Support the ability to save/load multiple databases (DB configs)
+- Add more resiliency against errors when copying table or record data via menu items
+
+## 0.2.3
+
+- Edit -> Copy Table (with query & headers) menu item to copy table data with query (e.g. SQL) & headers as a formatted string to the clipboard
+
 ## 0.2.2
 
 - Edit -> Copy Table (with headers) menu item to copy table data with headers as a formatted string to the clipboard
 - Edit -> Copy Selected Row  (with headers) menu item to copy selected row data with headers as a formatted string to the clipboard
+- Query -> Run menu item to run query
 
 ## 0.2.1
 

data/README.md

@@ -1,4 +1,4 @@
-# DB GUI (Database Graphical User Interface) 0.2.2
+# DB GUI (Database Graphical User Interface) 0.3.0
 ## [<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.2.2
+gem install db-gui -v0.3.0
 ```
 
 ## Usage
@@ -32,11 +32,14 @@ Note that it stores the last connection details under `~/.db_gui`, and will auto
 
 Click on this menu item to copy the table data as a formatted string to the clipboard.
 
-
 **Edit -> Copy Table (with headers)**
 
 Click on this menu item to copy the table data with headers as a formatted string to the clipboard.
 
+**Edit -> Copy Table (with query & headers)**
+
+Click on this menu item to copy the table data with query (e.g. SQL) & headers 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.

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/app/db-gui.rb

@@ -13,6 +13,11 @@ class DbGui
   APP_ROOT = File.expand_path('../..', __FILE__)
   VERSION = File.read(File.join(APP_ROOT, 'VERSION'))
   LICENSE = File.read(File.join(APP_ROOT, 'LICENSE.txt'))
+  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_config'))
+  FILE_DB_COMMANDS = File.expand_path(File.join(DIR_DB_GUI, '.db_commands'))
 end
 
 require 'db_gui/view/db_gui_application.rb'

data/app/db_gui/model/db.rb

@@ -4,17 +4,15 @@ require 'clipboard'
 
 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'))
+    Db = Struct.new(:name, :host, :port, :dbname, :username, :password, :db_command_timeout, keyword_init: true) do
+      
       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 :deleteable
+      alias deleteable? deleteable
       attr_accessor :connected
       alias connected? connected
       attr_accessor :db_command_result
@@ -22,13 +20,37 @@ class DbGui
       attr_accessor :db_command_result_selection
     
       def initialize
-        load_db_config
         load_db_command
+        reset
+        to_h.keys.each do |attribute|
+          Glimmer::DataBinding::Observer.proc do |value|
+            notify_observers(:saveable)
+          end.observe(self, attribute)
+        end
+      end
+      
+      def reset
+        self.name = Db::NAME_NEW
+        self.host = nil
         self.port ||= 5432 # PostgreSQL default port
+        self.dbname = nil
+        self.username = nil
+        self.password = nil
         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
+      
+      def new?
+        name === Db::NAME_NEW
+      end
+      
+      def saveable
+        !new?
+      end
+      
+      def deleteable
+        !new?
       end
       
       def toggle_connection
@@ -42,7 +64,6 @@ class DbGui
       def connect
         io
         self.connected = true
-        save_db_config
       end
       
       def disconnect
@@ -78,7 +99,6 @@ class DbGui
       
       def run_db_command
         run_io_command(db_command)
-        save_db_config
         save_db_command
       end
       
@@ -103,14 +123,19 @@ class DbGui
         Clipboard.copy(formatted_table_string)
       end
       
-      def copy_selected_row
+      def copy_table_with_headers
         return if db_command_result_rows.empty?
-        Clipboard.copy(formatted_selected_row_string)
+        Clipboard.copy(formatted_table_string(include_headers: true))
       end
       
-      def copy_table_with_headers
+      def copy_table_with_query_and_headers
         return if db_command_result_rows.empty?
-        Clipboard.copy(formatted_table_string(include_headers: true))
+        Clipboard.copy(formatted_table_string(include_query: true, include_headers: true))
+      end
+      
+      def copy_selected_row
+        return if db_command_result_rows.empty?
+        Clipboard.copy(formatted_selected_row_string)
       end
       
       def copy_selected_row_with_headers
@@ -118,16 +143,18 @@ class DbGui
         Clipboard.copy(formatted_selected_row_string(include_headers: true))
       end
       
-      def formatted_table_string(rows = nil, include_headers: false)
+      def formatted_table_string(rows = nil, include_query: false, include_headers: false)
         rows ||= db_command_result_rows
         rows = rows.dup
         rows.prepend(db_command_result_headers) if include_headers
-        column_max_lengths = row_column_max_lengths(rows) # TODO calculate those after prepending headers
-        rows.map do |row|
+        column_max_lengths = row_column_max_lengths(rows)
+        formatted_string = 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)
+        formatted_string.prepend("#{db_command}\n\n") if include_query
+        formatted_string
       end
       
       def formatted_selected_row_string(include_headers: false)
@@ -155,26 +182,8 @@ class DbGui
         @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_array = [db_command] # TODO in the future, support storing multiple DB commands
         db_commands_file_content = YAML.dump(db_commands_array)
         File.write(FILE_DB_COMMANDS, db_commands_file_content)
       end
@@ -205,6 +214,8 @@ class DbGui
       def compute_db_command_result_count_headers_rows
         count = 0
         headers = rows = []
+        # TODO db_command_result.lines has an issue in case the data in the DB in a certain row contains \n
+        # Try to bisect data more correctly, maybe by looking at \n one by one
         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)
@@ -231,5 +242,6 @@ class DbGui
         column_max_lengths
       end
     end
+    Db::NAME_NEW = '(New Config)'
   end
 end

data/app/db_gui/presenter/db_presenter.rb

@@ -0,0 +1,83 @@
+require 'glimmer/data_binding/observable_model'
+require 'db_gui/model/db'
+
+class DbGui
+  module Presenter
+    class DbPresenter
+      include Glimmer::DataBinding::ObservableModel
+      
+      attr_accessor :dbs, :selected_db, :new_db
+      
+      def initialize
+        @new_db = Model::Db.new
+        @dbs = [@new_db]
+        @selected_db = @new_db
+        load_db_config
+        selected_db.connect
+      end
+      
+      def newable
+        selected_db != new_db
+      end
+      
+      def selected_db_name
+        selected_db.name
+      end
+      
+      def selected_db_name=(db_name)
+        self.selected_db = dbs.find { |db| db.name == db_name }
+        notify_observers(:newable)
+        save_config
+      end
+      
+      def save
+        if selected_db == new_db && selected_db.name != Model::Db::NAME_NEW
+          saved_db = new_db.clone
+          new_db.reset
+          dbs << saved_db # this will trigger an update to the combobox items
+          self.selected_db_name = saved_db.name
+        else
+          notify_observers(:dbs)
+          self.selected_db_name = selected_db.name
+        end
+        save_config
+      end
+      
+      def new
+        self.selected_db_name = new_db.name
+      end
+      
+      def delete
+        dbs.delete(selected_db)
+        self.selected_db_name = new_db.name
+      end
+      
+      def save_config
+        dbs_attributes = dbs.reject {|db| db.name == Model::Db::NAME_NEW }.map(&:to_h)
+        selected_db_name
+        db_config = {
+          selected_db_name:,
+          dbs: dbs_attributes,
+        }
+        db_config_yaml = YAML.dump(db_config)
+        File.write(FILE_DB_CONFIGS, db_config_yaml)
+      end
+      
+      def load_db_config
+        db_config_yaml = File.read(FILE_DB_CONFIGS)
+        db_config = YAML.load(db_config_yaml)
+        db_config[:dbs].each do |db_config|
+          db = Model::Db.new
+          db_config.each do |attribute, value|
+            db.send("#{attribute}=", value)
+          end
+          self.dbs << db
+        end
+        self.selected_db_name = db_config[:selected_db_name]
+      rescue => e
+        puts "No database configurations stored yet. #{e.message}"
+      end
+      
+    end
+  end
+end

data/app/db_gui/view/db_command_form.rb

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

data/app/db_gui/view/db_command_result_table.rb

@@ -5,25 +5,25 @@ class DbGui
     class DbCommandResultTable
       include Glimmer::LibUI::CustomControl
       
-      option :db
+      option :db_presenter
       
       body {
         vertical_box {
-          content(db, :db_command_result) {
-            if db.db_command_result_error?
-              label(db.db_command_result)
-            elsif db.db_command_result_count > 0
+          content(db_presenter, 'selected_db.db_command_result') {
+            if db_presenter.selected_db.db_command_result_error?
+              label(db_presenter.selected_db.db_command_result)
+            elsif db_presenter.selected_db.db_command_result_count > 0
               table {
-                db.db_command_result_headers.each do |header|
+                db_presenter.selected_db.db_command_result_headers.each do |header|
                   text_column(header)
                 end
                 
-                cell_rows db.db_command_result_rows
+                cell_rows db_presenter.selected_db.db_command_result_rows
                 selection_mode :one
-                selection db.db_command_result_selection
+                selection db_presenter.selected_db.db_command_result_selection
                 
                 on_selection_changed do |t, selection, added_selection, removed_selection|
-                  db.db_command_result_selection = selection
+                  db_presenter.selected_db.db_command_result_selection = selection
                 end
               }
             else

data/app/db_gui/view/db_config_form.rb

@@ -5,48 +5,89 @@ class DbGui
     class DbConfigForm
       include Glimmer::LibUI::CustomControl
       
-      option :db
+      option :db_presenter
       
       body {
         vertical_box {
           form {
+            combobox { |me|
+              label 'Selected Config:'
+              items <= [db_presenter, :dbs, on_read: ->(dbs) { dbs.map(&:name) }]
+              selected_item <=> [db_presenter, :selected_db_name]
+              enabled <= [db_presenter, 'selected_db.connected', on_read: :!]
+            }
+            
             entry {
               label 'Host:'
-              text <=> [db, :host]
-              enabled <= [db, :connected, on_read: :!]
+              text <=> [db_presenter, 'selected_db.host']
+              enabled <= [db_presenter, 'selected_db.connected', on_read: :!]
             }
             
             spinbox(0, 1_000_000) {
               label 'Port:'
-              value <=> [db, :port]
-              enabled <= [db, :connected, on_read: :!]
+              value <=> [db_presenter, 'selected_db.port']
+              enabled <= [db_presenter, 'selected_db.connected', on_read: :!]
             }
             
             entry {
               label 'Database Name:'
-              text <=> [db, :dbname]
-              enabled <= [db, :connected, on_read: :!]
+              text <=> [db_presenter, 'selected_db.dbname']
+              enabled <= [db_presenter, 'selected_db.connected', on_read: :!]
             }
             
             entry {
               label 'Username:'
-              text <=> [db, :username]
-              enabled <= [db, :connected, on_read: :!]
+              text <=> [db_presenter, 'selected_db.username']
+              enabled <= [db_presenter, 'selected_db.connected', on_read: :!]
             }
             
             password_entry {
               label 'Password:'
-              text <=> [db, :password]
-              enabled <= [db, :connected, on_read: :!]
+              text <=> [db_presenter, 'selected_db.password']
+              enabled <= [db_presenter, 'selected_db.connected', on_read: :!]
+            }
+            
+            horizontal_box {
+              entry {
+                text <=> [db_presenter, 'selected_db.name']
+                enabled <= [db_presenter, 'selected_db.connected', on_read: :!]
+              }
+              button {
+                stretchy false
+                text 'Save'
+                enabled <= [db_presenter, 'selected_db.saveable']
+                
+                on_clicked do
+                  db_presenter.save
+                end
+              }
+              button {
+                stretchy false
+                text 'Delete'
+                enabled <= [db_presenter, 'selected_db.deleteable']
+                
+                on_clicked do
+                  db_presenter.delete
+                end
+              }
+              button {
+                stretchy false
+                text 'New'
+                enabled <= [db_presenter, 'newable']
+                
+                on_clicked do
+                  db_presenter.new
+                end
+              }
             }
           }
           
           button {
             stretchy false
-            text <= [db, :connected, on_read: -> (connected) { connected ? 'Disconnect (currently connected)' : 'Connect (currently disconnected)' }]
+            text <= [db_presenter, 'selected_db.connected', on_read: -> (connected) { connected ? 'Disconnect (currently connected)' : 'Connect (currently disconnected)' }]
               
             on_clicked do
-              db.toggle_connection
+              db_presenter.selected_db.toggle_connection
             end
           }
         }

data/app/db_gui/view/db_gui_application.rb

@@ -1,4 +1,4 @@
-require 'db_gui/model/db'
+require 'db_gui/presenter/db_presenter'
 
 require 'db_gui/view/db_gui_menu_bar'
 require 'db_gui/view/db_config_form'
@@ -10,11 +10,11 @@ class DbGui
     class DbGuiApplication
       include Glimmer::LibUI::Application
     
-      attr_reader :db
+      attr_reader :db_presenter
           
       before_body do
-        @db = Model::Db.new
-        db_gui_menu_bar(db:)
+        @db_presenter = Presenter::DbPresenter.new
+        db_gui_menu_bar(db_presenter:)
       end
   
       body {
@@ -25,13 +25,13 @@ class DbGui
           margined true
          
           vertical_box {
-            db_config_form(db:) {
+            db_config_form(db_presenter:) {
               stretchy false
             }
             
-            db_command_form(db:)
+            db_command_form(db_presenter:)
             
-            db_command_result_table(db:)
+            db_command_result_table(db_presenter:)
           }
         }
       }

data/app/db_gui/view/db_gui_menu_bar.rb

@@ -3,47 +3,75 @@ class DbGui
     class DbGuiMenuBar
       include Glimmer::LibUI::CustomControl
   
-      option :db
+      option :db_presenter
   
       body {
         menu('Query') {
           menu_item('Run') {
             on_clicked do
-              db.run_db_command
+              db_presenter.selected_db.run_db_command
             end
           }
         }
         
         menu('Edit') {
           menu_item('Copy Table') {
-            enabled <= [db, :db_command_result_rows, computed_by: :db_command_result, on_read: -> (data) { !data.empty? }]
+            enabled <= [db_presenter, 'selected_db.db_command_result_rows', computed_by: 'selected_db.db_command_result', on_read: -> (data) { !data.empty? }]
             
             on_clicked do
-              db.copy_table
+              begin
+                db_presenter.selected_db.copy_table
+              rescue => e
+                puts "Encountered an error copying table: #{e.full_message}"
+              end
             end
           }
 
           menu_item('Copy Table (with headers)') {
-            enabled <= [db, :db_command_result_rows, computed_by: :db_command_result, on_read: -> (data) { !data.empty? }]
+            enabled <= [db_presenter, 'selected_db.db_command_result_rows', computed_by: 'selected_db.db_command_result', on_read: -> (data) { !data.empty? }]
+            
+            on_clicked do
+              begin
+                db_presenter.selected_db.copy_table_with_headers
+              rescue => e
+                puts "Encountered an error copying table (with headers): #{e.full_message}"
+              end
+            end
+          }
+
+          menu_item('Copy Table (with query & headers)') {
+            enabled <= [db_presenter, 'selected_db.db_command_result_rows', computed_by: 'selected_db.db_command_result', on_read: -> (data) { !data.empty? }]
             
             on_clicked do
-              db.copy_table_with_headers
+              begin
+                db_presenter.selected_db.copy_table_with_query_and_headers
+              rescue => e
+                puts "Encountered an error copying table (with query & headers): #{e.full_message}"
+              end
             end
           }
 
           menu_item('Copy Selected Row') {
-            enabled <= [db, :db_command_result_rows, computed_by: :db_command_result, on_read: -> (data) { !data.empty? }]
+            enabled <= [db_presenter, 'selected_db.db_command_result_rows', computed_by: 'selected_db.db_command_result', on_read: -> (data) { !data.empty? }]
             
             on_clicked do
-              db.copy_selected_row
+              begin
+                db_presenter.selected_db.copy_selected_row
+              rescue => e
+                puts "Encountered an error copying selected row: #{e.full_message}"
+              end
             end
           }
 
           menu_item('Copy Selected Row (with headers)') {
-            enabled <= [db, :db_command_result_rows, computed_by: :db_command_result, on_read: -> (data) { !data.empty? }]
+            enabled <= [db_presenter, 'selected_db.db_command_result_rows', computed_by: 'selected_db.db_command_result', on_read: -> (data) { !data.empty? }]
             
             on_clicked do
-              db.copy_selected_row_with_headers
+              begin
+                db_presenter.selected_db.copy_selected_row_with_headers
+              rescue => e
+                puts "Encountered an error copying selected row (with headers): #{e.full_message}"
+              end
             end
           }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db-gui
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Andy Maleh
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.7
+        version: 0.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.7
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: clipboard
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,7 @@ files:
 - app/db-gui.rb
 - app/db_gui/launch.rb
 - app/db_gui/model/db.rb
+- app/db_gui/presenter/db_presenter.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