consul-templaterb 1.20.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdc12c65083f1f666615eec05c7b092839f28e05ad855a745271114305719a88
-  data.tar.gz: c0d46a14a91d4622ba7819a1d0e6bda38410f9b3fde5c1c89fa7d141dd837f36
+  metadata.gz: 3785f26a91750c80a99a7874db8987e5bfb0bda73b3e6e7a2f959fe6ecdb7017
+  data.tar.gz: 5003cbc12c820ed815f5f3a691f98568d44637b39e08ac56cc4c700bbd9a49cb
 SHA512:
-  metadata.gz: a78247bdaba4504bf6486faa24690f85fa86007ce49704def7f7dd123f2ea229c6b325c1c8e83c17d843f3c9f45a1a5708bbc48976a2bcb1b54950c07e74f3e8
-  data.tar.gz: 44c4afb432414e4bca30e52617924e76c500bf9c5e289ba42224853f13d2ad13189d659dec310347ac3ad9e152e0fbedc8daa47a8b72db8df0014f3bbe4968cd
+  metadata.gz: 63646b061bc898e14de0c52c6880f8d119ca39db3a09cd35a61ccb0de80ecfff8310a0b3993c9abb5b11426a9cf79c9a69e52fa533882892b90b323bb2272873
+  data.tar.gz: 21e214c1c701dfd64629ea20c660f7960d4f6433c730fbf403014ea133f8bd0fbc9dc78a654ecaad82d4c7aded172cc2c0dd61202624ef502ca47b647c180e26

data/.gitignore

@@ -12,6 +12,7 @@
 /samples/**/*.html
 /samples/**/*.txt
 /samples/**/*.cfg
+samples/consul-ui/decorators.js
 /samples/hosts
 /samples/hosts_per_services
 /samples/prometheus_consul_coordinates

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## (UNRELEASED)
 
+NEW FEATURES:
+
+## 1.21.0 (November 21, 2019)
+
+* added function `templates` to list all templates being rendered
+* added support for JS decorators in consul-ui (thanks to @Thib17)
+
 ## 1.20.0 (October 16, 2019)
 
 IMPROVEMENTS:

data/TemplateAPI.md

@@ -649,3 +649,26 @@ I am the file template_info.erb included from template include.erb rendered as d
 
 </div>
 </details>
+
+## templates
+
+It returns list of templates evaluated by this instance of consul-templaterb.
+Information returned is an array of elements where elements are `[template_name, template_destination, args]`.
+
+<details><summary>Example</summary>
+<div class="samples">
+
+### Display templates info
+
+```erb
+Here are templates rendered by consul-templaterb:
+<ul>
+<% templates.each do |template, destination, args| %>
+<li>I render <%= template %> with args <%= args.inspect %> and write the result to <%= destination %></li>
+<% end %>
+</ul>
+```
+
+</div>
+</details>
+

data/bin/consul-templaterb

@@ -175,7 +175,7 @@ optparse = OptionParser.new do |opts|
     sig_term = cur_sig_term
     consul_engine.add_template_callback do |all_ready, template_manager, results|
       if all_ready
-        modified = results.reduce(false) { |a, e| a || e.modified }
+        modified = results.any?(&:modified)
         if @programs[cmd].nil?
           STDERR.puts "[EXEC] Starting process: #{cmd}... on_reload=#{sig_reload ? sig_reload : 'NONE'} on_term=#{sig_term}"
           @programs[cmd] = Consul::Async::ProcessHandler.new(cmd, sig_reload: sig_reload, sig_term: sig_term)
@@ -290,7 +290,6 @@ EM.epoll
 
 consul_conf = Consul::Async::ConsulConfiguration.new(options[:consul])
 vault_conf = Consul::Async::VaultConfiguration.new(options[:vault])
-template_manager = Consul::Async::EndPointsManager.new(consul_conf, vault_conf, options[:erb][:trim_mode])
 
 ARGV.each do |tpl|
   dest = compute_default_output(tpl)
@@ -298,6 +297,8 @@ ARGV.each do |tpl|
   consul_engine.add_template(tpl, dest)
 end
 
+template_manager = Consul::Async::EndPointsManager.new(consul_conf, vault_conf, consul_engine.templates, options[:erb][:trim_mode])
+
 Signal.trap('USR1', 'IGNORE') unless Gem.win_platform?
 # Ensure to kill child process if any
 ['EXIT'].each do |sig|

