Class: Jazzy::Config
- Inherits:
-
Object
show all
- Defined in:
- lib/jazzy/config.rb
Overview
rubocop:disable Metrics/ClassLength
Defined Under Namespace
Modules: Mixin
Classes: Attribute
Constant Summary
collapse
- SWIFT_BUILD_TOOLS =
%w[spm xcodebuild].freeze
- BUILTIN_THEME_DIR =
Pathname(__FILE__).parent + 'themes'
- BUILTIN_THEMES =
BUILTIN_THEME_DIR.children(false).map(&:to_s)
Class Attribute Summary collapse
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Constructor Details
#initialize ⇒ Config
rubocop:enable Style/AlignParameter
402
403
404
405
406
|
# File 'lib/jazzy/config.rb', line 402
def initialize
self.class.all_config_attrs.each do |attr|
attr.set_to_default(self)
end
end
|
Class Attribute Details
.all_config_attrs ⇒ Object
Returns the value of attribute all_config_attrs.
91
92
93
|
# File 'lib/jazzy/config.rb', line 91
def all_config_attrs
@all_config_attrs
end
|
Returns the current config instance creating one if needed.
573
574
575
|
# File 'lib/jazzy/config.rb', line 573
def self.instance
@instance ||= new
end
|
Instance Attribute Details
#base_path ⇒ Object
Returns the value of attribute base_path.
94
95
96
|
# File 'lib/jazzy/config.rb', line 94
def base_path
@base_path
end
|
Class Method Details
.alias_config_attr(name, forward, **opts) ⇒ Object
82
83
84
85
86
87
88
|
# File 'lib/jazzy/config.rb', line 82
def self.alias_config_attr(name, forward, **opts)
alias_method name.to_s, forward.to_s
alias_method "#{name}=", "#{forward}="
alias_method "#{name}_configured", "#{forward}_configured"
alias_method "#{name}_configured=", "#{forward}_configured="
@all_config_attrs << Attribute.new(name, **opts)
end
|
.config_attr(name, **opts) ⇒ Object
rubocop:enable Style/AccessorMethodName
75
76
77
78
79
80
|
# File 'lib/jazzy/config.rb', line 75
def self.config_attr(name, **opts)
attr_accessor name
attr_accessor "#{name}_configured"
@all_config_attrs ||= []
@all_config_attrs << Attribute.new(name, **opts)
end
|
.parse! ⇒ Object
rubocop:disable Metrics/MethodLength
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
|
# File 'lib/jazzy/config.rb', line 414
def self.parse!
config = new
config.parse_command_line
config.parse_config_file
PodspecDocumenter.apply_config_defaults(config.podspec, config)
if config.root_url
config.dash_url ||= URI.join(
config.root_url,
"docsets/#{config.module_name}.xml",
)
end
config
end
|
Instance Method Details
#expand_glob_path(path) ⇒ Object
96
97
98
|
# File 'lib/jazzy/config.rb', line 96
def expand_glob_path(path)
Pathname(path).expand_path(base_path) end
|
#expand_path(path) ⇒ Object
100
101
102
103
|
# File 'lib/jazzy/config.rb', line 100
def expand_path(path)
abs_path = expand_glob_path(path)
Pathname(Dir[abs_path][0] || abs_path) end
|
#locate_config_file ⇒ Object
493
494
495
496
497
498
499
500
501
502
|
# File 'lib/jazzy/config.rb', line 493
def locate_config_file
return config_file if config_file
source_directory.ascend do |dir|
candidate = dir.join('.jazzy.yaml')
return candidate if candidate.exist?
end
nil
end
|
#parse_command_line ⇒ Object
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
|
# File 'lib/jazzy/config.rb', line 430
def parse_command_line
OptionParser.new do |opt|
opt.banner = 'Usage: jazzy'
opt.separator ''
opt.separator 'Options'
self.class.all_config_attrs.each do |attr|
attr.attach_to_option_parser(self, opt)
end
opt.on('-v', '--version', 'Print version number') do
puts 'jazzy version: ' + Jazzy::VERSION
exit
end
opt.on('-h', '--help [TOPIC]', 'Available topics:',
' usage Command line options (this help message)',
' config Configuration file options',
'...or an option keyword, e.g. "dash"') do |topic|
case topic
when 'usage', nil
puts opt
when 'config'
print_config_file_help
else
print_option_help(topic)
end
exit
end
end.parse!
end
|
#parse_config_file ⇒ Object
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
|
# File 'lib/jazzy/config.rb', line 462
def parse_config_file
config_path = locate_config_file
return unless config_path
self.base_path = config_path.parent
puts "Using config file #{config_path}"
config_file = read_config_file(config_path)
attrs_by_conf_key, attrs_by_name = %i[config_file_key name].map do |prop|
self.class.all_config_attrs.group_by(&prop)
end
config_file.each do |key, value|
unless attr = attrs_by_conf_key[key]
message = "WARNING: Unknown config file attribute #{key.inspect}"
if matching_name = attrs_by_name[key]
message << ' (Did you mean '
message << matching_name.first.config_file_key.inspect
message << '?)'
end
warn message
next
end
attr.first.set_if_unconfigured(self, value)
end
self.base_path = nil
end
|
#print_attr_description(attr) ⇒ Object
560
561
562
563
564
565
|
# File 'lib/jazzy/config.rb', line 560
def print_attr_description(attr)
attr.description.each { |line| puts " #{line}" }
if attr.default && attr.default != ''
puts " Default: #{attr.default}"
end
end
|
#print_config_file_help ⇒ Object
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
|
# File 'lib/jazzy/config.rb', line 519
def print_config_file_help
puts <<-_EOS_
By default, jazzy looks for a file named ".jazzy.yaml" in the source
directory and its ancestors. You can override the config file location
with --config.
(The source directory is the current working directory by default.
You can override that with --source-directory.)
The config file can be in YAML or JSON format. Available options are:
_EOS_
.gsub(/^ +/, '')
print_option_help
end
|
#print_option_help(topic = '') ⇒ Object
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
|
# File 'lib/jazzy/config.rb', line 537
def print_option_help(topic = '')
found = false
self.class.all_config_attrs.each do |attr|
match = ([attr.name] + attr.command_line).any? do |opt|
opt.to_s.include?(topic)
end
if match
found = true
puts
puts attr.name.to_s.tr('_', ' ').upcase
puts
puts " Config file: #{attr.config_file_key}"
cmd_line_forms = attr.command_line.select { |opt| opt.is_a?(String) }
if cmd_line_forms.any?
puts " Command line: #{cmd_line_forms.join(', ')}"
end
puts
print_attr_description(attr)
end
end
warn "Unknown help topic #{topic.inspect}" unless found
end
|
#read_config_file(file) ⇒ Object
504
505
506
507
508
509
510
511
512
513
514
515
516
517
|
# File 'lib/jazzy/config.rb', line 504
def read_config_file(file)
case File.extname(file)
when '.json' then JSON.parse(File.read(file))
when '.yaml', '.yml' then
if YAML.respond_to?('safe_load') YAML.safe_load(File.read(file))
else
YAML.load(File.read(file))
end
else raise "Config file must be .yaml or .json, but got #{file.inspect}"
end
end
|
#theme_directory=(theme_directory) ⇒ Object
408
409
410
411
|
# File 'lib/jazzy/config.rb', line 408
def theme_directory=(theme_directory)
@theme_directory = theme_directory
Doc.template_path = theme_directory + 'templates'
end
|