Sha256: d569e259e6c78b16015ed60f955533afc73ee8aabb8cab9b49c18839dc6ee6b3

Contents?: true

Size: 1.74 KB

Versions: 340

Compression:

Stored size: 1.74 KB

Contents

require 'spec_helper'

require 'puppet/util/rdoc'
require 'rdoc/rdoc'

describe Puppet::Util::RDoc do
  describe "when generating RDoc HTML documentation" do
    before :each do
      @rdoc = double('rdoc')
      allow(RDoc::RDoc).to receive(:new).and_return(@rdoc)
    end

    it "should tell RDoc to generate documentation using the Puppet generator" do
      expect(@rdoc).to receive(:document).with(include("--fmt").and(include("puppet")))

      Puppet::Util::RDoc.rdoc("output", [])
    end

    it "should tell RDoc to be quiet" do
      expect(@rdoc).to receive(:document).with(include("--quiet"))

      Puppet::Util::RDoc.rdoc("output", [])
    end

    it "should pass charset to RDoc" do
      expect(@rdoc).to receive(:document).with(include("--charset").and(include("utf-8")))

      Puppet::Util::RDoc.rdoc("output", [], "utf-8")
    end

    it "should tell RDoc to use the given outputdir" do
      expect(@rdoc).to receive(:document).with(include("--op").and(include("myoutputdir")))

      Puppet::Util::RDoc.rdoc("myoutputdir", [])
    end

    it "should tell RDoc to exclude all files under any modules/<mod>/files section" do
      expect(@rdoc).to receive(:document).with(include("--exclude").and(include("/modules/[^/]*/files/.*$")))

      Puppet::Util::RDoc.rdoc("myoutputdir", [])
    end

    it "should tell RDoc to exclude all files under any modules/<mod>/templates section" do
      expect(@rdoc).to receive(:document).with(include("--exclude").and(include("/modules/[^/]*/templates/.*$")))

      Puppet::Util::RDoc.rdoc("myoutputdir", [])
    end

    it "should give all the source directories to RDoc" do
      expect(@rdoc).to receive(:document).with(include("sourcedir"))

      Puppet::Util::RDoc.rdoc("output", ["sourcedir"])
    end
  end
end

Version data entries

340 entries across 340 versions & 1 rubygems

Version Path
puppet-8.3.0 spec/unit/util/rdoc_spec.rb
puppet-8.3.0-x86-mingw32 spec/unit/util/rdoc_spec.rb
puppet-8.3.0-x64-mingw32 spec/unit/util/rdoc_spec.rb
puppet-8.3.0-universal-darwin spec/unit/util/rdoc_spec.rb
puppet-8.4.0 spec/unit/util/rdoc_spec.rb
puppet-8.4.0-x86-mingw32 spec/unit/util/rdoc_spec.rb
puppet-8.4.0-x64-mingw32 spec/unit/util/rdoc_spec.rb
puppet-8.4.0-universal-darwin spec/unit/util/rdoc_spec.rb
puppet-7.28.0 spec/unit/util/rdoc_spec.rb
puppet-7.28.0-x86-mingw32 spec/unit/util/rdoc_spec.rb
puppet-7.28.0-x64-mingw32 spec/unit/util/rdoc_spec.rb
puppet-7.28.0-universal-darwin spec/unit/util/rdoc_spec.rb
puppet-8.3.1 spec/unit/util/rdoc_spec.rb
puppet-8.3.1-x86-mingw32 spec/unit/util/rdoc_spec.rb
puppet-8.3.1-x64-mingw32 spec/unit/util/rdoc_spec.rb
puppet-8.3.1-universal-darwin spec/unit/util/rdoc_spec.rb
puppet-7.27.0 spec/unit/util/rdoc_spec.rb
puppet-7.27.0-x86-mingw32 spec/unit/util/rdoc_spec.rb
puppet-7.27.0-x64-mingw32 spec/unit/util/rdoc_spec.rb
puppet-7.27.0-universal-darwin spec/unit/util/rdoc_spec.rb