content: /*
   *  Licensed to the Apache Software Foundation (ASF) under one
   *  or more contributor license agreements.  See the NOTICE file
   *  distributed with this work for additional information
   *  regarding copyright ownership.  The ASF licenses this file
   *  to you under the Apache License, Version 2.0 (the
   *  "License"); you may not use this file except in compliance
   *  with the License.  You may obtain a copy of the License at
   *
   *        http://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing,
   *  software distributed under the License is distributed on an
   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   *  KIND, either express or implied.  See the License for the
   *  specific language governing permissions and limitations
   *  under the License.
   */
  package org.apache.causeway.extensions.excel.testing;
  
  import java.io.InputStream;
  import java.net.URL;
  import java.util.Arrays;
  import java.util.List;
  
  import jakarta.inject.Inject;
  import jakarta.inject.Named;
  
  import org.apache.causeway.applib.annotation.DomainObject;
  import org.apache.causeway.applib.annotation.Programmatic;
  import org.apache.causeway.applib.annotation.PropertyLayout;
  import org.apache.causeway.applib.services.factory.FactoryService;
  import org.apache.causeway.applib.value.Blob;
  import org.apache.causeway.commons.internal.base._Bytes;
  import org.apache.causeway.extensions.excel.applib.CausewayModuleExtExcelApplib;
  import org.apache.causeway.extensions.excel.applib.ExcelService;
  import org.apache.causeway.extensions.excel.applib.WorksheetSpec;
  import org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScript;
  import org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScriptWithExecutionStrategy;
  import org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScripts;
  
  import lombok.Getter;
  import lombok.Setter;
  
  /**
   *
   * @since 2.0 {@index}
   */
  @Named(ExcelFixture2.LOGICAL_TYPE_NAME)
  @DomainObject
  public class ExcelFixture2 extends FixtureScript implements FixtureScriptWithExecutionStrategy {
  
      public final static String LOGICAL_TYPE_NAME = CausewayModuleExtExcelApplib.NAMESPACE + ".ExcelFixture2";
  
      @Inject FactoryService factoryService;
      @Inject ExcelService excelService;
  
      /**
       * Input, optional: defines the name of the resource.
       */
      @Getter @Setter
      @PropertyLayout(sequence = "1.1")
      private String excelResourceName;
  
      /**
       * Input, either this or the blob is mandatory ... the Excel spreadsheet to read.
       */
      @Getter @Setter
      @PropertyLayout(sequence = "1.2")
      private URL excelResource;
  
      /**
       * Input, either this or the excelResource is mandatory ... the Excel spreadsheet to read.
       */
      @Getter @Setter
      private Blob blob;
  
      /**
       * Input, mandatory ... how to process each sheet of the workbook.
       */
      @Getter @Setter
      WorksheetSpec.Matcher matcher;
  
      /**
       * Input, optional ... which sequence to process the matched sheets
       */
      @Getter @Setter
      private WorksheetSpec.Sequencer sequencer;
  
      protected <T> WorksheetSpec.RowFactory<T> rowFactoryFor(
              final Class<T> rowClass,
              final ExecutionContext ec) {
  
          return new WorksheetSpec.RowFactory<T>() {
              @Override
              public T create() {
                  final T importLine =
                          factoryService.getOrCreate(rowClass);
                  // allow the line to interact with the calling fixture
                  if(importLine instanceof FixtureAwareRowHandler<?>) {
                      final FixtureAwareRowHandler<?> farh = (FixtureAwareRowHandler<?>) importLine;
                      farh.setExecutionContext(ec);
                      farh.setExcelFixture2(ExcelFixture2.this);
                  }
                  return importLine;
              }
  
              @Override
              public Class<?> getCls() {
                  return rowClass;
              }
          };
      }
  
      /**
       * Output... a list of list of objects (each representing a row of a sheet)
       */
      @Programmatic // list of list not allowed to enter meta-model
      @Getter
      private List<List<?>> lists;
  
      @Override
      protected void execute(final ExecutionContext executionContext) {
  
          if (blob == null){
              byte[] bytes = getBytes();
              blob = new Blob("unused", ExcelService.XSLX_MIME_TYPE, bytes);
          }
  
          this.lists = excelService.fromExcel(blob, matcher, sequencer);
      }
  
      private byte[] bytes;
      private byte[] getBytes() {
          if (bytes == null) {
              if (blob != null){
                  bytes = blob.getBytes();
              } else {
                  bytes = readBytes();
              }
          }
          return bytes;
      }
  
      private byte[] readBytes() {
          try(final InputStream is = getExcelResource().openStream()) {
              return _Bytes.of(is);
          } catch (Exception e) {
              throw new IllegalArgumentException("Could not read from resource: " + getExcelResource());
          }
      }
  
      @Override
      public FixtureScripts.MultipleExecutionStrategy getMultipleExecutionStrategy() {
          return FixtureScripts.MultipleExecutionStrategy.EXECUTE_ONCE_BY_VALUE;
      }
  
      @Override
      public boolean equals(final Object o) {
          if (this == o)
              return true;
          if (o == null || getClass() != o.getClass())
              return false;
  
          final ExcelFixture2 that = (ExcelFixture2) o;
  
          return Arrays.equals(getBytes(), that.getBytes());
  
      }
  
      @Override
      public int hashCode() {
          return Arrays.hashCode(getBytes());
      }
  
  }
  