puppet-strings 2.4.0 → 2.5.0

data/Rakefile

@@ -1,160 +0,0 @@
-if Bundler.rubygems.find_name('puppet_litmus').any?
-  require 'puppet_litmus/rake_tasks'
-
-  # This is a _really_ horrible monkey-patch to fix up https://github.com/puppetlabs/bolt/issues/1614
-  # Based on resolution https://github.com/puppetlabs/bolt/pull/1620
-  # This can be removed once this is fixed, released into Bolt and into Litmus
-  require 'bolt_spec/run'
-  module BoltSpec
-    module Run
-      class BoltRunner
-        class << self
-          alias_method :original_with_runner, :with_runner
-        end
-
-        def self.with_runner(config_data, inventory_data)
-          original_with_runner(deep_duplicate_object(config_data), deep_duplicate_object(inventory_data)) { |runner| yield runner }
-        end
-
-        # From https://github.com/puppetlabs/pdk/blob/master/lib/pdk/util.rb
-        # Workaround for https://github.com/puppetlabs/bolt/issues/1614
-        def self.deep_duplicate_object(object)
-          if object.is_a?(Array)
-            object.map { |item| deep_duplicate_object(item) }
-          elsif object.is_a?(Hash)
-            hash = object.dup
-            hash.each_pair { |key, value| hash[key] = deep_duplicate_object(value) }
-            hash
-          else
-            object
-          end
-        end
-      end
-    end
-  end
-end
-
-require 'puppetlabs_spec_helper/tasks/fixtures'
-require 'bundler/gem_tasks'
-require 'puppet-lint/tasks/puppet-lint'
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.exclude_pattern = "spec/acceptance/**/*.rb"
-end
-
-# Add our own tasks
-require 'puppet-strings/tasks'
-
-PuppetLint.configuration.send('disable_80chars')
-PuppetLint.configuration.ignore_paths = %w(acceptance/**/*.pp spec/**/*.pp pkg/**/*.pp)
-
-desc 'Validate Ruby source files and ERB templates.'
-task :validate do
-  Dir['spec/**/*.rb','lib/**/*.rb'].each do |ruby_file|
-    sh "ruby -c #{ruby_file}" unless ruby_file =~ /spec\/fixtures/
-  end
-  Dir['lib/puppet-strings/yard/templates/**/*.erb'].each do |template|
-    sh "erb -P -x -T '-' #{template} | ruby -c"
-  end
-end
-
-namespace :litmus do
-  def install_remote_gem(gem_name, target_nodes, inventory_hash)
-    # TODO: Currently this is Linux only
-    install_command = "/opt/puppetlabs/puppet/bin/gem install #{gem_name}"
-    result = run_command(install_command, target_nodes, config: nil, inventory: inventory_hash)
-    if result.is_a?(Array)
-      result.each do |node|
-        puts "#{node['node']} failed #{node['result']}" if node['status'] != 'success'
-      end
-    else
-      raise "Failed trying to run '#{install_command}' against inventory."
-    end
-  end
-
-  # Install the gem under test and required fixture on a collection of nodes
-  #
-  # @param :target_node_name [Array] nodes on which to install a puppet module for testing.
-  desc 'install_gems - build and install module fixtures'
-  task :install_gems, [:target_node_name] do |_task, args|
-    inventory_hash = inventory_hash_from_inventory_file
-    target_nodes = find_targets(inventory_hash, args[:target_node_name])
-    if target_nodes.empty?
-      puts 'No targets found'
-      exit 0
-    end
-    require 'bolt_spec/run'
-    include BoltSpec::Run
-
-    # Build the gem
-    `gem build puppet-strings.gemspec --quiet`
-    result = $CHILD_STATUS
-    raise "Unable to build the puppet-strings gem. Returned exit code #{result.exitstatus}" unless result.exitstatus.zero?
-    puts 'Built'
-    # Find the gem build artifact
-    gem_tar = Dir.glob('puppet-strings-*.gem').max_by { |f| File.mtime(f) }
-    raise "Unable to find package in 'puppet-strings-*.gem'" if gem_tar.nil?
-    gem_tar = File.expand_path(gem_tar)
-
-    target_string = if args[:target_node_name].nil?
-                      'all'
-                    else
-                      args[:target_node_name]
-                    end
-    # TODO: Currently this is Linux targets only. no windows localhost
-    tmp_path = '/tmp/'
-    puts 'Copying gem to targets...'
-    run_local_command("bolt file upload #{gem_tar} #{tmp_path}#{File.basename(gem_tar)} --targets #{target_string} --inventoryfile inventory.yaml")
-
-    # Install dependent gems
-    puts 'Installing yard gem...'
-    install_remote_gem('yard', target_nodes, inventory_hash)
-    puts 'Installing rgen gem...'
-    install_remote_gem('rgen', target_nodes, inventory_hash)
-    # Install puppet-strings
-    puts 'Installing puppet-strings gem...'
-    install_remote_gem(tmp_path + File.basename(gem_tar), target_nodes, inventory_hash)
-    puts 'Installed'
-  end
-end
-
-task(:rubocop) do
-  require 'rubocop'
-  cli = RuboCop::CLI.new
-  result = cli.run(%w(-D -f s))
-  abort unless result == RuboCop::CLI::STATUS_SUCCESS
-end
-
-#### CHANGELOG ####
-begin
-  require 'github_changelog_generator/task'
-  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    require 'puppet-strings/version'
-    config.future_release = "v#{PuppetStrings::VERSION}"
-    config.header = "# Changelog\n\n" \
-      "All significant changes to this repo will be summarized in this file.\n"
-    config.configure_sections = {
-          added: {
-            prefix: "Added",
-            labels: ["enhancement"]
-          },
-          fixed: {
-            prefix: "Fixed",
-            labels: ["bugfix"]
-          },
-          breaking: {
-            prefix: "Changed",
-            labels: ["backwards-incompatible"]
-          }
-        }
-    config.exclude_labels = ['maintenance','incomplete']
-    config.user = 'puppetlabs'
-    config.project = 'puppet-strings'
-  end
-rescue LoadError
-  desc 'Install github_changelog_generator to get access to automatic changelog generation'
-  task :changelog do
-    raise 'Install github_changelog_generator to get access to automatic changelog generation'
-  end
-end

