RenderIndexTask.java

/*
 Copyright 2013-2016 Jason Leyba

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */

package com.github.jsdossier;

import com.github.jsdossier.annotations.Readme;
import com.github.jsdossier.proto.Comment;
import com.github.jsdossier.proto.PageData;
import com.google.common.collect.ImmutableList;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.Optional;
import javax.inject.Inject;

/**
 * Renders the main index file.
 */
final class RenderIndexTask implements RenderTask {

  private final DossierFileSystem dfs;
  private final CommentParser parser;
  private final LinkFactory linkFactory;
  private final PageRenderer renderer;
  private final Optional<Path> readmeFile;
  private final IndexBuilder index;

  @Inject
  RenderIndexTask(
      DossierFileSystem dfs,
      CommentParser parser,
      LinkFactoryBuilder linkFactoryBuilder,
      PageRenderer renderer,
      @Readme Optional<Path> readmeFile,
      IndexBuilder index) {
    this.dfs = dfs;
    this.parser = parser;
    this.index = index;
    this.linkFactory = linkFactoryBuilder.create(null);
    this.renderer = renderer;
    this.readmeFile = readmeFile;
  }

  @Override
  public List<Path> call() throws IOException {
    // TODO: render an index of all the types.
    Comment content = Comment.getDefaultInstance();

    if (readmeFile.isPresent()) {
      String readme = new String(
          Files.readAllBytes(readmeFile.get()),
          StandardCharsets.UTF_8);
      content = parser.parseComment(readme, linkFactory);
    }

    PageData data = PageData.newBuilder()
        .setMarkdown(
            PageData.Markdown.newBuilder()
                .setTitle("Index")
                .setContent(content))
        .build();

    Path htmlPath = dfs.getPath("index.html");
    Path jsonPath = dfs.getJsonPath(htmlPath);
    renderer.render(htmlPath, jsonPath, data);
    index.addSourceFile(htmlPath, jsonPath);
    return ImmutableList.of(htmlPath, jsonPath);
  }
}