travis-config 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db1b438a15fc56e6225dfb5483d279d42dedf2a4
-  data.tar.gz: d67b6b5f139cc394e1a7588dea711c20371b5752
+  metadata.gz: d28c9bf4b9fe2cad9b9320fc1c0f75a79f78bfc1
+  data.tar.gz: 8f80aa3063b9c09846c277bb8616349f2b273e84
 SHA512:
-  metadata.gz: 85c63849ba32c848183596720d9b206b8a2d7c23be61a82dddabbee79025bd4b8ee0b5762b0b69706dfe4606b988868a6f7ff1af333c9af23b0723b7878a866a
-  data.tar.gz: f7886416ae772b319e0d9c1c765b3e3ddae8a4ceb07131ea15546225491e73f55daf99edca0b20e56d6921428f767c3f875550c71c57a182058c491fd9a2e414
+  metadata.gz: a80aeac2d95ff766b3e5446ce0a23ad7ee49523e34a6b6b7b96602985c9fa70ee502d9ce5efea94386756975455a8b701682a0d4e52ba96edc6e1e2f8e1af4e0
+  data.tar.gz: ebb04bd02c4348d37d9bb26b32a4af29630b430ac0815e91c29a46c8886a5db83b706892a68cd43373a21ffd4e666ad98814a414844560a2e5b29c64fe6a67e4

data/Gemfile

