puppet-modulebuilder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d54453c16cf48b673985f7c0212fd2487d346938da71e4406a05837474c9018
+  data.tar.gz: 91164b968b1d6886f5e254b651cea4555c6a3ecdeddfb1fbabb8b22ef8ec8a67
+SHA512:
+  metadata.gz: a2896cd01a49b78b35bcfbca9b5d3dc47e45eed641d60386c351ba0eeb90ef502f453139fc108b54d1e7b8344ef794aeb43fa56da3a1418050751887cab1fb1f
+  data.tar.gz: aba5ef82de309bc9b3da471ad43d920632ee19b75fd338b70f1252f199c3e46dad279356496179d05b80a1e5387a6f9d67723dfe955fe6fbd6916c56517a8098

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Setting ownership to the modules team
+* @puppetlabs/modules @puppetlabs/pdk

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.local
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,173 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    # binstubs, and other utilities
+    - bin/**/*
+    - vendor/**/*
+    - vendor/**/.*
+    # package testing gems
+    - package-testing/vendor/**/*
+    - package-testing/vendor/**/.*
+    # Any thing in test fixtures
+    - spec/fixtures/**/*
+
+# Metrics, excludes complexity and sizing metrics for now, as ruby's defaults are very strict
+Metrics/AbcSize:
+  Enabled: False
+
+Metrics/BlockLength:
+  Description: rspec uses long describe blocks, so allow long blocks under spec/
+  Enabled: False
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/ClassLength:
+  Enabled: False
+
+Metrics/CyclomaticComplexity:
+  Enabled: False
+
+Layout/LineLength:
+  Description: People have wide screens, use them.
+  Max: 200
+
+Metrics/MethodLength:
+  Enabled: False
+
+Metrics/ModuleLength:
+  Enabled: False
+
+Metrics/ParameterLists:
+  Enabled: False
+
+Metrics/PerceivedComplexity:
+  Enabled: False
+
+# RSpec cops
+RSpec/BeforeAfterAll:
+  Description: Beware of using after(:all) as it may cause state to leak between tests. A necessary evil in acceptance testing.
+  Exclude:
+    - 'spec/acceptance/**/*.rb'
+    - 'package-testing/spec/package/**/*.rb'
+
+RSpec/DescribeClass:
+  Description: This cop does not account for rspec-puppet, and beaker-rspec usage.
+  Enabled: False
+
+RSpec/HookArgument:
+  Description: Prefer explicit :each argument, matching existing module's style
+  EnforcedStyle: each
+
+RSpec/NestedGroups:
+  Description: Nested groups can lead to cleaner tests with less duplication
+  Max: 10
+
+RSpec/ExampleLength:
+  Description: Forcing short examples leads to the creation of one-time use let() helpers
+  Enabled: False
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/ScatteredSetup:
+  Enabled: False
+
+# This is fine
+RSpec/ImplicitSubject:
+  Enabled: false
+
+# Set a reasonble max level
+RSpec/MultipleExpectations:
+  Max: 10
+
+# Nested contexts don't comply
+RSpec/ContextWording:
+  Enabled: false
+
+# This is allowed
+RSpec/SubjectStub:
+  Enabled: false
+
+# Doesn't help readability
+RSpec/PredicateMatcher:
+  Enabled: false
+
+# Style Cops
+Style/AsciiComments:
+  Description: Names, non-english speaking communities.
+  Enabled: False
+
+Style/BlockDelimiters:
+  Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to be consistent then.
+  EnforcedStyle: braces_for_chaining
+
+Style/ClassAndModuleChildren:
+  Description: Compact style reduces the required amount of indentation.
+  EnforcedStyle: compact
+
+Style/EmptyElse:
+  Description: Enforce against empty else clauses, but allow `nil` for clarity.
+  EnforcedStyle: empty
+
+Style/FormatString:
+  Description: Following the main puppet project's style, prefer the % format format.
+  EnforcedStyle: percent
+
+Style/FormatStringToken:
+  Description: Following the main puppet project's style, prefer the simpler template tokens over annotated ones.
+  EnforcedStyle: template
+
+Style/IfUnlessModifier:
+  Description: Post-fix `if` modifiers are hard to parse for newcomers. We don't want to encourage them. Post-fix `unless` modifiers could be nice in some cases, but the Cop doesn't differentiate.
+  Enabled: false
+
+Style/Lambda:
+  Description: Prefer the keyword for easier discoverability.
+  EnforcedStyle: literal
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/RegexpLiteral:
+  Description: Community preference. See https://github.com/voxpupuli/modulesync_config/issues/168
+  EnforcedStyle: percent_r
+
+Style/SymbolProc:
+  Description: SymbolProc notation is not discoverable
+  Enabled: false
+
+Style/TernaryParentheses:
+  Description: Checks for use of parentheses around ternary conditions. Enforce parentheses on complex expressions for better readability, but seriously consider breaking it up.
+  EnforcedStyle: require_parentheses_when_complex
+
+Style/TrailingCommaInArguments:
+  Description: Prefer always trailing comma on multiline argument lists. This makes diffs, and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  Description: Prefer always trailing comma on multiline literals. This makes diffs, and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  Description: Prefer always trailing comma on multiline literals. This makes diffs, and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
+
+Style/SymbolArray:
+  Description: Using percent style obscures symbolic intent of array's contents.
+  Enabled: true
+  EnforcedStyle: brackets
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+# Enforce LF line endings, even when on Windows
+Layout/EndOfLine:
+  EnforcedStyle: lf

