[GH-5] Overhaul Render (#6)

* [GH-5] Overhaul the renderer

* [GH-5] Overhaul the renderer

* [GH-5] Fixing tests and adding Android deps

* [GH-5] Fixing tests and adding Android deps

* [GH-5] New render is go!

* [GH-5] New render is go!

* [GH-5] Updating docs

* [GH-5] Updating docs and examples

* [GH-5] Updating docs and examples

* [GH-5] Updating docs and examples

Author: g0dkar

README.md

@@ -0,0 +1,231 @@
+# qrcode-kotlin
+
+[![Licença](https://img.shields.io/github/license/g0dkar/qrcode-kotlin)](LICENSE)
+[![Maven Central](https://img.shields.io/maven-central/v/io.github.g0dkar/qrcode-kotlin.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.github.g0dkar%22%20AND%20a:%22qrcode-kotlin%22)
+
+[![Mande uma Mensagem de Agradecimento](https://img.shields.io/badge/Mande%20uma-Mensagem%20de%20Agradecimento-green?style=for-the-badge)](https://saythanks.io/to/g0dkar)
+
+[_:us: **Available in English**_](README.md)
+
+Criar QRCodes em Kotlin e Java é mais difícil do que deveria. O QRCode-Kotlin tenta trazer uma forma simples, direta e
+personalizável de se criar QRCodes para o domínio da JVM, especialmente no backend.
+
+## Vantagens do QRCode-Kotlin
+
+* **Kotlin Puro:** Reimplementação em puro Kotlin a partir da implementação de referência da especificação do QRCode
+  por [Kazuhiko Arase](https://github.com/kazuhikoarase/qrcode-generator)
+* **Leve:** Sem dependencias*, `~72KB` e faz exatamente o que promete fazer.
+* **Fácil de usar:** Instancie um objeto, chame um método e pronto :)
+* **Compacta:** Não adiciona nenhum "inchaço" como quando se usa bibliotecas como a Google ZXing (que fazem bem mais que
+  gerar QRCodes)
+* **Saída Personalizada:** Quer um QRCode colorido? Nós temos!
+* **Amigável aos Servidores:** Esta não é uma biblioteca para aplicações Mobile. Esta biblioteca foi pensada por devs
+  backend para devs backend.
+
+>\* Bom, exceto talvez a `org.jetbrains.kotlin:kotlin-stdlib-jdk8` se você estiver usando Java...
+
+## Instalação
+
+Esta biblioteca está disponível a partir da [Central Maven](https://search.maven.org/artifact/io.github.g0dkar/qrcode-kotlin/2.0.0/qrcode-kotlin),
+então basta adicionar o `QRCode-Kotlin` a seu projeto como qualquer outra dependência:
+
+**Se você utiliza Maven - pom.xml:**
+
+```xml
+<dependency>
+    <groupId>io.github.g0dkar</groupId>
+    <artifactId>qrcode-kotlin</artifactId>
+    <version>2.0.0</version>
+</dependency>
+```
+
+**Se você utiliza Gradle:**
+
+```groovy
+// Kotlin ❤️
+implementation("io.github.g0dkar:qrcode-kotlin:2.0.0")
+
+// Groovy
+implementation 'io.github.g0dkar:qrcode-kotlin:2.0.0'
+```
+
+## Exemplos e Usos
+
+Aqui estão alguns exemplos de como utilizar a biblioteca para se ter alguns resultados bacanas. Se você tiver interesse
+em usos mais avançados ou QRCodes mais sofisticados, por favor leia a documentação :)
+
+>Também lembre de checar a pasta de [exemplos](examples) para ver códigos em Kotlin e Java, e os QRCodes resultantes!
+
+### Apenas um QRCode simples, nada de mais:
+
+Para gerar um QRCode simples:
+
+```kotlin
+// Por padrão, o método writeImage() escreve PNGs
+val fileOut = FileOutputStream("example01.png")
+
+QRCode("https://github.com/g0dkar/qrcode-kotlin").render().writeImage(fileOut)
+```
+
+O mesmo que o código acima, em Java:
+
+```java
+// By default, the writeImage() method outputs PNGs
+FileOutputStream fileOut = new FileOutputStream("example01-java.png");
+
+new QRCode("https://github.com/g0dkar/qrcode-kotlin").render().writeImage(fileOut);
+```
+
+### Um QRCode, mas maior
+
+A função `render()` pode receber o parâmetro `cellSize` para ajustar o tamanho do QRCode resultante. Este parâmetro
+representa o tamanho em pixels de cada quadrado no QRCode resultante. Seu valor padrão é `25`:
+
+```kotlin
+val fileOut = FileOutputStream("example02.png")
+
+QRCode("https://github.com/g0dkar/qrcode-kotlin")
+    .render(cellSize = 50)
+    .writeImage(fileOut)
+```
+
+Em Java:
+
+```java
+FileOutputStream fileOut = new FileOutputStream("example02-java.png");
+
+new QRCode("https://github.com/g0dkar/qrcode-kotlin")
+    .render(50)
+    .writeImage(fileOut);
+```
+
+### Igual ao Google ZXing!
+
+No momento da escrita desta documentação, a [biblioteca Google ZXing](https://github.com/zxing/zxing) é amplamente
+utilizada para se gerar QRCodes. Seus resultados normalmente incluem uma "borda" _(também chamada de "margem")_ ao redor
+do QRCode, geralmente com 1 célula de tamanho. A função `render()` também pode receber um parâmetro `margin` com a
+quantidade de pixels que queremos ter como margem ao redor do QRCode. **Por padrão, o parâmetro `margin` é igual a `0`
+.**
+
+Para se ter um desses QRCodes bem espaçados, tente fazer o seguinte:
+
+```kotlin
+val fileOut = FileOutputStream("example03.png")
+val cellSize = 30 // pixels
+
+QRCode("https://github.com/g0dkar/qrcode-kotlin")
+    .render(cellSize, margin = cellSize)
+    .writeImage(fileOut)
+```
+
+Em Java:
+
+```java
+FileOutputStream fileOut = new FileOutputStream("example03-java.png");
+int cellSize = 30; // pixels
+
+new QRCode("https://github.com/g0dkar/qrcode-kotlin")
+    .render(cellSize, cellSize);
+    .writeImage(fileOut);
+```
+
+### Um toque de Cor
+
+![novo na v2.0.0](https://img.shields.io/badge/novo!-v2.0.0-critical)
+
+Quer um QRCode colorido? Fácil, fácil! A Função `render()` também tem os parâmetros `brightColor`, `darkColor` e
+`marginColor` para isso. Seus valores padrão são para quadrados Preto-e-Branco com uma margem Branca. Esses são simples
+e (bem) velhos valores `java.awt.Color` no espaço RGBA.
+
+Por diversão, este código cria um QRCode com as cores do Modo Escuro do GitHub:
+
+```kotlin
+import io.github.g0dkar.qrcode.render.Colors
+
+val background = Colors.css("#8b949e")
+val foreground = Colors.css("#0d1117")
+val fileOut = FileOutputStream("example03.png")
+
+QRCode("https://github.com/g0dkar/qrcode-kotlin").render(
+    brightColor = background, // Background
+    darkColor = foreground,   // Foreground (aka the "black squares")
+    marginColor = background  // Margin (ignored since margin = 0)
+).writeImage(fileOut)
+```
+
+Em Java:
+
+```java
+import java.awt.Color;
+
+Color background = new Color(13, 17, 23);
+Color foreground = new Color(139, 148, 158);
+FileOutputStream fileOut = new FileOutputStream("example04-java.png");
+
+new QRCode("https://github.com/g0dkar/qrcode-kotlin")
+    .render(25, 0, background.getRGB(), foreground.getRGB(), background.getRGB())
+    .writeImage(fileOut);
+```
+
+### Especificando seu próprio tipo de dados
+
+Se você não quer depender da lógica básica de identificação de tipo de dado implementada pela biblioteca, você pode
+especificar qual o tipo de dado da string de entrada. Você pode passar essa informação pelo parâmetro `dataType` no
+construtor da classe `QRCode` dessa forma:
+
+```kotlin
+// Cria um QRCode do tipo "String" ao invés do tipo "Número" (que seria identificado automaticamente)
+QRCode("42", dataType = QRCodeDataType.DEFAULT)
+```
+
+### Spring Framework e/ou Spring Boot
+
+Uma das razões principais que desenvolvi essa biblioteca foi para utilizá-la em uma API Spring Boot que necessitava
+gerar QRCodes, então é apenas natural mostrar como se fazer isso :)
+
+```kotlin
+import org.springframework.core.io.ByteArrayResource
+import org.springframework.http.HttpHeaders.CONTENT_DISPOSITION
+import org.springframework.http.MediaType.IMAGE_PNG_VALUE
+
+@GetMapping("/qrcode")
+fun generateQrCode(content: String): ResponseEntity<ByteArrayResource> {
+    val imageOut = ByteArrayOutputStream()
+
+    QRCode(content).render().writeImage(imageOut)
+
+    val imageBytes = imageOut.toByteArray()
+    val resource = ByteArrayResource(imageBytes, IMAGE_PNG_VALUE)
+
+    return ResponseEntity.ok()
+        .header(CONTENT_DISPOSITION, "attachment; filename=\"qrcode.png\"")
+        .body(resource)
+}
+```
+
+## Licença
+
+Direito Autoral 2021 Rafael M. Lins, Licenciado pela [Licença MIT (texto em inglês)](LICENSE).
+
+QR Code é marca registrada de Denso Wave, inc.
+
+## Agradecimentos e Reconhecimentos
+
+* [Kazuhiko Arase](https://github.com/kazuhikoarase): Autor da implementação de referência!
+* [Paul Varry](https://github.com/pvarry): Por abrir as primeiras issues no repositório e ajudar a fazer a biblioteca
+  melhor para todo o mundo! :grin:
+* [Renan Lukas](https://github.com/RenanLukas): Por sua amizade, paciência e ajuda com Android, Gradle e outras coisas
+  durante o desenvolvimento da v2.0.0!
+
+## Suporte e Links
+
+* Se encontrou bugs, por
+  favor [abra uma Issue](https://github.com/g0dkar/qrcode-kotlin/issues/new?assignees=g0dkar&labels=bug&template=bug_report.md&title=)
+  😁
+* Tem sugestões?
+  Você [pode fazê-las](https://github.com/g0dkar/qrcode-kotlin/issues/new?assignees=&labels=&template=feature_request.md&title=)
+  também!
+
+Se curtiu a biblioteca e quiser me pagar um café, utilize o botão abaixo :love_you_gesture:
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg "Pague um café para mim no Ko-fi!")](https://ko-fi.com/g0dkar)

README.pt_BR.md

@@ -1,5 +1,11 @@
 import org.jetbrains.dokka.gradle.DokkaTask
 
+buildscript {
+    dependencies {
+        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.6.10")
+    }
+}
+
 plugins {
     id("idea")
     signing
@@ -13,7 +19,7 @@ plugins {
 }
 
 group = "io.github.g0dkar"
-version = "1.2.1"
+version = "2.0.0"
 
 java {
     sourceCompatibility = JavaVersion.VERSION_1_8
@@ -27,10 +33,6 @@ idea {
     }
 }
 
-repositories {
-    mavenCentral()
-}
-
 dependencies {
     implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
 
@@ -76,11 +78,13 @@ ktlint {
     }
 }
 
+
+
 /* **************** */
 /* Publishing       */
 /* **************** */
-val ossrhUsername: String? = properties.getOrDefault("ossrhUsername", System.getenv("OSSRH_USER"))?.toString()
-val ossrhPassword: String? = properties.getOrDefault("ossrhPassword", System.getenv("OSSRH_PASSWORD"))?.toString()
+val ossrhUsername = properties.getOrDefault("ossrhUsername", System.getenv("OSSRH_USER"))?.toString()
+val ossrhPassword = properties.getOrDefault("ossrhPassword", System.getenv("OSSRH_PASSWORD"))?.toString()
 
 val dokkaHtml by tasks.getting(DokkaTask::class)
 val javadocJar: TaskProvider<Jar> by tasks.registering(Jar::class) {
@@ -120,7 +124,7 @@ publishing {
                 licenses {
                     license {
                         name.set("MIT")
-                        url.set("https://github.com/g0dkar/qrcode-kotlin/blob/main/LICENSE")
+                        url.set("$projectGitUrl/blob/main/LICENSE")
                     }
                 }
                 developers {
@@ -165,6 +169,8 @@ signing {
     sign(publishing.publications)
 }
 
+
+
 /* *************************** */
 /* SonarQube Quality Reporting */
 /* *************************** */

build.gradle.kts

@@ -4,8 +4,9 @@ plugins {
 
 repositories {
     mavenCentral()
+    mavenLocal()
 }
 
 dependencies {
-    implementation("io.github.g0dkar:qrcode-kotlin:1.1.0")
+    implementation("io.github.g0dkar:qrcode-kotlin:2.0.0")
 }

examples/java-colored.png

@@ -2,13 +2,11 @@
 
 import io.github.g0dkar.qrcode.QRCode;
 import java.awt.Color;
-import java.awt.image.BufferedImage;
-import java.io.File;
+import java.io.FileOutputStream;
 import java.io.IOException;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Random;
-import javax.imageio.ImageIO;
 
 public class ColoredQRCode {
 
@@ -21,9 +19,16 @@ public void createQRCode(
         String filename
     ) throws IOException {
         String destination = ofNullable(filename).orElse(DEFAULT_FILENAME);
+        FileOutputStream fileOut = new FileOutputStream(destination);
         QRCode qrCode = new QRCode(content);
-        BufferedImage imageData = qrCode.render(25, 0, qrCode.encode(), backgroundColor, squareColor);
-        ImageIO.write(imageData, "PNG", new File(destination));
+
+        qrCode.render(
+                  QRCode.DEFAULT_CELL_SIZE,
+                  QRCode.DEFAULT_MARGIN,
+                  backgroundColor.getRGB(),
+                  squareColor.getRGB()
+              )
+              .writeImage(fileOut);
     }
 
     public static void main(String[] args) throws Exception {