sparkle_formation 1.2.0 → 2.0.0

data/lib/sparkle_formation/sparkle_attribute/rackspace.rb

@@ -0,0 +1,21 @@
+require 'sparkle_formation'
+
+class SparkleFormation
+
+  # Provides template helper methods
+  module SparkleAttribute
+
+    # Rackspace specific helper implementations
+    module Rackspace
+
+      # @!parse include SparkleFormation::SparkleAttribute::Heat
+
+      # Set customized struct behavior
+      def self.included(klass)
+        klass.include SparkleFormation::SparkleAttribute::Heat
+      end
+
+    end
+
+  end
+end

data/lib/sparkle_formation/sparkle_formation.rb

@@ -224,7 +224,7 @@ class SparkleFormation
       unless(result)
         message = "Failed to locate requested dynamic block for insertion: #{dynamic_name} " \
           "(valid: #{struct._self.sparkle.dynamics.keys.sort.join(', ')})"
-        if(struct._self.provider_resources.registry.keys.size > 1)
+        if(struct._self.provider_resources && struct._self.provider_resources.registry.keys.size > 1)
           t_name = struct._self.provider_resources.registry.keys.first
           message << "\nBuiltin dynamics pattern `#{t_name}` -> `:#{Bogo::Utility.snake(t_name.gsub('::', '_'))}`"
         end
@@ -266,7 +266,14 @@ class SparkleFormation
         nested_template.compile_state = options[:parameters]
       end
       struct.resources.set!(resource_name) do
-        type DEFAULT_STACK_RESOURCE
+        type struct._self.stack_resource_type
+      end
+      unless(struct._self.sparkle.empty?)
+        struct._self.sparkle.size.times do |idx|
+          nested_template.sparkle.add_sparkle(
+            struct._self.sparkle.sparkle_at(idx)
+          )
+        end
       end
       struct.resources[resource_name].properties.stack nested_template
       if(block_given?)
@@ -380,7 +387,8 @@ class SparkleFormation
         }
       )
     )
-    unless(options[:disable_aws_builtins])
+    self.provider = options.fetch(:provider, @parent ? @parent.provider : :aws)
+    if(provider == :aws || !options[:disable_aws_builtins])
       require 'sparkle_formation/aws'
     end
     @parameters = set_generation_parameters!(
@@ -388,21 +396,25 @@ class SparkleFormation
         options.fetch(:parameters, {})
       )
     )
-    @stack_resource_types = (
-      VALID_STACK_RESOURCES +
-      options.fetch(:stack_resource_types, [])
-    ).uniq
+    @stack_resource_types = [
+      stack_resource_type,
+      *options.fetch(:stack_resource_types, [])
+    ].compact.uniq
     @components = Smash.new
     @load_order = []
     @overrides = []
     @parent = options[:parent]
-    @provider = options.fetch(:provider, @parent ? @parent.provider : :aws)
     if(block)
       load_block(block)
     end
     @compiled = nil
   end
 
+  # @return [String] provider stack resource type
+  def stack_resource_type
+    DEFAULT_STACK_RESOURCE
+  end
+
   # Set remote API target for template to allow loading of
   # provider specific helpers and data if available. Setting
   # to a false-y value will disable helpers loading
@@ -412,6 +424,11 @@ class SparkleFormation
   def provider=(val)
     if(val)
       @provider = Bogo::Utility.snake(val).to_sym
+      provider_klass = Bogo::Utility.camel(@provider.to_s)
+      if(Provider.const_defined?(provider_klass))
+        extend Provider.const_get(provider_klass)
+      end
+      @provider
     else
       @provider = nil
     end
@@ -558,6 +575,12 @@ class SparkleFormation
       compiled = struct_class.new
       compiled._set_self(self)
       compiled._struct_class = struct_class
+      if(struct_class.const_defined?(:CAMEL_KEYS))
+        compiled._camel_keys = struct_class.const_get(:CAMEL_KEYS)
+      end
+      if(struct_class.const_defined?(:CAMEL_STYLE))
+        compiled._camel_style = struct_class.const_get(:CAMEL_STYLE)
+      end
       if(compile_state)
         compiled.set_state!(compile_state)
       end
@@ -587,71 +610,65 @@ class SparkleFormation
 
   # @return [Array<SparkleFormation>]
   def nested_stacks(*args)
-    compile.resources.keys!.map do |key|
-      if(stack_resource_type?(compile.resources[key].type))
-        result = [compile.resources[key].properties.stack]
-        if(args.include?(:with_resource))
-          result.push(compile[:resources][key])
-        end
-        if(args.include?(:with_name))
-          result.push(key)
+    if(compile[:resources])
+      compile.resources.keys!.map do |key|
+        if(stack_resource_type?(compile.resources[key].type))
+          result = [compile.resources[key].properties.stack]
+          if(args.include?(:with_resource))
+            result.push(compile[:resources][key])
+          end
+          if(args.include?(:with_name))
+            result.push(key)
+          end
+          result.size == 1 ? result.first : result
         end
-        result.size == 1 ? result.first : result
-      end
-    end.compact
+      end.compact
+    else
+      []
+    end
   end
 
   # @return [TrueClass, FalseClass] includes nested stacks
   def nested?(stack_hash=nil)
-    stack_hash = compile.dump! unless stack_hash
-    !!stack_hash.fetch('Resources', {}).detect do |_r_name, resource|
-      stack_resource_type?(resource['Type'])
+    if(stack_hash)
+      raise Error::Deprecated.new "Hash parameter no longer valid for this method (`#{self.class}##{__callee__}`)"
+    end
+    unless(compile.resources.nil?)
+      compile.resources._data.any? do |r_name, r_value|
+        stack_resource_type?(r_value.type)
+      end
     end
   end
 
   # @return [TrueClass, FalseClass] includes _only_ nested stacks
   def isolated_nests?(stack_hash=nil)
-    stack_hash = compile.dump! unless stack_hash
-    stack_hash.fetch('Resources', {}).all? do |_name, resource|
-      stack_resource_type?(resource['Type'])
+    if(stack_hash)
+      raise Error::Deprecated.new "Hash parameter no longer valid for this method (`#{self.class}##{__callee__}`)"
+    end
+    unless(compile.resources.nil?)
+      compile.resources._data.all? do |r_name, r_value|
+        stack_resource_type?(r_value.type)
+      end
     end
   end
 
   # @return [TrueClass, FalseClass] policies defined
   def includes_policies?(stack_hash=nil)
-    stack_hash = compile.dump! unless stack_hash
-    stack_hash.fetch('Resources', {}).any? do |_name, resource|
-      resource.key?('Policy')
+    if(stack_hash)
+      raise Error::Deprecated.new "Hash parameter no longer valid for this method (`#{self.class}##{__callee__}`)"
+    end
+    unless(compile.resources.nil?)
+      compile.resources._data.any? do |r_name, r_value|
+        !r_value.policy.nil?
+      end
     end
   end
 
   # Generate policy for stack
   #
   # @return [Hash]
-  # @todo this is very AWS specific, so make this easy for swapping
   def generate_policy
-    statements = []
-    compile.resources.keys!.each do |r_name|
-      r_object = compile.resources[r_name]
-      if(r_object['Policy'])
-        r_object['Policy'].keys!.each do |effect|
-          statements.push(
-            'Effect' => effect.to_s.capitalize,
-            'Action' => [r_object['Policy'][effect]].flatten.compact.map{|i| "Update:#{i}"},
-            'Resource' => "LogicalResourceId/#{r_name}",
-            'Principal' => '*'
-          )
-        end
-        r_object.delete!('Policy')
-      end
-    end
-    statements.push(
-      'Effect' => 'Allow',
-      'Action' => 'Update:*',
-      'Resource' => '*',
-      'Principal' => '*'
-    )
-    Smash.new('Statement' => statements)
+    Smash.new
   end
 
   # Apply nesting logic to stack
@@ -678,22 +695,6 @@ class SparkleFormation
   # @yieldreturn [Hash] key/values to be merged into resource properties
   # @return [Hash] dumped stack
   def apply_deep_nesting(*args, &block)
-    outputs = collect_outputs
-    nested_stacks(:with_resource).each do |stack, resource|
-      unless(stack.nested_stacks.empty?)
-        stack.apply_deep_nesting(*args)
-      end
-      stack.compile.parameters.keys!.each do |parameter_name|
-        if(output_name = output_matched?(parameter_name, outputs.keys))
-          next if outputs[output_name] == stack
-          stack_output = stack.make_output_available(output_name, outputs)
-          resource.properties.parameters.set!(parameter_name, stack_output)
-        end
-      end
-    end
-    if(block_given?)
-      extract_templates(&block)
-    end
     compile.dump!
   end
 
@@ -716,40 +717,7 @@ class SparkleFormation
   # @param outputs [Hash] listing of outputs
   # @reutrn [Hash] reference to output value (used for setting parameter)
   def make_output_available(output_name, outputs)
