Refactoring for golint warnings

Author: liderman

.golangci.yml

@@ -24,4 +24,5 @@ linters:
     - depguard
     - errorlint
     - goconst
-    - gocritic
+    - gocritic
+    - golint

.travis.yml

@@ -16,7 +16,7 @@ Usage
 -----------
 An example of a simple template text generation:
 ```go
-tg := text_generator.New()
+tg := textgenerator.New()
 template := "Good {morning|day}!"
 
 fmt.Print(tg.Generate(template))
@@ -28,7 +28,7 @@ fmt.Print(tg.Generate(template))
 
 An example of a complex generation template text:
 ```go
-tg := text_generator.New()
+tg := textgenerator.New()
 template := "{Good {morning|evening|day}|Goodnight|Hello}, {friend|brother}! {How are you|What's new with you}?"
 
 fmt.Print(tg.Generate(template))

README.md

@@ -1,5 +1,4 @@
-// Package text_generator Fast text generator on a mask.
-package text_generator
+package textgenerator
 
 import (
 	"crypto/md5"
@@ -8,13 +7,14 @@ import (
 	"time"
 )
 
+// CachedTextGenerator Implementing caching to prevent re-generation of phrases
 type CachedTextGenerator struct {
-	generator TextGeneratorInterface
+	generator GeneratorInterface
 	cache     *cache.Cache
 }
 
 // NewCached returns a new instance a cached text generator.
-func NewCached(generator TextGeneratorInterface, ttl int) TextGeneratorInterface {
+func NewCached(generator GeneratorInterface, ttl int) GeneratorInterface {
 	return &CachedTextGenerator{
 		generator: generator,
 		cache:     cache.New(time.Duration(ttl)*time.Second, 30*time.Second),
@@ -36,7 +36,8 @@ func (t *CachedTextGenerator) Generate(text string) string {
 	return result
 }
 
-func (t *CachedTextGenerator) Configure(startTag rune, endTag rune, separator rune) TextGeneratorInterface {
+// Configure Configuring tags and separators
+func (t *CachedTextGenerator) Configure(startTag rune, endTag rune, separator rune) GeneratorInterface {
 	t.generator.Configure(startTag, endTag, separator)
 	return t
 }

cached-text-generator.go

@@ -1,4 +1,4 @@
-package text_generator
+package textgenerator
 
 import (
 	"github.com/stretchr/testify/assert"

cached-text-generator_test.go

@@ -1,19 +1,18 @@
-package text_generator_test
+package textgenerator
 
 import (
 	"fmt"
-	"github.com/liderman/text-generator"
 )
 
 func ExampleSimpleTemplate() {
-	tg := text_generator.New()
+	tg := New()
 	template := "Good {morning|day}!"
 
 	fmt.Print(tg.Generate(template))
 }
 
 func ExampleComplexTemplate() {
-	tg := text_generator.New()
+	tg := New()
 	template := "{Good {morning|evening|day}|Goodnight|Hello}, {friend|brother}! {How are you|What's new with you}?"
 
 	fmt.Print(tg.Generate(template))

example_test.go

@@ -1,24 +1,25 @@
-// Package text_generator Fast text generator on a mask.
-package text_generator
+package textgenerator
 
 import (
 	"math/rand"
 	"time"
 )
 
-type TextGeneratorInterface interface {
+// GeneratorInterface Text generator interface for expanding functionality
+type GeneratorInterface interface {
 	Generate(text string) string
-	Configure(startTag rune, endTag rune, separator rune) TextGeneratorInterface
+	Configure(startTag rune, endTag rune, separator rune) GeneratorInterface
 }
 
+// TextGenerator Generator of unique texts by mask
 type TextGenerator struct {
 	startTag  rune
 	endTag    rune
 	separator rune
 }
 
 // New returns a new instance a text generator.
-func New() TextGeneratorInterface {
+func New() GeneratorInterface {
 	rand.Seed(time.Now().UnixNano())
 	return &TextGenerator{
 		startTag:  '{',
@@ -28,7 +29,7 @@ func New() TextGeneratorInterface {
 }
 
 // Configure method configures the parser
-func (t *TextGenerator) Configure(startTag rune, endTag rune, separator rune) TextGeneratorInterface {
+func (t *TextGenerator) Configure(startTag rune, endTag rune, separator rune) GeneratorInterface {
 	t.startTag = startTag
 	t.endTag = endTag
 	t.separator = separator

text-generator.go

@@ -1,4 +1,4 @@
-package text_generator
+package textgenerator
 
 import (
 	"testing"

text-generator_bench_test.go

@@ -1,4 +1,4 @@
-package text_generator
+package textgenerator
 
 import (
 	"github.com/stretchr/testify/assert"