data/codecov.yml

@@ -1,3 +0,0 @@
----
-# disable comments, info can be gotten from the pr status updates, and the comment editing spams the hipchat notifications
-comment: false

data/misc/ANNOUNCEMENT_TEMPLATE.md

@@ -1,40 +0,0 @@
-Send out announcements for major new feature releases, and high-impact bugfixes to <puppet-announce@googlegroups.com>, <puppet-dev@googlegroups.com>, <puppet-users@googlegroups.com>, <voxpupuli@groups.io>, and the puppet internal mailing lists <dev@puppet.com> and <tech-discuss@puppet.com>.
-
-Before sending, do check that all links are still valid. Feel free to adjust the text to match better with the circumstances of the release, or add other news that are relevant at the time. If you make changes, consider committing them here, for the benefit of future-you.
-
-The github rendering of the markdown seems to copy&paste acceptably into Google Inbox.
-
-The [CHANGELOG](https://github.com/puppetlabs/puppet-strings/blob/master/CHANGELOG.md) is a good starting point for finding enhancements and bug-fixes.
-
----
-
-Subject: [ANN] Puppet Strings vX.Y.Z Release
-
-Hi all,
-
-We're pleased to announce that version X.Y.Z of the Puppet Strings is being released today.
-
-Puppet Strings provides a simple way to extract source documentation into useful docs. It is provided as a Ruby gem to be referenced within modules. See the [README](https://github.com/puppetlabs/puppet-strings#installing-puppet-strings) for documentation on how to install and use it.
-
-
-The new release of Puppet Strings provides the following enhancements:
-
-* A
-* B
-* C
-
-The new release also contains the following notable bugfixes:
-
-* D
-* E
-* F
-
-See the [CHANGELOG](https://github.com/puppetlabs/puppet-strings/blob/master/CHANGELOG.md) for a full list of changes
-
-We encourage all module developers to review puppet-strings and use it when creating modules.
-
-Please let us know of your experiences with Puppet Strings, either here, on [Slack](https://slack.puppet.com/) (#forge-modules), or on the [github repo](https://github.com/puppetlabs/puppet-strings).
-
-
-Thanks,
-YOUR NAME

data/spec/acceptance/emit_json_options_spec.rb

@@ -1,69 +0,0 @@
-require 'spec_helper_acceptance'
-
-describe 'Emitting JSON' do
-  before(:all) do
-    @test_module_path = sut_module_path(/Module test/)
-    @remote_tmp_path = sut_tmp_path
-  end
-
-  let(:expected) do
-    {
-      "puppet_classes" => [],
-      "data_types" => [],
-      "data_type_aliases" => [],
-      "defined_types" => [],
-      "resource_types" => [],
-      "providers" => [],
-      "puppet_functions" => [
-        "name" => "function3x",
-        "file" => "#{@test_module_path}/lib/puppet/parser/functions/function3x.rb",
-        "line" => 1,
-        "type" => "ruby3x",
-        "signatures" => [
-          {
-            "signature" =>"function3x()",
-            "docstring" => {
-              "text" => "This is the function documentation for `function3x`",
-              "tags" => [
-                {
-                  "tag_name"=>"return",
-                  "text"=>"",
-                  "types"=>["Any"]
-                }
-              ]
-            }
-          },
-        ],
-        "docstring" => {
-          "text" => "This is the function documentation for `function3x`",
-          "tags" => ["tag_name" => "return", "text" => "", "types" => ["Any"]]},
-          "source" => "Puppet::Parser::Functions.newfunction(:function3x, :doc => \"This is the function documentation for `function3x`\") do |args|\nend"
-      ],
-      "puppet_tasks" => [],
-      "puppet_plans" => []
-    }
-  end
-
-  [
-    { :title => '--format json and STDOUT', :cmd_line => '--format json' },
-    { :title => '--emit-json-stdout', :cmd_line => '--emit-json-stdout' }
-  ].each do |testcase|
-    it "should emit JSON to stdout when using #{testcase[:title]}" do
-      output = PuppetLitmus::PuppetHelpers.run_shell("puppet strings generate #{testcase[:cmd_line]} \"#{@test_module_path}/lib/puppet/parser/functions/function3x.rb\"").stdout.chomp
-      expect(JSON.parse(output)).to eq(expected)
-    end
-  end
-
-  [
-    { :title => '--format json and --out', :cmd_line => '--format json --out "TMPFILE"' },
-    { :title => '--emit-json', :cmd_line => '--emit-json "TMPFILE"' },
-  ].each do |testcase|
-    it "should write JSON to a file when using #{testcase[:title]}" do
-      tmpfile = File.join(@remote_tmp_path, 'json_output.json')
-      cmd = "puppet strings generate #{testcase[:cmd_line].gsub('TMPFILE', tmpfile)} \"#{@test_module_path}/lib/puppet/parser/functions/function3x.rb\""
-      PuppetLitmus::PuppetHelpers.run_shell(cmd)
-      output = JSON.parse(file(tmpfile).content)
-      expect(output).to eq(expected)
-    end
-  end
-end

data/spec/acceptance/generate_markdown_spec.rb

@@ -1,47 +0,0 @@
-require 'spec_helper_acceptance'
-
-describe 'Generating Markdown' do
-  before(:all) do
-    @test_module_path = sut_module_path(/Module test/)
-    @remote_tmp_path = sut_tmp_path
-  end
-
-  expected = <<-EOF
-# Reference
-
-## Classes
-* [`test`](#test): This class exists to serve as fixture data for testing the puppet strings face
-
-## Classes
-
-### test
-
-#### Examples
-```puppet
-class { "test": }
-```
-
-#### Parameters
-
-##### `package_name`
-
-The name of the package
-
-##### `service_name`
-
-The name of the service
-
-  EOF
-
-  it 'should render Markdown to stdout when using --format markdown' do
-    skip('This test is broken. Does not output to STDOUT by default.')
-    output = PuppetLitmus::PuppetHelpers.run_shell("puppet strings generate --format markdown \"#{@test_module_path}/manifests/init.pp\"").stdout.chomp
-    expect(output).to eq(expected)
-  end
-
-  it 'should write Markdown to a file when using --format markdown and --out' do
-    tmpfile = File.join(@remote_tmp_path, 'md_output.md')
-    remote = PuppetLitmus::PuppetHelpers.run_shell("puppet strings generate --format markdown --out \"#{tmpfile}\" \"#{@test_module_path}/manifests/init.pp\"")
-    expect(file(tmpfile)).to contain expected
-  end
-end

data/spec/acceptance/running_strings_generate_spec.rb

@@ -1,88 +0,0 @@
-require 'spec_helper_acceptance'
-include PuppetLitmus # rubocop:disable Style/MixinUsage This is fine
-
-describe 'Generating module documentation using generate action' do
-  before :all do
-    # TODO: Linux only
-    @sut_work_dir = PuppetLitmus::PuppetHelpers.run_shell("pwd").stdout.chomp
-
-    test_module_path = sut_module_path(/Module test/)
-    PuppetLitmus::PuppetHelpers.run_shell("puppet strings generate \"#{test_module_path}/**/*.{rb,pp}\"")
-  end
-
-  def expect_file_contain(path, expected_contents)
-    file_path = File.join(@sut_work_dir, path)
-    file_content = file(file_path).content
-    expected_contents.each do |expected|
-      expect(file_content).to include(expected)
-    end
-  end
-
-  it 'should generate documentation for manifests' do
-    expect_file_contain('doc/puppet_classes/test.html', ['Class: test'])
-  end
-
-  it 'should generate documentation for puppet functions' do
-    skip('This test is failing. Appear to be legitimate failures.')
-    expect_file_contain('doc/puppet_functions_puppet/test_3A_3Aadd.html', [
-      'Adds two integers together.',
-      # These tests are failing. Appear to be legitimate failures.
-      '<p>The first integer to add.</p>',
-      '<p>The second integer to add.</p>',
-      '<p>Returns the sum of x and y.</p>'
-    ])
-  end
-
-  it 'should generate documentation for 3x functions' do
-    expect_file_contain('doc/puppet_functions_ruby3x/function3x.html', ['This is the function documentation for <code>function3x</code>'])
-  end
-
-  it 'should generate documentation for 4x functions' do
-    expect_file_contain('doc/puppet_functions_ruby4x/function4x.html', ['This is a function which is used to test puppet strings'])
-  end
-
-  it 'should generate documentation for custom types' do
-    expect_file_contain('doc/puppet_types/database.html', [
-      '<p>An example server resource type.</p>',
-      '<p>The database file to use.</p>',
-      '<p>Documentation for a dynamic property.</p>',
-      '<p>The database server name.</p>',
-      '<p>Documentation for a dynamic parameter.</p>',
-      '<p>The provider supports encryption.</p>',
-    ])
-  end
-
-  it 'should generate documentation for custom providers' do
-    expect_file_contain('doc/puppet_providers_database/linux.html', [
-      'The database provider on Linux',
-      '<tt>osfamily &mdash; linux</tt>',
-      '<tt>database &mdash; /usr/bin/database</tt>',
-    ])
-  end
-
-  it 'should generate documentation for puppet data types' do
-    expect_file_contain('doc/puppet_types/database.html', [
-      'Resource Type: database',
-      'type/database.rb',
-      'An example server resource type.',
-    ])
-  end
-
-  it 'should generate documentation for puppet data type aliases' do
-    expect_file_contain('doc/puppet_data_type_aliases/Test_3A_3AElephant.html', [
-      'Data Type: Test::Elephant',
-      'types/elephant.pp',
-      'A simple elephant type.',
-    ])
-  end
-
-  it 'should generate documentation for enum tag' do
-    expect_file_contain('doc/puppet_classes/test.html', [
-      '<p class="tag_title">Enum Options (<tt>myenum</tt>):</p>',
-      '<span class="name">a</span>',
-      "&mdash; <div class='inline'>\n<p>Option A</p>\n</div>",
-      '<span class="name">b</span>',
-      "&mdash; <div class='inline'>\n<p>Option B</p>\n</div>",
-    ])
-  end
-end

data/spec/fixtures/acceptance/modules/test/functions/add.pp

@@ -1,9 +0,0 @@
-# Adds two integers together.
-# @param x The first integer to add.
-# @param y The second integer to add.
-# @return [Integer] Returns the sum of x and y.
-# @example Example of adding two integers.
-#   test::add(1, 2) => 3
-function test::add(Integer $x, Integer $y) {
-  $x + $y
-}

data/spec/fixtures/acceptance/modules/test/lib/puppet/functions/4x_function.rb

@@ -1,5 +0,0 @@
-# function 4x
-#
-# This is a function which is used to test puppet strings
-Puppet::Functions.create_function(:function4x) do
-end

data/spec/fixtures/acceptance/modules/test/lib/puppet/parser/functions/function3x.rb

@@ -1,2 +0,0 @@
-Puppet::Parser::Functions.newfunction(:function3x, :doc => "This is the function documentation for `function3x`") do |args|
-end

data/spec/fixtures/acceptance/modules/test/lib/puppet/provider/server/linux.rb

@@ -1,9 +0,0 @@
-Puppet::Type.type(:database).provide :linux do
-  confine 'osfamily' => 'linux'
-  defaultfor 'osfamily' => 'linux'
-  commands :database => '/usr/bin/database'
-
-  desc 'The database provider on Linux.'
-
-  # ...
-end

data/spec/fixtures/acceptance/modules/test/lib/puppet/type/database.rb

@@ -1,15 +0,0 @@
-# @!puppet.type.param [value1, value2, value3] my_param Documentation for a dynamic parameter.
-# @!puppet.type.property [foo, bar, baz] my_prop Documentation for a dynamic property.
-Puppet::Type.newtype(:database) do
-  desc 'An example server resource type.'
-  feature :encryption, 'The provider supports encryption.', methods: [:encrypt]
-
-  newparam(:address) do
-    isnamevar
-    desc 'The database server name.'
-  end
-
-  newproperty(:file) do
-    desc 'The database file to use.'
-  end
-end