docker_compose_env 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11cda084bdb92a72404dc9149c5f26496c79eeef
+  data.tar.gz: d254e3e1f07eb0923a9d6d9aa7554ec54701d11c
+SHA512:
+  metadata.gz: ff61e526e2b6916a7f555e9efc9b5a8913faa427519941a8dbdd49b1e336811aa3b657bfdb9e4623866426597c34d9849eb289129d0aee1233d72519eee28bf9
+  data.tar.gz: 54c3df068e8e335708544f08c926b57d9712e280895ccc0796352d356732a397f0690b4ce959155f44a4117b9f8bfa2e1fda38b10fc07175f4af8a10041f705a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Metrics/LineLength:
+  Max: 100
+

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.4.1

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+sudo: required
+
+env:
+  - DOCKER_COMPOSE_VERSION=1.16.1
+
+before_install:
+  - docker version
+  - docker-compose version
+  - sudo apt-get update
+  - sudo apt-get -y -o Dpkg::Options::="--force-confnew" install docker-ce
+  - gem install bundler -v 1.15.4
+  - sudo rm /usr/local/bin/docker-compose
+  - curl -L https://github.com/docker/compose/releases/download/${DOCKER_COMPOSE_VERSION}/docker-compose-`uname -s`-`uname -m` > docker-compose
+  - chmod +x docker-compose
+  - sudo mv docker-compose /usr/local/bin
+  - docker version
+  - docker-compose version
+
+rvm:
+  - 2.4.1
+
+services:
+  - docker

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec name: 'docker_compose_env'
+gemspec name: 'docker_compose_env_rails'

data/LICENSE

@@ -0,0 +1,23 @@
+
+Copyright (c) 2017 Jonathan Knapp
+
+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,114 @@
+# DockerComposeEnv
+
+Simplify configuration between Docker Compose and Ruby/Rails apps in development.
+
+If you run Rails outside of Docker, this helps your application play be a better
+first class citizen with your dev machine by utilizing dynamic port mapping in
+Docker Compose services.
+
+To read more about the problems this gem solves, check out the
+[Why Does This Exist?](docs/why.md) documentation.
+
+If your team is comfortable running Rails inside a container or you are looking
+for a production solution for service discovery, this is _not_ what you want.
+
+
+## Installation / Usage
+
+For a Rails app, add this gem to your Gemfile in the development / test groups.
+
+```ruby
+group :development, :test do
+  gem 'docker_compose_env_rails'
+end
+```
+
+You will now have new `ENV` properties set from the `docker-compose.yml` file
+in your project directory. The following compose config would assign
+`ENV['DB_HOST']` and `ENV['DB_PORT_5432']` to the values returned
+from running `docker-compose port db 5432`, the host and dynamically mapped
+port assigned after you ran `docker-compose up`.
+
+```yaml
+version: '3.3'
+
+services:
+  db:
+    image: postgres:9.6-alpine
+    env_file: .env
+    ports:
+      - "5432"
+```
+
+That means your Rails `config/database.yml` file could look like:
+
+```yaml
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  host: <%= ENV['DB_HOST'].to_i %>
+  password: example
+  pool: 5
+  port: <%= ENV['DB_PORT_5432'].to_i %>
+  username: postgres
+
+development:
+  <<: *default
+  database: app
+
+test:
+  <<: *default
+  database: app_test
+```
+
+### Load Faster!
+
+If you need to load the dynamic port information faster than the
+`before_configuration` call in `Railties`, you can add the `docker_compose_env`
+gem higher up in the `Gemfile` and load it with a special require path:
+
+```ruby
+gem `docker_compose_env`, require: 'docker_compose_env/now'
+```
+
+### Further Customization
+
+Unfortunately, there's only so much automagic that can be done. If you need to
+customize the `docker-compose.yml` file name or location, or if you'd like to
+collect the dynamic information somewhere besides `ENV`, you will need to
+require the `docker_compose_env` gem and set it up yourself.
+
+```ruby
+# expects docker-compose.yml file and adds values to ENV
+DockerComposeEnv.setup!
+
+# customize docker-compose.yml path and adds values to ENV
+DockerComposeEnv.setup!(file: 'docker/docker-compose.dev.yml')
+
+# add dynamic values to custom object instead of ENV
+config = {}
+DockerComposeEnv.setup!(env: config)
+puts config
+
+# add dynamic values to custom object instead of ENV and custom compose path
+config = {}
+DockerComposeEnv.setup!(env: config, file: 'custom/path.yml')
+puts config
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CoffeeAndCode/docker_compose_env.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler/gem_helper'
+require 'rake/testtask'
+
+namespace 'docker_compose_env' do
+  Bundler::GemHelper.install_tasks name: 'docker_compose_env'
+end
+
+namespace 'docker_compose_env_rails' do
+  Bundler::GemHelper.install_tasks name: 'docker_compose_env_rails'
+end
+
+task build: ['docker_compose_env:build', 'docker_compose_env_rails:build']
+task install: ['docker_compose_env:install', 'docker_compose_env_rails:install']
+task release: ['docker_compose_env:release', 'docker_compose_env_rails:release']
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'docker_compose_env'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/lint

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+bundle exec reek
+bundle exec rubocop

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/docker_compose_env.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docker_compose_env/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'docker_compose_env'
+  spec.version = DockerComposeEnv::VERSION
+  spec.authors = ['Jonathan Knapp']
+  spec.email = ['jon@coffeeandcode.com']
+
+  # rubocop:disable LineLength
+  spec.description = 'Simplify configuration between Docker Compose and Ruby/Rails apps in development.'
+  # rubocop:enable LineLength
+  spec.summary = spec.description
+  spec.homepage = 'https://github.com/CoffeeAndCode/docker_compose_env'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(features|spec|test)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'minitest', '~> 5.10'
+end

data/docker_compose_env_rails.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docker_compose_env/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'docker_compose_env_rails'
+  spec.version = DockerComposeEnv::VERSION
+  spec.authors = ['Jonathan Knapp']
+  spec.email = ['jon@coffeeandcode.com']
+
+  spec.description = 'Automate docker_compose_env in Rails.'
+  spec.summary = spec.description
+  spec.homepage = 'https://github.com/CoffeeAndCode/docker_compose_env'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(features|spec|test)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'docker_compose_env', DockerComposeEnv::VERSION
+  spec.add_dependency 'railties', '>= 3.2', '< 5.2'
+end

data/docs/why.md

@@ -0,0 +1,116 @@
+# Why Does This Exist?
+
+I've repeatedly ran into configuration issues integrating Docker into my team's
+development environment. While I love what containers can bring to bootstrapping
+a project, I'm not sold on moving my development environment into a Docker
+container. That means, niceities that I could depend on (like easy mapping to
+other services) falls short and I end up having to map ports to developer host
+machines. This creates problems when those ports are already in use and there
+was no simple solution (that I found) to address simplifying configuration.
+
+
+### The Problem
+
+If you run your Ruby and/or Rails application outside of a Docker container,
+you normally have to hardcode the port mapping to connect to services managed
+by Docker Compose. For example, running a Rails application that connects with
+a Postgres Docker container would include the following:
+
+_.env_
+
+```bash
+POSTGRES_DB=app_db_name
+POSTGRES_PASSWORD=password
+POSTGRES_USER=postgres
+```
+
+_config/database.yml_
+
+```yaml
+development: &development
+  adapter: postgresql
+  database: <%= ENV['POSTGRES_DB'] %>_dev
+  encoding: unicode
+  host: 127.0.0.1
+  password: <%= ENV['POSTGRES_PASSWORD'] %>
+  pool: 5
+  port: 5432
+  username: <%= ENV['POSTGRES_USER'] %>
+
+test:
+  <<: *development
+  database: <%= ENV['POSTGRES_DB'] %>_test
+```
+
+_docker-compose.yml_
+
+```yaml
+version: '3.3'
+
+services:
+  postgres:
+    image: postgres:9.6-alpine
+    env_file: .env
+    ports:
+      - "5432:5432"
+```
+
+The good part is that this works just fine. However there are a few situations
+where things start to fall down.
+
+If you want to run your application on a machine that already has something
+listening on that port, Docker Compose will be unable to map the port properly
+(since it's already in use). That means if anyone has `mysql` or `postgres`
+installed through Homebrew, there will need to be additional notes for them
+to know how to work with your application.
+
+If you happen to work on multiple Rails applications at the same time, you may
+run into multiple projects each competing for the same local port mappings.
+Solutions such as hardcoding a different port to map to per project work, but
+add to the cognative overhead of working with the project.
+
+
+### The Solution
+
+Instead of worrying about additional setup for your application, setup
+Docker Compose to work with dynamic port assignments and inform your application
+of the final ports to map to. This allows your configuration to look like this:
+
+_.env_
+
+```bash
+POSTGRES_DB=app_db_name
+POSTGRES_PASSWORD=password
+POSTGRES_USER=postgres
+```
+
+_config/database.yml_
+
+```yaml
+development: &development
+  adapter: postgresql
+  database: <%= ENV['POSTGRES_DB'] %>_dev
+  encoding: unicode
+  host: <%= ENV['POSTGRES_HOST'] %> # dynamically setup by gem (probably 0.0.0.0)
+  password: <%= ENV['POSTGRES_PASSWORD'] %>
+  pool: 5
+  port: <%= ENV['POSTGRES_PORT_5432'] %> # dynamically setup by gem
+  username: <%= ENV['POSTGRES_USER'] %>
+
+test:
+  <<: *development
+  database: <%= ENV['POSTGRES_DB'] %>_test
+```
+
+_docker-compose.yml_
+
+```yaml
+version: '3.3'
+
+services:
+  postgres:
+    image: postgres:9.6-alpine
+    env_file: .env
+    ports:
+      - "5432" # do not explicitly mention host port to map to
+```

data/lib/docker_compose_env/now.rb

@@ -0,0 +1,10 @@
+# If you use gems that require environment variables to be set before they are
+# loaded, then list `docker_compose_env` in the `Gemfile` before those
+# other gems and require `docker_compose_env/now`.
+#
+#     gem 'docker_compose_env', require: 'docker_compose_env/now'
+#     gem 'gem_that_requires_env_variables'
+#
+
+require 'docker_compose_env'
+DockerComposeEnv.setup!

data/lib/docker_compose_env/railtie.rb

@@ -0,0 +1,9 @@
+require 'docker_compose_env'
+require 'rails'
+
+module DockerComposeEnv
+  # Setup DockerComposeEnv before Rails initializers.
+  class Railtie < Rails::Railtie
+    config.before_configuration { DockerComposeEnv.setup! }
+  end
+end

data/lib/docker_compose_env/version.rb

@@ -0,0 +1,3 @@
+module DockerComposeEnv
+  VERSION = '0.1.0'.freeze
+end

data/lib/docker_compose_env.rb

@@ -0,0 +1,46 @@
+require 'docker_compose_env/version'
+require 'yaml'
+
+# The main module for DockerComposeEnv, this provides a single "easy mode"
+# method for setting up the environment.
+module DockerComposeEnv
+  def self.setup!(env: ENV, file: 'docker-compose.yml')
+    config = YAML.safe_load(File.read(file))
+
+    config.fetch('services', {}).keys.each do |service_name|
+      (config['services'][service_name]['ports'] || []).each do |container_port|
+        if /(\d+)\/udp$/ =~ container_port
+          parsed_port = /(?<port>\d+)\/udp$/.match(container_port).named_captures['port']
+
+          command = "docker-compose --file=#{file} port --protocol=udp #{service_name} #{parsed_port}"
+          compose_port_info = `#{command}`
+
+          if (compose_port_info =~ /^0\.0\.0\.0\:\d+\s*$/) == 0
+            if env["#{service_name.upcase}_HOST"].nil?
+              env["#{service_name.upcase}_HOST"] = '0.0.0.0'
+            end
+
+            if env["#{service_name.upcase}_PORT_#{parsed_port}_UDP"].nil?
+              env["#{service_name.upcase}_PORT_#{parsed_port}_UDP"] = compose_port_info.gsub(/0\.0\.0\.0:(\d+)\s*/, '\1')
+            end
+          end
+        else
+          command = "docker-compose --file=#{file} port #{service_name} #{container_port}"
+          compose_port_info = `#{command}`
+
+          if (compose_port_info =~ /^0\.0\.0\.0\:\d+\s*$/) == 0
+            if env["#{service_name.upcase}_HOST"].nil?
+              env["#{service_name.upcase}_HOST"] = '0.0.0.0'
+            end
+
+            if env["#{service_name.upcase}_PORT_#{container_port}"].nil?
+              env["#{service_name.upcase}_PORT_#{container_port}"] = compose_port_info.gsub(/0\.0\.0\.0:(\d+)\s*/, '\1')
+            end
+          end
+        end
+      end
+    end
+  rescue Errno::ENOENT => exception
+    raise exception unless exception.message == 'No such file or directory - docker-compose'
+  end
+end

data/lib/docker_compose_env_rails.rb

@@ -0,0 +1 @@
+require 'docker_compose_env/railtie'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: docker_compose_env
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Knapp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  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: rubocop
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+description: Simplify configuration between Docker Compose and Ruby/Rails apps in
+  development.
+email:
+- jon@coffeeandcode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".tool-versions"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/lint
+- bin/setup
+- docker_compose_env.gemspec
+- docker_compose_env_rails.gemspec
+- docs/why.md
+- lib/docker_compose_env.rb
+- lib/docker_compose_env/now.rb
+- lib/docker_compose_env/railtie.rb
+- lib/docker_compose_env/version.rb
+- lib/docker_compose_env_rails.rb
+homepage: https://github.com/CoffeeAndCode/docker_compose_env
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Simplify configuration between Docker Compose and Ruby/Rails apps in development.
+test_files: []