sparkle_formation 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0a71f19541a41b7c1939abd94c39a2d9c44389f
-  data.tar.gz: b49e09f6abe9c535eebe042bb052e8cc87ba91a3
+  metadata.gz: f13e8abe07f3752130dc2655eba524647f390618
+  data.tar.gz: 874980adb868101566eb4756170280a5a1faec61
 SHA512:
-  metadata.gz: 6deda0e42edd85bc7e184840dcbd6e073b31744ca00eae9ab790415bb10b1467d915e4757516d3e863f2e244c4fff554dcbe214b5b137c8ed27694bbefe28187
-  data.tar.gz: 09960fd747e2d13f97716aa28c790aa2d0716f83ff0d8ae4700a81b13e7d91f326f20957f0435032fac5282fb34ec8991ccb86d5e07975a33e2023ef0f85a3be
+  metadata.gz: 5f1cb9bec94362ba83200fb0d9f47ce310799118d3903a565a9b1ac667bb28751a9fdfea0fb952fffce83e3eb6cfbd5af5120672ceb2332b5113547cacc3f724
+  data.tar.gz: 5b53d67cb905a968cab3932096e4603b324c68d133d76e66fea82982421b8c96654b4bf09df2db84149634981c14103c811972f44404e597d3e118d7e95e6971

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.4.0
+* Add support for compile time parameters
+* Backport SparkleStruct updates
+* Track parent stack within nested stacks
+* Fix nested stack check method which assumed resources hash
+
 ## v0.3.0
 * Update `or!` helper method to take multiple arguments
 * Support non-ref values in `map!` (#19)

data/lib/sparkle_formation/sparkle_formation.rb

@@ -121,9 +121,13 @@ class SparkleFormation
     # @yield block to execute
     # @return [SparkleStruct] provided base or new struct
     def build(base=nil, &block)
-      struct = base || SparkleStruct.new
-      struct.instance_exec(&block)
-      @_struct = struct
+      if(base || block.nil?)
+        struct = base || SparkleStruct.new
+        struct.instance_exec(&block)
+        @_struct = struct
+      else
+        block
+      end
     end
 
     # Load component
@@ -132,7 +136,6 @@ class SparkleFormation
     # @return [SparkleStruct] resulting struct
     def load_component(path)
       self.instance_eval(IO.read(path), path, 1)
-      @_struct
     end
 
     # Load all dynamics within a directory
@@ -226,6 +229,12 @@ class SparkleFormation
     # @note if symbol is provided for template, double underscores
     #   will be used for directory separator and dashes will match underscores
     def nest(template, struct, *args, &block)
+      options = args.detect{|i| i.is_a?(Hash)}
+      if(options)
+        args.delete(options)
+      else
+        options = {}
+      end
       spath = SparkleFormation.new('stub').sparkle_path
       resource_name = [template.to_s.gsub(/(\/|__|-)/, '_'), *args].compact.join('_').to_sym
       path = template.is_a?(Symbol) ? template.to_s.gsub('__', '/') : template.to_s
@@ -237,10 +246,12 @@ class SparkleFormation
         raise ArgumentError.new("Failed to locate nested stack file! (#{template.inspect} -> #{path.inspect})")
       end
       instance = self.instance_eval(IO.read(file), file, 1)
+      instance.parent = struct._self
+      instance.name = Bogo::Utility.camel(resource_name)
       struct.resources.set!(resource_name) do
         type 'AWS::CloudFormation::Stack'
       end
-      struct.resources.__send__(resource_name).properties.stack instance.compile
+      struct.resources.__send__(resource_name).properties.stack instance.compile(:state => options[:parameters])
       if(block_given?)
         struct.resources.__send__(resource_name).instance_exec(&block)
       end
@@ -294,7 +305,7 @@ class SparkleFormation
   end
 
   # @return [Symbol] name of formation
-  attr_reader :name
+  attr_accessor :name
   # @return [String] base path
   attr_reader :sparkle_path
   # @return [String] components path
@@ -309,6 +320,12 @@ class SparkleFormation
   attr_reader :load_order
   # @return [Hash] parameters for stack generation
   attr_reader :parameters
+  # @return [Hash] state hash for compile time parameters
+  attr_accessor :compile_state
+  # @return [Proc] block to call for setting compile time parameters
+  attr_accessor :compile_time_parameter_setter
+  # @return [SparkleFormation] parent instance
+  attr_accessor :parent
 
   # Create new instance
   #
@@ -341,7 +358,11 @@ class SparkleFormation
       require 'sparkle_formation/aws'
       SfnAws.load!
     end
-    @parameters = set_generation_parameters!(options.fetch(:parameters, {}))
+    @parameters = set_generation_parameters!(
+      options.fetch(:parameters,
+        options.fetch(:compile_time_parameters, {})
+      )
+    )
     @components = SparkleStruct.hashish.new
     @load_order = []
     @overrides = []
@@ -351,7 +372,33 @@ class SparkleFormation
     @compiled = nil
   end
 
-  ALLOWED_GENERATION_PARAMETERS = ['type', 'default']
+  # Get or set the compile time parameter setting block. If a get
+  # request the ancestor path will be searched to root
+  #
+  # @yield block to set compile time parameters
+  # @yieldparam [SparkleFormation]
+  # @return [Proc, NilClass]
+  def compile_time_parameter_setter(&block)
+    if(block)
+      @compile_time_parameter_setter = block
+    else
+      if(@compile_time_parameter_setter)
+        @compile_time_parameter_setter
+      else
+        parent.nil? ? nil : parent.compile_time_parameter_setter
+      end
+    end
+  end
+
+  # Set the compile time parameters for the stack if the setter proc
+  # is available
+  def set_compile_time_parameters!
+    if(compile_time_parameter_setter)
+      compile_time_parameter_setter.call(self)
+    end
+  end
+
+  ALLOWED_GENERATION_PARAMETERS = ['type', 'default', 'description', 'multiple', 'prompt_when_nested']
   VALID_GENERATION_PARAMETER_TYPES = ['String', 'Number']
 
   # Validation parameters used for template generation to ensure they
@@ -377,7 +424,7 @@ class SparkleFormation
   # @param block [Proc]
   # @return [TrueClass]
   def block(block)
-    @components[:__base__] = self.class.build(&block)
+    @components[:__base__] = block
     @load_order << :__base__
     true
   end
@@ -416,13 +463,19 @@ class SparkleFormation
   # @option args [Hash] :state local state parameters
   # @return [SparkleStruct]
   def compile(args={})
+    if(args.has_key?(:state))
+      @compile_state = args[:state]
+      @compiled = nil
+    end
     unless(@compiled)
+      set_compile_time_parameters!
       compiled = SparkleStruct.new
-      if(args[:state])
-        compiled.set_state!(args[:state])
+      compiled._set_self(self)
+      if(compile_state)
+        compiled.set_state!(compile_state)
       end
       @load_order.each do |key|
-        compiled._merge!(components[key])
+        self.class.build(compiled, &components[key])
       end
       @overrides.each do |override|
         if(override[:args] && !override[:args].empty?)
@@ -430,6 +483,9 @@ class SparkleFormation
         end
         self.class.build(compiled, &override[:block])
       end
+      if(compile_state)
+        compiled.outputs.compile_state.value MultiJson.dump(compile_state)
+      end
       @compiled = compiled
     end
     @compiled
@@ -438,14 +494,14 @@ class SparkleFormation
   # Clear compiled stack if cached and perform compilation again
   #
   # @return [SparkleStruct]
-  def recompile
+  def recompile(args={})
     @compiled = nil
-    compile
+    compile(args)
   end
 
   # @return [TrueClass, FalseClass] includes nested stacks
   def nested?
-    !!compile.dump!['Resources'].detect do |r_name, resource|
+    !!compile.dump!.fetch('Resources', {}).detect do |r_name, resource|
       resource['Type'] == 'AWS::CloudFormation::Stack'
     end
   end

data/lib/sparkle_formation/sparkle_struct.rb

@@ -1,14 +1,65 @@
 require 'sparkle_formation'
+require 'attribute_struct/monkey_camels'
 
 class SparkleFormation
   # SparkleFormation customized AttributeStruct
   class SparkleStruct < AttributeStruct
+
     include ::SparkleFormation::SparkleAttribute
     # @!parse include ::SparkleFormation::SparkleAttribute
 
+    # Override initializer to force desired behavior
+    def initialize(*_)
+      super
+      @_camel_keys = true
+      _set_state :hash_load_struct => true
+    end
+
+    # Set SparkleFormation instance
+    #
+    # @param inst [SparkleFormation]
+    # @return [SparkleFormation]
+    def _set_self(inst)
+      unless(inst.is_a?(::SparkleFormation))
+        ::Kernel.raise ::TypeError.new "Expecting type of `SparkleFormation` but got `#{inst.class}`"
+      end
+      @self = inst
+    end
+
+    # @return [SparkleFormation]
+    def _self(*_)
+      unless(@self)
+        if(_parent.nil?)
+          ::Kernel.raise ::ArgumentError.new 'Creator did not provide return reference!'
+        else
+          _parent._self
+        end
+      else
+        @self
+      end
+    end
+
     # @return [Class]
     def _klass
       ::SparkleFormation::SparkleStruct
     end
+
+    # Override the state to force helpful error when no value has been
+    # provided
+    #
+    # @param arg [String, Symbol] name of parameter
+    # @return [Object]
+    # @raises [ArgumentError]
+    def _state(arg)
+      result = super
+      if(@self && result.nil?)
+        if(_self.parameters.keys.map(&:to_s).include?(arg.to_s))
+          ::Kernel.raise ::ArgumentError.new "No value provided for compile time parameter: `#{arg}`!"
+        end
+      end
+      result
+    end
+    alias_method :state!, :_state
+
   end
 end

data/lib/sparkle_formation/version.rb

@@ -18,5 +18,5 @@
 
 class SparkleFormation
   # Current library version
-  VERSION = Gem::Version.new('0.3.0')
+  VERSION = Gem::Version.new('0.4.0')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparkle_formation
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-13 00:00:00.000000000 Z
+date: 2015-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attribute_struct
@@ -81,9 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Cloud Formation builder
 test_files: []
-has_rdoc: