rails8_db 0.0.1

data/lib/rails_db/helpers.rb

@@ -0,0 +1,73 @@
+module RailsDb
+  module Helpers
+    # TODO check styles
+    STYLES = {
+      default: {
+        table: 'table',
+        tr: 'table_tr',
+        th: 'table_th',
+        td: 'table_td',
+        thead: 'table_thead',
+        tfoot: 'table_tfoot'
+      },
+      bootstrap: {
+        table: 'table table-bordered table-striped table-hover',
+        tr: 'table_tr',
+        th: 'table_th',
+        td: 'table_td',
+        thead: 'table_thead',
+        tfoot: 'table_tfoot'
+      },
+      foundation: {
+        table: 'table',
+        tr: 'table_tr',
+        th: 'table_th',
+        td: 'table_td',
+        thead: 'table_thead',
+        tfoot: 'table_tfoot'
+      }
+    }
+
+    def rails_db_data_table(table_name, options = {})
+      options.reverse_merge!(
+        style: :default,
+        header: true,
+        footer: false,
+        columns: [],
+        limit: nil,
+        order_by: nil,
+        order: :asc
+      )
+      table = RailsDb::Table.new(table_name)
+        .limit(options[:limit])
+        .order_by(options[:order_by])
+        .select(options[:columns])
+        .order(options[:order])
+
+      render '/rails_db/shared/data_table', table: table,
+                                            header: options[:header],
+                                            footer: options[:footer],
+                                            style:  options[:style]
+    end
+
+    def rails_db_data_table_sql(sql, options = {})
+      options.reverse_merge!(
+        style: :default,
+        header: true,
+        footer: false,
+      )
+      sql        = "#{sql}".strip
+      sql_query  = RailsDb::SqlQuery.new(sql, false).execute
+
+      render '/rails_db/shared/sql_result', sql_query: sql_query,
+                                            header: options[:header],
+                                            footer: options[:footer],
+                                            style:  options[:style]
+    end
+
+    def rails_db_table_style(tag, style)
+      style = STYLES[style] || STYLES[:default]
+      style[tag.to_sym]
+    end
+  end
+end

data/lib/rails_db/history.rb

@@ -0,0 +1,29 @@
+module RailsDb
+  class History
+
+    class << self
+
+      def instance
+        $history ||= []
+      end
+
+      def add(sql)
+        instance.push(sql) unless last == sql
+      end
+
+      def last
+        history[0]
+      end
+
+      def remove(sql)
+        instance.delete(sql)
+      end
+
+      def history
+        instance.reverse
+      end
+
+    end
+
+  end
+end

data/lib/rails_db/mysql_result.rb

@@ -0,0 +1,18 @@
+module RailsDb
+  class MysqlResult
+
+    attr_reader :columns, :rows
+
+    delegate :each,  :to => :rows
+
+    def initialize(result)
+      @columns = []
+      @rows    = []
+      if result
+        @columns = result.fields
+        @rows    = result.entries
+      end
+    end
+
+  end
+end

data/lib/rails_db/rails_db_error.rb

@@ -0,0 +1,5 @@
+module RailsDb
+  class RailsDbError < StandardError
+
+  end
+end

data/lib/rails_db/result.rb

@@ -0,0 +1,19 @@
+module RailsDb
+  class Result
+
+    attr_reader :error
+
+    def initialize(error)
+      @error = error
+    end
+
+    def self.ok
+      Result.new(nil)
+    end
+
+    def ok?
+      error.nil?
+    end
+
+  end
+end

data/lib/rails_db/sql_explain.rb

@@ -0,0 +1,9 @@
+module RailsDb
+  class SqlExplain < SqlQueryData
+
+    def sql
+      "EXPLAIN #{super}"
+    end
+
+  end
+end

data/lib/rails_db/sql_import.rb

@@ -0,0 +1,26 @@
+module RailsDb
+  class SqlImport
+    include Connection
+
+    attr_reader :time, :result
+
+    def initialize(file)
+      @file = file
+    end
+
+    def valid?
+      if @file.nil?
+        raise RailsDbError.new('Please select valid SQL file and continue')
+      end
+    end
+
+    def import
+      valid?
+      @time   = Database.adapter.execute(@file.read)
+      @result = Result.ok
+    rescue RailsDbError, ActiveRecord::StatementInvalid => e
+      @result = Result.new(e)
+    end
+
+  end
+end

data/lib/rails_db/sql_query.rb

