cfer 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 603fcf5d75a2213b550efd3995f32516d80a7d7c8e3fad3625d87d4679c54a6e
-  data.tar.gz: c52dec7e2d40bc755e7dd203c183fcf78fb5ee732680bba609f9ea11bc0a1abc
+  metadata.gz: 2a6abc36b399fc3f0b6733ecfecb066ede795f883ca33c3701905482fa45ea4c
+  data.tar.gz: 03dd4c80a9ec1dc46f54fff419c66e0797a588efbd7b93a78173b579e0e636a6
 SHA512:
-  metadata.gz: b1637ca9021a0522a2745341881a5735d2ca60052f2d584dde85654e7fe9c79e247c24e7fd52b3b6bb295b83ce3b7442ea62f1bf932bb98f6b16e37c9c9edf2d
-  data.tar.gz: f4a49c953b84bb6a33df73c192e733d50c3ac69262db1aa09f419294e0efeb94ef2947dbd03dc265c353e9e8dc4ce3e0e6779ebc93241c3fa1a1af19c1565907
+  metadata.gz: 2efd4ee2bcb86c0c421f563a1487dc634915a862cc00faeb77de29fe0987e3994b5e3116034b0667801b28ab03cb716e8c87f2f99e03bc4094e8c836170f6d2a
+  data.tar.gz: 5089f9d86fea161d522d6e11a1cc7d9352f937a863a65cc9c467832244bd068355ca5a955b3ed461a73ebad08d41dd8000f65cf6082173d72e8fe975a2939cbd

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+

data/.github/workflows/build.yml

@@ -0,0 +1,18 @@
+name: Build Cfer
+on: [push]
+jobs:
+  Build:
+    strategy:
+      matrix:
+        os: [ubuntu, macos]
+        ruby: ["2.7", "3.0", "3.1"]
+    runs-on: ${{matrix.os}}-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+          bundler-cache: true
+      - run: bundle install --without debug --jobs=3 --retry=3
+      - run: bundle exec rspec
+      - run: bundle exec yard

data/.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Release Cfer
+on:
+  workflow_dispatch:
+    inputs:
+      release_type:
+        type: choice
+        description: Type of release to run
+        required: true
+        options:
+          - major
+          - minor
+          - patch
+jobs:
+  Publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1
+          bundler-cache: true
+      - run: bundle install --without debug --without test --jobs=3 --retry=3
+      - name: Bump version
+        run: |
+          git config --global user.name "CI"
+          git config --global user.email "seanedwards@users.noreply.github.com"
+          bundle exec bump ${{inputs.release_type}} --tag --tag-prefix v --changelog
+          git merge v$(bundle exec bump current)
+          git push --follow-tags
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_API_KEY}}"

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.2

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Cfer Change Log
 
+## Next
+## 1.0.0
+## 0.8.1
+
+* Support for Ruby 3
+* Deps updates
+* Syntactic sugar for exporting values from a Cfn stackq
+
 ## 0.8.0
 Upgrade to AWS SDK v3
 

data/Gemfile

@@ -7,9 +7,6 @@ group :test do
   gem 'rspec'
   gem 'rspec-mocks'
   gem 'guard-rspec'
-  gem 'simplecov'
-  gem 'rubocop', '~> 0.51'
-  gem "codeclimate-test-reporter", "~> 1.0.0"
 end
 
 group :debug do
@@ -17,5 +14,4 @@ group :debug do
   gem 'pry-byebug'
   gem 'pry-rescue'
   gem 'pry-stack_explorer'
-  gem 'travis'
 end

data/README.md

@@ -1,26 +1,13 @@
 # Cfer
 
