ref: errors

Author: sshaplygin

bik/bik.go

@@ -10,12 +10,12 @@ import (
 // example valid format is 044525225
 func Validate(bik string) (bool, error) {
 	if len(bik) != 9 {
-		pkg, err := ru_doc_code.GetPackageName()
+		name, err := ru_doc_code.GetModuleName()
 		if err != nil {
 			return false, err
 		}
 		return false, &ru_doc_code.CommonError{
-			Method: pkg,
+			Method: name,
 			Err:    ru_doc_code.ErrInvalidLength,
 		}
 	}

errors.go

@@ -12,22 +12,23 @@ var (
 	// ErrInvalidLength invalid input document code length
 	ErrInvalidLength = errors.New("invalid length")
 
-	// ErrInvalidFormattedSNILSLength
+	// ErrInvalidFormattedSNILSLength invalid formatted length of snils
 	ErrInvalidFormattedSNILSLength = errors.New("invalid formatted snils length")
 
-	// ErrRegistrationReasonCode
+	// ErrRegistrationReasonCode invalid registration reason code
 	ErrRegistrationReasonCode = errors.New("invalid registration reason code")
 
-	// ErrInvalidValue
+	// ErrInvalidValue invalid input value
 	ErrInvalidValue = errors.New("invalid code value")
 
-	// ErrInvalidBIKCountryCode
+	// ErrInvalidBIKCountryCode invalid bik code country
 	ErrInvalidBIKCountryCode = errors.New("invalid bik country code")
 
-	// ErrNotImplemented
+	// ErrNotImplemented not implemented method error
 	ErrNotImplemented = errors.New("method does not implemented")
 )
 
+// CommonError common error wrapped base error
 type CommonError struct {
 	Method string
 	Err    error
@@ -37,7 +38,8 @@ func (c *CommonError) Error() string {
 	return fmt.Sprintf("%s: %s", c.Method, c.Err.Error())
 }
 
-func GetPackageName() (string, error) {
+// GetModuleName get package name in runtime
+func GetModuleName() (string, error) {
 	pc, _, _, ok := runtime.Caller(1)
 	if !ok {
 		return "", errors.New("invalid runtime caller")

inn/inn.go

@@ -24,12 +24,12 @@ type INN struct {
 // example: input format is 7707083893
 func Validate(inn string) (bool, error) {
 	if len(inn) != lengthLegal && len(inn) != lengthPhysical {
-		pkg, err := ru_doc_code.GetPackageName()
+		name, err := ru_doc_code.GetModuleName()
 		if err != nil {
 			return false, err
 		}
 		return false, &ru_doc_code.CommonError{
-			Method: pkg,
+			Method: name,
 			Err:    ru_doc_code.ErrInvalidLength,
 		}
 	}

kpp/kpp.go

@@ -1,8 +1,6 @@
 package kpp
 
-import (
-	ru_doc_code "github.com/mrfoe7/ru-doc-code"
-)
+import ru_doc_code "github.com/mrfoe7/ru-doc-code"
 
 type KPP struct {
 	Code         ru_doc_code.TaxRegionCode
@@ -14,12 +12,12 @@ type KPP struct {
 // example: input format is 773643301
 func Validate(kpp string) (bool, error) {
 	if len(kpp) != 9 {
-		pkg, err := ru_doc_code.GetPackageName()
+		name, err := ru_doc_code.GetModuleName()
 		if err != nil {
 			return false, err
 		}
 		return false, &ru_doc_code.CommonError{
-			Method: pkg,
+			Method: name,
 			Err:    ru_doc_code.ErrInvalidLength,
 		}
 	}

ogrn/ogrn.go

@@ -10,12 +10,12 @@ import (
 // example: input format is 1027700132195
 func Validate(ogrn string) (bool, error) {
 	if len(ogrn) != 13 {
-		pkg, err := ru_doc_code.GetPackageName()
+		name, err := ru_doc_code.GetModuleName()
 		if err != nil {
 			return false, err
 		}
 		return false, &ru_doc_code.CommonError{
-			Method: pkg,
+			Method: name,
 			Err:    ru_doc_code.ErrInvalidLength,
 		}
 	}

ogrnip/ogrnip.go

@@ -10,12 +10,12 @@ import (
 // example: input format is 304500116000157
 func Validate(ogrnip string) (bool, error) {
 	if len(ogrnip) != 15 {
-		pkg, err := ru_doc_code.GetPackageName()
+		name, err := ru_doc_code.GetModuleName()
 		if err != nil {
 			return false, err
 		}
 		return false, &ru_doc_code.CommonError{
-			Method: pkg,
+			Method: name,
 			Err:    ru_doc_code.ErrInvalidLength,
 		}
 	}

okato/okato.go

@@ -1,9 +1,9 @@
-package okato
-
-import ru_doc_code "github.com/mrfoe7/ru-doc-code"
-
-// Validate check to valid OKATO format
-// example: input format is 17205000000
-func Validate() (bool, error) {
-	return false, ru_doc_code.ErrNotImplemented
-}
+package okato
+
+import ru_doc_code "github.com/mrfoe7/ru-doc-code"
+
+// Validate check to valid OKATO format
+// example: input format is 17205000000
+func Validate() (bool, error) {
+	return false, ru_doc_code.ErrNotImplemented
+}

okato/okato_test.go

@@ -1,7 +1,7 @@
-package okato
-
-import "testing"
-
-func TestValidate(t *testing.T) {
-
-}
+package okato
+
+import "testing"
+
+func TestValidate(t *testing.T) {
+
+}

oktmo/oktmo.go

@@ -1,9 +1,9 @@
-package oktmo
-
-import ru_doc_code "github.com/mrfoe7/ru-doc-code"
-
-// Validate check to valid OKTMO format
-// example: input format is 17605101
-func Validate() (bool, error) {
-	return false, ru_doc_code.ErrNotImplemented
-}
+package oktmo
+
+import ru_doc_code "github.com/mrfoe7/ru-doc-code"
+
+// Validate check to valid OKTMO format
+// example: input format is 17605101
+func Validate() (bool, error) {
+	return false, ru_doc_code.ErrNotImplemented
+}

oktmo/oktmo_test.go

@@ -1,7 +1,7 @@
-package oktmo
-
-import "testing"
-
-func TestValidate(t *testing.T) {
-
-}
+package oktmo
+
+import "testing"
+
+func TestValidate(t *testing.T) {
+
+}