cloud_shaped 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21a2049dd796e57e57bc9ad49fb45effb6340239
-  data.tar.gz: 8e445136b05818d16ff9d1a78ee61f23097d1a08
+  metadata.gz: 88837a9bfa352037ab2f2129279a0a9d7dab507b
+  data.tar.gz: a9082c94f9587bac9ec9642787dc87ea447b489a
 SHA512:
-  metadata.gz: 76e13fe7b29c92d2fec4986e886f053980a9f204fbaa1b32c74349644e4fe67b8177de4a2284b520066a4038b4aa27ba4a59b2164ccb50e7ed8f9b5d6fe9d151
-  data.tar.gz: 0f992328cba18e1393df16ed5bc00813194162b5d6beefe077ed97e896a1b6523ee0c330a762ca471a1f6b9a51d63cfc6bd4b316e69b2971b8ed1e4a6ef8156f
+  metadata.gz: ab97c0a3f429b9a65f2ca75e1458a8adc37f1136b3a75085137d9c5f2f86124a6dc335857ff2e0e2dc5d2ff377c3a9cc8a88f8f53f8c7e7355697641b938be8f
+  data.tar.gz: 184e53169c15670cac0ad4e382fbbaeab60be518aa40cded4bda75f7eaa32cd221ae5ad4c26d8e2a958a457f3169c4e3b73770431d26eef4515fb82265e0648d

data/README.md

@@ -17,10 +17,10 @@ Add this line to your application's Gemfile:
     require 'cloud_shaped'
     require 'json'
 
-    template = CloudShaped.template do
-      def_parameter "appName"
-      def_resource "app", "AWS::Appity:AppApp", "Name" => ref("appName")
-      def_output "appAddress", ref("app", "address")
+    template = CloudShaped.template do |t|
+      t.def_parameter "appName"
+      t.def_resource "app", "AWS::Appity:AppApp", "Name" => t.ref("appName")
+      t.def_output "appAddress", t.ref("app", "address")
     end
 
     puts JSON.pretty_generate(template)
@@ -53,6 +53,34 @@ outputs
       }
     }
 
+## Declaring resources
+
+Declare CloudFormation resources using the `def_resource` method.  It takes a resource name, type, and properties:
+
+    t.def_resource "adminEmail", "AWS::SNS::Topic",
+      "Subscription" => [{"Protocol" => "email", "Endpoint" => "mdub@example.com"}]
+
+If you prefer, you can set properties using a block:
+
+    t.def_resource "adminEmail", "AWS::SNS::Topic" do |topic|
+      topic["Subscription"] = [
+        { "Protocol" => "email", "Endpoint" => "mdub@example.com" }
+      ]
+    end
+
+### Resource macros
+
+Typically, the "type" argument will be a string specifying a CloudFormation resource type.  However, it's also possible to provide a Ruby symbol, in which case `def_resource` will call the named method, passing remaining arguments.  This allows common resource patterns to be abstracted as methods:
+
+    def t.email_topic(address)
+      resource "AWS::SNS::Topic",
+        "Subscription" => [{ "Protocol" => "email", "Endpoint" => address }]
+    end
+
+    t.def_resource "adminEmail", :email_topic, "mdub@example.com"
+
+## Full documentation
+
 For more info on the DSL, see:
 
 * {CloudShaped.template}

data/lib/cloud_shaped/core_methods.rb

@@ -8,7 +8,7 @@ module CloudShaped
 
     # Returns a CloudFormation Resource declaration.
     #
-    # Properties can be passed in the call, or defined using an optional block.
+    # Properties and additional resource attributes can be passed in the call, or defined using an optional block.
     #
     # @example
     #     resource("AWS::ElasticLoadBalancing::LoadBalancer", "Scheme" => "internal") do |elb|
@@ -17,15 +17,16 @@ module CloudShaped
     #
     # @param type [String] the resource type
     # @param properties [Hash] resource properties
+    # @param attributes [Hash] additional resource attributes
     #
-    def resource(type, properties = {})
+    def resource(type, properties = {}, attributes = {})
       properties = properties.camelate_keys
-      yield properties if block_given?
+      yield properties, attributes if block_given?
       properties.select! { |k,v| v != nil }
-      {
+      attributes.merge(
         "Type" => type,
         "Properties" => properties
-      }
+      )
     end
 
     # Returns a CloudFormation Parameter declaration.

data/lib/cloud_shaped/version.rb

@@ -1,3 +1,3 @@
 module CloudShaped
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/cloud_shaped/core_methods_spec.rb

@@ -24,10 +24,13 @@ describe CloudShaped::CoreMethods do
 
     context "with a block" do
 
-      it "allows properties to be added" do
-        result = resource("AWS::Thing", "MinSize" => 1) do |thing|
+      let(:result) do
+        resource("AWS::Thing", "MinSize" => 1) do |thing|
           thing["MaxSize"] = 3
         end
+      end
+
+      it "allows properties to be added" do
         expect(result).to eq(
           "Type" => "AWS::Thing",
           "Properties" => { "MinSize" => 1, "MaxSize" => 3 }
@@ -36,6 +39,40 @@ describe CloudShaped::CoreMethods do
 
     end
 
+    context "with an attributes hash" do
+
+      let(:result) do
+        resource("AWS::Thing", {}, "DependsOn" => "baz")
+      end
+
+      it "sets additional resource attributes" do
+        expect(result).to eq(
+          "Type" => "AWS::Thing",
+          "Properties" => {},
+          "DependsOn" => "baz"
+        )
+      end
+
+    end
+
+    context "with a block that sets attributes" do
+
+      let(:result) do
+        resource("AWS::Thing") do |props, attrs|
+          attrs["DeletionPolicy"] = "Retain"
+        end
+      end
+
+      it "sets additional resource attributes" do
+        expect(result).to eq(
+          "Type" => "AWS::Thing",
+          "Properties" => {},
+          "DeletionPolicy" => "Retain"
+        )
+      end
+
+    end
+
   end
 
   describe "#parameter" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloud_shaped
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler