dip 3.8.3 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47956f8a76407c96fe354e73d11fb582d081736b6c83b4b1756e5b514d3f6e59
-  data.tar.gz: e1b8a52c7fbcf29c407e562f12647e977429dd6661c41e11705eeee0d1f6e439
+  metadata.gz: 814f6f4b810a700663a169d6d34f535c010d7c9c9241a1343307f9657f50a9cd
+  data.tar.gz: 2d6b76d8e3459302accc2c264148083bb0b15d63fb365e9d4a12ed245820f843
 SHA512:
-  metadata.gz: ac05cfd64e35d26919a9291af4dd9b94c30b5fc67c0e292ee2457c67c778c24d28fab485dd5cf8931c073560b302e06a3f4a7a8681ddf8b35ccc6c5cd2965211
-  data.tar.gz: e43a7d567dd871f2fa4fc6d88571c9b07c929db2a177b1f2e8faa3c54f8ffb065fabe789bbc5ffde1dab180e07216ab92cb450b118d9204a7fc55ebbe6d0bfc4
+  metadata.gz: dc0e2299a4eed706c48868779fe655c7207e9b8d6353ed5bbb5887f318d1099e8c1db556f05af000b2869dc8e483b58ed874382062ebc2ea23d27def0481f705
+  data.tar.gz: f0a832bb6d9394b84a9e10b248ea9f1122d6cbed0fd8c973c679f9fc34faad066477b044bd8090cb8000b63d47f1d7329a67fd83e55a5d84e11c49379ec88d3e

data/README.md

@@ -6,10 +6,7 @@
 
 Docker Interaction Process
 
-Command line utility that gives the "native" interaction with applications configured with Docker Compose. It is for the local development only. In practice, it creates the feeling that you work without containers.
-
-<a href="https://evilmartians.com/?utm_source=dip">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+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.
 
 ## Presentations and examples
 
@@ -22,7 +19,7 @@ Command line utility that gives the "native" interaction with applications confi
 
 ## Integration with shell
 
-Dip can be injected into current shell (ZSH or Bash).
+Dip can be injected into the current shell (ZSH or Bash).
 
 ```sh
 eval "$(dip console)"
@@ -38,9 +35,9 @@ down
 provision
 ```
 
-When we change the current directory, all shell aliases will be automatically removed. But when we will enter back to a directory with a dip.yml file, then shell aliases will be renewed.
+When we change the current directory, all shell aliases will be automatically removed. But when we enter back into a directory with a `dip.yml` file, then shell aliases will be renewed.
 
-Also, in shell mode Dip is trying to determine passed manually environment variables. For example:
+Also, in shell mode Dip is trying to determine manually passed environment variables. For example:
 
 ```sh
 VERSION=20180515103400 rails db:migrate:down
@@ -51,20 +48,34 @@ After that, it will be automatically applied when you open your preferred termin
 
 ## Installation
 
-You have two ways.
+You have many ways.
+
+### Homebrew
+
 
-Install like a typical Ruby gem:
+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
 ```
 
-If you don't have installed Ruby then you could copy a precompiled binary to your system. 
+### 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/3.8.3/dip-`uname -s`-`uname -m` > /usr/local/bin/dip
+curl -L https://github.com/bibendi/dip/releases/download/4.0.0/dip-`uname -s`-`uname -m` > /usr/local/bin/dip
 chmod +x /usr/local/bin/dip
 ``` 
 
@@ -86,13 +97,13 @@ The configuration file `dip.yml` should be placed in a project root directory.
 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 real 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.       
-
+Also, you can check out examples in the top.
 
 ```yml
-version: '2'
+# Required minimum dip version
+version: '4'
 
 environment:
   COMPOSE_EXT: development
@@ -106,32 +117,48 @@ compose:
 
 interaction:
   bash:
+    description: Open the Bash shell in app's container
     service: app
-    compose_run_options: [no-deps]
+    compose:
+      run_options: [no-deps]
 
   bundle:
+    description: Run Bundler commands
     service: app
     command: bundle
 
   rake:
+    description: Run Rake commands
     service: app
     command: bundle exec rake
 
   rspec:
+    description: Run Rspec commands
     service: app
     environment:
       RAILS_ENV: test
     command: bundle exec rspec
 
   rails:
+    description: Run Rails commands
     service: app
     command: bundle exec rails
     subcommands:
       s:
+        description: Run Rails server at http://localhost:3000
         service: web
-        compose_run_options: [service-ports]
+        compose:
+          run_options: [service-ports]
+
+  sidekiq:
+    description: Run sidekiq in background
+    service: worker
+    compose:
+      method: up
+      run_options: [detach]
 
   psql:
+    description: Run Postgres psql console
     service: app
     command: psql -h pg -U postgres
 
@@ -143,27 +170,39 @@ provision:
 
 ### dip run
 
-Run commands defined within `interaction` section of dip.yml
+Run commands defined within the `interaction` section of dip.yml
 
 ```sh
 dip run rails c
 dip run rake db:migrate
 ```
 
