consult 0.11.0 → 1.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceefd393d6806ded58ba8e26053b884ccb16be5621cfed34143b1117c621da40
-  data.tar.gz: a5b86a629c6c01295dc89504cc7bf37b60cba8b821df29991fe1ad2ea41d9af6
+  metadata.gz: 1c7a54f7fb838f2f50a3553e2f798b75d569cf227c4c9d927d2185d4b597f882
+  data.tar.gz: be503dd900d460f14d8ae2ecaddd6eec05193859b2668d32762dd62e3e2f4cb1
 SHA512:
-  metadata.gz: 784828276c69a2f83f34a2169738f6053f4c035a3fe3b8a4b3925fed3dcb90f2a364d1e02032a1020f6e35cbbedee3eab4c833b444868d9fb9b9df2670a5df79
-  data.tar.gz: 1dc1fcb576c04a9a56ebd02d8af93f3e5ecf2bdf63037918cd915e7475b8bef00d901d504428dd8d8d1aba9b99c66dd020830465288d69df58ccfaa1a780f910
+  metadata.gz: f736a61ae78df99d70d778ec0a61bbaf6b702cc2e7d7b5e10f4a4c40682dd21cb72975cb49d6db28b502334b3027c793b17caa2b3a818f20fb05e52389a84a55
+  data.tar.gz: e786886e41c2a6c81b169c4d781465e422bae03b059b65dd6b156c8d30c2530c773157d752a150d569e514a56e6ccfa05b537f498d9bcc8c1078bdb336109688

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 #### Unreleased
 
+#### 1.0.0
+
+* Stop with error when force rendering and no template is found
+* Remove non-functional short verbosity argument
+* Add `--version` option to show the version
+* Better logging for template rendering status, errors, and config (verbose mode)
+* Development: adjust require's to be able to run CLI from any folder
+* Enable defining vars at the env block level, rather than only on template blocks
+* Create directories for rendered files as needed
+* Add the `skip_missing_template` config for templates
+
 #### 0.11.0
 
 * Enable support for Ruby 3.1 ([#36](https://github.com/veracross/consult/pull/36))

data/README.md

@@ -94,8 +94,22 @@ test:
     secrets:
       path: config/templates/secrets.yml
       dest: config/secrets.yml
+      # vars can be defined on a per-template basis
+      vars:
+        test_specific_key: and_the_value
+
+    extra_test_config:
+      # normally there's an error for missing templates, but this can be allowed via config
+      skip_missing_template: true
+      # config files are also processed through ERB, so paths can be made dynamic
+      path: config/templates/<%= ENV['extra_test_file'] %>.yml
+      dest: config/extra_test_config.yml
 
 production:
+  # vars can be defined at the environment level, which are available to these templates
+  vars:
+    hello: world
+
   templates:
     # You can concatenate multiple files together
     my_config:

data/lib/consult/cli.rb

@@ -38,9 +38,14 @@ module Consult
           opts[:force_render] = arg
         end
 
-        o.on '-v', '--quiet', FalseClass, 'Silence output' do |arg|
+        o.on '--quiet', FalseClass, 'Silence output' do |arg|
           opts[:verbose] = arg
         end
+
+        o.on '--version', 'Show version' do
+          puts "Consult #{Consult::VERSION}"
+          exit 0
+        end
       end
 
       @parser.on_tail "-h", "--help", "Show help" do

data/lib/consult/template.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require 'consult/template_functions'
+require 'fileutils'
+require_relative 'template_functions'
+require_relative '../support/hash_extensions'
 
 module Consult
   class Template
@@ -17,16 +19,26 @@ module Consult
     end
 
     def render(save: true)
+      if contents.empty? && @config[:skip_missing_template]
+        return
+      end
+
       # Attempt to render
       renderer = ERB.new(contents, nil, '-')
       result = renderer.result(binding)
 
-      File.open(dest, 'wb') { |f| f << result } if save
-      puts "Consult: Rendered #{name}" if verbose?
+      puts "Consult: Rendering #{name}" + (save ? " to #{dest} ..." : "...") if verbose?
+
+      if save
+        FileUtils.mkdir_p(dest.dirname) unless dest.dirname.exist?
+        File.open(dest, 'wb') { |f| f << result }
+      end
+
       result
     rescue StandardError => e
       STDERR.puts "Error rendering template: #{name}"
       STDERR.puts e
+      STDERR.puts e.backtrace if verbose?
       nil
     end
 
@@ -39,7 +51,7 @@ module Consult
     end
 
     def vars
-      @config[:vars]
+      @config[:env_vars].to_h.deep_merge @config[:vars].to_h
     end
 
     def dest
@@ -68,20 +80,34 @@ module Consult
 
     # Concatenate all the source templates together, in the order provided
     def contents
-      ordered_locations.map do |location|
+      @_contents ||= ordered_locations.map do |location|
         location.to_s.start_with?('consul') ? consul_contents(location) : disk_contents(location)
-      end.join
+      end.compact.join
     end
 
     def consul_contents(location)
       [@config[location]].compact.flatten.map do |key|
-        Diplomat::Kv.get(key, options: {}, not_found: :return, found: :return).force_encoding 'utf-8'
+        Diplomat::Kv.get(key, {}, :reject, :return).force_encoding 'utf-8'
+      rescue Diplomat::KeyNotFound
+        if @config[:skip_missing_template]
+          STDERR.puts "Consult: Skipping missing template: #{name}"
+          next
+        end
+
+        raise
       end.join
     end
 
     def disk_contents(location)
       [public_send(location)].compact.flatten.map do |file_path|
         File.read file_path, encoding: 'utf-8'
+      rescue Errno::ENOENT
+        if @config[:skip_missing_template]
+          STDERR.puts "Consult: Skipping missing template: #{name}"
+          next
+        end
+
+        raise
       end.join
     end
   end

data/lib/consult/version.rb

@@ -1,3 +1,3 @@
 module Consult
-  VERSION = '0.11.0'
+  VERSION = '1.0.0.pre1'
 end

data/lib/consult.rb

@@ -6,9 +6,9 @@ require 'erb'
 require 'vault'
 require 'diplomat'
 
-require 'consult/version'
-require 'consult/utilities'
-require 'consult/template'
+require_relative './consult/version'
+require_relative './consult/utilities'
+require_relative './consult/template'
 require_relative './support/hash_extensions'
 
 module Consult
@@ -24,21 +24,32 @@ module Consult
       root directory: config_dir
       yaml = root.join('config', 'consult.yml')
 
+      if verbose
+        puts "Consult: Loading config from #{yaml}"
+      end
+
       @all_config = if yaml.exist?
         if Gem::Version.new(YAML::VERSION) < Gem::Version.new('4.0')
           YAML.safe_load(ERB.new(yaml.read).result, [], [], true, symbolize_names: true).to_h
         else
           YAML.safe_load(ERB.new(yaml.read).result, aliases: true, symbolize_names: true).to_h
         end
+      else
+        STDERR.puts "Consult: No config file found at #{root} -> #{yaml}"
       end
 
       @all_config ||= {}
 
       @config = @all_config[:shared].to_h.deep_merge @all_config[env&.to_sym].to_h
-      @templates = @config[:templates]&.map { |name, config| Template.new(name, config.merge(verbose: verbose)) } || []
+      @templates = @config[:templates]&.map { |name, config| Template.new(name, config.merge(verbose: verbose).merge(env_vars: @config[:vars])) } || []
 
       @force_render = force_render
 
+      if @templates.empty? && @force_render
+        STDERR.puts "Consult: No template was found for env #{env.inspect} with forced rendering (re-run with `--no-force` if this is acceptable)"
+        exit 1
+      end
+
       configure_consul
       configure_vault
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consult
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.0.0.pre1
 platform: ruby
 authors:
 - Jeff Fraser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-19 00:00:00.000000000 Z
+date: 2023-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diplomat
@@ -205,9 +205,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.6
 signing_key: