sqlui 0.1.16 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7c438724dd4d58432da2908650a10bb82c3452a2faf4f0560c5dd23a8fd6d66
-  data.tar.gz: 949a64296520f3e7fcfec48ae1a4cc8b4a4056184d88a88ca52b5813b1ad8064
+  metadata.gz: f951e672b477e0fd4882c1aa4e42472975ac07fa6a2955eb4430bc1018ea6165
+  data.tar.gz: d8e7da6fe289ed3e94322a3ea3d5ce461356cbfa73e2e2732bab9001a8d3af24
 SHA512:
-  metadata.gz: ab6348bdcbeb1b2dfd7e38c206b7d72bf388f28ae992e15c40823b00db1bc3bdfb705cc3764373ca0f1de053b32ea546f84bdacf99328b5b6def0f9aea40954e
-  data.tar.gz: a55564765cd9c90fe47ef06d521aefde3bc78f903527cd4a49b6817267364ff6cd609d47b645a9508c382fcc1798b355b414b12ea861782038b538dbaa90a861
+  metadata.gz: 6769e3ee3c0b5330ca0b1ac1433370756838cec3187f0bd9822308704d31ee1608592199acb9b622edba8d45146c557e413d42c0a060bb9ace9b7653b43ad54c
+  data.tar.gz: 4ef70417125cdb931c5f6edba2ef7986be7bda22f0f27c362d7bea97df81752133493e9507b941cbfe51261fa4e77aca85f4838354805a97d88e64f0240e452d

data/.version

@@ -1 +1 @@
-0.1.16
+0.1.18

data/app/environment.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# Parses and provides access to environment variables.
 class Environment
   SERVER_ENV = ENV.fetch('SERVER_ENV', 'development').to_sym
   SERVER_PORT = ENV.fetch('SERVER_PORT', 8080)
@@ -17,4 +20,4 @@ class Environment
   def self.server_port
     SERVER_PORT
   end
-end
+end

data/app/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'erb'
 require 'json'
 require 'mysql2'
@@ -12,14 +14,16 @@ if ARGV.include?('-v') || ARGV.include?('--version')
 end
 
 raise 'you must specify a configuration file' unless ARGV.size == 1
-raise "configuration file does not exist" unless File.exist?(ARGV[0])
+raise 'configuration file does not exist' unless File.exist?(ARGV[0])
 
+# SQLUI Sinatra server.
 class Server < Sinatra::Base
   set :logging, true
   set :bind,    '0.0.0.0'
   set :port,    Environment.server_port
   set :env,     Environment.server_env
 
+  # A MySQL client. This needs to go away.
   class Client
     def initialize(params)
       @params = params
@@ -35,30 +39,30 @@ class Server < Sinatra::Base
     end
   end
 
-  config = YAML.load(ERB.new(File.read(ARGV[0])).result)
+  config = YAML.safe_load(ERB.new(File.read(ARGV[0])).result)
   saved_path_root = config['saved_path']
-  client_map = config['databases'].values.map do |database_config|
+  client_map = config['databases'].values.to_h do |database_config|
     client_params = {
-      host:            database_config['db_host'],
-      port:            database_config['db_port'] || 3306,
-      username:        database_config['db_username'],
-      password:        database_config['db_password'],
-      database:        database_config['db_database'],
-      read_timeout:    10, # seconds
-      write_timeout:   0,  # seconds
+      host: database_config['db_host'],
+      port: database_config['db_port'] || 3306,
+      username: database_config['db_username'],
+      password: database_config['db_password'],
+      database: database_config['db_database'],
+      read_timeout: 10, # seconds
+      write_timeout: 0, # seconds
       connect_timeout: 5   # seconds
     }
     client = Client.new(client_params)
     [
-      database_config['url_path'], 
+      database_config['url_path'],
       ::SQLUI.new(
-        client:       client,
+        client: client,
         table_schema: database_config['db_database'],
-        name:         database_config['name'],
-        saved_path:   File.join(saved_path_root, database_config['saved_path'])
+        name: database_config['name'],
+        saved_path: File.join(saved_path_root, database_config['saved_path'])
       )
     ]
