dip 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 027ac4456743eaef5ed3d2a461b15e57fcc13739500ef04bdedfca37b4c6c266
-  data.tar.gz: e5cdc4f2597241c242bc91f007ab35a2392feafbf924109f97f48ff330228997
+  metadata.gz: 0b6092ebf900ada263123eecb33ee04460d0d8c03421d7f77b99486b6a66941f
+  data.tar.gz: f2753b321d575b0417ca3153283d8181fdf78f9d75a393c0df74671b0343e8ab
 SHA512:
-  metadata.gz: 59685a0ab3f5d1174d58048d021b8f4f12d494aaa09773e0b0cfd05d4a2d12975c594efc7597b67e054912f5e6d75fdbd293ac7ca5ba69ab06af858f93dac1c5
-  data.tar.gz: 505a3e3657f17a0c01e1d785bfb23a86982ee42da7a8185ccf753de0116e7f18d082d66d11bac07031e43600c9397a74728de62e0a6d70191f9dbe939080f2da
+  metadata.gz: 4b8bd274d40759d1bcb770d9bc6318980d6de06ce6a2f8e6569b7605cdbe9e77b205480bbf7436ee415bad24176ee90928f450875c33aa6cb997f70f6ba4425b
+  data.tar.gz: dd228653949ce59936aa21b1e63c2f624c522c4fa050eba9f484180e87eccf3b06a44f173cdbbd682d1f6b1045540aaf6af33a194c6ba09ba7c6468031b1adbe

data/README.md

@@ -238,6 +238,92 @@ services:
 
 The container will run using the same user ID as your host machine.
 
+### Modules
+
+Modules are defined as array in `modules` section of dip.yml, modules are stored in `.dip` subdirectory of dip.yml directory.
+
+The main purpose of modules is to improve maintainability for a group of projects.
+Imagine having multiple gems which are managed with dip, each of them has the same commands, so to change one command in dip you need to update all gems individualy.
+
+With `modules` you can define a group of modules for dip.
+
+For example having setup as this:
+
+```yml
+# ./dip.yml
+modules:
+ - sasts
+ - rails
+
+...
+```
+
+```yml
+# ./.dip/sasts.yml
+interaction:
+  brakeman:
+    description: Check brakeman sast
+    command: docker run ...
+```
+
+```yml
+# ./.dip/rails.yml
+interaction:
+  annotate:
+    description: Run annotate command
+    service: backend
+    command: bundle exec annotate
+```
+
+Will be expanded to:
+
+```yml
+# resultant configuration
+interaction:
+  brakeman:
+    description: Check brakeman sast
+    command: docker run ...
+  annotate:
+    description: Run annotate command
+    service: backend
+    command: bundle exec annotate
+```
+
+Imagine `.dip` to be a submodule so it can be managed only in one place.
+
+If you want to override module command, you can redefine it in dip.yml
+
+```yml
+# ./dip.yml
+modules:
+ - sasts
+
+interaction:
+  brakeman:
+    description: Check brakeman sast
+    command: docker run another-image ...
+```
+
+```yml
+# ./.dip/sasts.yml
+interaction:
+  brakeman:
+    description: Check brakeman sast
+    command: docker run some-image ...
+```
+
+Will be expanded to:
+
+```yml
+# resultant configuration
+interaction:
+  brakeman:
+    description: Check brakeman sast
+    command: docker run another-image ...
+```
+
+Nested modules are not supported.
+
 ### dip run
 
 Run commands defined within the `interaction` section of dip.yml

data/lib/dip/config.rb

@@ -43,6 +43,10 @@ module Dip
         file_path&.exist?
       end
 
+      def modules_dir
+        file_path.dirname / ".dip"
+      end
+
       private
 
       attr_reader :override
@@ -90,6 +94,10 @@ module Dip
       finder.file_path
     end
 
+    def module_file(filename)
+      finder.modules_dir / "#{filename}.yml"
+    end
+
     def exist?
       finder.exist?
     end
@@ -125,10 +133,28 @@ module Dip
                                     "Please upgrade your dip!"
       end
 
+      base_config = {}
+
+      if (modules = config[:modules])
+        raise Dip::Error, "Modules should be specified as array" unless modules.is_a?(Array)
+
+        modules.each do |m|
+          file = module_file(m)
+          raise Dip::Error, "Could not find module `#{m}`" unless file.exist?
+
+          module_config = self.class.load_yaml(file)
+          raise Dip::Error, "Nested modules are not supported" if module_config[:modules]
+
+          base_config.deep_merge!(module_config)
+        end
+      end
+
+      base_config.deep_merge!(config)
+
       override_finder = ConfigFinder.new(work_dir, override: true)
-      config.deep_merge!(self.class.load_yaml(override_finder.file_path)) if override_finder.exist?
+      base_config.deep_merge!(self.class.load_yaml(override_finder.file_path)) if override_finder.exist?
 
-      @config = CONFIG_DEFAULTS.merge(config)
+      @config = CONFIG_DEFAULTS.merge(base_config)
     end
 
     def config_missing_error(config_key)

data/lib/dip/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dip
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - bibendi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor