db-gui 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c47f16e87bb120e67c9ded08af1613226f997239310973d9c35f2cde6b7620ae
+  data.tar.gz: ea3c1ae5858376c27dd9817cedc213bf0fd16eb696e9a817e0efeb0af84a7ef7
+SHA512:
+  metadata.gz: 1f3ea785cfa0e94155628a7df1b278bd3b86840e50f009fa26401910958f6de524b1ebdd9713eada1ba9b6e4047fa9e529d06b2da1563576935491236e5aee31
+  data.tar.gz: c5bda179f9fef7c91bc82532ace7ca4b1ce17fd0bb426fb3ab37cd19cf296f6e98f8b57c6391e713c0092ae040bd2432976766a174e27c0895894005fe7489ef

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.0.1
+
+- DB GUI for PostgreSQL database with support for running SQL queries and seeing their result as text

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2025 Andy Maleh
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# DB GUI (Database Graphical User Interface) 0.0.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/glimmer_snake.svg)](http://badge.fury.io/rb/glimmer_snake)
+
+
+This is a database graphical user interface that enables interaction with relational SQL database data.
+
+It currently supports PostgreSQL as a start, with the potential of supporting many other databases in the future.
+
+![db gui](/screenshots/db-gui-mac.png)
+
+## Setup
+
+Run:
+```
+gem install db-gui -v0.0.1
+```
+
+## Usage
+
+Run:
+```
+dbui
+```
+
+Or run alias:
+```
+db-ui
+```
+
+Or run alias:
+```
+dbgui
+```
+
+Or run alias:
+```
+db-gui
+```
+
+## Change Log
+
+[CHANGELOG.md](/CHANGELOG.md)
+
+## TODO
+
+[TODO.md](/TODO.md)
+
+## Contributing to db_gui
+
+-   Check out the latest master to make sure the feature hasn't been
+    implemented or the bug hasn't been fixed yet.
+-   Check out the issue tracker to make sure someone already hasn't
+    requested it and/or contributed it.
+-   Fork the project.
+-   Start a feature/bugfix branch.
+-   Commit and push until you are happy with your contribution.
+-   Make sure to add tests for it. This is important so I don't break it
+    in a future version unintentionally.
+-   Please try not to mess with the Rakefile, version, or history. If
+    you want to have your own version, or is otherwise necessary, that
+    is fine, but please isolate to its own commit so I can cherry-pick
+    around it.
+
+## Copyright
+
+Copyright (c) 2025 Andy Maleh.
+[MIT](/LICENSE.txt)
+See [LICENSE.txt](/LICENSE.txt) for further details.
+
+--
+
+[<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=40 />](https://github.com/AndyObtiva/glimmer) Built with [Glimmer DSL for LibUI](https://github.com/AndyObtiva/glimmer-dsl-libui) (Ruby Desktop Development GUI Library)

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/db-gui.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.expand_path('..', __FILE__))
+
+begin
+  require 'bundler/setup'
+  Bundler.require(:default)
+rescue Exception
+  # this runs when packaged as a gem (no bundler)
+  require 'glimmer-dsl-libui'
+  # add more gems if needed
+end
+
+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'))
+end
+
+require 'db_gui/view/db_gui_application.rb'

data/app/db_gui/launch.rb

@@ -0,0 +1,4 @@
+# this is only a helper for the bin script to launch the app. Developers must generally not need to edit it.
+require_relative '../db-gui'
+
+DbGui::View::DbGuiApplication.launch

data/app/db_gui/model/db_config.rb

@@ -0,0 +1,96 @@
+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
+    
+      def initialize
+        self.port = 5432 # PostgreSQL default port
+        self.db_command_result = ''
+        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)
+        @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
+      
+      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(3) { io.gets }
+      rescue
+        @io = nil
+        nil
+      end
+    end
+  end
+end

data/app/db_gui/presenter/db_gui_presenter.rb

