consult 1.0.0.pre2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f20892ac9536d4c435718496f6e4535207b47fa0e149993bc657b2ebfdf7491
-  data.tar.gz: 46ec2012537e03f62e9a21717d521f6660e9dddbcb3f5c83944dac5ba900fec1
+  metadata.gz: 76b94b56a94ff354ad82df46b823adc23c911b4acc377aff3232271dfaeb2b4e
+  data.tar.gz: ab8885c93afd32eb6aed12d1fd8fe3102a419efc8ae1a4dac483ae41a003359b
 SHA512:
-  metadata.gz: d4ea6a78c336c44172b03af8606bc6f783b6a2372b06db9d35d0c95e3090e1abbf75ffd0345d308ef38c25d4b126beda6f56d62fe1b17ac792c5740f0db80010
-  data.tar.gz: d7b4f886c8685df462f0af2404a6cc3513e09f17ccb7809ab81826e8b393fcd29632d73c86e0983eb66d49e8fde1d4c86aad7e04300083c3ece5cc99fc3b45ed
+  metadata.gz: 1c55a14f4e4ba227de03fa508907be7edd1e5912602794d8520192ed70d05cdbb7bd2feeae0b73ef1ce33b273bf7c40b8b5e5fd6074bf98937b702127e5addd9
+  data.tar.gz: 9431a33406b7b535be98ba6ef18694370acd0eea21e45e0f9ea0066a356abdfc1a6e59bd137357004a8e7917581e862ce97c299ad411a0b4d4ac5fb631849127

data/.github/workflows/ci.yml

@@ -0,0 +1,75 @@
+name: ci
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version:
+          - '2.5'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+
+    name: test (ruby ${{ matrix.ruby-version }})
+
+    services:
+      consul:
+        image: consul:1.3.0
+        ports:
+          - "8500:8500"
+
+      vault:
+        image: vault:0.11.3
+        ports:
+          - "8200:8200"
+        env:
+          VAULT_DEV_ROOT_TOKEN_ID: 94e1a9ed-5d72-5677-27ab-ebc485cca368
+
+    permissions:
+      contents: read
+      checks: write
+
+    env:
+      LATEST_RUBY_VERSION: '3.3'
+      BUNDLE_ONLY: default test
+      CI: true
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - run: ./spec/support/populate_consul.sh
+
+      - run: bundle exec rspec
+
+      - uses: joshmfrankel/simplecov-check-action@main
+        if: matrix.ruby-version == env.LATEST_RUBY_VERSION
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          check_job_name: "SimpleCov (ruby ${{ matrix.ruby-version }})"
+          on_fail_status: neutral
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: coverage-ruby-${{ matrix.ruby-version }}-${{ github.head_ref || github.ref_name }}-${{ github.sha }}
+          path: |
+            coverage/
+          if-no-files-found: ignore

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
+--format progress
 --color
 --require spec_helper

data/CHANGELOG.md

@@ -10,6 +10,7 @@
 * 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
+* Expand support to from Ruby 2.5 to Ruby 3.3
 
 #### 0.11.0
 

data/CODEOWNERS

@@ -0,0 +1 @@
+* @veracross/product-tech-leads

data/Dockerfile

@@ -0,0 +1,13 @@
+FROM ruby:3.1
+
+WORKDIR /consult
+
+COPY Gemfile consult.gemspec ./
+COPY lib/consult/version.rb ./lib/consult/version.rb
+RUN bundle package --all --no-install
+RUN bundle install
+
+COPY . .
+
+ENTRYPOINT ["ruby", "bin/consult"]
+CMD ["--help"]

data/Gemfile

@@ -4,3 +4,14 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in consult.gemspec
 gemspec
+
+group :development, :test do
+  gem 'bundler'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'pry-byebug'
+  gem 'rake'
+  gem 'rspec', '~> 3.0'
+  gem 'rspec_junit_formatter', '~> 0.4.1'
+  gem 'simplecov', '~> 0.22'
+end

data/README.md

@@ -48,6 +48,14 @@ Consult: Rendered my_config
 Consult: Rendered secrets
 ```
 
+The Consult CLI is also available via Docker:
+
+```bash
+$ docker run --rm -v .:/app veracross/consult:latest --directory /app
+```
+
+If your templates reference `localhost` (such as the templates in the `spec` directory of this repo), add `--net host` to the command.
+
 ### Configuration
 
 ```yaml

