hiera-eyaml 3.2.1 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67081f4016df05d739c387a5565632e3af0afa51367b505f3552b6c008a47c93
-  data.tar.gz: 573dfd56dc711d1b4722a67fc42a558c50eb38f43d56d3fccb79fe0d21d2a766
+  metadata.gz: 5bfbd5d31fef9569be60fa1914e921a042203d41c83925cb908173d74963df05
+  data.tar.gz: f93f91ef3fa2c34cef964e7e5b5a3b64dde0e1cc2ddb4ad06a0ea94b251bbf4e
 SHA512:
-  metadata.gz: 40e0c1fa73fe82f1b563580d0b4cdf26f402e1c9ee4d7c0b023ed9ad1941ced96f60dbb6e26fbefe3dce99a0b1c0e2816efbec09263b57c9ff5589d727353434
-  data.tar.gz: 86313762de24804bde617a78f865f3686e1d5ef0f011b4e5e786f0ec7401c9caac0702fb67ca332ab107b6f81dc0c674bea9ff268bab7f985c582a8ad21c0ad9
+  metadata.gz: e060aeb86e2f48506413629c9664441c4d1b0fa9862be7c7136e414df7e015a477a399b0453893b2b68d92751b6a2893cf5bbb898fdd6aea0d18b91611678761
+  data.tar.gz: de656da85d672bdc7b950c21663140cba2eb5c980abdeed0e7f44961f881ac5193c5e394c5e202b5a32dc78086b0e40bda73ada9b6615add4a7640c717934ee9

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file.
 
+## [v3.2.2](https://github.com/voxpupuli/hiera-eyaml/tree/v3.2.2) (2021-05-03)
+
+[Full Changelog](https://github.com/voxpupuli/hiera-eyaml/compare/v3.2.1...v3.2.2)
+
+**Fixed bugs:**
+
+- Using `3.2.1` for editing an eyaml created with `3.2.0` will mess up formatting [\#318](https://github.com/voxpupuli/hiera-eyaml/issues/318)
+- Fix block formatting when editing [\#319](https://github.com/voxpupuli/hiera-eyaml/pull/319) ([kenyon](https://github.com/kenyon))
+
+**Closed issues:**
+
+- Concerns about the encrypted? method [\#316](https://github.com/voxpupuli/hiera-eyaml/issues/316)
+
 ## [v3.2.1](https://github.com/voxpupuli/hiera-eyaml/tree/v3.2.1) (2021-02-16)
 
 [Full Changelog](https://github.com/voxpupuli/hiera-eyaml/compare/v3.2.0...v3.2.1)

data/Gemfile

@@ -8,7 +8,7 @@ group :development do
   gem "rspec-expectations", '~> 3.1.0'
   gem "hiera-eyaml-plaintext"
   gem "puppet", ENV['PUPPET_VERSION'] || '>= 7'
-  gem 'github_changelog_generator', :require => false, :git => 'https://github.com/voxpupuli/github-changelog-generator', :branch => 'voxpupuli_essential_fixes'
+  gem 'github_changelog_generator'
   gem "activesupport"
 end
 

data/lib/hiera/backend/eyaml.rb

@@ -2,7 +2,7 @@ class Hiera
   module Backend
     module Eyaml
 
-      VERSION = "3.2.1"
+      VERSION = "3.2.2"
       DESCRIPTION = "Hiera-eyaml is a backend for Hiera which provides OpenSSL encryption/decryption for Hiera properties"
 
       class RecoverableError < StandardError

data/lib/hiera/backend/eyaml/parser/encrypted_tokens.rb

@@ -4,34 +4,36 @@ require 'hiera/backend/eyaml/encryptor'
 require 'hiera/backend/eyaml'
 require 'base64'
 
-
 class Hiera
   module Backend
     module Eyaml
       module Parser
         class EncToken < Token
-          @@tokens_map = Hash.new()
+          @@tokens_map = {}
           @@encrypt_unchanged = true
           attr_reader :format, :cipher, :encryptor, :indentation, :plain_text, :id
+
           def self.encrypted_value(format, encryption_scheme, cipher, match, indentation = '')
             decryptor = Encryptor.find encryption_scheme
-            plain_text = decryptor.decrypt( decryptor.decode cipher )
+            plain_text = decryptor.decrypt(decryptor.decode(cipher))
             EncToken.new(format, plain_text, decryptor, cipher, match, indentation)
           end
+
           def self.decrypted_value(format, plain_text, encryption_scheme, match, id, indentation = '')
             encryptor = Encryptor.find encryption_scheme
-            cipher = encryptor.encode( encryptor.encrypt plain_text )
-            id_number = id.nil? ? nil : id.gsub(/\(|\)/, "").to_i
+            cipher = encryptor.encode(encryptor.encrypt(plain_text))
+            id_number = id.nil? ? nil : id.gsub(/\(|\)/, '').to_i
             EncToken.new(format, plain_text, encryptor, cipher, match, indentation, id_number)
           end
+
           def self.plain_text_value(format, plain_text, encryption_scheme, match, id, indentation = '')
             encryptor = Encryptor.find encryption_scheme
-            id_number = id.gsub(/\(|\)/,"").to_i unless id.nil?
-            EncToken.new(format, plain_text, encryptor, "", match, indentation, id_number)
+            id_number = id.gsub(/\(|\)/, '').to_i unless id.nil?
+            EncToken.new(format, plain_text, encryptor, '', match, indentation, id_number)
           end
 
           def self.tokens_map
-            return @@tokens_map
+            @@tokens_map
           end
 
           def self.set_encrypt_unchanged(encrypt_unchanged)
@@ -39,12 +41,12 @@ class Hiera
           end
 
           def self.encrypt_unchanged
-            return @@encrypt_unchanged
+            @@encrypt_unchanged
           end
 
           def initialize(format, plain_text, encryptor, cipher, match = '', indentation = '', id = nil)
             @format = format
-            @plain_text = Utils.convert_to_utf_8( plain_text )
+            @plain_text = Utils.convert_to_utf_8(plain_text)
             @encryptor = encryptor
             @cipher = cipher
             @indentation = indentation
@@ -52,65 +54,64 @@ class Hiera
             super(match)
           end
 
-          def to_encrypted(args={})
+          def to_encrypted(args = {})
             label = args[:label]
             label_string = label.nil? ? '' : "#{label}: "
             format = args[:format].nil? ? @format : args[:format]
             encryption_method = args[:change_encryption]
-            if encryption_method != nil
+            unless encryption_method.nil?
               @encryptor = Encryptor.find encryption_method
               @cipher = Base64.strict_encode64(@encryptor.encrypt(@plain_text))
             end
             case format
-              when :block
-                chevron = (args[:use_chevron].nil? || args[:use_chevron]) ? ">\n" : ''
-                "#{label_string}#{chevron}" + @indentation + "ENC[#{@encryptor.tag},#{@cipher}]".scan(/.{1,60}/).join("\n" + @indentation)
-              when :string
-                ciphertext = @cipher.gsub(/[\n\r]/, "")
-                "#{label_string}ENC[#{@encryptor.tag},#{ciphertext}]"
-              else
-                raise "#{@format} is not a valid format"
+            when :block
+              @cipher = @cipher.gsub(/\s/, '')
+              chevron = args[:use_chevron].nil? || args[:use_chevron] ? ">\n" : ''
+              "#{label_string}#{chevron}" + @indentation + "ENC[#{@encryptor.tag},#{@cipher}]".scan(/.{1,60}/).join("\n" + @indentation)
+            when :string
+              ciphertext = @cipher.gsub(/[\n\r]/, '')
+              "#{label_string}ENC[#{@encryptor.tag},#{ciphertext}]"
+            else
+              raise "#{@format} is not a valid format"
             end
           end
 
-          def to_decrypted(args={})
+          def to_decrypted(args = {})
             label = args[:label]
             label_string = label.nil? ? '' : "#{label}: "
             format = args[:format].nil? ? @format : args[:format]
             index = args[:index].nil? ? '' : "(#{args[:index]})"
-            if @@encrypt_unchanged == false
-              EncToken.tokens_map[index] = @plain_text
-            end
+            EncToken.tokens_map[index] = @plain_text if @@encrypt_unchanged == false
 
             case format
-              when :block
-                chevron = (args[:use_chevron].nil? || args[:use_chevron]) ? ">\n" : ''
-                "#{label_string}#{chevron}" + indentation + "DEC#{index}::#{@encryptor.tag}[" + @plain_text + "]!"
-              when :string
-                "#{label_string}DEC#{index}::#{@encryptor.tag}[" + @plain_text + "]!"
-              else
-                raise "#{@format} is not a valid format"
+            when :block
+              chevron = args[:use_chevron].nil? || args[:use_chevron] ? ">\n" : ''
+              "#{label_string}#{chevron}" + indentation + "DEC#{index}::#{@encryptor.tag}[" + @plain_text + ']!'
+            when :string
+              "#{label_string}DEC#{index}::#{@encryptor.tag}[" + @plain_text + ']!'
+            else
+              raise "#{@format} is not a valid format"
             end
           end
 
           def to_plain_text
             @plain_text
           end
-
         end
 
         class EncTokenType < TokenType
           def create_enc_token(match, type, enc_comma, cipher, indentation = '')
-            encryption_scheme = enc_comma.nil? ? Eyaml.default_encryption_scheme : enc_comma.split(",").first
+            encryption_scheme = enc_comma.nil? ? Eyaml.default_encryption_scheme : enc_comma.split(',').first
             EncToken.encrypted_value(type, encryption_scheme, cipher, match, indentation)
           end
         end
 
         class EncHieraTokenType < EncTokenType
           def initialize
-            @regex = /ENC\[(\w+,)?([a-zA-Z0-9\+\/ =\n]+?)\]/
-            @string_token_type = EncStringTokenType.new()
+            @regex = %r{ENC\[(\w+,)?([a-zA-Z0-9+/ =\n]+?)\]}
+            @string_token_type = EncStringTokenType.new
           end
+
           def create_token(string)
             @string_token_type.create_token(string.gsub(/\s/, ''))
           end
@@ -118,58 +119,55 @@ class Hiera
 
         class EncStringTokenType < EncTokenType
           def initialize
-            @regex = /ENC\[(\w+,)?([a-zA-Z0-9\+\/=]+?)\]/
+            @regex = %r{ENC\[(\w+,)?([a-zA-Z0-9+/=]+?)\]}
           end
+
           def create_token(string)
             md = @regex.match(string)
-            self.create_enc_token(string, :string, md[1], md[2])
+            create_enc_token(string, :string, md[1], md[2])
           end
         end
 
         class EncBlockTokenType < EncTokenType
           def initialize
-            @regex = />\n(\s*)ENC\[(\w+,)?([a-zA-Z0-9\+\/=\s]+?)\]/
+            @regex = %r{>\n(\s*)ENC\[(\w+,)?([a-zA-Z0-9+/=\s]+?)\]}
           end
+
           def create_token(string)
             md = @regex.match(string)
-            self.create_enc_token(string, :block, md[2], md[3], md[1])
+            create_enc_token(string, :block, md[2], md[3], md[1])
           end
         end
 
         class DecStringTokenType < TokenType
           def initialize
-            @regex = /DEC(\(\d+\))?::(\w+)\[(.+?)\]\!/m
+            @regex = /DEC(\(\d+\))?::(\w+)\[(.+?)\]!/m
           end
+
           def create_token(string)
             md = @regex.match(string)
-            if (EncToken.encrypt_unchanged == false)
-              unless md[1].nil?
-                if md[3] == EncToken.tokens_map[md[1]]
-                  return EncToken.plain_text_value(:string, md[3], md[2], string, md[1])
-                end
-              end
+            if EncToken.encrypt_unchanged == false && !md[1].nil? && (md[3] == EncToken.tokens_map[md[1]])
+              return EncToken.plain_text_value(:string, md[3], md[2], string, md[1])
             end
+
             EncToken.decrypted_value(:string, md[3], md[2], string, md[1])
           end
         end
 
         class DecBlockTokenType < TokenType
           def initialize
-            @regex = />\n(\s*)DEC(\(\d+\))?::(\w+)\[(.+?)\]\!/m
+            @regex = />\n(\s*)DEC(\(\d+\))?::(\w+)\[(.+?)\]!/m
           end
+
           def create_token(string)
             md = @regex.match(string)
-            if (EncToken.encrypt_unchanged == false)
-              unless md[2].nil?
-                if md[4] == EncToken.tokens_map[md[2]]
-                  return EncToken.plain_text_value(:string, md[4], md[3], string, md[2])
-                end
-              end
+            if EncToken.encrypt_unchanged == false && !md[2].nil? && (md[4] == EncToken.tokens_map[md[2]])
+              return EncToken.plain_text_value(:string, md[4], md[3], string, md[2])
             end
+
             EncToken.decrypted_value(:block, md[4], md[3], string, md[2], md[1])
           end
         end
-
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hiera-eyaml
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.2
 platform: ruby
 authors:
 - Tom Poulton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optimist
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: OpenSSL Encryption backend for Hiera