@@ -0,0 +1,13 @@
+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

data/app/db_gui/view/db_command_form.rb

@@ -0,0 +1,27 @@
+require 'db_gui/model/db_config'
+
+class DbGui
+  module View
+    class DbCommandForm
+      include Glimmer::LibUI::CustomControl
+      
+      option :db_config
+      
+      body {
+        vertical_box {
+          entry {
+            text <=> [db_config, :db_command]
+          }
+          
+          button('Run') {
+            stretchy false
+              
+            on_clicked do
+              db_config.run_db_command
+            end
+          }
+        }
+      }
+    end
+  end
+end

data/app/db_gui/view/db_config_form.rb

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

data/app/db_gui/view/db_gui_application.rb

@@ -0,0 +1,96 @@
+require 'db_gui/presenter/db_gui_presenter'
+
+require 'db_gui/view/db_config_form'
+require 'db_gui/view/db_command_form'
+
+class DbGui
+  module View
+    class DbGuiApplication
+      include Glimmer::LibUI::Application
+    
+      attr_reader :presenter
+          
+      before_body do
+        @presenter = Presenter::DbGuiPresenter.new
+#         menu_bar # TODO implement
+      end
+  
+      body {
+        window {
+          content_size 1024, 800
+          title 'DB GUI'
+          
+          margined true
+         
+          vertical_box {
+            db_config_form(db_config: presenter.db_config) {
+              stretchy false
+            }
+            
+            db_command_form(db_config: presenter.db_config)
+            
+            non_wrapping_multiline_entry {
+              text <=> [presenter.db_config, :db_command_result, on_write: ->(value) {presenter.db_config.db_command_result}]
+            }
+          }
+        }
+      }
+  
+#       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 display_preferences_dialog
+#         window {
+#           title 'Preferences'
+#           content_size 200, 100
+#
+#           margined true
+#
+#           vertical_box {
+#             padded true
+#
+#             label('Greeting:') {
+#               stretchy false
+#             }
+#
+#             radio_buttons {
+#               stretchy false
+#
+#               items Model::Greeting::GREETINGS
+#               selected <=> [@greeting, :text_index]
+#             }
+#           }
+#         }.show
+#       end
+    end
+  end
+end

data/bin/db-gui

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+runner = File.expand_path('../../app/db_gui/launch.rb', __FILE__)
+
+require 'glimmer/launcher'
+
+launcher = Glimmer::Launcher.new([runner] + ARGV)
+launcher.launch

data/bin/db-ui

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+runner = File.expand_path('../../app/db_gui/launch.rb', __FILE__)
+
+require 'glimmer/launcher'
+
+launcher = Glimmer::Launcher.new([runner] + ARGV)
+launcher.launch

data/bin/dbgui

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+runner = File.expand_path('../../app/db_gui/launch.rb', __FILE__)
+
+require 'glimmer/launcher'
+
+launcher = Glimmer::Launcher.new([runner] + ARGV)
+launcher.launch

data/bin/dbui

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+runner = File.expand_path('../../app/db_gui/launch.rb', __FILE__)
+
+require 'glimmer/launcher'
+
+launcher = Glimmer::Launcher.new([runner] + ARGV)
+launcher.launch

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: db-gui
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andy Maleh
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: glimmer-dsl-libui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.9
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Db Gui
+email: andy.am@gmail.com
+executables:
+- db-gui
+- dbgui
+- db-ui
+- dbui
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- 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/view/db_command_form.rb
+- app/db_gui/view/db_config_form.rb
+- app/db_gui/view/db_gui_application.rb
+- bin/db-gui
+- bin/db-ui
+- bin/dbgui
+- bin/dbui
+- icons/linux/Db Gui.png
+- icons/macosx/Db Gui.icns
+- icons/windows/Db Gui.ico
+homepage: http://github.com/AndyObtiva/db-gui
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- app
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Db Gui
+test_files: []