data/consult.gemspec

@@ -26,13 +26,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'diplomat', '~> 2.6'
   spec.add_dependency 'vault', '>= 0.10.0', '< 1.0.0'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'guard'
-  spec.add_development_dependency 'guard-rspec'
-  spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4.1'
-  spec.add_development_dependency 'simplecov', '~> 0.16.1'
 end

data/lib/consult/template.rb

@@ -24,7 +24,11 @@ module Consult
       end
 
       # Attempt to render
-      renderer = ERB.new(contents, nil, '-')
+      renderer = if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7.0')
+        ERB.new(contents, trim_mode: '-')
+      else
+        ERB.new(contents, nil, '-')
+      end
       result = renderer.result(binding)
 
       puts "Consult: Rendering #{name}" + (save ? " to #{dest}" : "...") if verbose?

data/lib/consult/version.rb

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

data/lib/consult.rb

@@ -5,6 +5,8 @@ require 'yaml'
 require 'erb'
 require 'vault'
 require 'diplomat'
+# https://github.com/WeAreFarmGeek/diplomat/issues/26
+require 'ostruct'
 
 require_relative './consult/version'
 require_relative './consult/utilities'
@@ -41,7 +43,7 @@ module Consult
       @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).merge(env_vars: @config[:vars])) } || []
+      @templates = @config[:templates]&.map { |name, config| Template.new(name, config.merge({verbose: verbose, env_vars: @config[:vars]})) } || []
 
       @force_render = force_render
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consult
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre2
+  version: 1.0.0
 platform: ruby
 authors:
 - Jeff Fraser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2025-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diplomat
@@ -44,118 +44,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.1
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.1
 description: Manage consul/vault backed template files in Ruby.
 email:
 - jeff.fraser@veracross.com
@@ -164,12 +52,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
+- CODEOWNERS
+- Dockerfile
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -205,11 +95,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Manage consul/vault backed template files in Ruby.

data/.circleci/config.yml

@@ -1,79 +0,0 @@
-version: 2.1
-
-jobs:
-  test:
-    parameters:
-      ruby_version:
-        type: string
-
-    docker:
-      - image: cimg/ruby:<< parameters.ruby_version >>
-      - image: consul:1.3.0
-      - image: vault:0.11.3
-        environment:
-          - VAULT_DEV_ROOT_TOKEN_ID=94e1a9ed-5d72-5677-27ab-ebc485cca368
-          # - SKIP_SETCAP=skip
-        # cap_add:
-        #   - IPC_LOCK
-
-    working_directory: ~/repo
-
-    steps:
-      - checkout
-
-      - restore_cache:
-          name: restore gem cache
-          keys:
-            - v1-bundle-<< parameters.ruby_version >>-{{ .Branch }}-{{ checksum "consult.gemspec" }}
-            - v1-bundle-<< parameters.ruby_version >>-{{ .Branch }}-
-            - v1-bundle-<< parameters.ruby_version >>-
-
-      - run:
-          name: install dependencies
-          command: |
-            bundle check --path ./vendor/bundle || bundle install --jobs=3 --retry=3 --path vendor/bundle
-            bundle clean
-
-      - save_cache:
-          name: save gem cache
-          paths:
-            - ./vendor/bundle
-          key: v1-bundle-<< parameters.ruby_version >>-{{ .Branch }}-{{ checksum "consult.gemspec" }}
-
-      - run:
-          name: setup fixture data
-          command: |
-            ./spec/support/populate_consul.sh
-
-      - run:
-          name: run tests
-          command: |
-            mkdir /tmp/test-results
-
-            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
-              circleci tests split --split-by=timings)"
-
-            bundle exec rspec \
-              --format progress \
-              --format RspecJunitFormatter \
-              --out /tmp/test-results/rspec.xml \
-              --format progress \
-              $TEST_FILES
-
-      - store_test_results:
-          path: /tmp/test-results
-
-      - store_artifacts:
-          path: ./coverage
-          destination: coverage
-
-workflows:
-  test_supported_ruby_versions:
-    jobs:
-      - test:
-          matrix:
-            parameters:
-              ruby_version:
-                - '2.5'
-                - '2.7'
-                - '3.1'