Class: RDoc::Generator::Aliki

# File 'lib/rdoc/generator/aliki.rb', line 188

def build_constant_entry(const, parent)
  entry = {
    name: const.name,
    full_name: "#{parent.full_name}::#{const.name}",
    type: 'constant',
    path: parent.path
  }

  snippet = const.search_snippet
  entry[:snippet] = snippet unless snippet.empty?
  entry
end

# File 'lib/rdoc/generator/aliki.rb', line 173

def build_method_entry(method)
  type = method.singleton ? 'class_method' : 'instance_method'

  entry = {
    name: method.name,
    full_name: method.full_name,
    type: type,
    path: method.path
  }

  snippet = method.search_snippet
  entry[:snippet] = snippet unless snippet.empty?
  entry
end

# File 'lib/rdoc/generator/aliki.rb', line 74

def build_search_index
  setup

  index = []

  @classes.each do |klass|
    next unless klass.display?

    index << build_class_module_entry(klass)

    klass.constants.each do |const|
      next unless const.display?

      index << build_constant_entry(const, klass)
    end
  end

  @methods.each do |method|
    next unless method.display?

    index << build_method_entry(method)
  end

  index
end

# File 'lib/rdoc/generator/aliki.rb', line 26

def generate
  setup

  write_style_sheet
  generate_index
  generate_class_files
  generate_file_files
  generate_table_of_contents
  write_search_index

  copy_static

rescue => e
  debug_msg "%s: %s\n  %s" % [
    e.class.name, e.message, e.backtrace.join("\n  ")
  ]

  raise
end

# File 'lib/rdoc/generator/aliki.rb', line 141

def resolve_url(rel_prefix, url)
  uri = URI.parse(url)
  if uri.absolute?
    url
  else
    "#{rel_prefix}/#{url}"
  end
rescue URI::InvalidURIError
  "#{rel_prefix}/#{url}"
end

# File 'lib/rdoc/generator/aliki.rb', line 126

def type_signature_html(method_attr, from_path)
  lines = method_attr.type_signature_lines || @store.rbs_signature_for(method_attr)
  return unless lines

  RDoc::RbsHelper.signature_to_html(
    lines,
    lookup: @store.type_name_lookup,
    from_path: from_path
  )
end

# File 'lib/rdoc/generator/aliki.rb', line 108

def write_search_index
  debug_msg "Writing Aliki search index"

  index = build_search_index

  FileUtils.mkdir_p 'js' unless @dry_run

  search_index_path = 'js/search_data.js'
  return if @dry_run

  data = { index: index }
  File.write search_index_path, "var search_data = #{JSON.generate(data)};"
end

# File 'lib/rdoc/generator/aliki.rb', line 51

def write_style_sheet
  debug_msg "Copying Aliki static files"
  options = { verbose: $DEBUG_RDOC, noop: @dry_run }

  install_rdoc_static_file @template_dir + 'css/rdoc.css', "./css/rdoc.css", options

  unless @options.template_stylesheets.empty?
    FileUtils.cp @options.template_stylesheets, '.', **options
  end

  Dir[(@template_dir + 'js/**/*').to_s].each do |path|
    next if File.directory?(path)
    next if File.basename(path).start_with?('.')

    dst = Pathname.new(path).relative_path_from(@template_dir)

    install_rdoc_static_file @template_dir + path, dst, options
  end
end