Class: YARD::CLI::Display
- Inherits:
-
Yardoc
- Object
- Command
- YardoptsCommand
- Yardoc
- YARD::CLI::Display
- Defined in:
- lib/yard/cli/display.rb
Overview
Display one object
Constant Summary
Instance Attribute Summary (collapse)
-
- (Array<String>) apis
inherited
from Yardoc
Keep track of which APIs are to be shown.
-
- (Array<String>) assets
inherited
from Yardoc
A list of assets to copy after generation.
-
- (Array<String>) excluded
inherited
from Yardoc
List of excluded paths (regexp matches).
-
- (Array<String>) files
inherited
from Yardoc
List of Ruby source files to process.
-
- (Boolean) generate
inherited
from Yardoc
Whether to generate output.
-
- (Boolean) has_markup
inherited
from Yardoc
Whether markup option was specified.
-
- (Array<String>) hidden_apis
inherited
from Yardoc
Keep track of which APIs are to be hidden.
-
- (Array<Symbol>) hidden_tags
inherited
from Yardoc
A list of tags to hide from templates.
-
- (Boolean) list
inherited
from Yardoc
Whether to print a list of objects.
-
- (Hash) options
inherited
from Yardoc
readonly
The hash of options passed to the template.
-
- (String) options_file
inherited
from YardoptsCommand
The options file name (defaults to YardoptsCommand::DEFAULT_YARDOPTS_FILE).
-
- (Boolean) save_yardoc
inherited
from Yardoc
Whether objects should be serialized to .yardoc db.
-
- (Boolean) statistics
inherited
from Yardoc
Whether to print statistics after parsing.
-
- (Boolean) use_cache
inherited
from Yardoc
Whether to use the existing yardoc db if the .yardoc already exists.
-
- (Boolean) use_document_file
inherited
from YardoptsCommand
Whether to parse options from .document.
-
- (Boolean) use_yardopts_file
inherited
from YardoptsCommand
Whether to parse options from .yardopts.
-
- (Array<Symbol>) visibilities
inherited
from Yardoc
Keep track of which visibilities are to be shown.
Instance Method Summary (collapse)
- - (Object) description
-
- (String) format_objects
The output data for all formatted objects.
-
- (Display) initialize(*args)
constructor
A new instance of Display.
- - (Object) output_options(opts)
-
- (Object) parse_arguments(*args)
Parses commandline options.
-
- (void) run(*args)
Runs the commandline utility, parsing arguments and displaying an object from the Registry.
- - (Object) wrap_layout(contents)
Constructor Details
- (Display) initialize(*args)
Returns a new instance of Display
8 9 10 11 12 13 |
# File 'lib/yard/cli/display.rb', line 8 def initialize(*args) super .format = :text # default for this command @layout = nil @objects = [] end |
Instance Attribute Details
- (Array<String>) assets Originally defined in class Yardoc
Returns a list of assets to copy after generation
- (Array<String>) excluded Originally defined in class Yardoc
Returns list of excluded paths (regexp matches)
- (Array<String>) files Originally defined in class Yardoc
Returns list of Ruby source files to process
- (Boolean) generate Originally defined in class Yardoc
Returns whether to generate output
- (Boolean) has_markup Originally defined in class Yardoc
Returns whether markup option was specified
- (Array<String>) hidden_apis Originally defined in class Yardoc
Keep track of which APIs are to be hidden
- (Array<Symbol>) hidden_tags Originally defined in class Yardoc
Returns a list of tags to hide from templates
- (Boolean) list Originally defined in class Yardoc
Returns whether to print a list of objects
- (Hash) options (readonly) Originally defined in class Yardoc
Returns the hash of options passed to the template.
- (String) options_file Originally defined in class YardoptsCommand
The options file name (defaults to DEFAULT_YARDOPTS_FILE)
- (Boolean) save_yardoc Originally defined in class Yardoc
Returns whether objects should be serialized to .yardoc db
- (Boolean) statistics Originally defined in class Yardoc
Returns whether to print statistics after parsing
- (Boolean) use_cache Originally defined in class Yardoc
Returns whether to use the existing yardoc db if the .yardoc already exists. Also makes use of file checksums to parse only changed files.
- (Boolean) use_document_file Originally defined in class YardoptsCommand
Returns whether to parse options from .document
- (Boolean) use_yardopts_file Originally defined in class YardoptsCommand
Returns whether to parse options from .yardopts
Instance Method Details
- (Object) description
6 |
# File 'lib/yard/cli/display.rb', line 6 def description; 'Displays a formatted object' end |
- (String) format_objects
Returns the output data for all formatted objects
26 27 28 29 30 |
# File 'lib/yard/cli/display.rb', line 26 def format_objects @objects.inject([]) do |arr, obj| arr.push obj.format() end.join("\n") end |
- (Object) output_options(opts)
60 61 62 63 64 65 |
# File 'lib/yard/cli/display.rb', line 60 def (opts) super(opts) opts.on('-l', '--layout [LAYOUT]', 'Wraps output in layout template (good for HTML)') do |layout| @layout = layout || 'layout' end end |
- (Object) parse_arguments(*args)
Parses commandline options.
45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/yard/cli/display.rb', line 45 def parse_arguments(*args) opts = OptionParser.new opts. = "Usage: yard display [options] OBJECT [OTHER OBJECTS]" (opts) (opts) (opts, args) Registry.load @objects = args.map {|o| Registry.at(o) } # validation return false if @objects.any? {|o| o.nil? } end |
- (void) run(*args)
This method returns an undefined value.
Runs the commandline utility, parsing arguments and displaying an object from the Registry.
20 21 22 23 |
# File 'lib/yard/cli/display.rb', line 20 def run(*args) return unless parse_arguments(*args) log.puts wrap_layout(format_objects) end |
- (Object) wrap_layout(contents)
32 33 34 35 36 37 38 39 40 41 |
# File 'lib/yard/cli/display.rb', line 32 def wrap_layout(contents) return contents unless @layout opts = .merge( :contents => contents, :object => @objects.first, :objects => @objects ) args = [.template, @layout, .format] Templates::Engine.template(*args).run(opts) end |