feat: added builder mode to generate instances

wenlng · Jun 22, 2024 · 870759f · 870759f
1 parent c626d2a
commit 870759f
Show file tree

Hide file tree

Showing 14 changed files with 319 additions and 135 deletions.
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@
 
 ## Install Captcha Module
 ```shell
-$ go get -u github.com/wenlng/go-captcha/v2@v2.0.0-beta.2
+$ go get -u github.com/wenlng/go-captcha/v2@latest
 ```
 
 ## Import Captcha Module
@@ -78,7 +78,7 @@ import (
 var textCapt click.Captcha
 
 func init() {
-	textCapt = click.New(
+	builder := click.NewBuilder(
 		click.WithRangeLen(option.RangeVal{Min: 4, Max: 6}),
 		click.WithRangeVerifyLen(option.RangeVal{Min: 2, Max: 4}),
 	)
@@ -93,7 +93,7 @@ func init() {
 		log.Fatalln(err)
 	}
 
-	textCapt.SetResources(
+	builder.SetResources(
 		click.WithChars([]string{
 			"1A",
 			"5E",
@@ -112,6 +112,8 @@ func init() {
 			bgImage,
 		}),
 	)
+
+	textCapt= builder.Make()
 }
 
 func loadPng(p string) (image.Image, error) {
@@ -157,11 +159,11 @@ func main() {
 ```
 
 ### Create instance method
-- click.New()
-- click.NewWithShape()
+- builder.Make()
+- builder.MakeWithShape()
 
 ### Configuration options
-click.New(click.WithXxx(), ...)
+> click.NewBuilder(click.WithXxx(), ...) OR builder.SetOptions()(click.WithXxx(), ...)
 - click.WithImageSize(option.Size)
 - click.WithRangeLen(option.RangeVal) 
 - click.WithRangeAnglePos([]option.RangeVal) 
@@ -185,7 +187,7 @@ click.New(click.WithXxx(), ...)
 
 
 ### Set resources
-xxx.SetResources(click.WithXxx(), ...)
+> builder.SetResources(click.WithXxx(), ...)
 - click.WithChars([]string) 
 - click.WithShapes(map[string]image.Image) 
 - click.WithFonts([]*truetype.Font) 
@@ -219,7 +221,7 @@ import (
 var slideTileCapt slide.Captcha
 
 func init() {
-	slideTileCapt = slide.New()
+	builder := slide.NewBuilder()
 
 	bgImage, err := loadPng("../resources/bg.png")
 	if err != nil {
@@ -233,13 +235,15 @@ func init() {
 
 	graphs := getSlideTileGraphArr()
 
-	slideTileCapt.SetResources(
+	builder.SetResources(
 		slide.WithGraphImages(graphs),
 		slide.WithBackgrounds([]image.Image{
 			bgImage,
 			bgImage1,
 		}),
 	)
+
+	slideTileCapt = builder.Make()
 }
 
 func getSlideTileGraphArr() []*slide.GraphImage {
@@ -301,12 +305,12 @@ func loadPng(p string) (image.Image, error) {
 
 
 ### Create instance method
-- slide.New()
-- slide.NewWithRegion() 
+- builder.Make()
+- builder.MakeWithRegion() 
 
 
 ### Configuration options
-slide.New(slide.WithXxx(), ...)
+> slide.NewBuilder(slide.WithXxx(), ...) OR builder.SetOptions(slide.WithXxx(), ...)
 - slide.WithImageSize(*option.Size)
 - slide.WithImageAlpha(float32) 
 - slide.WithRangeGraphSize(val option.RangeVal) 
@@ -317,7 +321,7 @@ slide.New(slide.WithXxx(), ...)
 
 
 ### Set resources
-xxx.SetResources(slide.WithXxx(), ...)
+builder.SetResources(slide.WithXxx(), ...)
 - slide.WithBackgrounds([]image.Image) 
 - slide.WithGraphImages(images []*GraphImage)
 
@@ -348,7 +352,7 @@ import (
 var rotateCapt rotate.Captcha
 
 func init() {
-	rotateCapt = rotate.New()
+	builder := rotate.NewBuilder()
 
 	bgImage, err := loadPng("../resources/bg.png")
 	if err != nil {
@@ -360,12 +364,14 @@ func init() {
 		log.Fatalln(err)
 	}
 
-	rotateCapt.SetResources(
+	builder.SetResources(
 		rotate.WithImages([]image.Image{
 			bgImage,
 			bgImage1,
 		}),
 	)
+
+	rotateCapt = builder.Make()
 }
 
 func main() {
@@ -403,19 +409,19 @@ func loadPng(p string) (image.Image, error) {
 
 
 ### Create instance method
-- rotate.New()
+- builder.Make()
 
 
 ### Configuration options
-rotate.New(rotate.WithXxx(), ...)
+> rotate.NewBuilder(rotate.WithXxx(), ...) OR builder.SetOptions(rotate.WithXxx(), ...)
 - rotate.WithImageSquareSize(val int) 
 - rotate.WithRangeAnglePos(vals []option.RangeVal)
 - rotate.WithRangeThumbImageSquareSize(val []int) 
 - rotate.WithThumbImageAlpha(val float32)
 
 
 ### Set resources
-xxx.SetResources(rotate.WithXxx(), ...)
+builder.SetResources(rotate.WithXxx(), ...)
 - rotate.WithBackgrounds([]image.Image)
 
 ### Captcha Data
@@ -447,9 +453,9 @@ xxx.SetResources(rotate.WithXxx(), ...)
 - <p>Web Native ✔</p>
 - <p>Vue ✔</p>
 - <p>React ✔</p>
-- <p>Angular</p>
-- <p>Svelte</p>
-- <p>Solid</p>
+- <p>Angular ✔</p>
+- <p>Svelte ✔</p>
+- <p>Solid ✔</p>
 - <p>MinProgram</p>
 - <p>UniApp</p>
 - <p>Android App</p>

diff --git a/README_zh.md b/README_zh.md
@@ -15,7 +15,7 @@
 > [English](README.md) | 中文 
 
 <p style="text-align: center">
-<a style="font-weight: bold" href="https://github.com/wenlng/go-captcha">Go Captcha</a> 是一个简洁易用、交互友好、高安全的行为式验证码库 (Golang)，支持文本点/图形点选、滑动/拖拽、旋转等验证模式。
+<a style="font-weight: bold" href="https://github.com/wenlng/go-captcha">Go Captcha</a> 是一个简洁易用、交互友好、高安全的行为式验证码库 (Golang)，支持文本/图形点选、滑动/拖拽、旋转等验证模式。
 </p>
 
 <p style="text-align: center"> ⭐️ 如果能帮助到你，请随手给点一个star</p>
@@ -37,7 +37,7 @@
 - Angular Package：[https://github.com/wenlng/go-captcha-angular](https://github.com/wenlng/go-captcha-angular)
 - Svelte Package：[https://github.com/wenlng/go-captcha-svelte](https://github.com/wenlng/go-captcha-svelte)
 - Solid Package：[https://github.com/wenlng/go-captcha-solid](https://github.com/wenlng/go-captcha-solid)
-- 在线演示：[http://gocaptcha.wencodes.com/demo](http://gocaptcha.wencodes.com/demo)
+- 在线演示：[http://gocaptcha.wencodes.com/demo/](http://gocaptcha.wencodes.com/demo/)
 - ...
 
 <br/>
@@ -65,7 +65,7 @@ $ source ~/.profile
 
 ## 安装模块
 ```shell
-$ go get -u github.com/wenlng/go-captcha/v2@v2.0.0-beta.2
+$ go get -u github.com/wenlng/go-captcha/v2@latest
 ```
 
 ## 引入模块
@@ -103,7 +103,7 @@ import (
 var textCapt click.Captcha
 
 func init() {
-	textCapt = click.New(
+	builder := click.NewBuilder(
 		click.WithRangeLen(option.RangeVal{Min: 4, Max: 6}),
 		click.WithRangeVerifyLen(option.RangeVal{Min: 2, Max: 4}),
 	)
@@ -118,7 +118,7 @@ func init() {
 		log.Fatalln(err)
 	}
 
-	textCapt.SetResources(
+	builder.SetResources(
 		click.WithChars([]string{"这", "是", "随", "机", "的", "文", "本", "种", "子", "呀"}),
 		click.WithFonts([]*truetype.Font{
 			fontN,
@@ -127,6 +127,8 @@ func init() {
 			bgImage,
 		}),
 	)
+
+	textCapt = builder.Make()
 }
 
 func loadPng(p string) (image.Image, error) {
@@ -172,11 +174,11 @@ func main() {
 ```
 
 ### 创建实例方法
-- click.New()  中文文本、字母数字混合点选
-- click.NewWithShape()  图形点选
+- builder.Make()  中文文本、字母数字混合点选
+- builder.MakeWithShape()  图形点选
 
 ### 配置选项
-click.New(click.WithXxx(), ...)
+> click.NewBuilder(click.WithXxx(), ...) 或 builder.SetOptions(click.WithXxx(), ...)
 - click.WithImageSize(option.Size)  设置主图尺寸，默认 300x220
 - click.WithRangeLen(option.RangeVal)  设置随机内容长度范围
 - click.WithRangeAnglePos([]option.RangeVal)  设置随机角度范围
@@ -200,7 +202,7 @@ click.New(click.WithXxx(), ...)
 
 
 ### 设置资源
-xxx.SetResources(click.WithXxx(), ...)
+> builder.SetResources(click.WithXxx(), ...)
 - click.WithChars([]string)  设置文本种子
 - click.WithShapes(map[string]image.Image)  设置图形种子
 - click.WithFonts([]*truetype.Font)  设置字体
@@ -234,7 +236,7 @@ import (
 var slideTileCapt slide.Captcha
 
 func init() {
-	slideTileCapt = slide.New()
+	builder := slide.NewBuilder()
 
 	bgImage, err := loadPng("../resources/bg.png")
 	if err != nil {
@@ -248,13 +250,15 @@ func init() {
 
 	graphs := getSlideTileGraphArr()
 
-	slideTileCapt.SetResources(
+	builder.SetResources(
 		slide.WithGraphImages(graphs),
 		slide.WithBackgrounds([]image.Image{
 			bgImage,
 			bgImage1,
 		}),
 	)
+
+	slideTileCapt = builder.Make()
 }
 
 func getSlideTileGraphArr() []*slide.GraphImage {
@@ -316,12 +320,12 @@ func loadPng(p string) (image.Image, error) {
 
 
 ### 创建实例方法
-- slide.New() 滑动式
-- slide.NewWithRegion()  区域内拖拽滑动式
+- builder.Make() 滑动式
+- builder.MakeWithRegion()  区域内拖拽滑动式
 
 
 ### 配置选项
-slide.New(slide.WithXxx(), ...)
+> slide.NewBuilder(slide.WithXxx(), ...) 或 builder.SetOptions(slide.WithXxx(), ...)
 - slide.WithImageSize(*option.Size)  设置主图尺寸，默认 300x220
 - slide.WithImageAlpha(float32)  设置主图透明度
 - slide.WithRangeGraphSize(val option.RangeVal)  设置图形随机尺寸范围
@@ -332,7 +336,7 @@ slide.New(slide.WithXxx(), ...)
 
 
 ### 设置资源
-xxx.SetResources(slide.WithXxx(), ...)
+> builder.SetResources(slide.WithXxx(), ...)
 - slide.WithBackgrounds([]image.Image)  设置主图背景
 - slide.WithGraphImages(images []*GraphImage)  设置贴图的图形
 
@@ -363,7 +367,7 @@ import (
 var rotateCapt rotate.Captcha
 
 func init() {
-	rotateCapt = rotate.New()
+	builder := rotate.NewBuilder()
 
 	bgImage, err := loadPng("../resources/bg.png")
 	if err != nil {
@@ -375,12 +379,14 @@ func init() {
 		log.Fatalln(err)
 	}
 
-	rotateCapt.SetResources(
+	builder.SetResources(
 		rotate.WithImages([]image.Image{
 			bgImage,
 			bgImage1,
 		}),
 	)
+
+	rotateCapt = builder.Make()
 }
 
 func main() {
@@ -418,19 +424,19 @@ func loadPng(p string) (image.Image, error) {
 
 
 ### 创建实例方法
-- rotate.New() 旋转式
+- builder.Make() 旋转式
 
 
 ### 配置选项
-rotate.New(rotate.WithXxx(), ...)
+> rotate.NewBuilder(rotate.WithXxx(), ...) 或 builder.SetOptions(rotate.WithXxx(), ...)
 - rotate.WithImageSquareSize(val int)  设置主图大小
 - rotate.WithRangeAnglePos(vals []option.RangeVal)  设置校验随机角度范围
 - rotate.WithRangeThumbImageSquareSize(val []int)  设置缩略图大小
 - rotate.WithThumbImageAlpha(val float32)  设置缩略图透明度
 
 
 ### 设置资源
-xxx.SetResources(rotate.WithXxx(), ...)
+> builder.SetResources(rotate.WithXxx(), ...)
 - rotate.WithBackgrounds([]image.Image)  设置主图图片
 
 ### 验证码数据

diff --git a/v2/capts.go b/v2/capts.go
@@ -6,27 +6,17 @@ import (
 	"github.com/wenlng/go-captcha/v2/slide"
 )
 
-// NewClick .
-func NewClick(opts ...click.Option) click.Captcha {
-	return click.New(opts...)
+// NewClickBuilder .
+func NewClickBuilder(opts ...click.Option) click.Builder {
+	return click.NewBuilder(opts...)
 }
 
-// NewClickWithShape .
-func NewClickWithShape(opts ...click.Option) click.Captcha {
-	return click.NewWithShape(opts...)
+// NewSlideBuilder .
+func NewSlideBuilder(opts ...slide.Option) slide.Builder {
+	return slide.NewBuilder(opts...)
 }
 
-// NewSlide .
-func NewSlide(opts ...slide.Option) slide.Captcha {
-	return slide.New(opts...)
-}
-
-// NewSlideWithRegion .
-func NewSlideWithRegion(opts ...slide.Option) slide.Captcha {
-	return slide.NewWithRegion(opts...)
-}
-
-// NewRotate .
-func NewRotate(opts ...rotate.Option) rotate.Captcha {
-	return rotate.New(opts...)
+// NewRotateBuilder .
+func NewRotateBuilder(opts ...rotate.Option) rotate.Builder {
+	return rotate.NewBuilder(opts...)
 }