Merge pull request #4 from innogames/feature/port-functions

Port old-style puppet functions to new API

Author: Felixoid

.gitignore

@@ -22,3 +22,6 @@
 /convert_report.txt
 /update_report.txt
 .DS_Store
+.project
+.envrc
+/inventory.yaml

.gitlab-ci.yml

@@ -10,33 +10,35 @@ cache:
 before_script:
   - bundle -v
   - rm Gemfile.lock || true
-  - gem update --system $RUBYGEMS_VERSION
+  - "# Update system gems if requested. This is useful to temporarily workaround troubles in the test runner"
+  - "# Set `rubygems_version` in the .sync.yml to set a value"
+  - "# Ignore exit code of SIGPIPE'd yes to not fail with shell's pipefail set"
+  - '[ -z "$RUBYGEMS_VERSION" ] || (yes || true) | gem update --system $RUBYGEMS_VERSION'
   - gem --version
   - bundle -v
   - bundle install --without system_tests --path vendor/bundle --jobs $(nproc)
 
-parallel_spec-Ruby 2.1.9-Puppet ~> 4.0:
-  stage: unit
-  image: ruby:2.1.9
+syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop-Ruby 2.5.7-Puppet ~> 6:
+  stage: syntax
+  image: ruby:2.5.7
   script:
-    - bundle exec rake parallel_spec
+    - bundle exec rake syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop
   variables:
-    PUPPET_GEM_VERSION: '~> 4.0'
-    RUBYGEMS_VERSION: '2.7.8'
+    PUPPET_GEM_VERSION: '~> 6'
 
-syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop-Ruby 2.4.4-Puppet ~> 5.5:
-  stage: syntax
-  image: ruby:2.4.4
+parallel_spec-Ruby 2.5.7-Puppet ~> 6:
+  stage: unit
+  image: ruby:2.5.7
   script:
-    - bundle exec rake syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop
+    - bundle exec rake parallel_spec
   variables:
-    PUPPET_GEM_VERSION: '~> 5.5'
+    PUPPET_GEM_VERSION: '~> 6'
 
-parallel_spec-Ruby 2.4.4-Puppet ~> 5.5:
+parallel_spec-Ruby 2.4.5-Puppet ~> 5:
   stage: unit
-  image: ruby:2.4.4
+  image: ruby:2.4.5
   script:
     - bundle exec rake parallel_spec
   variables:
-    PUPPET_GEM_VERSION: '~> 5.5'
+    PUPPET_GEM_VERSION: '~> 5'
 

.pdkignore

@@ -22,6 +22,9 @@
 /convert_report.txt
 /update_report.txt
 .DS_Store
+.project
+.envrc
+/inventory.yaml
 /appveyor.yml
 /.fixtures.yml
 /Gemfile
@@ -30,8 +33,10 @@
 /.gitlab-ci.yml
 /.pdkignore
 /Rakefile
+/rakelib/
 /.rspec
 /.rubocop.yml
 /.travis.yml
 /.yardopts
 /spec/
+/.vscode/

.puppet-lint.rc

@@ -1 +1 @@
-
+--relative

.rubocop.yml

@@ -1,5 +1,7 @@
 ---
-require: rubocop-rspec
+require:
+- rubocop-rspec
+- rubocop-i18n
 AllCops:
   DisplayCopNames: true
   TargetRubyVersion: '2.1'
@@ -19,10 +21,13 @@ AllCops:
 Metrics/LineLength:
   Description: People have wide screens, use them.
   Max: 200
+GetText:
+  Enabled: false
 GetText/DecorateString:
   Description: We don't want to decorate test output.
   Exclude:
-  - spec/*
+  - spec/**/*
+  Enabled: false
 RSpec/BeforeAfterAll:
   Description: Beware of using after(:all) as it may cause state to leak between tests.
     A necessary evil in acceptance testing.
@@ -35,6 +40,10 @@ Style/BlockDelimiters:
   Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to
     be consistent then.
   EnforcedStyle: braces_for_chaining