-  end.to_h
+  end
 
   get '/-/health' do
     status 200
@@ -66,7 +70,7 @@ class Server < Sinatra::Base
   end
 
   get '/db/?' do
-    erb :databases, :locals => {:databases => config['databases']}
+    erb :databases, locals: { databases: config['databases'] }
   end
 
   get '/db/:database' do
@@ -76,7 +80,7 @@ class Server < Sinatra::Base
   get '/db/:database/:route' do
     response = client_map[params[:database]].get(params)
     status response[:status]
-    headers "Content-Type": response[:content_type]
+    headers 'Content-Type': response[:content_type]
     body response[:body]
   end
 
@@ -84,7 +88,7 @@ class Server < Sinatra::Base
     post_body = JSON.parse(request.body.read)
     response = client_map[params[:database]].post(params.merge(post_body))
     status response[:status]
-    headers "Content-Type": response[:content_type]
+    headers 'Content-Type': response[:content_type]
     body response[:body]
   end
 

data/app/sqlui.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'uri'
 require 'set'
 
+# Main SQLUI class responsible for producing web content. This class needs to die.
 class SQLUI
   MAX_ROWS = 1_000
 
-  def initialize(client:, table_schema: nil, name:, saved_path:, max_rows: MAX_ROWS)
+  def initialize(client:, name:, saved_path:, table_schema: nil, max_rows: MAX_ROWS)
     @client = client
     @table_schema = table_schema
     @name = name
@@ -65,35 +68,33 @@ class SQLUI
   end
 
   def query_file(params)
-    if params['file']
-      sql = File.read("#{@saved_path}/#{params['file']}")
-      execute_query(sql).tap { |r| r[:file] = params[:file] }
-    else
-      raise 'missing file param'
-    end
+    raise 'missing file param' unless params['file']
+
+    sql = File.read("#{@saved_path}/#{params['file']}")
+    execute_query(sql).tap { |r| r[:file] = params[:file] }
   end
 
   def metadata
-    @metadata ||= load_metadata
+    load_metadata
   end
 
   def load_metadata
     result = {
-      server:  @name,
+      server: @name,
       schemas: {},
-      saved:   Dir.glob("#{@saved_path}/*.sql").sort.map do |path|
+      saved: Dir.glob("#{@saved_path}/*.sql").map do |path|
         {
-          filename:    File.basename(path),
+          filename: File.basename(path),
           description: File.readlines(path).take_while { |l| l.start_with?('--') }.map { |l| l.sub(/^-- */, '') }.join
         }
       end
     }
 
