summaryrefslogtreecommitdiffstats
path: root/spec/unit/util/inline_docs_spec.rb
blob: edfa405a1172a8fa6e368d7924b786f2148f1b8e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
#!/usr/bin/env ruby

Dir.chdir(File.dirname(__FILE__)) { (s = lambda { |f| File.exist?(f) ? require(f) : Dir.chdir("..") { s.call(f) } }).call("spec/spec_helper.rb") }

require 'puppet/util/inline_docs'

class InlineDoccer
  include Puppet::Util::InlineDocs
end

describe Puppet::Util::InlineDocs do
  describe "when included" do
    it "should create a class method for specifying that docs should be associated" do
      InlineDoccer.expects(:use_docs=).with true
      InlineDoccer.associates_doc
    end

    it "should default to not associating docs" do
      (!! InlineDoccer.use_docs).should be_false
    end

    it "should create an instance method for setting documentation" do
      instance = InlineDoccer.new
      instance.doc = "foo"
      instance.doc.should == "foo"
    end

    it "should default to an empty string for docs" do
      InlineDoccer.new.doc.should == ""
    end
  end
end