-`run` argument can be ommited
+`run` argument can be omitted
 
 ```sh
 dip rake db:migrate
 dip VERSION=12352452 rake db:rollback
 ```
 
+### dip ls
+
+List al available run commands.
+
+```sh
+dip ls
+
+bash     # Open the Bash shell in app's container
+rails    # Run Rails command
+rails s  # Run Rails server at http://localhost:3000
+```
+
 ### dip provision
 
 Run commands each by each from `provision` section of dip.yml
 
 ### dip compose
 
-Run docker-compose commands that are configured according with application dip.yml
+Run docker-compose commands that are configured according to the application's dip.yml :
 
 ```sh
 dip compose COMMAND [OPTIONS]
@@ -199,7 +238,7 @@ volumes:
 
 ### 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 contains environment variable `VIRTUAL_HOST` and `VIRTUAL_PATH` and connects to external network `frontend`.
+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`.
 
 foo-project/docker-compose.yml
 
@@ -255,7 +294,7 @@ curl www.bar-app.docker/api/v1/baz_service/qzz
 
 ### dip dns
 
-Runs DNS server container based on https://github.com/aacebedo/dnsdock It used for container to container requests through nginx. An application's docker-compose.yml should define `dns` configuration with environment variable `$DIP_DNS` and connect to external network `frontend`. `$DIP_DNS` will be automatically assigned by dip.
+Runs a DNS server container based on https://github.com/aacebedo/dnsdock. It is used for container to container requests through Nginx. An application's docker-compose.yml should define `dns` configuration with environment variable `$DIP_DNS` and connect to external network `frontend`. `$DIP_DNS` will be automatically assigned by dip.
 
 ```sh
 dip dns up

data/lib/dip.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
+require "dip/errors"
 require "dip/config"
 require "dip/environment"
 
 module Dip
-  Error = Class.new(StandardError)
-
   class << self
     def config
       @config ||= Dip::Config.new

data/lib/dip/cli.rb

@@ -39,6 +39,12 @@ module Dip
     end
     map %w(--version -v) => :version
 
+    desc 'ls', 'List available run commands'
+    def ls
+      require_relative 'commands/list'
+      Dip::Commands::List.new.execute
+    end
+
     desc 'compose CMD [OPTIONS]', 'Run docker-compose commands'
     def compose(*argv)
       require_relative 'commands/compose'

data/lib/dip/cli/dns.rb

@@ -22,7 +22,6 @@ module Dip
                             desc: 'Docker image name'
       method_option :domain, aliases: '-d', type: :string, default: "docker",
                              desc: 'Top level domain'
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def up
         if options[:help]
           invoke :help, ['up']
@@ -37,7 +36,6 @@ module Dip
           ).execute
         end
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
       desc "down", "Stop dnsdock container"
       method_option :help, aliases: '-h', type: :boolean,

data/lib/dip/cli/nginx.rb

@@ -22,7 +22,6 @@ module Dip
                             desc: 'Docker image name'
       method_option :domain, aliases: '-d', type: :string, default: "docker",
                              desc: 'Top level domain'
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def up
         if options[:help]
           invoke :help, ['up']
@@ -37,7 +36,6 @@ module Dip
           ).execute
         end
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
       desc "down", "Stop nginx container"
       method_option :help, aliases: '-h', type: :boolean,

data/lib/dip/commands/list.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../interaction_tree'
+
+module Dip
+  module Commands
+    class List < Dip::Command
+      def execute
+        tree = InteractionTree.new(Dip.config.interaction).list
+
+        longest_name = tree.keys.map(&:size).max
+
+        tree.each do |name, command|
+          puts "#{name.ljust(longest_name)}  ##{command[:description] ? ' ' + command[:description] : ''}"
+        end
+      end
+    end
+  end
+end

data/lib/dip/commands/run.rb

@@ -2,58 +2,47 @@
 
 require 'shellwords'
 require_relative '../command'
+require_relative '../interaction_tree'
 require_relative 'compose'
 
 module Dip
   module Commands
     class Run < Dip::Command
-      def initialize(cmd, subcmd = nil, *argv)
-        @cmd = cmd.to_sym
-        @subcmd = subcmd.to_sym if subcmd
-        @argv = argv
-        @config = ::Dip.config.interaction
+      def initialize(cmd, *argv)
+        @command, @argv = InteractionTree.
+                          new(Dip.config.interaction).
+                          find(cmd, *argv)&.
+                          values_at(:command, :argv)
+
+        raise Dip::Error, "Command `#{[cmd, *argv].join(' ')}` not recognized!" unless command
+
+        Dip.env.merge(command[:environment])
       end
 
-      # TODO: Refactor
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def execute
-        command = @config.fetch(@cmd)
-        command[:subcommands] ||= {}
-
-        if (subcommand = command[:subcommands].fetch(@subcmd, {})).any?
-          subcommand[:command] ||= nil
-          command.merge!(subcommand)
-        elsif @subcmd
-          @argv.unshift(@subcmd.to_s)
-        end
+        Dip::Commands::Compose.new(
+          command[:compose][:method],
+          *compose_arguments
+        ).execute
+      end
 
-        Dip.env.merge(command[:environment]) if command[:environment]
+      private
 
