compose_env 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1bf18f7a179e46428c95da43b104a329ad6baaee09417dd7ddb5762569dbe1e
+  data.tar.gz: 5650f2d56eb29c9b210221d84bda6cee3e787cf56ef26cc3e9c485e4d88f7391
+SHA512:
+  metadata.gz: 413f3a347d870dc00ee8d79960d45d25aa56e4fa505bccd3e86049a5c1788160cfa870f63814e93dfd4e654559bc7ecbddeb6b0763e1fd3274ea7767ff4d1439
+  data.tar.gz: aba36b1196d817c832c7a947bdbef4e16ab4909abb4c13bed98554ddad3ccca45af2b17d717107b6ca40628dab09586baafc7e95d52aa29e0f28a40178d4be4d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-06-20
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at vanyazin@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in compose_env.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    compose_env (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  compose_env!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.20

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ivan Zinovyev
+
+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,144 @@
+# Compose Env
+
+Compile docker-compose files for different environments using an ERB template.
+
+The proposed approach might differ from the canonical way of handling multiple docker-compose environments and
+extending the services for specific cases. So it might worth it to check the official documentation describing how to
+[extend services](https://docs.docker.com/compose/extends/#multiple-compose-files) and also how to
+[add and override configuration](https://docs.docker.com/compose/extends/#adding-and-overriding-configuration).
+
+Anyway I find it sometimes easier to have the
+[Puppet-like ERB template](https://puppet.com/docs/puppet/6/lang_template_erb.html#lang_template_erb) which describes
+all the services in one place when building a small MVP application without a lot of dependencies.
+
+Usually I used a couple of Makefile instructions before, but it is just much simpler to have these several steps defined
+in one gem and be available as one executable command from the console. You can use boths: `compose_env` or
+`compose-env` that's up to you, both commands are equal.
+
+## Installation
+
+```bash
+gem install 'compose_env'
+```
+
+And then execute:
+
+    $ compose-env --help
+
+Or:
+
+    $ compose_env --help
+
+## Example
+
+Create a `docker-compose.yml.erb` file with the following content inside of your project directory:
+
+```yaml
+version: "3.9"
+services:
+  db:
+    image: postgres
+    volumes:
+      - ./tmp/db:/var/lib/postgresql/data
+    environment:
+      POSTGRES_PASSWORD: <%= !development? ? 'strong123password' : 'password' %>
+  web:
+    <% if env.production? %>
+    image: my_app:v0.1
+    <% else %>
+    build: .
+    <% end %>
+    command: bash -c "rm -f tmp/pids/server.pid && bundle exec rails s -p 3000 -b '0.0.0.0'"
+    volumes:
+      - .:/myapp
+    environment:
+      RAILS_ENV: <%= current_env %>
+    ports:
+      <% development do %>
+      - "3000:3000"
+      <% end %>
+      - "80:3000"
+    depends_on:
+      - db
+```
+
+Now execute the command:
+
+```bash
+compose-env -f docker-compose.yml.erb  -e production, development
+```
+
+The result will be the following:
+
+**docker-compose.development.yml**
+
+```yaml
+---
+version: '3.9'
+services:
+  db:
+    image: postgres
+    volumes:
+    - "./tmp/db:/var/lib/postgresql/data"
+    environment:
+      POSTGRES_PASSWORD: password
+  web:
+    build: "."
+    command: bash -c "rm -f tmp/pids/server.pid && bundle exec rails s -p 3000 -b
+      '0.0.0.0'"
+    volumes:
+    - ".:/myapp"
+    environment:
+      RAILS_ENV: development
+    ports:
+    - 3000:3000
+    - 80:3000
+    depends_on:
+    - db
+```
+
+**docker-compose.production.yml**
+
+```yaml
+---
+version: '3.9'
+services:
+  db:
+    image: postgres
+    volumes:
+    - "./tmp/db:/var/lib/postgresql/data"
+    environment:
+      POSTGRES_PASSWORD: strong123password
+  web:
+    image: my_app:v0.1
+    command: bash -c "rm -f tmp/pids/server.pid && bundle exec rails s -p 3000 -b
+      '0.0.0.0'"
+    volumes:
+    - ".:/myapp"
+    environment:
+      RAILS_ENV: production
+    ports:
+    - 80:3000
+    depends_on:
+    - db
+```
+
+As you can see the command provides you a couple of helper methods to pick out the proper configuration for
+each environment based on the environments passed to the `--envs` (or `-e`) option:
+
+`environment?` returns a boolean value for the particular environment and can be used with `if/else` operators.
+
+Which can be also used as a block of code. The code will be executed only if current environment statisfies the check.
+```
+<% environment do %>
+  # environment specific code here...
+<% end %>
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ComposeEnv project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/compose_env/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/compose-env

@@ -0,0 +1,2 @@
+#! /usr/bin/env ruby
+require File.expand_path('./compose_env.rb', __dir__)

data/bin/compose_env

@@ -0,0 +1,2 @@
+#! /usr/bin/env ruby
+require File.expand_path('./compose_env.rb', __dir__)

data/bin/compose_env.rb

@@ -0,0 +1,3 @@
+require File.expand_path('../lib/compose_env.rb', __dir__)
+
+ComposeEnv.run(ARGV)

data/compose_env.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/compose_env/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'compose_env'
+  spec.version       = ComposeEnv::VERSION
+  spec.authors       = ["Ivan Zinovyev"]
+  spec.email         = ["ivan@zinovyev.net"]
+
+  spec.summary       = 'Prepare docker-compose files for different environments from the ERB template.'
+  spec.description   = 'Prepare docker-compose files for different environments from the ERB template.'
+  spec.homepage      = 'https://github.com/zinovyev/compose_env'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.executables   = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_development_dependency 'pry'
+end

data/lib/compose_env.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'optparse'
+require 'erb'
+require 'yaml'
+require 'pry'
+require_relative "compose_env/version"
+require_relative "compose_env/input_parser"
+require_relative "compose_env/context"
+require_relative "compose_env/builder"
+
+module ComposeEnv
+  extend self
+
+  def run(argv)
+    options = InputParser.parse(argv)
+    Builder.new(options).build_compose_files!
+  end
+end

data/lib/compose_env/builder.rb

@@ -0,0 +1,49 @@
+module ComposeEnv
+  class Builder
+    attr_reader :options
+
+    def initialize(options)
+      @options = options
+    end
+
+    def build_compose_files
+      parse_all do |current_env, raw_yaml|
+        File.write(environment_file_name(current_env), raw_yaml)
+      end
+    end
+    alias build_compose_files! build_compose_files
+
+    def parse_all
+      options.envs.map do |current_env|
+        result = [current_env, parse_file(current_env)]
+        yield(*result) if block_given?
+
+        result
+      end.to_h
+    end
+
+    private
+
+    def environment_file_name(current_env)
+      Pathname.new(dirname).join("#{basename}.#{current_env}.yml").to_s
+    end
+
+    def basename
+      @basename ||= File.basename(options.file).split('.').first
+    end
+
+    def dirname
+      @dirname ||= File.dirname(options.file)
+    end
+
+    def parse_file(current_env)
+      env_context = Context.new(options, current_env).get_binding
+      raw_yaml = erb_template.result(env_context)
+      ::YAML.load(raw_yaml).to_yaml
+    end
+
+    def erb_template
+      @erb_template ||= ::ERB.new(File.read(options.file))
+    end
+  end
+end

data/lib/compose_env/context.rb

@@ -0,0 +1,73 @@
+require 'pry'
+module ComposeEnv
+  class Context
+    attr_reader :options, :current_env
+
+    def initialize(options, current_env)
+      @options = options
+      @current_env = current_env
+    end
+
+    def method_missing(name, *args, &block)
+      method_name = name.to_sym
+      return handle_test_method(method_name) if test_method?(method_name)
+      return handle_restriction_method(method_name, &block) if restriction_method?(method_name)
+
+      super
+    end
+
+    def env
+      self
+    end
+
+    def env?(*env_names, &block)
+      return unless block_given?
+
+      first_env = env_names.first
+      env_names = first_env.is_a?(Array) ? first_env : env_names
+      return unless env_names.map(&:to_sym).include?(current_env)
+
+      block.call(self)
+    end
+
+    def get_binding
+      binding
+    end
+
+    def handle_test_method(method_name)
+      return method_name == "#{current_env}?".to_sym
+    end
+
+    def handle_restriction_method(method_name, &block)
+      return unless block_given? && method_name == current_env
+
+      block.call(self)
+    end
+
+    def test_method?(method_name)
+      test_methods.include?(method_name)
+    end
+
+    def restriction_method?(method_name)
+      restriction_methods.include?(method_name)
+    end
+
+    def test_methods
+      @test_methods ||= env_methods[:test]
+    end
+
+    def restriction_methods
+      @restriction_methods ||= env_methods[:restriction]
+    end
+
+    def env_methods
+      return @env_methods unless @env_methods.nil?
+
+      options.envs.each_with_object({test: [], restriction: []}) do |env, acc|
+        test_method = "#{env}?".to_sym
+        acc[:test] << test_method
+        acc[:restriction] << env
+      end
+    end
+  end
+end

data/lib/compose_env/input_parser.rb

@@ -0,0 +1,58 @@
+module ComposeEnv
+  # Parse input options.
+  # Prepare the options for being pipelined to the follow-up processors.
+  class InputParser
+    DEFAULT_ENVS = %i[development staging production].freeze
+    DEFAULT_FILE = 'docker-compose.yml.erb'.freeze
+
+    Options = Struct.new(:envs, :file)
+
+    def self.parse(options)
+      new.parse(options)
+    end
+
+    def parse(options)
+      prepared_options = prepare(options)
+      option_parser.parse!(prepared_options)
+      return args
+    end
+
+    private
+
+    def option_parser
+      OptionParser.new do |opts|
+        opts.banner = "Usage: compose-env [options]"
+
+        opts.on("-eENVIROMENTS", "--envs=ENVIRONMENTS", "List of environments") do |envs|
+          args.envs = normalize_envs(envs)
+        end
+
+        opts.on("-fFILE", "--file=FILE", "The name of a template file to parse") do |file|
+          args.file = normalize_file(file)
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          exit
+        end
+      end
+    end
+
+    def args
+      @args ||= Options.new(DEFAULT_ENVS, normalize_file(DEFAULT_FILE))
+    end
+
+    def normalize_envs(envs)
+      envs.split(',').map(&:strip).map(&:to_sym)
+    end
+
+    def normalize_file(file)
+      Pathname.new(Dir.pwd).join(file).to_s
+    end
+
+    # Prepare a comma separated string to be parsed as one argument even with whitespaces in it
+    def prepare(options)
+      options.join(' ').gsub(/\s*,\s*/, ',').split(' ')
+    end
+  end
+end

data/lib/compose_env/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ComposeEnv
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: compose_env
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Zinovyev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: Prepare docker-compose files for different environments from the ERB
+  template.
+email:
+- ivan@zinovyev.net
+executables:
+- compose-env
+- compose_env
+- compose_env.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/compose-env
+- bin/compose_env
+- bin/compose_env.rb
+- compose_env.gemspec
+- lib/compose_env.rb
+- lib/compose_env/builder.rb
+- lib/compose_env/context.rb
+- lib/compose_env/input_parser.rb
+- lib/compose_env/version.rb
+homepage: https://github.com/zinovyev/compose_env
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zinovyev/compose_env
+  source_code_uri: https://github.com/zinovyev/compose_env
+  changelog_uri: https://github.com/zinovyev/compose_env/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Prepare docker-compose files for different environments from the ERB template.
+test_files: []