dip 3.2.3 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f2589dd2d5ed737bf8c27f106eab0a30208e91d3057408c01019c5190e79481
-  data.tar.gz: e8f08bfb7d9dc8dbb4aec65f4f5dab3138fe65e0f027d11034877a018f742bf7
+  metadata.gz: 39afd269d744387e64e708e2c173c38ffe35605ae8aa4dffa9cd074142e0e9b1
+  data.tar.gz: efb60031ad5646986fc5672b4579671d3225624b9bc38d1d26ba142a91b1b3ee
 SHA512:
-  metadata.gz: 2e7949d2b0e8af442161bb85413710c6fe8dcb3220ed23a6f98e4e6b3cd584ebe23dd4d36a7780ed2cd2f47d48b438ebce3095eb560d7c7911cea396a66c6025
-  data.tar.gz: 8439e5601a24bcb1d15bf813a37478c98bdbbab3fcdd9817b613f144144090a09fc8498314e57444f0becfa80f41cff2ab337602a34d2c552a60780859b2f8a9
+  metadata.gz: c6d434a4250d5276e4ce91d3ed2393be9cbc93108a8fe32052f3cb6f54b2fd8fd740ee0652352fb32f26310ed30e559dbe17565eb2e16a195d7e6d7f226aaa58
+  data.tar.gz: 5a5512fff638facb0f3bf185703a53df02fb009e1d3c29a80803724336607f8198891f4465f0b9b2cd730d6b866225118dd9d2efa59eacc77776038039be64c5

data/README.md