-    if @table_schema
-      where_clause = "where table_schema = '#{@table_schema}'"
-    else
-      where_clause = "where table_schema not in('mysql', 'sys', 'information_schema', 'performance_schema')"
-    end
+    where_clause = if @table_schema
+                     "where table_schema = '#{@table_schema}'"
+                   else
+                     "where table_schema not in('mysql', 'sys', 'information_schema', 'performance_schema')"
+                   end
     column_result = @client.query(
       <<~SQL
         select
@@ -129,9 +130,7 @@ class SQLUI
       end
       columns = result[:schemas][table_schema][:tables][table_name][:columns]
       column_name = row[:column_name]
-      unless columns[column_name]
-        columns[column_name] = {}
-      end
+      columns[column_name] = {} unless columns[column_name]
       column = columns[column_name]
       column[:name] = column_name
       column[:data_type] = row[:data_type]
@@ -142,11 +141,11 @@ class SQLUI
       column[:extra] = row[:extra]
     end
 
-    if @table_schema
-      where_clause = "where table_schema = '#{@table_schema}'"
-    else
-      where_clause = "where table_schema not in('mysql', 'sys', 'information_schema', 'performance_schema')"
-    end
+    where_clause = if @table_schema
+                     "where table_schema = '#{@table_schema}'"
+                   else
+                     "where table_schema not in('mysql', 'sys', 'information_schema', 'performance_schema')"
+                   end
     stats_result = @client.query(
       <<~SQL
         select
@@ -168,9 +167,7 @@ class SQLUI
       table_name = row[:table_name]
       indexes = tables[table_name][:indexes]
       index_name = row[:index_name]
-      unless indexes[index_name]
-        indexes[index_name] = {}
-      end
+      indexes[index_name] = {} unless indexes[index_name]
       index = indexes[index_name]
       column_name = row[:column_name]
       index[column_name] = {}
@@ -186,13 +183,13 @@ class SQLUI
 
   def execute_query(sql)
     result = @client.query(sql)
-    rows = result.map { |row| row.values }
+    rows = result.map(&:values)
     columns = result.first&.keys || []
     column_types = columns.map { |_| 'string' }
     unless rows.empty?
       maybe_non_null_column_value_exemplars = columns.each_with_index.map do |_, index|
-        row = rows.find do |row|
-          !row[index].nil?
+        row = rows.find do |current|
+          !current[index].nil?
         end
         row.nil? ? nil : row[index]
       end
@@ -210,22 +207,24 @@ class SQLUI
       end
     end
     {
-      query:        sql,
-      columns:      columns,
+      query: sql,
+      columns: columns,
       column_types: column_types,
-      total_rows:   rows.size,
-      rows:         rows.take(@max_rows)
+      total_rows: rows.size,
+      rows: rows.take(@max_rows)
     }
   end
 
   def find_query_at_cursor(sql, cursor)
     parts_with_ranges = []
     sql.scan(/[^;]*;[ \n]*/) { |part| parts_with_ranges << [part, 0, part.size] }
-    parts_with_ranges.inject(0) do |pos, part_with_range|
-      part_with_range[1] += pos
-      part_with_range[2] += pos
+    parts_with_ranges.inject(0) do |pos, current|
+      current[1] += pos
+      current[2] += pos
     end
-    part_with_range = parts_with_ranges.find { |part_with_range| cursor >= part_with_range[1] && cursor < part_with_range[2] } || parts_with_ranges[-1]
+    part_with_range = parts_with_ranges.find do |current|
+      cursor >= current[1] && cursor < current[2]
+    end || parts_with_ranges[-1]
     part_with_range[0]
   end
 end

data/app/views/databases.erb

@@ -5,11 +5,13 @@
     <style>
       body {
         font-family: Helvetica;
+        margin: 0px;
       }
 
       h1 {
         font-size: 30px;
-        margin-bottom: 30px;
+        margin: 10px;
+
       }
 
       .database a {
@@ -20,8 +22,6 @@
 
       .database h2 {
         margin: 0px;
-        margin-top: 10px;
-        margin-bottom: 0px;
         font-size: 20px;
         font-weight: bold;
       }
@@ -29,11 +29,12 @@
       .database p {
         margin: 0px;
         margin-top: 10px;
-        padding-bottom: 20px;
         font-size: 16px;
       }
 
       .database {
+        margin: 0px;
+        padding: 10px;
         cursor: pointer;
         border-bottom: 1px solid #eeeeee;
       }
@@ -52,11 +53,11 @@
     <h1>Databases</h1>
     <% databases.values.each do |database| %>
       <div class="database" onclick="window.location='<%= "/db/#{database['url_path']}/app" %>'">
-      <h2><%= database['name'] %></h2>
-      <a href="/db/<%= database['url_path'] %>/app">query</a>
-      <a href="/db/<%= database['url_path'] %>/app?tab=saved">saved</a>
-      <a href="/db/<%= database['url_path'] %>/app?tab=structure">structure</a>
-      <p>
+      <h2 class='name'><%= database['name'] %></h2>
+      <a class='query-link' href="/db/<%= database['url_path'] %>/app">query</a>
+      <a class='saved-link' href="/db/<%= database['url_path'] %>/app?tab=saved">saved</a>
+      <a class='structure-link' href="/db/<%= database['url_path'] %>/app?tab=structure">structure</a>
+      <p class='description'>
         <%= database['description'] %>
       </p>
     </div>

data/bin/sqlui

@@ -1,3 +1,4 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require_relative '../app/server'