pdk 3.0.1 → 3.3.0

metadata

@@ -1,265 +1,237 @@
 --- !ruby/object:Gem::Specification
 name: pdk
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Puppet, Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-20 00:00:00.000000000 Z
+date: 2024-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 1.15.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 1.15.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: childprocess
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: cri
+  name: minitar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.15.11
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.15.11
-- !ruby/object:Gem::Dependency
-  name: diff-lcs
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: ffi
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.5
+        version: 2.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.5
+        version: 2.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: hitimes
+  name: cri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.15.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.15.11
 - !ruby/object:Gem::Dependency
-  name: json_pure
+  name: childprocess
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.3
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.3
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: json-schema
+  name: hitimes
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: minitar
+  name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.23'
 - !ruby/object:Gem::Dependency
-  name: pathspec
+  name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: tty-prompt
+  name: tty-which
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: tty-spinner
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: tty-which
+  name: puppet-modulebuilder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: concurrent-ruby
+  name: deep_merge
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.10
+        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.10
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
-  name: facter
+  name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
-  name: httpclient
+  name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.3
+        version: 2.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.3
+        version: 2.6.3
 - !ruby/object:Gem::Dependency
-  name: deep_merge
+  name: pathspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '1.1'
 description: A CLI to facilitate easy, unified development workflows for Puppet modules.
 email:
 - pdk-maintainers@puppet.com
@@ -273,10 +245,6 @@ files:
 - README.md
 - exe/pdk
 - lib/pdk.rb
-- lib/pdk/analytics.rb
-- lib/pdk/analytics/client/google_analytics.rb
-- lib/pdk/analytics/client/noop.rb
-- lib/pdk/analytics/util.rb
 - lib/pdk/answer_file.rb
 - lib/pdk/bolt.rb
 - lib/pdk/cli.rb
@@ -321,7 +289,6 @@ files:
 - lib/pdk/cli/util/update_manager_printer.rb
 - lib/pdk/cli/validate.rb
 - lib/pdk/config.rb
-- lib/pdk/config/analytics_schema.json
 - lib/pdk/config/errors.rb
 - lib/pdk/config/ini_file.rb
 - lib/pdk/config/ini_file_setting.rb
@@ -352,13 +319,11 @@ files:
 - lib/pdk/generate/transport.rb
 - lib/pdk/logger.rb
 - lib/pdk/module.rb
-- lib/pdk/module/build.rb
 - lib/pdk/module/convert.rb
 - lib/pdk/module/metadata.rb
 - lib/pdk/module/release.rb
 - lib/pdk/module/update.rb
 - lib/pdk/module/update_manager.rb
-- lib/pdk/monkey_patches.rb
 - lib/pdk/report.rb
 - lib/pdk/report/event.rb
 - lib/pdk/template.rb
@@ -418,7 +383,7 @@ homepage: https://github.com/puppetlabs/pdk
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -433,8 +398,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.17
+signing_key:
 specification_version: 4
 summary: A key part of the Puppet Development Kit, the shortest path to better modules
 test_files: []

data/lib/pdk/analytics/client/google_analytics.rb

@@ -1,141 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Analytics
-    module Client
-      class GoogleAnalytics
-        PROTOCOL_VERSION  = 1
-        TRACKING_URL      = 'https://google-analytics.com/collect'.freeze
-        CUSTOM_DIMENSIONS = {
-          operating_system: :cd1,
-          output_format: :cd2,
-          ruby_version: :cd3,
-          cli_options: :cd4,
-          env_vars: :cd5
-        }.freeze
-
-        attr_reader :user_id, :logger, :app_name, :app_id, :app_version, :app_installer
-
-        def initialize(opts)
-          # lazy-load expensive gem code
-          require 'concurrent/configuration'
-          require 'concurrent/future'
-          require 'httpclient'
-          require 'locale'
-          require 'pdk/analytics/util'
-
-          @http = HTTPClient.new
-          @user_id = opts[:user_id]
-          @executor = Concurrent.global_io_executor
-          @os = PDK::Analytics::Util.fetch_os_async
-          @logger = opts[:logger]
-          @app_name = opts[:app_name]
-          @app_id = opts[:app_id]
-          @app_version = opts[:app_version]
-          @app_installer = opts[:app_installer]
-        end
-
-        def screen_view(screen, **kwargs)
-          custom_dimensions = walk_keys(kwargs) do |k|
-            CUSTOM_DIMENSIONS[k] || raise(format("Unknown analytics key '%{key}'", key: k))
-          end
-
-          screen_view_params = {
-            # Type
-            t: 'screenview',
-            # Screen Name
-            cd: screen
-          }.merge(custom_dimensions)
-
-          submit(base_params.merge(screen_view_params))
-        end
-
-        def event(category, action, label: nil, value: nil, **kwargs)
-          custom_dimensions = walk_keys(kwargs) do |k|
-            CUSTOM_DIMENSIONS[k] || raise(format("Unknown analytics key '%{key}'", key: k))
-          end
-
-          event_params = {
-            # Type
-            t: 'event',
-            # Event Category
-            ec: category,
-            # Event Action
-            ea: action
-          }.merge(custom_dimensions)
-
-          # Event Label
-          event_params[:el] = label if label
-          # Event Value
-          event_params[:ev] = value if value
-
-          submit(base_params.merge(event_params))
-        end
-
-        def submit(params)
-          # Handle analytics submission in the background to avoid blocking the
-          # app or polluting the log with errors
-          Concurrent::Future.execute(executor: @executor) do
-            require 'json'
-
-            logger.debug "Submitting analytics: #{JSON.pretty_generate(params)}"
-            @http.post(TRACKING_URL, params)
-            logger.debug 'Completed analytics submission'
-          end
-        end
-
-        # These parameters have terrible names. See this page for complete documentation:
-        # https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
-        def base_params
-          require 'locale'
-
-          {
-            v: PROTOCOL_VERSION,
-            # Client ID
-            cid: user_id,
-            # Tracking ID
-            tid: app_id,
-            # Application Name
-            an: app_name,
-            # Application Version
-            av: app_version,
-            # Application Installer ID
-            aiid: app_installer,
-            # Anonymize IPs
-            aip: true,
-            # User locale
-            ul: Locale.current.to_rfc,
-            # Custom Dimension 1 (Operating System)
-            cd1: @os.value
-          }
-        end
-
-        # If the user is running a very fast command, there may not be time for
-        # analytics submission to complete before the command is finished. In
-        # that case, we give a little buffer for any stragglers to finish up.
-        # 250ms strikes a balance between accomodating slower networks while not
-        # introducing a noticeable "hang".
-        def finish
-          @executor.shutdown
-          @executor.wait_for_termination(0.25)
-        end
-
-        private
-
-        def walk_keys(data, &block)
-          case data
-          when Hash
-            data.each_with_object({}) do |(k, v), acc|
-              v = walk_keys(v, &block)
-              acc[yield(k)] = v
-            end
-          when Array
-            data.map { |v| walk_keys(v, &block) }
-          else
-            data
-          end
-        end
-      end
-    end
-  end
-end

data/lib/pdk/analytics/client/noop.rb

@@ -1,25 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Analytics
-    module Client
-      class Noop
-        attr_reader :logger
-
-        def initialize(opts)
-          @logger = opts[:logger]
-        end
-
-        def screen_view(screen, **_kwargs)
-          logger.debug "Skipping submission of '#{screen}' screenview because analytics is disabled"
-        end
-
-        def event(category, action, **_kwargs)
-          logger.debug "Skipping submission of '#{category} #{action}' event because analytics is disabled"
-        end
-
-        def finish; end
-      end
-    end
-  end
-end

data/lib/pdk/analytics/util.rb

@@ -1,18 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Analytics
-    module Util
-      def self.fetch_os_async
-        require 'concurrent/configuration'
-        require 'concurrent/future'
-
-        Concurrent::Future.execute(executor: :io) do
-          os = Facter.value('os')
-
-          os.nil? ? 'unknown' : "#{os['name']} #{os.fetch('release', {}).fetch('major', '')}".strip
-        end
-      end
-    end
-  end
-end

data/lib/pdk/analytics.rb

@@ -1,30 +0,0 @@
-require 'pdk'
-
-autoload :Logger, 'logger'
-
-module PDK
-  module Analytics
-    autoload :Util, 'pdk/analytics/util'
-
-    module Client
-      autoload :Noop, 'pdk/analytics/client/noop'
-      autoload :GoogleAnalytics, 'pdk/analytics/client/google_analytics'
-    end
-
-    def self.build_client(opts = {})
-      opts[:logger] ||= ::Logger.new($stderr)
-      opts[:client] ||= :noop
-
-      if opts[:disabled]
-        opts[:logger].debug 'Analytics opt-out is set, analytics will be disabled'
-        opts[:client] = :noop
-      end
-
-      client_const = opts[:client].to_s.split('_').map(&:capitalize).join
-      PDK::Analytics::Client.const_get(client_const).new(opts)
-    rescue StandardError => e
-      opts[:logger].debug "Failed to initialize analytics client, analytics will be disabled: #{e}"
-      PDK::Analytics::Client::Noop.new(opts)
-    end
-  end
-end

data/lib/pdk/config/analytics_schema.json

@@ -1,26 +0,0 @@
-{
-  "definitions": {},
-  "$schema": "http://json-schema.org/draft-06/schema#",
-  "$id": "http://puppet.com/schema/does_not_exist.json",
-  "type": "object",
-  "title": "The PDK Analytics YAML Schema",
-  "properties": {
-    "disabled": {
-      "$id": "#/properties/disabled",
-      "type": "boolean",
-      "title": "Disabled property",
-      "examples": [
-        false
-      ]
-    },
-    "user-id": {
-      "$id": "#/properties/user-id",
-      "type": "string",
-      "title": "The User-id for analytics",
-      "examples": [
-        "cb9ed65f-37dc-48d8-9863-8bd09cbb61c7"
-      ],
-      "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$"
-    }
-  }
-}