consul-templaterb 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5b4bfc2f950af28c0c5db345700d15cdf01076cab18efea784e6ad6d1329e81
-  data.tar.gz: 725e4f3abcae9d3891b6956547dbb94a1c35beb3c810a34d2e8ade1f59e6f47c
+  metadata.gz: d6f546cec480feae29069b3458138d65bdeacc686b5a0e2a0e6762a306ee7cbe
+  data.tar.gz: edad0a361f2bfc627994e05ea590cb5c1f62c81a1f25aeaaad9c150110e0ed5c
 SHA512:
-  metadata.gz: 10f434a98600c5d2613fd6cfc1c195ed2344a2f9c4929d8fe8625815b9cd9ec086452e10cfbb55d6be9645fc81bd967d9556f40da7e408adb2d52089b260da7a
-  data.tar.gz: c2ba837aced1ca0db90480b4deb91dffafa0fa5f621ac9f9161e557d25e7ad580fee23f6bbd04fbe2759d2df9f7c75578725d4d50389ab71fd19c246e84dc13b
+  metadata.gz: d4882996d68193413e3b9b2cacdb182c14cd6c952b6a53397488689d140e90ce0b6f7cefd898028d85e0cb22114c9a53b1c6333fd06aaa50d73dcc9158560836
+  data.tar.gz: 8cbeeda5ae647a91fe9744a5240c0113f216c29613e802f58ec8ffcbb5b49d632192573fe0e4fd1dc357c498d48c81935d38f3f58886bd72c0d37270100efa7f

data/.rubocop.yml

@@ -13,7 +13,7 @@ Metrics/BlockNesting:
   Max: 4
 
 Metrics/ClassLength:
-  Max: 200
+  Max: 225
 
 Metrics/CyclomaticComplexity:
   Max: 15

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## (UNRELEASED)
 
+## 1.8.0 (December 11, 2018)
+
+NEW FEATURES:
+
+ * Added new function `template_info` to get information about the file being rendered and whether
+   the first rendering phase is completed.
+
 ## 1.7.0 (December 7, 2018)
 
 OPTIMIZATIONS:

data/README.md

@@ -290,8 +290,8 @@ Please consult [CHANGELOG.md](CHANGELOG.md) for fixed bugs.
 
 * [x] Hashi's Vault support (EXPERIMENTAL)
 * [ ] Implement automatic dynamic rate limit
-* [ ] More samples: apache, nginx, full website displaying consul information...
-* [ ] Optimize rendering speed at start-up: an iteration is done very second by default, but it would be possible to speed
+* [x] More samples: apache, nginx, full website displaying consul information...
+* [x] Optimize rendering speed at start-up: an iteration is done very second by default, but it would be possible to speed
       up rendering by iterating with higher frequency until the first write of result has been performed.
 * [ ] Allow to tune bandwidth using a simple configuration file (while it should not be necessary for 90% of use-cases)
 

data/TemplateAPI.md

@@ -377,3 +377,48 @@ secret('secret/foo', [force_ttl: intInSecond])
 
 </div>
 </details>
+
+## template_info()
+
+It returns information about current template being rendered.
+The information returned has the following structure:
+
+```json
+{
+  'destination':       destination_file_for_root_template
+  'source':            absolute_path_to_template_file.erb
+  'source_root':       absolute_path_to_root_template.erb
+  'was_rendered_once': true|false
+}
+```
+
+- `destination`: absolute path where the file is gonna be written
+- `source`: the template absolute path file, most of the time, if will be
+  equal to `source_root`, except when the current template is included
+  in another template using `render_file()`
+- `source_root`: the root template absolute file.
+- `was_rendered_once` true if whole template structure has been rendered
+  at least once, false if current template data is still incomplete.
+
+<details><summary>Examples</summary>
+<div class="samples">
+
+### Display template info
+
+```erb
+I am the file <%= File.basename(template_info['source']) %><%
+  if template_info['source'] != template_info['source_root']
+%> included from template <%= File.basename(template_info['source_root']) %><%
+  end
+%> rendered as <%= File.basename(template_info['destination']) %>
+```
+
+The command `consul-template template_info.erb` would render:
+`I am the file template_info.erb rendered as template_info`
+
+If creating a file called include.erb with contents: `<%= render_file('template_info.erb') %>`,
+the command `consul-templaterb --template include.erb:destination_file.txt` would render:
+`I am the file template_info.erb included from template include.erb rendered as destination_file.txt`
+
+</div>
+</details>

data/lib/consul/async/consul_template.rb

@@ -36,6 +36,12 @@ module Consul
         }
         @context = {
           current_erb_path: nil,
+          template_info: {
+            'source_root'       => nil,
+            'source'            => nil,
+            'destination'       => nil,
+            'was_rendered_once' => false
+          },
           params: {}
         }
 
@@ -104,6 +110,11 @@ module Consul
         v
       end
 
+      # Get information about current template
+      def template_info
+        @context[:template_info]
+      end
+
       # https://www.consul.io/api/catalog.html#list-services
       def services(dc: nil, tag: nil)
         path = '/v1/catalog/services'
@@ -153,7 +164,7 @@ module Consul
       def render_file(path, params = {})
         new_path = File.expand_path(path, File.dirname(@context[:current_erb_path]))
         raise "render_file ERROR: #{path} is resolved as #{new_path}, but the file does not exists" unless File.exist? new_path
-        render(File.read(new_path), new_path, params)
+        render(File.read(new_path), new_path, params, current_template_info: template_info)
       end
 
       def find_line(e)
@@ -164,12 +175,14 @@ module Consul
         nil
       end
 
-      def render(tpl, tpl_file_path, params = {})
+      def render(tpl, tpl_file_path, params = {}, current_template_info: nil)
         # Ugly, but allow to use render_file well to support stack of calls
         old_value = @context
+        tpl_info = current_template_info.merge('source' => tpl_file_path.freeze)
         @context = {
           current_erb_path: tpl_file_path,
-          params: params
+          params: params,
+          template_info: tpl_info
         }
         result = ERB.new(tpl, nil, @trim_mode).result(binding)
         @context = old_value
@@ -182,8 +195,8 @@ module Consul
         raise e2, "[TEMPLATE SYNTAX ERROR] #{tpl_file_path}#{find_line(e)}: #{e.message}"
       end
 
-      def write(file, tpl, last_result, tpl_file_path, params = {})
-        data = render(tpl, tpl_file_path, params)
+      def write(file, tpl, last_result, tpl_file_path, params = {}, current_template_info: {})
+        data = render(tpl, tpl_file_path, params, current_template_info: current_template_info)
         not_ready = []
         ready = 0
         @iteration = Time.now.utc - @start_time

data/lib/consul/async/consul_template_render.rb

@@ -30,10 +30,11 @@ module Consul
         @last_result = File.read(output_file) if File.exist? output_file
         @template = load_template
         @params = params
+        @was_rendered_once = false
       end
 
-      def render(tpl = @template)
-        @template_manager.render(tpl, template_file, params)
+      def render(tpl = @template, current_template_info: _build_default_template_info)
+        @template_manager.render(tpl, template_file, params, current_template_info: current_template_info)
       end
 
       def run
@@ -50,17 +51,28 @@ module Consul
       end
 
       # Will throw Consul::Async::InvalidTemplateException if template invalid
-      def update_template(new_template)
+      def update_template(new_template, current_template_info)
         return false unless new_template != @template
         # We render to ensure the template is valid
-        render(new_template)
+        render(new_template, current_template_info)
         @template = new_template.freeze
         true
       end
 
+      def _build_default_template_info
+        {
+          'destination'       => @output_file,
+          'source_root'       => template_file.freeze,
+          'source'            => template_file.freeze,
+          'was_rendered_once' => @was_rendered_once
+        }
+      end
+
       def write
-        success, modified, last_res = @template_manager.write(@output_file, @template, @last_result, template_file, params)
+        current_template_info = _build_default_template_info
+        success, modified, last_res = @template_manager.write(@output_file, @template, @last_result, template_file, params, current_template_info: current_template_info)
         @last_result = last_res if last_res
+        @was_rendered_once = success unless @was_rendered_once
         [success, modified, @last_result]
       end
 
@@ -68,8 +80,11 @@ module Consul
         new_time = File.ctime(template_file)
         if template_file_ctime != new_time
           begin
+            current_template_info = {}
+            current_template_info.!merge(current_template_info)
+            current_template_info['ready'] = false
             @template_file_ctime = new_time
-            return update_template(load_template)
+            return update_template(load_template, current_template_info: current_template_info)
           rescue Consul::Async::InvalidTemplateException => e
             STDERR.puts "****\n[ERROR] HOT Reload of template #{template_file} did fail due to:\n #{e}\n****\n"
             raise e unless hot_reload_failure == 'keep'

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.7.0'.freeze
+    VERSION = '1.8.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-07 00:00:00.000000000 Z
+date: 2018-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request