@@ -1,4 +1,8 @@
-# DIP [![Build Status](https://travis-ci.org/bibendi/dip.svg?branch=master)](https://travis-ci.org/bibendi/dip)
+[![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)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d0dca854f0930502f7b3/maintainability)](https://codeclimate.com/github/bibendi/dip/maintainability)
+
+# DIP
 
 Docker Interaction Process
 
@@ -22,6 +26,10 @@ https://github.com/bibendi/dip/releases
 - [Ubuntu](docs/docker-ubuntu-install.md)
 - [Mac OS](docs/docker-for-mac-install.md)
 
+## Examples
+
+- [Modern Rails application with webpack](https://github.com/bibendi/dip-example-rails)
+
 ## Usage
 
 ```sh
@@ -36,48 +44,47 @@ version: '2'
 
 environment:
   COMPOSE_EXT: development
-  RAILS_ENV: development
 
 compose:
   files:
     - docker/docker-compose.yml
     - docker/docker-compose.$COMPOSE_EXT.yml
     - docker/docker-compose.$DIP_OS.yml
-  project_name: bear-$RAILS_ENV
+  project_name: bear
 
 interaction:
   sh:
-    service: foo-app
+    service: app
     compose_run_options: [no-deps]
 
   bundle:
-    service: foo-app
+    service: app
     command: bundle
 
   rake:
-    service: foo-app
+    service: app
     command: bundle exec rake
 
   rspec:
-    service: foo-app
+    service: app
     environment:
       RAILS_ENV: test
     command: bundle exec rspec
 
   rails:
-    service: foo-app
+    service: app
     command: bundle exec rails
     subcommands:
       s:
-        service: foo-web
+        service: web
         compose_method: up
 
   psql:
-    service: foo-app
+    service: app
     command: psql -h pg -U postgres
 
 provision:
-  - dip compose up -d foo-pg foo-redis
+  - dip compose up -d pg redis
   - dip bundle install
   - dip rake db:migrate
 ```
@@ -112,6 +119,28 @@ dip compose COMMAND [OPTIONS]
 dip compose up -d redis
 ```
 
+### Integration with shell
+
+Dip can be injected into your current shell. For now, it supported ZSH only.
+
+Inject Dip rc file (by default it saved to ~/.dip_shell_rc) into ZSH:
+
+```sh
+source $(dip console)
+```
+
+After that you can type commands without `dip` prefix. For example:
+
+```sh
+d> <run-command> *any-args
+d> compose *any-compose-arg
+d> up <service>
+d> down
+d> provision
+```
+
+When you change the current directory, all shell aliases will be automatically removed. But when you will enter back to a directory with a dip.yml file, then shell aliases will be renewed.
+
 ### dip ssh
 
 Runs ssh-agent container based on https://github.com/whilp/ssh-agent with your ~/.ssh/id_rsa.

data/lib/dip.rb

@@ -15,6 +15,11 @@ module Dip
       @env ||= Dip::Environment.new(config.exist? ? config.environment : {})
     end
 
+    def bin_path
+      # TODO: Maybe there's a better way?
+      $PROGRAM_NAME.start_with?("./") ? File.expand_path($PROGRAM_NAME) : $PROGRAM_NAME
+    end
+
     %w(test debug).each do |key|
       define_method("#{key}?") do
         ENV["DIP_ENV"] == key

data/lib/dip/cli.rb

@@ -99,5 +99,9 @@ module Dip
     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 is supported now)"
+    subcommand :console, Dip::CLI::Console
   end
 end

data/lib/dip/cli/console.rb

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

data/lib/dip/commands/console.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module Dip
+  module Commands
+    module Console
+      class Start < Dip::Command
+        def execute
+          File.write(rc_file, script_content)
+
+          puts rc_file
+        end
+
+        private
+
+        def rc_file
+          @rc_file ||= "#{Dir.home}/.dip_shell_rc"
+        end
+
+        def script_content
+          <<-SH.gsub(/^[ ]{12}/, '')
+            if [ "$DIP_SHELL" != "1" ]; then
+              export PS1="${PS1}d> "
+              export DIP_SHELL=1
+            fi
+
+            function _dip_remove_aliases() {
+              # will be redefined
+            }
+
+            function _dip_source_aliases() {
+              #{Dip.bin_path} console inject | source /dev/stdin
+            }
+
+            _dip_source_aliases
+
+            function chpwd() {
+              _dip_remove_aliases
+              _dip_source_aliases
+            }
+          SH
+        end
+      end
+
+      class Inject < Dip::Command
+        def initialize
+          @aliases = []
+          @out = []
+        end
+
+        def execute
+          if Dip.config.exist?
+            alias_interaction if Dip.config.interaction
+            alias_compose
+            add_alias("provision")
+          end
+
+          fill_removing_aliases
+
+          puts @out.join("\n\n")
+        end
+
+        private
+
+        def alias_interaction
+          Dip.config.interaction.keys.each do |name|
+            add_alias(name)
+          end
+        end
+
+        def alias_compose
+          %w(compose up down).each do |name|
+            add_alias(name)
+          end
+        end
+
+        def add_alias(name)
+          @aliases << name
+          @out << "function #{name}() { #{Dip.bin_path} #{name} $@; }"
+        end
+
+        def fill_removing_aliases
+          @out << "function _dip_remove_aliases() { \n" \
+                  "#{@aliases.map { |a| "  unset -f #{a}" }.join("\n")} " \
+                  "\n}"
+        end
+      end
+    end
+  end
+end

data/lib/dip/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dip
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.3.0
 platform: ruby
 authors:
 - bibendi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-08 00:00:00.000000000 Z
+date: 2018-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -136,11 +136,13 @@ files:
 - exe/dip
 - lib/dip.rb
 - lib/dip/cli.rb
+- lib/dip/cli/console.rb
 - lib/dip/cli/dns.rb
 - lib/dip/cli/nginx.rb
 - lib/dip/cli/ssh.rb
 - lib/dip/command.rb
 - lib/dip/commands/compose.rb
+- lib/dip/commands/console.rb
 - lib/dip/commands/dns.rb
 - lib/dip/commands/nginx.rb
 - lib/dip/commands/provision.rb