Class: Jazzy::Config

Inherits:
Object
  • 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)

Singleton collapse

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Config

rubocop:enable Style/AlignParameter



449
450
451
452
453
 
# File 'lib/jazzy/config.rb', line 449

def initialize
  self.class.all_config_attrs.each do |attr|
    attr.set_to_default(self)
  end
end

Class Attribute Details

.all_config_attrs ⇒ Object (readonly)

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

.instance ⇒ Config

Returns the current config instance creating one if needed.

Returns:

  • (Config) —

    the current config instance creating one if needed.



620
621
622
 
# File 'lib/jazzy/config.rb', line 620

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



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/jazzy/config.rb', line 461

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) # nil means Pathname.pwd
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) # Use existing filesystem spelling
end

#hide_objc? ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/jazzy/config.rb', line 109

def hide_objc?
  hide_declarations == 'objc'
end

#hide_swift? ⇒ Boolean

Returns:

  • (Boolean) 


105
106
107
 
# File 'lib/jazzy/config.rb', line 105

def hide_swift?
  hide_declarations == 'swift'
end

#locate_config_file ⇒ Object 



540
541
542
543
544
545
546
547
548
549
 
# File 'lib/jazzy/config.rb', line 540

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 



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/jazzy/config.rb', line 477

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 



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/jazzy/config.rb', line 509

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 



607
608
609
610
611
612
 
# File 'lib/jazzy/config.rb', line 607

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 



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/jazzy/config.rb', line 566

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 



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/jazzy/config.rb', line 584

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 



551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/jazzy/config.rb', line 551

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') # ruby >= 2.1.0
        YAML.safe_load(File.read(file))
      else
        # rubocop:disable Security/YAMLLoad
        YAML.load(File.read(file))
        # rubocop:enable Security/YAMLLoad
      end
    else raise "Config file must be .yaml or .json, but got #{file.inspect}"
  end
end

#theme_directory=(theme_directory) ⇒ Object 



455
456
457
458
 
# File 'lib/jazzy/config.rb', line 455

def theme_directory=(theme_directory)
  @theme_directory = theme_directory
  Doc.template_path = theme_directory + 'templates'
end