Merge pull request #2 from onixbyte/release/v1.0.0

Release/v1.0.0

Author: zihluwang

.gitignore

@@ -106,7 +106,7 @@ http-client.private.env.json
 gradle-app.setting
 
 # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
-!gradle-wrapper.jar
+!/gradle/wrapper/gradle-wrapper.jar
 
 # Avoid ignore Gradle wrappper properties
 !gradle-wrapper.properties
@@ -134,13 +134,14 @@ gradle-app.setting
 .mtj.tmp/
 
 # Package Files #
-*.jar
 *.war
 *.nar
 *.ear
 *.zip
 *.tar.gz
 *.rar
+*.jar
+!/gradle/wrapper/gradle-wrapper.jar
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*

README.md

@@ -52,44 +52,47 @@ import com.onixbyte.captcha.noise.NoiseProducer;
 import com.onixbyte.captcha.noise.impl.DefaultNoiseProducer;
 import com.onixbyte.captcha.text.TextProducer;
 import com.onixbyte.captcha.text.WordRenderer;
-import com.onixbyte.captcha.text.impl.DefaultTextCreator;
+import com.onixbyte.captcha.text.impl.DefaultTextProducer;
 import com.onixbyte.captcha.text.impl.DefaultWordRenderer;
 
 import javax.imageio.ImageIO;
 import java.awt.*;
 import java.awt.image.BufferedImage;
 import java.io.File;
 import java.io.IOException;
