pdk 2.1.0 → 2.4.0

data/lib/pdk/util/changelog_generator.rb

@@ -1,124 +1,137 @@
-require 'pdk'
-
-module PDK
-  module Util
-    module ChangelogGenerator
-      # Taken from the version regex in https://forgeapi.puppet.com/schemas/module.json
-      VERSION_REGEX = %r{^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+[0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*)?$}
-      GEM = 'github_changelog_generator'.freeze
-
-      # Raises if the github_changelog_generator is not available
-      def self.github_changelog_generator_available!
-        check_command = PDK::CLI::Exec::InteractiveCommand.new(PDK::CLI::Exec.bundle_bin, 'show', 'github_changelog_generator')
-        check_command.context = :module
-
-        result = check_command.execute!
-
-        return if result[:exit_code].zero?
-
-        raise PDK::CLI::ExitWithError, _(
-          'Unable to generate the changelog as the %{gem} gem is not included in this module\'s Gemfile',
-        ) % { gem: GEM }
-      end
-
-      # Runs the Changelog Generator gem (in the module's context) to automatically create a CHANGLELOG.MD file
-      #
-      # @returns [String] The content of the new Changelog
-      def self.generate_changelog
-        github_changelog_generator_available!
-
-        changelog_command = PDK::CLI::Exec::InteractiveCommand.new(PDK::CLI::Exec.bundle_bin, 'exec', 'rake', 'changelog')
-        changelog_command.context = :module
-
-        result = changelog_command.execute!
-        raise PDK::CLI::ExitWithError, _('Error generating changelog: %{stdout}' % { stdout: result[:stdout] }) unless result[:exit_code].zero?
-
-        output = changelog_content
-
-        raise PDK::CLI::ExitWithError, _('The generated changelog contains uncategorized Pull Requests. Please label them and try again. See %{changelog_file} for more details' % { changelog_file: changelog_file }) if output =~ %r{UNCATEGORIZED PRS; GO LABEL THEM} # rubocop:disable Metrics/LineLength
-        output
-      end
-
-      # Computes the next version, based on the content of a changelog
-      #
-      # @param current_version [String, Gem::Version] The current version of the module
-      # @return [String] The new version. May be the same as the current version if there are no notable changes
-      def self.compute_next_version(current_version)
-        raise PDK::CLI::ExitWithError, _('Invalid version string %{version}' % { version: current_version }) unless current_version =~ VERSION_REGEX
-        version = Gem::Version.create(current_version).segments
-        PDK.logger.info _('Determing the target version from \'%{file}\'') % { file: changelog_file }
-
-        # Grab all lines that start with ## between from the latest changes
-        # For example given the changelog below
-
-        # ```
-        # # Change log
-        #
-        # All notable changes to this project will be documented in this file.
-        #
-        # ## [v4.0.0](https://github.com/puppetlabs/puppetlabs-inifile/tree/v4.
-        #
-        # [Full Changelog](https://github.com/puppetlabs/puppetlabs-inifile/com   --+
-        #                                                                           |
-        # ### Changed                                                               |
-        #                                                                           |
-        # - pdksync - FM-8499 - remove ubuntu14 support [\#363](https://github.     |  It's this piece of text we are interested in
-        #                                                                           |
-        # ### Added                                                                 |
-        #                                                                           |
-        # - FM-8402 add debian 10 support [\#352](https://github.com/puppetlabs     |
-        #                                                                           |
-        # ## [v3.1.0](https://github.com/puppetlabs/puppetlabs-inifile/tree/v3.     |
-        #                                                                         --+
-        # [Full Changelog](https://github.com/puppetlabs/puppetlabs-inifile/com
-        #
-        # ### Added
-        #
-        # - FM-8222 - Port Module inifile to Litmus [\#344](https://github.com/
-        # - \(FM-8154\) Add Windows Server 2019 support [\#340](https://github.
-        # - \(FM-8041\) Add RedHat 8 support [\#339](https://github.com/puppetl
-        # ````
-        data = ''
-        in_changelog_entry = false
-        changelog_content.each_line do |line|
-          line.strip!
-          if line.start_with?('[')
-            # We're leaving the latest changes so we can break
-            break if in_changelog_entry
-            in_changelog_entry = true
-          end
-          if in_changelog_entry && line.start_with?('##')
-            data += line
-          end
-        end
-
-        # Check for meta headers in first two header line matches
-        if data =~ %r{^### Changed}
-          # Major Version bump
-          version[0] += 1
-          version[1] = 0
-          version[2] = 0
-        elsif data =~ %r{^### Added}
-          # Minor Version bump
-          version[1] += 1
-          version[2] = 0
-        elsif data =~ %r{^### Fixed}
-          # Patch Version bump
-          version[2] += 1
-        end
-
-        version.join('.')
-      end
-
-      def self.changelog_file
-        # Default Changelog file is CHANGELOG.md, but also search for the .MD prefix as well.
-        @changelog_file ||= ['CHANGELOG.md', 'CHANGELOG.MD'].map { |file| PDK::Util::Filesystem.expand_path(file) }.find { |path| PDK::Util::Filesystem.file?(path) }
-      end
-
-      def self.changelog_content
-        return '' if changelog_file.nil?
-        PDK::Util::Filesystem.read_file(changelog_file, open_args: 'rb:utf-8')
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Util
+    module ChangelogGenerator
+      # Taken from the version regex in https://forgeapi.puppet.com/schemas/module.json
+      VERSION_REGEX = %r{^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+[0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*)?$}
+      GEM = 'github_changelog_generator'.freeze
+
+      # Raises if the github_changelog_generator is not available
+      def self.github_changelog_generator_available!
+        check_command = PDK::CLI::Exec::InteractiveCommand.new(PDK::CLI::Exec.bundle_bin, 'show', 'github_changelog_generator')
+        check_command.context = :module
+
+        result = check_command.execute!
+
+        return if result[:exit_code].zero?
+
+        raise PDK::CLI::ExitWithError, _(
+          'Unable to generate the changelog as the %{gem} gem is not included in this module\'s Gemfile',
+        ) % { gem: GEM }
+      end
+
+      # Runs the Changelog Generator gem (in the module's context) to automatically create a CHANGLELOG.MD file
+      #
+      # @returns [String] The content of the new Changelog
+      def self.generate_changelog
+        github_changelog_generator_available!
+
+        changelog_command = PDK::CLI::Exec::InteractiveCommand.new(PDK::CLI::Exec.bundle_bin, 'exec', 'rake', 'changelog')
+        changelog_command.context = :module
+
+        result = changelog_command.execute!
+        raise PDK::CLI::ExitWithError, _('Error generating changelog: %{stdout}' % { stdout: result[:stdout] }) unless result[:exit_code].zero?
+
+        output = changelog_content
+
+        raise PDK::CLI::ExitWithError, _('The generated changelog contains uncategorized Pull Requests. Please label them and try again. See %{changelog_file} for more details' % { changelog_file: changelog_file }) if output =~ %r{UNCATEGORIZED PRS; GO LABEL THEM} # rubocop:disable Metrics/LineLength
+        output
+      end
+
+      # Computes the next version, based on the content of a changelog
+      #
+      # @param current_version [String, Gem::Version] The current version of the module
+      # @return [String] The new version. May be the same as the current version if there are no notable changes
+      def self.compute_next_version(current_version)
+        raise PDK::CLI::ExitWithError, _('Invalid version string %{version}' % { version: current_version }) unless current_version =~ VERSION_REGEX
+        version = Gem::Version.create(current_version).segments
+        PDK.logger.info _('Determing the target version from \'%{file}\'') % { file: changelog_file }
+
+        # Grab all lines that start with ## between from the latest changes
+        # For example given the changelog below
+
+        # ```
+        # # Change log
+        #
+        # All notable changes to this project will be documented in this file.
+        #
+        # ## [v4.0.0](https://github.com/puppetlabs/puppetlabs-inifile/tree/v4.
+        #
+        # [Full Changelog](https://github.com/puppetlabs/puppetlabs-inifile/com   --+
+        #                                                                           |
+        # ### Changed                                                               |
+        #                                                                           |
+        # - pdksync - FM-8499 - remove ubuntu14 support [\#363](https://github.     |  It's this piece of text we are interested in
+        #                                                                           |
+        # ### Added                                                                 |
+        #                                                                           |
+        # - FM-8402 add debian 10 support [\#352](https://github.com/puppetlabs     |
+        #                                                                           |
+        # ## [v3.1.0](https://github.com/puppetlabs/puppetlabs-inifile/tree/v3.     |
+        #                                                                         --+
+        # [Full Changelog](https://github.com/puppetlabs/puppetlabs-inifile/com
+        #
+        # ### Added
+        #
+        # - FM-8222 - Port Module inifile to Litmus [\#344](https://github.com/
+        # - \(FM-8154\) Add Windows Server 2019 support [\#340](https://github.
+        # - \(FM-8041\) Add RedHat 8 support [\#339](https://github.com/puppetl
+        # ````
+        data = ''
+        in_changelog_entry = false
+        changelog_content.each_line do |line|
+          line.strip!
+          if line.start_with?('[')
+            # We're leaving the latest changes so we can break
+            break if in_changelog_entry
+            in_changelog_entry = true
+          end
+          if in_changelog_entry && line.start_with?('##')
+            data += line
+          end
+        end
+
+        # Check for meta headers in first two header line matches
+        if data =~ %r{^### Changed}
+          # Major Version bump
+          version[0] += 1
+          version[1] = 0
+          version[2] = 0
+        elsif data =~ %r{^### Added}
+          # Minor Version bump
+          version[1] += 1
+          version[2] = 0
+        elsif data =~ %r{^### Fixed}
+          # Patch Version bump
+          version[2] += 1
+        end
+
+        version.join('.')
+      end
+
+      # Returns the top most version from the CHANGELOG file
+      def self.latest_version
+        latest = nil
+        changelog_content.each_line do |line|
+          line.strip!
+          if line.start_with?('## [')
+            latest = line[line.index('[') + 1..line.index(']') - 1].delete('v')
+            break # stops after the top version is extracted
+          end
+        end
+        latest
+      end
+
+      def self.changelog_file
+        # Default Changelog file is CHANGELOG.md, but also search for the .MD prefix as well.
+        @changelog_file ||= ['CHANGELOG.md', 'CHANGELOG.MD'].map { |file| PDK::Util::Filesystem.expand_path(file) }.find { |path| PDK::Util::Filesystem.file?(path) }
+      end
+
+      def self.changelog_content
+        return '' if changelog_file.nil?
+        PDK::Util::Filesystem.read_file(changelog_file, open_args: 'rb:utf-8')
+      end
+    end
+  end
+end

data/lib/pdk/util/env.rb

@@ -1,47 +1,47 @@
-require 'pdk'
-require 'forwardable'
-
-module PDK
-  module Util
-    class Env
-      class WindowsEnv
-        extend Forwardable
-
-        # Note, these delegators may not have case insensitive keys
-        def_delegators :env_hash, :fetch, :select, :reject
-
-        def []=(key, value)
-          PDK::Util::Windows::Process.set_environment_variable(key, value)
-        end
-
-        def key?(key)
-          !env_hash.keys.find { |item| key.casecmp(item).zero? }.nil?
-        end
-
-        def [](key)
-          env_hash.each do |item, value|
-            next unless key.casecmp(item).zero?
-            return value
-          end
-          nil
-        end
-
-        private
-
-        def env_hash
-          PDK::Util::Windows::Process.environment_hash
-        end
-      end
-
-      class << self
-        extend Forwardable
-
-        def_delegators :implementation, :key?, :[], :[]=, :fetch, :select, :reject
-
-        def implementation
-          @implementation ||= Gem.win_platform? ? WindowsEnv.new : ENV
-        end
-      end
-    end
-  end
-end
+require 'pdk'
+require 'forwardable'
+
+module PDK
+  module Util
+    class Env
+      class WindowsEnv
+        extend Forwardable
+
+        # Note, these delegators may not have case insensitive keys
+        def_delegators :env_hash, :fetch, :select, :reject
+
+        def []=(key, value)
+          PDK::Util::Windows::Process.set_environment_variable(key, value)
+        end
+
+        def key?(key)
+          !env_hash.keys.find { |item| key.casecmp(item).zero? }.nil?
+        end
+
+        def [](key)
+          env_hash.each do |item, value|
+            next unless key.casecmp(item).zero?
+            return value
+          end
+          nil
+        end
+
+        private
+
+        def env_hash
+          PDK::Util::Windows::Process.environment_hash
+        end
+      end
+
+      class << self
+        extend Forwardable
+
+        def_delegators :implementation, :key?, :[], :[]=, :fetch, :select, :reject
+
+        def implementation
+          @implementation ||= Gem.win_platform? ? WindowsEnv.new : ENV
+        end
+      end
+    end
+  end
+end

data/lib/pdk/util/filesystem.rb

@@ -1,138 +1,138 @@
-require 'pdk'
-autoload :FileUtils, 'fileutils'
-
-module PDK
-  module Util
-    module Filesystem
-      def write_file(path, content)
-        raise ArgumentError, _('content must be a String') unless content.is_a?(String)
-        raise ArgumentError, _('path must be a String or Pathname') unless path.is_a?(String) || path.respond_to?(:to_path)
-
-        # Harmonize newlines across platforms.
-        content = content.encode(universal_newline: true)
-
-        # Make sure all written files have a trailing newline.
-        content += "\n" unless content[-1] == "\n"
-
-        File.open(path, 'wb') { |f| f.write(content) }
-      end
-      module_function :write_file
-
-      def read_file(file, nil_on_error: false, open_args: 'r')
-        File.read(file, open_args: Array(open_args))
-      rescue => e
-        raise e unless nil_on_error
-        nil
-      end
-      module_function :read_file
-
-      #:nocov:
-      # These methods just wrap core Ruby functionality and
-      # can be ignored for code coverage
-      def directory?(*args)
-        File.directory?(*args)
-      end
-      module_function :directory?
-
-      def mkdir_p(*args)
-        FileUtils.mkdir_p(*args)
-      end
-      module_function :mkdir_p
-
-      def file?(*args)
-        File.file?(*args)
-      end
-      module_function :file?
-
-      def expand_path(*args)
-        File.expand_path(*args)
-      end
-      module_function :expand_path
-
-      def glob(*args)
-        Dir.glob(*args)
-      end
-      module_function :glob
-
-      def fnmatch(*args)
-        File.fnmatch(*args)
-      end
-      module_function :fnmatch
-
-      def fnmatch?(*args)
-        File.fnmatch?(*args)
-      end
-      module_function :fnmatch?
-
-      def readable?(*args)
-        File.readable?(*args)
-      end
-      module_function :readable?
-
-      def exist?(*args)
-        File.exist?(*args)
-      end
-      module_function :exist?
-
-      def rm(*args)
-        FileUtils.rm(*args)
-      end
-      module_function :rm
-
-      def rm_f(*args)
-        FileUtils.rm_f(*args)
-      end
-      module_function :rm_f
-
-      def rm_rf(*args)
-        FileUtils.rm_rf(*args)
-      end
-      module_function :rm_rf
-
-      def remove_entry_secure(*args)
-        FileUtils.remove_entry_secure(*args)
-      end
-      module_function :remove_entry_secure
-
-      def zero?(*args)
-        File.zero?(*args)
-      end
-      module_function :zero?
-
-      def stat(*args)
-        File.stat(*args)
-      end
-      module_function :stat
-
-      def symlink?(*args)
-        File.symlink?(*args)
-      end
-      module_function :symlink?
-
-      def cp(*args)
-        FileUtils.cp(*args)
-      end
-      module_function :cp
-
-      def mv(*args)
-        FileUtils.mv(*args)
-      rescue Errno::ENOENT
-        # PDK-1169 - FileUtils.mv raises Errno::ENOENT when moving files inside
-        #            VMWare shared folders on Windows. So we need to catch this
-        #            case, check if the file exists to see if the exception is
-        #            legit and "move" the file with cp & rm.
-        src, dest, opts = args
-        raise unless File.exist?(src)
-
-        FileUtils.cp(src, dest, preserve: true)
-        if (opts ||= {})[:secure]
-          FileUtils.remove_entry_secure(src, opts[:force])
-        else
-          FileUtils.remove_entry(src, opts[:force])
-        end
-      end
-      module_function :mv
-      #:nocov:
-    end
-  end
-end
+require 'pdk'
+autoload :FileUtils, 'fileutils'
+
+module PDK
+  module Util
+    module Filesystem
+      def write_file(path, content)
+        raise ArgumentError, _('content must be a String') unless content.is_a?(String)
+        raise ArgumentError, _('path must be a String or Pathname') unless path.is_a?(String) || path.respond_to?(:to_path)
+
+        # Harmonize newlines across platforms.
+        content = content.encode(universal_newline: true)
+
+        # Make sure all written files have a trailing newline.
+        content += "\n" unless content[-1] == "\n"
+
+        File.open(path, 'wb') { |f| f.write(content) }
+      end
+      module_function :write_file
+
+      def read_file(file, nil_on_error: false, open_args: 'r')
+        File.read(file, open_args: Array(open_args))
+      rescue => e
+        raise e unless nil_on_error
+        nil
+      end
+      module_function :read_file
+
+      #:nocov:
+      # These methods just wrap core Ruby functionality and
+      # can be ignored for code coverage
+      def directory?(*args)
+        File.directory?(*args)
+      end
+      module_function :directory?
+
+      def mkdir_p(*args)
+        FileUtils.mkdir_p(*args)
+      end
+      module_function :mkdir_p
+
+      def file?(*args)
+        File.file?(*args)
+      end
+      module_function :file?
+
+      def expand_path(*args)
+        File.expand_path(*args)
+      end
+      module_function :expand_path
+
+      def glob(*args)
+        Dir.glob(*args)
+      end
+      module_function :glob
+
+      def fnmatch(*args)
+        File.fnmatch(*args)
+      end
+      module_function :fnmatch
+
+      def fnmatch?(*args)
+        File.fnmatch?(*args)
+      end
+      module_function :fnmatch?
+
+      def readable?(*args)
+        File.readable?(*args)
+      end
+      module_function :readable?
+
+      def exist?(*args)
+        File.exist?(*args)
+      end
+      module_function :exist?
+
+      def rm(*args)
+        FileUtils.rm(*args)
+      end
+      module_function :rm
+
+      def rm_f(*args)
+        FileUtils.rm_f(*args)
+      end
+      module_function :rm_f
+
+      def rm_rf(*args)
+        FileUtils.rm_rf(*args)
+      end
+      module_function :rm_rf
+
+      def remove_entry_secure(*args)
+        FileUtils.remove_entry_secure(*args)
+      end
+      module_function :remove_entry_secure
+
+      def zero?(*args)
+        File.zero?(*args)
+      end
+      module_function :zero?
+
+      def stat(*args)
+        File.stat(*args)
+      end
+      module_function :stat
+
+      def symlink?(*args)
+        File.symlink?(*args)
+      end
+      module_function :symlink?
+
+      def cp(*args)
+        FileUtils.cp(*args)
+      end
+      module_function :cp
+
+      def mv(*args)
+        FileUtils.mv(*args)
+      rescue Errno::ENOENT
+        # PDK-1169 - FileUtils.mv raises Errno::ENOENT when moving files inside
+        #            VMWare shared folders on Windows. So we need to catch this
+        #            case, check if the file exists to see if the exception is
+        #            legit and "move" the file with cp & rm.
+        src, dest, opts = args
+        raise unless File.exist?(src)
+
+        FileUtils.cp(src, dest, preserve: true)
+        if (opts ||= {})[:secure]
+          FileUtils.remove_entry_secure(src, opts[:force])
+        else
+          FileUtils.remove_entry(src, opts[:force])
+        end
+      end
+      module_function :mv
+      #:nocov:
+    end
+  end
+end