CsvableBuilder.scala

/*
 * Copyright (c) 2022 bitlap
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package org.bitlap.csv.core

import org.bitlap.csv.core.macros.DeriveCsvableBuilder

/**
 * Builder to create a custom Csv Encoder.
 *
 * @author 梦境迷离
 * @version 1.0,2022/4/30
 */
class CsvableBuilder[T] {

  import java.io.File

  /**
   * Convert this CSV column string to any Scala types.
   *
   * @param scalaField The field in scala case class.
   * @param value      This function specifies how you want to convert this field to a CSV string.
   * @tparam SF The field type, generally, it is not necessary to specify, but it is safer if specify.
   * @return
   */
  def setField[SF](scalaField: T => SF, value: SF => String): CsvableBuilder[T] =
    macro DeriveCsvableBuilder.setFieldImpl[T, SF]

  /**
   * Create a custom builder for converting this scala value to CSV line string.
   *
   * @param t               The value of Scala case class.
   * @param columnSeparator The separator for CSV column value.
   * @return
   */
  def build(t: T, columnSeparator: Char): Csvable[T] = macro DeriveCsvableBuilder.buildImpl[T]

  /**
   * Make columnSeparator assign to `,` as default value.
   */
  def build(t: T): Csvable[T] = macro DeriveCsvableBuilder.buildDefaultImpl[T]

  /**
   * Convert the sequence of Scala case class to CSV string.
   *
   * @param ts               The sequence of Scala case class.
   * @param columnSeparator The separator for CSV column value.
   * @return
   */
  def convert(ts: List[T], columnSeparator: Char): String = macro DeriveCsvableBuilder.convertImpl[T]

  /**
   * Make columnSeparator assign to `,` as default value.
   */
  def convert(ts: List[T]): String = macro DeriveCsvableBuilder.convertDefaultImpl[T]

  /**
   * Convert the sequence of Scala case class to CSV string and write to file.
   *
   * @param ts               The sequence of Scala case class.
   * @param file File to save CSV string.
   * @return
   */
  def writeTo(ts: List[T], file: File): Boolean = macro DeriveCsvableBuilder.writeToFileImpl[T]

}

object CsvableBuilder {

  def apply[T <: Product]: CsvableBuilder[T] = macro DeriveCsvableBuilder.applyImpl[T]

}