Class: Puppet::Application::Doc

Inherits:
Puppet::Application show all
Defined in:
lib/puppet/application/doc.rb

Constant Summary

Constants inherited from Puppet::Application

DOCPATTERN

Constants included from Util

Util::ALNUM, Util::ALPHA, Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE, Util::ESCAPED, Util::HEX, Util::HttpProxy, Util::PUPPET_STACK_INSERTION_FRAME, Util::RESERVED, Util::RFC_3986_URI_REGEX, Util::UNRESERVED, Util::UNSAFE

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Instance Attribute Summary collapse

Attributes inherited from Puppet::Application

#command_line, #options

Instance Method Summary collapse

Methods inherited from Puppet::Application

[], #app_defaults, available_application_names, banner, clear!, clear?, clear_everything_for_tests, #configure_indirector_routes, controlled_run, #deprecate, #deprecated?, environment_mode, exit, find, get_environment_mode, #handle_logdest_arg, #handlearg, #initialize, #initialize_app_defaults, interrupted?, #log_runtime_environment, #main, #name, option, option_parser_commands, #parse_options, restart!, restart_requested?, #run, run_mode, #set_log_level, #setup_logs, stop!, stop_requested?, try_load_class

Methods included from Util

absolute_path?, benchmark, chuser, clear_environment, create_erb, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, format_backtrace_array, format_puppetstack_frame, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, resolve_stackframe, rfc2396_escape, safe_posix_fork, set_env, skip_external_facts, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, uri_unescape, which, withenv, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, groups_of, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Methods included from Util::SymbolicFileMode

#display_mode, #normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Constructor Details

This class inherits a constructor from Puppet::Application

Instance Attribute Details

#manifestObject



8
9
10
# File 'lib/puppet/application/doc.rb', line 8

def manifest
  @manifest
end

#unknown_argsObject



8
9
10
# File 'lib/puppet/application/doc.rb', line 8

def unknown_args
  @unknown_args
end

Instance Method Details

#handle_unknown(opt, arg) ⇒ Object



119
120
121
122
# File 'lib/puppet/application/doc.rb', line 119

def handle_unknown(opt, arg)
  @unknown_args << { :opt => opt, :arg => arg }
  true
end

#helpObject



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/puppet/application/doc.rb', line 58

def help
  <<~HELP

    puppet-doc(8) -- #{summary}
    ========

    SYNOPSIS
    --------
    Generates a reference for all Puppet types. Largely meant for internal
    Puppet Inc. use. (Deprecated)


    USAGE
    -----
    puppet doc [-h|--help] [-l|--list]
      [-r|--reference <reference-name>]


    DESCRIPTION
    -----------
    This deprecated command generates a Markdown document to stdout
    describing all installed Puppet types or all allowable arguments to
    puppet executables. It is largely meant for internal use and is used to
    generate the reference document available on the Puppet Inc. web site.

    For Puppet module documentation (and all other use cases) this command
    has been superseded by the "puppet-strings"
    module - see https://github.com/puppetlabs/puppetlabs-strings for more information.

    This command (puppet-doc) will be removed once the
    puppetlabs internal documentation processing pipeline is completely based
    on puppet-strings.

    OPTIONS
    -------

    * --help:
      Print this help message

    * --reference:
      Build a particular reference. Get a list of references by running
      'puppet doc --list'.


    EXAMPLE
    -------
        $ puppet doc -r type > /tmp/type_reference.markdown


    AUTHOR
    ------
    Luke Kanies


    COPYRIGHT
    ---------
    Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License

  HELP
end

#otherObject



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/puppet/application/doc.rb', line 155

def other
  text = ''.dup
  with_contents = options[:references].length <= 1
  exit_code = 0
  require_relative '../../puppet/util/reference'
  options[:references].sort_by(&:to_s).each do |name|
    section = Puppet::Util::Reference.reference(name)
    raise _("Could not find reference %{name}") % { name: name } unless section

    begin
      # Add the per-section text, but with no ToC
      text += section.send(options[:format], with_contents)
    rescue => detail
      Puppet.log_exception(detail, _("Could not generate reference %{name}: %{detail}") % { name: name, detail: detail })
      exit_code = 1
      next
    end
  end

  text += Puppet::Util::Reference.footer unless with_contents # We've only got one reference

  if options[:mode] == :pdf
    Puppet::Util::Reference.pdf(text)
  else
    puts text
  end

  exit exit_code
end

#preinitObject



10
11
12
13
14
15
16
# File 'lib/puppet/application/doc.rb', line 10

def preinit
  { :references => [], :mode => :text, :format => :to_markdown }.each do |name, value|
    options[name] = value
  end
  @unknown_args = []
  @manifest = false
end

#rdocObject



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/puppet/application/doc.rb', line 128

def rdoc
  exit_code = 0
  files = []
  unless @manifest
    env = Puppet.lookup(:current_environment)
    files += env.modulepath
    files << ::File.dirname(env.manifest) if env.manifest != Puppet::Node::Environment::NO_MANIFEST
  end
  files += command_line.args
  Puppet.info _("scanning: %{files}") % { files: files.inspect }

  Puppet.settings[:document_all] = options[:all] || false
  begin
    require_relative '../../puppet/util/rdoc'
    if @manifest
      Puppet::Util::RDoc.manifestdoc(files)
    else
      options[:outputdir] = "doc" unless options[:outputdir]
      Puppet::Util::RDoc.rdoc(options[:outputdir], files, options[:charset])
    end
  rescue => detail
    Puppet.log_exception(detail, _("Could not generate documentation: %{detail}") % { detail: detail })
    exit_code = 1
  end
  exit exit_code
end

#run_commandObject



124
125
126
# File 'lib/puppet/application/doc.rb', line 124

def run_command
  [:rdoc].include?(options[:mode]) ? send(options[:mode]) : other
end

#setupObject



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/puppet/application/doc.rb', line 185

def setup
  # sole manifest documentation
  if command_line.args.size > 0
    options[:mode] = :rdoc
    @manifest = true
  end

  if options[:mode] == :rdoc
    setup_rdoc
  else
    setup_reference
  end

  setup_logging
end

#setup_loggingObject



228
229
230
231
232
233
234
# File 'lib/puppet/application/doc.rb', line 228

def setup_logging
  Puppet::Util::Log.level = :warning

  set_log_level

  Puppet::Util::Log.newdestination(:console)
end

#setup_rdocObject



214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'lib/puppet/application/doc.rb', line 214

def setup_rdoc
  # consume the unknown options
  # and feed them as settings
  if @unknown_args.size > 0
    @unknown_args.each do |option|
      # force absolute path for modulepath when passed on commandline
      if option[:opt] == "--modulepath"
        option[:arg] = option[:arg].split(::File::PATH_SEPARATOR).collect { |p| ::File.expand_path(p) }.join(::File::PATH_SEPARATOR)
      end
      Puppet.settings.handlearg(option[:opt], option[:arg])
    end
  end
end

#setup_referenceObject



201
202
203
204
205
206
207
208
209
210
211
212
# File 'lib/puppet/application/doc.rb', line 201

def setup_reference
  if options[:all]
    # Don't add dynamic references to the "all" list.
    require_relative '../../puppet/util/reference'
    refs = Puppet::Util::Reference.references(Puppet.lookup(:current_environment))
    options[:references] = refs.reject do |ref|
      Puppet::Util::Reference.reference(ref).dynamic?
    end
  end

  options[:references] << :type if options[:references].empty?
end

#summaryObject



54
55
56
# File 'lib/puppet/application/doc.rb', line 54

def summary
  _("Generate Puppet references")
end