@@ -1,3 +1,8 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :test do
+  gem 'rspec', '~> 3.0'
+  gem 'mocha', '~> 1.1'
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    travis-config (0.1.0)
+      hashr (~> 0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    hashr (0.0.22)
+    metaclass (0.0.4)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha (~> 1.1)
+  rspec (~> 3.0)
+  travis-config!

data/README.md

@@ -0,0 +1,65 @@
+# Travis Config
+
+Shared way of loading and reading configuration in Travis CI.
+
+Users can either set defaults and include logic directly to the class
+`Travis::Config` or extend the class to, e.g. `Travis::Logs::Config`.
+
+E.g.
+
+```ruby
+require 'travis/config'
+
+module Travis
+  class Config < Hashr
+    define  host:  'travis-ci.org'
+
+    def foo
+      :foo
+    end
+  end
+end
+```
+
+Or:
+
+```ruby
+require 'travis/config'
+
+module Travis::Logs
+  class Config < Travis::Config
+    define  host:  'logs.travis-ci.org'
+
+    def foo
+      :foo
+    end
+  end
+end
+```
+
+### Config sources
+
+Serveral config sources are supported:
+
+* Files: All files `config/travis.yml` and `config/travis/*.yml` are read and
+  merged (alpabetically sorted).
+* Env: `ENV['travis_config']` is parsed as YAML and merged, if present.
+* Heroku: The env vars `DATABASE_URL` or `SHARED_DATABASE_URL`, and `DB_POOL`
+  or `DATABASE_POOL_SIZE` are merged into the database config.
+* Docker: The env vars `POSTGRESQL_PORT`, `RABBITMQ_PORT`, and `REDIS_PORT` are
+  interpreted as resource URLs, and merged into the database config.
+
+Configuration from all sources is merged before it is passed to the `Hashr`
+instance. All merging is deep merging of Hashes on any level.
+
+### Doing a Rubygem release
+
+Any tool works. The current releases were done with
+[`gem-release`](https://github.com/svenfuchs/gem-release) which allows creating
+a Git tag, pushing it to GitHub, building the gem and pushing it to Rubygems in
+one go:
+
+```bash
+$ gem install gem-release
+$ gem release --tag
+```

data/lib/travis/config/files.rb

@@ -9,16 +9,12 @@ module Travis
 
       def load
         filenames.inject({}) do |config, filename|
-          deep_merge(config, load_file(filename)[env] || {})
+          deep_merge(config, load_file(filename)[Config.env] || {})
         end
       end
 
       private
 
-        def env
-          ENV['ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
-        end
-
         def load_file(filename)
           YAML.load_file(filename) || {} rescue {}
         end

data/lib/travis/config/heroku.rb

@@ -6,20 +6,31 @@ module Travis
     class Heroku
       include Helpers
 
+      DATABASE_URL = %r((?:.+?)://(?<username>.+):(?<password>.+)@(?<host>[^:]+):?(?<port>.*)/(?<database>.+))
+
       def load
-        { database: parse_database_url(database_url) || {} }
+        { database: database }
       end
 
       private
 
-        def database_url
-          ENV.values_at('DATABASE_URL', 'SHARED_DATABASE_URL').first
+        def database
+          config = parse_database_url(database_url)
+          config = config.merge(pool: pool_size.to_i) if pool_size
+          config
         end
 
         def parse_database_url(url)
-          pattern = %r((?:.+?)://(?<username>.+):(?<password>.+)@(?<host>[^:]+):?(?<port>.*)/(?<database>.+))
-          matches = pattern.match(url.to_s)
-          compact(Hash[matches.names.zip(matches.captures)]) if matches
+          matches = DATABASE_URL.match(url.to_s)
+          matches ? compact(Hash[matches.names.zip(matches.captures)]) : {}
+        end
+
+        def pool_size
+          ENV.values_at('DB_POOL', 'DATABASE_POOL_SIZE').first
+        end
+
+        def database_url
+          ENV.values_at('DATABASE_URL', 'SHARED_DATABASE_URL').first
         end
     end
   end

data/lib/travis/config/version.rb

@@ -1,5 +1,3 @@
-module Travis
-  class Config
-    VERSION = '0.1.0'
-  end
+module TravisConfig
+  VERSION = '0.1.1'
 end

data/lib/travis/config.rb

@@ -24,6 +24,10 @@ module Travis
     class << self
       include Helpers
 
+      def env
+        @env ||= ENV['ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+      end
+
       def load(*loaders)
         loaders = [:files, :env, :heroku, :docker] if loaders.empty?
 
@@ -36,5 +40,9 @@ module Travis
         new(data)
       end
     end
+
+    def env
+      self.class.env
+    end
   end
 end

data/spec/spec_helper.rb

@@ -3,6 +3,13 @@ ENV['ENV'] = 'test'
 require 'mocha'
 require 'travis/config'
 
+module Travis::Test
+  class Config < Travis::Config
+    define amqp: { username: 'guest', password: 'guest', host: 'localhost', prefetch: 1 }
+    define database: { adapter: 'postgresql', database: 'test', encoding: 'unicode' }
+  end
+end
+
 RSpec.configure do |config|
   config.mock_with :mocha
 end

data/spec/travis/config/docker_spec.rb

@@ -0,0 +1,37 @@
+describe Travis::Config::Docker do
+  let(:config) { Travis::Test::Config.load(:docker) }
+  let(:vars)   { %w(POSTGRESQL_PORT RABBITMQ_PORT REDIS_PORT) }
+  after        { vars.each { |key| ENV.delete(key) } }
+
+  describe 'loads POSTGRESQL_PORT to config.database' do
+    before { ENV['POSTGRESQL_PORT'] = 'tcp://172.17.0.11:5432' }
+
+    it 'loads host and port from the env var' do
+      expect(config.database.values_at(:host, :port)).to eq(['172.17.0.11', '5432'])
+    end
+
+    it 'keeps adapter, database, encoding from the regular config' do
+      expect(config.database.values_at(:adapter, :database, :encoding)).to eq(['postgresql', 'test', 'unicode'])
+    end
+  end
+
+  describe 'loads RABBITMQ_PORT to config.amqp' do
+    before { ENV['RABBITMQ_PORT'] = 'tcp://172.17.0.11:5672' }
+
+    it 'loads host and port from the env var' do
+      expect(config.amqp.values_at(:host, :port)).to eq(['172.17.0.11', '5672'])
+    end
+
+    it 'keeps username, password, prefetch from the regular config' do
+      expect(config.amqp.values_at(:username, :password, :prefetch)).to eq(['guest', 'guest', 1])
+    end
+  end
+
+  describe 'loads REDIS_PORT' do
+    before { ENV['REDIS_PORT'] = 'tcp://172.17.0.7:6379' }
+
+    it 'loads the port to redis.url' do
+      expect(config.redis).to eq({ url: 'tcp://172.17.0.7:6379' })
+    end
+  end
+end

data/spec/travis/config/files_spec.rb

@@ -0,0 +1,31 @@
+describe Travis::Config::Files do
+  let(:config) { Travis::Test::Config.load(:files) }
+
+  describe 'reads custom config files' do
+    before :each do
+      Dir.stubs(:[]).returns ['config/travis.yml', 'config/travis/foo.yml', 'config/travis/bar.yml']
+      YAML.stubs(:load_file).with('config/travis.yml').returns('test' => { 'travis' => 'travis', 'shared' => 'travis' })
+      YAML.stubs(:load_file).with('config/travis/foo.yml').returns('test' => { 'foo' => 'foo' })
+      YAML.stubs(:load_file).with('config/travis/bar.yml').returns('test' => { 'bar' => 'bar', 'shared' => 'bar' })
+    end
+
+    it 'still reads the default config file' do
+      expect(config.travis).to eq('travis')
+    end
+
+    it 'merges custom files' do
+      expect(config.foo).to eq('foo')
+      expect(config.bar).to eq('bar')
+    end
+
+    it 'overwrites previously set values with values loaded later' do
+      expect(config.shared).to eq('bar')
+    end
+  end
+
+
+  it 'deep symbolizes arrays, too' do
+    config = Travis::Config.new('queues' => [{ 'slug' => 'rails/rails', 'queue' => 'rails' }])
+    expect(config.queues.first.values_at(:slug, :queue)).to eq(['rails/rails', 'rails'])
+  end
+end

data/spec/travis/config/heroku_spec.rb

@@ -0,0 +1,46 @@
+describe Travis::Config::Heroku do
+  let(:config) { Travis::Test::Config.load(:heroku) }
+  let(:vars)   { %w(DATABASE_URL POOL_SIZE) }
+  after        { vars.each { |key| ENV.delete(key) } }
+  before       { ENV['DATABASE_URL'] = 'postgres://username:password@hostname:port/database' }
+
+  it 'loads a DATABASE_URL with a port' do
+    expect(config.database.to_hash).to eq(
+      adapter:  'postgresql',
+      host:     'hostname',
+      port:     'port',
+      database: 'database',
+      username: 'username',
+      password: 'password',
+      encoding: 'unicode'
+    )
+  end
+
+  it 'loads a DATABASE_URL without a port' do
+    ENV['DATABASE_URL'] = 'postgres://username:password@hostname/database'
+
+    expect(config.database.to_hash).to eq(
+      adapter:  'postgresql',
+      host:     'hostname',
+      database: 'database',
+      username: 'username',
+      password: 'password',
+      encoding: 'unicode'
+    )
+  end
+
+  it 'loads DB_POOL' do
+    ENV['DB_POOL'] = '25'
+
+    expect(config.database.to_hash).to eq(
+      adapter:  'postgresql',
+      host:     'hostname',
+      port:     'port',
+      database: 'database',
+      username: 'username',
+      password: 'password',
+      encoding: 'unicode',
+      pool:     25
+    )
+  end
+end

data/spec/travis/config_spec.rb

@@ -1,12 +1,3 @@
-require 'spec_helper'
-
-module Travis::Test
-  class Config < Travis::Config
-    define amqp: { username: 'guest', password: 'guest', host: 'localhost', prefetch: 1 }
-    define database: { adapter: 'postgresql', database: 'test', encoding: 'unicode' }
-  end
-end
-
 describe Travis::Config do
   let(:config) { Travis::Test::Config.load(:files, :env, :heroku, :docker) }
 
@@ -28,52 +19,15 @@ describe Travis::Config do
       config.foo = { :bar => { :baz => 'baz' } }
       expect(config.foo.bar).to be_kind_of(Hashr)
     end
-  end
-
-  describe 'using DATABASE_URL for database configuration if present' do
-    after :each do
-      ENV.delete('DATABASE_URL')
-    end
-
-    it 'works when given a url with a port' do
-      ENV['DATABASE_URL'] = 'postgres://username:password@hostname:port/database'
-
-      expect(config.database.to_hash).to eq(
-        :adapter => 'postgresql',
-        :host => 'hostname',
-        :port => 'port',
-        :database => 'database',
-        :username => 'username',
-        :password => 'password',
-        :encoding => 'unicode'
-      )
-    end
-
-    it 'works when given a url without a port' do
-      ENV['DATABASE_URL'] = 'postgres://username:password@hostname/database'
-
-      expect(config.database.to_hash).to eq(
-        :adapter => 'postgresql',
-        :host => 'hostname',
-        :database => 'database',
-        :username => 'username',
-        :password => 'password',
-        :encoding => 'unicode'
-      )
-    end
-  end
-
-  describe 'the example config file' do
-    let(:data) { {} }
 
     it 'can access all keys recursively' do
-      nested_access = lambda do |config, data|
-        data.keys.each do |key|
-          expect(-> { config.send(key) }).to_not raise_error
-          nested_access.call(config.send(key), data[key]) if data[key].is_a?(Hash)
+      access = proc do |config|
+        config.keys.each do |key|
+          expect(proc { config.send(key) }).to_not raise_error
+          access.call(config.send(key)) if config[key].is_a?(Hash)
         end
       end
-      nested_access.call(config, data)
+      access.call(config)
     end
   end
 
@@ -99,46 +53,6 @@ describe Travis::Config do
     end
   end
 
-  describe 'loads docker-style env vars' do
-    after :each do
-      %w(POSTGRESQL_PORT RABBITMQ_PORT REDIS_PORT).each do |key|
-        ENV.delete(key)
-      end
-    end
-
-    describe 'loads POSTGRESQL_PORT to config.database' do
-      before :each do
-        ENV['POSTGRESQL_PORT'] = 'tcp://172.17.0.11:5432'
-      end
-
-      it 'loads host and port from the env var' do
-        expect(config.database.values_at(:host, :port)).to eq(['172.17.0.11', '5432'])
-      end
-
-      it 'keeps adapter, database, encoding from the regular config' do
-        expect(config.database.values_at(:adapter, :database, :encoding)).to eq(['postgresql', 'test', 'unicode'])
-      end
-    end
-
-    describe 'loads RABBITMQ_PORT to config.amqp' do
-      before :each do
-        ENV['RABBITMQ_PORT'] = 'tcp://172.17.0.11:5672'
-      end
-
-      it 'loads host and port from the env var' do
-        expect(config.amqp.values_at(:host, :port)).to eq(['172.17.0.11', '5672'])
-      end
-
-      it 'keeps username, password, prefetch from the regular config' do
-        expect(config.amqp.values_at(:username, :password, :prefetch)).to eq(['guest', 'guest', 1])
-      end
-    end
-
-    it 'loads REDIS_PORT' do
-      ENV['REDIS_PORT'] = 'tcp://172.17.0.7:6379'
-      expect(config.redis).to eq({ url: 'tcp://172.17.0.7:6379' })
-    end
-  end
 
   it 'deep symbolizes arrays, too' do
     config = Travis::Config.new('queues' => [{ 'slug' => 'rails/rails', 'queue' => 'rails' }])

data/travis-config.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'travis/config/version'
+
+Gem::Specification.new do |s|
+  s.name         = "travis-config"
+  s.version      = TravisConfig::VERSION
+  s.authors      = ["Travis CI"]
+  s.email        = "contact@travis-ci.org"
+  s.homepage     = "https://github.com/travis-ci/travis-core"
+  s.summary      = "Travis CI config"
+  s.description  = "#{s.summary}."
+  s.license      = "MIT"
+
+  s.files        = Dir['{lib/**/*,spec/**/*,[A-Z]*}']
+  s.platform     = Gem::Platform::RUBY
+  s.require_path = 'lib'
+  s.rubyforge_project = '[none]'
+
+  s.add_dependency 'hashr', '~> 0.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: travis-config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Travis CI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-19 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashr
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.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'
 description: Travis CI config.
 email: contact@travis-ci.org
 executables: []
@@ -45,7 +31,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - LICENSE
+- README.md
 - lib/travis/config.rb
 - lib/travis/config/docker.rb
 - lib/travis/config/env.rb
@@ -54,7 +42,11 @@ files:
 - lib/travis/config/heroku.rb
 - lib/travis/config/version.rb
 - spec/spec_helper.rb
+- spec/travis/config/docker_spec.rb
+- spec/travis/config/files_spec.rb
+- spec/travis/config/heroku_spec.rb
 - spec/travis/config_spec.rb
+- travis-config.gemspec
 homepage: https://github.com/travis-ci/travis-core
 licenses:
 - MIT
@@ -75,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: "[none]"
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Travis CI config