+Style/BracesAroundHashParameters:
+  Description: Braces are required by Ruby 2.7. Cop removed from RuboCop v0.80.0.
+    See https://github.com/rubocop-hq/rubocop/pull/7643
+  Enabled: true
 Style/ClassAndModuleChildren:
   Description: Compact style reduces the required amount of indentation.
   EnforcedStyle: compact
@@ -84,6 +93,12 @@ Style/MethodCalledOnDoEndBlock:
   Enabled: true
 Style/StringMethods:
   Enabled: true
+GetText/DecorateFunctionMessage:
+  Enabled: false
+GetText/DecorateStringFormattingUsingInterpolation:
+  Enabled: false
+GetText/DecorateStringFormattingUsingPercent:
+  Enabled: false
 Layout/EndOfLine:
   Enabled: false
 Layout/IndentHeredoc:

.travis.yml

@@ -1,39 +1,50 @@
 ---
-dist: trusty
+os: linux
+dist: xenial
 language: ruby
 cache: bundler
 before_install:
   - bundle -v
   - rm -f Gemfile.lock
-  - gem update --system $RUBYGEMS_VERSION
+  - "# Update system gems if requested. This is useful to temporarily workaround troubles in the test runner"
+  - "# See https://github.com/puppetlabs/pdk-templates/commit/705154d5c437796b821691b707156e1b056d244f for an example of how this was used"
+  - "# Ignore exit code of SIGPIPE'd yes to not fail with shell's pipefail set"
+  - '[ -z "$RUBYGEMS_VERSION" ] || (yes || true) | gem update --system $RUBYGEMS_VERSION'
   - gem --version
   - bundle -v
 script:
   - 'bundle exec rake $CHECK'
 bundler_args: --without system_tests
 rvm:
-  - 2.5.1
-env:
-  global:
-    - BEAKER_PUPPET_COLLECTION=puppet6 PUPPET_GEM_VERSION="~> 6.0"
+  - 2.5.7
 stages:
+  - static
+  - spec
+  - acceptance
   - test
   -
     if: tag =~ ^v
     name: deploy
-matrix:
+  -
+    if: tag =~ ^v\d
+    name: deploy
+jobs:
   fast_finish: true
   include:
     -
-      env: CHECK="syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop"
-    -
-      env: CHECK=parallel_spec
+      env: CHECK="check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop syntax lint metadata_lint"
+      stage: static
     -
       env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec
-      rvm: 2.4.4
+      rvm: 2.4.5
+      stage: spec
     -
-      env: PUPPET_GEM_VERSION="~> 4.0" CHECK=parallel_spec RUBYGEMS_VERSION=2.7.8
-      rvm: 2.1.9
+      env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec
+      rvm: 2.5.7
+      stage: spec
+    -
+      env: DEPLOY_TO_FORGE=yes
+      stage: deploy
     -
       env: CHECK='build' DEPLOY_TO_FORGE=yes
       stage: deploy
@@ -45,7 +56,7 @@ notifications:
   email: false
 deploy:
   provider: puppetforge