-    bubble_path = outputs[output_name].root_path - root_path
-    drip_path = root_path - outputs[output_name].root_path
-    bubble_path.each_slice(2) do |base_sparkle, ref_sparkle|
-      next unless ref_sparkle
-      base_sparkle.compile.outputs.set!(output_name).set!(
-        :value, base_sparkle.compile.attr!(
-          ref_sparkle.name, "Outputs.#{output_name}"
-        )
-      )
-    end
-    if(bubble_path.empty?)
-      if(drip_path.size == 1)
-        parent = drip_path.first.parent
-        if(parent && parent.compile.parameters.data![output_name])
-          return compile.ref!(output_name)
-        end
-      end
-      raise ArgumentError.new "Failed to detect available bubbling path for output `#{output_name}`. " <<
-        'This may be due to a circular dependency! ' <<
-        "(Output Path: #{outputs[output_name].root_path.map(&:name).join(' > ')} " <<
-        "Requester Path: #{root_path.map(&:name).join(' > ')})"
-    end
-    result = compile.attr!(bubble_path.first.name, "Outputs.#{output_name}")
-    if(drip_path.size > 1)
-      parent = drip_path.first.parent
-      drip_path.unshift(parent) if parent
-      drip_path.each_slice(2) do |base_sparkle, ref_sparkle|
-        next unless ref_sparkle
-        base_sparkle.compile.resources[ref_sparkle.name].properties.parameters.set!(output_name, result)
-        ref_sparkle.compile.parameters.set!(output_name){ type 'String' } # TODO: <<<<------ type check and prop
-        result = compile.ref!(output_name)
-      end
-    end
-    result
+    {}
   end
 
   # Extract and process nested stacks
@@ -785,32 +753,13 @@ class SparkleFormation
   # @yieldreturn [String] Remote URL storage for template
   # @return [Hash]
   def apply_shallow_nesting(*args, &block)
-    parameters = compile[:parameters] ? compile[:parameters]._dump : {}
-    output_map = {}
-    nested_stacks(:with_resource, :with_name).each do |_stack, stack_resource, stack_name|
-      remap_nested_parameters(compile, parameters, stack_name, stack_resource, output_map)
-    end
-    extract_templates(&block)
-    compile.parameters parameters
-    if(args.include?(:bubble_outputs))
-      outputs_hash = Hash[
-        output_map do |name, value|
-          [name, {'Value' => {'Fn::GetAtt' => value}}]
-        end
-      ]
-      if(compile.outputs)
-        compile._merge(compile._klass_new(outputs_hash))
-      else
-        compile.outputs output_hash
-      end
-    end
     compile.dump!
   end
 
   # @return [Smash<output_name:SparkleFormation>]
   def collect_outputs(*args)
     if(args.include?(:force) || root?)
