database_specification 0.0.1

data/lib/database_specification.rb

@@ -0,0 +1,196 @@
+require "database_specification/version"
+require 'uri'
+require 'cgi'
+
+# Translate beween different ways of describing a database connection
+# Currently supports
+#
+# - ActiveRecord hash
+# - Sequel hash
+# - URL (Sequel/Heroku)
+#
+# Construct an object with the appropriate from-database constructor,
+# and then use the appopriate to-database accessor.
+class DatabaseSpecification
+  # The database driver type: postgres, sqlite, etc.
+  attr_reader :adapter
+  # Database name within the server
+  attr_reader :database
+  attr_reader :user
+  attr_reader :password
+  attr_reader :host
+  attr_reader :port
+  # Misc extra options, ex: pool, timeout
+  attr_reader :options
+
+  # How we store the information internally
+  STANDARD = [
+    :adapter,
+    :database,
+    :user,
+    :username,
+    :password,
+    :host,
+    :port,
+  ]
+
+  # ActiveRecord constructor
+  # @param [Hash] config ActiveRecord style db hash
+  def self.active_record(config)
+    new.from_active_record(config)
+  end
+
+  # Sequel hash constructor
+  # @param [Hash] config Sequel style db hash
+  def self.sequel(config)
+    new.from_sequel(config)
+  end
+
+  # URL constructor (Sequel/Heroku)
+  # @param [String] url
+  def self.url(url)
+    new.from_url(url)
+  end
+
+  # Performs the work of setting up from an ActiveRecord style hash
+  # @param [Hash] config ActiveRecord style db hash
+  # @return [DatabaseSpecification]
+  def from_active_record(config)
+    @adapter = ar_to_sequel(config[:adapter])
+    @database = config[:database]
+    @user = config[:username]
+    @password = config[:password]
+    @host = config[:host]
+    @port = config[:port]
+    @options = (config.keys - STANDARD).map {|k| [k, config[k]]}
+    self
+  end
+
+  # Performs the work of setting up from a Sequel style hash
+  # @param [Hash] config Sequel style db hash
+  # @return [DatabaseSpecification]
+  def from_sequel(config)
+    @adapter = config[:adapter]
+    @database = config[:database]
+    @user = config[:user]
+    @password = config[:password]
+    @host = config[:host]
+    @port = config[:port]
+    @options = (config.keys - STANDARD).map {|k| [k, config[k]]}
+    self
+  end
+
+  # Performs the work of setging up from a url
+  # @param [String] url
+  # @return [DatabaseSpecification]
+  def from_url(url)
+    begin
+      uri = URI.parse(url)
+    rescue URI::InvalidURIError
+      raise "Invalid DATABASE_URL"
+    end
+    @adapter = uri.scheme
+    @database = uri.path.split('/')[1]
+    @user = uri.user
+    @password = uri.password
+    @host = uri.host
+    @port = uri.port
+    @options = parse_query(uri.query)
+
+    if @adapter == 'sqlite'
+      @database = [@host, @database].join('/')
+      @host = nil
+    end
+    self
+  end
+
+  # @return [Hash] ActiveRecord style hash
+  def active_record
+    Hash[[
+      [:adapter, sequel_to_ar(adapter)],
+      [:database, database],
+      [:username, user],
+      [:password, password],
+      [:host, host],
+      [:port, port],
+    ].select {|x| x.last} + options]
+  end
+
+  # @return [Hash] Sequel style hash
+  def sequel
+    Hash[[
+      [:adapter, adapter],
+      [:database, database],
+      [:user, user],
+      [:password, password],
+      [:host, host],
+      [:port, port],
+    ].select {|x| x.last} + options]
+  end
+
+  # @return [String] DB url with query paramters
+  def url
+    [url_bare, query].compact.join('?')
+  end
+
+  # @return [String] DB url without query parameters
+  def url_bare
+    if adapter == 'postgres'
+      h = host || 'localhost'
+    else
+      h = host
+    end
+    uri = URI::Generic.build({
+      :scheme => adapter,
+      :userinfo => userinfo,
+      :host => h,
+      :port => port,
+      :path => '/' + database, # wants an absolute component
+    }).to_s
+    # URI is overly agressive in removing leading /
+    if adapter == 'sqlite'
+      uri.gsub!(':/', '://')
+    end
+    uri
+  end
+
+  private
+  def ar_to_sequel(adapter)
+    case adapter
+    when 'sqlite3'; 'sqlite'
+    when 'postgresql'; 'postgres'
+    else; adapter
+    end
+  end
+
+  def sequel_to_ar(adapter)
+    case adapter
+    when 'sqlite'; 'sqlite3'
+    when 'postgres'; 'postgresql'
+    else; adapter
+    end
+  end
+
+  def userinfo
+    if user || password
+      [user, password].join(':')
+    end
+  end
+
+  def query
+    q = options.map do |k,v|
+      k.to_s + '=' + v.to_s
+    end.join('&')
+    q unless q.empty?
+  end
+
+  def parse_query(q)
+    CGI.parse(q || '').to_a.map do |k, v|
+      n = v.first
+      if n.match(/\d+/)
+        n = n.to_i
+      end
+      [k.to_sym, n]
+    end
+  end
+end