-  user: innogames
+  username: innogames
   password:
     secure: "YsTvDpCHiuMpQ41X5GMUz8kbbHUAXVVoUWsnzXdsq5UnSMgVVTrQTnrzRSwFSKtkQJkm+N5BOn1WXj3te+eGsV+Ca4hXk/hygKcHMZNBT3ZKJs1GJdW4CfOxBzdgHjT7cY7UFaDFB1vb8S6dC36R03kqizVuiWI3KC9cO5msgPB5LSIxnJYDkRqZcHPQFF8EAgIP/zidlt18fYhbTOcG61vN59aGcl3aYHxD8YGgKe5OOQk41GxvWe6tsFFHW9f8Bg7FwwMLfA7sii4TV3tW9XXP9WhfL+/VhazIPf8cLK017W4RaHi3NW+GT9d3fz15UWYta7/69i8fzg+1w+0y7hA4Fm2+aunuArYvKIzf+3erBa8RvJE563wP3xx20czjsmP26ecTo0uyHiqvovhHUF7s39EWyQgv6zNPOT5IfYKDTZxj/wMIYUEas9GPJOYjyPi08TkIK2ABi2SQsPeXz7gTaANaTeIR8jcvxNItZ9Kr0SkazZaRMUJI3Lhn1dx2jt705H5FdjFFC2xLfVdFgJVNHUTuO9ZWEH73QJnj6g11lwFDejz8xAdcpi287kpOQ59rVit8Tn2y+CJY9R30o1ac5CKQ6EXpP7DuZRiPx7+S4OQItwX7ep5GiOgo6mD5VsaPr3uHebT9islxzvCboIFv+FcPkmrTwFI0fJQFY5A="
   on:

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "puppet.puppet-vscode",
+    "rebornix.Ruby"
+  ]
+}

Gemfile

@@ -17,16 +17,18 @@ ruby_version_segments = Gem::Version.new(RUBY_VERSION.dup).segments
 minor_version = ruby_version_segments[0..1].join('.')
 
 group :development do
-  gem "fast_gettext", '1.1.0',                         require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0')
-  gem "fast_gettext",                                  require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0')
-  gem "json_pure", '<= 2.0.1',                         require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0')
-  gem "json", '= 1.8.1',                               require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.1.9')
-  gem "json", '<= 2.0.4',                              require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.4.4')
-  gem "puppet-module-posix-default-r#{minor_version}", require: false, platforms: [:ruby]
-  gem "puppet-module-posix-dev-r#{minor_version}",     require: false, platforms: [:ruby]
-  gem "puppet-module-win-default-r#{minor_version}",   require: false, platforms: [:mswin, :mingw, :x64_mingw]
-  gem "puppet-module-win-dev-r#{minor_version}",       require: false, platforms: [:mswin, :mingw, :x64_mingw]
-  gem "pdk",                                           require: false
+  gem "fast_gettext", '1.1.0',                                   require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0')
+  gem "fast_gettext",                                            require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0')
+  gem "json_pure", '<= 2.0.1',                                   require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0')
+  gem "json", '= 1.8.1',                                         require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.1.9')
+  gem "json", '= 2.0.4',                                         require: false if Gem::Requirement.create('~> 2.4.2').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "json", '= 2.1.0',                                         require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "rb-readline", '= 0.5.5',                                  require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "puppet-module-posix-default-r#{minor_version}", '~> 0.4', require: false, platforms: [:ruby]
+  gem "puppet-module-posix-dev-r#{minor_version}", '~> 0.4',     require: false, platforms: [:ruby]
+  gem "puppet-module-win-default-r#{minor_version}", '~> 0.4',   require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "puppet-module-win-dev-r#{minor_version}", '~> 0.4',       require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "pdk",                                                     require: false
 end
 group :dependencies do
   gem "xml-simple", require: false

REFERENCE.md

@@ -12,13 +12,25 @@
 
 ### hash_to_xml
 
-Type: Ruby 3.x API
+Type: Ruby 4.x API
 
 Function that converts a hash to an XML string
 
+#### `hash_to_xml(Hash $data)`
+
+The hash_to_xml function.
+
+Returns: `String` xml is generated from `$data`
+
+##### `data`
+
+Data type: `Hash`
+
+Hash to be converted into xml
+
 #### `hash_to_xml(Hash $data, Hash $options)`
 
-Function that converts a hash to an XML string
+The hash_to_xml function.
 
 Returns: `String` xml is generated from `$data`
 
@@ -32,21 +44,33 @@ Hash to be converted into xml
 
 Data type: `Hash`
 
-(optional) second parameter will be passed into XmlSimple.xml_out
+The second parameter will be passed into XmlSimple.xml_out
 
 ### xml_to_hash
 
-Type: Ruby 3.x API
+Type: Ruby 4.x API
 
 Function to convert an xml file into a hash via xml-simple
 
-#### `xml_to_hash(String $xml, Hash $options)`
+#### `xml_to_hash(String $xml_file)`
 
-Function to convert an xml file into a hash via xml-simple
+The xml_to_hash function.
+
+Returns: `Hash` data are converted from xml
+
+##### `xml_file`
+
+Data type: `String`
+
+Local file name to be passed into XmlSimple.xml_in
+
+#### `xml_to_hash(String $xml_file, Hash $options)`
+
+The xml_to_hash function.
 
 Returns: `Hash` data are converted from xml
 
-##### `xml`
+##### `xml_file`
 
 Data type: `String`
 

Rakefile

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'puppet_litmus/rake_tasks' if Bundler.rubygems.find_name('puppet_litmus').any?
 require 'puppetlabs_spec_helper/rake_tasks'
 require 'puppet-syntax/tasks/puppet-syntax'
 require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any?
@@ -14,15 +17,24 @@ end
 
 def changelog_project
   return unless Rake.application.top_level_tasks.include? "changelog"
-  returnVal = nil || JSON.load(File.read('metadata.json'))['name']
-  raise "unable to find the changelog_project in .sync.yml or the name in metadata.json" if returnVal.nil?
+
+  returnVal = nil
+  returnVal ||= begin
+    metadata_source = JSON.load(File.read('metadata.json'))['source']
+    metadata_source_match = metadata_source && metadata_source.match(%r{.*\/([^\/]*?)(?:\.git)?\Z})
+
+    metadata_source_match && metadata_source_match[1]
+  end
+
+  raise "unable to find the changelog_project in .sync.yml or calculate it from the source in metadata.json" if returnVal.nil?
+
   puts "GitHubChangelogGenerator project:#{returnVal}"
   returnVal
 end
 
 def changelog_future_release
   return unless Rake.application.top_level_tasks.include? "changelog"
-  returnVal = JSON.load(File.read('metadata.json'))['version']
+  returnVal = "v%s" % JSON.load(File.read('metadata.json'))['version']
   raise "unable to find the future_release (version) in metadata.json" if returnVal.nil?
   puts "GitHubChangelogGenerator future_release:#{returnVal}"
   returnVal

appveyor.yml

@@ -3,6 +3,7 @@ version: 1.1.x.{build}
 branches:
   only:
     - master
+    - release
 skip_commits:
   message: /^\(?doc\)?.*/
 clone_depth: 10
@@ -17,14 +18,6 @@ environment:
     -
       RUBY_VERSION: 24-x64
       CHECK: syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop
-    -
-      PUPPET_GEM_VERSION: ~> 4.0
-      RUBY_VERSION: 21
-      CHECK: parallel_spec
-    -
-      PUPPET_GEM_VERSION: ~> 4.0
-      RUBY_VERSION: 21-x64
-      CHECK: parallel_spec
     -
       PUPPET_GEM_VERSION: ~> 5.0
       RUBY_VERSION: 24

lib/puppet/functions/hash_to_xml.rb

@@ -0,0 +1,31 @@
+require 'xmlsimple'
+
+# @summary
+#     Function that converts a hash to an XML string
+Puppet::Functions.create_function(:hash_to_xml) do
+  # @param [Hash] data Hash to be converted into xml
+  #
+  # @return [String]
+  #   xml is generated from `$data`
+  dispatch :default_impl do
+    param 'Hash', :data
+  end
+
+  # @param [Hash] data Hash to be converted into xml
+  # @param [Hash] options The second parameter will be passed into XmlSimple.xml_out
+  #
+  # @return [String]
+  #   xml is generated from `$data`
+  dispatch :with_options do
+    param 'Hash', :data
+    param 'Hash', :options
+  end
+
+  def default_impl(data)
+    XmlSimple.xml_out(data)
+  end
+
+  def with_options(data, options)
+    XmlSimple.xml_out(data, options)
+  end
+end