-[![Build Status](https://travis-ci.org/seanedwards/cfer.svg?branch=master)](https://travis-ci.org/seanedwards/cfer)
+![Build Status](https://github.com/seanedwards/cfer/actions/workflows/build.yml/badge.svg?branch=master)
 [![Gem Version](https://badge.fury.io/rb/cfer.svg)](http://badge.fury.io/rb/cfer)
-[![Code Climate](https://codeclimate.com/github/seanedwards/cfer/badges/gpa.svg)](https://codeclimate.com/github/seanedwards/cfer)
-[![Test Coverage](https://codeclimate.com/github/seanedwards/cfer/badges/coverage.svg)](https://codeclimate.com/github/seanedwards/cfer/coverage)
-[![Issue Count](https://codeclimate.com/github/seanedwards/cfer/badges/issue_count.svg)](https://codeclimate.com/github/seanedwards/cfer)
 
 
 Cfer is a lightweight toolkit for managing CloudFormation templates.
 
 Read about Cfer [here](https://github.com/seanedwards/cfer/blob/master/examples/vpc.md).
 
-Sign up for the [Cfer mailing list](http://eepurl.com/bVA-Hr) to receive updates when changes are made. Cfer is a slow-moving project, so you can expect around one or two updates per year at most.
-
-## Support
-
-Cfer is pre-1.0 software, and may contain bugs or incomplete features. Please see the [license](https://github.com/seanedwards/cfer/blob/master/LICENSE.txt) for disclaimers.
-
-If you would like support or guidance on Cfer, or CloudFormation in general, I offer DevOps consulting services. Please [Contact me](mailto:stedwards87+cfer@gmail.com) and I'll be happy to discuss your needs.
-
-You can also find me at [@tilmonedwards](https://twitter.com/tilmonedwards). If you use Cfer, or are considering it, I'd love to hear from you.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -119,12 +106,24 @@ Outputs may be defined using the `output` function:
 output :OutputName, Fn::ref(:ResourceName)
 ```
 
+Outputs may have an optional description:
+
+```ruby
+output :OutputName, Fn::ref(:ResourceName), description: 'The resource that does stuff'
+```
+
 Outputs may be retireved from other stacks anywhere in a template by using the `lookup_output` function.
 
 ```ruby
 lookup_output('stack_name', 'output_name')
 ```
 
+Outputs may also be exported for use by `Fn::ImportValue` in other cloudformation stacks:
+
+```ruby
+output :OutputName, Fn::ref(:ResourceName), export: Fn::sub('${AWS::StackName}-OutputName')
+```
+
 #### Including code from multiple files
 
 Templates can get pretty large, and splitting template code into multiple

data/cfer.gemspec

@@ -14,25 +14,27 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/seanedwards/cfer'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version = ['~> 2.2', '>= 2.2.5']
+  spec.required_ruby_version = ['>= 2.2.5']
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'bin'
   spec.executables   = ['cfer', 'json-to-cfer']
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'docile', '~> 1.1.5'
+  spec.add_runtime_dependency 'docile', '~> 1.4'
   spec.add_runtime_dependency 'cri', '~> 2.7'
   spec.add_runtime_dependency 'activesupport', '>= 3'
   spec.add_runtime_dependency 'aws-sdk-cloudformation', '~> 1'
   spec.add_runtime_dependency 'aws-sdk-s3', '~> 1'
   spec.add_runtime_dependency 'preconditions', '~> 0.3.0'
   spec.add_runtime_dependency 'semantic', '~> 1.4'
-  spec.add_runtime_dependency 'rainbow', '~> 2.2'
-  spec.add_runtime_dependency 'highline', '~> 1.7'
+  spec.add_runtime_dependency 'rainbow', '~> 3'
+  spec.add_runtime_dependency 'highline', '~> 2.1'
   spec.add_runtime_dependency 'table_print', '~> 1.5'
   spec.add_runtime_dependency 'git', '~> 1.3'
+  spec.add_runtime_dependency 'rexml', '~> 3'
 
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'bump'
 end

data/lib/cfer/block.rb

@@ -63,7 +63,8 @@ module Cfer
       :parameters,
       :options,
       :lookup_output,
-      :lookup_outputs
+      :lookup_outputs,
+      :__docile_undo_fallback__
     ].freeze
 
     # Directly sets raw properties in the underlying CloudFormation structure.

data/lib/cfer/core/resource.rb

@@ -21,7 +21,7 @@ module Cfer::Core
 
     attr_reader :stack
 
-    def initialize(name, type, stack, **options, &block)
+    def initialize(name, type, stack, options, &block)
       @name = name
       @stack = stack
 
@@ -73,13 +73,13 @@ module Cfer::Core
 
       # Registers a hook that will be run before properties are set on a resource
       # @param type [String] The type of resource, for example `AWS::EC2::Instance`
-      def before(type, options = {}, &block)
+      def before(type, **options, &block)
         resource_class(type).pre_hooks << options.merge(block: block)
       end
 
       # Registers a hook that will be run after properties have been set on a resource
       # @param type [String] The type of resource, for example `AWS::EC2::Instance`
-      def after(type, options = {}, &block)
+      def after(type, **options, &block)
         resource_class(type).post_hooks << options.merge(block: block)
       end
     end

data/lib/cfer/core/stack.rb

@@ -101,7 +101,7 @@ module Cfer::Core
     #     By adding a constraint description, such as must only contain upper- and lowercase letters, and numbers, you can display a customized error message:
     #
     #     ```Malformed input-Parameter MyParameter must only contain upper and lower case letters and numbers```
-    def parameter(name, options = {})
+    def parameter(name, **options)
       param = {}
       options.each do |key, v|
         next if v === nil
@@ -138,7 +138,7 @@ module Cfer::Core
     # @param name [String] The name of the resource (must be alphanumeric)
     # @param type [String] The type of CloudFormation resource to create.
     # @param options [Hash] Additional attributes to add to the resource block (such as the `UpdatePolicy` for an `AWS::AutoScaling::AutoScalingGroup`)
-    def resource(name, type, options = {}, &block)
+    def resource(name, type, **options, &block)
       Preconditions.check_argument(/[[:alnum:]]+/ =~ name, "Resource name must be alphanumeric")
 
       clazz = Cfer::Core::Resource.resource_class(type)
@@ -152,11 +152,14 @@ module Cfer::Core
     # @param name [String] The Logical ID of the output parameter
     # @param value [String] Value to return
     # @param options [Hash] Extra options for this output parameter
-    # @option options [String] :Description Information about the value
-    def output(name, value, options = {})
-      self[:Outputs][name] = options.merge('Value' => value)
-    end
-
+    # @option options [String] :description Information about the value
+    # @option options [String] :export Name be exported for cross-stack reference
+    def output(name, value, **options)
+      opt = options.each_with_object({}) { |(k,v),h| h[k.to_s.capitalize] = v } # capitalize all keys
+      export = opt.has_key?('Export') ? {'Name' => opt['Export']} : nil
+      self[:Outputs][name] = opt.merge('Value' => value, 'Export' => export).compact
+    end
+    
     # Renders the stack into a CloudFormation template.
     # @return [String] The final template
     def to_cfn

data/lib/cfer/version.rb

@@ -1,5 +1,5 @@
 module Cfer
-  VERSION = "0.8.0"
+  VERSION = "1.0.0"
 
   begin
     require 'semantic'

data/lib/cfer.rb

@@ -1,5 +1,6 @@
 require 'active_support/all'
 require 'aws-sdk-cloudformation'
+require 'aws-sdk-s3'
 require 'logger'
 require 'json'
 require 'preconditions'
@@ -299,7 +300,7 @@ module Cfer
     rescue SyntaxError => e
       raise Cfer::Util::TemplateError.new([]), e.message
     rescue StandardError => e
-      raise Cfer::Util::TemplateError.new(convert_backtrace(base_loc, e)), e.message
+      raise e #Cfer::Util::TemplateError.new(convert_backtrace(base_loc, e)), e.message
     end
 
     def convert_backtrace(base_loc, exception)

data/lib/cferext/aws/iam/policy_generator.rb

@@ -3,13 +3,13 @@ require 'docile'
 module CferExt
   module AWS
     module IAM
-      class PolicyGenerator < Cfer::BlockHash
+      class PolicyGenerator < Cfer::Block
         def initialize
           self[:Version] = '2012-10-17'
           self[:Statement] = []
         end
 
-        def statement(options = {}, &block)
+        def statement(**options, &block)
           statement = ::Cfer::BlockHash.new(&block)
           statement.merge! options
           statement.build_from_block(&block)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfer
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Sean Edwards
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2023-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: cri
   requirement: !ruby/object:Gem::Requirement
@@ -114,28 +114,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: table_print
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Toolkit for automating infrastructure using AWS CloudFormation
 email:
 - stedwards87+cfer@gmail.com
@@ -201,11 +229,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/build.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
+- ".tool-versions"
 - ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -258,9 +287,6 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
-    - !ruby/object:Gem::Version
-      version: '2.2'
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.2.5
@@ -270,8 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Toolkit for automating infrastructure using AWS CloudFormation

data/.codeclimate.yml

@@ -1,27 +0,0 @@
----
-engines:
-  duplication:
-    enabled: true
-    config:
-      languages:
-      - ruby
-      - javascript
-      - python
-      - php
-  fixme:
-    enabled: true
-  rubocop:
-    enabled: true
-    exclude_fingerprints:
-      - 9d7be17b9e5e786560cf0df662f55736
-ratings:
-  paths:
-  - "**.inc"
-  - "**.js"
-  - "**.jsx"
-  - "**.module"
-  - "**.php"
-  - "**.py"
-  - "**.rb"
-exclude_paths:
-- spec/**/*