dip 3.5.1 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ddf8801ef01a76da6d71d1b32957bde546c51dd1886c25096f6ca4422d740d5
-  data.tar.gz: 8b49bd15402dfcd852d6e1b80e9907f1f92babc0ab8fc789e4c38c5b8e44a558
+  metadata.gz: 3246e04b08a0a56b6e0affd8eff3d770647145546f3c47425291fd8f6f731da4
+  data.tar.gz: d68016e14a196cb6265dcc7a37782df46d1ba911921aab9bc42d7e62e6ed7230
 SHA512:
-  metadata.gz: 979d79ae46e6449c74e650c544a0249b1f5d6ae423a314b5e96cc940ac9586d09b157ffbe28c06b6a623c28ff6b06a57bac7035efd9beb25be2195e96934f8a1
-  data.tar.gz: 27cc30b7d126641d8cc1c380977288a9e541fd6dedd4b3e734bef5f572a5a753d7f346b945df845ba9e049b797792f9428f96aa4468009c8a388e808b3d9169e
+  metadata.gz: 9a846265e4fae5e87cd5e4e0ff75c7c7b4c6a600113fe5ffe509bec059aff169c53e45512408034fba1c22e6e23dcf9802730aee64952f05e301f9734bd9f775
+  data.tar.gz: bf3372c2dcae8432c1faf37a2d807b5214f1aa26f934195191a5abfcc8d37cd60c87683e9b59769ec5d4ee5028001e9410287cccc4d38b2ddb8db51041d53c94

data/README.md

@@ -6,30 +6,57 @@
 
 Docker Interaction Process
 
-CLI utility for straightforward provisioning and interacting with an application configured by docker-compose.
+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.
 
-DIP also contains commands for running support containers such as ssh-agent and DNS server.
+<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>
 