data/.travis.yml

@@ -0,0 +1,14 @@
+---
+os: linux
+language: ruby
+cache: bundler
+jobs:
+  include:
+  - rvm: 2.5.7
+    env:
+    - SIMPLECOV=yes
+    before_install: gem install bundler -v 2.1.4
+  - rvm: 2.4.9
+    before_install: gem install bundler -v 2.1.4
+  - rvm: 2.1.9
+    script: "bundle exec rake spec # don't try to run rubocop on ancient ruby"

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+This is the initial release of the project.

data/Gemfile

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puppet-modulebuilder.gemspec
+gemspec
+
+group :development do
+  gem 'rake', '~> 12.0'
+  gem 'rspec', '~> 3.0'
+  if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')
+    gem 'rubocop', '~> 0.68'
+    gem 'rubocop-rspec', '~> 1.38'
+
+    gem 'codecov', '~> 0.1'
+    gem 'simplecov', '~> 0.18'
+    gem 'simplecov-console', '~> 0.6'
+  end
+
+  if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.5.0')
+    gem 'puppet', '~> 6.0'
+  elsif Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.4.0')
+    gem 'puppet', '~> 5.0' # rubocop:disable Bundler/DuplicatedGem Nope, not a duplicate!
+  else
+    gem 'puppet', '~> 4.0' # rubocop:disable Bundler/DuplicatedGem Nope, not a duplicate!
+  end
+end
+
+# Evaluate Gemfile.local and ~/.gemfile if they exist
+extra_gemfiles = [
+  "#{__FILE__}.local",
+  File.join(Dir.home, '.gemfile'),
+]
+
+extra_gemfiles.each do |gemfile|
+  if File.file?(gemfile) && File.readable?(gemfile)
+    eval(File.read(gemfile), binding) # rubocop:disable Security/Eval
+  end
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,38 @@
+[![Build Status](https://travis-ci.com/puppetlabs/puppet-modulebuilder.svg?branch=master)](https://travis-ci.com/puppetlabs/puppet-modulebuilder) [![Build status](https://ci.appveyor.com/api/projects/status/j9tosvq4a09iw0bx/branch/master?svg=true)](https://ci.appveyor.com/project/puppetlabs/puppet-modulebuilder/branch/master)
+
+# Puppet::Modulebuilder
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/puppet/modulebuilder`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puppet-modulebuilder'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install puppet-modulebuilder
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/puppet-modulebuilder.
+

data/Rakefile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+begin
+  # make rubocop optional to deal with ruby 2.1
+  require 'rubocop/rake_task'
+
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.options = %w[-D -S -E]
+  end
+
+  task default: [:rubocop]
+rescue LoadError => e
+  puts "Can't load 'rubocop/rake_task': #{e.inspect}"
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/unit/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new(:acceptance) do |t|
+  t.pattern = 'spec/acceptance/**/*_spec.rb'
+end
+
+task default: [:spec, :acceptance]

data/appveyor.yml

@@ -0,0 +1,25 @@
+---
+install:
+  - set PATH=C:\Ruby25-x64\bin;%PATH%
+  - set SIMPLECOV=yes
+  - gem install bundler -v 2.1.4
+  - bundle -v
+  - bundle install --retry 2
+
+build: off
+
+branches:
+  only:
+    - master
+
+before_test:
+  - bundle env
+  - type Gemfile.lock
+
+test_script:
+  - bundle exec rake
+
+# Uncomment this block to enable RDP access to the AppVeyor test instance for
+# debugging purposes.
+# on_finish:
+#  - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))

data/lib/puppet/modulebuilder.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'puppet/modulebuilder/version'
+require 'puppet/modulebuilder/builder'

data/lib/puppet/modulebuilder/builder.rb

@@ -0,0 +1,414 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Puppet::Modulebuilder
+  # Class to build Puppet Modules from source
+  class Builder
+    DEFAULT_IGNORED = [
+      '/pkg/',
+      '~*',
+      '/coverage',
+      '/checksums.json',
+      '/REVISION',
+      '/spec/fixtures/modules/',
+      '/vendor/',
+    ].freeze
+
+    attr_reader :destination
+
+    attr_reader :logger
+
+    def initialize(source, destination, logger)
+      raise ArgumentError, 'logger is expected to be nil or a Logger. Got %{klass}' % { klass: logger.class } unless logger.nil? || logger.is_a?(Logger)
+
+      @source_validated = false
+      @source = source
+      @destination = destination.nil? ? File.join(source, 'pkg') : destination
+      @logger = logger.nil? ? ::Logger.new(File.open(File::NULL, 'w')) : logger
+    end
+
+    # The source to build the module from
+    # @return [String]
+    def source
+      return @source if @source_validated
+
+      validate_source!
+      @source
+    end
+
+    # Build a module package from a module directory.
+    #
+    # @return [String] The path to the built package file.
+    def build
+      create_build_dir
+
+      stage_module_in_build_dir
+      build_package
+
+      package_file
+    ensure
+      cleanup_build_dir
+    end
+
+    # Return the path to the temporary build directory, which will be placed
+    # inside the target directory and match the release name (see #release_name).
+    def build_dir
+      @build_dir ||= File.join(build_context[:parent_dir], build_context[:build_dir_name])
+    end
+
+    def build_context
+      {
+        parent_dir: destination,
+        build_dir_name: release_name,
+      }.freeze
+    end
+
+    # Iterate through all the files and directories in the module and stage
+    # them into the temporary build directory (unless ignored).
+    #
+    # @return nil
+    def stage_module_in_build_dir
+      require 'find'
+
+      Find.find(source) do |path|
+        next if path == source
+
+        if ignored_path?(path)
+          logger.debug("Ignoring #{path} from the build")
+          Find.prune
+        else
+          logger.debug("Staging #{path} for the build")
+          stage_path(path)
+        end
+      end
+    end
+
+    # Stage a file or directory from the module into the build directory.
+    #
+    # @param path [String] The path to the file or directory.
+    #
+    # @return nil.
+    def stage_path(path)
+      require 'pathname'
+
+      relative_path = Pathname.new(path).relative_path_from(Pathname.new(source))
+      dest_path = File.join(build_dir, relative_path)
+
+      validate_path_encoding!(relative_path.to_path)
+
+      begin
+        if file_directory?(path)
+          fileutils_mkdir_p(dest_path, mode: file_stat(path).mode)
+        elsif file_symlink?(path)
+          warn_symlink(path)
+        else
+          validate_ustar_path!(relative_path.to_path)
+          fileutils_cp(path, dest_path, preserve: true)
+        end
+      rescue ArgumentError => e
+        raise '%{message} Rename the file or exclude it from the package by adding it to the .pdkignore file in your module.' % { message: e.message }
+      end
+    end
+
+    # Check if the given path matches one of the patterns listed in the
+    # ignore file.
+    #
+    # @param path [String] The path to be checked.
+    #
+    # @return [Boolean] true if the path matches and should be ignored.
+    def ignored_path?(path)
+      path = path.to_s + '/' if File.directory?(path)
+
+      !ignored_files.match_paths([path], source).empty?
+    end
+
+    # Warn the user about a symlink that would have been included in the
+    # built package.
+    #
+    # @param path [String] The relative or absolute path to the symlink.
+    #
+    # @return nil.
+    def warn_symlink(path)
+      require 'pathname'
+
+      symlink_path = Pathname.new(path)
+      module_path = Pathname.new(module_dir)
+
+      logger.warn _('Symlinks in modules are not supported and will not be included in the package. Please investigate symlink %{from} -> %{to}.') % {
+        from: symlink_path.relative_path_from(module_path),
+        to: symlink_path.realpath.relative_path_from(module_path),
+      }
+    end
+
+    # Select the most appropriate ignore file in the module directory.
+    #
+    # In order of preference, we first try `.pdkignore`, then `.pmtignore`
+    # and finally `.gitignore`.
+    #
+    # @return [String] The path to the file containing the patterns of file
+    #   paths to ignore.
+    def ignore_file
+      @ignore_file ||= [
+        File.join(source, '.pdkignore'),
+        File.join(source, '.pmtignore'),
+        File.join(source, '.gitignore'),
+      ].find { |file| file_exists?(file) && file_readable?(file) }
+    end
+
+    # Checks if the path contains any non-ASCII characters.
+    #
+    # Java will throw an error when it encounters a path containing
+    # characters that are not supported by the hosts locale. In order to
+    # maximise compatibility we limit the paths to contain only ASCII
+    # characters, which should be part of any locale character set.
+    #
+    # @param path [String] the relative path to be added to the tar file.
+    #
+    # @raise [ArgumentError] if the path contains non-ASCII characters.
+    #
+    # @return [nil]
+    def validate_path_encoding!(path)
+      return unless path =~ %r{[^\x00-\x7F]}
+
+      raise ArgumentError, "'%{path}' can only include ASCII characters in its path or " \
+        'filename in order to be compatible with a wide range of hosts.' % { path: path }
+    end
+
+    # Creates a gzip compressed tarball of the build directory.
+    #
+    # If the destination package already exists, it will be removed before
+    # creating the new tarball.
+    #
+    # @return nil.
+    def build_package
+      require 'zlib'
+      require 'minitar'
+      require 'find'
+
+      FileUtils.rm_f(package_file)
+
+      # The chdir necessary us due to Minitar entry not be able to separate the filename
+      # within the TAR versus the source filename to pack
+      Dir.chdir(build_context[:parent_dir]) do
+        gz = Zlib::GzipWriter.new(File.open(package_file, 'wb'))
+        begin
+          tar = Minitar::Output.new(gz)
+          Find.find(build_context[:build_dir_name]) do |entry|
+            entry_meta = {
+              name: entry,
+            }
+
+            orig_mode = File.stat(entry).mode
+            min_mode = Minitar.dir?(entry) ? 0o755 : 0o644
+
+            entry_meta[:mode] = orig_mode | min_mode
+
+            if entry_meta[:mode] != orig_mode
+              logger.debug('Updated permissions of packaged \'%{entry}\' to %{new_mode}' % {
+                entry: entry,
+                new_mode: (entry_meta[:mode] & 0o7777).to_s(8),
+              })
+            end
+
+            Minitar.pack_file(entry_meta, tar)
+          end
+        ensure
+          tar.close
+        end
+      end
+    end
+
+    # Instantiate a new PathSpec class and populate it with the pattern(s) of
+    # files to be ignored.
+    #
+    # @return [PathSpec] The populated ignore path matcher.
+    def ignored_files
+      require 'pathspec'
+
+      @ignored_files ||=
+        begin
+          ignored = if ignore_file.nil?
+                      PathSpec.new
+                    else
+                      PathSpec.new(read_file(ignore_file, open_args: 'rb:UTF-8'))
+                    end
+
+          if File.realdirpath(destination).start_with?(File.realdirpath(source))
+            ignored = ignored.add("\/#{File.basename(destination)}\/")
+          end
+
+          DEFAULT_IGNORED.each { |r| ignored.add(r) }
+
+          ignored
+        end
+    end
+
+    # Create a temporary build directory where the files to be included in
+    # the package will be staged before building the tarball.
+    #
+    # If the directory already exists, remove it first.
+    def create_build_dir
+      cleanup_build_dir
+
+      fileutils_mkdir_p(build_dir)
+    end
+
+    # Remove the temporary build directory and all its contents from disk.
+    #
+    # @return nil.
+    def cleanup_build_dir
+      FileUtils.rm_rf(build_dir, secure: true)
+    end
+
+    # Read and parse the values from metadata.json for the module that is
+    # being built.
+    #
+    # @return [Hash{String => Object}] The hash of metadata values.
+    def metadata
+      return @metadata unless @metadata.nil?
+
+      metadata_json_path = File.join(source, 'metadata.json')
+
+      unless file_exists?(metadata_json_path)
+        raise ArgumentError, "'%{file}' does not exist or is not a file." % { file: metadata_json_path }
+      end
+
+      unless file_readable?(metadata_json_path)
+        raise ArgumentError, "Unable to open '%{file}' for reading." % { file: metadata_json_path }
+      end
+
+      require 'json'
+      begin
+        @metadata = JSON.parse(read_file(metadata_json_path))
+      rescue JSON::JSONError => e
+        raise ArgumentError, 'Invalid JSON in metadata.json: %{msg}' % { msg: e.message }
+      end
+      @metadata.freeze
+    end
+
+    # Return the path where the built package file will be written to.
+    def package_file
+      @package_file ||= File.join(destination, "#{release_name}.tar.gz")
+    end
+
+    # Verify if there is an existing package in the target directory and prompts
+    # the user if they want to overwrite it.
+    def package_already_exists?
+      file_exists?(package_file)
+    end
+
+    # Combine the module name and version into a Forge-compatible dash
+    # separated string.
+    #
+    # @return [String] The module name and version, joined by a dash.
+    def release_name
+      @release_name ||= [
+        metadata['name'],
+        metadata['version'],
+      ].join('-')
+    end
+
+    # Checks if the path length will fit into the POSIX.1-1998 (ustar) tar
+    # header format.
+    #
+    # POSIX.1-2001 (which allows paths of infinite length) was adopted by GNU
+    # tar in 2004 and is supported by minitar 0.7 and above. Unfortunately
+    # much of the Puppet ecosystem still uses minitar 0.6.1.
+    #
+    # POSIX.1-1998 tar format does not allow for paths greater than 256 bytes,
+    # or paths that can't be split into a prefix of 155 bytes (max) and
+    # a suffix of 100 bytes (max).
+    #
+    # This logic was pretty much copied from the private method
+    # {Archive::Tar::Minitar::Writer#split_name}.
+    #
+    # @param path [String] the relative path to be added to the tar file.
+    #
+    # @raise [ArgumentError] if the path is too long or could not be split.
+    #
+    # @return [nil]
+    def validate_ustar_path!(path)
+      if path.bytesize > 256
+        raise ArgumentError, "The path '%{path}' is longer than 256 bytes." % {
+          path: path,
+        }
+      end
+
+      if path.bytesize <= 100
+        prefix = ''
+      else
+        parts = path.split(File::SEPARATOR)
+        newpath = parts.pop
+        nxt = ''
+
+        loop do
+          nxt = parts.pop || ''
+          break if newpath.bytesize + 1 + nxt.bytesize >= 100
+
+          newpath = File.join(nxt, newpath)
+        end
+
+        prefix = File.join(*parts, nxt)
+        path = newpath
+      end
+
+      return unless path.bytesize > 100 || prefix.bytesize > 155
+
+      raise ArgumentError, \
+            "'%{path}' could not be split at a directory separator into two " \
+            'parts, the first having a maximum length of 155 bytes and the ' \
+            'second having a maximum length of 100 bytes.' % { path: path }
+    end
+
+    private
+
+    # Validates that source is able to be built
+    def validate_source!
+      unless file_directory?(@source) && file_readable?(@source)
+        raise ArgumentError, "Module source '%{source}' does not exist as a directory is or is not readable" % { source: @source }
+      end
+
+      @source_validated = true
+    end
+
+    # @return [String] The file contents
+    def read_file(file, nil_on_error: false, open_args: 'r')
+      File.read(file, open_args: Array(open_args))
+    rescue StandardError => e
+      raise e unless nil_on_error
+
+      nil
+    end
+
+    # Filesystem wrapper methods.
+    # These are mocked in spec tests.
+    def file_exists?(*args)
+      File.file?(*args)
+    end
+
+    def file_readable?(*args)
+      File.readable?(*args)
+    end
+
+    def file_directory?(*args)
+      File.directory?(*args)
+    end
+
+    def file_symlink?(*args)
+      File.symlink?(*args)
+    end
+
+    def fileutils_cp(*args)
+      FileUtils.cp(*args)
+    end
+
+    def fileutils_mkdir_p(*args)
+      FileUtils.mkdir_p(*args)
+    end
+
+    def file_stat(*args)
+      File.stat(*args)
+    end
+  end
+end

data/lib/puppet/modulebuilder/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Puppet # rubocop:disable Style/ClassAndModuleChildren
+  module Modulebuilder
+    VERSION = '0.1.0'
+  end
+end

data/puppet-modulebuilder.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/puppet/modulebuilder/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'puppet-modulebuilder'
+  spec.version               = Puppet::Modulebuilder::VERSION
+  spec.authors               = ['Sheena', 'Team IAC']
+  spec.email                 = ['sheena@puppet.com', 'https://puppetlabs.github.io/iac/']
+  spec.summary               = 'A gem to set up puppet-modulebuilder'
+  spec.homepage              = 'https://github.com/puppetlabs/puppet-modulebuilder'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.1.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/puppetlabs/puppet-modulebuilder'
+  spec.metadata['changelog_uri'] = 'https://github.com/puppetlabs/puppet-modulebuilder/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  # minitar and pathspec is required for building Puppet modules
+  spec.add_runtime_dependency 'minitar', '~> 0.6'
+  spec.add_runtime_dependency 'pathspec', '~> 0.2.1'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: puppet-modulebuilder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sheena
+- Team IAC
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: pathspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+description: 
+email:
+- sheena@puppet.com
+- https://puppetlabs.github.io/iac/
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CODEOWNERS"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- appveyor.yml
+- lib/puppet/modulebuilder.rb
+- lib/puppet/modulebuilder/builder.rb
+- lib/puppet/modulebuilder/version.rb
+- puppet-modulebuilder.gemspec
+homepage: https://github.com/puppetlabs/puppet-modulebuilder
+licenses: []
+metadata:
+  homepage_uri: https://github.com/puppetlabs/puppet-modulebuilder
+  source_code_uri: https://github.com/puppetlabs/puppet-modulebuilder
+  changelog_uri: https://github.com/puppetlabs/puppet-modulebuilder/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A gem to set up puppet-modulebuilder
+test_files: []