travis-config 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8fb7abc33d4b387f6619d373e40015d812ea4308
+  data.tar.gz: 2a5e1f82e557946189dc1b5ab4b793ff7130d235
+SHA512:
+  metadata.gz: f859a30538499361ccf47e8b930f3006fceece03cd3a59286a1401ecbb0c1fd59c0b242befcf3397bfcc4bcd2ddb9e34d2efd0522890b3479cd5fc4722c8f8c8
+  data.tar.gz: a4ed8459bff5ec0c35cd1535959c771a1c4d189e80f2eceadc5c2885c0161c951bb9cb112a896b19add6fddffdb101070482bf47f9e3e7c2f84891a9181e1cf4

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c)  Travis CI <contact@travis-ci.org>
+
+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/lib/travis/config/docker.rb

@@ -0,0 +1,35 @@
+require 'hashr'
+require 'travis/config/helpers'
+
+module Travis
+  class Config < Hashr
+    class Docker
+      include Helpers
+
+      PATTERN = %r(tcp://(?<host>[^:]+):?(?<port>.*))
+
+      def load
+        compact(redis: redis, database: database, amqp: amqp)
+      end
+
+      private
+
+        def database
+          parse(ENV['POSTGRESQL_PORT']) if ENV['POSTGRESQL_PORT']
+        end
+
+        def amqp
+          parse(ENV['RABBITMQ_PORT']) if ENV['RABBITMQ_PORT']
+        end
+
+        def redis
+          { url: ENV['REDIS_PORT'] } if ENV['REDIS_PORT']
+        end
+
+        def parse(url)
+          matches = PATTERN.match(url.to_s)
+          compact(Hash[matches.names.zip(matches.captures)]) if matches
+        end
+    end
+  end
+end

data/lib/travis/config/env.rb

@@ -0,0 +1,11 @@
+require 'hashr'
+
+module Travis
+  class Config < Hashr
+    class Env
+      def load
+        ENV['travis_config'] ? YAML.load(ENV['travis_config']) : {}
+      end
+    end
+  end
+end

data/lib/travis/config/files.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+require 'hashr'
+require 'travis/config/helpers'
+
+module Travis
+  class Config < Hashr
+    class Files
+      include Helpers
+
+      def load
+        filenames.inject({}) do |config, filename|
+          deep_merge(config, load_file(filename)[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
+
+        def filenames
+          @filenames ||= Dir['config/{travis.yml,travis/*.yml}'].sort
+        end
+    end
+  end
+end

data/lib/travis/config/helpers.rb

@@ -0,0 +1,51 @@
+require 'hashr'
+
+module Travis
+  class Config < Hashr
+    module Helpers
+      def deep_symbolize_keys(hash)
+        hash.inject({}) do |result, (key, value)|
+          key = key.to_sym if key.respond_to?(:to_sym)
+          result[key] = case value
+          when Array
+            value.map { |value| value.is_a?(Hash) ? value.deep_symbolize_keys : value }
+          when Hash
+            value.deep_symbolize_keys
+          else
+            value
+          end
+          result
+        end
+      end
+
+      def deep_merge(hash, other)
+        merger = proc { |key, v1, v2| v1.is_a?(Hash) && v2.is_a?(Hash) ? v1.merge(v2, &merger) : v2 || v1 }
+        hash.merge(other, &merger)
+      end
+
+      def compact(obj)
+        case obj
+        when Array
+          obj.reject { |obj| blank?(obj) }
+        when Hash
+          obj.keys.each { |key| obj.delete(key) if blank?(obj[key]) }
+          obj
+        else
+          obj
+        end
+      end
+
+      def blank?(obj)
+        obj.respond_to?(:empty?) ? !!obj.empty? : !obj
+      end
+
+      def camelize(string)
+        string = string.to_s
+        string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+        string.gsub!(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }
+        string.gsub!('/', '::')
+        string
+      end
+    end
+  end
+end

data/lib/travis/config/heroku.rb

@@ -0,0 +1,26 @@
+require 'hashr'
+require 'travis/config/helpers'
+
+module Travis
+  class Config < Hashr
+    class Heroku
+      include Helpers
+
+      def load
+        { database: parse_database_url(database_url) || {} }
+      end
+
+      private
+
+        def database_url
+          ENV.values_at('DATABASE_URL', 'SHARED_DATABASE_URL').first
+        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
+        end
+    end
+  end
+end

data/lib/travis/config/version.rb

@@ -0,0 +1,5 @@
+module Travis
+  class Config
+    VERSION = '0.0.1'
+  end
+end

data/lib/travis/config.rb

@@ -0,0 +1,40 @@
+require 'hashr'
+require 'travis/config/docker'
+require 'travis/config/env'
+require 'travis/config/files'
+require 'travis/config/heroku'
+
+# patch Hashr to merge with existing definitions and defaults
+class Hashr < Hash
+  class << self
+    def define(definition)
+      definition = self.definition.merge(definition.deep_symbolize_keys)
+      @definition = deep_accessorize(definition)
+    end
+
+    def default(defaults)
+      defaults = self.defaults.merge(defaults)
+      @defaults = deep_accessorize(defaults)
+    end
+  end
+end
+
+module Travis
+  class Config < Hashr
+    class << self
+      include Helpers
+
+      def load(*loaders)
+        loaders = [:files, :env, :heroku, :docker] if loaders.empty?
+
+        data = loaders.inject({}) do |data, name|
+          const = const_get(camelize(name)).new
+          other = deep_symbolize_keys(const.load)
+          deep_merge(data, other)
+        end
+
+        new(data)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+ENV['ENV'] = 'test'
+
+require 'mocha'
+require 'travis/config'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

data/spec/travis/config_spec.rb

@@ -0,0 +1,147 @@
+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) }
+
+  describe 'Hashr behaviour' do
+    after :each do
+      ENV.delete('travis_config')
+    end
+
+    it 'is a Hashr instance' do
+      expect(config).to be_kind_of(Hashr)
+    end
+
+    it 'returns Hashr instances on subkeys' do
+      ENV['travis_config'] = YAML.dump('redis' => { 'url' => 'redis://localhost:6379' })
+      expect(config.redis).to be_kind_of(Hashr)
+    end
+
+    it 'returns Hashr instances on subkeys that were set to Ruby Hashes' 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)
+        end
+      end
+      nested_access.call(config, data)
+    end
+  end
+
+  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
+
+  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' }])
+    expect(config.queues.first.values_at(:slug, :queue)).to eq(['rails/rails', 'rails'])
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: travis-config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Travis CI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- lib/travis/config.rb
+- lib/travis/config/docker.rb
+- lib/travis/config/env.rb
+- lib/travis/config/files.rb
+- lib/travis/config/helpers.rb
+- lib/travis/config/heroku.rb
+- lib/travis/config/version.rb
+- spec/spec_helper.rb
+- spec/travis/config_spec.rb
+homepage: https://github.com/travis-ci/travis-core
+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: "[none]"
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Travis CI config
+test_files: []
+has_rdoc: