sparkle_formation 0.2.10 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b479d29d2362b0b07927cc975a6908b1600df820
-  data.tar.gz: 8d0477f4ac1aedb6cb7fd471711194a0a93b50a2
+  metadata.gz: 46a1c4f04178bc15ec4ebce5da8046a7187bf9cb
+  data.tar.gz: 74608ee05fd93fdcbe70762a0c6702d5a0f2aeb0
 SHA512:
-  metadata.gz: 56d720122b2bcd063c6a2fb7ab369d9497794aa182ef5763dd9266389f9799c018f406ec786ad728f8bcf42c005ec41e2e07bc17832d9ad4989be4eb700247ff
-  data.tar.gz: 1df868daea61d465381fd2b934c32257013bd8f914814be7b365b7bf08bedeb5842a5074bf632d3298b7907279f0acd290f7570ba2222c5c40cc2a92bf10552a
+  metadata.gz: 33caa72fa07477b8c4bd48c6d2da66817fc292bd22f2d6817234673f17b95abd3532d3c6e29a6d4b2776c46e47557b17c33ba6647f2985e97dd8add9b14b3ad2
+  data.tar.gz: 51bf91bef24f3618847f31815be27964aa858203c5e964bee9b66aee32e77e76d290b405b545ac40e7e16d53a7ff37f34819601096ddbb35af6fd07294a67bb5

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v0.2.12
+* Stubs for template generation parameters
+* Add `no_value!` helper method
+* Force path resets with `sparkle_path` is set
+* Include all missing pseudo parameter helpers
+* Provide more control on dynamic naming
+
 ## v0.2.10
 * Add helper for generating no value
 * Fix Fn::If generator (#35 thanks @yhuang !)

data/lib/sparkle_formation/sparkle_attribute.rb

@@ -234,6 +234,31 @@ class SparkleFormation
     end
     alias_method :no_value!, :_no_value
 
+    def _region
+      _ref('AWS::Region')
+    end
+    alias_method :region!, :_region
+
+    def _notification_arns
+      _ref('AWS::NotificationARNs')
+    end
+    alias_method :notification_arns!, :_notification_arns
+
+    def _account_id
+      _ref('AWS::AccountId')
+    end
+    alias_method :account_id!, :_account_id
+
+    def _stack_id
+      _ref('AWS::StackId')
+    end
+    alias_method :stack_id!, :_stack_id
+
+    def _stack_name
+      _ref('AWS::StackName')
+    end
+    alias_method :stack_name!, :_stack_name
+
     # Execute system command
     #
     # @param command [String]
@@ -243,6 +268,20 @@ class SparkleFormation
     end
     alias_method :system!, :_system
 
+    # @return [TrueClass, FalseClass] resource can be tagged
+    def taggable?
+      if(defined?(SfnAws))
+        if(self[:type])
+          resource = SfnAws.lookup(self[:type].gsub('::', '_').downcase)
+          resource && resource[:properties].include?('Tags')
+        else
+          if(self._parent)
+            self._parent.taggable?
+          end
+        end
+      end
+    end
+
     # @return [TrueClass, FalseClass]
     def rhel?
       !!@platform[:rhel]

data/lib/sparkle_formation/sparkle_formation.rb

@@ -55,9 +55,9 @@ class SparkleFormation
     def sparkle_path=(path=nil)
       if(path)
         custom_paths[:sparkle_path] = path
-        custom_paths[:components_directory] ||= File.join(path, 'components')
-        custom_paths[:dynamics_directory] ||= File.join(path, 'dynamics')
-        custom_paths[:registry_directory] ||= File.join(path, 'registry')
+        custom_paths[:components_directory] = File.join(path, 'components')
+        custom_paths[:dynamics_directory] = File.join(path, 'dynamics')
+        custom_paths[:registry_directory] = File.join(path, 'registry')
       end
       custom_paths[:sparkle_path]
     end
@@ -102,11 +102,17 @@ class SparkleFormation
     # Compile file
     #
     # @param path [String] path to file
-    # @param args [Object] use :sparkle to return struct
+    # @param args [Object] use :sparkle to return struct. provide Hash
+    #   to pass through when compiling ({:state => {}})
     # @return [Hashish, SparkleStruct]
     def compile(path, *args)
       formation = self.instance_eval(IO.read(path), path, 1)
-      args.include?(:sparkle) ? formation : formation.compile._dump
+      if(args.delete(:sparkle))
+        formation
+      else
+        comp_arg = args.detect{|i| i.is_a?(Hash) }
+        (comp_arg ? formation.compile(comp_arg) : formation.compile)._dump
+      end
     end
 
     # Execute given block within struct context
@@ -252,7 +258,8 @@ class SparkleFormation
         _name, _config = *args
         _config ||= {}
         return unless _name
-        new_resource = struct.resources.__send__("#{_name}_#{dynamic_name}".to_sym)
+        resource_name = "#{_name}_#{_config.delete(:resource_name_suffix) || dynamic_name}".to_sym
+        new_resource = struct.resources.__send__(resource_name)
         new_resource.type lookup_key
         properties = new_resource.properties
         SfnAws.resource(dynamic_name, :properties).each do |prop_name|
@@ -300,6 +307,8 @@ class SparkleFormation
   attr_reader :components
   # @return [Array] order of loading
   attr_reader :load_order
+  # @return [Hash] parameters for stack generation
+  attr_reader :parameters
 
   # Create new instance
   #
@@ -309,6 +318,7 @@ class SparkleFormation
   # @option options [String] :components_directory custom components path
   # @option options [String] :dynamics_directory custom dynamics path
   # @option options [String] :registry_directory custom registry path
+  # @option options [Hash] :parameters parameters for stack generation
   # @option options [Truthy, Falsey] :disable_aws_builtins do not load builtins
   # @yield base context
   def initialize(name, options={}, &block)
@@ -331,6 +341,7 @@ class SparkleFormation
       require 'sparkle_formation/aws'
       SfnAws.load!
     end
+    @parameters = set_generation_parameters!(options.fetch(:parameters, {}))
     @components = SparkleStruct.hashish.new
     @load_order = []
     @overrides = []
@@ -340,6 +351,27 @@ class SparkleFormation
     @compiled = nil
   end
 
+  ALLOWED_GENERATION_PARAMETERS = ['type', 'default']
+  VALID_GENERATION_PARAMETER_TYPES = ['String', 'Number']
+
+  # Validation parameters used for template generation to ensure they
+  # are in the expected format
+  #
+  # @param params [Hash] parameter set
+  # @return [Hash] parameter set
+  # @raises [ArgumentError]
+  def set_generation_parameters!(params)
+    params.each do |name, value|
+      unless(value.is_a?(Hash))
+        raise TypeError.new("Expecting `Hash` type. Received `#{value.class}`")
+      end
+      if(key = value.keys.detect{|k| !ALLOWED_GENERATION_PARAMETERS.include?(k.to_s) })
+        raise ArgumentError.new("Invalid generation parameter key provided `#{key}`")
+      end
+    end
+    params
+  end
+
   # Add block to load order
   #
   # @param block [Proc]
@@ -380,10 +412,15 @@ class SparkleFormation
 
   # Compile the formation
   #
+  # @param args [Hash]
+  # @option args [Hash] :state local state parameters
   # @return [SparkleStruct]
-  def compile
+  def compile(args={})
     unless(@compiled)
       compiled = SparkleStruct.new
+      if(args[:state])
+        compiled.set_state!(args[:state])
+      end
       @load_order.each do |key|
         compiled._merge!(components[key])
       end
@@ -429,7 +466,7 @@ class SparkleFormation
   # @yieldparam template [Hash] nested stack template
   # @yieldreturn [String] remote URL
   # @return [Hash] dumped template hash
-  def apply_nesting
+  def apply_nesting(*args)
     hash = compile.dump!
     stacks = Hash[
       hash['Resources'].find_all do |r_name, resource|
@@ -448,6 +485,18 @@ class SparkleFormation
         resource['Properties']['TemplateURL'] = yield(resource_name, stack)
       end
     end
+    if(args.include?(:collect_outputs))
+      outputs_hash = Hash[
+        output_map do |name, value|
+          [name, {'Value' => {'Fn::GetAtt' => value}}]
+        end
+      ]
+      if(hash['Outputs'])
+        hash['Outputs'].merge!(outputs_hash)
+      else
+        hash['Outputs'] = outputs_hash
+      end
+    end
     hash
   end
 

data/lib/sparkle_formation/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparkle_formation
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.12
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-13 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attribute_struct