Adjust the api (#12)

Author: wi101

README.md

@@ -2,19 +2,31 @@
 
 You can add an artistic touch to your console.
 
-## Usage
+To use embroidery, add the following line in your `build.sbt` file:
+```
+libraryDependencies += "com.github.wi101" %% "embroidery" % "0.1.1"
+```
 
-This is an example usage:
+## Usage
 
 1. Convert your text to ASCII Art:
 `title.asciiArt` returns a String that you can display or use in your project.
+ Or you can use the syntax `title.toAsciiArt`.
 
 ```scala
-import embroidery.asciiArt.title
+import embroidery.title
 
 title.asciiArt("Hello world")
 ```
 
+Or:
+
+```scala
+import embroidery._
+
+"Hello".toAsciiArt
+```
+
 Output:
 
 ```
@@ -32,11 +44,16 @@ Output:
 You can specify the spaces between the character.
 For example, if you would like to display S c a l a, you can call:
 ```scala
-import embroidery.asciiArt._
+import embroidery.title
 
 title.asciiArt("Scala", art = 'S', spaces = 1)
 ```
+Or
+```scala
+import embroidery._
 
+"Scala".toAsciiArt(art = 'S', spaces = 1)
+```
 Output:
 
 ```
@@ -57,42 +74,72 @@ WARNNG: The title should be short to be able to display it in your screen (maxim
 2. Convert your LOGO to ASCII Art:
 
 You can get the Ascii Art of your icons using `logo.asciiArt` method.
+Or you can use the syntax `logoPath.toAsciiArt`.
+
+```scala
+import embroidery.logo
 
-```
 logo.asciiArt("src/test/scala/embroidery/asciiArt/logos/images/pikachu.png")
 ```
+
+OR
+
+```scala
+import embroidery._
+
+ImagePath("src/test/scala/embroidery/asciiArt/logos/images/pikachu.png").toAsciiArt
+```
 | pikachu.png | result with ASCII Art |
 | --- | --- |
 | ![pikachu](https://user-images.githubusercontent.com/3535357/87250424-f0908c00-c464-11ea-9bb9-bc92b23ca63d.png) | ![pikachu](https://user-images.githubusercontent.com/3535357/87250405-d48cea80-c464-11ea-9ccc-ce13d4ef60dd.png) |
 
-```
+```scala
+import embroidery.logo
+
 logo.asciiArt("src/test/scala/embroidery/asciiArt/logos/images/zio.png")
 ```
+
+OR
+
+```scala
+import embroidery._
+
+ImagePath("src/test/scala/embroidery/asciiArt/logos/images/zio.png").toAsciiArt
+```
+
 | zio.png | result with ASCII Art |
 | --- | --- |
 | ![zio](https://user-images.githubusercontent.com/3535357/87250611-49145900-c466-11ea-8f75-ccfacc4bae05.png) | ![zio](https://user-images.githubusercontent.com/3535357/87250628-7234e980-c466-11ea-87c1-ae82c09703ce.png) | 
 
-```
+```scala
+import embroidery.logo
+
 logo.asciiArt("src/test/scala/embroidery/asciiArt/logos/images/scala.jpg")
 ```
+
+OR
+
+```scala
+import embroidery._
+
+ImagePath("src/test/scala/embroidery/asciiArt/logos/images/scala.jpg").toAsciiArt
+```
+
 | scala.jpg | result with ASCII Art |
 | --- | --- |
 |![scala](https://user-images.githubusercontent.com/3535357/36055500-2611c978-0dfd-11e8-8ca4-15c689fa0438.jpg) | ![scala](https://user-images.githubusercontent.com/3535357/87250678-d8ba0780-c466-11ea-9e4d-bd1b7de03119.png) |
 
 You can also decide which characters to use on each brightness level:
 
 ```scala
-import embroidery.asciiArt._
+import embroidery._
 
  val pixelsWithArt: List[PixelAsciiArt] = List(
     PixelAsciiArt(Pixel(255), Art(' ')),
     PixelAsciiArt(Pixel(0), Art('#'))
   )
 
-  val img: String = logo.asciiArt(
-    "src/test/scala/embroidery/asciiArt/images/zio.png",
-    pixelsWithArt
-  )
+  val img: String = ImagePath("src/test/scala/embroidery/asciiArt/images/zio.png").toAsciiArt(pixelsWithArt)
   val s = img.flatMap(
     c =>
       if (c != ' ' && c != '\n')
@@ -109,7 +156,8 @@ Output:
 You can also control the size of your logo:
 
 ```scala
-import embroidery.asciiArt._
+import embroidery._
+
   val pixelsWithArt: List[PixelAsciiArt] = List(
       PixelAsciiArt(Pixel(255), Art(' ')),
       PixelAsciiArt(Pixel(230), Art('.')),
@@ -134,6 +182,7 @@ import embroidery.asciiArt._
     100,
     50
   )
+// The same as: ImagePath("...").toAsciiArt(pixelsWithArt, 100, 50)
   val scala = img.flatMap(
     c =>
       if (c != ' ' && c != '\n')

…ala/embroidery/asciiArt/Embroidery.scala …c/main/scala/embroidery/Embroidery.scalasrc/main/scala/embroidery/asciiArt/Embroidery.scala renamed to src/main/scala/embroidery/Embroidery.scala src/main/scala/embroidery/asciiArt/Embroidery.scala renamed to src/main/scala/embroidery/Embroidery.scala

@@ -1,4 +1,4 @@
-package embroidery.asciiArt
+package embroidery
 
 import java.awt.Color
 import java.awt.image.BufferedImage
@@ -44,7 +44,7 @@ abstract class Embroidery { self =>
         Try {
           val matrix = toPixelMatrix
           matrix.pixels.foldLeft("") { (asciiArt, lines) =>
-            asciiArt + lines.map(getAsciiArt).mkString + "\n"
+            asciiArt + lines.map(getAsciiArt).mkString + System.getProperty("line.separator")
           }
         }.recover { case err => s"$RED<error>$RESET Input couldn't be converted to ASCII Art. Reason: $err." }
           .getOrElse(s"$RED<error>$RESET Unexpected error!")

src/main/scala/embroidery/asciiArt/logo/package.scala

@@ -1,13 +1,13 @@
-package embroidery
-package asciiArt
-package logo
+package embroidery.logo
 
 import java.awt.Image
 import java.awt.image.BufferedImage
 import java.io.{ File, IOException }
 import javax.imageio.ImageIO
 
-final case class LogoArt private (logo: BufferedImage, url: URL, logoStyle: LogoStyle) extends Embroidery {
+import embroidery.{ Embroidery, Pixel }
+
+final case class LogoArt private (logo: BufferedImage, url: LogoPath, logoStyle: LogoStyle) extends Embroidery {
 
   override def drawImage(): BufferedImage = {
     val (width, height) =
@@ -51,17 +51,24 @@ object LogoArt {
   def apply(imgPath: String, maybeLogoStyle: Either[String, LogoStyle]): Embroidery = {
     val result = for {
       logoStyle <- maybeLogoStyle
-      url       <- URL(imgPath)
-      logo      <- readLogo(url)
+      url = LogoPath(imgPath)
+      logo <- readLogo(url)
     } yield LogoArt(logo, url, logoStyle)
     result.fold(Embroidery.Empty, identity)
   }
 
-  private def readLogo(url: URL): Either[String, BufferedImage] =
+  private def readLogo(url: LogoPath): Either[String, BufferedImage] =
     try {
-      val bufferedImage = ImageIO.read(new File(url.value))
-      if (bufferedImage.getWidth == 0 || bufferedImage.getHeight == 0) Left("Width and Height should be > 0")
-      else Right(bufferedImage)
+      def isValid: Boolean = {
+        val regex = "[^\\s]+(\\.(?i)(jpg|jpeg|png|bmp))$"
+        url.value.matches(regex)
+      }
+      if (isValid) {
+        val bufferedImage = ImageIO.read(new File(url.value))
+        if (bufferedImage.getWidth == 0 || bufferedImage.getHeight == 0) Left("Width and Height should be > 0")
+        else Right(bufferedImage)
+      } else
+        Left(s"Invalid path: $url, Embroidery supports only: jpg, jpeg, png, bmp formats.")
     } catch {
       case ex: IOException => Left(ex.getMessage)
     }

src/main/scala/embroidery/asciiArt/title/package.scala

@@ -1,19 +1,8 @@
-package embroidery.asciiArt
+package embroidery
 package logo
 
-final case class URL private (value: String) extends AnyVal {
-  def isValid: Boolean = {
-    val regex = "[^\\s]+(\\.(?i)(jpg|jpeg|png|bmp))$"
-    value.matches(regex)
-  }
-}
-
-object URL {
-  def apply(path: String): Either[String, URL] = {
-    val url = new URL(path)
-    if (url.isValid) Right(url)
-    else Left(s"Invalid path: $path, Embroidery supports only: jpg, jpeg, png, bmp formats.")
-  }
+final case class LogoPath(value: String) {
+  override def toString: String = value
 }
 
 // Logo
@@ -24,20 +13,21 @@ final case class Size(width: Int, height: Int) {
 }
 
 final case class LogoStyle private (
-    pixelsWithArt: List[PixelAsciiArt] = PixelAsciiArt.pixelsWithArt,
-    maxSize: Size = Size(100, 100)
+    pixelsWithArt: List[PixelAsciiArt],
+    maxSize: Size
 ) {
   def isValid: Boolean = maxSize.width > 10 || maxSize.height > 10
   val darkestArt: Art =
     pixelsWithArt.lastOption.map(_.art).getOrElse(Art('#'))
 }
 
 object LogoStyle {
-  val default: Either[String, LogoStyle] = Right(new LogoStyle(PixelAsciiArt.pixelsWithArt))
   val MinSize                            = Size(20, 20)
+  val defaultSize                        = Size(100, 100)
+  val default: Either[String, LogoStyle] = Right(new LogoStyle(PixelAsciiArt.pixelsWithArt, defaultSize))
   def apply(
       pixelsWithArt: List[PixelAsciiArt] = PixelAsciiArt.pixelsWithArt,
-      maxSize: Size = Size(100, 100)
+      maxSize: Size = defaultSize
   ): Either[String, LogoStyle] = {
     if (maxSize.width >= MinSize.width || maxSize.height >= MinSize.height) Right(new LogoStyle(pixelsWithArt, maxSize))
     else Left(s"$maxSize is invalid, it should be at least $MinSize")

…a/embroidery/asciiArt/logo/LogoArt.scala …main/scala/embroidery/logo/LogoArt.scalasrc/main/scala/embroidery/asciiArt/logo/LogoArt.scala renamed to src/main/scala/embroidery/logo/LogoArt.scala src/main/scala/embroidery/asciiArt/logo/LogoArt.scala renamed to src/main/scala/embroidery/logo/LogoArt.scala

@@ -0,0 +1,16 @@
+package embroidery
+
+package object logo {
+
+  def asciiArt(path: String): String =
+    LogoArt(path, LogoStyle.default).toAsciiArt
+
+  def asciiArt(path: String, pixelsWithArt: List[PixelAsciiArt]): String =
+    LogoArt(path, LogoStyle(pixelsWithArt)).toAsciiArt
+
+  def asciiArt(path: String, width: Int, height: Int): String =
+    LogoArt(path, LogoStyle(maxSize = Size(width, height))).toAsciiArt
+
+  def asciiArt(path: String, pixelsWithArt: List[PixelAsciiArt], width: Int, height: Int): String =
+    LogoArt(path, LogoStyle(pixelsWithArt, Size(width, height))).toAsciiArt
+}

…ala/embroidery/asciiArt/logo/model.scala …c/main/scala/embroidery/logo/model.scalasrc/main/scala/embroidery/asciiArt/logo/model.scala renamed to src/main/scala/embroidery/logo/model.scala src/main/scala/embroidery/asciiArt/logo/model.scala renamed to src/main/scala/embroidery/logo/model.scala

@@ -1,4 +1,4 @@
-package embroidery.asciiArt
+package embroidery
 
 // Common Data types
 final case class Art(value: Char) extends AnyVal

src/main/scala/embroidery/logo/package.scala

@@ -0,0 +1,44 @@
+package object embroidery {
+
+  /**
+    * Apply asciiArt to any string
+    */
+  implicit class TitleHelper(val text: String) extends AnyVal {
+    def toAsciiArt: String =
+      title.asciiArt(text)
+
+    def toAsciiArt(art: Char): String =
+      title.asciiArt(text, art = art)
+
+    def toAsciiArt(art: Char, spaces: Int): String =
+      title.asciiArt(text, art = art, spaces = spaces)
+
+    def toAsciiArt(spaces: Int): String =
+      title.asciiArt(text, spaces = spaces)
+  }
+
+  /**
+    * Apply asciiArt to any image path.
+    * @example
+    * ImagePath("src/img/logo.png").toAsciiArt
+    */
+  type ImagePath     = logo.LogoPath
+  type PixelAsciiArt = logo.PixelAsciiArt
+  val ImagePath: logo.LogoPath.type          = logo.LogoPath
+  val PixelAsciiArt: logo.PixelAsciiArt.type = logo.PixelAsciiArt
+
+  implicit class LogoHelper(val path: ImagePath) extends AnyVal {
+    def toAsciiArt: String =
+      logo.asciiArt(path.value)
+
+    def toAsciiArt(pixelsWithArt: List[PixelAsciiArt]): String =
+      logo.asciiArt(path.value, pixelsWithArt)
+
+    def toAsciiArt(width: Int, height: Int): String =
+      logo.asciiArt(path.value, width, height)
+
+    def toAsciiArt(pixelsWithArt: List[PixelAsciiArt], width: Int, height: Int): String =
+      logo.asciiArt(path.value, pixelsWithArt, width, height)
+  }
+
+}

…in/scala/embroidery/asciiArt/model.scala src/main/scala/embroidery/model.scalasrc/main/scala/embroidery/asciiArt/model.scala renamed to src/main/scala/embroidery/model.scala src/main/scala/embroidery/asciiArt/model.scala renamed to src/main/scala/embroidery/model.scala

@@ -1,4 +1,4 @@
-package embroidery.asciiArt
+package embroidery
 package title
 
 import java.awt.Font
@@ -33,6 +33,6 @@ final case class TitleArt private (title: Title) extends Embroidery {
 }
 
 object TitleArt {
-  def apply(value: String, style: TitleStyle): Embroidery =
+  def apply(value: String, style: TitleStyle = TitleStyle.default): Embroidery =
     Title(value, style).fold[Embroidery](Embroidery.Empty, TitleArt(_))
 }