dip 7.1.3 → 7.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42ac21bbebf1b0ad111a5bc783a9a539ad9b27bf6ef46b6e64fb3a6109f87005
-  data.tar.gz: 8988eb2450aaa51ddfacc05749405fdc1879da5f622bc130fb8d4a64af0b7359
+  metadata.gz: fd70c4af79fd861df4bfdb85662727067ad86b0b6705483ffbaf47818bf1a914
+  data.tar.gz: adacf1505575f58dbfeff69377dd65a17bf883029e4108ea1ba678b41cfc7106
 SHA512:
-  metadata.gz: f9f6c9e006584fa20d7d42b4586b8b35a5908aa8f1587f4ca506cb42445b786db5a569033af8f466606db015c681458b6f961221afef360d0b7558cf941fa631
-  data.tar.gz: f77739aa2ffc4c245630732c88f2264a4c83421d1dc8b83807776d8c2eac507b991743aa3e482a117edcfc0424deb3e4a93785e69c9a46e47fb8d08db2fa28a9
+  metadata.gz: 8dbe5aae1bd167ce4887a0557c8deaac21987480034f79efee0a45bd9718f9c41487c76f42cf6e51feac4764988e5145c394aeb657e299119d269555c3d5d01f
+  data.tar.gz: 7972685fc3b4cbdf38e1ffbf60aed7786b2176967b5c850bb69ba463ba4a983ef0dc3c677c4e1b2b5fa6db8bdb47d8817cf83fa666e7abe749e74fc5715e6e5c

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 bibendi
+Copyright (c) 2016 Mikhail Merkushin aka bibendi
 
 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

data/README.md

@@ -1,17 +1,15 @@
 [![Gem Version](https://badge.fury.io/rb/dip.svg)](https://badge.fury.io/rb/dip)
-[![Build Status](https://travis-ci.org/bibendi/dip.svg?branch=master)](https://travis-ci.org/bibendi/dip)
+[![Build Status](https://github.com/bibendi/dip/workflows/Ruby/badge.svg?branch=master)](https://github.com/bibendi/dip/actions?query=branch%3Amaster)
 [![Maintainability](https://api.codeclimate.com/v1/badges/d0dca854f0930502f7b3/maintainability)](https://codeclimate.com/github/bibendi/dip/maintainability)
 
 # DIP
 
-Docker Interaction Process
+Docker Interaction Program.
 
-A command-line utility that gives the "native" interaction with applications configured with Docker Compose. It is for local development only. In practice, it creates the feeling that you work without containers.
+Development-environment CLI program providing the native-like interaction with a Dockerized application. It creates the feeling that you are working without mind-blowing commands to run the containers.
 
-<p float="left">
-<a href="https://evilmartians.com/?utm_source=dip"><img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" height="80" /></a>
-<img src="https://ya-webdesign.com/images250_/vertical-divider-png-1.png" width="50" height="100" />
-<a href="https://www.jetbrains.com/?from=DIP"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/1/1a/JetBrains_Logo_2016.svg/1200px-JetBrains_Logo_2016.svg.png" alt="Sponsored by JetBrains" height="100" /></a></p>
+<a href="https://evilmartians.com/?utm_source=dip">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" height="80" /></a>
 
 ## Presentations and examples
 
@@ -47,7 +45,7 @@ When we change the current directory, all shell aliases will be automatically re
 
 Also, in shell mode Dip is trying to determine manually passed environment variables. For example:
 
-```shhttps://ya-webdesign.com/images250_/vertical-divider-png-1.pnghttps://ya-webdesign.com/images250_/vertical-divider-png-1.png
+```sh
 VERSION=20180515103400 rails db:migrate:down
 ```
 
@@ -201,6 +199,8 @@ returned is `/app/sub-project-dir`.
 
 Run commands defined within the `interaction` section of dip.yml
 
+By default, a command will be executed using [`docker compose`](https://docs.docker.com/compose/install/) command. If you are still using `docker-compose` binary (i.e., prior to Compose V2 changes), a command would be run through it. You can disable using of Compose V2 by passing an environment variable `DIP_COMPOSE_V2=false dip run`.
+
 ```sh
 dip run rails c
 dip run rake db:migrate
@@ -224,6 +224,16 @@ Use options `-p, --publish=[]` if you need to additionally publish a container's
 dip run -p 3000:3000 bundle exec rackup config.ru
 ```
 
+You can also override docker compose command by passing `DIP_COMPOSE_COMMAND` if you wish. For example if you want to use [`mutagen-compose`](https://mutagen.io/documentation/orchestration/compose) run `DIP_COMPOSE_COMMAND=mutagen-compose dip run`.
+
+If you want to persist that change you can specify command in `compose` section of dip.yml :
+
+```yml
+compose:
+  command: mutagen-compose
+
+```
+
 ### dip ls
 
 List all available run commands.
@@ -293,7 +303,7 @@ services:
 
 ### dip nginx
 
-Runs Nginx server container based on [bibendi/nginx-proxy](https://github.com/bibendi/nginx-proxy) image. An application's docker-compose.yml should contain environment variable `VIRTUAL_HOST` and `VIRTUAL_PATH` and connects to external network `frontend`.
+Runs Nginx server container based on [nginxproxy/nginx-proxy](https://github.com/nginx-proxy/nginx-proxy) image. An application's docker-compose.yml should contain environment variable `VIRTUAL_HOST` and `VIRTUAL_PATH` and connects to external network `frontend`.
 
 foo-project/docker-compose.yml
 

data/lib/dip/cli/console.rb

@@ -9,7 +9,7 @@ module Dip
     class Console < Base
       desc "start", "Integrate Dip into current shell"
       method_option :help, aliases: "-h", type: :boolean,
-                           desc: "Display usage information"
+        desc: "Display usage information"
       def start
         if options[:help]
           invoke :help, ["start"]
@@ -22,7 +22,7 @@ module Dip
 
       desc "inject", "Inject aliases"
       method_option :help, aliases: "-h", type: :boolean,
-                           desc: "Display usage information"
+        desc: "Display usage information"
       def inject
         if options[:help]
           invoke :help, ["inject"]

data/lib/dip/cli/dns.rb

@@ -10,19 +10,19 @@ module Dip
     class DNS < Base
       desc "up", "Run dnsdock container"
       method_option :help, aliases: "-h", type: :boolean,
-                           desc: "Display usage information"
+        desc: "Display usage information"
       method_option :name, aliases: "-n", type: :string, default: "dnsdock",
-                           desc: "Container name"
+        desc: "Container name"
       method_option :socket, aliases: "-s", type: :string, default: "/var/run/docker.sock",
-                             desc: "Path to docker socket"
+        desc: "Path to docker socket"
       method_option :net, aliases: "-t", type: :string, default: "frontend",
-                          desc: "Container network name"
+        desc: "Container network name"
       method_option :publish, aliases: "-p", type: :string, default: "53/udp",
-                              desc: "Container port"
+        desc: "Container port"
       method_option :image, aliases: "-i", type: :string, default: "aacebedo/dnsdock:latest-amd64",
-                            desc: "Docker image name"
+        desc: "Docker image name"
       method_option :domain, aliases: "-d", type: :string, default: "docker",
-                             desc: "Top level domain"
+        desc: "Top level domain"
       def up
         if options[:help]
           invoke :help, ["up"]
@@ -40,9 +40,9 @@ module Dip
 
       desc "down", "Stop dnsdock container"
       method_option :help, aliases: "-h", type: :boolean,
-                           desc: "Display usage information"
+        desc: "Display usage information"
       method_option :name, aliases: "-n", type: :string, default: "dnsdock",
-                           desc: "Container name"
+        desc: "Container name"
       def down
         if options[:help]
           invoke :help, ["down"]
@@ -55,7 +55,7 @@ module Dip
 
       desc "restart", "Stop and start dnsdock container"
       method_option :help, aliases: "-h", type: :boolean,
-                           desc: "Display usage information"
+        desc: "Display usage information"
       def restart(*args)
         if options[:help]
           invoke :help, ["restart"]
@@ -68,11 +68,11 @@ module Dip
 
       desc "ip", "Get ip address of dnsdock container"
       method_option :help, aliases: "-h", type: :boolean,
-                           desc: "Display usage information"
+        desc: "Display usage information"
       method_option :name, aliases: "-n", type: :string, default: "dnsdock",
-                           desc: "Container name"
+        desc: "Container name"
       method_option :net, aliases: "-t", type: :string, default: "frontend",
-                          desc: "Container network name"
+        desc: "Container network name"
       def ip
         if options[:help]
           invoke :help, ["status"]

data/lib/dip/cli/nginx.rb

@@ -6,23 +6,23 @@ require_relative "../commands/nginx"
 
 module Dip
   class CLI
-    # See more https://github.com/bibendi/nginx-proxy
+    # See more https://github.com/nginx-proxy/nginx-proxy
     class Nginx < Base
       desc "up", "Run nginx container"
       method_option :help, aliases: "-h", type: :boolean,
-                           desc: "Display usage information"
+        desc: "Display usage information"
       method_option :name, aliases: "-n", type: :string, default: "nginx",
-                           desc: "Container name"
+        desc: "Container name"
       method_option :socket, aliases: "-s", type: :string, default: "/var/run/docker.sock",
-                             desc: "Path to docker socket"
+        desc: "Path to docker socket"
       method_option :net, aliases: "-t", type: :string, default: "frontend",
-                          desc: "Container network name"
+        desc: "Container network name"
       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"
+        desc: "Container port(s). For more than one port, separate them by a space"
+      method_option :image, aliases: "-i", type: :string, default: "nginxproxy/nginx-proxy:latest",
+        desc: "Docker image name"
       method_option :domain, aliases: "-d", type: :string, default: "docker",
-                             desc: "Top level domain"
+        desc: "Top level domain"
       method_option :certs, aliases: "-c", type: :string, desc: "Path to ssl certificates"
       def up
         if options[:help]
@@ -42,9 +42,9 @@ module Dip
 
       desc "down", "Stop nginx container"
       method_option :help, aliases: "-h", type: :boolean,
-                           desc: "Display usage information"
+        desc: "Display usage information"
       method_option :name, aliases: "-n", type: :string, default: "nginx",
-                           desc: "Container name"
+        desc: "Container name"
       def down
         if options[:help]
           invoke :help, ["down"]
@@ -57,7 +57,7 @@ module Dip
 
       desc "restart", "Stop and start nginx container"
       method_option :help, aliases: "-h", type: :boolean,
-                           desc: "Display usage information"
+        desc: "Display usage information"
       def restart(*args)
         if options[:help]
           invoke :help, ["restart"]

data/lib/dip/cli/ssh.rb

@@ -9,18 +9,18 @@ module Dip
     class SSH < Base
       desc "up", "Run ssh-agent container"
       method_option :help, aliases: "-h", type: :boolean,
-                           desc: "Display usage information"
+        desc: "Display usage information"
       method_option :key, aliases: "-k", type: :string, default: "$HOME/.ssh/id_rsa",
-                          desc: "Path to ssh key"
+        desc: "Path to ssh key"
       method_option :volume, aliases: "-v", type: :string, default: "$HOME",
-                             desc: "Mounted docker volume"
+        desc: "Mounted docker volume"
       method_option :interactive, aliases: "-t", type: :boolean, default: true,
-                                  desc: "Run in interactive mode"
+        desc: "Run in interactive mode"
       method_option :user, aliases: "-u", type: :string,
-                           desc: "UID for ssh-agent container"
+        desc: "UID for ssh-agent container"
       # Backward compatibility
       method_option :nonteractive, aliases: "-T", type: :boolean,
-                                   desc: "Run in noninteractive mode"
+        desc: "Run in noninteractive mode"
       def up
         if options[:help]
           invoke :help, ["up"]
@@ -38,7 +38,7 @@ module Dip
 
       desc "down", "Stop ssh-agent container"
       method_option :help, aliases: "-h", type: :boolean,
-                           desc: "Display usage information"
+        desc: "Display usage information"
       def down
         if options[:help]
           invoke :help, ["down"]
@@ -49,7 +49,7 @@ module Dip
 
       desc "restart", "Stop and start ssh-agent container"
       method_option :help, aliases: "-h", type: :boolean,
-                           desc: "Display usage information"
+        desc: "Display usage information"
       def restart(*args)
         if options[:help]
           invoke :help, ["restart"]
@@ -62,7 +62,7 @@ module Dip
 
       desc "status", "Show status of ssh-agent container"
       method_option :help, aliases: "-h", type: :boolean,
-                           desc: "Display usage information"
+        desc: "Display usage information"
       def status
         if options[:help]
           invoke :help, ["status"]

data/lib/dip/cli.rb

@@ -75,7 +75,7 @@ module Dip
 
     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"
+      desc: "Publish a container's port(s) to the host"
     method_option :help, aliases: "-h", type: :boolean, desc: "Display usage information"
     def run(*argv)
       if argv.empty? || options[:help]
@@ -88,7 +88,7 @@ module Dip
 
     desc "provision", "Execute commands within provision section"
     method_option :help, aliases: "-h", type: :boolean,
-                         desc: "Display usage information"
+      desc: "Display usage information"
     def provision
       if options[:help]
         invoke :help, ["provision"]

data/lib/dip/commands/compose.rb

@@ -23,7 +23,14 @@ module Dip
 
         compose_argv = Array(find_files) + Array(cli_options) + argv
 
-        exec_program("docker-compose", compose_argv, shell: shell)
+        if (override_command = compose_command_override)
+          override_command, *override_args = override_command.split(" ")
+          exec_program(override_command, override_args.concat(compose_argv), shell: shell)
+        elsif compose_v2?
+          exec_program("docker", compose_argv.unshift("compose"), shell: shell)
+        else
+          exec_program("docker-compose", compose_argv, shell: shell)
+        end
       end
 
       private
@@ -39,7 +46,7 @@ module Dip
             next unless file_path.exist?
 
             memo << "--file"
-            memo << file_path.to_s
+            memo << Shellwords.escape(file_path.to_s)
           end
         end
       end
@@ -68,6 +75,18 @@ module Dip
           ip.empty? ? DOCKER_EMBEDDED_DNS : ip
         end
       end
+
+      def compose_v2?
+        if %w[false no 0].include?(Dip.env["DIP_COMPOSE_V2"]) || Dip.test?
+          return false
+        end
+
+        !!exec_subprocess("docker", "compose version", panic: false, out: File::NULL, err: File::NULL)
+      end
+
+      def compose_command_override
+        Dip.env["DIP_COMPOSE_COMMAND"] || config[:command]
+      end
     end
   end
 end

data/lib/dip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dip
-  VERSION = "7.1.3"
+  VERSION = "7.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dip
 version: !ruby/object:Gem::Version
-  version: 7.1.3
+  version: 7.3.0
 platform: ruby
 authors:
 - bibendi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-14 00:00:00.000000000 Z
+date: 2022-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -211,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Ruby gem CLI tool for better interacting docker-compose files.