sparkle_formation 0.4.0 → 1.0.0

data/lib/sparkle_formation/sparkle_attribute.rb

@@ -1,21 +1,3 @@
-#
-# Author:: Chris Roberts <chris@hw-ops.com>
-# Copyright:: 2013, Heavy Water Operations, LLC
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
 require 'sparkle_formation'
 
 class SparkleFormation
@@ -236,31 +218,64 @@ class SparkleFormation
     end
     alias_method :no_value!, :_no_value
 
+    # Region generator
+    #
+    # @return [Hash]
     def _region
       _ref('AWS::Region')
     end
     alias_method :region!, :_region
 
+    # Notification ARNs generator
+    #
+    # @return [Hash]
     def _notification_arns
       _ref('AWS::NotificationARNs')
     end
     alias_method :notification_arns!, :_notification_arns
 
+    # Account ID generator
+    #
+    # @return [Hash]
     def _account_id
       _ref('AWS::AccountId')
     end
     alias_method :account_id!, :_account_id
 
+    # Stack ID generator
+    #
+    # @return [Hash]
     def _stack_id
       _ref('AWS::StackId')
     end
     alias_method :stack_id!, :_stack_id
 
+    # Stack name generator
+    #
+    # @return [Hash]
     def _stack_name
       _ref('AWS::StackName')
     end
     alias_method :stack_name!, :_stack_name
 
+    # Resource dependency generator
+    #
+    # @param [Symbol, String, Array<Symbol, String>] resource names
+    # @return [Array<String>]
+    def _depends_on(*args)
+      _set('DependsOn', [args].flatten.compact.map{|s| _process_key(s)})
+    end
+    alias_method :depends_on!, :_depends_on
+
+    # Reference output value from nested stack
+    #
+    # @param stack_name [String, Symbol] logical resource name of stack
+    # @apram output_name [String, Symbol] stack output name
+    def _stack_output(stack_name, output_name)
+      _attr(_process_key(stack_name), "Outputs.#{_process_key(output_name)}")
+    end
+    alias_method :stack_output!, :_stack_output
+
     # Execute system command
     #
     # @param command [String]
@@ -319,7 +334,7 @@ class SparkleFormation
     # @param args [Object] argument list for registry
     # @return [self]
     def registry!(name, *args)
-      SfnRegistry.insert(name, self, *args)
+      SparkleFormation::Registry.insert(name, self, *args)
     end
 
     # Stack nesting helper method

data/lib/sparkle_formation/sparkle_collection.rb

@@ -0,0 +1,149 @@
+require 'sparkle_formation'
+
+class SparkleFormation
+  # Provides a collection of sparkles
+  # @todo add unmemoize behavior on collection modification to prevent
+  # leak on long running processes with long lasting collections
+  class SparkleCollection < Sparkle
+
+    # Create a new collection of sparkles
+    #
+    # @return [self]
+    def initialize(*_)
+      @root = nil
+      @sparkles = []
+    end
+
+    # Set the root sparkle which forces highest precedence
+    #
+    # @param sparkle [Sparkle]
+    # @return [self]
+    def set_root(sparkle)
+      @root = sparkle
+      self
+    end
+
+    # Add new sparkle to collection
+    #
+    # @param sparkle [Sparkle]
+    # @return [self]
+    def add_sparkle(sparkle, precedence=:high)
+      unless(sparkle.is_a?(Sparkle))
+        raise TypeError.new "Expected type `SparkleFormation::Sparkle` but received `#{sparkle.class}`!"
+      end
+      if(precedence == :high)
+        @sparkles.push(sparkle).uniq!
+      else
+        @sparkles.unshift(sparkle).uniq!
+      end
+      self
+    end
+
+    # Remove sparkle from collection
+    #
+    # @param sparkle [Sparkle]
+    # @return [self]
+    def remove_sparkle(sparkle)
+      @sparkles.delete(sparkle)
+      self
+    end
+
+    # @return [Sparkle, NilClass]
+    def sparkle_at(idx)
+      sparkles.at(idx)
+    end
+
+    # @return [Integer]
+    def size
+      sparkles.size
+    end
+
+    # @return [TrueClass, FalseClass]
+    def empty?
+      size == 0
+    end
+
+    # @return [Smash]
+    def components
+      memoize("components_#{checksum}") do
+        Smash.new.tap do |hsh|
+          sparkles.each do |sprkl|
+            hsh.merge!(sprkl.components)
+          end
+        end
+      end
+    end
+
+    # @return [Smash]
+    def dynamics
+      memoize("dynamics_#{checksum}") do
+        Smash.new.tap do |hsh|
+          sparkles.each do |sprkl|
+            hsh.merge!(sprkl.dynamics)
+          end
+        end
+      end
+    end
+
+    # @return [Smash]
+    def registries
+      memoize("registries_#{checksum}") do
+        Smash.new.tap do |hsh|
+          sparkles.each do |sprkl|
+            hsh.merge!(sprkl.registries)
+          end
+        end
+      end
+    end
+
+    # @return [Smash]
+    def templates
+      memoize("templates_#{checksum}") do
+        Smash.new.tap do |hsh|
+          sparkles.each do |sprkl|
+            hsh.merge!(sprkl.templates)
+          end
+        end
+      end
+    end
+
+    # Request item from the store
+    #
+    # @param type [String, Symbol] item type (see: TYPES)
+    # @param name [String, Symbol] name of item
+    # @return [Smash] requested item
+    # @raises [NameError, Error::NotFound]
+    def get(*args)
+      result = nil
+      error = nil
+      sparkles.each do |sprkl|
+        begin
+          result = sprkl.get(*args)
+        rescue Error::NotFound => error
+        end
+      end
+      if(result)
+        result
+      else
+        raise error
+      end
+    end
+
+    protected
+
+    # @return [Array<Sparkle>]
+    def sparkles
+      (@sparkles + [@root]).compact
+    end
+
+    # @return [String] checksum of sparkles
+    def checksum
+      Smash.new.tap do |s|
+        sparkles.each_with_index do |v, i|
+          s[i.to_s] = v
+        end
+      end.checksum
+    end
+
+  end
+end