dip 4.2.0 → 7.0.0

data/lib/dip/cli/dns.rb

@@ -1,30 +1,31 @@
 # frozen_string_literal: true
 
-require 'thor'
+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'
-      method_option :name, aliases: '-n', type: :string, default: "dnsdock",
-                           desc: 'Container name'
-      method_option :socket, aliases: '-s', type: :string, default: "/var/run/docker.sock",
-                             desc: 'Path to docker socket'
-      method_option :net, aliases: '-t', type: :string, default: "frontend",
-                          desc: 'Container network name'
-      method_option :publish, aliases: '-p', type: :string, default: "53/udp",
-                              desc: 'Container port'
-      method_option :image, aliases: '-i', type: :string, default: "aacebedo/dnsdock:latest-amd64",
-                            desc: 'Docker image name'
-      method_option :domain, aliases: '-d', type: :string, default: "docker",
-                             desc: 'Top level domain'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
+      method_option :name, aliases: "-n", type: :string, default: "dnsdock",
+                           desc: "Container name"
+      method_option :socket, aliases: "-s", type: :string, default: "/var/run/docker.sock",
+                             desc: "Path to docker socket"
+      method_option :net, aliases: "-t", type: :string, default: "frontend",
+                          desc: "Container network name"
+      method_option :publish, aliases: "-p", type: :string, default: "53/udp",
+                              desc: "Container port"
+      method_option :image, aliases: "-i", type: :string, default: "aacebedo/dnsdock:latest-amd64",
+                            desc: "Docker image name"
+      method_option :domain, aliases: "-d", type: :string, default: "docker",
+                             desc: "Top level domain"
       def up
         if options[:help]
-          invoke :help, ['up']
+          invoke :help, ["up"]
         else
           Dip::Commands::DNS::Up.new(
             name: options.fetch(:name),
@@ -38,13 +39,13 @@ module Dip
       end
 
       desc "down", "Stop dnsdock container"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
-      method_option :name, aliases: '-n', type: :string, default: "dnsdock",
-                           desc: 'Container name'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
+      method_option :name, aliases: "-n", type: :string, default: "dnsdock",
+                           desc: "Container name"
       def down
         if options[:help]
-          invoke :help, ['down']
+          invoke :help, ["down"]
         else
           Dip::Commands::DNS::Down.new(
             name: options.fetch(:name)
@@ -53,11 +54,11 @@ module Dip
       end
 
       desc "restart", "Stop and start dnsdock container"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
       def restart(*args)
         if options[:help]
-          invoke :help, ['restart']
+          invoke :help, ["restart"]
         else
           Dip::CLI::DNS.start(["down"] + args)
           sleep 1
@@ -66,15 +67,15 @@ module Dip
       end
 
       desc "ip", "Get ip address of dnsdock container"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
-      method_option :name, aliases: '-n', type: :string, default: "dnsdock",
-                           desc: 'Container name'
-      method_option :net, aliases: '-t', type: :string, default: "frontend",
-                          desc: 'Container network name'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
+      method_option :name, aliases: "-n", type: :string, default: "dnsdock",
+                           desc: "Container name"
+      method_option :net, aliases: "-t", type: :string, default: "frontend",
+                          desc: "Container network name"
       def ip
         if options[:help]
-          invoke :help, ['status']
+          invoke :help, ["status"]
         else
           Dip::Commands::DNS::IP.new(
             name: options.fetch(:name),

data/lib/dip/cli/nginx.rb

@@ -1,31 +1,32 @@
 # frozen_string_literal: true
 
-require 'thor'
+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'
-      method_option :name, aliases: '-n', type: :string, default: "nginx",
-                           desc: 'Container name'
-      method_option :socket, aliases: '-s', type: :string, default: "/var/run/docker.sock",
-                             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",
-                              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'
-      method_option :domain, aliases: '-d', type: :string, default: "docker",
-                             desc: 'Top level domain'
-      method_option :certs, aliases: '-c', type: :string, desc: 'Path to ssl certificates'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
+      method_option :name, aliases: "-n", type: :string, default: "nginx",
+                           desc: "Container name"
+      method_option :socket, aliases: "-s", type: :string, default: "/var/run/docker.sock",
+                             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"],
+                              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"
+      method_option :domain, aliases: "-d", type: :string, default: "docker",
+                             desc: "Top level domain"
+      method_option :certs, aliases: "-c", type: :string, desc: "Path to ssl certificates"
       def up
         if options[:help]
-          invoke :help, ['up']
+          invoke :help, ["up"]
         else
           Dip::Commands::Nginx::Up.new(
             name: options.fetch(:name),
@@ -40,13 +41,13 @@ module Dip
       end
 
       desc "down", "Stop nginx container"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
-      method_option :name, aliases: '-n', type: :string, default: "nginx",
-                           desc: 'Container name'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
+      method_option :name, aliases: "-n", type: :string, default: "nginx",
+                           desc: "Container name"
       def down
         if options[:help]
-          invoke :help, ['down']
+          invoke :help, ["down"]
         else
           Dip::Commands::Nginx::Down.new(
             name: options.fetch(:name)
@@ -55,11 +56,11 @@ module Dip
       end
 
       desc "restart", "Stop and start nginx container"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
       def restart(*args)
         if options[:help]
-          invoke :help, ['restart']
+          invoke :help, ["restart"]
         else
           Dip::CLI::Nginx.start(["down"] + args)
           sleep 1

data/lib/dip/cli/ssh.rb

@@ -1,31 +1,35 @@
 # frozen_string_literal: true
 
-require 'thor'
+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'
-      method_option :key, aliases: '-k', type: :string, default: "$HOME/.ssh/id_rsa",
-                          desc: 'Path to ssh key'
-      method_option :volume, aliases: '-v', type: :string, default: "$HOME",
-                             desc: 'Mounted docker volume'
-      method_option :interactive, aliases: '-t', type: :boolean, default: true,
-                                  desc: 'Run in interactive mode'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
+      method_option :key, aliases: "-k", type: :string, default: "$HOME/.ssh/id_rsa",
+                          desc: "Path to ssh key"
+      method_option :volume, aliases: "-v", type: :string, default: "$HOME",
+                             desc: "Mounted docker volume"
+      method_option :interactive, aliases: "-t", type: :boolean, default: true,
+                                  desc: "Run in interactive mode"
+      method_option :user, aliases: "-u", type: :string,
+                           desc: "UID for ssh-agent container"
       # Backward compatibility
-      method_option :nonteractive, aliases: '-T', type: :boolean,
-                                   desc: 'Run in noninteractive mode'
+      method_option :nonteractive, aliases: "-T", type: :boolean,
+                                   desc: "Run in noninteractive mode"
       def up
         if options[:help]
-          invoke :help, ['up']
+          invoke :help, ["up"]
         else
           Dip::Commands::SSH::Up.new(
             key: options.fetch(:key),
             volume: options.fetch(:volume),
-            interactive: options.nonteractive? ? false : options.interactive?
+            interactive: options.nonteractive? ? false : options.interactive?,
+            user: options.user
           ).execute
         end
       end
@@ -33,22 +37,22 @@ module Dip
       map add: :up
 
       desc "down", "Stop ssh-agent container"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
       def down
         if options[:help]
-          invoke :help, ['down']
+          invoke :help, ["down"]
         else
           Dip::Commands::SSH::Down.new.execute
         end
       end
 
       desc "restart", "Stop and start ssh-agent container"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
       def restart(*args)
         if options[:help]
-          invoke :help, ['restart']
+          invoke :help, ["restart"]
         else
           Dip::CLI::SSH.start(["down"] + args)
           sleep 1
@@ -57,11 +61,11 @@ module Dip
       end
 
       desc "status", "Show status of ssh-agent container"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
       def status
         if options[:help]
-          invoke :help, ['status']
+          invoke :help, ["status"]
         else
           Dip::Commands::SSH::Status.new.execute
         end

data/lib/dip/command.rb

@@ -9,15 +9,15 @@ module Dip
     def_delegators self, :shell, :subshell
 
     class ExecRunner
-      def self.call(cmd, argv, env: {}, **options)
-        ::Process.exec(env, cmd, *argv, options)
+      def self.call(cmdline, env: {}, **options)
+        ::Process.exec(env, cmdline, options)
       end
     end
 
     class SubshellRunner
-      def self.call(cmd, argv, env: {}, panic: true, **options)
-        return if ::Kernel.system(env, cmd, *argv, options)
-        raise Dip::Error, "Command '#{([cmd] + argv).join(' ')}' executed with error." if panic
+      def self.call(cmdline, env: {}, panic: true, **options)
+        return if ::Kernel.system(env, cmdline, options)
+        raise Dip::Error, "Command '#{cmdline}' executed with error." if panic
       end
     end
 
@@ -25,11 +25,12 @@ module Dip
       def shell(cmd, argv = [], subshell: false, **options)
         cmd = Dip.env.interpolate(cmd)
         argv = argv.map { |arg| Dip.env.interpolate(arg) }
+        cmdline = [cmd, *argv].compact.join(" ")
 
-        puts [Dip.env.vars, cmd, argv].inspect if Dip.debug?
+        puts [Dip.env.vars, cmdline].inspect if Dip.debug?
 
         runner = subshell ? SubshellRunner : ExecRunner
-        runner.call(cmd, argv, env: Dip.env.vars, **options)
+        runner.call(cmdline, env: Dip.env.vars, **options)
       end
 
       def subshell(*args, **kwargs)

data/lib/dip/commands/compose.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-require_relative '../command'
-require_relative 'dns'
+require "pathname"
+
+require_relative "../command"
+require_relative "dns"
 
 module Dip
   module Commands
@@ -18,7 +20,7 @@ module Dip
       def execute
         Dip.env["DIP_DNS"] ||= find_dns
 
-        compose_argv = Array(find_files) + Array(find_project_name) + argv
+        compose_argv = Array(find_files) + Array(cli_options) + argv
 
         shell("docker-compose", compose_argv)
       end
@@ -29,23 +31,26 @@ 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
 
-      def find_project_name
-        return unless (project_name = config[:project_name])
+      def cli_options
+        %i[project_name project_directory].flat_map do |name|
+          next unless (value = config[name])
+          next unless value.is_a?(String)
 
-        if project_name.is_a?(String)
-          project_name = ::Dip.env.interpolate(project_name)
-          ["--project-name", project_name]
-        end
+          value = ::Dip.env.interpolate(value)
+          ["--#{name.to_s.tr("_", "-")}", value]
+        end.compact
       end
 
       def find_dns
@@ -53,9 +58,9 @@ module Dip
         net = Dip.env["FRONTEND_NETWORK"] || "frontend"
 
         IO.pipe do |r, w|
-          Dip::Commands::DNS::IP.
-            new(name: name, net: net).
-            execute(out: w, err: File::NULL, panic: false)
+          Dip::Commands::DNS::IP
+            .new(name: name, net: net)
+            .execute(out: w, err: File::NULL, panic: false)
 
           w.close_write
           ip = r.readlines[0].to_s.strip

data/lib/dip/commands/console.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../command'
+require_relative "../command"
 
 module Dip
   module Commands
@@ -13,9 +13,9 @@ module Dip
         private
 
         def script
-          <<-SH.gsub(/^[ ]{12}/, '')
+          <<-SH.gsub(/^ {12}/, "")
             export DIP_SHELL=1
-            export DIP_EARLY_ENVS=#{ENV.keys.join(',')}
+            export DIP_EARLY_ENVS=#{ENV.keys.join(",")}
             export DIP_PROMPT_TEXT="ⅆ"
 
             function dip_clear() {
@@ -86,9 +86,9 @@ 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")
+            add_aliases("compose", "up", "stop", "down", "provision", "build")
           end
 
           clear_aliases
@@ -107,7 +107,7 @@ module Dip
 
         def clear_aliases
           out << "function dip_clear() { \n" \
-                  "#{aliases.any? ? aliases.map { |a| "  unset -f #{a}" }.join("\n") : 'true'} " \
+                  "#{aliases.any? ? aliases.map { |a| "  unset -f #{a}" }.join("\n") : "true"} " \
                   "\n}"
         end
       end

data/lib/dip/commands/dns.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "shellwords"
-require_relative '../command'
+require_relative "../command"
 
 module Dip
   module Commands
@@ -24,13 +24,13 @@ module Dip
         private
 
         def container_args
-          result = %w(--detach)
+          result = %w[--detach]
           result << "--volume #{@socket}:/var/run/docker.sock:ro"
           result << "--restart always"
           result << "--publish #{@publish}"
           result << "--net #{@net}"
           result << "--name #{@name}"
-          result.join(' ')
+          result.join(" ")
         end
       end
 
@@ -53,10 +53,10 @@ module Dip
 
         def execute(**options)
           subshell("docker",
-                   "inspect " \
-                   "--format '{{ .NetworkSettings.Networks.#{@net}.IPAddress }}' " \
-                   "#{@name}".shellsplit,
-                   **options)
+            "inspect " \
+            "--format '{{ .NetworkSettings.Networks.#{@net}.IPAddress }}' " \
+            "#{@name}".shellsplit,
+            **options)
         end
       end
     end