@@ -0,0 +1,43 @@
+module RailsDb
+  class SqlQuery
+    include Connection
+
+    attr_reader :query, :data, :explain, :sql_explain
+
+    def initialize(query, sql_explain = true)
+      @query       = query
+      @sql_explain = sql_explain
+    end
+
+    def valid?
+      query.present?
+    end
+
+    def load_explain
+      @explain ||= SqlExplain.new(self).load_data
+    end
+
+    def load_data
+      @data    ||= SqlQueryData.new(self).load_data
+    end
+
+    def execute
+      if valid?
+        load_data
+        load_explain if sql_explain
+        History.add(query)
+      end
+      self
+    end
+
+    def to_csv
+      CSV.generate do |csv|
+        csv << data.columns
+        data.rows.each do |row|
+          csv << row
+        end
+      end
+    end
+
+  end
+end

data/lib/rails_db/sql_query_data.rb

@@ -0,0 +1,36 @@
+module RailsDb
+  class SqlQueryData
+
+    attr_reader :sql_query, :time, :columns, :rows, :error
+
+    def initialize(sql_query)
+      @rows    = []
+      @columns = []
+      @sql_query = sql_query
+    end
+
+    def load_data
+      result, @time = Database.adapter.exec_query(sql)
+      @columns      = result.columns
+      @rows         = result.rows
+      self
+    rescue ActiveRecord::StatementInvalid => e
+      @columns, @rows = [], []
+      @error = e
+      self
+    end
+
+    def count
+      rows.count
+    end
+
+    def is_error?
+      error.present?
+    end
+
+    def sql
+      sql_query.query
+    end
+
+  end
+end

data/lib/rails_db/table.rb

@@ -0,0 +1,92 @@
+require 'active_model'
+
+module RailsDb
+
+  class Table
+    include Connection
+
+    attr_reader :name, :data
+
+    delegate :count,     to: :data
+    delegate :paginate,  to: :data
+    delegate :limit,     to: :data
+    delegate :order,     to: :data
+    delegate :asc,       to: :data
+    delegate :desc,      to: :data
+
+    def initialize(table_name)
+      throw 'Access Denied' unless RailsDb::Database.accessible_tables.include?(table_name)
+      @name = table_name
+      @data = RailsDb::TableData.new(self)
+      self
+    end
+
+    def to_csv
+      CSV.generate do |csv|
+        csv << column_names
+        data.data.rows.each do |row|
+          csv << row
+        end
+      end
+    end
+
+    def indexes
+      RailsDb::Database.indexes(name)
+    end
+
+    def truncate
+      RailsDb::Database.truncate(name)
+    end
+
+    def primary_key
+      RailsDb::Database.primary_key(name)
+    end
+
+    def delete(id)
+      RailsDb::Database.delete(name, primary_key, id)
+    end
+
+    def create_model(table_name, &block)
+      begin
+        klass = Class.new(ActiveRecord::Base) do
+          def self.model_name
+            ActiveModel::Name.new(self, nil, table_name)
+          end
+          self.table_name = table_name
+          self.inheritance_column = nil
+        end
+        klass.count # verify that it works, if not load other, hack
+      rescue
+        klass = ActiveRecord::Base.descendants.detect { |c| c.table_name == table_name }
+      end
+
+      add_ransack_methods(klass) if ransack_version >= Gem::Version.new('4.0.0')
+      klass.class_eval(&block) if block_given?
+
+      klass
+    end
+
+    def as_model
+      @model ||= create_model(name)
+    end
+
+    def add_ransack_methods(klass)
+      klass.define_singleton_method(:ransackable_attributes) do |auth_object = nil|
+        column_names.map(&:to_sym) + column_names
+      end
+
+      klass.define_singleton_method(:ransortable_attributes) do |auth_object = nil|
+        column_names.map(&:to_sym) + column_names
+      end
+
+      klass.define_singleton_method(:ransackable_associations) do |auth_object = nil|
+        []
+      end
+    end
+
+    def ransack_version
+      Gem.loaded_specs['ransack'].version
+    end
+  end # module
+
+end

data/lib/rails_db/table_data.rb