data/lib/consul/async/consul_template.rb

@@ -79,8 +79,8 @@ module Consul
     end
 
     class EndPointsManager
-      attr_reader :consul_conf, :vault_conf, :net_info, :start_time, :coordinate, :remote_resource
-      def initialize(consul_configuration, vault_configuration, trim_mode = nil)
+      attr_reader :consul_conf, :vault_conf, :net_info, :start_time, :coordinate, :remote_resource, :templates
+      def initialize(consul_configuration, vault_configuration, templates, trim_mode = nil)
         @consul_conf = consul_configuration
         @vault_conf = vault_configuration
         @trim_mode = trim_mode
@@ -95,6 +95,7 @@ module Consul
           changes: 0,
           network_bytes: 0
         }
+        @templates = templates
         @context = {
           current_erb_path: nil,
           template_info: {

data/lib/consul/async/consul_template_engine.rb

@@ -10,7 +10,7 @@ require 'erb'
 module Consul
   module Async
     class ConsulTemplateEngine
-      attr_reader :template_manager, :hot_reload_failure, :template_frequency, :debug_memory, :result
+      attr_reader :template_manager, :hot_reload_failure, :template_frequency, :debug_memory, :result, :templates
       attr_writer :hot_reload_failure, :template_frequency, :debug_memory
       def initialize
         @templates = []
@@ -45,7 +45,7 @@ module Consul
       # Run templating engine once
       def do_run(template_manager, template_renders)
         results = template_renders.map(&:run)
-        all_ready = results.reduce(true) { |a, e| a && e.ready? }
+        all_ready = results.all?(&:ready?)
         if !@all_templates_rendered && all_ready
           @all_templates_rendered = true
           cur_time = Time.now

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.20.0'.freeze
+    VERSION = '1.21.0'.freeze
   end
 end

data/samples/all_templates.erb

@@ -0,0 +1,3 @@
+<% templates.each do |erb_file, output_file, args| %>
+  <%= erb_file %> will be rendered as <%= output_file %>
+<% end %>

data/samples/consul-ui/consul-services-ui.html.erb

@@ -64,6 +64,7 @@
   <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
   <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js" integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"></script>
   <script src="js/utils.js"></script>
+  <script src="decorators.js"></script>
   <script src="js/types.js"></script>
   <script src="js/service.js"></script>
   <script type="text/javascript">

data/samples/consul-ui/decorators.js.erb

@@ -0,0 +1,7 @@
+function serviceInstanceDecorator(instance, element) {
+    return element;
+}
+
+function serviceMetaDecorator(key, value) {
+    return  document.createTextNode(value);
+}

data/samples/consul-ui/js/service.js

@@ -313,7 +313,7 @@ class ServiceMainSelector extends MainSelector {
         element.appendChild(checksStatusGenerator(instance, instance.name));
         element.setAttribute("status", state);
 
-        return element;
+        return serviceInstanceDecorator(instance, element);
     }
 
     getStatus(instance) {

data/samples/consul-ui/js/utils.js

@@ -189,7 +189,7 @@ function serviceMetaGenerator(instanceMeta) {
             container.appendChild(metaH);
             var metaVH = document.createElement('dd');
             metaVH.className = 'col-sm-8 lookup';
-            metaVH.appendChild(document.createTextNode(instanceMeta[meta]));
+            metaVH.appendChild(serviceMetaDecorator(meta, instanceMeta[meta]));
             container.appendChild(metaVH);
         }
     }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 1.21.0
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-16 00:00:00.000000000 Z
+date: 2019-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -192,6 +192,7 @@ files:
 - lib/consul/async/vault_endpoint.rb
 - lib/consul/async/version.rb
 - samples/all_services.txt.erb
+- samples/all_templates.erb
 - samples/consul-ui/README.md
 - samples/consul-ui/common/header.html.erb
 - samples/consul-ui/consul-keys-ui.html.erb
@@ -202,6 +203,7 @@ files:
 - samples/consul-ui/consul_nodes.json.erb
 - samples/consul-ui/consul_services.json.erb
 - samples/consul-ui/css/style.css
+- samples/consul-ui/decorators.js.erb
 - samples/consul-ui/images/favicon.png
 - samples/consul-ui/js/keys.js
 - samples/consul-ui/js/nodes.js