terraform-template-renderer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cef4859595c7d96c5122dbe5b058da92806f7905
+  data.tar.gz: 162af8691305d44a0cb024d1f2ceac8efe83a5a4
+SHA512:
+  metadata.gz: e221e4184fa8e12e9ce5c0c850071bcdf1a5a84e734872790ba3cb5250112f08547babeab991e13a951aa5246e6d1099c13d310ab4ad0562876446657b13870d
+  data.tar.gz: 372ebfe28e1e7d077c0ea60ed8827410e4d1a6c45c17c39721a684b5af8a025c3ea016ff4b39823baf8c1f4d21839aa38e1eec14d8b602d787c5d320e889f87a

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+Metrics/LineLength:
+  Max: 119
+  Exclude:
+    - "spec/**/*"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.1.0 (2018-01-28)
+
+Features:
+
+ - Initial version, reads json from stdin, takes path to ERB template as first argument, outputs json object with
+	rendered template as the value to key "rendered".

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jonathan Harden
+
+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,24 @@
+# terraform-template-renderer
+
+Provides a ruby executable which will take a path to an ERB template as it's only positional argument and render that
+with a json blob passed in to STDIN. The keys in the json blob will be used as instance variable names to use in the
+template.
+
+The result will be returned inside a json blob with a single key, the name of which is rendered.
+
+For example if your template is
+
+    Hello <%= @my_key %>!
+
+And you execute the command as:
+
+    echo '{ "my_key": "dear reader" }' | template_renderer path_to_my_template
+
+You will produce
+
+    { "rendered": "Hello dear reader!" }
+
+The purpose for this strange behaviour is to be a [terraform external
+provider](https://www.terraform.io/docs/providers/external/data_source.html) to render arbitrarily complex templates,
+terraform passes in the variables to render as a json blob to stdin as described above and expects a json blob
+back.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/rake

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/exe/render-template

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json"
+require_relative "../lib/terraform_template_renderer"
+
+def help
+  puts <<~EOF
+    Usage: render-template <path_to_erb_template>
+
+    Reads json blob with params from STDIN
+  EOF
+end
+
+if ARGV.empty?
+  STDERR.puts "You must supply the path to an ERB template as the first argument"
+  exit 1
+end
+
+template_path = ARGV[0]
+
+if ["-h", "--help", "-help", "help"].include?(template_path)
+  help
+  exit 0
+end
+
+unless File.exist?(template_path)
+  STDERR.puts "ERB Template #{template_path} does not exist"
+  exit 2
+end
+
+template = File.read(template_path)
+json_params = STDIN.read
+
+renderer = TerraformTemplateRenderer::Renderer.new(template)
+rendered_template = renderer.render(json_params)
+json_output = { rendered: rendered_template }.to_json
+puts json_output

data/lib/terraform_template_renderer.rb

@@ -0,0 +1,3 @@
+require_relative "terraform_template_renderer/binding"
+require_relative "terraform_template_renderer/renderer"
+require_relative "terraform_template_renderer/version"

data/lib/terraform_template_renderer/binding.rb

@@ -0,0 +1,11 @@
+module TerraformTemplateRenderer
+  class Binding
+    def add_param(key, value)
+      instance_variable_set("@#{key}", value)
+    end
+
+    def bind
+      binding
+    end
+  end
+end

data/lib/terraform_template_renderer/renderer.rb

@@ -0,0 +1,28 @@
+require "erb"
+require "json"
+
+module TerraformTemplateRenderer
+  class Renderer
+    def initialize(template)
+      @erb_template = ERB.new(template)
+    end
+
+    # The passed in json_variables needs to be a JSON object (not array), all the keys will be used
+    # as variables in the templates
+    def render(json_variables)
+      @erb_template.result(template_binding(json_variables))
+    end
+
+    private
+
+    def template_binding(json_variables)
+      Binding.new.tap { |binding_object| add_params_to_object(binding_object, JSON.parse(json_variables)) }.bind
+    end
+
+    def add_params_to_object(object, params)
+      params.each do |key, value|
+        object.add_param(key, value)
+      end
+    end
+  end
+end

data/lib/terraform_template_renderer/version.rb

@@ -0,0 +1,3 @@
+module TerraformTemplateRenderer
+  VERSION = "0.1.0"
+end

data/terraform-template-renderer.gemspec

@@ -0,0 +1,35 @@
+require_relative "lib/terraform_template_renderer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "terraform-template-renderer"
+  spec.version       = TerraformTemplateRenderer::VERSION
+  spec.authors       = ["Jonathan Harden"]
+  spec.email         = ["jfharden@gmail.com"]
+  spec.license       = "MIT"
+  spec.homepage      = "http://github.com/jfharden/terraform-template-renderer"
+
+  spec.summary       = "Renders an aribtrary erb template with passed in JSON variables"
+  spec.description   = <<-DESCRIPTION
+    Will render an arbitrary erb template (passed as the first positional argument),
+    filling variables from a passed in JSON blob, the keys will be used as variable names
+    and the values their respective values.
+
+    The purpose of this GEM is to make it easy to render complex templates in terraform in
+    a modular and reusable way.
+  DESCRIPTION
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = "render-template"
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.add_development_dependency "aruba", "~> 0.14.3"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "pry-byebug", "~> 3.5"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.7"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: terraform-template-renderer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Harden
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: |2
+      Will render an arbitrary erb template (passed as the first positional argument),
+      filling variables from a passed in JSON blob, the keys will be used as variable names
+      and the values their respective values.
+
+      The purpose of this GEM is to make it easy to render complex templates in terraform in
+      a modular and reusable way.
+email:
+- jfharden@gmail.com
+executables:
+- render-template
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/rake
+- bin/rspec
+- exe/render-template
+- lib/terraform_template_renderer.rb
+- lib/terraform_template_renderer/binding.rb
+- lib/terraform_template_renderer/renderer.rb
+- lib/terraform_template_renderer/version.rb
+- terraform-template-renderer.gemspec
+homepage: http://github.com/jfharden/terraform-template-renderer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Renders an aribtrary erb template with passed in JSON variables
+test_files: []