cumuliform 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8e6b6392368ceef96436d11a3276315436d82c2f
-  data.tar.gz: e69ae5e3488e78466dd6fb187b7b758fb322e18e
+SHA256:
+  metadata.gz: 86477f5b5e5ff570e701ea108595ab37165e9c2c8c0b908d71a3376925a4d5f2
+  data.tar.gz: 6f77929d740fe9aaecdc83b65d691458441d762688f658b0fd338560b5501f79
 SHA512:
-  metadata.gz: 65db6a7682acfa6e99bd3c9fb877efacc7c16ee0a8d299efc204be532d1f63074a62d506ab15b75f89c5de9fdbb6755c3aa3643813f11d33a44654ac691a58e3
-  data.tar.gz: 3d76af0b68eba1ad4bdeb76871e7287c2a921743ea292f62d8abd575ea59729667f9a66fd2efc0877affe6b49e82bf3ae63cedcaf05112099a2656e4955968f2
+  metadata.gz: 6abcbc9530eddcf37006beaf07fa357ac21b51bc325195825ed9b04b71ee2fadf2a305fea65458b7595a4e522bf44ea751878a1965e8c7f51ce6c7f5dfd05dc8
+  data.tar.gz: ea4cd0da1e21c9a86514ec9d5f4ab7c754240f32bdde7567c8576ebad5786d9d9adbb3cc6bf6bcddae68960145175a8a16841097bf6d3e48d0c03654a7955b2d

data/.ruby-version

@@ -1 +1 @@
-2.3
+2.6

data/.travis.yml

@@ -3,8 +3,6 @@ env:
     - CC_TEST_REPORTER_ID=ad171accd9e47d577857f84b0d9032042ea70bf942a219bfa4f5582b5e504a60
 language: ruby
 sudo: false
-rvm:
-  2.4.3
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter

data/README.md

@@ -17,9 +17,7 @@ provides a simple DSL that generates reliably valid JSON and enforces
 referential integrity through convenience wrappers around the common points
 where CloudFormation expects references between resources. provides.
 
-Cumuliform has been extracted from ops and deployment code at [tape.tv][tape]
-
-[tape]: https://www.tape.tv/
+Cumuliform was originally extracted from ops and deployment code at tape.tv
 
 ## Installation
 
@@ -281,8 +279,36 @@ The generated template is:
 }
 ```
 
-Note that the optional `AWSTemplateFormatVersion`, `Description`, and
-`Metadata` sections are *not* currently supported.
+Note that the optional `AWSTemplateFormatVersion`, and `Metadata` sections are
+*not* currently supported.
+
+Here's a trivial template that specifies a `Transform` top-level value (e.g. for [AWS SAM][])
+
+[AWS SAM]: https://github.com/awslabs/serverless-application-model
+
+```ruby
+Cumuliform.template do
+  transform 'AWS::Serverless-2016-10-31'
+  resource 'MyFunction' do
+    {
+      Type: 'AWS::Serverless::Function'
+    }
+  end
+end
+```
+
+And the result:
+
+```json
+{
+  "Transform": "AWS::Serverless-2016-10-31",
+  "Resources": {
+    "MyFunction": {
+      "Type": "AWS::Serverless::Function"
+    }
+  }
+}
+```
 
 ## Intrinsic functions
 

data/cumuliform.gemspec

@@ -23,7 +23,6 @@ non-existent resources because you have a typo.
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3"
   spec.add_development_dependency "yard", ">= 0.8"

data/examples/top-level-value.rb

@@ -0,0 +1,8 @@
+Cumuliform.template do
+  transform 'AWS::Serverless-2016-10-31'
+  resource 'MyFunction' do
+    {
+      Type: 'AWS::Serverless::Function'
+    }
+  end
+end

data/lib/cumuliform/output.rb

@@ -13,7 +13,11 @@ module Cumuliform
     # @return [Hash] Hash representing the CloudFormation template
     def to_hash
       output = {}
-      SECTIONS.each do |section_name, _|
+      TOP_LEVEL.each do |item_name|
+        value = get_top_level_value(item_name)
+        output[item_name] = value unless value.nil?
+      end
+      SECTION_NAMES.each do |section_name|
         section = get_section(section_name)
         output[section_name] = generate_section(section) unless section.empty?
       end

data/lib/cumuliform/sections.rb

@@ -8,16 +8,18 @@ module Cumuliform
     "Resources" => :resource,
     "Outputs" => :output
   }
+  SECTION_NAMES = SECTIONS.map { |name, _| name }
 
   # @api private
   module Sections
     def initialize
-      SECTIONS.each do |section_name, _|
+      SECTION_NAMES.each do |section_name|
         instance_variable_set(:"@#{section_name}", Section.new(section_name, imports))
       end
     end
 
     def get_section(name)
+      raise ArgumentError, "#{name} is not a valid template section" unless SECTION_NAMES.include?(name)
       instance_variable_get(:"@#{name}")
     end
 

data/lib/cumuliform/template.rb

@@ -11,12 +11,26 @@ module Cumuliform
       AWS::AccountId AWS::NotificationARNs AWS::NoValue
       AWS::Region AWS::StackId AWS::StackName
   }
+  TOP_LEVEL = %w{ Transform Description }
 
   # Represents a single CloudFormation template
   class Template
     include Output
     include Sections
 
+    def transform(transform)
+      @Transform = transform
+    end
+
+    def description(desc)
+      @Description = desc
+    end
+
+    def get_top_level_value(item_name)
+      raise ArgumentError, "Not an allowed top-level item name" unless TOP_LEVEL.include?(item_name)
+      instance_variable_get(:"@#{item_name}")
+    end
+
     # @api private
     def define(&block)
       instance_exec(&block)

data/lib/cumuliform/version.rb

@@ -1,3 +1,3 @@
 module Cumuliform
-  VERSION = "0.5.3"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cumuliform
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Matt Patterson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-05 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +101,7 @@ files:
 - examples/module-helper.rb
 - examples/simplest.rb
 - examples/top-level-declarations.rb
+- examples/top-level-value.rb
 - exe/cumuliform
 - lib/cumuliform.rb
 - lib/cumuliform/dsl.rb
@@ -149,8 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: DSL library for generating AWS CloudFormation templates