rubycfn 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a68bc5a68e2c5d5e17afd182cc6584ecd7cbd2a0
-  data.tar.gz: 8ea2e232f188466493fc1549a1bd4df5940b0d00
+  metadata.gz: ad6c0ee3940074c02e77ec200940b30cd04c88a9
+  data.tar.gz: 02df17c17bfb5d0a27065fa3507309426cd11fe0
 SHA512:
-  metadata.gz: adb271c31360abcbb0526ecb9b967ff519aec21ba6a8f1cefb2f9405e4a468e2be8f3ed983e3b8b73ffa363fdf8a53c10b5939fb0510a13b6fbf93781534a332
-  data.tar.gz: 93dcf56467cc1b90e6b6912488111b41b4d0e5f4203adef9ea02ff3656317566747665363f6a51801297302c50e221086de58182762cc310a0233918b3abb5f6
+  metadata.gz: 00960d82e125677be467a2578c08bbeb0396530d8e3d9c058398f30580886c98a2f0a8985cee19292bcd30f8e430856ce982a10cce5d25d8381997df6268ff7d
+  data.tar.gz: a3161e628b18490ac66aa330d6cc41ec3c4de798a68e5b350483f253e2452fdd6a9a02d54f197725b33223e0caa6093407dd27029762a047e672c4fab4d703d4

data/.rubocop.yml

@@ -20,6 +20,9 @@ Metrics/AbcSize:
     - "test/**/*"
     - "spec/**/*"
 
+Metrics/BlockNesting:
+  Enabled: false
+
 Metrics/ClassLength:
   Max: 500
   Exclude:

data/CHANGELOG.md

