tflat 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8857b58d1633ffb77eda5e12f302113a5741ee5057fb17c32dd1190ba510ee58
-  data.tar.gz: 5cc3cbdccd719aee57517c79369cce8938f845af117a2d778ab8c6628dd498d0
+  metadata.gz: f7f0542a87cf91985a9d85fbb008a929c8476f8ee6c5bf140e35c30a049bf521
+  data.tar.gz: 03b4b5f6f38256fc3d9db1ed1b0d23331f4195e1787e527d1702497f2b45f97c
 SHA512:
-  metadata.gz: 6e559851c0c04dfa89ca8836feee4a2d7a213eb7aa16cc742cf651b0bc974c333277a879a0a94320bf1cbfd99f43587c31d2d4c197273c173b6c78ec8d227490
-  data.tar.gz: 62d8944b2f6955eee6defead0095d790a6942f0c9694d750d4ccfff0c1705b95d7d5b3ccb289c47d7db5e03b9e82b1cc919c2a7aaafb1bb7378f387852609512
+  metadata.gz: 3902861c7d4683a40a07ae308f65ed0b69856b649294e005e76a108b93189d6b4adf242c527cbde2e7236ae9a7454d4ce494788ef7b33ce276b4ff9b231503d8
+  data.tar.gz: 9d89086124665920668439b094c81ebe7bd10cb9adabd3618370ab6bfabe0d65ceefbda82123bed30f04bae3e118ecb1d77ce70e5b0756951affc22b23c6e347

data/README.md

@@ -1,10 +1,10 @@
-# TFlat
+# TFlat = Terraform + Subdirectories + Ruby (ERB)
 
 Aren't you tired of copy and pasting?
 
-I love Terraform, but HCL really gets in the way sometimes.
+I love [Terraform](https://www.terraform.io/), but HCL really gets in the way sometimes.
 
-How many times you wish you could just write a simple IF or CASE statement inside a .tf file? Any attempt of having minimal flow control with HCL results in a massive oneliner mess. Sometimes it feels like writing PERL one-liners. Hard to read equals hard to debug.
+How many times you wish you could just write a simple IF or CASE statement inside a `.tf` file? Any attempt of having minimal flow control with HCL results in a massive oneliner mess. Sometimes it feels like writing PERL one-liners. Hard to read equals hard to debug.
 
 Also, you can't use subfolders with Terraform, so you often end up at one of the three scenarios below:
 - You have a few `.tf` files with a lot of code in it. Ugly and not organized.
@@ -15,6 +15,11 @@ TFlat does 2 things to solve this problem:
 * Separate your Terraform code in subdirectories.
 * It allows you to write Ruby code in `.tf` files using ERB templates. Hurray!
 
+Jump to:
+* [Installation](#installation)
+* [Usage](#usage)
+
+
 ## How does TFlat make Terraform read subdirectories?
 It doesn't. This is what happens when you run it:
 1. Create a folder `.tflat` inside the current folder if it doesn't exist yet. If it does exist, delete all files from this folder non-recursively.
@@ -92,10 +97,15 @@ template = "<%= file('files/userdata.tpl') %>"
 # Let Terraform load the file content using the 'f' helper method (quoting nightmare!)
 template = "${file("<%= f('files/userdata.tpl') %>")}"
 ```
+
+**IMPORTANT:** The file path must be relative to the project's root folder!
+
 It is up to you to choose what you like. Try both and look inside `.tflat/main.tf` to see the difference between the two ways.
 
 ## Installation
+1. [Download and install Terraform](https://www.terraform.io/intro/getting-started/install.html). Make sure the `terraform` command is in your **$PATH**.
 
+2. Install the gem:
 ```
 $ gem install tflat
 ```
@@ -112,6 +122,27 @@ tflat plan
 ```
 That's it!
 
+## Using TFVARS inside the ERB template
+If you store your variables in JSON format inside a file named `terraform.tfvars.json`, those variables will be automatically available for you as a HASH named `@variables` (with string keys). For example:
+
+```
+# terraform.tfvars.json
+{
+  "app_domain": "example.com"
+}
+
+# files/swarm-stack.yml
+version: "3.7"
+services:
+  ...
+  myapp:
+    ...
+    environment:
+      - DOMAIN_NAME=<%= @variables['app_domain'] %>
+...
+```
+
+That way you don't have to deal with Terraform templates!
 
 ## Contributing
 

data/lib/tflat.rb

@@ -2,6 +2,7 @@ require "tflat/version"
 require 'erb'
 require 'fileutils'
 require 'ptools'
+require 'json'
 
 module Tflat
   class Terraform
@@ -19,6 +20,7 @@ module Tflat
         return
       end
       setup
+      read_variables
       print "- [tflat] Generating files..."
       flatten_directories
       parse_erb
@@ -35,6 +37,11 @@ module Tflat
       end
     end
 
+    def read_variables
+      return unless File.file?('terraform.tfvars.json')
+      @variables = JSON.parse(File.read 'terraform.tfvars.json')
+    end
+
     def flatten_directories
       all_files.each do |entry|
         new_name = entry.sub(/^#{directory}\//,'').gsub('/', '#')

data/lib/tflat/version.rb

@@ -1,3 +1,3 @@
 module Tflat
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tflat
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Paulo Arruda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-10 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ptools