/*
 * RiskScape™ Copyright New Zealand Institute for Earth Science Limited
 * (Earth Sciences New Zealand) is distributed for research purposes only
 * under the terms of AGPLv3.
 *
 * RiskScape™ Copyright 2026 New Zealand Institute for Earth Science
 * Limited (Earth Sciences New Zealand). All rights reserved. Source code
 * available under the AGPLv3.
 * 
 * This program is free software: you can redistribute it and/or modify it under
 *  the terms of the GNU Affero 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 for RESEARCH PURPOSES ONLY, in the hope that it will
 * be useful for research and education initiatives.
 * 
 * If you are not a researcher, or you are a researcher who wishes to use this
 * program on terms other than AGPLv3 (including those who wish to restrict the
 * distribution of any source code created using this program), please contact:
 * https://riskscape.org.nz
 * 
 * This program is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Affero General Public License for more details.  You should have received a copy
 * of the GNU Affero General Public License along with this program.  If not, see
 * <http://www.gnu.org/licenses/>.
 * 
 * By way of summary only, under the AGPLv3:
 *     • Permissions of this strongest copyleft license are conditioned
 *       on making available complete source code of licensed works and
 *       modifications, which include larger works using a licensed work,
 *       under the same license.
 *     • Copyright and license notices must be preserved.
 *     • Contributors provide an express grant of patent rights.
 *     • When a modified version is used to provide a service over a
 *       network, the complete source code of the modified version must be made
 *       available.
 */
package nz.org.riskscape.engine.projection;

import static org.hamcrest.Matchers.*;
import static org.junit.Assert.*;

import static nz.org.riskscape.engine.Assert.*;

import java.util.Optional;

import org.geotools.geometry.jts.MultiCurve;
import org.junit.Test;
import org.locationtech.jts.geom.Geometry;
import org.locationtech.jts.geom.MultiLineString;

import nz.org.riskscape.engine.SRIDSet;
import nz.org.riskscape.engine.Tuple;
import nz.org.riskscape.engine.data.InputDataProblems;
import nz.org.riskscape.engine.gt.GeometryHelper;
import nz.org.riskscape.engine.relation.InvalidTupleException;
import nz.org.riskscape.engine.types.Nullable;
import nz.org.riskscape.engine.types.Struct;
import nz.org.riskscape.engine.types.Types;

public class LinearGeometryProjectionTest {

  GeometryHelper geomHelper = GeometryHelper.nzTransverseMercatorWithOriginShift(new SRIDSet());
  Struct type;
  LinearGeometryProjection projection;
  Projector projector;
  Tuple projected;

  @Test
  public void isIdentityProjectorWhenNoGeometries() {
    buildProjector(Struct.of("foo", Types.TEXT), 0D);
    assertThat(projector.toString(), is("IdentityProjector({foo=>Text})"));
  }

  @Test
  public void projectorReturnsNewTuple() {
    buildProjector(Struct.of("geom", Types.GEOMETRY), 0D);

    assertThat(projector.getSourceType(), is(type));
    assertThat(projector.getProducedType(), is(type));

    Tuple in = Tuple.ofValues(type, geomHelper.point(10, 10));
    project(in);
    // projected is equivalent to in
    assertThat(projected, is(in));
    // but it's not an inplace replacement (that is never good)
    assertThat(projected, not(sameInstance(in)));
  }

  @Test
  public void invalidTupleExceptionForCurvedGeometryAndNoTolerance() {
    buildProjector(Struct.of("geom", Types.GEOMETRY), null);

    Tuple in = Tuple.ofValues(type, geomHelper.multiCurve(
        geomHelper.line(0, 0, 1, 1),
        geomHelper.line(2, 0, 3, 1)
    ));
    // it goes boom on a curved geometry
    InvalidTupleException ex = assertThrows(InvalidTupleException.class, () -> project(in));
    // and has informative problems
    assertThat(ex.getProblem(), is(InputDataProblems.get().invalidTupleError().withChildren(
        LinearGeometryProjection.PROBLMES.unexpectedCurvedGeometry(
            MultiCurve.class,
            LinearGeometryProjection.PROBLMES.enableLinearizeGeometryHint()
        )
    )));

    // sanity check the projector is fine with linear geometry
    Tuple in1 = Tuple.ofValues(type, geomHelper.multiLine(
        geomHelper.line(0, 0, 1, 1),
        geomHelper.line(2, 0, 3, 1)
    ));
    project(in1);
    assertThat(fetch("geom"), is(geomHelper.multiLine(
        geomHelper.line(0, 0, 1, 1),
        geomHelper.line(2, 0, 3, 1)
    )));
  }

  @Test
  public void willLinearizeSingleGeometry() {
    buildProjector(Struct.of("geom", Types.GEOMETRY), 0D);

    Tuple in = Tuple.ofValues(type, geomHelper.multiCurve(
        geomHelper.line(0, 0, 1, 1),
        geomHelper.line(2, 0, 3, 1)
    ));
    // sanity check that the input is a curved geom
    assertThat(in.fetch("geom"), instanceOf(MultiCurve.class));

    project(in);
    assertThat(fetch("geom"), is(geomHelper.multiLine(
        geomHelper.line(0, 0, 1, 1),
        geomHelper.line(2, 0, 3, 1)
    )));
    // ensure projected geometry is not a curve
    assertThat(fetch("geom"), allOf(
        instanceOf(MultiLineString.class),
        not(instanceOf(MultiCurve.class))
    ));
  }

  @Test
  public void willLinearizeMultipleGeometry() {
    buildProjector(Struct.of("geom", Types.GEOMETRY, "geom2", Types.GEOMETRY), 0D);

    Tuple in = Tuple.ofValues(type, geomHelper.multiCurve(
        geomHelper.line(0, 0, 1, 1),
        geomHelper.line(2, 0, 3, 1)
    ), geomHelper.multiCurve(
        geomHelper.line(0, 0, 1, 1),
        geomHelper.line(2, 0, 3, 1)
    ));
    // sanity check that the input is a curved geom
    assertThat(in.fetch("geom"), instanceOf(MultiCurve.class));

    project(in);
    assertThat(fetch("geom"), is(geomHelper.multiLine(
        geomHelper.line(0, 0, 1, 1),
        geomHelper.line(2, 0, 3, 1)
    )));
    // ensure projected geometry is not a curve
    assertThat(fetch("geom"), allOf(
        instanceOf(MultiLineString.class),
        not(instanceOf(MultiCurve.class))
    ));
    assertThat(fetch("geom2"), is(geomHelper.multiLine(
        geomHelper.line(0, 0, 1, 1),
        geomHelper.line(2, 0, 3, 1)
    )));
  }

  @Test
  public void isNullSafe() {
    buildProjector(Struct.of("geom", Nullable.GEOMETRY), 0D);
    Tuple in = Tuple.ofValues(type);

    project(in);
    assertThat(projected, is(in));
  }

  Tuple project(Tuple t) {
    projected = projector.apply(t);
    return projected;
  }

  void buildProjector(Struct sourceType, Double tolerance) {
    this.projection = new LinearGeometryProjection(Optional.ofNullable(tolerance));
    this.type = sourceType;
    this.projector = projection.getProjectionFunction(sourceType).get();
  }

  Geometry fetch(String attribute) {
    return projected.fetch(attribute);
  }

}