-## Installation
+## Presentations and examples
+
+- [Local development with Docker containers](https://slides.com/bibendi/dip)
+- [Dockerized Ruby on Rails application](https://github.com/bibendi/dip-example-rails)
+- [Dockerized Node.js application](https://github.com/bibendi/yt-graphql-react-event-booking-api)
+- [Dockerized Ruby gem](https://github.com/bibendi/schked)
+
+[![asciicast](https://asciinema.org/a/210236.svg)](https://asciinema.org/a/210236)
+
+## Integration with shell
+
+Dip can be injected into current shell. For now, it supported ZSH only.
 
 ```sh
-gem install dip
+dip console | source /dev/stdin
 ```
 
-## Changelog
+After that we can type commands without `dip` prefix. For example:
 
-https://github.com/bibendi/dip/releases
+```sh
+<run-command> *any-args
+compose *any-compose-arg
+up <service>
+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.
+
+Also, in shell mode Dip is trying to determine passed manually environment variables. For example:
+
+```sh
+VERSION=20180515103400 rails db:migrate:down
+```
+
+## Installation
 
+```sh
+gem install dip
+```
 
 ## Docker installation
 
 - [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
@@ -39,6 +66,15 @@ dip SUBCOMMAND --help
 
 ### dip.yml
 
+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. 
+`dip.yml` reference will be written soon. 
+Also, you can check out examples in the top.       
+
+
 ```yml
 version: '2'
 
@@ -53,7 +89,7 @@ compose:
   project_name: bear
 
 interaction:
-  sh:
+  bash:
     service: app
     compose_run_options: [no-deps]
 
@@ -77,16 +113,16 @@ interaction:
     subcommands:
       s:
         service: web
-        compose_method: up
+        compose_run_options: [service-ports]
 
   psql:
     service: app
     command: psql -h pg -U postgres
 
 provision:
+  - dip compose down --volumes
   - dip compose up -d pg redis
-  - dip bundle install
-  - dip rake db:migrate
+  - dip bash -c ./bin/setup
 ```
 
 ### dip run
@@ -119,32 +155,6 @@ dip compose COMMAND [OPTIONS]
 dip compose up -d redis
 ```
 
-### Integration with shell
-
-Dip can be injected into current shell. For now, it supported ZSH only.
-
-```sh
-dip console | source /dev/stdin
-```
-
-After that we can type commands without `dip` prefix. For example:
-
-```sh
-<run-command> *any-args
-compose *any-compose-arg
-up <service>
-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.
-
-Also, in shell mode Dip is trying to determine passed manually environment variables. For example:
-
-```sh
-VERSION=20180515103400 rails db:migrate:down
-```
-
 ### dip ssh
 
 Runs ssh-agent container based on https://github.com/whilp/ssh-agent with your ~/.ssh/id_rsa.
@@ -237,3 +247,7 @@ dip dns up
 cd foo-project
 dip compose exec foo-web curl http://www.bar-app.docker/api/v1/baz_service
 ```
+
+## Changelog
+
+https://github.com/bibendi/dip/releases

data/exe/dip

@@ -21,7 +21,7 @@ end
 
 begin
   Dip::CLI.start(ARGV)
-rescue Dip::Error => err
-  puts "ERROR: #{err.message}"
+rescue Dip::Error => e
+  puts "ERROR: #{e.message}"
   exit 1
 end

data/lib/dip.rb

@@ -12,7 +12,7 @@ module Dip
     end
 
     def env
-      @env ||= Dip::Environment.new(config.exist? ? config.environment : {})
+      @env ||= Dip::Environment.new(Dip::Config.exist? ? config.environment : {})
     end
 
     def bin_path

data/lib/dip/commands/console.rb

@@ -55,7 +55,7 @@ module Dip
         end
 
         def execute
-          if Dip.config.exist?
+          if Dip::Config.exist?
             alias_interaction if Dip.config.interaction
             alias_compose
             add_alias("provision")

data/lib/dip/config.rb

@@ -3,16 +3,35 @@
 require "yaml"
 require "erb"
 
+require "dip/ext/hash"
+
+using ActiveSupportHashHelpers
+
 module Dip
   class Config
     DEFAULT_PATH = "dip.yml"
 
-    def initialize
-      @path = ENV["DIP_FILE"] || File.join(Dir.pwd, DEFAULT_PATH)
-    end
+    class << self
+      def exist?
+        File.exist?(path)
+      end
+
+      def path
+        ENV["DIP_FILE"] || File.join(Dir.pwd, DEFAULT_PATH)
+      end
+
+      def override_path
+        path.gsub(/\.yml$/, ".override.yml")
+      end
 
-    def exist?
-      File.exist?(@path)
+      def load_yaml(file_path = path)
+        return {} unless File.exist?(file_path)
+
+        YAML.safe_load(
+          ERB.new(File.read(file_path)).result,
+          [], [], true
+        ).deep_symbolize_keys!
+      end
     end
 
     %i[environment compose interaction provision].each do |key|
@@ -28,39 +47,14 @@ module Dip
     private
 
     def config
-      @config ||= load
-    end
-
-    def load
-      raise ArgumentError, "Dip config not found at path '#{@path}'" unless exist?
+      return @config if @config
 
-      @config = YAML.safe_load(
-        ERB.new(File.read(@path)).result,
-        [], [], true
-      )
+      raise ArgumentError, "Dip config not found at path '#{self.class.path}'" unless self.class.exist?
 
-      deep_symbolyze_keys!(@config)
+      config = self.class.load_yaml
+      config.deep_merge!(self.class.load_yaml(self.class.override_path))
 
-      @config
-    end
-
-    # rubocop:disable Metrics/MethodLength
-    def deep_symbolyze_keys!(object)
-      case object
-      when Hash
-        object.keys.each do |key|
-          value = object.delete(key)
-          key = key.to_sym if key.is_a?(String)
-          object[key] = deep_symbolyze_keys!(value)
-        end
-
-        object
-      when Array
-        object.map! { |e| deep_symbolyze_keys!(e) }
-      else
-        object
-      end
+      @config = config
     end
-    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/dip/environment.rb

@@ -2,7 +2,7 @@
 
 module Dip
   class Environment
-    VAR_REGEX = /\$[\{]?(?<var_name>[a-zA-Z_][a-zA-Z0-9_]*)[\}]?/
+    VAR_REGEX = /\$[\{]?(?<var_name>[a-zA-Z_][a-zA-Z0-9_]*)[\}]?/.freeze
     SPECIAL_VARS = {"DIP_OS" => :find_dip_os}.freeze
 
     attr_reader :vars

data/lib/dip/ext/hash.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# active_support helpers
+module ActiveSupportHashHelpers
+  refine Hash do
+    def deep_symbolize_keys!
+      deep_transform_keys! { |key| key.respond_to?(:to_sym) ? key.to_sym : key }
+    end
+
+    def deep_transform_keys!(&block)
+      keys.each do |key|
+        value = delete(key)
+        self[yield(key)] = value.is_a?(Hash) ? value.deep_transform_keys!(&block) : value
+      end
+
+      self
+    end
+
+    def deep_merge(other_hash, &block)
+      dup.deep_merge!(other_hash, &block)
+    end
+
+    def deep_merge!(other_hash, &block)
+      merge!(other_hash) do |key, this_val, other_val|
+        if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+          this_val.deep_merge(other_val, &block)
+        elsif block_given?
+          block.call(key, this_val, other_val)
+        else
+          other_val
+        end
+      end
+    end
+  end
+end

data/lib/dip/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dip
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.6.0
 platform: ruby
 authors:
 - bibendi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-17 00:00:00.000000000 Z
+date: 2019-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -28,14 +28,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,7 @@ files:
 - lib/dip/commands/ssh.rb
 - lib/dip/config.rb
 - lib/dip/environment.rb
+- lib/dip/ext/hash.rb
 - lib/dip/run_vars.rb
 - lib/dip/version.rb
 homepage: https://github.com/bibendi/dip