sparkle_formation 1.1.6 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8c8435e87b4a778f623d62924a0e04ce2d12984
-  data.tar.gz: 8d6ccfaad6cbb84f3e73a3a25f48a12f27d0d4a6
+  metadata.gz: cec97d229b916558ac8d3d3dbab3ba9912b7b637
+  data.tar.gz: eae3742d180d5a39cffbe79488d7ba48a81421dd
 SHA512:
-  metadata.gz: 24eabd02e9e856165565d27e0fcb6b68ff4a1ff4b48d5f364e7709451892bf1923877cdb14b8c72bb6ea5e5b15effdbb62a681abd962f720897c74006f2c98a3
-  data.tar.gz: a1aaadb1b5237ab15c31e341833cc1cf701597a8bbb8ed0dd277e5955ec3428d54c79718eb5b69465f395281139610a9a413962cdfdd91bcec9ab3f862d5d79c
+  metadata.gz: 9d17129d13125c94b53a65f7db3bf98a5158d05d364e0db63c7b96932d160c0199528f186fe44d2087853744fe0f6dddb748ed7f24d40a9275febd2a55461dd6
+  data.tar.gz: 06a6b6e7583dd3b99d3ab58660be6619d7ff263717f4c90c36b1742e6ebfdce6cc509038656491d36d5b042aede6b3c410c50831690ccacdb6b5a8b4dcb78bb3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.1.8
+* Raise error on name collisions within pack (#101)
+* Extract registry items from pack during compile
+
 ## v1.1.6
 * Fix `#root!` helper method usage (#98)
 

data/README.md

@@ -17,114 +17,20 @@ helper functions for commonly generated data structures, builtin
 logic for handling template nesting, and most importantly:
 conjouring magic (to get unicorns).
 
-## Documentation
-
-* [Library Documentation](https://sparkleformation.github.io/sparkle_formation)
-* [User Documentation](https://sparkleformation.github.io/sparkle_formation/UserDocs)
-
-## Overview
-
-Many template orchestration APIs accept serialized templates defining
-infrastructure resources and configurations. Interacting directly with
-these services via data serialization formats (JSON, YAML, etc) can be
-difficult for humans. SparkleFormation allows humans to programmatically
-define templates in Ruby. These are then exported into the desired
-serialization format, ready to send to the target orchestration API.
-
-## What's it look like?
-
-Below is a simple example of an AWS CloudFormation template defined within
-SparkleFormation. It creates a single EC2 resource:
-
-```ruby
-SparkleFormation.new('ec2_example') do
-  description "AWS CloudFormation Sample Template ..."
-
-  parameters.key_name do
-    description 'Name of EC2 key pair'
-    type 'String'
-  end
-
-  mappings.region_map do
-    set!('us-east-1'._no_hump, :ami => 'ami-7f418316')
-    set!('us-west-1'._no_hump, :ami => 'ami-951945d0')
-    set!('us-west-2'._no_hump, :ami => 'ami-16fd7026')
-    set!('eu-west-1'._no_hump, :ami => 'ami-24506250')
-    set!('sa-east-1'._no_hump, :ami => 'ami-3e3be423')
-    set!('ap-southeast-1'._no_hump, :ami => 'ami-74dda626')
-    set!('ap-northeast-1'._no_hump, :ami => 'ami-dcfa4edd')
-  end
+## Using SparkleFormation
 
-  dynamic!(:ec2_instance, :foobar) do
-    properties do
-      key_name ref!(:key_name)
-      image_id map!(:region_map, region!, :ami)
-      user_data base64!('80')
-    end
-  end
+SparkleFormation is a library and not intended for "direct use". If
+you are looking to build infrastructure stacks via orchestration APIs
+using SparkleFormation templates, please see the reference application
+implementation:
 
-  outputs do
-    instance_id do
-      description 'InstanceId of the newly created EC2 instance'
-      value ref!(:foobar_ec2_instance)
-    end
-    az do
-      description 'Availability Zone of the newly created EC2 instance'
-      value attr!(:foobar_ec2_instance, :availability_zone)
-    end
-    public_ip do
-      description 'Public IP address of the newly created EC2 instance'
-      value attr!(:foobar_ec2_instance, :public_ip)
-    end
-    private_ip do
-      description 'Private IP address of the newly created EC2 instance'
-      value attr!(:foobar_ec2_instance, :private_ip)
-    end
-    public_dns do
-      description 'Public DNSName of the newly created EC2 instance'
-      value attr!(:foobar_ec2_instance, :public_dns_name)
-    end
-    private_dns do
-      description 'Private DNSName of the newly created EC2 instance'
-      value attr!(:foobar_ec2_instance, :private_dns_name)
-    end
-  end
-end
-```
+* [SparkleFormation CLI (sfn)](http://www.sparkleformation.io/docs/sfn)
 
-And once compiled we get a nice Hash that we can then convert to JSON which
-is ready to send to the AWS CloudFormation API:
-
-```ruby
-require 'sparkle_formation'
-require 'json'
-
-puts JSON.pretty_generate(
-  SparkleFormation.compile('ec2_example.rb')
-)
-```
-
-Easy!
-
-## Reusability features
-
-SparkleFormation provides a number of features facilitating code reuse and
-logical structuring. These features help aid developers in applying DRY
-concepts to infrastructure codebases easing maintainability.
-
-> [Learn more!](https://sparkleformation.github.io/sparkle_formation/UserDocs/building-blocks.html)
-
-## SparkleFormation Implementations
-
-SparkleFormation itself is simply a library for building complex template
-documents in Ruby. It does not provide any integrations with remote API
-services. For interacting with remote services using the SparkleFormation
-library, see the SparkleFormation CLI application:
+## Documentation
 
-* [SparkleFormation CLI (sfn)](https://github.com/sparkleformation/sfn)
+* [SparkleFormation Library Documentation](http://www.sparkleformation.io/docs/sparkle_formation/)
 
 # Infos
-* Documentation: http://sparkleformation.github.io/sparkle_formation
-* User Documentation: http://sparkleformation.github.io/sparkle_formation/UserDocs/README.html
+* Documentation: http://www.sparkleformation.io/docs/sparkle_formation
 * Repository: https://github.com/sparkleformation/sparkle_formation
 * IRC: Freenode @ #sparkleformation

data/lib/sparkle_formation/sparkle.rb

@@ -146,9 +146,10 @@ class SparkleFormation
             end
 
           end
-          SfnRegistry = Registry
-
         end
+
+        SfnRegistry = SparkleFormation::Registry
+
         ::Object.constants.each do |const|
           unless(self.const_defined?(const))
             next if const == :Config # prevent warning output
@@ -261,6 +262,9 @@ class SparkleFormation
             unless(data[:name])
               data[:name] = slim_path.tr('/', '__').sub(/\.(rb|json)$/, '')
             end
+            if(hash[data[:name]])
+              raise KeyError.new "Template name is already in use within pack! (`#{data[:name]}`)"
+            end
             hash[data[:name]] = data.merge(
               Smash.new(
                 :type => :template,
@@ -281,7 +285,7 @@ class SparkleFormation
     # @raises [NameError, Error::NotFound]
     def get(type, name)
       unless(TYPES.keys.include?(type.to_s))
-        raise NameError.new "Invalid type requested (#{type})! Valid types: #{TYPES.join(', ')}"
+        raise NameError.new "Invalid type requested (#{type})! Valid types: #{TYPES.keys.join(', ')}"
       end
       result = send(TYPES[type])[name]
       if(result.nil? && TYPES[type] == 'templates')
@@ -334,12 +338,17 @@ class SparkleFormation
         raw_data.each do |key, items|
           items.each do |item|
             if(item[:name])
-              send(TYPES[key])[item.delete(:name)] = item
+              collection = send(TYPES[key])
+              name = item.delete(:name)
             else
               path = item[:block].source_location.first.sub('.rb', '').split(File::SEPARATOR)
               type, name = path.slice(path.size - 2, 2)
-              send(type)[name] = item
+              collection = send(type)
+            end
+            if(collection[name])
+              raise KeyError.new "#{key.capitalize} name is already in use within pack! (`#{name}`)"
             end
+            collection[name] = item
           end
         end
       end

data/lib/sparkle_formation/sparkle_attribute.rb

@@ -334,7 +334,7 @@ class SparkleFormation
     # @param args [Object] argument list for registry
     # @return [self]
     def registry!(name, *args)
-      SparkleFormation::Registry.insert(name, self, *args)
+      SparkleFormation.registry(name, self, *args)
     end
 
     # Stack nesting helper method

data/lib/sparkle_formation/sparkle_formation.rb

@@ -187,6 +187,18 @@ class SparkleFormation
     end
     alias_method :dynamic_information, :dynamic_info
 
+    # Insert a dynamic into a context
+    #
+    # @param dynamic_name [String, Symbol] dynamic name
+    # @param struct [SparkleStruct] context for insertion
+    # @param args [Object] parameters for dynamic
+    # @return [SparkleStruct]
+    def registry(registry_name, struct, *args)
+      result = false
+      reg = struct._self.sparkle.get(:registry, registry_name)
+      struct.instance_exec(*args, &reg[:block])
+    end
+
     # Insert a dynamic into a context
     #
     # @param dynamic_name [String, Symbol] dynamic name

data/lib/sparkle_formation/version.rb

@@ -1,4 +1,4 @@
 class SparkleFormation
   # Current library version
-  VERSION = Gem::Version.new('1.1.6')
+  VERSION = Gem::Version.new('1.1.8')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparkle_formation
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.1.8
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attribute_struct