org.sonar.scanner.scm.ScmChangedFiles Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-scanner-engine Show documentation

Open source platform for continuous inspection of code quality

There is a newer version: 24.12.0.100206

/*
 * SonarQube
 * Copyright (C) 2009-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.scanner.scm;

import java.nio.file.Path;
import java.util.Collection;
import java.util.Map;
import java.util.Optional;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import org.sonar.scm.git.ChangedFile;

import static java.util.Collections.emptyMap;
import static java.util.function.Function.identity;
import static java.util.stream.Collectors.toMap;

@Immutable
public class ScmChangedFiles {
  @Nullable
  private final Collection changedFiles;
  private final Map changedFilesByPath;

  public ScmChangedFiles(@Nullable Collection changedFiles) {
    this.changedFiles = changedFiles;
    this.changedFilesByPath = toChangedFilesByPathMap(changedFiles);
  }

  public boolean isChanged(Path file) {
    if (!isValid()) {
      throw new IllegalStateException("Scm didn't provide valid data");
    }

    return this.getChangedFile(file).isPresent();
  }

  public boolean isValid() {
    return changedFiles != null;
  }

  @CheckForNull
  public Collection get() {
    return changedFiles;
  }

  @CheckForNull
  public String getOldRelativeFilePath(Path absoluteFilePath) {
    return this.getChangedFile(absoluteFilePath)
      .filter(ChangedFile::isMovedFile)
      .map(ChangedFile::getOldRelativeFilePathReference)
      .orElse(null);
  }

  private Optional getChangedFile(Path absoluteFilePath) {
    return Optional.ofNullable(changedFilesByPath.get(absoluteFilePath));
  }

  private static Map toChangedFilesByPathMap(@Nullable Collection changedFiles) {
    return Optional.ofNullable(changedFiles)
      .map(files -> files.stream().collect(toMap(ChangedFile::getAbsolutFilePath, identity())))
      .orElse(emptyMap());
  }
}