@@ -0,0 +1,78 @@
+module RailsDb
+  class TableData
+    include Connection
+    include TablePagination
+
+    attr_reader :table, :time
+    attr_accessor :current_page, :offset, :per_page, :sort_column, :sort_order, :select_columns
+
+    delegate :each,  to: :data
+    delegate :count, to: :table
+
+    def initialize(table)
+      @table = table
+    end
+
+    def data
+      @data ||= begin
+        commands = []
+        if select_columns && select_columns.any?
+          commands.push("SELECT #{select_columns.join(', ')} FROM #{table.name}")
+        else
+          commands.push("SELECT * FROM #{table.name}")
+        end
+        if sort_column
+          commands.push("ORDER BY #{sort_column} #{sort_order}")
+        end
+        if per_page
+          commands.push("LIMIT #{per_page.to_i} OFFSET #{offset.to_i}")
+        end
+        results, @time = Database.select(commands.join(' '))
+        results
+      end
+    end
+
+    def limit(limit)
+      self.per_page = limit
+      self
+    end
+
+    def desc
+      self.sort_order = 'desc'
+      self
+    end
+
+    def asc
+      self.sort_order = 'asc'
+      self
+    end
+
+    def order_by(column)
+      self.sort_column = column
+      self
+    end
+
+    def order(sort_order)
+      self.send(sort_order) if [:asc, :desc].include?(sort_order.to_sym)
+      self
+    end
+
+    def select(*select_columns)
+      self.select_columns = Array.wrap(select_columns).flatten
+      self
+    end
+
+    def columns
+      if select_columns && select_columns.any?
+        select_columns
+      else
+        table.column_names
+      end
+    end
+
+    def count
+      Database.count(table.name)
+    end
+
+  end
+end

data/lib/rails_db/table_pagination.rb

@@ -0,0 +1,31 @@
+module RailsDb
+  module TablePagination
+    DEFAULT_PAGINATION_PER_PAGE = 10
+
+    def next_page
+      current_page < total_pages ? (current_page + 1) : nil
+    end
+
+    def paginate(options = {})
+      self.per_page     = (options[:per_page] || DEFAULT_PAGINATION_PER_PAGE).to_i
+      self.current_page = (options[:page] || 1).to_i
+      self.offset       = (current_page * per_page) - per_page
+      self.sort_column  = options[:sort_column]
+      self.sort_order   = options[:sort_order]
+      table
+    end
+
+    def previous_page
+      current_page > 1 ? (current_page - 1) : nil
+    end
+
+    def total_entries
+      @total_entries ||= count
+    end
+
+    def total_pages
+      total_entries.zero? ? 1 : (total_entries / per_page.to_f).ceil
+    end
+
+  end
+end

data/lib/rails_db/version.rb

@@ -0,0 +1,3 @@
+module RailsDb
+  VERSION = "0.0.1"
+end

data/lib/rails_db.rb

@@ -0,0 +1,70 @@
+require "rails"
+require 'terminal-table'
+require 'csv'
+require 'simple_form'
+require 'active_record'
+require 'ransack'
+require 'kaminari'
+require 'sprockets/rails'
+
+module RailsDb
+  # Custom require relative that work with older rubies also
+  # def self.require_relative(path)
+  #   full_path = File.expand_path(path, File.dirname(__FILE__))
+  #   Kernel.require(full_path)
+  # end
+
+  # gem in enabled
+  mattr_accessor :enabled
+  @@enabled = true
+
+  # Allow read only operations
+  mattr_accessor :sandbox
+  @@sandbox = false
+
+  # automatic engine routes mouting
+  mattr_accessor :automatic_routes_mount
+  @@automatic_routes_mount = true
+
+  # set tables which you want to hide ONLY
+  mattr_accessor :black_list_tables
+  @@black_list_tables = []
+
+  # set tables which you want to show ONLY
+  mattr_accessor :white_list_tables
+  @@white_list_tables = []
+
+  # Enable http basic authentication
+  mattr_accessor :http_basic_authentication_enabled
+  @@http_basic_authentication_enabled = false
+
+  # Enable http basic authentication
+  mattr_accessor :http_basic_authentication_user_name
+  @@http_basic_authentication_user_name = 'rails_db'
+
+  # Enable http basic authentication
+  mattr_accessor :http_basic_authentication_password
+  @@http_basic_authentication_password = 'password'
+
+  # If you want to enable access by specific conditions
+  mattr_accessor :verify_access_proc
+  @@verify_access_proc = proc { |controller| true }
+
+  def self.setup
+    yield(self)
+  end
+
+  def self.use_default_configuration!
+    self.enabled                            = true
+    self.automatic_routes_mount             = true
+    self.black_list_tables                  = self.white_list_tables = []
+    self.http_basic_authentication_enabled  = false
+    self.verify_access_proc                 = proc { |controller| true }
+  end
+
+end
+
+require_relative "libs"
+require_relative "rails_db/engine"
+require_relative "rails/routes"
+require_relative "ext/simple_form_ext"

data/lib/standalone.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'active_record'
+require 'rack'
+require 'rack/server'
+require 'erb'
+
+require_relative "ext/string_ext"
+
+module Standalone
+  HOST = '0.0.0.0'
+  PORT = 12345
+
+  def Standalone.run
+    database_yml = ::File.expand_path(File.join('.', 'config', 'database.yml'))
+    app_path     = ::File.expand_path(File.join('.'))
+
+    ENV['DATABASE_YML_PATH'] = database_yml
+
+    require ::File.expand_path('../../test/standalone/config/environment', __FILE__)
+
+    puts      "Using database.yml from: #{database_yml}".red
+    db_conf   = YAML.load(ERB.new(File.open(database_yml).read).result) || {}
+    env       = ENV['RAILS_ENV'] || ENV['ENV'] || 'development'
+    db_env    = db_conf[env]
+
+    if db_env['adapter'] == 'sqlite3'
+      db_env['database'] = "#{app_path}/#{db_env['database']}"
+    end
+
+    puts      "ENV: #{db_env.inspect}".yellow
+
+    ActiveRecord::Base.establish_connection(db_env)
+    RailsDb.use_default_configuration!
+
+    begin
+      require 'launchy'
+      Launchy.open("http://#{HOST}:#{PORT}/rails/db")
+    rescue Exception
+      puts 'Please run `gem install launchy` to have the browser window opened automatically at launch'
+      # silence
+      # in case it won't work
+    end
+
+    puts "Starting RailsDB on #{"http://#{HOST}:#{PORT}/rails/db"} ...".green
+
+    Rack::Handler::WEBrick.run Rails.application, { Host: HOST, Port: PORT }
+  end
+end
+
+Standalone.run

data/lib/tasks/rails_db_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_db do
+#   # Task goes here
+# end

data/lib/templates/erb/scaffold/_form.html.erb

@@ -0,0 +1,13 @@
+<%%= simple_form_for(@<%= singular_table_name %>) do |f| %>
+  <%%= f.error_notification %>
+
+  <div class="form-inputs">
+  <%- attributes.each do |attribute| -%>
+    <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %>
+  <%- end -%>
+  </div>
+
+  <div class="form-actions">
+    <%%= f.button :submit %>
+  </div>
+<%% end %>

data/rails_db.gemspec

@@ -0,0 +1,45 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "rails_db/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rails8_db"
+  s.version     = RailsDb::VERSION
+  s.authors     = ["Ilton Silveira"]
+  s.email       = ["iltonsilveira91@gmail.com"]
+  s.homepage    = "https://github.com/TonGarcia/rails8_db"
+  s.summary     = "Inspect your Rails DB (table content viewer, execute sql queries, export & import data"
+  s.description = "Quick way to inspect your Rails database, see content of tables, filter, export them to CSV, Excel, EXPLAIN SQL and run SQL queries."
+  s.license     = "MIT"
+
+  s.files = Dir["{app,config,lib,test}/**/*", "rails_db.gemspec", "Gemfile", "Gemfile.lock", "MIT-LICENSE", "Rakefile", "README.rdoc", "bin/rails_db", "bin/railsdb", "bin/runsql"] + Dir.glob("test/dummy/public/assets/**/*")
+  s.test_files = Dir["test/**/*"]
+
+  s.executables   = ["railsdb", "rails_db", 'runsql']
+
+  s.add_dependency 'rails', ">= 5.0.0"
+  s.add_dependency 'terminal-table'
+  s.add_dependency 'simple_form', '>= 5.0.1'
+  s.add_dependency 'activerecord'
+  s.add_dependency 'ransack', '>= 2.3.2'
+  s.add_dependency 'kaminari'
+  s.add_dependency 'csv'
+
+  s.add_development_dependency "launchy"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "mysql2"
+  s.add_development_dependency "pg"
+  s.add_development_dependency "caxlsx_rails"
+  s.add_development_dependency 'will_paginate', '>= 3.1.0'
+  s.add_development_dependency 'mime-types'
+  s.add_development_dependency 'paranoia'
+  s.add_development_dependency 'pry-rails'
+  s.add_development_dependency 'puma'
+
+  # Removed sprockets-rails
+  # s.add_development_dependency 'sprockets-rails'
+
+  # s.add_development_dependency 'populator'
+  # s.add_development_dependency 'faker'
+  # s.add_development_dependency 'pry'
+end