rackdb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d345d254f1c2ad27b886c988a50d462a4c9270c
+  data.tar.gz: 18fbfef83c48dc7f0a7324222487a04a4050c1dd
+SHA512:
+  metadata.gz: 475f10e4c91265d9a42c9002160e71cb840a59593ad48fa42657b3c64fe3d1964778574bdef5a2ea3282533faebeec9612e17861c095be54c3a244f85d750d80
+  data.tar.gz: 1eaec56cd7652b9ae32f55c7d4648089ad05093ab8b84018e8d1fb180802a40847a717ace15b7a06aade5d424c3aa9305e92c8d525049433f05a4ef29eac3333

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 / 2016-04-14
+
+* Initial release, based upon [`racksh`](https://github.com/sickill/racksh) and the Ruby on Rails `dbconsole` [code](https://github.com/rails/rails/blob/master/railties/lib/rails/commands/dbconsole.rb) (as of Railties v4.2.6).

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Andrew Hodgkinson (Hipposoft)
+
+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,37 @@
+# `rackdb`
+
+## About
+
+**rackdb** is a database console for Ruby applications that run on Rack, which follow the Rails-like convention of a `config/database.yml` file describing the database connection parameters. This includes [Rails applications](http://rubyonrails.org) and [Hoodoo services](http://hoodoo.cloud/).
+
+It is based upon [`racksh`](https://github.com/sickill/racksh) and the Ruby on Rails `dbconsole` [code](https://github.com/rails/rails/blob/master/railties/lib/rails/commands/dbconsole.rb). For more information, see the Rails documentation for `dbconsole`.
+
+## Installation
+
+    gem install rackdb
+
+## Usage
+
+To open a default shell:
+
+    cd some_application_or_service
+    bundle exec rackdb
+
+For help:
+
+    bundle exec rackdb --help
+
+Quick access to specific environment database consoles:
+
+    bundle exec rackdb <environment_name>
+
+## Bugs & feature requests
+
+Please use the [GitHub issue tracker](https://github.com/pond/rackdb/issues).
+
+## Authors
+
+ * Created by Andrew Hodgkinson - [http://pond.org.uk/](http://pond.org.uk/)
+ * Derives from:
+   * https://github.com/sickill/racksh
+   * https://github.com/rails/rails/blob/master/railties/lib/rails/commands/dbconsole.rb

data/bin/rackdb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+  File.join(
+    File.dirname( __FILE__),
+    '..', 'lib', 'rackdb', 'init.rb'
+  )
+)
+
+# Prevent STDOUT and STDERR from being reopened (some applications do this
+# to be able to log under Passenger).
+#
+def STDOUT.reopen(*args); end
+def STDERR.reopen(*args); end
+
+RackDB::Console.start()
+p eval( ARGV.join( ' ' ) ) unless ARGV.empty?

data/lib/rackdb/console.rb

@@ -0,0 +1,204 @@
+require 'erb'
+require 'yaml'
+require 'optparse'
+require 'rbconfig'
+require 'active_record'
+
+module Service
+  include ActiveSupport::Configurable
+end
+
+module RackDB
+  class Console
+    attr_reader :arguments
+
+    def self.start
+      new.start
+    end
+
+    def initialize(arguments = ARGV)
+      @arguments = arguments
+    end
+
+    def start
+      options = parse_arguments(arguments)
+      exit if options.nil?
+
+      ENV['RACK_ENV'] = options[:environment] || environment()
+      Service.config.env = environment()
+
+      case config["adapter"]
+      when /^(jdbc)?mysql/
+        args = {
+          'host'      => '--host',
+          'port'      => '--port',
+          'socket'    => '--socket',
+          'username'  => '--user',
+          'encoding'  => '--default-character-set',
+          'sslca'     => '--ssl-ca',
+          'sslcert'   => '--ssl-cert',
+          'sslcapath' => '--ssl-capath',
+          'sslcipher' => '--ssl-cipher',
+          'sslkey'    => '--ssl-key'
+        }.map { |opt, arg| "#{arg}=#{config[opt]}" if config[opt] }.compact
+
+        if config['password'] && options['include_password']
+          args << "--password=#{config['password']}"
+        elsif config['password'] && !config['password'].to_s.empty?
+          args << "-p"
+        end
+
+        args << config['database']
+
+        find_cmd_and_exec(['mysql', 'mysql5'], *args)
+
+      when /^postgres|^postgis/
+        ENV['PGUSER']     = config["username"] if config["username"]
+        ENV['PGHOST']     = config["host"] if config["host"]
+        ENV['PGPORT']     = config["port"].to_s if config["port"]
+        ENV['PGPASSWORD'] = config["password"].to_s if config["password"] && options['include_password']
+        find_cmd_and_exec('psql', config["database"])
+
+      when "sqlite"
+        find_cmd_and_exec('sqlite', config["database"])
+
+      when "sqlite3"
+        args = []
+
+        args << "-#{options['mode']}" if options['mode']
+        args << "-header" if options['header']
+        args << File.expand_path(config['database'], root())
+
+        find_cmd_and_exec('sqlite3', *args)
+
+      when "oracle", "oracle_enhanced"
+        logon = ""
+
+        if config['username']
+          logon = config['username']
+          logon << "/#{config['password']}" if config['password'] && options['include_password']
+          logon << "@#{config['database']}" if config['database']
+        end
+
+        find_cmd_and_exec('sqlplus', logon)
+
+      when "sqlserver"
+        args = []
+
+        args += ["-D", "#{config['database']}"] if config['database']
+        args += ["-U", "#{config['username']}"] if config['username']
+        args += ["-P", "#{config['password']}"] if config['password']
+
+        if config['host']
+          host_arg = "#{config['host']}"
+          host_arg << ":#{config['port']}" if config['port']
+          args += ["-S", host_arg]
+        end
+
+        find_cmd_and_exec("sqsh", *args)
+
+      else
+        abort "Unknown command-line client for #{config['database']}."
+      end
+    end
+
+    def config
+      @config ||= begin
+        if configurations()[environment].blank?
+          raise ActiveRecord::AdapterNotSpecified, "'#{environment}' database is not configured. Available configuration: #{configurations().inspect}"
+        else
+          configurations()[environment]
+        end
+      end
+    end
+
+    def environment
+      ENV["RACK_ENV"] || "development"
+    end
+
+    protected
+
+    def root
+      if defined?( Application ) && Application.respond_to?( :root )
+        Application.root # Rails-like
+      elsif Rack.respond_to?( :root )
+        Rack.root # Hypothetical
+      elsif defined?( Service ) && Service.respond_to?( :config ) && Service.config.respond_to?( :root ) && Service.config.root != nil
+        Service.config.root # Hoodoo service
+      else
+        '.'
+      end
+    end
+
+    def configurations
+      ActiveRecord::Base.default_timezone = :utc
+
+      path           = File.join( root(), 'config', 'database.yml' )
+      erb_yaml_file  = File.read( path )
+      pure_yaml_file = ERB.new( erb_yaml_file ).result
+
+      ActiveRecord::Base.configurations = YAML.load( pure_yaml_file )
+      return ActiveRecord::Base.configurations
+    end
+
+    def parse_arguments(arguments)
+      options = {}
+
+      OptionParser.new do |opt|
+        opt.banner = "Usage: rackdb [environment] [options]"
+        opt.on("-p", "--include-password", "Automatically provide the password from database.yml") do |v|
+          options['include_password'] = true
+        end
+
+        opt.on("--mode [MODE]", ['html', 'list', 'line', 'column'],
+          "Automatically put the sqlite3 database in the specified mode (html, list, line, column).") do |mode|
+            options['mode'] = mode
+        end
+
+        opt.on("--header", "Turn on sqlite3 database command line header display.") do |h|
+          options['header'] = h
+        end
+
+        opt.on("-h", "--help", "Show this help message.") do
+          puts opt
+          return nil
+        end
+
+        opt.on("-e", "--environment=name", String,
+          "Specifies the environment to run this console under (test/development/production).",
+          "Default: development"
+        ) { |v| options[:environment] = v.strip }
+
+        opt.parse!(arguments)
+        abort opt.to_s unless (0..1).include?(arguments.size)
+      end
+
+      if arguments.first && arguments.first[0] != '-'
+        options[:environment] = arguments.first
+      end
+
+      options
+    end
+
+    def find_cmd_and_exec(commands, *args)
+      commands = Array(commands)
+
+      dirs_on_path = ENV['PATH'].to_s.split(File::PATH_SEPARATOR)
+      commands += commands.map{|cmd| "#{cmd}.exe"} if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+
+      full_path_command = nil
+      found = commands.detect do |cmd|
+        dirs_on_path.detect do |path|
+          full_path_command = File.join(path, cmd)
+          File.executable? full_path_command
+        end
+      end
+
+      if found
+        exec full_path_command, *args
+      else
+        abort("Couldn't find database client: #{commands.join(', ')}. Check your $PATH and try again.")
+      end
+    end
+  end
+end

data/lib/rackdb/version.rb

@@ -0,0 +1,3 @@
+module RackDB
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: rackdb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Hodgkinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Database console for Ruby applications running on Rack with ActiveRecord
+  and following the Rails "config/database.yml" database configuration pattern
+email: ahodgkin@rowing.org.uk
+executables:
+- rackdb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/rackdb
+- lib/rackdb/console.rb
+- lib/rackdb/version.rb
+homepage: http://github.com/pond/rackdb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Database console for Rack applications
+test_files: []