class YARD::CLI::Gems
@since 0.6.0
Public Class Methods
new()
click to toggle source
# File lib/yard/cli/gems.rb, line 5 def initialize @rebuild = false @gems = [] end
Public Instance Methods
description()
click to toggle source
# File lib/yard/cli/gems.rb, line 10 def description; "Builds YARD index for gems" end
run(*args)
click to toggle source
Runs the commandline utility, parsing arguments and generating YARD indexes for gems.
@param [Array<String>] args the list of arguments @return [void]
# File lib/yard/cli/gems.rb, line 17 def run(*args) require 'rubygems' optparse(*args) build_gems end
Private Instance Methods
add_gems(gems)
click to toggle source
# File lib/yard/cli/gems.rb, line 45 def add_gems(gems) 0.step(gems.size - 1, 2) do |index| gem, ver_require = gems[index], gems[index + 1] || ">= 0" specs = Gem.source_index.find_name(gem, ver_require) if specs.empty? log.warn "#{gem} #{ver_require} could not be found in RubyGems index" else @gems += specs end end end
build_gems()
click to toggle source
Builds .yardoc files for all non-existing gems
# File lib/yard/cli/gems.rb, line 26 def build_gems require 'rubygems' @gems.each do |spec| ver = "= #{spec.version}" dir = Registry.yardoc_file_for_gem(spec.name, ver) if dir && File.directory?(dir) && !@rebuild log.debug "#{spec.name} index already exists at '#{dir}'" else yfile = Registry.yardoc_file_for_gem(spec.name, ver, true) next unless yfile next unless File.directory?(spec.full_gem_path) Registry.clear Dir.chdir(spec.full_gem_path) log.info "Building yardoc index for gem: #{spec.full_name}" Yardoc.run('--no-stats', '-n', '-b', yfile) end end end
optparse(*args)
click to toggle source
Parses options
# File lib/yard/cli/gems.rb, line 58 def optparse(*args) opts = OptionParser.new opts.banner = 'Usage: yard gems [options] [gem_name [version]]' opts.separator "" opts.separator "#{description}. If no gem_name is given," opts.separator "all gems are built." opts.separator "" opts.on('--rebuild', 'Rebuilds index') do @rebuild = true end common_options(opts) parse_options(opts, args) add_gems(args) if !args.empty? && @gems.empty? log.error "No specified gems could be found for command" elsif @gems.empty? @gems += Gem.source_index.find_name('') if @gems.empty? end end