terraspace 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 856fb06902999857dcda1fd2a82709f7f01487a1b94420361cc7c7474df81c3e
-  data.tar.gz: cc60137b36d9a25928b410f2ef4b65467647674a378e8732e6c55e90d2e246ca
+  metadata.gz: f265061c3973d32dcbea50e12b291ee22041dc2e5bc2cf2521907dd4d74b0703
+  data.tar.gz: 97e6064b47fe37f11660fe05512e1750b23f96cd7bc7ea1bef0aa512884922de
 SHA512:
-  metadata.gz: 644e41b44f03afcaab0c6e261b7021811da19dc24d8e16d1a96fbd6516d84fc714b5fe9d6a9a0042a323a0c4919561e3236c6a3979b1d0132c850309d0eb2763
-  data.tar.gz: a74a1d2c00910e3214fc373bb21b2ccdec57f41ab628fe123ba45816ae165d875bfa543057dea518ee6457e7a1bdbc39f6dfa4e7d32e3794270d2c3153b2d17b
+  metadata.gz: bb0ccae4efe36fae839a755561e9b6829b998c4ec653f7a9a24c8a67a6e9da9ff9e5b81ad1134018edceed75b5859e12cce280819e2792a203da7a65f4997087
+  data.tar.gz: '0269f857a01274f4c9b64b051c724fff030582e2d62b9222da04ae0828e7770160645a4dee01a0a0c791921197d08ce87f420e5fa24678e961e76fb267c9377b'

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [1.0.4] - 2022-01-21
+- [#193](https://github.com/boltops-tools/terraspace/pull/193) improve all include_stacks and exclude_stacks option
+
 ## [1.0.3] - 2022-01-20
 - [#192](https://github.com/boltops-tools/terraspace/pull/192) run super-early boot hooks before dotenv load
 

data/lib/terraspace/compiler/select.rb

@@ -1,28 +1,84 @@
 module Terraspace::Compiler
   class Select
+    include Terraspace::Util::Logging
+
     def initialize(path)
       @path = path
       @stack_name = extract_stack_name(path)
     end
 
     def selected?
-      all = Terraspace.config.all
-      # Key difference between include_stacks vs all.include_stacks option is that
-      # the option can be nil. The local variable is guaranteed to be an Array.
-      # This simplifies the logic.
-      include_stacks = all.include_stacks || []
-      ignore_stacks  = all.ignore_stacks  || []
-
-      if all.include_stacks.nil?
-        !ignore_stacks.include?(@stack_name)
+      ignore_stacks_deprecation_warning
+      if include_stacks.nil? && exclude_stacks.nil?
+        true
+      elsif include_stacks.nil?
+        !exclude_stacks.include?(@stack_name)
+      elsif exclude_stacks.nil?
+        include_stacks.include?(@stack_name)
       else
-        stacks = include_stacks - ignore_stacks
+        stacks = include_stacks - exclude_stacks
         stacks.include?(@stack_name)
       end
     end
 
+    def include_stacks
+      include_option(:include_stacks)
+    end
+
+    def exclude_stacks
+      include_option(:exclude_stacks)
+    end
+
+    def include_option(name)
+      option = all[name]  # IE: include_stacks or exclude_stacks
+      option ||= all[:ignore_stacks] if name == :exclude_stacks
+      case option
+      when nil
+        return nil
+      when Array
+        return option
+      when -> (c) { c.respond_to?(:public_instance_methods) && c.public_instance_methods.include?(:call) }
+        object= option.new
+      when -> (c) { c.respond_to?(:call) }
+        object = option
+      else
+        raise "Invalid option for config.all.#{name}"
+      end
+
+      if object
+        result = object.call(@stack_name)
+        unless result.is_a?(Array) || result.is_a?(NilClass)
+          message = "ERROR: The config.all.#{name} needs to return an Array or nil"
+          logger.info message.color(:yellow)
+          logger.info <<~EOL
+            The config.all.#{name} when assigned a class, object, or proc must implement
+            the call method and return an Array or nil.
+            The current return value is a #{result.class}
+          EOL
+          raise message
+        end
+      end
+      result
+    end
+
+  private
+    def all
+      Terraspace.config.all
+    end
+
     def extract_stack_name(path)
       path.sub(%r{.*(app|vendor)/stacks/}, '')
     end
+
+    @@ignore_stacks_deprecation_warning = nil
+    def ignore_stacks_deprecation_warning
+      return unless all.ignore_stacks
+      return if @@ignore_stacks_deprecation_warning
+      puts <<~EOL.color(:yellow)
+        DEPRECATED:  config.all.ignore_stacks
+        Instead use: config.all.exclude_stacks
+      EOL
+      @@ignore_stacks_deprecation_warning = true
+    end
   end
 end

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport