pdk-akerl 1.8.0.1

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,133 @@
+**Fork of https://github.com/puppetlabs/pdk**:
+
+Changes from upstream:
+
+* Addition of this notice
+* Gem name changed to pdk-akerl
+* Addition of .prospectus file
+* Update of Bundler and Ruby dependencies (https://github.com/puppetlabs/pdk/pull/610)
+
+# pdk [![Build Status](https://travis-ci.org/puppetlabs/pdk.svg?branch=master)](https://travis-ci.org/puppetlabs/pdk) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/x70e2fqllbaootpd?svg=true)](https://ci.appveyor.com/project/puppetlabs/pdk) [![Coverage Status](https://coveralls.io/repos/github/puppetlabs/pdk/badge.svg?branch=master)](https://coveralls.io/github/puppetlabs/pdk?branch=master)
+
+* [Installation](#installation)
+* [Basic usage](#basic-usage)
+* [Experimental features](#experimental-features)
+* [Module compatibility](#module-compatibility)
+* [Contributing](#contributing)
+* [Contact Information](#contact-information)
+
+The Puppet Development Kit (PDK) includes key Puppet code development and testing tools for Linux, Windows, and OS X workstations, so you can install one package with the tools you need to create and validate new modules.
+
+PDK includes testing tools, a complete module skeleton, and command line tools to help you create, validate, and run tests on Puppet modules. PDK also includes all dependencies needed for its use.
+
+PDK includes the following tools:
+
+Tool   | Description
+----------------|-------------------------
+metadata-json-lint | Validates and lints `metadata.json` files in modules against  Puppet's module metadatastyle guidelines.
+pdk | Command line tool for generating and testing modules
+puppet-lint | Checks your Puppet code against the recommendations in the Puppet Language style guide.
+puppet-syntax | Checks for correct syntax in Puppet manifests, templates, and Hiera YAML.
+puppetlabs_spec_helper | Provides classes, methods, and Rake tasks to help with spec testing Puppet code.
+rspec-puppet | Tests the behavior of Puppet when it compiles your manifests into a catalog of Puppet resources.
+rspec-puppet-facts | Adds support for running rspec-puppet tests against the facts for your supported operating systems.
+
+
+## Installation
+
+Download and install the newest package matching your platform from the [download](https://puppet.com/download-puppet-development-kit) page. If you are using Windows, remember to close any open PowerShell windows.
+
+For complete installation information, see the [PDK documentation](https://puppet.com/docs/pdk/latest/pdk_install.html).
+
+## Basic usage
+
+PDK can generate modules and classes, validate module metadata, style, and syntax, and run unit tests. This README contains very basic usage information---for complete usage information, see the [PDK documentation](https://puppet.com/docs/pdk/latest/pdk_install.html).
+
+### Generate a module
+
+Generates the basic components of a module and set up an infrastructure for testing it with PDK.
+
+1. Run the `pdk new module` command, specifying the name of the new module:
+
+```
+pdk new module my_module
+```
+
+This command asks a series of metadata questions and then generates the basic components of a new module.
+
+### Generate a class
+
+To generate a class in your module, use the `pdk new class` command, specifying the name of your new class. To generate the main class of the module, which is defined in an `init.pp` file, give the class the same name as the module.
+
+1. From the command line, in your module's directory, run:
+```
+pdk new class class_name
+```
+
+PDK creates the new class manifest and a test file (as `class_name_spec.rb`) in your module's `/spec/classes` directory.
+
+### Generate a defined type
+
+To generate a defined type in your module, use the `pdk new defined_type` command, specifying the name of your new defined type.
+
+1. From the command line, in your module's directory, run:
+```
+pdk new defined_type defined_type_name
+```
+
+PDK creates the new defined\_type manifest and a test file (as `defined_type_name_spec.rb`) in your module's `/spec/defines` directory.
+
+### Generate a task
+
+To generate a task in your module, use the `pdk new task` command, specifying the name of your new task.
+
+1. From the command line, in your module's directory, run:
+```
+pdk new task task_name
+```
+
+PDK creates the new task file and metadata.
+
+### Validating a module
+
+PDK can validate the well-formedness of the module and style and syntax of its files.
+
+1. In the module's directory, run:
+
+```
+pdk validate
+```
+
+This command validates the metadata, Puppet code syntax and style, and Ruby syntax and style for the entire module.
+
+### Run unit tests
+
+PDK's [default template](https://github.com/puppetlabs/pdk-templates) sets up [rspec](http://rspec.info/) for Ruby-level unit testing, and [rspec-puppet](https://github.com/rodjek/rspec-puppet/) for catalog-level unit testing.
+
+In the module's directory, run unit tests with:
+
+```
+pdk test unit
+```
+
+This command runs all available unit tests.
+
+## Experimental features
+
+### `pdk bundle` command
+
+This command executes arbitrary commands in a bundler context within the module you're currently working on. Arguments to this command are passed straight through to bundler. This command is experimental  and can lead to errors that can't be resolved by the pdk itself.
+
+Note that for most uses, you must use the `--` to separate bundler options from pdk options. Compare the following two commands:
+
+## Module Compatibility
+
+**PDK Version Compatibility:** Modules created with PDK version validate against and run on all Puppet and Ruby version combinations currently under maintenance (see https://docs.puppet.com/puppet/latest/about_agent.html and https://puppet.com/misc/puppet-enterprise-lifecycle)
+
+## Contributing
+
+PDK encourages community contributions. See the [CONTRIBUTING.md](CONTRIBUTING.md) file for development notes.
+
+## Contact Information
+
+To contact us with questions: [pdk-maintainers@puppet.com](mailto:pdk-maintainers@puppet.com)

data/exe/pdk

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'pdk/cli'
+
+begin
+  PDK::CLI.run(ARGV)
+rescue Interrupt
+  warn "\nAborted!"
+  exit 1
+end

data/lib/pdk.rb

@@ -0,0 +1,10 @@
+require 'pdk/answer_file'
+require 'pdk/generate'
+require 'pdk/i18n'
+require 'pdk/logger'
+require 'pdk/report'
+require 'pdk/template_file'
+require 'pdk/validate'
+require 'pdk/version'
+
+module PDK; end

data/lib/pdk/answer_file.rb

@@ -0,0 +1,121 @@
+require 'json'
+require 'pdk/util/filesystem'
+
+module PDK
+  # Singleton accessor to the current answer file being used by the PDK.
+  #
+  # @return [PDK::AnswerFile] The AnswerFile instance currently being used by
+  #   the PDK.
+  def self.answers
+    @answer_file ||= PDK::AnswerFile.new
+  end
+
+  # Specify the path to a custom answer file that the PDK should use.
+  #
+  # @param path [String] A path on disk to the file where the PDK should store
+  #   answers to interactive questions.
+  def self.answer_file=(path)
+    @answer_file = PDK::AnswerFile.new(path)
+  end
+
+  class AnswerFile
+    attr_reader :answers
+    attr_reader :answer_file_path
+
+    include PDK::Util::Filesystem
+
+    # Initialises the AnswerFile object, which stores the responses to certain
+    # interactive questions.
+    #
+    # @param answer_file_path [String, nil] The path on disk to the file where
+    #   the answers will be stored and read from. If not specified (or `nil`),
+    #   the default path will be used (see #default_answer_file_path).
+    #
+    # @raise (see #read_from_disk)
+    def initialize(answer_file_path = nil)
+      @answer_file_path = answer_file_path || default_answer_file_path
+      @answers = read_from_disk
+    end
+
+    # Retrieve the stored answer to a question.
+    #
+    # @param question [String] The question name/identifying string.
+    #
+    # @return [Object] The answer to the question, or `nil` if no answer found.
+    def [](question)
+      answers[question]
+    end
+
+    # Update the stored answers in memory and then save them to disk.
+    #
+    # @param new_answers [Hash{String => Object}] The new questions and answers
+    #   to be merged into the existing answers.
+    #
+    # @raise [PDK::CLI::FatalError] if the new answers are not provided as
+    #   a Hash.
+    # @raise (see #save_to_disk)
+    def update!(new_answers = {})
+      unless new_answers.is_a?(Hash)
+        raise PDK::CLI::FatalError, _('Answer file can be updated only with a Hash')
+      end
+
+      answers.merge!(new_answers)
+
+      save_to_disk
+    end
+
+    private
+
+    # Determine the default path to the answer file.
+    #
+    # @return [String] The path on disk to the default answer file.
+    def default_answer_file_path
+      File.join(PDK::Util.cachedir, 'answers.json')
+    end
+
+    # Read existing answers into memory from the answer file on disk.
+    #
+    # @raise [PDK::CLI::FatalError] If the answer file exists but can not be
+    #   read.
+    #
+    # @return [Hash{String => Object}] The existing questions and answers.
+    def read_from_disk
+      return {} if !File.file?(answer_file_path) || File.zero?(answer_file_path)
+
+      unless File.readable?(answer_file_path)
+        raise PDK::CLI::FatalError, _("Unable to open '%{file}' for reading") % {
+          file: answer_file_path,
+        }
+      end
+
+      answers = JSON.parse(File.read(answer_file_path))
+      if answers.is_a?(Hash)
+        answers
+      else
+        PDK.logger.warn _("Answer file '%{path}' did not contain a valid set of answers, recreating it") % {
+          path: answer_file_path,
+        }
+        {}
+      end
+    rescue JSON::JSONError
+      PDK.logger.warn _("Answer file '%{path}' did not contain valid JSON, recreating it") % {
+        path: answer_file_path,
+      }
+      {}
+    end
+
+    # Save the in memory answer set to the answer file on disk.
+    #
+    # @raise [PDK::CLI::FatalError] if the answer file can not be written to.
+    def save_to_disk
+      FileUtils.mkdir_p(File.dirname(answer_file_path))
+
+      write_file(answer_file_path, JSON.pretty_generate(answers))
+    rescue SystemCallError, IOError => e
+      raise PDK::CLI::FatalError, _("Unable to write '%{file}': %{msg}") % {
+        file: answer_file_path,
+        msg:  e.message,
+      }
+    end
+  end
+end