rubycfn 0.4.1 → 0.4.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubycfn (0.4.1)
+    rubycfn (0.4.2)
       activesupport (~> 5.1.5)
       dotenv (~> 2.4.0)
       json (~> 2.1.0)

data/README.md

@@ -61,7 +61,7 @@ __________ ____ __________________.___._________ _____________________
  |       _/    |   /|    |  _//   |   |/    \  \/ |    __)   |    |  _/
  |    |   \    |  / |    |   \\____   |\     \____|     \    |    |   \
  |____|_  /______/  |______  // ______| \______  /\___  /    |______  /
-        \/                 \/ \/               \/     \/            \/ [v0.4.1]
+        \/                 \/ \/               \/     \/            \/ [v0.4.2]
 Project name? example
 Account ID? 1234567890
 Select region EU (Frankfurt)
@@ -338,6 +338,98 @@ convert it to YAML format ;)
 To allow for SAM transformation use the 'transform' method inside your template.
 The transform method takes an optional argument, and defaults to "AWS::Serverless-2016-10-31"
 
+## Resource attributes
+
+When creating a resource there are a couple of arguments that can be passed
+along with it. In its most simple form a resource looks like this:
+
+```ruby
+resource :my_resource,
+         type: "AWS::Some::Resource"
+```
+
+The following arguments are supported:
+
+* condition
+* creation_policy
+* deletion_policy
+* depends_on
+* metadata
+* type
+* update_policy
+* update_replace_policy
+
+To make a resource depend on another resource you can use the `depends_on`
+argument as follows:
+
+```ruby
+resource :my_resource,
+         depends_on: :some_other_resource,
+         type: "AWS::Some::Resource"
+```
+
+or... if you want to make it dependant on multiple resources:
+
+```ruby
+resource :my_resource,
+         depends_on: %i(some_other_resource yet_another_resource),
+         type: "AWS::Some::Resource"
+```
+
+If you want to dynamically generate DependsOn, you can do that in this way:
+
+```ruby
+resource :my_resource,
+         amount: 2,
+         type: "AWS::Some::Resource" do |r, index|
+  r.depends_on "SomeResource#{index}"
+end
+```
+
+The `depends_on` attribute and `r.depends_on` method can be used together.
+The `r.depends_on` specified resources get appended to the `depends_on`
+specified resources.
+
+## Manipulating the resource name
+
+Common practice is to use a symbol as argument to the `resource` method. The
+passed symbol is camel cased in the final CloudFormation template generation.
+It is imaginable that you have a use case where you need to control the resource
+name. There are two ways to achieve this.
+
+The first method is to pass a string as resource name, rather than a symbol.
+When you pass a string it will be taken as the literal resource name and not be
+camel cased. E.g.:
+
+```ruby
+resource "myAmazingResource",
+         type: "AWS::Some::Resource"
+```
+
+The second method is to use the resource method `_id`:
+
+```ruby
+resource :irrelevant_resource_name,
+         amount: 3,
+         type: "AWS::Some::Resource" do |r, index|
+  r._id "ResourceNameOverride#{index+1}"
+end
+```
+
+## Resource validation
+
+Rubycfn is shipped with a `CloudFormationResourceSpecification.json` file. It
+is used to validate whether used properties are valid and if any mandatory
+properties were omitted. The CloudFormation compiler will throw an error if
+a mandatory property is missing or if an unknown property is specified. Note
+that the CloudFormationResourceSpecification.json is not actively maintained
+by me. It is maintained by AWS at:
+
+https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-resource-specification.html
+
+You can also place the `CloudFormationResourceSpecification.json` file in the
+root of your project. It will override the one supplied by Rubycfn.
+
 ## License
 
 MIT License

data/lib/rubycfn.rb

@@ -17,6 +17,11 @@ require "rubycfn/version"
 @variables = {}
 @global_variables = {}
 
+@resource_specification = JSON.parse(File.open(File.join(File.dirname(__FILE__), "/../CloudFormationResourceSpecification.json")).read)
+if File.file?("CloudFormationResourceSpecification.json")
+  @resource_specification = JSON.parse(File.open("CloudFormationResourceSpecification.json").read)
+end
+
 # Monkey patching
 class Symbol
   def cfnize
@@ -380,6 +385,9 @@ module Rubycfn
       name = name.class == Symbol ? name.to_s.cfnize : name = name.to_s
       arguments[:type] =~ /^([A-Za-z0-9]*)\:\:/
       arguments[:cloud] ||= $1
+      resource_specification = TOPLEVEL_BINDING.eval("@resource_specification")
+
+      raise "#{arguments[:type]} is not a valid resource type" unless resource_specification["ResourceTypes"][arguments[:type].to_s] || arguments[:type] =~ /Rspec\:\:/ || arguments[:type] =~ /^Custom\:\:/ || arguments[:type] =~ /AWS\:\:Serverless\:\:/
 
       # Custom resource types are AWS resources
       if arguments[:cloud] == "Custom" || arguments[:cloud] == "Rspec"
@@ -413,6 +421,19 @@ module Rubycfn
 
           arguments[:depends_on] ||= []
           rendered_depends_on = TOPLEVEL_BINDING.eval("@depends_on").nil? && arguments[:depends_on] || arguments[:depends_on] + TOPLEVEL_BINDING.eval("@depends_on")
+          if resource_specification["ResourceTypes"][arguments[:type].to_s]
+            resource_specification = TOPLEVEL_BINDING.eval("@resource_specification")
+            known_properties = resource_specification["ResourceTypes"][arguments[:type].to_s]["Properties"].keys
+            mandatory_properties = []
+            known_properties.each do |prop|
+              mandatory_properties.push(prop) if resource_specification["ResourceTypes"][arguments[:type].to_s]["Properties"][prop]["Required"] == true
+            end
+            TOPLEVEL_BINDING.eval("@properties").each do |k, _v|
+              raise "Property `#{k}` for #{arguments[:type]} is not valid." unless known_properties.include? k.to_s
+              mandatory_properties.delete(k.to_s)
+            end
+            raise "Property #{mandatory_properties.join(", ")} is mandatory for #{arguments[:type]}" unless mandatory_properties.count.zero?
+          end
           res = {
             "#{name.to_s}#{i.zero? ? "" : resource_postpend}": {
               Properties: TOPLEVEL_BINDING.eval("@properties"),

data/lib/rubycfn/version.rb

@@ -1,4 +1,4 @@
 # Rubycfn version
 module Rubycfn
-  VERSION = "0.4.1".freeze
+  VERSION = "0.4.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycfn
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Dennis Vink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2019-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: neatjson
@@ -259,6 +259,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CloudFormationResourceSpecification.json
 - Gemfile
 - Gemfile.lock
 - README.md