rails_db_config_resolver 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 886200010d0a03d6d08bc7bc9952494ef6353f1b
+  data.tar.gz: 530d0e66d11c381cf0142c6ea3b2a21cbd3ec92e
+SHA512:
+  metadata.gz: bb0c27eda5bc7fa74f403a244ecfce8f8c0fd1b2b8a368a4af6a0439cb795ace2691cef7e4e08aedfd59cff73396b45f2e566cf516d26382b20ec5e9f2bf4858
+  data.tar.gz: 5cb4070e87474a13266b7802ca1a9055fae706077e526ec7e9423742761cac859f75e8d7f49cdfa34617f913ccc60d176dc290a5ef9f297e85dea45ae059b140

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_db_config_resolver.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cameron Martin
+
+MIT License
+
+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,38 @@
+# RailsDbConfigResolver
+
+Resolves database configuration in the same way that rails does.
+This is useful when wanting to connect to rail's database without loading the rails environment or
+when wanting to use [em-pg-client][1] for a helper process in a rails app.
+
+Values from `ENV['DATABASE_URL']` and `config/database.yml` are merged. `ENV['DATABASE_URL']` trumps `config/database.yml`.
+By looking at [the rails guide][2], I _think_ the url field in `database.yml` trumps both of them, so I'm not sure, so I left it out.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_db_config_resolver'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_db_config_resolver
+
+## Usage
+
+For now, check out `spec/rails_db_config_resolver_spec.rb`.
+
+## Contributing
+
+1. Fork it ( https://github.com/cameron-martin/rails_db_config_resolver/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+[1]: https://github.com/royaltm/ruby-em-pg-client
+[2]: http://guides.rubyonrails.org/configuring.html#configuring-a-database

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rails_db_config_resolver/database_config.rb

@@ -0,0 +1,79 @@
+require 'uri'
+require 'rattributes'
+
+class RailsDbConfigResolver
+  class DatabaseConfig
+
+    include Rattributes.new(:adapter, :host, :port, :username, :password, :database, :pool)
+
+    def self.from_url(url_string)
+      url = URI.parse(url_string)
+
+      pool = (url.query.match(/pool=(\d+)/)[1] if url.query)
+      database = url.path[1..-1]
+
+      new(
+        adapter: url.scheme,
+        host: url.host,
+        port: url.port,
+        username: url.user,
+        password: url.password,
+        database: database,
+        pool: pool
+      )
+    end
+
+    class << self
+      alias_method :from_hash, :new
+    end
+
+    def initialize(*)
+      super
+
+      @pool = cast_to_integer_or_nil(@pool)
+    end
+
+    def to_hash
+      {
+        adapter: @adapter,
+        host: @host,
+        port: @port,
+        username: @username,
+        password: @password,
+        database: @database,
+        pool: @pool
+      }
+    end
+
+    def to_url
+      URI::Generic.build(build_url_hash).to_s
+    end
+
+    def merge(other)
+      my_hash = to_hash
+      other_hash = other.to_hash.reject { |_, value| value.nil? }
+      self.class.from_hash(my_hash.merge(other_hash))
+    end
+
+  private
+
+    def build_url_hash
+      {
+        scheme: @adapter,
+        host: @host,
+        port: @port,
+        path: "/#{@database}"
+      }.tap do |hash|
+        hash[:query] = "pool=#{@pool}" if @pool
+        hash[:userinfo] = [@username, @password].compact.join(':') if @username || @password
+      end
+
+    end
+
+    def cast_to_integer_or_nil(object)
+      return nil unless object.is_a?(Numeric) || /^\d+$/.match(object)
+      object.to_i
+    end
+
+  end
+end

data/lib/rails_db_config_resolver/version.rb

@@ -0,0 +1,3 @@
+class RailsDbConfigResolver
+  VERSION = '0.0.1'
+end

data/lib/rails_db_config_resolver.rb

@@ -0,0 +1,54 @@
+require 'rails_db_config_resolver/version'
+require 'rails_db_config_resolver/database_config'
+
+require 'erb'
+require 'yaml'
+require 'uri'
+
+class RailsDbConfigResolver
+
+  def initialize(file, env_url, rails_env)
+    @file = file
+    @env_url = env_url
+    @rails_env = rails_env
+  end
+
+  def parse
+    merged_config.to_hash
+  end
+
+private
+
+  def merged_config
+    if @env_url
+      file_config.merge(env_url_config)
+    else
+      file_config
+    end
+  end
+
+  def env_url_config
+    DatabaseConfig.from_url(@env_url)
+  end
+
+  def file_config
+    DatabaseConfig.from_hash(file_config_hash)
+  end
+
+  def file_config_hash
+    symbolize_keys(YAML.load(rendered_yaml)[@rails_env])
+  end
+
+  def raw_yaml
+    File.read(@file)
+  end
+
+  def rendered_yaml
+    ERB.new(raw_yaml).result
+  end
+
+  def symbolize_keys(hash)
+    Hash[hash.map { |k, v| [k.to_sym, v] }]
+  end
+
+end

data/rails_db_config_resolver.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_db_config_resolver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails_db_config_resolver'
+  spec.version       = RailsDbConfigResolver::VERSION
+  spec.authors       = ['Cameron Martin']
+  spec.email         = ['cameronmartin123@gmail.com']
+  spec.summary       = %q{Rails db configuration, outside of rails}
+  spec.description   = %q{Use the database configuration from a rails app, without using rails}
+  spec.homepage      = 'https://github.com/cameron-martin/rails_db_config_resolver'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.0'
+
+  spec.add_dependency 'rattributes'
+end

data/spec/database_config_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe RailsDbConfigResolver::DatabaseConfig do
+
+  describe '.from_url' do
+
+    context 'with all fields' do
+
+      subject { RailsDbConfigResolver::DatabaseConfig.from_url('postgres://username:password@host.com:1234/database?pool=5') }
+
+      its(:adapter) { should eq('postgres') }
+      its(:username) { should eq('username') }
+      its(:password) { should eq('password') }
+      its(:host) { should eq('host.com') }
+      its(:port) { should eq(1234) }
+      its(:database) { should eq('database') }
+      its(:pool) { should eq(5) }
+
+    end
+
+    context 'without pool' do
+
+      subject { RailsDbConfigResolver::DatabaseConfig.from_url('postgres://username:password@host.com:1234/database') }
+
+      its(:adapter) { should eq('postgres') }
+      its(:username) { should eq('username') }
+      its(:password) { should eq('password') }
+      its(:host) { should eq('host.com') }
+      its(:port) { should eq(1234) }
+      its(:database) { should eq('database') }
+      its(:pool) { should be_nil }
+
+    end
+
+  end
+
+  describe '#initialize' do
+
+    context 'pool' do
+
+      def create_with_pool(pool)
+        RailsDbConfigResolver::DatabaseConfig.new(pool: pool)
+      end
+
+      it 'leaves integer pool as is' do
+        expect(create_with_pool(5).pool).to eq(5)
+      end
+
+      it 'converts pool to integer' do
+        expect(create_with_pool('5').pool).to eq(5)
+      end
+
+      it 'converts empty pool to nil' do
+        expect(create_with_pool('').pool).to eq(nil)
+      end
+
+    end
+
+  end
+
+  describe '#merge' do
+
+    context 'with two urls' do
+
+      let(:config1) { RailsDbConfigResolver::DatabaseConfig.from_url('postgres://username:password@host.com/database?pool=5') }
+      let(:config2) { RailsDbConfigResolver::DatabaseConfig.from_url('postgres://other-host.com/other-database?pool=10') }
+
+      subject { config1.merge(config2) }
+
+      its(:adapter) { should eq('postgres') }
+      its(:username) { should eq('username') }
+      its(:password) { should eq('password') }
+      its(:host) { should eq('other-host.com') }
+      its(:database) { should eq('other-database') }
+      its(:pool) { should eq(10) }
+
+    end
+
+  end
+
+  describe '#to_url' do
+
+    # Here we test if DatabaseConfig.from_url(url).to_url == url
+
+    {
+        'with every field' => 'postgres://username:password@host.com:1234/database?pool=5',
+        'without port' => 'postgres://username:password@host.com/database?pool=5',
+        'without pool' => 'postgres://username:password@host.com:1234/database',
+        'without password' => 'postgres://username@host.com:1234/database?pool=5',
+        'without username and password' => 'postgres://host.com:1234/database?pool=5',
+    }.each do |description, url|
+      context description do
+        subject { RailsDbConfigResolver::DatabaseConfig.from_url(url) }
+        its(:to_url) { should eq(url) }
+      end
+    end
+
+  end
+
+end

data/spec/rails_db_config_resolver_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+SPEC_ROOT = __dir__
+DB_FILE = File.join(SPEC_ROOT, 'support', 'database.yml')
+
+describe RailsDbConfigResolver do
+
+  context 'with full database file, and partial env variable' do
+
+    subject { RailsDbConfigResolver.new(DB_FILE, 'sqlite://env-host.com/env_database', 'production') }
+
+    its(:parse) { should eq(
+                            adapter:  'sqlite',
+                            database: 'env_database',
+                            pool:     5,
+                            username: 'file_username',
+                            password: 'file_password',
+                            host:     'env-host.com',
+                            port:     1234
+    ) }
+
+  end
+
+  context 'with full database file, and no env file' do
+
+    subject { RailsDbConfigResolver.new(DB_FILE, nil, 'production') }
+
+    its(:parse) { should eq(
+                            adapter:  'postgresql',
+                            database: 'file_database',
+                            pool:     5,
+                            username: 'file_username',
+                            password: 'file_password',
+                            host:     'file-host.com',
+                            port:     1234
+    ) }
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rails_db_config_resolver'
+
+require 'rspec'
+require 'rspec/its'

data/spec/support/database.yml

@@ -0,0 +1,9 @@
+production:
+  adapter: postgresql
+  encoding: unicode
+  database: file_database
+  pool: 5
+  username: file_username
+  password: file_password
+  host: file-host.com
+  port: 1234

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: rails_db_config_resolver
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cameron Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rattributes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use the database configuration from a rails app, without using rails
+email:
+- cameronmartin123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_db_config_resolver.rb
+- lib/rails_db_config_resolver/database_config.rb
+- lib/rails_db_config_resolver/version.rb
+- rails_db_config_resolver.gemspec
+- spec/database_config_spec.rb
+- spec/rails_db_config_resolver_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.yml
+homepage: https://github.com/cameron-martin/rails_db_config_resolver
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rails db configuration, outside of rails
+test_files:
+- spec/database_config_spec.rb
+- spec/rails_db_config_resolver_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.yml