dip 6.0.0 → 7.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 965a10ab510e886e51a4e307a152358177caceb7c6504ac2c15d222c537ebb12
-  data.tar.gz: 2d9c98f79718a7774ba7f12f66ecb8495b7f965db3f6aac855586cfe8bb0b7cd
+  metadata.gz: 5e42a461aef491ba31638884320252a28f891416510128a0dee140d8c8b3e8a8
+  data.tar.gz: 836d775a9c88f2df8bc807207710f84b39502b4e1f7e19747cf4f231fb3e7b06
 SHA512:
-  metadata.gz: 3d44176de01f624cff9e98b578c23e525e7c4b6ddc4ad9bdf35cfa54923851f6bea24633c377f20167263deb0b133482f92d3203adffbc6e79b09cdf0c390f71
-  data.tar.gz: ff3ba16f8461fe8e1eb8a5070e312f88702c06c2f2cdcf4f4e0a61390bee09bdd69ce3510c1bd26100addc1bca163e876aa9a78aa615fb2394b2d2a55fbaea01
+  metadata.gz: 88e61d6a5dfe78dd7dba7f1993ea8260f991fabc1921c144157dd4778bf1ccd4839472436327548d12b29222437bcfc08588f25a94e724fc74701b3a81c2d904
+  data.tar.gz: 564e4cc1f1fe2aa824b9ca061a0e7a446074faeadb24ee620192cc53bcb3f7fab0cdf3d4849611ee963f7a0d3700089bc1932911096f740212165420b45e452d

data/README.md

