Auto merge of #15 - mozillazg:develop, r=mozillazg

v0.9.0

Author: homu

.travis.yml

@@ -5,6 +5,7 @@ go:
   - 1.4
   - 1.5
   - 1.6
+  - 1.7
   - tip
 
 sudo: false

CHANGELOG.md

@@ -1,6 +1,15 @@
 # Changelog
 
 
+## 0.9.0 (2016-09-04):
+
+* **NEW** 新增 `func Convert(s string, a *Args) [][]string`
+* **NEW** 新增 `func LazyConvert(s string, a *Args) []string`
+
+之所以增加这两个函数是希望 `a` 参数支持 `nil`
+
+
+
 ## 0.8.0 (2016-08-19)
 
 * **Changed** use [pinyin-data](https://github.com/mozillazg/pinyin-data) v0.3.0

README.md

@@ -45,6 +45,7 @@ import (
 
 func main() {
 	hans := "中国人"
+
 	// 默认
 	a := pinyin.NewArgs()
 	fmt.Println(pinyin.Pinyin(hans, a))
@@ -68,6 +69,15 @@ func main() {
 	a.Style = pinyin.Tone2
 	fmt.Println(pinyin.Pinyin(hans, a))
 	// [[zho1ng zho4ng] [guo2] [re2n]]
+
+	fmt.Println(pinyin.LazyPinyin(hans, pinyin.NewArgs()))
+	// [zhong guo ren]
+
+	fmt.Println(pinyin.Convert(hans, nil))
+	// [[zhong] [guo] [ren]]
+
+	fmt.Println(pinyin.LazyConvert(hans, nil))
+	// [zhong guo ren]
 }
 ```
 
@@ -78,3 +88,9 @@ Related Projects
 * [hotoo/pinyin](https://github.com/hotoo/pinyin): 汉语拼音转换工具 Node.js/JavaScript 版。
 * [mozillazg/python-pinyin](https://github.com/mozillazg/python-pinyin): 汉语拼音转换工具 Python 版。
 * [mozillazg/rust-pinyin](https://github.com/mozillazg/rust-pinyin): 汉语拼音转换工具 Rust 版。
+
+
+License
+---------
+
+Under the MIT License.

example_test.go

@@ -6,6 +6,12 @@ import (
 	"github.com/mozillazg/go-pinyin"
 )
 
+func ExampleConvert() {
+	hans := "中国人"
+	fmt.Println("default:", pinyin.Convert(hans, nil))
+	// Output: default: [[zhong] [guo] [ren]]
+}
+
 func ExamplePinyin_default() {
 	hans := "中国人"
 	a := pinyin.NewArgs()

pinyin.go

@@ -7,7 +7,7 @@ import (
 
 // Meta
 const (
-	Version   = "0.8.0"
+	Version   = "0.9.0"
 	Author    = "mozillazg, 闲耘"
 	License   = "MIT"
 	Copyright = "Copyright (c) 2016 mozillazg, 闲耘"
@@ -240,7 +240,26 @@ func LazyPinyin(s string, a Args) []string {
 }
 
 // Slug join `LazyPinyin` 的返回值.
+// 建议改用 https://github.com/mozillazg/go-slugify
 func Slug(s string, a Args) string {
 	separator := a.Separator
 	return strings.Join(LazyPinyin(s, a), separator)
 }
+
+// Convert 跟 Pinyin 的唯一区别就是 a 参数可以是 nil
+func Convert(s string, a *Args) [][]string {
+	if a == nil {
+		args := NewArgs()
+		a = &args
+	}
+	return Pinyin(s, *a)
+}
+
+// LazyConvert 跟 LazyPinyin 的唯一区别就是 a 参数可以是 nil
+func LazyConvert(s string, a *Args) []string {
+	if a == nil {
+		args := NewArgs()
+		a = &args
+	}
+	return LazyPinyin(s, *a)
+}

pinyin_test.go

@@ -322,3 +322,33 @@ func TestUpdated(t *testing.T) {
 	}
 	testPinyinUpdate(t, testData, Pinyin)
 }
+
+func TestConvert(t *testing.T) {
+	s := "中国人"
+	v := Convert(s, nil)
+	value := [][]string{{"zhong"}, {"guo"}, {"ren"}}
+	if !reflect.DeepEqual(v, value) {
+		t.Errorf("Expected %s, got %s", value, v)
+	}
+
+	a := NewArgs()
+	v = Convert(s, &a)
+	if !reflect.DeepEqual(v, value) {
+		t.Errorf("Expected %s, got %s", value, v)
+	}
+}
+
+func TestLazyConvert(t *testing.T) {
+	s := "中国人"
+	v := LazyConvert(s, nil)
+	value := []string{"zhong", "guo", "ren"}
+	if !reflect.DeepEqual(v, value) {
+		t.Errorf("Expected %s, got %s", value, v)
+	}
+
+	a := NewArgs()
+	v = LazyConvert(s, &a)
+	if !reflect.DeepEqual(v, value) {
+		t.Errorf("Expected %s, got %s", value, v)
+	}
+}