Module: PDK

Defined in:
lib/pdk.rb,
lib/pdk/util.rb,
lib/pdk/config.rb,
lib/pdk/logger.rb,
lib/pdk/module.rb,
lib/pdk/report.rb,
lib/pdk/version.rb,
lib/pdk/cli/exec.rb,
lib/pdk/cli/util.rb,
lib/pdk/generate.rb,
lib/pdk/util/git.rb,
lib/pdk/validate.rb,
lib/pdk/analytics.rb,
lib/pdk/cli/errors.rb,
lib/pdk/tests/unit.rb,
lib/pdk/answer_file.rb,
lib/pdk/config/json.rb,
lib/pdk/config/yaml.rb,
lib/pdk/module/build.rb,
lib/pdk/report/event.rb,
lib/pdk/util/bundler.rb,
lib/pdk/util/version.rb,
lib/pdk/util/windows.rb,
lib/pdk/config/errors.rb,
lib/pdk/generate/task.rb,
lib/pdk/module/update.rb,
lib/pdk/template_file.rb,
lib/pdk/analytics/util.rb,
lib/pdk/cli/exec_group.rb,
lib/pdk/config/setting.rb,
lib/pdk/module/convert.rb,
lib/pdk/generate/module.rb,
lib/pdk/module/metadata.rb,
lib/pdk/util/filesystem.rb,
lib/pdk/cli/exec/command.rb,
lib/pdk/config/namespace.rb,
lib/pdk/generate/provider.rb,
lib/pdk/util/ruby_version.rb,
lib/pdk/util/template_uri.rb,
lib/pdk/cli/util/interview.rb,
lib/pdk/generate/transport.rb,
lib/pdk/module/templatedir.rb,
lib/pdk/util/vendored_file.rb,
lib/pdk/util/puppet_strings.rb,
lib/pdk/util/puppet_version.rb,
lib/pdk/validate/tasks/name.rb,
lib/pdk/validate/yaml/syntax.rb,
lib/pdk/analytics/client/noop.rb,
lib/pdk/generate/defined_type.rb,
lib/pdk/generate/puppet_class.rb,
lib/pdk/module/update_manager.rb,
lib/pdk/validate/ruby/rubocop.rb,
lib/pdk/generate/puppet_object.rb,
lib/pdk/config/json_with_schema.rb,
lib/pdk/config/yaml_with_schema.rb,
lib/pdk/validate/base_validator.rb,
lib/pdk/validate/ruby_validator.rb,
lib/pdk/validate/yaml_validator.rb,
lib/pdk/validate/tasks_validator.rb,
lib/pdk/cli/util/option_validator.rb,
lib/pdk/validate/puppet_validator.rb,
lib/pdk/cli/util/option_normalizer.rb,
lib/pdk/config/json_schema_setting.rb,
lib/pdk/validate/puppet/puppet_epp.rb,
lib/pdk/cli/util/command_redirector.rb,
lib/pdk/validate/metadata_validator.rb,
lib/pdk/validate/puppet/puppet_lint.rb,
lib/pdk/cli/exec/interactive_command.rb,
lib/pdk/config/json_schema_namespace.rb,
lib/pdk/validate/tasks/metadata_lint.rb,
lib/pdk/validate/puppet/puppet_syntax.rb,
lib/pdk/analytics/client/google_analytics.rb,
lib/pdk/validate/metadata/metadata_syntax.rb,
lib/pdk/validate/metadata/metadata_json_lint.rb

Defined Under Namespace

Modules: Analytics, CLI, Generate, Module, Test, Util, Validate Classes: AnswerFile, Config, Logger, Report, TemplateFile

Constant Summary collapse

VERSION = 
'1.14.0'.freeze
TEMPLATE_REF = 
VERSION

Class Method Summary collapse

Class Method Details

.analytics ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/pdk/analytics.rb', line 5

def self.analytics
  require 'pdk/config'
  require 'pdk/logger'
  require 'pdk/util'
  require 'pdk/version'

  @analytics ||= PDK::Analytics.build_client(
    logger:        PDK.logger,
    disabled:      ENV['PDK_DISABLE_ANALYTICS'] || PDK.config.user['analytics']['disabled'],
    user_id:       PDK.config.user['analytics']['user-id'],
    app_id:        "UA-139917834-#{PDK::Util.development_mode? ? '2' : '1'}",
    client:        :google_analytics,
    app_name:      'pdk',
    app_version:   PDK::VERSION,
    app_installer: PDK::Util.package_install? ? 'package' : 'gem',
  )
end

.answer_file=(path) ⇒ Object

Specify the path to a custom answer file that the PDK should use.

Parameters:

  • path (String) —

    A path on disk to the file where the PDK should store answers to interactive questions.



16
17
18
 
# File 'lib/pdk/answer_file.rb', line 16

def self.answer_file=(path)
  @answer_file = PDK::AnswerFile.new(path)
end

.answers ⇒ PDK::AnswerFile

Singleton accessor to the current answer file being used by the PDK.

Returns:

  • (PDK::AnswerFile) —

    The AnswerFile instance currently being used by the PDK.



8
9
10
 
# File 'lib/pdk/answer_file.rb', line 8

def self.answers
  @answer_file ||= PDK::AnswerFile.new
end

.config ⇒ Object 



9
10
11
 
# File 'lib/pdk/config.rb', line 9

def self.config
  @config ||= PDK::Config.new
end

.logger ⇒ Object 



4
5
6
 
# File 'lib/pdk/logger.rb', line 4

def self.logger
  @logger ||= PDK::Logger.new
end