-        compose_method = command.fetch(:compose_method, "run").to_s
+      attr_reader :command, :argv
 
-        compose_argv = []
-        compose_argv.concat(prepare_compose_run_options(command[:compose_run_options]))
+      def compose_arguments
+        compose_argv = command[:compose][:run_options].dup
 
-        if compose_method == "run"
+        if command[:compose][:method] == "run"
           compose_argv.concat(run_vars)
           compose_argv << "--rm"
         end
 
-        compose_argv << command.fetch(:service).to_s
-        compose_argv += command[:command].to_s.shellsplit
-        compose_argv.concat(@argv)
-
-        Dip::Commands::Compose.new(compose_method, *compose_argv).execute
-      end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
-
-      def prepare_compose_run_options(value)
-        return [] unless value
+        compose_argv << command.fetch(:service)
+        compose_argv.concat(command[:command].to_s.shellsplit)
+        compose_argv.concat(argv)
 
-        value.map do |o|
-          o = o.start_with?("-") ? o : "--#{o}"
-          o.shellsplit
-        end.flatten
+        compose_argv
       end
 
       def run_vars

data/lib/dip/config.rb

@@ -3,6 +3,7 @@
 require "yaml"
 require "erb"
 
+require "dip/version"
 require "dip/ext/hash"
 
 using ActiveSupportHashHelpers
@@ -52,6 +53,13 @@ module Dip
       raise ArgumentError, "Dip config not found at path '#{self.class.path}'" unless self.class.exist?
 
       config = self.class.load_yaml
+
+      unless Gem::Version.new(Dip::VERSION) >= Gem::Version.new(config.fetch(:version))
+        raise VersionMismatchError, "Your dip version is `#{Dip::VERSION}`, " \
+                                    "but config requires minimum version `#{config[:version]}`. " \
+                                    "Please upgrade your dip!"
+      end
+
       config.deep_merge!(self.class.load_yaml(self.class.override_path))
 
       @config = config

data/lib/dip/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Dip
+  Error = Class.new(StandardError)
+
+  class VersionMismatchError < Dip::Error
+  end
+end

data/lib/dip/interaction_tree.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "shellwords"
+require "dip/ext/hash"
+
+using ActiveSupportHashHelpers
+
+module Dip
+  class InteractionTree
+    def initialize(entries)
+      @entries = entries
+    end
+
+    def find(name, *argv)
+      entry = entries[name.to_sym]
+      return unless entry
+
+      commands = expand(name, entry)
+
+      keys = [name, *argv]
+      rest = []
+
+      keys.size.times do
+        if (command = commands[keys.join(" ")])
+          return {command: command, argv: rest.reverse!}
+        else
+          rest << keys.pop
+        end
+      end
+    end
+
+    def list
+      entries.each_with_object({}) do |(name, entry), memo|
+        expand(name.to_s, entry, tree: memo)
+      end
+    end
+
+    private
+
+    attr_reader :entries
+
+    def expand(name, entry, tree: {})
+      cmd = build_command(entry)
+
+      tree[name] = cmd
+
+      entry[:subcommands]&.each do |sub_name, sub_entry|
+        sub_command_defaults!(sub_entry)
+
+        expand("#{name} #{sub_name}", entry.deep_merge(sub_entry), tree: tree)
+      end
+
+      tree
+    end
+
+    def build_command(entry)
+      {
+        description: entry[:description],
+        service: entry.fetch(:service),
+        command: entry[:command],
+        environment: entry[:environment] || {},
+        compose: {
+          method: entry.dig(:compose, :method) || entry[:compose_method] || "run",
+          run_options: compose_run_options(entry.dig(:compose, :run_options) || entry[:compose_run_options])
+        }
+      }
+    end
+
+    def sub_command_defaults!(entry)
+      entry[:command] ||= nil
+      entry[:subcommands] ||= nil
+      entry[:description] ||= nil
+    end
+
+    def compose_run_options(value)
+      return [] unless value
+
+      value.map do |o|
+        o = o.start_with?("-") ? o : "--#{o}"
+        o.shellsplit
+      end.flatten
+    end
+  end
+end

data/lib/dip/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dip
 version: !ruby/object:Gem::Version
-  version: 3.8.3
+  version: 4.0.0
 platform: ruby
 authors:
 - bibendi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2019-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -144,13 +144,16 @@ files:
 - lib/dip/commands/compose.rb
 - lib/dip/commands/console.rb
 - lib/dip/commands/dns.rb
+- lib/dip/commands/list.rb
 - lib/dip/commands/nginx.rb
 - lib/dip/commands/provision.rb
 - lib/dip/commands/run.rb
 - lib/dip/commands/ssh.rb
 - lib/dip/config.rb
 - lib/dip/environment.rb
+- lib/dip/errors.rb
 - lib/dip/ext/hash.rb
+- lib/dip/interaction_tree.rb
 - lib/dip/run_vars.rb
 - lib/dip/version.rb
 homepage: https://github.com/bibendi/dip
@@ -166,14 +169,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ruby gem CLI tool for better interacting docker-compose files.