dip 4.2.0 → 5.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de28bb80ddff1548082c5b8ccd0115bcd650cbdba9a930c666b02751cf0ba976
-  data.tar.gz: 96a4a6d5b2f78b559ef429f793e1899ec8d35edc7f10ac90693632b8a9e2be06
+  metadata.gz: 0de34f9ada82a4cdfc8f56dd7edbba913e502ec08b8975344389c61e534bfd89
+  data.tar.gz: 55def66126d5b484529d895a00121b55552bdebcbbfe9e72f73a679b0cae744b
 SHA512:
-  metadata.gz: 404af36fd19249124ab8bf8ce3f765c03f8e72ef9d6c1138424704233caf543c7ce2cf8ea7a86ece144407597bfba895cdb140ef277aa71042201a77221c974c
-  data.tar.gz: 4b788801e5c6e73e259f0de5b4c137aa5dcce5a7e681dae1d21b2c403118cdafdf0870c22bd80be350c25f943e100930c0f8296927898196e0c812e0f1f66254
+  metadata.gz: 06f6595f1387da56159c717a13ee4116b76debbd87dc20204909d2e723ff2a00e7e51895dc2fb55eb9fa7e4115151b58d2fc4573ffd3076bf8b1382e44ee101d
+  data.tar.gz: c17f4ed583c96c557c6e59479e822be00bb6d390e535108acda62493e3ab93bf502eaa8b2bab7636af3c63cd1f88532f3f2bf95b31166dceb9c0f148ac64c438

data/README.md

