dbbrowser 0.0.1 → 0.1.0

data/Manifest.txt

@@ -3,4 +3,16 @@ Manifest.txt
 README.md
 Rakefile
 lib/dbbrowser.rb
+lib/dbbrowser/connection.rb
+lib/dbbrowser/public/style.css
+lib/dbbrowser/server.rb
 lib/dbbrowser/version.rb
+lib/dbbrowser/views/db.erb
+lib/dbbrowser/views/debug.erb
+lib/dbbrowser/views/index.erb
+lib/dbbrowser/views/layout.erb
+lib/dbbrowser/views/shared/_debug.erb
+lib/dbbrowser/views/shared/_table_def.erb
+lib/dbbrowser/views/shared/_tables.erb
+lib/dbbrowser/views/shared/_version.erb
+lib/dbbrowser/views/table.erb

data/README.md

@@ -13,7 +13,25 @@ TBD
 
 ## Alternatives
 
-TBD
+### Browser
+
+[db_explorer](https://github.com/robinbortlik/db_explorer) by Robin Bortlík; Rails web app
+
+[dbadmin gem](https://rubygems.org/gems/dbadmin) [(Source)](https://github.com/pjb3/dbadmin) by Paul Barry; last update October 2012
+
+[rails_db_browser gem](https://rubygems.org/gems/rails_db_browser) [(Source)](https://github.com/funny-falcon/rails_db_browser) by Sokolov Yura; last update March 2011
+
+[rails_db_admin gem](https://rubygems.org/gems/rails_db_admin) [(Source)](https://github.com/portablemind/compass_agile_enterprise) by Rick Koloski, Russell Holmes; last update June 2013
+
+[databrowser gem](https://rubygems.org/gems/databrowser) by Carlos Junior; last update August 2008
+
+
+
+### Admin / ActiveScaffold
+
+- ActiveAdmin
+- RailsAdmin
+
 
 ## License
 

data/lib/dbbrowser.rb

@@ -1,22 +1,23 @@
 
+# 3rd party gems/libs
 
-require 'dbbrowser/version'  # let it always go first
+require 'textutils'
 
+require 'active_record'
 
-module DbBrowser
 
-  def self.banner
-    "dbbrowser #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
-  end
+# our own code
+
+require 'dbbrowser/version'  # let it always go first
+require 'dbbrowser/connection'
+
+module DbBrowser
 
-=begin
   def self.root
     "#{File.expand_path( File.dirname(File.dirname(__FILE__)) )}"
   end
-=end
 
 end  # module DbBrowser
 
 
-puts DbBrowser.banner    # say hello
-
+require 'dbbrowser/server'

data/lib/dbbrowser/connection.rb

@@ -0,0 +1,246 @@
+module DbBrowser
+
+class ConnectionMan  # connection manager
+  
+  # get connection names
+  #  def connection_names
+  #    ActiveRecord::Base.configurations.keys
+  #  end
+
+  def connection( key='std' )
+    if key == 'std'
+      # -- use/try 'standard/default' connection
+      con = ActiveRecord::Base.connection
+    else
+      con = AbstractModel.connection_for( key )
+    end
+    # wrap ActiveRecord connection in our own connection class
+    Connection.new( con, key )
+  end
+
+
+  class AbstractModel < ActiveRecord::Base
+    self.abstract_class = true   # no table; class just used for getting db connection
+
+    CONNECTS = {}  # cache connections
+    def self.connection_for( key )
+      CONNECTS[ key ] ||= begin
+        establish_connection( key )
+        connection
+      end
+    end
+  end # class AbstractModel
+
+
+  class Connection
+
+    def initialize( connection, key )
+      @connection = connection
+      @key        = key
+    end
+
+    attr_reader  :connection
+    attr_reader  :key
+
+    delegate :select_value, :select_all,
+             :to => :connection
+
+  #    delegate :quote_table_name, :quote_column_name, :quote,
+  #             :update, :insert, :delete,
+  #             :add_limit_offset!,
+  #             :to => :connection
+
+    def tables
+      @tables ||= fetch_table_defs
+    end
+
+    def table( name )
+      tables.find { |t| t.name.downcase == name.downcase }
+    end
+
+    # getting list of column definitions
+    # and order them to be more human readable
+    def table_columns( name )
+      cols = fetch_table_column_defs( name )
+      ### fix/to be done
+      # cols.sort_by{|col|
+      #    [
+      #      fields_to_head.index(col.name) || 1e6,
+      #      -(fields_to_tail.index(col.name) || 1e6),
+      #      col.name
+      #    ]
+      #  }
+      cols
+    end
+
+    def fetch_table_defs
+      @connection.tables.sort.map do |name|
+        Table.new( self, name )
+      end
+    end
+
+    def fetch_table_column_defs( name )
+      ### fix/todo: add reference to table_def
+      @connection.columns( name ).map do |col|
+        Column.new( col.name, col.sql_type, col.default, col.null )
+      end
+    end
+
+
+    def fetch_table_select_all( name, opts={} )
+      per_page = (opts[:perpage] || 33).to_i   # 33 records per page (for now default)
+
+      sql = "select * from #{name} limit #{per_page}"
+
+      # page = (opts[:page] || 1 ).try(:to_i)
+      # fields = opts[:fields] || nil
+     
+      # rez = { :fields => fields }
+      # if sql =~ /\s*select/i && per_page > 0
+      #  rez[:count] = select_value("select count(*) from (#{sql}) as t").to_i
+      #  rez[:pages] = (rez[:count].to_f / per_page).ceil
+      #  sql = "select * from (#{sql}) as t"
+      #  add_limit_offset!( sql,
+      #                        :limit => per_page,
+      #                        :offset => per_page * (page - 1))
+      # end
+
+      result = {}
+      result[ :rows ] = select_all( sql )
+
+      #    unless rez[:rows].blank?
+      #      rez[:fields] ||= []
+      #      rez[:fields].concat( self.sort_fields(rez[:rows].first.keys) - rez[:fields] )
+      #    end
+
+      Result.new( result )
+    rescue StandardError => ex
+      Result.new( error: ex )
+    end  # fetch_table
+
+
+=begin
+      def column_names(table)
+        columns(table).map{|c| c.name}
+      end
+
+      # fields to see first
+      def fields_to_head
+        @fields_to_head ||= %w{id name login value}
+      end
+
+      # fields to see last
+      def fields_to_tail
+        @fields_to_tail ||= %w{created_at created_on updated_at updated_on}
+      end
+
+      attr_writer :fields_to_head, :fields_to_tail
+
+      # sort field names in a rezult
+      def sort_fields(fields)
+        fields = (fields_to_head & fields) | (fields - fields_to_head)
+        fields = (fields - fields_to_tail) | (fields_to_tail & fields)
+        fields
+      end
+
+      # performs query with appropriate method
+      def query(sql, opts={})
+        per_page = (opts[:perpage] || nil).to_i
+        page = (opts[:page] || 1 ).try(:to_i)
+        fields = opts[:fields] || nil
+        case sql
+        when /\s*select/i , /\s*(update|insert|delete).+returning/im
+          rez = {:fields => fields}
+          if sql =~ /\s*select/i && per_page > 0
+            rez[:count] = select_value("select count(*) from (#{sql}) as t").to_i
+            rez[:pages] = (rez[:count].to_f / per_page).ceil
+            sql = "select * from (#{sql}) as t"
+            add_limit_offset!( sql,
+                              :limit => per_page,
+                              :offset => per_page * (page - 1))
+          end
+
+          rez[:rows] = select_all( sql )
+
+          unless rez[:rows].blank?
+            rez[:fields] ||= []
+            rez[:fields].concat( self.sort_fields(rez[:rows].first.keys) - rez[:fields] )
+          end
+
+          Result.new(rez)
+        when /\s*update/i
+          Result.new :value => update( sql )
+        when /\s*insert/i
+          Result.new :value => insert( sql )
+        when /\s*delete/i
+          Result.new :value => delete( sql )
+        end
+      rescue StandardError => e
+        Result.new :error => e
+      end
+
+=end
+      
+  end # class Connection
+
+
+  class Table
+
+    def initialize(connection, name)
+      @connection = connection
+      @name       = name
+    end
+
+    attr_reader :connection
+    attr_reader :name
+
+    def count
+      @connection.select_value( "select count(*) from #{name}").to_i
+    end
+
+    def columns
+      # load columns on demand for now (cache on first lookup)
+      @columns ||= @connection.table_columns( @name )
+    end
+
+    def query( opts={})
+      @connection.fetch_table_select_all( @name, opts )
+    end
+
+  end # class Table
+
+
+  class Column
+    def initialize(name, type, default, null)
+      @name    = name
+      @type    = type   # note: is sql_type
+      @default = default
+      @null    = null   # note: true|false depending if NOT NULL or not
+    end
+
+    attr_reader :name, :type, :default, :null
+  end # class Column
+
+
+  class Result
+    def initialize( opts={} )
+      if opts[:error]
+        @error = opts[:error]
+      else
+        @rows = opts[:rows]
+        # @count = opts[:count] || @rows.size
+        # @pages = opts[:pages] || 1
+        # @fields = opts[:fields]
+      end
+    end
+
+    attr_reader :rows, :error   ### to be done :count, :pages, :fields, 
+
+    def error?()  @error.present?;       end
+    def rows?()   @rows != nil;          end
+  end # class Result
+
+
+end # class  ConnectionMan
+
+end # module DbBrowser

data/lib/dbbrowser/public/style.css

@@ -0,0 +1,53 @@
+ /* fix: use sass w/ variables */
+
+   body {
+    font-family: sans-serif;
+    background-color: #F4F4F4;
+    color: #333333;
+   }
+   
+   a, a:visited {
+    text-decoration: none;
+    color: maroon;
+   }
+  
+   a:hover {
+    text-decoration: underline;
+    color: #1E68A6;
+    background-color: yellow;
+   }
+
+  a.nav ,
+  a.visited.nav ,
+  a:hover.nav  {
+    text-decoration: none;
+    color: #333333;
+    background-color: #F4F4F4;
+  }
+
+
+   .count,
+   .key {
+     font-size: 12px;
+     color: grey;
+   }
+
+   /* fix: use .small instead */
+   .smaller {
+     font-size: 12px;
+     /* color: #666666; */ /* lighter gray than text gray */
+   }
+   
+
+
+/** version block **********/
+
+.version {
+  text-align: center;
+  margin-top: 10px;
+  color: grey; }
+  .version a, .version span {
+    font-size: 12px;
+    color: grey; }
+
+/***************************/

data/lib/dbbrowser/server.rb

@@ -0,0 +1,103 @@
+
+
+# 3rd party libs/gems
+
+require 'sinatra/base'
+
+
+module DbBrowser
+
+class Server < Sinatra::Base
+
+  def self.banner
+    "dbbrowser #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] on Sinatra/#{Sinatra::VERSION} (#{ENV['RACK_ENV']})"
+  end
+
+  PUBLIC_FOLDER = "#{DbBrowser.root}/lib/dbbrowser/public"
+  VIEWS_FOLDER = "#{DbBrowser.root}/lib/dbbrowser/views"
+
+  puts "[boot] dbbrowser - setting public folder to: #{PUBLIC_FOLDER}"
+  puts "[boot] dbbrowser - setting views folder to: #{VIEWS_FOLDER}"
+
+  set :public_folder, PUBLIC_FOLDER # set up the static dir (with images/js/css inside)
+  set :views, VIEWS_FOLDER # set up the views dir
+
+  set :static, true # set up static file routing
+
+
+  set :man, ConnectionMan.new
+
+  #################
+  # Helpers
+  
+  include TextUtils::HypertextHelper  # e.g. lets us use link_to, sanitize, etc.
+
+  def path_prefix
+    request.script_name   # request.env['SCRIPT_NAME']
+  end
+
+  def db_path( key )
+    "#{path_prefix}/db/#{key}"
+  end
+
+  def table_path( table )
+    "#{path_prefix}/db/#{table.connection.key}/#{table.name.downcase}"
+  end
+
+  def root_path
+    "#{path_prefix}/"
+  end
+
+  def h( text )
+    Rack::Utils.escape_html(text)
+  end
+
+
+  def render_table_def( table, opts={} )
+    erb( 'shared/_table_def'.to_sym,
+         layout: false,
+         locals: { table: table } )
+  end
+
+  def render_tables( tables, opts={} )
+    erb( 'shared/_tables'.to_sym,
+         layout: false,
+         locals: { tables: tables } )
+  end
+
+  def render_tables_for( key, opts={} )
+    con = settings.man.connection( key )
+    erb( 'shared/_tables'.to_sym,
+         layout: false,
+         locals: { tables: con.tables } )
+  end
+
+
+  ##############################################
+  # Controllers / Routing / Request Handlers
+
+  get '/' do
+    erb :index
+  end
+
+  get '/db/:key/:table_name' do |key,table_name|
+    con = settings.man.connection( key )
+    erb :table, locals: { table: con.table( table_name ) }
+  end
+
+  get '/db/:key' do |key|
+    con = settings.man.connection( key )
+    erb :db, locals: { key: key, tables: con.tables }
+  end
+
+  get '/d*' do
+    erb :debug
+  end
+
+
+end # class Server
+end # module DbBrowser
+
+
+# say hello
+puts DbBrowser::Server.banner

data/lib/dbbrowser/version.rb

@@ -1,4 +1,4 @@
 
 module DbBrowser
-   VERSION = '0.0.1'
+   VERSION = '0.1.0'
 end

data/lib/dbbrowser/views/db.erb

@@ -0,0 +1,16 @@
+
+<h2>## <%= key %> ##</h2>
+
+<pre>
+<%= ActiveRecord::Base.configurations[key].inspect %>
+</pre>
+
+
+<%= render_tables( tables ) %>
+
+
+<% tables.each do |table| %>
+<h4>### <%= table.name %> ###</h4>
+
+<%= render_table_def( table ) %>
+<% end %>

data/lib/dbbrowser/views/debug.erb

@@ -0,0 +1,7 @@
+<h3>Named Route Helpers</h3>
+
+<pre>
+  root_path:    <%= root_path %>
+</pre>
+
+<%= erb :'shared/_debug' %>

data/lib/dbbrowser/views/index.erb

@@ -0,0 +1,11 @@
+
+<% ActiveRecord::Base.configurations.keys.each do |key| %>
+
+<h2>## <%= key %> ##</h2>
+<pre>
+<%= ActiveRecord::Base.configurations[key].inspect %>
+</pre>
+
+<%= render_tables_for( key ) %> 
+
+<% end %>

data/lib/dbbrowser/views/layout.erb

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <title>DB Browser</title>
+  <link href="<%= url('/style.css') %>" rel='stylesheet'>
+</head>
+<body>
+
+<p>
+  <%= link_to 'DB Browser', root_path(), class: 'nav' %> |
+  <% ActiveRecord::Base.configurations.keys.each do |key| %>
+     <%= link_to key, db_path( key ) %>
+  <% end %>
+</p>
+
+<%= yield %>
+
+<%= erb :'shared/_version' %>
+
+</body>
+</html>

data/lib/dbbrowser/views/shared/_debug.erb

@@ -0,0 +1,16 @@
+<h3>Request</h3>
+
+<pre>
+  request.scheme: <%= request.scheme %>
+  request.script_name: <%= request.script_name %>
+  request.path_info: <%= request.path_info %>
+  request.port: <%= request.port %>
+  request.request_method: <%= request.request_method %>
+  request.query_string: <%= request.query_string %>
+  request.host: <%= request.host %>
+  request.referrer: <%= request.referrer %>
+  request.user_agent: <%= request.user_agent %>
+  request.url: <%= request.url %>
+  request.path: <%= request.path %>
+  request.ip: <%= request.ip %>
+</pre>

data/lib/dbbrowser/views/shared/_table_def.erb

@@ -0,0 +1,14 @@
+
+<table>
+<% table.columns.each do |col| %>
+ <tr>
+  <td><%= col.name %></td>
+  <td><%= col.type %></td>
+  <td><%= col.default %></td>
+  <td><% unless col.null %>
+        NOT NULL
+      <% end %>
+  </td>
+ </tr>
+<% end %>
+</table>

data/lib/dbbrowser/views/shared/_tables.erb

@@ -0,0 +1,13 @@
+
+<h3>Tables
+ <span class='count'>(<%= tables.size %>)</span>
+</h3>
+
+<table>
+<% tables.each do |table| %>
+ <tr>
+  <td><%= link_to table.name, table_path( table ) %></td>
+  <td style='text-align: right;'><%= table.count %> recs</td>
+ </tr>
+<% end %>
+</table>

data/lib/dbbrowser/views/shared/_version.erb

@@ -0,0 +1,6 @@
+<div class='version'>
+  <a href="https://github.com/rubylibs/dbbrowser">dbbrowser/<%= DbBrowser::VERSION %></a>,
+  -
+  <span>Ruby/<%= "#{RUBY_VERSION} (#{RUBY_RELEASE_DATE}/#{RUBY_PLATFORM})" %> on</span>
+  <span>Sinatra/<%= Sinatra::VERSION %> (<%= ENV['RACK_ENV'] %>)</span>
+</div>

data/lib/dbbrowser/views/table.erb

@@ -0,0 +1,43 @@
+
+<h2><%= table.name %>
+    <span class='count'>(<%= table.count %>)</span>
+</h2>
+
+
+<%= render_table_def( table ) %>
+
+
+<% result = table.query() %>
+<% if result.error? %>
+    <p>
+        ERROR: <%= result.error %>
+    </p>
+<% else %>
+  <table>
+  <% result.rows.each do |row| %>
+    <tr>
+      <% row.each do |key,value| %>
+
+           <% if ['id','created_at', 'updated_at'].include?( key ) %>
+             <td class='key'>
+           <% else %>
+             <td>
+           <% end %>
+
+            <span title='<%= key %> : <%= value.class.name %>'>
+           <% if value.nil? %>
+             NULL <!-- fix/todo: use special char for null?? -->
+           <% else %>
+               <% if value.kind_of?( String ) %>
+                   <%= h( value[0..80] ) %>   <!-- cut off after 80 chars; escape html use h-helper -->
+               <% else %>
+                   <%= value %>
+               <% end %>
+           <% end %>
+             </span>
+         </td>
+      <% end %>
+    </tr>
+  <% end %>
+  </table>
+<% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dbbrowser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-12 00:00:00.000000000 Z
+date: 2013-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
-  requirement: &72495300 !ruby/object:Gem::Requirement
+  requirement: &69669750 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *72495300
+  version_requirements: *69669750
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &72495060 !ruby/object:Gem::Requirement
+  requirement: &69669480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *72495060
+  version_requirements: *69669480
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &72494820 !ruby/object:Gem::Requirement
+  requirement: &69669210 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *72494820
+  version_requirements: *69669210
 description: dbbrowser - database browser (connections, schema, tables, records, etc.)
   as mountable web app
 email: webslideshow@googlegroups.com
@@ -57,7 +57,19 @@ files:
 - README.md
 - Rakefile
 - lib/dbbrowser.rb
+- lib/dbbrowser/connection.rb
+- lib/dbbrowser/public/style.css
+- lib/dbbrowser/server.rb
 - lib/dbbrowser/version.rb
+- lib/dbbrowser/views/db.erb
+- lib/dbbrowser/views/debug.erb
+- lib/dbbrowser/views/index.erb
+- lib/dbbrowser/views/layout.erb
+- lib/dbbrowser/views/shared/_debug.erb
+- lib/dbbrowser/views/shared/_table_def.erb
+- lib/dbbrowser/views/shared/_tables.erb
+- lib/dbbrowser/views/shared/_version.erb
+- lib/dbbrowser/views/table.erb
 homepage: https://github.com/rubylibs/dbbrowser
 licenses:
 - Public Domain