From 141355a5eab885da07271556bf67548a6dbd4e1c Mon Sep 17 00:00:00 2001
From: jiro <jiroron666@gmail.com>
Date: Sun, 14 Aug 2022 17:51:41 +0900
Subject: [PATCH] =?UTF-8?q?=F0=9F=94=A5BREAKING=20CHANGES=20=E3=81=8A?=
 =?UTF-8?q?=E3=83=91=E3=83=83=E3=82=B1=E3=83=BC=E3=82=B8=E3=82=A4=E3=83=B3?=
 =?UTF-8?q?=E3=83=9D=E3=83=BC=E3=83=88=E6=99=82=E3=81=AB=E4=B9=B1=E6=95=B0?=
 =?UTF-8?q?=E3=81=AE=E5=88=9D=E6=9C=9F=E5=8C=96=E3=82=92=E3=81=97=E3=81=AA?=
 =?UTF-8?q?=E3=81=84=E3=82=88=E3=81=86=E3=81=AB=E5=A4=89=E6=9B=B4=E3=81=84?=
 =?UTF-8?q?=E3=81=9F=E3=81=97=E3=81=BE=E3=81=97=E3=81=9F=E3=82=8F?=
 =?UTF-8?q?=F0=9F=94=A5=20#71=20(#79)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* :fire: BREAKING_CHANGES パッケージインポート時の乱数初期化をしないように変更 #71

* :green_heart: Exampleコードを追加

* fix comment

* fix example

* fix readme example

* fix
---
 README.adoc         | 22 ++++++++++++++--------
 cmd/ojosama/main.go |  4 ++++
 examples/sample1.go |  4 ++++
 ojosama.go          | 18 ++++++++----------
 ojosama_test.go     | 15 +++++++++++++++
 5 files changed, 45 insertions(+), 18 deletions(-)

diff --git a/README.adoc b/README.adoc
index cab0195..c27afa3 100644
--- a/README.adoc
+++ b/README.adoc
@@ -107,23 +107,29 @@ $ ojosama -charcode sjis testdata/sample1_sjis.txt
 
 Goのコードとして使う場合は以下のように使用します。
 
+一部変換ロジックの中でランダムな選択を行うため、乱数のシード値を設定します。
+
 [source,go]
 ----
 package main
 
 import (
-  "fmt"
+	"fmt"
+	"math/rand"
+	"time"
 
-  "github.com/jiro4989/ojosama"
+	"github.com/jiro4989/ojosama"
 )
 
 func main() {
-  s := "ハーブがありました！"
-  text, err := ojosama.Convert(s, nil)
-  if err != nil {
-    panic(err)
-  }
-  fmt.Println(text)
+	rand.Seed(time.Now().UnixNano())
+
+	s := "ハーブがありました！"
+	text, err := ojosama.Convert(s, nil)
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(text)
 }
 ----
 
diff --git a/cmd/ojosama/main.go b/cmd/ojosama/main.go
index 2d4a4d6..50e3da5 100644
--- a/cmd/ojosama/main.go
+++ b/cmd/ojosama/main.go
@@ -3,7 +3,9 @@ package main
 import (
 	"fmt"
 	"io"
+	"math/rand"
 	"os"
+	"time"
 
 	"github.com/jiro4989/ojosama"
 	"golang.org/x/text/encoding/japanese"
@@ -113,6 +115,8 @@ func main() {
 }
 
 func run(s string, args *CmdArgs) (int, error) {
+	rand.Seed(time.Now().UnixNano())
+
 	text, err := ojosama.Convert(s, nil)
 	if err != nil {
 		return exitStatusConvertError, err
diff --git a/examples/sample1.go b/examples/sample1.go
index 232cc40..d528cc5 100644
--- a/examples/sample1.go
+++ b/examples/sample1.go
@@ -2,11 +2,15 @@ package main
 
 import (
 	"fmt"
+	"math/rand"
+	"time"
 
 	"github.com/jiro4989/ojosama"
 )
 
 func main() {
+	rand.Seed(time.Now().UnixNano())
+
 	s := "ハーブがありました！"
 	text, err := ojosama.Convert(s, nil)
 	if err != nil {
diff --git a/ojosama.go b/ojosama.go
index 2475de4..327e45b 100644
--- a/ojosama.go
+++ b/ojosama.go
@@ -41,7 +41,6 @@ import (
 	"math/rand"
 	"regexp"
 	"strings"
-	"time"
 
 	"github.com/ikawaha/kagome-dict/ipa"
 	"github.com/ikawaha/kagome/v2/tokenizer"
@@ -54,9 +53,9 @@ import (
 
 // ConvertOption はお嬢様変換時のオプショナルな設定。
 type ConvertOption struct {
-	// 句点を！に変換する機能をOFFにする。句点を！に変換してしまうと変換元の文章
-	// のニュアンスを破壊する可能性があるため、オプションパラメータで無効にでき
-	// るようにする。
+	// 句点を！に変換する機能をOFFにする。
+	// 句点を！に変換してしまうと変換元の文章のニュアンスを破壊する可能性があるため、
+	// オプションパラメータで無効にできるようにする。
 	DisableKutenToExclamation bool
 
 	forceAppendLongNote     forceAppendLongNote // 単体テスト用のパラメータ
@@ -86,17 +85,16 @@ var (
 	shuffleElementsKutenToExclamation = []string{"。", "。", "！", "❗"}
 )
 
-func init() {
-	rand.Seed(time.Now().UnixNano())
-}
-
 // Convert はテキストを壱百満天原サロメお嬢様風の口調に変換して返却する。
 //
 // 簡単に説明すると「ハーブですわ！」を「おハーブですわ～～！！！」と変換する。
 // それ以外にもいくつかバリエーションがある。
 //
-// opt は挙動を微調整するためのオプショナルなパラメータ。不要であれば nil を渡せ
-// ば良い。
+// opt は挙動を微調整するためのオプショナルなパラメータ。
+// 不要であれば nil を渡せば良い。
+//
+// 一部変換の途中でランダムに要素を選択するため、
+// 呼び出し側で乱数のシードの初期化を行うこと。
 func Convert(src string, opt *ConvertOption) (string, error) {
 	t, err := tokenizer.New(ipa.Dict(), tokenizer.OmitBosEos())
 	if err != nil {
diff --git a/ojosama_test.go b/ojosama_test.go
index 8ee6da0..97deae9 100644
--- a/ojosama_test.go
+++ b/ojosama_test.go
@@ -1,12 +1,27 @@
 package ojosama
 
 import (
+	"fmt"
+	"math/rand"
 	"testing"
+	"time"
 
 	"github.com/jiro4989/ojosama/internal/chars"
 	"github.com/stretchr/testify/assert"
 )
 
+func ExampleConvert() {
+	rand.Seed(time.Now().UnixNano())
+	got, err := Convert("ハーブです", nil)
+
+	fmt.Println("got: " + got)
+	fmt.Println(fmt.Sprintf("err: %v", err))
+
+	// Output:
+	// got: おハーブですわ
+	// err: <nil>
+}
+
 func TestConvert(t *testing.T) {
 	opt := &ConvertOption{
 		DisableKutenToExclamation: true,