puppet-modulebuilder 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e3b99ce5da4071720566c77f44583561146cc8eb93f067b46df09b41a496f9a
-  data.tar.gz: 8d414dcd3940dc02f5fe0a6580a5b52be4a24e4249869488d7c64816d51e1c25
+  metadata.gz: 05a8a7a5f6a232a88809f50d10b4a9c4dee9b4a425e29612ca2309919c0d6fc9
+  data.tar.gz: 27d621ca9b24fa55b1da29a1e53b2280c3d67d74e261ae423509cd63b7f37bd9
 SHA512:
-  metadata.gz: 72f79579ecefd1fa236f084d811b670c62ba06468270fd88689d086d47868e23287e22634e3b0f1aec81463d9fc2c47a6b96b179b1b822305448dd2c45e603a2
-  data.tar.gz: 83e3c4375ae4f14be9a27b960042a377debee4479ace71ba697faddac636b1317df151652d087d30d77a8cdff339a73c868195a2831a143bc43468042be8744d
+  metadata.gz: af2ac39ef0e40a3000b5a252375f0e448e2aee455e96f1a9cbac8d0a5b72d905febbf24a29dd8a71bbc9d469559c21aaac0384815a784a3b7c93dccd6a3a6b20
+  data.tar.gz: 3a78db102c55cda296dd9619533e53516e067348789183c4bcc5b1a7a846107af5d2f368a10e15a2e23cda62bcbde23a59e730a9019f15e02a0630bac2833db4

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-06-28 12:03:58 UTC using RuboCop version 1.64.1.
+# on 2024-07-05 11:25:28 UTC using RuboCop version 1.64.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -11,7 +11,7 @@ Lint/MixedRegexpCaptureTypes:
   Exclude:
     - 'Gemfile'
 
-# Offense count: 4
+# Offense count: 2
 # Configuration parameters: Prefixes, AllowedPatterns.
 # Prefixes: when, with, without
 RSpec/ContextWording:
@@ -34,24 +34,24 @@ RSpec/MessageSpies:
 RSpec/MultipleExpectations:
   Max: 11
 
-# Offense count: 13
+# Offense count: 8
 # Configuration parameters: AllowSubject.
 RSpec/MultipleMemoizedHelpers:
   Max: 8
 
-# Offense count: 8
+# Offense count: 5
 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
 # SupportedStyles: always, named_only
 RSpec/NamedSubject:
   Exclude:
     - 'spec/unit/puppet/modulebuilder/builder_spec.rb'
 
-# Offense count: 3
+# Offense count: 1
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
-  Max: 5
+  Max: 4
 
-# Offense count: 32
+# Offense count: 28
 RSpec/SubjectStub:
   Exclude:
     - 'spec/unit/puppet/modulebuilder/builder_spec.rb'

data/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
 
+## [v2.0.0](https://github.com/puppetlabs/puppet-modulebuilder/tree/v2.0.0) - 2024-09-17
+
+[Full Changelog](https://github.com/puppetlabs/puppet-modulebuilder/compare/v1.1.0...v2.0.0)
+
+### Changed
+
+- Implement allowlist for puppet module content [#79](https://github.com/puppetlabs/puppet-modulebuilder/pull/79) ([bastelfreak](https://github.com/bastelfreak))
+
 ## [v1.1.0](https://github.com/puppetlabs/puppet-modulebuilder/tree/v1.1.0) - 2024-09-17
 
 [Full Changelog](https://github.com/puppetlabs/puppet-modulebuilder/compare/v1.0.0...v1.1.0)

data/lib/puppet/modulebuilder/builder.rb

@@ -5,15 +5,29 @@ require 'logger'
 module Puppet::Modulebuilder
   # Class to build Puppet Modules from source
   class Builder
-    DEFAULT_IGNORED = [
+    # Due to the way how PathSpec generates the regular expression,
+    # `/*` doesn't match directories starting with a dot,
+    # so we need `/.*` as well.
+    IGNORED = [
+      '/**',
       '/.*',
-      '/pkg/',
-      '~*',
-      '/coverage',
-      '/checksums.json',
-      '/REVISION',
-      '/spec/fixtures/modules/',
-      '/vendor/',
+      '!/CHANGELOG*',
+      '!/LICENSE',
+      '!/README*',
+      '!/REFERENCE.md',
+      '!/bolt_plugin.json',
+      '!/data/**',
+      '!/docs/**',
+      '!/files/**',
+      '!/hiera.yaml',
+      '!/locales/**',
+      '!/manifests/**',
+      '!/metadata.json',
+      '!/plans/**',
+      '!/scripts/**',
+      '!/tasks/**',
+      '!/templates/**',
+      '!/types/**',
     ].freeze
 
     attr_reader :destination, :logger
@@ -168,21 +182,6 @@ module Puppet::Modulebuilder
                          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
@@ -251,20 +250,10 @@ module Puppet::Modulebuilder
     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
-
-          ignored = ignored.add("/#{File.basename(destination)}/") if File.realdirpath(destination).start_with?(File.realdirpath(source))
+      ignored = PathSpec.new(IGNORED)
+      ignored.add("/#{File.basename(destination)}/") if File.realdirpath(destination).start_with?(File.realdirpath(source))
 
-          DEFAULT_IGNORED.each { |r| ignored.add(r) }
-
-          ignored
-        end
+      ignored
     end
 
     # Create a temporary build directory where the files to be included in

data/lib/puppet/modulebuilder/version.rb

@@ -2,6 +2,6 @@
 
 module Puppet
   module Modulebuilder
-    VERSION = '1.1.0'
+    VERSION = '2.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-modulebuilder
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Sheena