/*
 * 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.bind.impl;

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

import java.net.URI;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;

import org.junit.Before;
import org.junit.Test;

import nz.org.riskscape.engine.ProjectTest;
import nz.org.riskscape.engine.TemporaryDirectoryTestHelper;
import nz.org.riskscape.engine.data.Bookmark;
import nz.org.riskscape.engine.function.ArgumentList;
import nz.org.riskscape.engine.function.BaseRealizableFunction;
import nz.org.riskscape.engine.function.RiskscapeFunction;
import nz.org.riskscape.engine.problem.GeneralProblems;
import nz.org.riskscape.engine.rl.RealizationContext;
import nz.org.riskscape.engine.types.Type;
import nz.org.riskscape.engine.types.Types;
import nz.org.riskscape.engine.types.WithMetadata;
import nz.org.riskscape.problem.ResultOrProblems;
import nz.org.riskscape.rl.ast.FunctionCall;

public class BookmarkBinderTest extends ProjectTest implements TemporaryDirectoryTestHelper {

  // we use bookmark_test() to check we can bind against expression, if that
  // expression yields a bookmark in WithMetadata that it returns
  public static class BookmarkTestFunction extends BaseRealizableFunction {
    public BookmarkTestFunction() {
      super(ArgumentList.create("id", Types.TEXT), Types.ANYTHING);
    }

    @Override
    public ResultOrProblems<RiskscapeFunction> realize(RealizationContext context, FunctionCall functionCall,
        List<Type> argumentTypes) {
      // just lookup the bookmark that matches the ID, if any
      Bookmark bookmark = arguments.getRequiredArgument(functionCall, "id")
        .flatMap(idArg -> idArg.evaluateConstant(context, String.class, Types.TEXT))
        .flatMap(id -> context.getProject().getBookmarks().getOr(id))
        .orElse(null);
      return ResultOrProblems.of(RiskscapeFunction.create(this, argumentTypes,
          bookmark == null ? Types.TEXT : WithMetadata.wrap(Types.TEXT, bookmark),
          args -> "foo"));
    }
  }

  BookmarkBinder binder = new BookmarkBinder();
  Bookmark bookmark = Bookmark.fromURI(URI.create("foo:bar"));

  @Before
  public void setup() {
    project.add(bookmark);
  }

  @Test
  public void testCanLookupABookmarkById() throws Exception {
    assertThat(binder.bindValue(bindingContext, bookmark.getId(), Bookmark.class).get(), is(bookmark));
  }


  @Test
  public void testCanLookupABookmarkByQuotedId() throws Exception {
    assertThat(binder.bindValue(bindingContext, "'" + bookmark.getId() + "'", Bookmark.class).get(), is(bookmark));
  }

  @Test
  public void testCanLookupABookmarkByDoubleQuotedId() throws Exception {
    assertThat(binder.bindValue(bindingContext, '"' + bookmark.getId() + '"', Bookmark.class).get(), is(bookmark));
  }

  @Test
  public void aMissingBookmarkReturnsAFailedResult() throws Exception {
    String invalidId = "nonexistent_bookmark";
    ResultOrProblems<Bookmark> result = binder.bindValue(bindingContext, invalidId, Bookmark.class);

    assertThat(
        result.getAsSingleProblem(),
        equalTo(GeneralProblems.get().noSuchObjectExists(invalidId, Bookmark.class))
    );
  }

  // couple of negative tests here to show that the changed bookmark binding behaviour will not attempt to open a file
  // - that's something that resolving should or could do (but not binding to a bookmark)
  @Test
  public void bindingBookmarksDoesNotTryToConvertAUriInToAnAnonymousBookmark() throws Exception {
    String invalidId = "http://example.com/bookmark";
    ResultOrProblems<Bookmark> result = binder.bindValue(bindingContext, invalidId, Bookmark.class);

    assertThat(
        result.getAsSingleProblem(),
        equalTo(GeneralProblems.get().noSuchObjectExists(invalidId, Bookmark.class))
    );
  }

  @Test
  public void bindingBookmarksDoesNotTryToConvertALocalFileInToAnAnonymousBookmark() throws Exception {
    // Try to bind a local file path - this should create an anonymous bookmark from the file path
    Path file = Files.createTempFile("test", ".csv");

    ResultOrProblems<Bookmark> result = binder.bindValue(bindingContext, file.toString(), Bookmark.class);

    assertThat(
        result.getAsSingleProblem(),
        equalTo(GeneralProblems.get().noSuchObjectExists(file.toString(), Bookmark.class))
    );
  }
}
