/*
    * SPDX-FileCopyrightText: none
    * SPDX-License-Identifier: CC0-1.0
    */
   
   package dev.metaschema.core.metapath;
   
   import org.jmock.Expectations;
   import org.jmock.Mockery;
  import org.jmock.junit5.JUnit5Mockery;
  import org.jmock.lib.concurrent.Synchroniser;
  import org.junit.jupiter.api.extension.RegisterExtension;
  
  import java.io.File;
  import java.net.URI;
  import java.util.stream.Stream;
  
  import dev.metaschema.core.metapath.item.node.IDocumentNodeItem;
  import dev.metaschema.core.metapath.item.node.INodeItem;
  import dev.metaschema.core.util.ObjectUtils;
  import edu.umd.cs.findbugs.annotations.NonNull;
  
  public class ExpressionTestBase {
    /**
     * A Metaschema model namespace for use in unit tests.
     */
    @NonNull
    protected static final String NS = "http://example.com/ns";
  
    @SuppressWarnings("exports")
    @NonNull
    @RegisterExtension
    public final Mockery context = new JUnit5Mockery() {
      {
        setThreadingPolicy(new Synchroniser());
      }
    };
  
    /**
     * Get the mocking context.
     *
     * @return the mocking context
     */
    @NonNull
    protected Mockery getContext() {
      return context;
    }
  
    /**
     * Construct a new dynamic context for testing.
     *
     * @return the dynamic context
     */
    @NonNull
    protected static DynamicContext newDynamicContext() {
      URI baseUri = ObjectUtils.notNull(new File("").getAbsoluteFile().toURI());
  
      return new DynamicContext(StaticContext.builder()
          .baseUri(baseUri)
          .defaultModelNamespace(NS)
          .build());
    }
  
    /**
     * Get a mocked document node item.
     *
     * @return the mocked node item
     */
    @NonNull
    protected IDocumentNodeItem newDocumentNodeMock() {
      IDocumentNodeItem retval = getContext().mock(IDocumentNodeItem.class);
      assert retval != null;
  
      getContext().checking(new Expectations() {
        { // NOPMD - intentional
          allowing(retval).getNodeItem();
          will(returnValue(retval));
          allowing(retval).ancestorOrSelf();
          will(returnValue(Stream.of(retval)));
        }
      });
  
      return retval;
    }
  
    /**
     * Get a mocked node item.
     *
     * @param mockName
     *          the name of the mocked object
     *
     * @return the mocked node item
     */
    @NonNull
    protected INodeItem newNonDocumentNodeMock(@NonNull String mockName) {
      INodeItem retval = getContext().mock(INodeItem.class, mockName);
      assert retval != null;
  
      getContext().checking(new Expectations() {
       { // NOPMD - intentional
         allowing(retval).getNodeItem();
         will(returnValue(retval));
         allowing(retval).ancestorOrSelf();
         will(returnValue(Stream.of(retval)));
       }
     });
 
     return retval;
   }
 }