terraform-template-renderer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48bac62d1bd59cb46a67cfcc05d0a3a92a5d2300
-  data.tar.gz: 3ca5b7f8ce549c3a498bd688e8b9e2b83df16f35
+  metadata.gz: 199d05f5cf8be0a612bac993592c3ad7e83a17a4
+  data.tar.gz: a0707bbc1b18022812c9ac513b479031cf6008cf
 SHA512:
-  metadata.gz: 05208a74a1873f77c36647a90edc1407fe5856b54bb41398f14839256bc8c47152a3ae49c59062ac145d29b71ccb388c1f52bec5ab370377dc61f7e878396453
-  data.tar.gz: 7666c567d1a7c0973ae06b9df0dbf155d6feae5f31ebb2bbb8bc53da5cb4f6cc16c7e11b08591b155aabfa2f2a4c627832735a788f25b187688bc42436ea38f5
+  metadata.gz: c0add51ad60f5be109c7c94cc6acdc60ff16e7fdef8182e94486847be280c5fcb4d0341dd0394b64e1e042500be36c8335c78e0f86ed4e38d3c22afa3284db77
+  data.tar.gz: b7c9ebd034973e49d589d53619bbd55d5969d29b1945f58991f7b8addc5c4c6dd8abf7a8168f051ef9e5f08f010479927e39cf010978c23c57974d28e9cb67bb

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
 Metrics/LineLength:
   Max: 119
   Exclude:

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.3.0 (2018-02-02)
+
+Features:
+
+ - Partials can now be rendered by calling `render 'path/to/partial.erb'` in the template.
+
 ## 0.2.0 (2018-01-29)
 
 Features:

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -23,6 +23,27 @@ provider](https://www.terraform.io/docs/providers/external/data_source.html) to
 terraform passes in the variables to render as a json blob to stdin as described above and expects a json blob
 back.
 
+## Rendering Partials
+
+Inside any template you can render a partial template by calling the render method.
+
+For example if you have a partial template in filepath `partials/partial.erb`:
+
+    This is a partial, Hello <%= name %>
+
+And your template is
+
+    My favourite colour is <%= colour %>
+    <%= render 'partials/partial.erb' %>
+
+And you execute the command as
+
+    echo '{ "colour": "purple", "name": "Jonathan" }' | template_renderer path_to_my_template
+
+You will produce
+
+    { "rendered": "My favourite colour is purple\nThis is a partial, Hello Jonathan\n" }
+
 ## ERB Template notes
 
 Trim mode is enabled and the trim character is a hyphen `-`.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/examples/Gemfile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 gem "terraform-template-renderer", path: "../"

data/examples/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    terraform-template-renderer (0.2.0)
+    terraform-template-renderer (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/examples/simple_partials/partials/string1.erb

@@ -0,0 +1,2 @@
+First partial <%= @partial_key_1 %>
+<%= render "partials/string2.erb" -%>

data/examples/simple_partials/partials/string2.erb

@@ -0,0 +1 @@
+Second partial <%= @partial_key_2 %>

data/examples/simple_partials/simple_partials.erb

@@ -0,0 +1,3 @@
+KEY1 [<%=@key1%>]
+KEY2 [<%=@key2%>]
+<%= render "partials/string1.erb" -%>

data/examples/simple_partials/simple_partials.tf

@@ -0,0 +1,23 @@
+terraform {
+  required_version = "~> 0.11.1"
+}
+
+provider "external" {
+  version = "~> 1.0.0"
+}
+
+data "external" "simple_partials" {
+  program = ["bundle", "exec", "render-template", "simple_partials.erb"]
+
+  query {
+    key1 = "value1"
+    key2 = "value2"
+    partial_key_1 = "partial_value_1"
+    partial_key_2 = "partial_value_2"
+  }
+}
+
+resource "local_file" "simple_partials" {
+  content = "${data.external.simple_partials.result.rendered}"
+  filename = "sample_output"
+}

data/exe/render-template

@@ -1,15 +1,17 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require "bundler/setup"
 require "json"
 require_relative "../lib/terraform_template_renderer"
 
 def help
-  puts <<~EOF
+  puts <<~HELP
     Usage: render-template <path_to_erb_template>
 
     Reads json blob with params from STDIN
-  EOF
+  HELP
 end
 
 if ARGV.empty?
@@ -24,7 +26,7 @@ if ["-h", "--help", "-help", "help"].include?(template_path)
   exit 0
 end
 
-unless File.exist?(template_path)
+unless File.file?(template_path)
   STDERR.puts "ERB Template #{template_path} does not exist"
   exit 2
 end
@@ -32,7 +34,7 @@ end
 template = File.read(template_path)
 json_params = STDIN.read
 
-renderer = TerraformTemplateRenderer::Renderer.new(template)
+renderer = TerraformTemplateRenderer::Renderer.new(template, File.dirname(template_path))
 rendered_template = renderer.render(json_params)
 json_output = { rendered: rendered_template }.to_json
 puts json_output

data/lib/terraform_template_renderer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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

@@ -1,5 +1,15 @@
+# frozen_string_literal: true
+
 module TerraformTemplateRenderer
+  # Provides a Binding context which we can add arbitrary params to (which will become instance
+  # variables for the templates when they get rendered). Also provides a method to render
+  # partial templates which will pass through itself as the binding context for the partial
+  # template
   class Binding
+    def initialize(template_path)
+      @template_path = template_path
+    end
+
     def add_param(key, value)
       instance_variable_set("@#{key}", value)
     end
@@ -7,5 +17,12 @@ module TerraformTemplateRenderer
     def bind
       binding
     end
+
+    def render(partial_path)
+      path_to_partial = File.join(@template_path, partial_path)
+      renderer = Renderer.new(File.read(path_to_partial), @template_path)
+
+      renderer.render_with_binding(self)
+    end
   end
 end

data/lib/terraform_template_renderer/renderer.rb

@@ -1,23 +1,35 @@
+# frozen_string_literal: true
+
 require "erb"
 require "json"
 
 module TerraformTemplateRenderer
+  # Renderer to remder an ERB template with variables taken from a json string instead of
+  # from the original binding
   class Renderer
-    def initialize(template)
+    def initialize(template, template_path)
       # The third argument enables trim mode using a hyphen
       @erb_template = ERB.new(template, nil, "-")
+      @template_path = template_path
     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))
+      binding_ = template_binding(json_variables)
+      render_with_binding(binding_)
+    end
+
+    def render_with_binding(binding_)
+      @erb_template.result(binding_.bind)
     end
 
     private
 
     def template_binding(json_variables)
-      Binding.new.tap { |binding_object| add_params_to_object(binding_object, JSON.parse(json_variables)) }.bind
+      Binding.new(@template_path).tap do |binding_object|
+        add_params_to_object(binding_object, JSON.parse(json_variables))
+      end
     end
 
     def add_params_to_object(object, params)

data/lib/terraform_template_renderer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TerraformTemplateRenderer
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/terraform-template-renderer.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/terraform_template_renderer/version"
 
 Gem::Specification.new do |spec|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraform-template-renderer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jonathan Harden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-29 00:00:00.000000000 Z
+date: 2018-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -121,6 +121,10 @@ files:
 - examples/simple_list/simple_list.tf
 - examples/simple_map/simple_map.erb
 - examples/simple_map/simple_map.tf
+- examples/simple_partials/partials/string1.erb
+- examples/simple_partials/partials/string2.erb
+- examples/simple_partials/simple_partials.erb
+- examples/simple_partials/simple_partials.tf
 - examples/simple_strings/simple_strings.erb
 - examples/simple_strings/simple_strings.tf
 - exe/render-template