db_admin 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f8ca91c5487bf88b9be3339e6535a869a292f32b6dd99f762b40a53b7497524
-  data.tar.gz: d9a7108368da315d9af88b852167895d6548988e72291398a1e77067067fb7f9
+  metadata.gz: b9334ebb91f433dfa6036c5126cfd0dcb94eb2b85dfba0398206a27b4c8cb808
+  data.tar.gz: c5c8f15ebff96a75d13df95ac6c802ffc67209f54a2f787288a7c855ec5c1a31
 SHA512:
-  metadata.gz: 41a830abc163b9cec042f70b65a1e4af57ad3a690448d04c57b1dad9576286675f84701dbdc38d66baed0e452f75e4bfa01b9e8a6af6cf6c67be9d34908bef36
-  data.tar.gz: 7ce005a8a1def70323f57f456fc2282b71716851149b521e05822f78842df7a590da7561e21b3716bd3713eab9cd86e481b78789dc990bc02449f4003ddad678
+  metadata.gz: 4fa406fe61284e9e171aab51f69630ae2acbff65a2acc5ff0b6b140c2cbd59b3feea9da28e86cc4e9c87d8d39de671acff450690f47ba0992421f3af3adee206
+  data.tar.gz: 342f9253078c69c90913b393afd26b5422dc843485ea272d2791c6eda914e583c511bf609a6ecef111d5130313c9f79f486d102552ab83703dce4c4b1df48dbc

data/README.md

