activerecord_url_connections 0.0.2 → 0.0.3

data/Gemfile

@@ -1,5 +1,10 @@
 source "http://rubygems.org"
 
-gem "rake", "0.8.7"
+gem "rake"
 # Specify your gem's dependencies in activerecord_url_connections.gemspec
 gemspec
+
+group :test do
+  gem "ruby-debug19", :require => "ruby-debug"
+  gem "mocha", :require => nil
+end

data/Rakefile

@@ -1,2 +1,14 @@
-require 'bundler'
+require "bundler"
+require "rake"
+require "rake/testtask"
+module ActiveRecordURLConnections
+  class RakeTasks
+    include Rake::DSL
+    Rake::TestTask.new do |t|
+      t.libs << "test"
+      t.test_files = FileList["test/*_test.rb"]
+      t.verbose = true
+    end
+  end
+end
 Bundler::GemHelper.install_tasks

data/Readme.md

@@ -0,0 +1,68 @@
+# ActiveRecord URL Connections
+
+This gem adds support to ActiveRecord for connecting to a database by
+specifying a URL rather than a hash of parameters. Many ruby adapters
+have opted for this format (DataMapper, Sequel, MongoDB, etc.) in
+addition to numerous alternatives in other languages. So why should AR
+be missing out on all the fun?
+
+The other notable benefit is that you can continue to use
+`config/database.yml` in development, while setting an ENV variable
+of `DATABASE_URL` on your production server to specify the connection
+settings. No more risk of committing sensitive database credentials into
+version control, or having to worry about Capistrano moving the relevant
+production file into place on deploy.
+
+## Usage
+
+The URL takes the form of:
+
+    <adapter>://<user>:<password>@<hostname>:<port>/<database>?<options>
+
+Where options is a query string of key value pairs. For example:
+
+    mysql://app:s3crets@127.0.0.1:5123/nyancat_production?encoding=utf8
+
+Only `adapter`, `hostname`, and `database` are required. Everything else
+is optional, so to connect using local user permissions in postgres just do:
+
+    postgres://localhost/nyancat_production
+
+## Installation
+
+Either in your `Gemfile`:
+
+    gem "activerecord_url_connections"
+
+Or install it directly onto your system with rubygems:
+
+    gem install activerecord_url_connections
+
+Then require in your app:
+
+    require "activerecord_url_connections"
+
+## License
+
+ActiveRecord URL Connections is MIT Licensed
+
+Copyright (C) 2011 by Glenn Gillen
+
+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/activerecord_url_connections.gemspec

@@ -16,4 +16,5 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  s.add_dependency('activerecord')
 end

data/lib/activerecord_url_connections.rb

@@ -1,3 +1,4 @@
+require "active_record"
 module ActiveRecordURLConnections
   def self.parse(str)
     config = URI.parse(str)
@@ -11,3 +12,33 @@ module ActiveRecordURLConnections
     }
   end
 end
+
+ActiveRecord::Base.class_eval do
+  class << self
+    alias_method :establish_connection_without_url, :establish_connection
+    def establish_connection(spec = nil)
+      spec ||= ENV["DATABASE_URL"]
+      if spec.is_a?(String) && url = URI.parse(spec)
+        adapter = url.scheme
+        adapter = "postgresql" if adapter == "postgres"
+        spec = { :adapter  => adapter,
+                 :username => url.user,
+                 :password => url.password,
+                 :database => url.path.sub(%r{^/},""),
+                 :port     => url.port,
+                 :hostname => url.host }
+        spec.reject!{ |key,value| value.nil? }
+        spec.merge!(split_query_options(url.query))
+      end
+      establish_connection_without_url(spec)
+    rescue URI::InvalidURIError
+      establish_connection_without_url(spec)
+    end
+
+    private
+    def split_query_options(query = nil)
+      return {} unless query
+      Hash[query.split("&").map{ |pair| pair.split("=") }].symbolize_keys
+    end
+  end
+end

data/lib/activerecord_url_connections/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordURLConnections
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/connection_test.rb