data/lib/database_specification/version.rb

@@ -0,0 +1,4 @@
+class DatabaseSpecification
+  # version number
+  VERSION = "0.0.1"
+end

data/spec/database_specification_spec.rb

@@ -0,0 +1,98 @@
+require 'database_specification'
+
+describe DatabaseSpecification do
+  let(:ar_sqlite) do
+    {
+      :adapter => 'sqlite3',
+      :database => 'db/development.sqlite3',
+      :pool => 5,
+      :timeout => 5000,
+    }
+  end
+  let(:sequel_sqlite) do
+    {
+      :adapter => 'sqlite',
+      :database => 'db/development.sqlite3',
+      :pool => 5,
+      :timeout => 5000,
+    }
+  end
+  let(:url_sqlite) {'sqlite://db/development.sqlite3?pool=5&timeout=5000'}
+  let(:url_sqlite_bare) {'sqlite://db/development.sqlite3'}
+  let(:ar_postgres) do
+    {
+      :adapter => 'postgresql',
+      :database => 'pacha_development',
+      :username => 'user',
+      :password => 'pass',
+      :host => 'localhost',
+      :port => 1111,
+    }
+  end
+  let(:ar_postgres_short) do
+    {
+      :adapter => 'postgresql',
+      :database => 'pacha_development',
+    }
+  end
+  let(:url_postgres_short) {'postgres://localhost/pacha_development'}
+  let(:sequel_postgres) do
+    {
+      :adapter => 'postgres',
+      :database => 'pacha_development',
+      :user => 'user',
+      :password => 'pass',
+      :host => 'localhost',
+      :port => 1111,
+    }
+  end
+  let(:url_postgres) {'postgres://user:pass@localhost:1111/pacha_development'}
+
+  describe 'ActiveRecord' do
+    describe 'sqlite' do
+      subject {DatabaseSpecification.active_record(ar_sqlite)}
+      its(:active_record) {should == ar_sqlite}
+      its(:sequel) {should == sequel_sqlite}
+      its(:url) {should == url_sqlite}
+      its(:url_bare) {should == url_sqlite_bare}
+    end
+    describe 'postgres' do
+      subject {DatabaseSpecification.active_record(ar_postgres)}
+      its(:active_record) {should == ar_postgres}
+      its(:sequel) {should == sequel_postgres}
+      its(:url) {should == url_postgres}
+    end
+    describe 'postgres short' do
+      subject {DatabaseSpecification.active_record(ar_postgres_short)}
+      its(:url) {should == url_postgres_short}
+    end
+  end
+  describe 'Sequel' do
+    describe 'sqlite' do
+      subject {DatabaseSpecification.sequel(sequel_sqlite)}
+      its(:active_record) {should == ar_sqlite}
+      its(:sequel) {should == sequel_sqlite}
+      its(:url) {should == url_sqlite}
+    end
+    describe 'postgres' do
+      subject {DatabaseSpecification.sequel(sequel_postgres)}
+      its(:active_record) {should == ar_postgres}
+      its(:sequel) {should == sequel_postgres}
+      its(:url) {should == url_postgres}
+    end
+  end
+  describe 'url' do
+    describe 'sqlite' do
+      subject {DatabaseSpecification.url(url_sqlite)}
+      its(:active_record) {should == ar_sqlite}
+      its(:sequel) {should == sequel_sqlite}
+      its(:url) {should == url_sqlite}
+    end
+    describe 'postgres' do
+      subject {DatabaseSpecification.url(url_postgres)}
+      its(:active_record) {should == ar_postgres}
+      its(:sequel) {should == sequel_postgres}
+      its(:url) {should == url_postgres}
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: database_specification
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Justin Love
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Translate between different ways of specifying a database connection.  Translates
+  between ActiveRecord-hash, Sequel-hash, and urls used by Sequel and Heroku
+email:
+- git@JustinLove.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/database_specification.rb
+- lib/database_specification/version.rb
+- spec/database_specification_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: database_specification
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Translate between different ways of specifying a database connection - eg
+  AR-URL
+test_files:
+- spec/database_specification_spec.rb
+has_rdoc: