hiera-eyaml 3.3.0 → 4.0.0

data/lib/hiera/backend/eyaml/utils.rb

@@ -6,64 +6,63 @@ class Hiera
   module Backend
     module Eyaml
       class Utils
-
-        def self.camelcase string
+        def self.camelcase(string)
           return string if string !~ /_/ && string =~ /[A-Z]+.*/
-          string.split('_').map{|e| e.capitalize}.join
+
+          string.split('_').map { |e| e.capitalize }.join
         end
 
-        def self.snakecase string
-          return string if string !~ /[A-Z]/
-          string.split(/(?=[A-Z])/).collect {|x| x.downcase}.join("_")
+        def self.snakecase(string)
+          return string unless /[A-Z]/.match?(string)
+
+          string.split(/(?=[A-Z])/).collect { |x| x.downcase }.join('_')
         end
 
-        def self.find_closest_class args
-          parent_class = args[ :parent_class ]
-          class_name = args[ :class_name ]
+        def self.find_closest_class(args)
+          parent_class = args[:parent_class]
+          class_name = args[:class_name]
           constants = parent_class.constants
           candidates = []
-          constants.each do | candidate |
+          constants.each do |candidate|
             candidates << candidate.to_s if candidate.to_s.downcase == class_name.downcase
           end
-          if candidates.count > 0
-            parent_class.const_get candidates.first
-          else
-            nil
-          end
+          return unless candidates.count > 0
+
+          parent_class.const_get candidates.first
         end
 
-        def self.require_dir classdir
-          num_class_hierarchy_levels = self.to_s.split("::").count - 1 
-          root_folder = File.dirname(__FILE__) + "/" + Array.new(num_class_hierarchy_levels).fill("..").join("/")
-          class_folder = root_folder + "/" + classdir
+        def self.require_dir(classdir)
+          num_class_hierarchy_levels = to_s.split('::').count - 1
+          root_folder = File.dirname(__FILE__) + '/' + Array.new(num_class_hierarchy_levels).fill('..').join('/')
+          class_folder = root_folder + '/' + classdir
           Dir[File.expand_path("#{class_folder}/*.rb")].uniq.each do |file|
             LoggingHelper.trace "Requiring file: #{file}"
             require file
           end
         end
 
-        def self.find_all_subclasses_of args
-          parent_class = args[ :parent_class ]
+        def self.find_all_subclasses_of(args)
+          parent_class = args[:parent_class]
           constants = parent_class.constants
           candidates = []
-          constants.each do | candidate |
-            candidates << candidate.to_s.split('::').last if parent_class.const_get(candidate).class.to_s == "Class"
+          constants.each do |candidate|
+            candidates << candidate.to_s.split('::').last if parent_class.const_get(candidate).instance_of?(::Class)
           end
           candidates
         end
 
         def self.hiera?
-          "hiera".eql? Eyaml::Options[:source]
+          'hiera'.eql? Eyaml::Options[:source]
         end
 
-        def self.convert_to_utf_8 string
+        def self.convert_to_utf_8(string)
           orig_encoding = string.encoding
           return string if orig_encoding == Encoding::UTF_8
 
-          return string.dup.force_encoding(Encoding::UTF_8)
-        rescue EncodingError => detail
+          string.dup.force_encoding(Encoding::UTF_8)
+        rescue EncodingError => e
           warn "Unable to encode to \"Encoding::UTF_8\" using the original \"#{orig_encoding}\""
-          return string
+          string
         end
       end
     end

data/lib/hiera/backend/eyaml.rb

@@ -1,14 +1,13 @@
 class Hiera
   module Backend
     module Eyaml
-
-      VERSION = "3.3.0"
-      DESCRIPTION = "Hiera-eyaml is a backend for Hiera which provides OpenSSL encryption/decryption for Hiera properties"
+      VERSION = '4.0.0'
+      DESCRIPTION = 'Hiera-eyaml is a backend for Hiera which provides OpenSSL encryption/decryption for Hiera properties'
 
       class RecoverableError < StandardError
       end
 
-      def self.subcommand= command
+      def self.subcommand=(command)
         @@subcommand = command
       end
 
@@ -16,16 +15,16 @@ class Hiera
         @@subcommand
       end
 
-      def self.default_encryption_scheme= new_encryption
+      def self.default_encryption_scheme=(new_encryption)
         @@default_encryption_scheme = new_encryption
       end
 
       def self.default_encryption_scheme
-        @@default_encryption_scheme ||= "PKCS7"
+        @@default_encryption_scheme ||= 'PKCS7'
         @@default_encryption_scheme
       end
 
-      def self.verbosity_level= new_verbosity_level
+      def self.verbosity_level=(new_verbosity_level)
         @@debug_level = new_verbosity_level
       end
 
@@ -34,14 +33,13 @@ class Hiera
         @@debug_level
       end
 
-      def self.subcommands= commands
+      def self.subcommands=(commands)
         @@subcommands = commands
       end
 
       def self.subcommands
         @@subcommands
       end
-
     end
   end
 end

data/lib/hiera/backend/eyaml_backend.rb

@@ -9,15 +9,14 @@ require 'yaml'
 class Hiera
   module Backend
     class Eyaml_backend
-
       attr_reader :extension
 
       def initialize(cache = nil)
-        debug("Hiera eYAML backend starting")
+        debug('Hiera eYAML backend starting')
 
         @decrypted_cache = {}
         @cache     = cache || Filecache.new
-        @extension = Config[:eyaml][:extension] || "eyaml"
+        @extension = Config[:eyaml][:extension] || 'eyaml'
       end
 
       def lookup(key, scope, order_override, resolution_type)
@@ -31,7 +30,7 @@ class Hiera
           debug("Looking for data source #{source}")
           eyaml_file = Backend.datafile(:eyaml, scope, source, extension) || next
 
-          next unless File.exists?(eyaml_file)
+          next unless File.exist?(eyaml_file)
 
           data = @cache.read(eyaml_file, Hash) do |data|
             YAML.load(data) || {}
@@ -54,20 +53,28 @@ class Hiera
           new_answer = parse_answer(data[key], scope)
           case resolution_type
           when :array
-            raise Exception, "Hiera type mismatch: expected Array and got #{new_answer.class}" unless new_answer.kind_of? Array or new_answer.kind_of? String
+            unless new_answer.is_a? Array or new_answer.is_a? String
+              raise Exception,
+                    "Hiera type mismatch: expected Array and got #{new_answer.class}"
+            end
+
             answer ||= []
             answer << new_answer
           when :hash
-            raise Exception, "Hiera type mismatch: expected Hash and got #{new_answer.class}" unless new_answer.kind_of? Hash
+            unless new_answer.is_a? Hash
+              raise Exception,
+                    "Hiera type mismatch: expected Hash and got #{new_answer.class}"
+            end
+
             answer ||= {}
-            answer = Backend.merge_answer(new_answer,answer)
+            answer = Backend.merge_answer(new_answer, answer)
           else
             answer = new_answer
             break
           end
         end
 
-        return answer
+        answer
       end
 
       private
@@ -78,19 +85,18 @@ class Hiera
 
       def decrypt(data)
         if encrypted?(data)
-          debug("Attempting to decrypt")
+          debug('Attempting to decrypt')
           begin
             parser = Eyaml::Parser::ParserFactory.hiera_backend_parser
             tokens = parser.parse(data)
-            decrypted = tokens.map{ |token| token.to_plain_text }
+            decrypted = tokens.map { |token| token.to_plain_text }
             plaintext = decrypted.join
           rescue OpenSSL::PKCS7::PKCS7Error => e
-            debug("Caught exception: #{e.class}, #{e.message}\n"\
+            debug("Caught exception: #{e.class}, #{e.message}\n" \
                   "#{e.backtrace.join("\n")}")
-            raise "Hiera-eyaml decryption failed, check the "\
-              "encrypted data matches the key you are using.\n"\
-              "Raw message from system: #{e.message}"
-
+            raise 'Hiera-eyaml decryption failed, check the ' \
+                  "encrypted data matches the key you are using.\n" \
+                  "Raw message from system: #{e.message}"
           end
           plaintext.chomp
         else
@@ -99,14 +105,14 @@ class Hiera
       end
 
       def encrypted?(data)
-        /.*ENC\[.*\]/ =~ data ? true : false
+        /.*ENC\[.*\]/.match?(data) ? true : false
       end
 
-      def parse_answer(data, scope, extra_data={})
+      def parse_answer(data, scope, extra_data = {})
         if data.is_a?(Numeric) or data.is_a?(TrueClass) or data.is_a?(FalseClass)
-          return data
+          data
         elsif data.is_a?(String)
-          return parse_string(data, scope, extra_data)
+          parse_string(data, scope, extra_data)
         elsif data.is_a?(Hash)
           answer = {}
           data.each_pair do |key, val|
@@ -114,14 +120,14 @@ class Hiera
             answer[interpolated_key] = parse_answer(val, scope, extra_data)
           end
 
-          return answer
+          answer
         elsif data.is_a?(Array)
           answer = []
           data.each do |item|
             answer << parse_answer(item, scope, extra_data)
           end
 
-          return answer
+          answer
         end
       end
 
@@ -132,18 +138,18 @@ class Hiera
           debug("Set option: #{key} = #{parsed_value}")
         end
 
-        Eyaml::Options[:source] = "hiera"
+        Eyaml::Options[:source] = 'hiera'
       end
 
-      def parse_string(data, scope, extra_data={})
+      def parse_string(data, scope, extra_data = {})
         if Eyaml::Options[:cache_decrypted]
-          if not @decrypted_cache.include?(data)
+          if @decrypted_cache.include?(data)
+            debug('Retrieving data from decrypted cache')
+            decrypted_data = @decrypted_cache[data]
+          else
             decrypted_data = decrypt(data)
-            debug("Adding data to decrypted cache")
+            debug('Adding data to decrypted cache')
             @decrypted_cache[data] = decrypted_data
-          else
-            debug("Retrieving data from decrypted cache")
-            decrypted_data = @decrypted_cache[data]
           end
         else
           decrypted_data = decrypt(data)

metadata

@@ -1,43 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: hiera-eyaml
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: optimist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 13.2.1
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: voxpupuli-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 description: Hiera backend for decrypting encrypted yaml properties
 email: voxpupuli@groups.io
 executables:
@@ -45,9 +93,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - Gemfile
 - HISTORY.md
@@ -85,8 +136,6 @@ files:
 - sublime_text/README.md
 - sublime_text/eyaml.sublime-package
 - sublime_text/eyaml.syntax_definition.json
-- tools/git_tag_release.rb
-- tools/regem.sh
 homepage: https://github.com/voxpupuli/hiera-eyaml/
 licenses:
 - MIT
@@ -99,7 +148,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '2.7'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4'
@@ -109,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: OpenSSL Encryption backend for Hiera

data/tools/git_tag_release.rb

@@ -1,98 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems'
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9')
-  $stderr.puts "This script requires Ruby >= 1.9"
-  exit 1
-end
-
-require 'open3'
-result = Open3.capture3('git rev-parse --show-toplevel')
-unless result[2].exitstatus == 0
-  $stderr.puts "You do not appear to be in a git repository. This script must be run from inside a git repository."
-  exit 2
-end
-filename = result[0].lines.first.chomp + '/CHANGES.md'
-unless File.exist?(filename)
-  $stderr.puts "CHANGES.md not found. Please ensure that CHANGES.md exists."
-  exit 3
-end
-contents = IO.read(filename)
-
-lines = contents.lines.drop(3).map(&:chomp).reject(&:empty?)
-versions = Hash.new
-currentversion = nil
-versions[nil] = []
-lines.each_with_index do |line, index|
-  if line =~ /\A-+\z/
-    versions[currentversion].pop
-    currentversion = lines[index-1]
-    versions[currentversion] = []
-  else
-    versions[currentversion] << line
-  end
-end
-versions.delete(nil)
-
-def prompt(*args)
-  print(*args)
-  gets.chomp
-end
-
-newest = versions.first[0]
-version = prompt "Version [#{newest}]: "
-version = newest if version.empty?
-
-unless versions[version]
-  $stderr.puts "Version #{version} is invalid. Valid versions are: #{versions.keys.join(', ')}"
-  exit 4
-end
-
-tagname = "v#{version}"
-
-
-
-result = Open3.capture3("git rev-parse #{tagname}")
-if result[2].exitstatus == 0
-  $stderr.puts "Tag #{tagname} already exists."
-  exit 5
-end
-
-commit = prompt "Commit: "
-
-result = Open3.capture3("git --no-pager log -1 #{commit} --format='%ci'")
-unless result[2].exitstatus == 0
-  $stderr.puts "Commit '#{commit}' is not valid."
-  exit result[2].exitstatus
-end
-commitdate = result[0].lines.first.chomp
-
-def word_wrap(line, width)
-  first_prefix = line.match(/([ -]*)/)[1]
-  prefix = ' ' * first_prefix.size
-  real_width = width - (prefix.size * 2)
-  line[prefix.size..-1].gsub(/(^)?(.{1,#{real_width}})(?: +|$)/) { |s| $1 ? "#{first_prefix}#{s}\n" : "#{prefix}#{s}\n" }
-end
-
-require 'tempfile'
-begin
-  tf = Tempfile.new('tag-message')
-  tf.puts "Version #{version} release"
-  tf.puts ""
-  tf.puts "Changes:"
-  versions[version].each do |line|
-    tf.puts word_wrap(line, 80)
-  end
-  tf.flush
-
-  result = Open3.capture3({'GIT_COMMITTER_DATE' => commitdate}, "git tag -a #{tagname} #{commit} -F #{tf.path}")
-  $stderr.puts result[1]
-  if result[2].exitstatus == 0
-    system "git --no-pager show #{tagname} --no-patch"
-    puts ""
-    puts "Tag created. Please push to GitHub with `git push origin #{tagname}`."
-  end
-  exit result[2].exitstatus
-ensure
-  tf.close!
-end

data/tools/regem.sh

@@ -1,11 +0,0 @@
-#!/bin/sh
-
-# ToDo: Remove as 'rake install' task will build and install the latest gem?
-
-gem uninstall hiera-eyaml --executables
-RAKE_OUT=`rake build`
-echo ${RAKE_OUT}
-VERSION=`echo ${RAKE_OUT} | awk '{print $2}'`
-echo Installing version: ${VERSION} ...
-gem install pkg/hiera-eyaml-${VERSION}.gem
-eyaml version