@@ -0,0 +1,93 @@
+require "rubygems"
+require "bundler/setup"
+Bundler.require(:test)
+require "test/unit"
+require "mocha"
+require "activerecord_url_connections"
+class TestConnection < Test::Unit::TestCase
+  def mock_connection_spec(spec, adapter)
+    conn_spec = ActiveRecord::Base::ConnectionSpecification.new(spec, adapter)
+    ActiveRecord::Base::ConnectionSpecification.stubs(:new).
+      with(spec, adapter).returns(conn_spec)
+    conn_spec
+  end
+
+  def setup
+    ActiveRecord::ConnectionAdapters::ConnectionHandler.any_instance.
+      stubs(:establish_connection)
+  end
+
+  def spec_hash(opts = {})
+    default_spec = { :adapter  => "mysql",
+                     :username => "user",
+                     :password => "secret",
+                     :hostname => "localhost",
+                     :database => "mydatabase" }
+    default_spec.merge!(opts)
+    default_spec
+  end
+
+  def test_generic_url_connection
+    connection_spec = mock_connection_spec(spec_hash, "mysql_connection")
+    url = "mysql://user:secret@localhost/mydatabase"
+    ActiveRecord::ConnectionAdapters::ConnectionHandler.any_instance.
+      expects(:establish_connection).with("ActiveRecord::Base", connection_spec)
+    ActiveRecord::Base.establish_connection(url)
+  end
+
+  def test_works_with_traditional_hash_spec
+    spec = spec_hash
+    connection_spec = mock_connection_spec(spec, "mysql_connection")
+    ActiveRecord::ConnectionAdapters::ConnectionHandler.any_instance.
+      expects(:establish_connection).with("ActiveRecord::Base", connection_spec)
+    ActiveRecord::Base.establish_connection(spec)
+  end
+
+  def test_doesnt_raise_uri_parse_error
+    url = "this isn't a URL"
+    assert_raises ActiveRecord::AdapterNotSpecified do
+      ActiveRecord::Base.establish_connection(url)
+    end
+  end
+
+  def test_translates_postgres
+    spec = spec_hash(:adapter => "postgresql")
+    connection_spec = mock_connection_spec(spec, "postgresql_connection")
+    url  = "postgres://user:secret@localhost/mydatabase"
+    ActiveRecord::ConnectionAdapters::ConnectionHandler.any_instance.
+      expects(:establish_connection).with("ActiveRecord::Base", connection_spec)
+    ActiveRecord::Base.establish_connection(url)
+  end
+
+  def test_supports_additional_options_as_params
+    spec = spec_hash(:encoding => "utf8",
+                     :hostname => "remotehost.example.org",
+                     :port => 3133,
+                     :random_key => "blah")
+    connection_spec = mock_connection_spec(spec, "mysql_connection")
+    url  = "mysql://user:secret@remotehost.example.org:3133/mydatabase?encoding=utf8&random_key=blah"
+    ActiveRecord::ConnectionAdapters::ConnectionHandler.any_instance.
+      expects(:establish_connection).with("ActiveRecord::Base", connection_spec)
+    ActiveRecord::Base.establish_connection(url)
+  end
+
+  def test_drops_empty_values_from_spec
+    spec = spec_hash
+    spec.delete(:username)
+    spec.delete(:password)
+    connection_spec = mock_connection_spec(spec, "mysql_connection")
+    url  = "mysql://localhost/mydatabase"
+    ActiveRecord::ConnectionAdapters::ConnectionHandler.any_instance.
+      expects(:establish_connection).with("ActiveRecord::Base", connection_spec)
+    ActiveRecord::Base.establish_connection(url)
+  end
+
+  def test_use_environment_variable_if_no_spec_provided
+    url = "mysql://user:secret@localhost/mydatabase"
+    ENV["DATABASE_URL"] = url
+    connection_spec = mock_connection_spec(spec_hash, "mysql_connection")
+    ActiveRecord::ConnectionAdapters::ConnectionHandler.any_instance.
+      expects(:establish_connection).with("ActiveRecord::Base", connection_spec)
+    ActiveRecord::Base.establish_connection
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: activerecord_url_connections
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Glenn Gillen
@@ -10,10 +10,20 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-01 00:00:00 +01:00
+date: 2011-06-28 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 description: Allows database connections to be defined as URLS, then converted to hash for use in ActiveRecord
 email: 
 - glenn@rubypond.com
@@ -27,9 +37,11 @@ files:
 - .gitignore
 - Gemfile
 - Rakefile
+- Readme.md
 - activerecord_url_connections.gemspec
 - lib/activerecord_url_connections.rb
 - lib/activerecord_url_connections/version.rb
+- test/connection_test.rb
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -44,18 +56,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2816335097435414650
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2816335097435414650
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
@@ -64,5 +70,5 @@ rubygems_version: 1.6.0
 signing_key: 
 specification_version: 3
 summary: Convert URLs into AR friendly hashes
-test_files: []
-
+test_files: 
+- test/connection_test.rb