@@ -16,9 +16,11 @@ A command-line utility that gives the "native" interaction with applications con
 ## Presentations and examples
 
 - [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 Ruby on Rails applications: [one](https://github.com/lewagon/rails-k8s-demo), [two](https://github.com/bibendi/dip-example-rails), [three](https://github.com/evilmartians/evil_chat)
 - 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)
+- [Dockerizing Ruby and Rails development](https://evilmartians.com/chronicles/ruby-on-whales-docker-for-ruby-rails-development)
+- [Reusable development containers with Docker Compose and Dip](https://evilmartians.com/chronicles/reusable-development-containers-with-docker-compose-and-dip)
 
 [![asciicast](https://asciinema.org/a/210236.svg)](https://asciinema.org/a/210236)
 
@@ -36,6 +38,7 @@ After that we can type commands without `dip` prefix. For example:
 <run-command> *any-args
 compose *any-compose-arg
 up <service>
+build
 down
 provision
 ```
@@ -53,41 +56,11 @@ After that, it will be automatically applied when you open your preferred termin
 
 ## Installation
 
-You have many ways.
-
-### Homebrew
-
-
-You can use [Homebrew](https://brew.sh) on macOS (or [Linux](https://docs.brew.sh/Homebrew-on-Linux)).
-
-Today Homebrew tap for DIP is located at https://github.com/bibendi/homebrew-dip
-
-```sh
-brew tap bibendi/dip
-brew install dip
-```
-
-### Ruby Gem
-
 ```sh
 gem install dip
 ```
 
-### Precompiled binary
-
-If you don't have installed Ruby, then you could copy a precompiled binary to your system.
-It can be found at [releases page](https://github.com/bibendi/dip/releases)
-or type bellow into your terminal:
-
-```sh
-curl -L https://github.com/bibendi/dip/releases/download/v6.0.0/dip-`uname -s`-`uname -m` > /usr/local/bin/dip
-chmod +x /usr/local/bin/dip
-```
-
-## Docker installation
-
-- [Ubuntu](docs/docker-ubuntu-install.md)
-- [Mac OS](docs/docker-for-mac-install.md)
+The compiled binary is no more provided since version 7, because of new version of [Ruby Packer](https://github.com/pmq20/ruby-packer) not released for a long time with recent Ruby version. Also there was a lot of work to prepare each release of Dip for MacOS version.
 
 ## Usage
 
@@ -108,7 +81,7 @@ Also, you can check out examples at the top.
 
 ```yml
 # Required minimum dip version
-version: '4.1'
+version: '7.1'
 
 environment:
   COMPOSE_EXT: development
@@ -121,7 +94,7 @@ compose:
   project_name: bear
 
 interaction:
-  bash:
+  shell:
     description: Open the Bash shell in app's container
     service: app
     command: bash
@@ -169,8 +142,19 @@ interaction:
     default_args: db_dev
     command: psql -h pg -U postgres
 
+  setup_key:
+    description: Copy key
+    service: app
+    command: cp `pwd`/config/key.pem /root/keys/
+    shell: false # you can disable shell interpolations on the host machine and send the command as is
+
+  clean_cache:
+    description: Delete cache files on the host machine
+    command: rm -rf $(pwd)/tmp/cache/*
+
 provision:
   - dip compose down --volumes
+  - dip clean_cache
   - dip compose up -d pg redis
   - dip bash -c ./bin/setup
 ```
@@ -237,7 +221,7 @@ 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 run -p 3000:3000 bundle exec rackup config.ru
 ```
 
 ### dip ls
@@ -292,6 +276,21 @@ volumes:
       name: ssh_data
 ```
 
+if you want to use non-root user you can specify UID like so:
+
+```
+dip ssh up -u 1000
+```
+
+This especially helpful if you have something like this in your docker-compose.yml:
+
+```
+services:
+  web:
+    user: "1000:1000"
+
+```
+
 ### 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`.

data/exe/dip

@@ -1,20 +1,20 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-lib_path = File.expand_path('../lib', __dir__)
+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"
+  require "pry-byebug" if ENV["DIP_ENV"] == "debug"
 rescue LoadError
   # do nothing
 end
 
-require 'dip'
-require 'dip/cli'
-require 'dip/run_vars'
+require "dip"
+require "dip/cli"
+require "dip/run_vars"
 
-Signal.trap('INT') do
+Signal.trap("INT") do
   warn("\n#{caller.join("\n")}: interrupted")
   exit(1)
 end

data/lib/dip.rb

@@ -18,7 +18,7 @@ module Dip
       $PROGRAM_NAME.start_with?("./") ? File.expand_path($PROGRAM_NAME) : "dip"
     end
 
-    %w(test debug).each do |key|
+    %w[test debug].each do |key|
       define_method("#{key}?") do
         ENV["DIP_ENV"] == key
       end

data/lib/dip/cli.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'thor'
-require 'dip/run_vars'
+require "thor"
+require "dip/run_vars"
 
 module Dip
   class CLI < Thor
@@ -34,25 +34,30 @@ module Dip
 
     stop_on_unknown_option! :run
 
-    desc 'version', 'dip version'
+    desc "version", "dip version"
     def version
-      require_relative 'version'
+      require_relative "version"
       puts Dip::VERSION
     end
-    map %w(--version -v) => :version
+    map %w[--version -v] => :version
 
-    desc 'ls', 'List available run commands'
+    desc "ls", "List available run commands"
     def ls
-      require_relative 'commands/list'
+      require_relative "commands/list"
       Dip::Commands::List.new.execute
     end
 
-    desc 'compose CMD [OPTIONS]', 'Run docker-compose commands'
+    desc "compose CMD [OPTIONS]", "Run docker-compose commands"
     def compose(*argv)
-      require_relative 'commands/compose'
+      require_relative "commands/compose"
       Dip::Commands::Compose.new(*argv).execute
     end
 
+    desc "build [OPTIONS] SERVICE", "Run `docker-compose build` command"
+    def build(*argv)
+      compose("build", *argv)
+    end
+
     desc "up [OPTIONS] SERVICE", "Run `docker-compose up` command"
     def up(*argv)
       compose("up", *argv)
@@ -63,50 +68,50 @@ module Dip
       compose("stop", *argv)
     end
 
-    desc "down all services [OPTIONS]", "Run `docker-compose down` command"
+    desc "down [OPTIONS]", "Run `docker-compose down` command"
     def down(*argv)
       compose("down", *argv)
     end
 
-    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 "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'
+    method_option :help, aliases: "-h", type: :boolean, desc: "Display usage information"
     def run(*argv)
       if argv.empty? || options[:help]
-        invoke :help, ['run']
+        invoke :help, ["run"]
       else
-        require_relative 'commands/run'
+        require_relative "commands/run"
         Dip::Commands::Run.new(*argv, publish: options[:publish]).execute
       end
     end
 
     desc "provision", "Execute commands within provision section"
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Display usage information'
+    method_option :help, aliases: "-h", type: :boolean,
+                         desc: "Display usage information"
     def provision
       if options[:help]
-        invoke :help, ['provision']
+        invoke :help, ["provision"]
       else
-        require_relative 'commands/provision'
+        require_relative "commands/provision"
         Dip::Commands::Provision.new.execute
       end
     end
 
-    require_relative 'cli/ssh'
+    require_relative "cli/ssh"
     desc "ssh", "ssh-agent container commands"
     subcommand :ssh, Dip::CLI::SSH
 
-    require_relative 'cli/dns'
+    require_relative "cli/dns"
     desc "dns", "DNS server for automatic docker container discovery"
     subcommand :dns, Dip::CLI::DNS
 
-    require_relative 'cli/nginx'
+    require_relative "cli/nginx"
     desc "nginx", "Nginx reverse proxy server"
     subcommand :nginx, Dip::CLI::Nginx
 
-    require_relative 'cli/console'
-    desc "console", "Integrate Dip commands into shell (only ZSH and Bash is supported)"
+    require_relative "cli/console"
+    desc "console", "Integrate Dip commands into shell (only ZSH and Bash are supported)"
     subcommand :console, Dip::CLI::Console
   end
 end

data/lib/dip/cli/console.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'thor'
+require "thor"
 require_relative "./base"
 require_relative "../commands/console"
 
@@ -8,11 +8,11 @@ module Dip
   class CLI
     class Console < Base
       desc "start", "Integrate Dip into current shell"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
       def start
         if options[:help]
-          invoke :help, ['start']
+          invoke :help, ["start"]
         else
           Dip::Commands::Console::Start.new.execute
         end
@@ -21,11 +21,11 @@ module Dip
       default_task :start
 
       desc "inject", "Inject aliases"
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      method_option :help, aliases: "-h", type: :boolean,
+                           desc: "Display usage information"
       def inject
         if options[:help]
-          invoke :help, ['inject']
+          invoke :help, ["inject"]
         else
           Dip::Commands::Console::Inject.new.execute
         end

data/lib/dip/cli/dns.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'thor'
+require "thor"
 require_relative "./base"
 require_relative "../commands/dns"
 
@@ -9,23 +9,23 @@ module Dip
     # See more https://github.com/aacebedo/dnsdock
     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),
@@ -39,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)
@@ -54,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
@@ -67,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,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'thor'
+require "thor"
 require_relative "./base"
 require_relative "../commands/nginx"
 
@@ -9,24 +9,24 @@ module Dip
     # See more https://github.com/bibendi/nginx-proxy
     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),
@@ -41,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)
@@ -56,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