rename Migration.LongString to LogString

mattes · Feb 10, 2017 · 1b079a3 · 1b079a3
1 parent c1b23fe
commit 1b079a3
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 13 deletions.
diff --git a/migrate.go b/migrate.go
@@ -295,9 +295,9 @@ func (m *Migrate) Run(migration ...*Migration) error {
 		defer close(ret)
 		for _, migr := range migration {
 			if m.PrefetchMigrations > 0 && migr.Body != nil {
-				m.logVerbosePrintf("Start buffering %v\n", migr.StringLong())
+				m.logVerbosePrintf("Start buffering %v\n", migr.LogString())
 			} else {
-				m.logVerbosePrintf("Scheduled %v\n", migr.StringLong())
+				m.logVerbosePrintf("Scheduled %v\n", migr.LogString())
 			}
 
 			ret <- migr
@@ -629,13 +629,13 @@ func (m *Migrate) runMigrations(ret <-chan interface{}) error {
 			migr := r.(*Migration)
 
 			if migr.Body == nil {
-				m.logVerbosePrintf("Execute %v\n", migr.StringLong())
+				m.logVerbosePrintf("Execute %v\n", migr.LogString())
 				if err := m.databaseDrv.Run(migr.TargetVersion, nil); err != nil {
 					return err
 				}
 
 			} else {
-				m.logVerbosePrintf("Read and execute %v\n", migr.StringLong())
+				m.logVerbosePrintf("Read and execute %v\n", migr.LogString())
 				if err := m.databaseDrv.Run(migr.TargetVersion, migr.BufferedBody); err != nil {
 					return err
 				}
@@ -648,9 +648,9 @@ func (m *Migrate) runMigrations(ret <-chan interface{}) error {
 			// log either verbose or normal
 			if m.Log != nil {
 				if m.Log.Verbose() {
-					m.logPrintf("Finished %v (read %v, ran %v)\n", migr.StringLong(), readTime, runTime)
+					m.logPrintf("Finished %v (read %v, ran %v)\n", migr.LogString(), readTime, runTime)
 				} else {
-					m.logPrintf("%v (%v)\n", migr.StringLong(), readTime+runTime)
+					m.logPrintf("%v (%v)\n", migr.LogString(), readTime+runTime)
 				}
 			}
 
@@ -754,9 +754,9 @@ func (m *Migrate) newMigration(version uint, targetVersion int) (*Migration, err
 	}
 
 	if m.PrefetchMigrations > 0 && migr.Body != nil {
-		m.logVerbosePrintf("Start buffering %v\n", migr.StringLong())
+		m.logVerbosePrintf("Start buffering %v\n", migr.LogString())
 	} else {
-		m.logVerbosePrintf("Scheduled %v\n", migr.StringLong())
+		m.logVerbosePrintf("Scheduled %v\n", migr.LogString())
 	}
 
 	return migr, nil

diff --git a/migration.go b/migration.go
@@ -108,8 +108,7 @@ func (m *Migration) String() string {
 }
 
 // StringLong returns a string describing this migration to humans.
-// TODO: rename to LogString()
-func (m *Migration) StringLong() string {
+func (m *Migration) LogString() string {
 	directionStr := "u"
 	if m.TargetVersion < int(m.Version) {
 		directionStr = "d"

diff --git a/migration_test.go b/migration_test.go
@@ -19,7 +19,7 @@ func ExampleNewMigration() {
 		log.Fatal(err)
 	}
 
-	fmt.Print(migr.StringLong())
+	fmt.Print(migr.LogString())
 	// Output:
 	// 1486686016/u create_users_table
 }
@@ -33,7 +33,7 @@ func ExampleNewMigration_nilMigration() {
 		log.Fatal(err)
 	}
 
-	fmt.Print(migr.StringLong())
+	fmt.Print(migr.LogString())
 	// Output:
 	// 1486686016/u <empty>
 }
@@ -50,7 +50,7 @@ func ExampleNewMigration_nilVersion() {
 		log.Fatal(err)
 	}
 
-	fmt.Print(migr.StringLong())
+	fmt.Print(migr.LogString())
 	// Output:
 	// 1486686016/d drop_users_table
 }