@@ -2,7 +2,9 @@
 A gem based on [Sinatra](https://github.com/sinatra/sinatra) and [Sequel](https://github.com/jeremyevans/sequel).
 You can use it to manage multiple databases at the same time.
 
-Rails user can also use it because it is just a gem. Here are some demo pictures.
+For Rails user, this gem will treat `./config/database.yml` as database configuration file.
+
+Here are some demo pictures.
 
 ![Demo home](./lib/public/demo_home.png)
 
@@ -11,14 +13,15 @@ Rails user can also use it because it is just a gem. Here are some demo pictures
 ![Demo hover](./lib/public/demo_hover.png)
 
 ## Installation
-**The best way** to use this gem is **`gem install db_admin`**.
-
+~~~ruby
+gem install db_admin
+~~~
 If you prefer to use it in `Gemfile`:
 ~~~ruby
 group :development do
   # A Web UI for database admin. Run `$ db_admin` and then
   # visit http://localhost:4567
-  gem 'db_admin', require: false # Don't require the code because you needn't it.
+  gem 'db_admin', require: false # You needn't require the code.
 end
 ~~~
 
@@ -31,6 +34,49 @@ $ db_admin # Run this command to start a Sinatra Web.
 ~~~
 Visit [http://localhost:4567](http://localhost:4567/)
 
+### Connect to database
+There are two ways for you to connect to a database.
+
+1) Visit [http://localhost:4567](http://localhost:4567/) . The homepage is asking you to connect to a database. Please look at the demo picture above.
+
+2) `touch ./config/database.yml` or `touch ./database.yml`
+
+You can use Rails's `database.yml` file directly.
+
+In yaml, 'Omit the key' or 'keep value blank' means use the default value.
+~~~yaml
+# 'database.yml' for Rails style example 1. We only connect to the 'development' database!
+development:
+  adapter: postgresql
+  encoding: unicode
+  host: localhost
+  database: somthing_development
+  username: username
+  password:
+  port: 5432
+~~~
+~~~yaml
+# 'database.yml' for Rails style example 2. Inherited style is also supported.
+default: &default
+  adapter: postgresql
+  # Below omitted ...
+
+development:
+  <<: *default
+  database: somthing_development
+  # Below omitted ...
+~~~
+~~~yaml
+# 'database.yml' for none-Rails style example.
+adapter: postgres
+encoding: unicode
+host: localhost
+database: your_database_name
+user: username
+password:
+port: 5432
+~~~
+
 ## Customizing
 If you want to change some code for your own purpose, please
 ~~~bash

data/bin/db_admin

@@ -2,4 +2,29 @@
 
 require 'db_admin'
 
+module DBAdmin
+  class Web
+    yml_hash = database_config_yml_hash
+
+    unless yml_hash.empty?
+      begin
+        db = Sequel.connect(yml_hash)
+
+        if db.test_connection
+          DB = db
+          DBs << DB
+          puts "==== Connect to the database defined in your config file './config/database.yml' or './database.yml' succeed."
+        end
+      rescue Sequel::AdapterNotFound => e
+        puts "==== Warning: An exception occurred when trying to connect to the database defined in your config file './config/database.yml' or './database.yml' \n" +
+             "====   #{e.message} \n" +
+             "====   You need to install the database driver gem first"
+      rescue Exception => e
+        puts "==== Warning: An exception occurred when trying to connect to the database defined in your config file './config/database.yml' or './database.yml' \n" +
+             "====   #{e.message}"
+      end
+    end
+  end
+end
+
 DBAdmin::Web.run!

data/lib/db_admin.rb

@@ -10,19 +10,54 @@ module DBAdmin
 
     DBs = []
 
-    # Direct connect. 'adapter' can be 'postgres', 'mysql2', 'sqlite', 'oracle', etc.
-    # DB = Sequel.connect({ adapter: 'postgres',
-    #                       host: 'hostname_or_ip',
-    #                       database: 'database_name',
-    #                       user: 'user',
-    #                       password: '' }); DBs << DB
+    # Load Rails './config/database.yml' or './database.yml'
+    def self.database_config_yml_hash
+      db_hash = load_database_yml
+
+      return {} if db_hash.empty?
+
+      db_hash = db_hash['development'] if db_hash['development'].is_a?(Hash)
+
+      return {} if ['adapter', 'host', 'database'].any? { |item| db_hash[item].to_s.empty? }
+
+      return db_hash
+        .slice('adapter', 'host', 'database', 'username', 'password', 'encoding', 'port')
+        .transform_keys { |key| key == 'username' ? :user : key.to_sym }
+        .transform_values { |value| convert_rails_adapter(value) }
+    end
+
+    def self.load_database_yml
+      require 'yaml'
+
+      begin
+        YAML.load_file('config/database.yml')
+      rescue Errno::ENOENT
+        begin
+          YAML.load_file('database.yml')
+        rescue Errno::ENOENT
+          {}
+        end
+      end
+    end
+
+    def self.convert_rails_adapter(adapter)
+      hash = { 'postgresql' => 'postgres', 'sqlite3' => 'sqlite', 'sqlserver' => 'tinytds' }
+
+      return hash[adapter] if hash.keys.include?(adapter)
+
+      return adapter
+    end
 
     set :bind, '0.0.0.0'
 
     enable :sessions
 
     get '/' do
-      erb :index, layout: :layout_index
+      if DBs.size > 0
+        erb :home
+      else
+        erb :index, layout: :layout_index
+      end
     end
 
     get '/home' do
@@ -55,7 +90,7 @@ module DBAdmin
           DBs << DB
         end
       rescue Sequel::AdapterNotFound => e
-        session[:error] = "#{e.message} \n You need to install the database driver gem first.\n Please uncomment the driver gem in 'Gemfile' and run `$ bundle install`."
+        session[:error] = "#{e.message} \n You need to install the database driver gem first."
       rescue Exception => e
         session[:error] = e.message
       end

data/lib/db_admin/run_web.rb

@@ -1,3 +1,14 @@
 require_relative '../db_admin'
 
+module DBAdmin
+  class Web
+    # Uncomment the line below to direct connect to a database.
+    # DB = Sequel.connect({ adapter: 'postgres', # 'adapter' can be 'postgres', 'mysql2', 'sqlite', 'oracle', etc.
+    #                       host: 'hostname_or_ip',
+    #                       database: 'your_database_name',
+    #                       user: 'user',
+    #                       password: '' }); DBs << DB
+  end
+end
+
 DBAdmin::Web.run!

data/lib/views/layout_index.erb

@@ -1,43 +1,43 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <meta charset='utf-8'>
-  <meta name='viewport' content='width=device-width, initial-scale=1'>
-  <title>Database</title>
-  <link href='/css/bootstrap.min.css' rel='stylesheet'>
+  <head>
+    <meta charset='utf-8'>
+    <meta name='viewport' content='width=device-width, initial-scale=1'>
+    <title>Database</title>
+    <link href='/css/bootstrap.min.css' rel='stylesheet'>
 
-  <script src='/js/jquery.min.js'></script>
-  <script src='/js/bootstrap.min.js'></script>
+    <script src='/js/jquery.min.js'></script>
+    <script src='/js/bootstrap.min.js'></script>
 
-  <style>
-    select, button {
-      margin-top: 5px;
-      margin-bottom: 5px;
-    }
+    <style>
+      select, button {
+        margin-top: 5px;
+        margin-bottom: 5px;
+      }
 
-    h1 a:link { color: #000000; }
-    h1 a:visited { color: #000000; }
-    h1 a:hover { color: #4666FF; }
-  </style>
-</head>
+      h1 a:link { color: #000000; }
+      h1 a:visited { color: #000000; }
+      h1 a:hover { color: #4666FF; }
+    </style>
+  </head>
 
-<body>
-<div class='container'>
-  <div>
-    <h1>
-      <a href='/'>Ruby Database Admin</a>
-    </h1>
-  </div>
+  <body>
+    <div class='container'>
+      <div>
+        <h1>
+          <a href='/'>Ruby Database Admin</a>
+        </h1>
+      </div>
 
-  <div class='row'>
-    <div class='col-sm-2'>
-      <%= erb :_recent_databases %>
-    </div>
+      <div class='row'>
+        <div class='col-sm-2'>
+          <%= erb :_recent_databases %>
+        </div>
 
-    <div class='col-sm-10 blog-main'>
-      <%= yield %>
+        <div class='col-sm-10 blog-main'>
+          <%= yield %>
+        </div>
+      </div>
     </div>
-  </div>
-</div>
-</body>
+  </body>
 </html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_admin
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Lane Zhang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-03 00:00:00.000000000 Z
+date: 2019-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra