compote 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99486c3d153db32cab2c8d73aeef121c776763ac
+  data.tar.gz: 44dd7d9d41bbc8c55119b6a3e74ce7157b779d3c
+SHA512:
+  metadata.gz: 50e82f05fe8bdab08574c1bb7f078cebe3212d2156cce0545c64213fdfad0601d23974ef72ca5ab6cfd18e94795d55d0a9e61c9986d3098b4f5cca6a6d2fc8f9
+  data.tar.gz: fa6c01b6059c0a6fa4b898f344aaf10b04855f09e04b496617bd579c8f9620be1aa67c057db03071f62fa1aab4d0c35acfd772f85eed622a3d6ea7d0794c6487

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+
+/*.gem
+
+Gemfile.lock
+
+.rspec_status
+
+/notes

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dmitry Maganov
+
+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,103 @@
+# Compote
+
+Compote is a wrapper for docker-compose. It extends compose in two ways.
+
+Firstly, it adds additional fields in the config spec, main focus of those additions is to provide more flexibility with extending of services definitions.
+
+Second, it adds abitility to specify custom commands as node's package.json "scripts" field do.
+
+
+## Installation
+
+    $ gem install compote
+
+
+## Usage
+
+You use `compote` as you do `docker-compose` as all commands are redirected to it.
+
+Compote will search for `docker-compote.yml` file in current directory. You also can specify a path to a compote's config with env variable `COMPOTE_FILE`.
+
+Here are additions that compote brings.
+
+```yml
+version: '2.1' # currently only version 2.1 supported
+
+compote: # all additions live under compote key, here on top level and in a service definition
+
+  # extends
+  # allows to include definitions from other files
+  # it can be a single string, an array of strings
+  # it can also be a hash where keys are paths and values are objects with optional fields "except" and "only"
+  # only
+  # all paths resolved to a current compote config file
+  extends:
+    ../hello.yml: { only: [ 'volumes' ] }
+
+  # env_file
+  # can be a single string or array of strings
+  # if files specified they must exist
+  # if no file specified and there is .env file near config, it is used
+  env_file: .hello_env
+
+  # environment
+  # can be a hash or an array of definitions (like the environment field in a service definition)
+  environment:
+    COMPOSE_PROJECT_NAME: hello
+
+  # commands
+  # commands specified here will be available for invocation by "compote command KEY [ARGS...]"
+  # a resulted executed command will be "COMMAND [ARGS...]"
+  # commands executed in environment combined from shell ones, env_file and environment options.
+  # to list available commands call "compote commands"
+  commands:
+    hello: echo "hello"
+
+services:
+
+  hello:
+    image: hello
+    compote:
+
+      # extends
+      # same as extends in top compote settings, but with a name of a extended service after a colon
+      # this is not the same as usual service extends, as it recursively merges everything and
+      # does not care about ignoring some fields like docker-compose does
+      # you can reproduce compose way using "except" or "only" options
+      extends:
+        - ../hello.yml:hello
+        - ../hello.yml:world
+
+      # volumes, networks
+      # allow you to specify volumes and networks inside a service defintion
+      # those fields will be merged in top level ones for docker-compose consumption
+      # having those here simplifies extending of services
+      volumes: {}
+      networks: {}
+
+      # commands
+      # commands specified here will be available for invocation by "compote command SERVICE:KEY [ARGS...]"
+      # a resulted executed command will be "compote run [OPTIONS] SERVICE [COMMAND] [ARGS]"
+      # a command specified will be splited into two parts - run's options and a service command
+      # a service command starts at first argument not starting with a dash
+      commands:
+        world: --rm bash # it will execute "docker-compose run --rm hello bash"
+```
+
+
+## TODO
+
+- Tests with aruba.
+- Interpolation of env variables in compote fields.
+- Suggestions for misspelled commands.
+- Add some power to `only` and `except` extend options for specifying nested paths.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vonagam/compote.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+
+Dir.glob( 'config/gems/**/tasks.rake' ).each { | path | load path }
+
+
+task default: 'gem:rspec'

data/bin/pry

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+ENV[ 'BUNDLE_GEMFILE' ] ||= File.expand_path( '../../Gemfile', Pathname.new( __FILE__ ).realpath )
+
+require 'rubygems'
+
+require 'bundler/setup'
+
+
+require 'compote'
+
+
+load Gem.bin_path 'pry', 'pry'

data/bin/rake

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+ENV[ 'BUNDLE_GEMFILE' ] ||= File.expand_path( '../../Gemfile', Pathname.new( __FILE__ ).realpath )
+
+require 'rubygems'
+
+require 'bundler/setup'
+
+
+load Gem.bin_path 'rake', 'rake'

data/bin/rspec

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+ENV[ 'BUNDLE_GEMFILE' ] ||= File.expand_path( '../../Gemfile', Pathname.new( __FILE__ ).realpath )
+
+require 'rubygems'
+
+require 'bundler/setup'
+
+
+load Gem.bin_path 'rspec-core', 'rspec'

data/compote.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+
+lib = File.expand_path '../lib', __FILE__
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
+
+require 'compote/version'
+
+
+Gem::Specification.new do | spec |
+
+  spec.name          = 'compote'
+  spec.version       = Compote::VERSION
+  spec.authors       = [ 'Dmitry Maganov' ]
+  spec.email         = [ 'vonagam@gmail.com' ]
+
+  spec.summary       = 'Wrapper for docker-compose with additional features.'
+  spec.homepage      = 'https://github.com/vonagam/compote'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split( "\x0" ).reject { | path | path.match %r{^spec/} }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep( %r{^exe/} ) { | path | File.basename path }
+  spec.require_paths = [ 'lib' ]
+
+
+  spec.add_dependency 'thor', '~> 0.19' # cli builder - erikhuda/thor
+  spec.add_dependency 'json-schema', '~> 2.8' # json scheme validator - ruby-json-schema/json-schema
+  spec.add_dependency 'dotenv', '~> 2.2' # env variables from .env file - bkeepers/dotenv
+
+  spec.add_development_dependency 'bundler', '~> 1.14' # dependencies manager - bundler/bundler
+  spec.add_development_dependency 'rake', '~> 12.0' # tasks runner - ruby/rake
+  spec.add_development_dependency 'rspec', '~> 3.0' # test framework - rspec/rspec
+  spec.add_development_dependency 'aruba', '~> 0.14' # test framework - rspec/rspec
+
+  spec.add_development_dependency 'pry', '~> 0.10' # debug console - pry/pry
+  spec.add_development_dependency 'pry-rescue', '~> 1.4' # start debug on exception - conradirwin/pry-rescue
+  spec.add_development_dependency 'pry-stack_explorer', '~> 0.4' # moving in stack vertically - pry/pry-stack_explorer
+  spec.add_development_dependency 'pry-byebug', '~> 3.4' # moving in stack forward - deivid-rodriguez/pry-byebug
+  spec.add_development_dependency 'pry-inline', '~> 1.0' # view variables values inline - seikichi/pry-inline
+  spec.add_development_dependency 'pry-state', '~> 0.1' # view variables values - sudhagars/pry-state
+  spec.add_development_dependency 'pry-doc', '~> 0.10' # view ruby core classes documentation - pry/pry-doc
+
+end

data/config/gems/rspec/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/config/gems/rspec/tasks.rake

@@ -0,0 +1,9 @@
+namespace :gem do
+
+  task :rspec do
+
+    exec 'bin/rspec --options ./config/gems/rspec/.rspec'
+
+  end
+
+end

data/exe/compote

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'compote/cli'
+
+
+Compote::CLI.start

data/lib/compote.rb

@@ -0,0 +1,22 @@
+require 'json-schema'
+
+require 'dotenv'
+
+require 'yaml'
+
+require 'tempfile'
+
+
+module Compote
+
+  require 'compote/schema'
+
+  require 'compote/config'
+
+  require 'compote/service_config'
+
+  require 'compote/error'
+
+  require 'compote/version'
+
+end

data/lib/compote/cli.rb

@@ -0,0 +1,74 @@
+require 'compote'
+
+require 'thor'
+
+require 'shellwords'
+
+
+module Compote
+
+  class CLI < Thor
+
+    require 'compote/cli/compose'
+
+    require 'compote/cli/command'
+
+    require 'compote/cli/commands'
+
+    require 'compote/cli/env'
+
+    require 'compote/cli/help'
+
+    require 'compote/cli/version'
+
+    protected
+
+    def load_config
+
+      path = ENV.fetch 'COMPOTE_FILE', './docker-compote.yml'
+
+      config = Config.load_config path
+
+      config
+
+    end
+
+    def run_compose ( command, *arguments )
+
+      compote_config = load_config
+
+      compose_environment = compote_config.compose_environment
+
+      compose_file = compote_config.compose_file
+
+      system compose_environment, 'docker-compose', '-f', compose_file.path, command, *arguments
+
+      exit_status = $?.exitstatus
+
+      compose_file.unlink
+
+      exit exit_status
+
+    rescue Error => error
+
+      compose_file&.unlink
+
+      exit_with_error error
+
+    ensure
+
+      compose_file&.unlink
+
+    end
+
+    def exit_with_error ( error )
+
+      say error.message, :red
+
+      exit 1
+
+    end
+
+  end
+
+end

data/lib/compote/cli/command.rb

@@ -0,0 +1,69 @@
+module Compote
+
+  class CLI < Thor
+
+    desc 'command', 'Run command specified in docker-compote config'
+
+    def command ( key, *arguments )
+
+      config = load_config
+
+      commands = config.commands
+
+      command = commands[ key ]
+
+      service_name, command_name = key.include?( ':' ) ? key.split( ':' ) : [ nil, key ]
+
+      raise UndefinedCommandError.new service_name: service_name, command_name: command_name, config: config unless command
+
+      arguments = [ *Shellwords.split( command ), *arguments ]
+
+      say "Running compote command \"#{ key }\":"
+
+      if service_name
+
+        run_arguments, command_arguments = split_arguments arguments
+
+        arguments = [ 'run', *run_arguments, service_name, *command_arguments ]
+
+        say Shellwords.join [ 'compote', *arguments ]
+
+        run_compose *arguments
+
+      else
+
+        say Shellwords.join arguments
+
+        environment = config.compose_environment
+
+        exec environment, *arguments
+
+      end
+
+    rescue Error => error
+
+      exit_with_error error
+
+    end
+
+    protected
+
+    def split_arguments ( arguments )
+
+      is_run_option = true
+
+      run_arguments, command_arguments = arguments.partition do | argument |
+
+        is_run_option &&= argument.match? /\A-/
+
+        is_run_option
+
+      end
+
+      [ run_arguments, command_arguments ]
+
+    end
+
+  end
+
+end

data/lib/compote/cli/commands.rb

@@ -0,0 +1,31 @@
+module Compote
+
+  class CLI < Thor
+
+    desc 'commands', 'List commands specified in docker-compote config'
+
+    def commands
+
+      config = load_config
+
+      commands = config.commands
+
+      if commands.empty?
+
+        say 'No commands specified'
+
+      else
+
+        say commands.map { | key, command | "#{ key } -> #{ command }" }.join "\n"
+
+      end
+
+    rescue Error => error
+
+      exit_with_error error
+
+    end
+
+  end
+
+end