-      if(compile.outputs)
+      unless(compile.outputs.nil?)
         outputs = Smash[
           compile.outputs.keys!.zip(
             [self] * compile.outputs.keys!.size
@@ -843,39 +792,6 @@ class SparkleFormation
   # @note if parameter has includes `StackUnique` a new parameter will
   #   be added to container stack and it will not use outputs
   def remap_nested_parameters(template, parameters, stack_name, stack_resource, output_map)
-    stack_parameters = stack_resource.properties.stack.compile.parameters
-    unless(stack_parameters.nil?)
-      stack_parameters._dump.each do |pname, pval|
-        if(pval['StackUnique'])
-          check_name = [stack_name, pname].join
-        else
-          check_name = pname
-        end
-        if(parameters.keys.include?(check_name))
-          if(parameters[check_name]['Type'] == 'CommaDelimitedList')
-            new_val = {'Fn::Join' => [',', {'Ref' => check_name}]}
-          else
-            new_val = {'Ref' => check_name}
-          end
-          template.resources.set!(stack_name).properties.parameters.set!(pname, new_val)
-        elsif(output_map[check_name])
-          template.resources.set!(stack_name).properties.parameters.set!(pname, 'Fn::GetAtt' => output_map[check_name])
-        else
-          if(pval['Type'] == 'CommaDelimitedList')
-            new_val = {'Fn::Join' => [',', {'Ref' => check_name}]}
-          else
-            new_val = {'Ref' => check_name}
-          end
-          template.resources.set!(stack_name).properties.parameters.set!(pname, new_val)
-          parameters[check_name] = pval
-        end
-      end
-    end
-    unless(stack_resource.properties.stack.compile.outputs.nil?)
-      stack_resource.properties.stack.compile.outputs.keys!.each do |oname|
-        output_map[oname] = [stack_name, "Outputs.#{oname}"]
-      end
-    end
     true
   end
 

data/lib/sparkle_formation/sparkle_struct.rb

@@ -45,6 +45,40 @@ class SparkleFormation
       end
     end
 
+    # Process value in search for FunctionStruct objects. If found replace with
+    # the root item of the structure
+    #
+    # @param item [Object]
+    # @return [Object]
+    def function_bubbler(item)
+      if(item.is_a?(::Enumerable))
+        if(item.respond_to?(:keys))
+          item.class[
+            *item.map do |entry|
+              function_bubbler(entry)
+            end.flatten(1)
+          ]
+        else
+          item.class[
+            *item.map do |entry|
+              function_bubbler(entry)
+            end
+          ]
+        end
+      elsif(item.is_a?(::SparkleFormation::FunctionStruct))
+        item._root
+      else
+        item
+      end
+    end
+
+    # Override to inspect result value and fetch root if value is a
+    # FunctionStruct
+    def method_missing(sym, *args, &block)
+      result = super(*[sym, *args], &block)
+      @table[_process_key(sym)] = function_bubbler(result)
+    end
+
     # @return [Class]
     def _klass
       _struct_class || ::SparkleFormation::SparkleStruct
@@ -76,7 +110,11 @@ class SparkleFormation
       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}`!"
+          unless(_self.parameters[arg.to_sym].key?(:default))
+            ::Kernel.raise ::ArgumentError.new "No value provided for compile time parameter: `#{arg}`!"
+          else
+            result = _self.parameters[arg.to_sym][:default]
+          end
         end
       end
       result
@@ -84,5 +122,4 @@ class SparkleFormation
     alias_method :state!, :_state
 
   end
-
 end

data/lib/sparkle_formation/version.rb

@@ -1,5 +1,5 @@
 # Unicorns and rainbows
 class SparkleFormation
   # Current library version
-  VERSION = Gem::Version.new('1.2.0')
+  VERSION = Gem::Version.new('2.0.0')
 end

data/sparkle_formation.gemspec

@@ -10,12 +10,16 @@ Gem::Specification.new do |s|
   s.description = 'Ruby DSL for programmatic orchestration API template generation'
   s.license = 'Apache-2.0'
   s.require_path = 'lib'
-  s.add_dependency 'attribute_struct', '>= 0.2.27', '< 0.4'
-  s.add_dependency 'multi_json'
-  s.add_dependency 'bogo'
+  s.required_ruby_version = '>= 2.0'
+  s.add_runtime_dependency 'attribute_struct', '>= 0.3.0', '< 0.5'
+  s.add_runtime_dependency 'multi_json'
+  s.add_runtime_dependency 'bogo'
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'redcarpet', '~> 2.0'
+  s.add_development_dependency 'github-markup'
   s.executables << 'generate_sparkle_docs'
   s.files = Dir['{lib,docs}/**/*'] + %w(sparkle_formation.gemspec README.md CHANGELOG.md LICENSE)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparkle_formation
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-02 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attribute_struct
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.27
+        version: 0.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.27
+        version: 0.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby DSL for programmatic orchestration API template generation
 email: chrisroberts.code@gmail.com
 executables:
@@ -132,12 +174,26 @@ files:
 - lib/sparkle_formation.rb
 - lib/sparkle_formation/aws.rb
 - lib/sparkle_formation/error.rb
+- lib/sparkle_formation/function_struct.rb
+- lib/sparkle_formation/provider.rb
+- lib/sparkle_formation/provider/aws.rb
+- lib/sparkle_formation/provider/azure.rb
+- lib/sparkle_formation/provider/heat.rb
 - lib/sparkle_formation/resources.rb
 - lib/sparkle_formation/resources/aws.rb
 - lib/sparkle_formation/resources/aws_resources.json
+- lib/sparkle_formation/resources/azure.rb
+- lib/sparkle_formation/resources/azure_resources.json
+- lib/sparkle_formation/resources/heat.rb
+- lib/sparkle_formation/resources/heat_resources.json
+- lib/sparkle_formation/resources/rackspace.rb
+- lib/sparkle_formation/resources/rackspace_resources.json
 - lib/sparkle_formation/sparkle.rb
 - lib/sparkle_formation/sparkle_attribute.rb
 - lib/sparkle_formation/sparkle_attribute/aws.rb
+- lib/sparkle_formation/sparkle_attribute/azure.rb
+- lib/sparkle_formation/sparkle_attribute/heat.rb
+- lib/sparkle_formation/sparkle_attribute/rackspace.rb
 - lib/sparkle_formation/sparkle_collection.rb
 - lib/sparkle_formation/sparkle_formation.rb
 - lib/sparkle_formation/sparkle_struct.rb
@@ -159,7 +215,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="