cumuliform 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4589cd0a6f35898e49b81876b266f3a9822a111
+  data.tar.gz: 7ddd217959b61d317a0ddc0f2def640d2fa51d07
+SHA512:
+  metadata.gz: d1c8a3767dac321236b599bffb8a4c05d3111eeb7acac048a8da941d061dc3b3bfe12fa61150dad15bb590596a7414aa9a04a765c09b2f24d4e8673c36ccc0a0
+  data.tar.gz: 20524b85307eb0fe35233ccb6c3453dbc6d09a4920af248fa0d22c9df8abfc62e37b316a7b1149306153546d3d0f71387f5328087b39efa063c8cbe60e3920f3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+sudo: false
+rvm:
+  2.2.2
+addons:
+  code_climate:
+    repo_token: "ad171accd9e47d577857f84b0d9032042ea70bf942a219bfa4f5582b5e504a60"

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cumuliform.gemspec
+gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Matt Patterson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Cumuliform
+
+[![Build Status](https://travis-ci.org/tape-tv/cumuliform.svg?branch=master)](https://travis-ci.org/tape-tv/cumuliform) [![Code Climate](https://codeclimate.com/github/tape-tv/cumuliform/badges/gpa.svg)](https://codeclimate.com/github/tape-tv/cumuliform) [![Test Coverage](https://codeclimate.com/github/tape-tv/cumuliform/badges/coverage.svg)](https://codeclimate.com/github/tape-tv/cumuliform/coverage)
+
+A DSL and library for the generation and reuse of Amazon's AWS CloudFormation templates, extracted from ops and deployment code at tape.tv
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cumuliform'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cumuliform
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/tape-tv/cumuliform/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: [:spec]
+rescue LoadError
+end
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cumuliform"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cumuliform.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cumuliform/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cumuliform"
+  spec.version       = Cumuliform::VERSION
+  spec.authors       = ["Matt Patterson"]
+  spec.email         = ["matt@reprocessed.org"]
+
+  spec.summary       = %q{DSL library for generating AWS CloudFormation templates}
+  spec.description   = <<-EOD
+Simple DSL for generation AWS CloudFormation templates with an emphasis
+on ensuring you don't shoot yourself in the foot by, e.g. referencing
+non-existent resources because you have a typo.
+  EOD
+  spec.homepage      = "https://www.github.com/tape-tv/cumuliform"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  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", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+end

data/lib/cumuliform/error.rb

@@ -0,0 +1,47 @@
+module Cumuliform
+  module Error
+    class IDError < StandardError
+      attr_reader :id
+
+      def initialize(id)
+        @id = id
+      end
+    end
+
+    class DuplicateLogicalID < IDError
+      def to_s
+        "Existing item with logical ID '#{id}'"
+      end
+    end
+
+    class NoSuchLogicalId < IDError
+      def to_s
+        "No such logical ID '#{id}'"
+      end
+    end
+
+    class FragmentAlreadyDefined < IDError
+      def to_s
+        "Fragment '#{id}' already defined"
+      end
+    end
+
+    class FragmentNotFound < IDError
+      def to_s
+        "No fragment with name '#{id}'"
+      end
+    end
+
+    class EmptyItem < IDError
+      def to_s
+        "Empty item '#{id}'"
+      end
+    end
+
+    class NoResourcesDefined < StandardError
+      def to_s
+        "No resources defined"
+      end
+    end
+  end
+end

data/lib/cumuliform/fragments.rb

@@ -0,0 +1,44 @@
+require_relative 'error'
+
+module Cumuliform
+  module Fragments
+    def fragments
+      @fragments ||= {}
+    end
+
+    def fragment(name, *args, &block)
+      if block_given?
+        define_fragment(name, block)
+      else
+        include_fragment(name, *args)
+      end
+    end
+
+    def find_fragment(name)
+      local_fragment = fragments[name]
+      imports.reverse.reduce(local_fragment) { |fragment, import|
+        fragment || import.find_fragment(name)
+      }
+    end
+
+    def has_fragment?(name)
+      !find_fragment(name).nil?
+    end
+
+    private
+
+    def define_fragment(name, block)
+      if fragments.has_key?(name)
+        raise Error::FragmentAlreadyDefined, name
+      end
+      fragments[name] = block
+    end
+
+    def include_fragment(name, opts = {})
+      unless has_fragment?(name)
+        raise Error::FragmentNotFound, name
+      end
+      instance_exec(opts, &find_fragment(name))
+    end
+  end
+end

data/lib/cumuliform/functions.rb

@@ -0,0 +1,69 @@
+require_relative 'error'
+
+module Cumuliform
+  module Functions
+    class IntrinsicFunctions
+      attr_reader :template
+
+      def initialize(template)
+        @template = template
+      end
+
+      def find_in_map(mapping_logical_id, level_1_key, level_2_key)
+        template.verify_mapping_logical_id!(mapping_logical_id)
+        {"Fn::FindInMap" => [mapping_logical_id, level_1_key, level_2_key]}
+      end
+
+      def get_att(resource_logical_id, attr_name)
+        template.verify_resource_logical_id!(resource_logical_id)
+        {"Fn::GetAtt" => [resource_logical_id, attr_name]}
+      end
+
+      def join(separator, args)
+        raise ArgumentError, "Second argument must be an Array" unless args.is_a?(Array)
+        {"Fn::Join" => [separator, args]}
+      end
+
+      def base64(value)
+        {"Fn::Base64" => value}
+      end
+
+      def get_azs(value = "")
+        {"Fn::GetAZs" => value}
+      end
+
+      def equals(value, other_value)
+        {"Fn::Equals" => [value, other_value]}
+      end
+
+      def if(condition, true_value, false_value)
+        {"Fn::If" => [condition, true_value, false_value]}
+      end
+
+      def select(index, array)
+        unless index.is_a?(Integer) && index >= 0
+          raise ArgumentError, "index must be a positive integer"
+        end
+        if array.is_a?(Array) && index >= array.length
+          raise IndexError, "index must be in the range 0 <= index < array.length"
+        end
+        {"Fn::Select" => [index.to_s, array]}
+      end
+    end
+
+    def xref(logical_id)
+      unless has_logical_id?(logical_id)
+        raise Error::NoSuchLogicalId, logical_id
+      end
+      logical_id
+    end
+
+    def ref(logical_id)
+      {"Ref" => xref(logical_id)}
+    end
+
+    def fn
+      @fn ||= IntrinsicFunctions.new(self)
+    end
+  end
+end

data/lib/cumuliform/import.rb

@@ -0,0 +1,62 @@
+require_relative 'error'
+
+module Cumuliform
+  module Import
+    def import(template)
+      imports << template
+    end
+
+    def has_logical_id?(logical_id)
+      (imports.reverse).inject(logical_ids.include?(logical_id)) { |found, template|
+        found || template.has_logical_id?(logical_id)
+      }
+    end
+
+    def verify_logical_id!(logical_id)
+      raise Error::NoSuchLogicalId, logical_id unless has_logical_id?(logical_id)
+      true
+    end
+
+    private
+
+    def imports
+      @imports ||= []
+    end
+  end
+
+  class Section
+    attr_reader :name, :imports, :items
+
+    def initialize(name, imports)
+      @name = name
+      @imports = imports
+      @items = {}
+    end
+
+    def []=(name, item)
+      items[name] = item
+    end
+
+    def [](name)
+      merged[name]
+    end
+
+    def each(&block)
+      merged.each(&block)
+    end
+
+    def member?(name)
+      merged.member?(name)
+    end
+
+    def empty?
+      merged.empty?
+    end
+
+    def merged
+      imports.reduce({}) { |merged, import|
+        import.get_section(name).merged.merge(merged)
+      }.merge(items)
+    end
+  end
+end

data/lib/cumuliform/output.rb

@@ -0,0 +1,41 @@
+# Simple AWS CloudFormation. Doesn't try to run the commands, doesn't try to
+# DSLize every last thing. Simple is the watch word
+
+require 'json'
+require 'set'
+
+module Cumuliform
+  module Output
+    def to_hash
+      output = {}
+      SECTIONS.each do |section_name, _|
+        section = get_section(section_name)
+        output[section_name] = generate_section(section) unless section.empty?
+      end
+
+      raise Error::NoResourcesDefined unless output.has_key?("Resources")
+      output
+    end
+
+    def to_json
+      JSON.pretty_generate(to_hash)
+    end
+
+    private
+
+    def generate_section(section)
+      output = {}
+      section.each do |logical_id, block|
+        output[logical_id] = generate_item(logical_id, block)
+      end
+      output
+    end
+
+    def generate_item(logical_id, block)
+      raise Error::EmptyItem, logical_id if block.nil?
+      item_body = instance_exec(&block)
+      raise Error::EmptyItem, logical_id if item_body.empty?
+      item_body
+    end
+  end
+end

data/lib/cumuliform/version.rb

@@ -0,0 +1,3 @@
+module Cumuliform
+  VERSION = "0.3.0"
+end

data/lib/cumuliform.rb

@@ -0,0 +1,96 @@
+# Simple AWS CloudFormation. Doesn't try to run the commands, doesn't try to
+# DSLize every last thing. Simple is the watch word
+
+require 'json'
+require 'set'
+require_relative 'cumuliform/error'
+require_relative 'cumuliform/fragments'
+require_relative 'cumuliform/functions'
+require_relative 'cumuliform/import'
+require_relative 'cumuliform/output'
+
+module Cumuliform
+  AWS_PSEUDO_PARAMS = %w{
+      AWS::AccountId AWS::NotificationARNs AWS::NoValue
+      AWS::Region AWS::StackId AWS::StackName
+  }
+  SECTIONS = {
+    "Parameters" => :parameter,
+    "Mappings" => :mapping,
+    "Conditions" => :condition,
+    "Resources" => :resource,
+    "Outputs" => :output
+  }
+
+  def self.template(&block)
+    template = Template.new
+    template.define(&block)
+  end
+
+  class Template
+    include Import
+    include Fragments
+    include Functions
+    include Output
+
+    def initialize
+      SECTIONS.each do |section_name, _|
+        instance_variable_set(:"@#{section_name}", Section.new(section_name, imports))
+      end
+    end
+
+    def helpers(*mods, &block)
+      if block_given?
+        mods << Module.new(&block)
+      end
+      mods.each do |mod|
+        self.class.include mod
+      end
+    end
+
+    def define(&block)
+      instance_exec(&block)
+      self
+    end
+
+    def logical_ids
+      @logical_ids ||= Set.new(AWS_PSEUDO_PARAMS)
+    end
+
+    def get_section(name)
+      instance_variable_get(:"@#{name}")
+    end
+
+    SECTIONS.each do |section_name, method_name|
+      error_class = Class.new(Error::IDError) do
+        def to_s
+          "No logical ID '#{id}' in section"
+        end
+      end
+      Error.const_set("NoSuchLogicalIdIn#{section_name}", error_class)
+
+      define_method method_name, ->(logical_id, &block) {
+        add_to_section(section_name, logical_id, block)
+      }
+
+      define_method :"verify_#{method_name}_logical_id!", ->(logical_id) {
+        raise error_class, logical_id unless get_section(section_name).member?(logical_id)
+        true
+      }
+    end
+
+    private
+
+    def has_local_logical_id?(logical_id)
+      logical_ids.include?(logical_id)
+    end
+
+    def add_to_section(section_name, logical_id, block)
+      if has_local_logical_id?(logical_id)
+        raise Error::DuplicateLogicalID, logical_id
+      end
+      logical_ids << logical_id
+      get_section(section_name)[logical_id] = block
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: cumuliform
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Matt Patterson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-27 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: |
+  Simple DSL for generation AWS CloudFormation templates with an emphasis
+  on ensuring you don't shoot yourself in the foot by, e.g. referencing
+  non-existent resources because you have a typo.
+email:
+- matt@reprocessed.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cumuliform.gemspec
+- lib/cumuliform.rb
+- lib/cumuliform/error.rb
+- lib/cumuliform/fragments.rb
+- lib/cumuliform/functions.rb
+- lib/cumuliform/import.rb
+- lib/cumuliform/output.rb
+- lib/cumuliform/version.rb
+homepage: https://www.github.com/tape-tv/cumuliform
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: DSL library for generating AWS CloudFormation templates
+test_files: []