DocAsCodeRepository.java

  1. package org.docascode.api.core;

  3. import org.docascode.api.core.chrono.ChronoRepository;
  4. import org.docascode.api.core.errors.DocAsCodeException;
  5. import org.docascode.api.core.git.GitRepository;
  6. import org.docascode.api.core.mvn.MvnRepository;
  7. import org.docascode.api.listener.APIEventListener;
  8. import org.eclipse.jgit.errors.ConfigInvalidException;
  9. import org.eclipse.jgit.lib.*;

  11. import java.io.File;
  12. import java.io.IOException;
  13. import java.nio.file.Path;
  14. import java.nio.file.Paths;

  16. public class DocAsCodeRepository extends APIEventListener {
  17.     private File docascodeDir;

  19.     private GitRepository gitRepository;

  21.     /**
  22.      * A DocAsCodeRepository constructor
  23.      * @param repo The base Git Repository.
  24.      */

  26.     public DocAsCodeRepository(Repository repo) throws IOException {
  27.         gitRepository = new GitRepository(repo);
  28.         docascodeDir = new File(getWorkTree(),".docascode");
  29.     }

  31.     /**
  32.      * The workTree of the current DocAsCode/Git Repository.
  33.      */

  35.     public File getWorkTree(){
  36.         return gitRepository.getWorkTree();
  37.     }

  39.     /**
  40.      * The Maven project settings file for this DocAsCode repository.
  41.      * @return the Maven project file.
  42.      */

  44.     private File getProjectSettingsFile() {
  45.         return new File(getDocAsCodeDir(),"settings.xml");
  46.     }


  49.     private MvnRepository mvnRepository;

  51.     /**
  52.      * A Maven Repository Controller for this DocAsCode repository.
  53.      * @return the MvnRepository
  54.      */

  56.     public MvnRepository mvn(){
  57.         if (mvnRepository==null){
  58.             mvnRepository = new MvnRepository(getProjectSettingsFile(),getWorkTree());
  59.             mvnRepository.addListener(this);
  60.         }
  61.         return mvnRepository;
  62.     }

  64.     private ChronoRepository chronoRepository;

  66.     /**
  67.      * A Chrono Repository Controller for this DocAsCode repository.
  68.      * @return the ChronoRepository
  69.      */

  71.     public ChronoRepository chrono(){
  72.         if (chronoRepository==null){
  73.             chronoRepository = new ChronoRepository(getChronoXML(),getWorkTree());
  74.             chronoRepository.addListener(this);
  75.         }
  76.         return chronoRepository;
  77.     }

  79.     /**
  80.      * The delivery.properties file for this repository.
  81.      * @return the delivery.properties file.
  82.      */

  84.     public File getDeliveryProperties() {
  85.         return new File(getWorkTree(),"delivery.properties");
  86.     }

  88.     /**
  89.      * The .docascode directory.
  90.      */

  92.     public File getDocAsCodeDir(){
  93.         return this.docascodeDir;
  94.     }

  96.     /**
  97.      * The chrono.xml file.
  98.      */

  100.     public File getChronoXML(){
  101.         return new File(getDocAsCodeDir(),"chrono.xml");
  102.     }

  104.     public File  getDeliveryXML(){
  105.         return new File(getWorkTree(),"delivery.xml");
  106.     }

  108.     /**
  109.      * Resolve file path relatively to the worktree of this DocAsCode repository.
  110.      * Paths are returned in Unix styles.
  111.      * @param file the file to resolve.
  112.      * @return the resolved path.
  113.      */

  115.     public String relativize (File file){
  116.         Path workTreePath = Paths.get(getWorkTree().getAbsolutePath());
  117.         Path filePath = Paths.get(file.getAbsolutePath());
  118.         return workTreePath.relativize(filePath).normalize().toString().replace("\\","/").replace("../","");
  119.     }

  121.     /**
  122.      * The temporary working directory for this DocAsCode repository.
  123.      * @return the temporary working directory.
  124.      */

  126.     public File getTmpDir(){
  127.         return new File(getDocAsCodeDir(),"tmp");
  128.     }

  130.     /**
  131.      * The version of this DocAsCode repository.
  132.      * Usually this version is set through an init or upgrade
  133.      * @return this DocAsCode repository version
  134.      */

  136.     public String getVersion() throws DocAsCodeException {
  137.         StoredConfig c = git().getProjectConfig();
  138.         try {
  139.             c.load();
  140.             return c.getString("docascode",null,"version");
  141.         } catch (IOException | ConfigInvalidException e) {
  142.             throw new DocAsCodeException("Unable to get current repository version",e);
  143.         }
  144.     }

  146.     /**
  147.      * A Git Repository Controller for this DocAsCode repository.
  148.      * @return the GitRepository.
  149.      */

  151.     public GitRepository git() {
  152.         return gitRepository;
  153.     }
  154. }
Created with JaCoCo 0.8.3.201901230119