-import java.util.Collections;
 
 public class CaptchaExample {
 
     public static void main(String[] args) throws IOException {
         // Define producers and engines
-        TextProducer textProducer = new DefaultTextCreator();
-        WordRenderer wordRenderer = new DefaultWordRenderer(
-                Color.BLACK,
-                Collections.singletonList(new Font("Arial", Font.BOLD, 40))
-        );
-        GimpyEngine gimpyEngine = new WaterRipple(new DefaultNoiseProducer());
-        BackgroundProducer backgroundProducer = new DefaultBackgroundProducer(
-                Color.WHITE,
-                Color.LIGHT_GRAY
-        );
-        NoiseProducer noiseProducer = new DefaultNoiseProducer();
+        TextProducer textProducer = DefaultTextProducer.builder()
+                // .length(6) // default length is 6
+                // .chars("ABCDEFGHIJKLMNOPQRSTUVWXYZ".toCharArray()) // default available characters are 'a' to 'z', 'A' to 'Z' and '0' - '9'
+                .build();
+        WordRenderer wordRenderer = DefaultWordRenderer.builder()
+                // .fontColour(Color.BLACK) // default to Color.BLACK
+                // .fonts(new Font("Arial", Font.BOLD, 40)) // default to (Arial Bold 40) and (Courier, Bold, 40)
+                // .fontSize(40) // default to 40
+                // .charSpace(2) // default to 2
+                .build();
+        NoiseProducer noiseProducer = DefaultNoiseProducer.builder()
+                // .noiseColour(Color.BLACK) // default to Color.BLACK
+                .build();
+        GimpyEngine gimpyEngine = WaterRipple.builder()
+                // .noiseProducer(DefaultNoiseProducer.builder().build()) // default to DefaultNoiseProducer with default configurations
+                .build();
+        BackgroundProducer backgroundProducer = DefaultBackgroundProducer.builder()
+                // .colourFrom(Color.WHITE) // default to Color.LIGHT_GRAY
+                // .colourTo(Color.LIGHT_GRAY) // default to Color.WHITE
+                .build();
 
         // Create a CAPTCHA producer
-        Producer captcha = new DefaultCaptchaProducer(
-                wordRenderer,
-                gimpyEngine,
-                backgroundProducer,
-                200,
-                50,
-                true,
-                Color.BLACK,
-                1,
-                textProducer
-        );
+        Producer captcha = DefaultCaptchaProducer.builder()
+                .textProducer(textProducer) // default to DefaultTextProducer with default configurations
+                .wordRenderer(wordRenderer) // default to DefaultWordRenderer with default configurations
+                .gimpyEngine(gimpyEngine) // default to WaterRipple with default configurations
+                .backgroundProducer(backgroundProducer) // default to DefaultBackgroundProducer with default configurations
+                .build();
 
         // Generate text and create the image
         String captchaText = captcha.createText();

gradle/wrapper/gradle-wrapper.jar

@@ -1,4 +1,3 @@
-#Sun Oct 26 12:17:38 CST 2025
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 distributionUrl=https\://services.gradle.org/distributions/gradle-8.14-bin.zip

gradle/wrapper/gradle-wrapper.properties

@@ -29,7 +29,7 @@
 import com.onixbyte.captcha.gimpy.impl.WaterRipple;
 import com.onixbyte.captcha.text.TextProducer;
 import com.onixbyte.captcha.text.WordRenderer;
-import com.onixbyte.captcha.text.impl.DefaultTextCreator;
+import com.onixbyte.captcha.text.impl.DefaultTextProducer;
 import com.onixbyte.captcha.text.impl.DefaultWordRenderer;
 
 import java.awt.BasicStroke;
@@ -192,14 +192,14 @@ public static class DefaultCaptchaProducerBuilder {
 
         private DefaultCaptchaProducerBuilder() {
             this.wordRenderer = DefaultWordRenderer.builder().build();
-            this.gimpyEngine = (GimpyEngine) WaterRipple.builder().build();
+            this.gimpyEngine = WaterRipple.builder().build();
             this.backgroundProducer = DefaultBackgroundProducer.builder().build();
             this.width = 200;
             this.height = 50;
             this.borderDrawn = true;
             this.borderColour = Color.BLACK;
             this.borderThickness = 1;
-            this.textProducer = DefaultTextCreator.builder().build();
+            this.textProducer = DefaultTextProducer.builder().build();
         }
 
         /**

src/main/java/com/onixbyte/captcha/impl/DefaultCaptchaProducer.java

@@ -23,7 +23,6 @@
 package com.onixbyte.captcha.noise.impl;
 
 import com.onixbyte.captcha.noise.NoiseProducer;
-import com.onixbyte.captcha.text.impl.DefaultTextCreator;
 
 import java.awt.image.BufferedImage;
 

src/main/java/com/onixbyte/captcha/noise/impl/NoNoiseProducer.java

@@ -31,13 +31,13 @@
 /**
  * The default implementation of {@link TextProducer}.
  */
-public class DefaultTextCreator implements TextProducer {
+public class DefaultTextProducer implements TextProducer {
 
     private final int length;
 
     private final char[] chars;
 
-    private DefaultTextCreator(int length, char[] chars) {
+    private DefaultTextProducer(int length, char[] chars) {
         this.length = length;
         this.chars = chars;
     }
@@ -58,22 +58,22 @@ public String getText() {
     }
 
     /**
-     * Creates a new {@link DefaultTextCreatorBuilder}.
+     * Creates a new {@link DefaultTextProducerBuilder}.
      *
-     * @return a new {@link DefaultTextCreatorBuilder}
+     * @return a new {@link DefaultTextProducerBuilder}
      */
-    public static DefaultTextCreatorBuilder builder() {
-        return new DefaultTextCreatorBuilder();
+    public static DefaultTextProducerBuilder builder() {
+        return new DefaultTextProducerBuilder();
     }
 
     /**
-     * A builder for creating {@link DefaultTextCreator} instances.
+     * A builder for creating {@link DefaultTextProducer} instances.
      */
-    public static class DefaultTextCreatorBuilder {
+    public static class DefaultTextProducerBuilder {
         private int length;
         private char[] chars;
 
-        private DefaultTextCreatorBuilder() {
+        private DefaultTextProducerBuilder() {
             this.length = 6;
             this.chars = new char[]{
                     'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p',
@@ -89,7 +89,7 @@ private DefaultTextCreatorBuilder() {
          * @param length the length
          * @return this builder
          */
-        public DefaultTextCreatorBuilder length(int length) {
+        public DefaultTextProducerBuilder length(int length) {
             if (length <= 0) {
                 throw new IllegalArgumentException("Length should be greater than 0.");
             }
@@ -103,7 +103,7 @@ public DefaultTextCreatorBuilder length(int length) {
          * @param chars the characters
          * @return this builder
          */
-        public DefaultTextCreatorBuilder chars(char[] chars) {
+        public DefaultTextProducerBuilder chars(char[] chars) {
             if (Objects.isNull(chars) || chars.length == 0) {
                 throw new IllegalArgumentException("Chars cannot be empty.");
             }
@@ -112,12 +112,12 @@ public DefaultTextCreatorBuilder chars(char[] chars) {
         }
 
         /**
-         * Builds a new {@link DefaultTextCreator} with the configured properties.
+         * Builds a new {@link DefaultTextProducer} with the configured properties.
          *
-         * @return a new {@link DefaultTextCreator}
+         * @return a new {@link DefaultTextProducer}
          */
-        public DefaultTextCreator build() {
-            return new DefaultTextCreator(length, chars);
+        public DefaultTextProducer build() {
+            return new DefaultTextProducer(length, chars);
         }
     }
 }