@@ -2,7 +2,11 @@
 All notable changes to Rubycfn will be documented in this file.
 This project uses [Semantic Versioning](http://semver.org/).
 
-## 0.4.4 (Next Release)
+## 0.4.5 (Next Release)
+
+## 0.4.4
+
+  * Added autocorrection to property names so that developers won't have to think about camel casing -- [@dennisvink][@dennisvink]
 
 ## 0.4.3
 

data/Gemfile.lock

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

data/README.md

@@ -61,7 +61,7 @@ __________ ____ __________________.___._________ _____________________
  |       _/    |   /|    |  _//   |   |/    \  \/ |    __)   |    |  _/
  |    |   \    |  / |    |   \\____   |\     \____|     \    |    |   \
  |____|_  /______/  |______  // ______| \______  /\___  /    |______  /
-        \/                 \/ \/               \/     \/            \/ [v0.4.3]
+        \/                 \/ \/               \/     \/            \/ [v0.4.4]
 Project name? example
 Account ID? 1234567890
 Select region EU (Frankfurt)

data/lib/monkeypatch.rb

@@ -0,0 +1,206 @@
+class Symbol
+  def cfnize
+    return self.to_s if self.to_s !~ /_/ && self.to_s =~ /[A-Z]+.*/
+    to_s.split("_").map(&:capitalize).join
+  end
+
+  def ref(attr = nil)
+    unless attr
+      return { Ref: to_s.split("_").map(&:capitalize).join }
+    end
+    attr = attr.class == String ? attr : attr.to_s.split("_").map(&:capitalize).join
+    {
+      "Fn::GetAtt": [
+        to_s.split("_").map(&:capitalize).join, attr
+      ]
+    }
+  end
+
+  def fntransform(parameters = nil)
+    raise "fntransform parameters must be of type Hash" unless parameters.class == Hash
+    {
+      "Fn::Transform": {
+        "Name": to_s.split("_").map(&:capitalize).join,
+        "Parameters": parameters
+      }
+    }
+  end
+end
+
+class Hash
+  def fnsplit(separator = "")
+    {
+      "Fn::Split": [
+        separator,
+        self
+      ]
+    }
+  end
+end
+
+class String
+  def cfnize
+    return self if self !~ /_/ && self =~ /[A-Z]+.*/
+    split("_").map(&:capitalize).join
+  end
+
+  def ref(attr = nil)
+    unless attr
+      return { Ref: self }
+    end
+    attr = attr.class == String ? attr : attr.to_s.split("_").map(&:capitalize).join
+    {
+      "Fn::GetAtt": [
+        self,
+        attr
+      ]
+    }
+  end
+
+  def fntransform(parameters = nil)
+    raise "fntransform parameters must be of type Hash" unless parameters.class == Hash
+    {
+      "Fn::Transform": {
+        "Name": self,
+        "Parameters": parameters
+      }
+    }
+  end
+
+  def fnsplit(separator = "")
+    {
+      "Fn::Split": [
+        separator,
+        self
+      ]
+    }
+  end
+
+  def fnbase64
+    {
+      "Fn::Base64": self
+    }
+  end
+
+  def fngetazs
+    {
+      "Fn::GetAZs": self
+    }
+  end
+
+  def fnsub(variable_map = nil)
+    unless variable_map
+      return { "Fn::Sub": self }
+    end
+    {
+      "Fn::Sub": [
+        self,
+        variable_map
+      ]
+    }
+  end
+
+  def fnimportvalue
+    {
+      "Fn::Import": self
+    }
+  end
+  alias_method :fnimport, :fnimportvalue
+end
+
+class Array
+  def fncidr
+    {
+      "Fn::Cidr": self
+    }
+  end
+  alias_method :cidr, :fncidr
+
+  def fnequals
+    {
+      "Fn::Equals": self
+    }
+  end
+
+  def fnand
+    {
+      "Fn::And": self
+    }
+  end
+
+  def fnif
+    {
+      "Fn::If": self
+    }
+  end
+
+  def fnnot
+    {
+      "Fn::Not": self
+    }
+  end
+
+  def fnor
+    {
+      "Fn::Or": self
+    }
+  end
+
+  def fnfindinmap(name = nil)
+    unshift(name.cfnize) if name
+    {
+      "Fn::FindInMap": self
+    }
+  end
+  alias_method :find_in_map, :fnfindinmap
+  alias_method :findinmap, :fnfindinmap
+
+  def fnjoin(separator = "")
+    {
+      "Fn::Join": [
+        separator,
+        self
+      ]
+    }
+  end
+
+  def fnselect(index = 0)
+    {
+      "Fn::Select": [
+        index,
+        self
+      ]
+    }
+  end
+end
+
+class ::Hash
+  # rubocop:disable Style/CaseEquality
+  # rubocop:disable Lint/UnusedBlockArgument
+  def deep_merge(second)
+    merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : Array === v1 && Array === v2 ? v1 | v2 : [:undefined, nil, :nil].include?(v2) ? v1 : v2 }
+    self.merge(second.to_h, &merger)
+  end
+  # rubocop:enable Style/CaseEquality
+  # rubocop:enable Lint/UnusedBlockArgument
+
+  def recursive_compact
+    delete_if do |k, v|
+      next if v == false || k =~ /Fn\:/
+      (v.respond_to?(:empty?) ? v.empty? : !v) || v.instance_of?(Hash) && v.recursive_compact.empty?
+    end
+  end
+
+  def compact
+    delete_if { |_k, v| v.nil? }
+  end
+
+  def fnselect(index = 0)
+    {
+      "Fn::Select": [
+        index,
+        self
+      ]
+    }
+  end
+end

data/lib/rubycfn/version.rb

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

data/lib/rubycfn.rb

@@ -3,6 +3,7 @@ require "active_support/concern"
 require "json"
 require "neatjson"
 require "rubycfn/version"
+require_relative "monkeypatch"
 
 @description = ""
 @transform = ""
@@ -22,214 +23,6 @@ if File.file?("CloudFormationResourceSpecification.json")
   @resource_specification = JSON.parse(File.open("CloudFormationResourceSpecification.json").read)
 end
 
-# Monkey patching
-class Symbol
-  def cfnize
-    return self.to_s if self.to_s !~ /_/ && self.to_s =~ /[A-Z]+.*/
-    to_s.split("_").map(&:capitalize).join
-  end
-
-  def ref(attr = nil)
-    unless attr
-      return { Ref: to_s.split("_").map(&:capitalize).join }
-    end
-    attr = attr.class == String ? attr : attr.to_s.split("_").map(&:capitalize).join
-    {
-      "Fn::GetAtt": [
-        to_s.split("_").map(&:capitalize).join, attr
-      ]
-    }
-  end
-
-  def fntransform(parameters = nil)
-    raise "fntransform parameters must be of type Hash" unless parameters.class == Hash
-    {
-      "Fn::Transform": {
-        "Name": to_s.split("_").map(&:capitalize).join,
-        "Parameters": parameters
-      }
-    }
-  end
-end
-
-class Hash
-  def fnsplit(separator = "")
-    {
-      "Fn::Split": [
-        separator,
-        self
-      ]
-    }
-  end
-end
-
-class String
-  def cfnize
-    return self if self !~ /_/ && self =~ /[A-Z]+.*/
-    split("_").map(&:capitalize).join
-  end
-
-  def ref(attr = nil)
-    unless attr
-      return { Ref: self }
-    end
-    attr = attr.class == String ? attr : attr.to_s.split("_").map(&:capitalize).join
-    {
-      "Fn::GetAtt": [
-        self,
-        attr
-      ]
-    }
-  end
-
-  def fntransform(parameters = nil)
-    raise "fntransform parameters must be of type Hash" unless parameters.class == Hash
-    {
-      "Fn::Transform": {
-        "Name": self,
-        "Parameters": parameters
-      }
-    }
-  end
-
-  def fnsplit(separator = "")
-    {
-      "Fn::Split": [
-        separator,
-        self
-      ]
-    }
-  end
-
-  def fnbase64
-    {
-      "Fn::Base64": self
-    }
-  end
-
-  def fngetazs
-    {
-      "Fn::GetAZs": self
-    }
-  end
-
-  def fnsub(variable_map = nil)
-    unless variable_map
-      return { "Fn::Sub": self }
-    end
-    {
-      "Fn::Sub": [
-        self,
-        variable_map
-      ]
-    }
-  end
-
-  def fnimportvalue
-    {
-      "Fn::Import": self
-    }
-  end
-  alias_method :fnimport, :fnimportvalue
-end
-
-class Array
-  def fncidr
-    {
-      "Fn::Cidr": self
-    }
-  end
-  alias_method :cidr, :fncidr
-
-  def fnequals
-    {
-      "Fn::Equals": self
-    }
-  end
-
-  def fnand
-    {
-      "Fn::And": self
-    }
-  end
-
-  def fnif
-    {
-      "Fn::If": self
-    }
-  end
-
-  def fnnot
-    {
-      "Fn::Not": self
-    }
-  end
-
-  def fnor
-    {
-      "Fn::Or": self
-    }
-  end
-
-  def fnfindinmap(name = nil)
-    unshift(name.cfnize) if name
-    {
-      "Fn::FindInMap": self
-    }
-  end
-  alias_method :find_in_map, :fnfindinmap
-  alias_method :findinmap, :fnfindinmap
-
-  def fnjoin(separator = "")
-    {
-      "Fn::Join": [
-        separator,
-        self
-      ]
-    }
-  end
-
-  def fnselect(index = 0)
-    {
-      "Fn::Select": [
-        index,
-        self
-      ]
-    }
-  end
-end
-
-class ::Hash
-  # rubocop:disable Style/CaseEquality
-  # rubocop:disable Lint/UnusedBlockArgument
-  def deep_merge(second)
-    merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : Array === v1 && Array === v2 ? v1 | v2 : [:undefined, nil, :nil].include?(v2) ? v1 : v2 }
-    self.merge(second.to_h, &merger)
-  end
-  # rubocop:enable Style/CaseEquality
-  # rubocop:enable Lint/UnusedBlockArgument
-
-  def recursive_compact
-    delete_if do |k, v|
-      next if v == false || k =~ /Fn\:/
-      (v.respond_to?(:empty?) ? v.empty? : !v) || v.instance_of?(Hash) && v.recursive_compact.empty?
-    end
-  end
-
-  def compact
-    delete_if { |_k, v| v.nil? }
-  end
-
-  def fnselect(index = 0)
-    {
-      "Fn::Select": [
-        index,
-        self
-      ]
-    }
-  end
-end
-
 module Rubycfn
   extend ActiveSupport::Concern
 
@@ -421,6 +214,8 @@ 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")
+          rendered_properties = TOPLEVEL_BINDING.eval("@properties")
+          autocorrected_properties = {}
           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
@@ -428,14 +223,23 @@ module Rubycfn
             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|
+            rendered_properties.each do |k, v|
               unless known_properties.include? k.to_s
-                TOPLEVEL_BINDING.eval("@depends_on = []")
-                TOPLEVEL_BINDING.eval("@properties = {}")
-                raise "Property `#{k}` for #{arguments[:type]} is not valid."
+                # Can we fix it ? Maybe we can
+                autocorrected = known_properties.find { |prop| prop.casecmp(k.to_s).zero? }
+                if autocorrected.nil?
+                  TOPLEVEL_BINDING.eval("@depends_on = []")
+                  TOPLEVEL_BINDING.eval("@properties = {}")
+                  rendered_properties = {}
+                  raise "Property `#{k}` for #{arguments[:type]} is not valid."
+                end
+                rendered_properties.delete(k)
+                autocorrected_properties[autocorrected.to_sym] = v
+                mandatory_properties.delete(autocorrected.to_s)
               end
               mandatory_properties.delete(k.to_s)
             end
+            rendered_properties = rendered_properties.deep_merge(autocorrected_properties)
             unless mandatory_properties.count.zero?
               TOPLEVEL_BINDING.eval("@depends_on = []")
               TOPLEVEL_BINDING.eval("@properties = {}")
@@ -444,7 +248,7 @@ module Rubycfn
           end
           res = {
             "#{name.to_s}#{i.zero? ? "" : resource_postpend}": {
-              Properties: TOPLEVEL_BINDING.eval("@properties"),
+              Properties: rendered_properties,
               Type: arguments[:type],
               Condition: arguments[:condition],
               UpdatePolicy: arguments[:update_policy],

data/spec/lib/rubycfn_spec.rb

@@ -28,6 +28,39 @@ describe Rubycfn do
         r.property(:some_arn) { :rspec_resource.ref(:arn) }
         r.property(:some_other_arn) { :rspec_resource.ref("FooBar") }
       end
+
+      resource :asellion_com_database_instance,
+               type: "AWS::RDS::DBInstance" do |r|
+        r.property(:db_instance_identifier) { "rspec" }
+        r.property(:allocated_storage) { 100 }
+        r.property(:dbinstanceclass) { "db.t2.small" }
+        r.property(:engine) { "mariadb" }
+        r.property(:master_username) { "rspecroot" }
+        r.property(:master_user_password) { "rubycfn<3" }
+        r.property(:db_name) { "MyAwesomeDatabase" }
+        r.property(:preferred_backup_window) { "01:00-01:30" }
+        r.property(:backup_retention_period) { 14 }
+        r.property(:availability_zone) { "eu-central-1b" }
+        r.property(:preferred_maintenance_window) { "sun:06:00-sun:06:30" }
+        r.property(:multi_az) { true }
+        r.property(:engine_version) { "10.1.34" }
+        r.property(:auto_minor_version_upgrade) { true }
+        r.property(:license_model) { "general-public-license" }
+        r.property(:publicly_accessible) { true }
+        r.property(:storage_type) { "gp2" }
+        r.property(:port) { 3306 }
+        r.property(:copy_tags_to_snapshot) { true }
+        r.property(:monitoring_interval) { 60 }
+        r.property(:enable_iam_database_authentication) { false }
+        r.property(:enable_performance_insights) { false }
+        r.property(:deletion_protection) { true }
+        r.property(:db_subnet_group_name) { "default-vpc-123456789" }
+        r.property(:vpc_security_groups) do
+          [
+            "sg-0xc0ff3e"
+          ]
+        end
+      end
     end
   end
 
@@ -153,6 +186,24 @@ describe Rubycfn do
           it { should eq ["FooBar", "fooBar"] }
         end
       end
+
+      context "Database resource exists" do
+        subject { resources }
+
+        it { should have_key "AsellionComDatabaseInstance" }
+
+        context "Database resource has the right autocorrected properties" do
+          let(:properties) { resources["AsellionComDatabaseInstance"]["Properties"] }
+          subject { properties }
+
+          it { should have_key "DBInstanceClass" }
+          it { should have_key "DBInstanceIdentifier" }
+          it { should have_key "DBName" }
+          it { should have_key "DBSubnetGroupName" }
+          it { should have_key "MultiAZ" }
+          it { should have_key "VPCSecurityGroups" }
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycfn
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Dennis Vink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-23 00:00:00.000000000 Z
+date: 2019-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: neatjson
@@ -267,6 +267,7 @@ files:
 - bin/rubycfn
 - format.vim
 - lib/cli_methods.rb
+- lib/monkeypatch.rb
 - lib/rubycfn.rb
 - lib/rubycfn/version.rb
 - rubycfn.gemspec