@@ -17,7 +17,7 @@ A command-line utility that gives the "native" interaction with applications con
 
 - [Local development with Docker containers](https://slides.com/bibendi/dip)
 - Dockerized Ruby on Rails applications: [one](https://github.com/bibendi/dip-example-rails), [two](https://github.com/evilmartians/evil_chat)
-- [Dockerized Node.js application](https://github.com/bibendi/yt-graphql-react-event-booking-api)
+- Dockerized Node.js application: [one](https://github.com/bibendi/twinkle.js), [two](https://github.com/bibendi/yt-graphql-react-event-booking-api)
 - [Dockerized Ruby gem](https://github.com/bibendi/schked)
 
 [![asciicast](https://asciinema.org/a/210236.svg)](https://asciinema.org/a/210236)
@@ -98,13 +98,13 @@ dip SUBCOMMAND --help
 
 ### dip.yml
 
-The configuration file `dip.yml` should be placed in a project root directory.
+The configuration is loaded from `dip.yml` file. It may be located in a working directory, or it will be found in the nearest parent directory up to the file system root. If nearby places `dip.override.yml` file, it will be merged into the main config.
+
 Also, in some cases, you may want to change the default config path by providing an environment variable `DIP_FILE`.
-If nearby places `dip.override.yml` file it would be merged into the main config.
 
 Below is an example of a real config.
-`dip.yml` reference will be written soon.
-Also, you can check out examples in the top.
+Config file reference will be written soon.
+Also, you can check out examples at the top.
 
 ```yml
 # Required minimum dip version
@@ -124,6 +124,7 @@ interaction:
   bash:
     description: Open the Bash shell in app's container
     service: app
+    command: bash
     compose:
       run_options: [no-deps]
 
@@ -153,7 +154,7 @@ interaction:
         description: Run Rails server at http://localhost:3000
         service: web
         compose:
-          run_options: [service-ports]
+          run_options: [service-ports, use-aliases]
 
   sidekiq:
     description: Run sidekiq in background
@@ -174,6 +175,44 @@ provision:
   - dip bash -c ./bin/setup
 ```
 
+### Predefined environment variables
+
+#### $DIP_OS
+
+Current OS architecture (e.g. `linux`, `darwin`, `freebsd`, and so on). Sometime it may be useful to have one common `docker-compose.yml` and OS-dependent Compose configs.
+
+#### $DIP_WORK_DIR_REL_PATH
+
+Relative path from the current directory to the nearest directory where a Dip's config is found. It is useful when you need to mount a specific local directory to a container along with ability to change its working dir. For example:
+
+```
+- project_root
+  |- dip.yml (1)
+  |- docker-compose.yml (2)
+  |- sub-project-dir
+     |- your current directory is here <<<
+```
+
+```yml
+# dip.yml (1)
+environment:
+  WORK_DIR: /app/${DIP_WORK_DIR_REL_PATH}
+```
+
+```yml
+# docker-compose.yml (2)
+services:
+  app:
+    working_dir: ${WORK_DIR:-/app}
+```
+
+```sh
+cd sub-project-dir
+dip run bash -c pwd
+```
+
+returned is `/app/sub-project-dir`.
+
 ### dip run
 
 Run commands defined within the `interaction` section of dip.yml
@@ -183,16 +222,27 @@ dip run rails c
 dip run rake db:migrate
 ```
 
-`run` argument can be omitted
+Also, `run` argument can be omitted
 
 ```sh
 dip rake db:migrate
+```
+
+You can pass in a custom environment variable into a container:
+
+```sh
 dip VERSION=12352452 rake db:rollback
 ```
 
+Use options `-p, --publish=[]` if you need to additionally publish a container's port(s) to the host unless this behaviour is not configured at dip.yml:
+
+```sh
+dip run -p 3000:3000 bundle exec rackup config.ru 
+```
+
 ### dip ls
 
-List al available run commands.
+List all available run commands.
 
 ```sh
 dip ls

data/exe/dip

@@ -4,16 +4,16 @@
 lib_path = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
 
+begin
+  require 'pry-byebug' if ENV["DIP_ENV"] == "debug"
+rescue LoadError # rubocop:disable Lint/SuppressedException
+  # do nothing
+end
+
 require 'dip'
 require 'dip/cli'
 require 'dip/run_vars'
 
-begin
-  require 'pry-byebug' if Dip.debug?
-rescue LoadError
-  puts "pry-byebug not found!"
-end
-
 Signal.trap('INT') do
   warn("\n#{caller.join("\n")}: interrupted")
   exit(1)

data/lib/dip.rb

@@ -11,7 +11,7 @@ module Dip
     end
 
     def env
-      @env ||= Dip::Environment.new(Dip::Config.exist? ? config.environment : {})
+      @env ||= Dip::Environment.new(config.exist? ? config.environment : {})
     end
 
     def bin_path

data/lib/dip/cli.rb

@@ -5,6 +5,8 @@ require 'dip/run_vars'
 
 module Dip
   class CLI < Thor
+    TOP_LEVEL_COMMANDS = %w[help version ls compose up stop down run provision ssh dns nginx console].freeze
+
     class << self
       # Hackery. Take the run method away from Thor so that we can redefine it.
       def is_thor_reserved_word?(word, type)
@@ -13,24 +15,24 @@ module Dip
         super
       end
 
-      def start(argv)
-        super Dip::RunVars.call(argv, ENV)
+      def exit_on_failure?
+        true
       end
-    end
 
-    stop_on_unknown_option! :up
+      def start(argv)
+        argv = Dip::RunVars.call(argv, ENV)
 
-    def method_missing(cmd, *args)
-      if Dip.config.interaction.key?(cmd.to_sym)
-        self.class.start(["run", cmd.to_s, *args])
-      else
-        super
+        cmd = argv.first
+
+        if cmd && !TOP_LEVEL_COMMANDS.include?(cmd) && Dip.config.exist? && Dip.config.interaction.key?(cmd.to_sym)
+          argv.unshift("run")
+        end
+
+        super Dip::RunVars.call(argv, ENV)
       end
     end
 
-    def respond_to_missing?(cmd)
-      Dip.config.interaction.key?(cmd.to_sym)
-    end
+    stop_on_unknown_option! :run
 
     desc 'version', 'dip version'
     def version
@@ -66,10 +68,17 @@ module Dip
       compose("down", *argv)
     end
 
-    desc 'CMD or dip run CMD [OPTIONS]', 'Run configured command in a docker-compose service'
+    desc 'run [OPTIONS] CMD [ARGS]', 'Run configured command in a docker-compose service. `run` prefix may be omitted'
+    method_option :publish, aliases: '-p', type: :string, repeatable: true,
+                            desc: "Publish a container's port(s) to the host"
+    method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
     def run(*argv)
-      require_relative 'commands/run'
-      Dip::Commands::Run.new(*argv).execute
+      if argv.empty? || options[:help]
+        invoke :help, ['run']
+      else
+        require_relative 'commands/run'
+        Dip::Commands::Run.new(*argv, publish: options[:publish]).execute
+      end
     end
 
     desc "provision", "Execute commands within provision section"

data/lib/dip/cli/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Dip
+  class CLI
+    class Base < Thor
+      def self.exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/dip/cli/console.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require 'thor'
+require_relative "./base"
 require_relative "../commands/console"
 
 module Dip
   class CLI
-    class Console < Thor
+    class Console < Base
       desc "start", "Integrate Dip into current shell"
       method_option :help, aliases: '-h', type: :boolean,
                            desc: 'Display usage information'

data/lib/dip/cli/dns.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 require 'thor'
+require_relative "./base"
 require_relative "../commands/dns"
 
 module Dip
   class CLI
     # See more https://github.com/aacebedo/dnsdock
-    class DNS < Thor
+    class DNS < Base
       desc "up", "Run dnsdock container"
       method_option :help, aliases: '-h', type: :boolean,
                            desc: 'Display usage information'

data/lib/dip/cli/nginx.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 require 'thor'
+require_relative "./base"
 require_relative "../commands/nginx"
 
 module Dip
   class CLI
     # See more https://github.com/bibendi/nginx-proxy
-    class Nginx < Thor
+    class Nginx < Base
       desc "up", "Run nginx container"
       method_option :help, aliases: '-h', type: :boolean,
                            desc: 'Display usage information'
@@ -16,7 +17,7 @@ module Dip
                              desc: 'Path to docker socket'
       method_option :net, aliases: '-t', type: :string, default: "frontend",
                           desc: 'Container network name'
-      method_option :publish, aliases: '-p', type: :array, default: "80:80",
+      method_option :publish, aliases: '-p', type: :array, default: ["80:80"],
                               desc: 'Container port(s). For more than one port, separate them by a space'
       method_option :image, aliases: '-i', type: :string, default: "bibendi/nginx-proxy:latest",
                             desc: 'Docker image name'

data/lib/dip/cli/ssh.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require 'thor'
+require_relative "./base"
 require_relative "../commands/ssh"
 
 module Dip
   class CLI
-    class SSH < Thor
+    class SSH < Base
       desc "up", "Run ssh-agent container"
       method_option :help, aliases: '-h', type: :boolean,
                            desc: 'Display usage information'

data/lib/dip/commands/compose.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'pathname'
+
 require_relative '../command'
 require_relative 'dns'
 
@@ -29,12 +31,14 @@ module Dip
         return unless (files = config[:files])
 
         if files.is_a?(Array)
-          files.each_with_object([]) do |file_name, memo|
-            file_name = ::Dip.env.interpolate(file_name)
-            next unless File.exist?(file_name)
+          files.each_with_object([]) do |file_path, memo|
+            file_path = ::Dip.env.interpolate(file_path)
+            file_path = Pathname.new(file_path)
+            file_path = Dip.config.file_path.parent.join(file_path).expand_path if file_path.relative?
+            next unless file_path.exist?
 
             memo << "--file"
-            memo << file_name
+            memo << file_path.to_s
           end
         end
       end

data/lib/dip/commands/console.rb

@@ -86,7 +86,7 @@ module Dip
         end
 
         def execute
-          if Dip::Config.exist?
+          if Dip.config.exist?
             add_aliases(*Dip.config.interaction.keys) if Dip.config.interaction
             add_aliases("compose", "up", "stop", "down", "provision")
           end

data/lib/dip/commands/run.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'shellwords'
+require_relative '../../../lib/dip/run_vars'
 require_relative '../command'
 require_relative '../interaction_tree'
 require_relative 'compose'
@@ -8,7 +9,9 @@ require_relative 'compose'
 module Dip
   module Commands
     class Run < Dip::Command
-      def initialize(cmd, *argv)
+      def initialize(cmd, *argv, publish: nil)
+        @publish = publish
+
         @command, @argv = InteractionTree.
                           new(Dip.config.interaction).
                           find(cmd, *argv)&.
@@ -28,13 +31,14 @@ module Dip
 
       private
 
-      attr_reader :command, :argv
+      attr_reader :command, :argv, :publish
 
       def compose_arguments
         compose_argv = command[:compose][:run_options].dup
 
         if command[:compose][:method] == "run"
           compose_argv.concat(run_vars)
+          compose_argv.concat(published_ports)
           compose_argv << "--rm"
         end
 
@@ -55,6 +59,14 @@ module Dip
 
         run_vars.map { |k, v| ["-e", "#{k}=#{v}"] }.flatten
       end
+
+      def published_ports
+        if publish.respond_to?(:each)
+          publish.map { |p| "--publish=#{p}" }
+        else
+          []
+        end
+      end
     end
   end
 end

data/lib/dip/config.rb

@@ -2,6 +2,7 @@
 
 require "yaml"
 require "erb"
+require "pathname"
 
 require "dip/version"
 require "dip/ext/hash"
@@ -12,47 +13,89 @@ module Dip
   class Config
     DEFAULT_PATH = "dip.yml"
 
-    class << self
-      def exist?
-        File.exist?(path)
+    class ConfigFinder
+      attr_reader :file_path
+
+      def initialize(work_dir, override: false)
+        @override = override
+
+        @file_path = if ENV["DIP_FILE"]
+                       Pathname.new(prepared_name(ENV["DIP_FILE"]))
+                     else
+                       find(Pathname.new(work_dir))
+                     end
       end
 
-      def path
-        ENV["DIP_FILE"] || File.join(Dir.pwd, DEFAULT_PATH)
+      def exist?
+        file_path&.exist?
       end
 
-      def override_path
+      private
+
+      attr_reader :override
+
+      def prepared_name(path)
+        return path unless override
+
         path.gsub(/\.yml$/, ".override.yml")
       end
 
+      def find(path)
+        file = path.join(prepared_name(DEFAULT_PATH))
+        return file if file.exist?
+        return if path.root?
+
+        find(path.parent)
+      end
+    end
+
+    class << self
       def load_yaml(file_path = path)
         return {} unless File.exist?(file_path)
 
         YAML.safe_load(
           ERB.new(File.read(file_path)).result,
           [], [], true
-        ).deep_symbolize_keys!
+        )&.deep_symbolize_keys! || {}
       end
     end
 
-    %i[environment compose interaction provision].each do |key|
-      define_method(key) do
-        config[key]
-      end
+    def initialize(work_dir = Dir.pwd)
+      @work_dir = work_dir
+    end
+
+    def file_path
+      finder.file_path
+    end
+
+    def exist?
+      finder.exist?
     end
 
     def to_h
       config
     end
 
+    %i[environment compose interaction provision].each do |key|
+      define_method(key) do
+        config[key]
+      end
+    end
+
     private
 
+    attr_reader :work_dir
+
+    def finder
+      @finder ||= ConfigFinder.new(work_dir)
+    end
+
     def config
       return @config if @config
 
-      raise ArgumentError, "Dip config not found at path '#{self.class.path}'" unless self.class.exist?
+      raise Dip::Error, "Could not find dip.yml config" unless finder.exist?
 
-      config = self.class.load_yaml
+      config = self.class.load_yaml(finder.file_path)
 
       unless Gem::Version.new(Dip::VERSION) >= Gem::Version.new(config.fetch(:version))
         raise VersionMismatchError, "Your dip version is `#{Dip::VERSION}`, " \
@@ -60,7 +103,8 @@ module Dip
                                     "Please upgrade your dip!"
       end
 
-      config.deep_merge!(self.class.load_yaml(self.class.override_path))
+      override_finder = ConfigFinder.new(work_dir, override: true)
+      config.deep_merge!(self.class.load_yaml(override_finder.file_path)) if override_finder.exist?
 
       @config = config
     end

data/lib/dip/environment.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require "pathname"
+
 module Dip
   class Environment
     VAR_REGEX = /\$[\{]?(?<var_name>[a-zA-Z_][a-zA-Z0-9_]*)[\}]?/.freeze
-    SPECIAL_VARS = {"DIP_OS" => :find_dip_os}.freeze
+    SPECIAL_VARS = %i[os work_dir_rel_path].freeze
 
     attr_reader :vars
 
@@ -24,6 +26,10 @@ module Dip
       vars.fetch(name) { ENV[name] }
     end
 
+    def fetch(name)
+      vars.fetch(name) { ENV.fetch(name) { yield } }
+    end
+
     def []=(key, value)
       @vars[key] = value
     end
@@ -32,8 +38,8 @@ module Dip
       value.gsub(VAR_REGEX) do
         var_name = Regexp.last_match[:var_name]
 
-        if SPECIAL_VARS.key?(var_name)
-          self[var_name] || send(SPECIAL_VARS[var_name])
+        if special_vars.key?(var_name)
+          fetch(var_name) { send(special_vars[var_name]) }
         else
           self[var_name]
         end
@@ -44,8 +50,18 @@ module Dip
 
     private
 
-    def find_dip_os
+    def special_vars
+      @special_vars ||= SPECIAL_VARS.each_with_object({}) do |key, memo|
+        memo["DIP_#{key.to_s.upcase}"] = "find_#{key}"
+      end
+    end
+
+    def find_os
       @dip_os ||= Gem::Platform.local.os
     end
+
+    def find_work_dir_rel_path
+      @find_work_dir_rel_path ||= Pathname.getwd.relative_path_from(Dip.config.file_path.parent).to_s
+    end
   end
 end

data/lib/dip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dip
-  VERSION = "4.2.0"
+  VERSION = "5.0.0.rc1"
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: dip
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 5.0.0.rc1
 platform: ruby
 authors:
 - bibendi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2019-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '0.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +142,7 @@ files:
 - exe/dip
 - lib/dip.rb
 - lib/dip/cli.rb
+- lib/dip/cli/base.rb
 - lib/dip/cli/console.rb
 - lib/dip/cli/dns.rb
 - lib/dip/cli/nginx.rb
@@ -172,9 +179,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.7