Removed resize code

leaanthony · leaanthony · commit d0addb1d308d · 2018-12-30T19:53:27.000+11:00
Fix clearing lines on windows
Added licenses
diff --git a/.gitignore b/.gitignore
@@ -1 +1,4 @@
-example/example
+example/example
+/example/example.exe
+/.vscode
+/vendor
diff --git a/cursor_vt100.go b/cursor_vt100.go
@@ -4,9 +4,6 @@ package spinner
 
 import (
 	"fmt"
-	"os"
-	"syscall"
-	"unsafe"
 )
 
 func init() {
@@ -24,24 +21,3 @@ func hideCursor() {
 func (s *Spinner) clearCurrentLine() {
 	fmt.Printf("\r\033[0K")
 }
-
-type winsize struct {
-	rows    uint16
-	cols    uint16
-	xpixels uint16
-	ypixels uint16
-}
-
-func (s *Spinner) updateTermSize() error {
-	out, err := os.OpenFile("/dev/tty", syscall.O_WRONLY, 0)
-	if err != nil {
-		return err
-	}
-	var sz winsize
-	_, _, _ = syscall.Syscall(syscall.SYS_IOCTL,
-		out.Fd(), uintptr(syscall.TIOCGWINSZ), uintptr(unsafe.Pointer(&sz)))
-	out.Close()
-	s.termWidth.SetValue(int(sz.cols))
-	s.termHeight.SetValue(int(sz.rows))
-	return nil
-}
diff --git a/cursor_windows.go b/cursor_windows.go
@@ -27,9 +27,7 @@ func (s *Spinner) clearCurrentLine() {
 	fmt.Printf("\r")
 
 	// Get the current line length
-	s.locks[currentLineLock].Lock()
-	var length = len(s.currentLine)
-	s.locks[currentLineLock].Unlock()
+	var length = len(s.getMessage()) + len(s.getCurrentSpinnerFrame()) + 1
 
 	for i := 0; i < length; i++ {
 		fmt.Printf(" ")
diff --git a/example/example.go b/example/example.go
@@ -154,9 +154,9 @@ func main() {
 	fmt.Println("Interrupt handling. Hit Ctrl-C to stop bomb exploding!")
 	fmt.Println("")
 
-	a = spinner.New("💣 Tick...tick...tick...")
+	a = spinner.New("💣  Tick...tick...tick...")
 	a.SetAbortMessage("Defused!")
 	a.Start()
 	time.Sleep(time.Second * 5)
-	a.Success("💥 Boom!")
+	a.Success("💥  Boom!")
 }
diff --git a/go.mod b/go.mod
@@ -0,0 +1,17 @@
+module github.com/leaanthony/spinner
+
+require (
+	github.com/fatih/color v1.7.0
+	github.com/google/go-github v17.0.0+incompatible // indirect
+	github.com/google/go-querystring v1.0.0 // indirect
+	github.com/leaanthony/synx v0.1.0
+	github.com/leaanthony/wincursor v0.1.0
+	github.com/mattn/go-colorable v0.0.9 // indirect
+	github.com/mattn/go-isatty v0.0.4
+	github.com/mattn/go-runewidth v0.0.4 // indirect
+	github.com/olekukonko/tablewriter v0.0.1 // indirect
+	github.com/ribice/glice v0.0.0-20181011133736-685f13fa9b12 // indirect
+	golang.org/x/net v0.0.0-20181220203305-927f97764cc3 // indirect
+	golang.org/x/oauth2 v0.0.0-20181203162652-d668ce993890 // indirect
+	golang.org/x/sys v0.0.0-20181228144115-9a3f9b0469bb // indirect
+)
diff --git a/go.sum b/go.sum
@@ -0,0 +1,30 @@
+github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
+github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
+github.com/google/go-github v17.0.0+incompatible h1:N0LgJ1j65A7kfXrZnUDaYCs/Sf4rEjNlfyDHW9dolSY=
+github.com/google/go-github v17.0.0+incompatible/go.mod h1:zLgOLi98H3fifZn+44m+umXrS52loVEgC2AApnigrVQ=
+github.com/google/go-querystring v1.0.0 h1:Xkwi/a1rcvNg1PPYe5vI8GbeBY/jrVuDX5ASuANWTrk=
+github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
+github.com/leaanthony/synx v0.0.0-20180923230033-60efbd9984b0 h1:1bGojw4YacLY5bqQalojiQ7mSfQbe4WIWCEgPZagowU=
+github.com/leaanthony/synx v0.0.0-20180923230033-60efbd9984b0/go.mod h1:Iz7eybeeG8bdq640iR+CwYb8p+9EOsgMWghkSRyZcqs=
+github.com/leaanthony/synx v0.1.0 h1:R0lmg2w6VMb8XcotOwAe5DLyzwjLrskNkwU7LLWsyL8=
+github.com/leaanthony/synx v0.1.0/go.mod h1:Iz7eybeeG8bdq640iR+CwYb8p+9EOsgMWghkSRyZcqs=
+github.com/leaanthony/wincursor v0.0.0-20180705115120-056510f32d15 h1:166LIty6ldcyOc7tbgfu5smsGATvEo0JZV6bnbzyEc4=
+github.com/leaanthony/wincursor v0.0.0-20180705115120-056510f32d15/go.mod h1:7TVwwrzSH/2Y9gLOGH+VhA+bZhoWXBRgbGNTMk+yimE=
+github.com/leaanthony/wincursor v0.1.0 h1:Dsyp68QcF5cCs65AMBmxoYNEm0n8K7mMchG6a8fYxf8=
+github.com/leaanthony/wincursor v0.1.0/go.mod h1:7TVwwrzSH/2Y9gLOGH+VhA+bZhoWXBRgbGNTMk+yimE=
+github.com/mattn/go-colorable v0.0.9 h1:UVL0vNpWh04HeJXV0KLcaT7r06gOH2l4OW6ddYRUIY4=
+github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
+github.com/mattn/go-isatty v0.0.4 h1:bnP0vzxcAdeI1zdubAl5PjU6zsERjGZb7raWodagDYs=
+github.com/mattn/go-isatty v0.0.4/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
+github.com/mattn/go-runewidth v0.0.4 h1:2BvfKmzob6Bmd4YsL0zygOqfdFnK7GR4QL06Do4/p7Y=
+github.com/mattn/go-runewidth v0.0.4/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
+github.com/olekukonko/tablewriter v0.0.1 h1:b3iUnf1v+ppJiOfNX4yxxqfWKMQPZR5yoh8urCTFX88=
+github.com/olekukonko/tablewriter v0.0.1/go.mod h1:vsDQFd/mU46D+Z4whnwzcISnGGzXWMclvtLoiIKAKIo=
+github.com/ribice/glice v0.0.0-20181011133736-685f13fa9b12 h1:QmQk3fHEhAV7Lp5bJVRowH9/AtQl1kW9yxYwFEA19Pw=
+github.com/ribice/glice v0.0.0-20181011133736-685f13fa9b12/go.mod h1:A+ednilkKNW0CJGLsrLkq0D49M4EhlCi8gvnkwoZFn0=
+golang.org/x/net v0.0.0-20181220203305-927f97764cc3 h1:eH6Eip3UpmR+yM/qI9Ijluzb1bNv/cAU/n+6l8tRSis=
+golang.org/x/net v0.0.0-20181220203305-927f97764cc3/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
+golang.org/x/oauth2 v0.0.0-20181203162652-d668ce993890 h1:uESlIz09WIHT2I+pasSXcpLYqYK8wHcdCetU3VuMBJE=
+golang.org/x/oauth2 v0.0.0-20181203162652-d668ce993890/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
+golang.org/x/sys v0.0.0-20181228144115-9a3f9b0469bb h1:pf3XwC90UUdNPYWZdFjhGBE7DUFuK3Ct1zWmZ65QN30=
+golang.org/x/sys v0.0.0-20181228144115-9a3f9b0469bb/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
diff --git a/licenses/github.com/fatih/color/LICENSE.md b/licenses/github.com/fatih/color/LICENSE.md
@@ -17,4 +17,4 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/licenses/github.com/leaanthony/synx/LICENSE b/licenses/github.com/leaanthony/synx/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-Present Lea Anthony
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/licenses/github.com/leaanthony/wincursor/LICENSE b/licenses/github.com/leaanthony/wincursor/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-Present Lea Anthony
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/licenses/github.com/mattn/go-colorable/LICENSE b/licenses/github.com/mattn/go-colorable/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yasuhiro Matsumoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/licenses/github.com/mattn/go-isatty/LICENSE b/licenses/github.com/mattn/go-isatty/LICENSE
@@ -0,0 +1,9 @@
+Copyright (c) Yasuhiro MATSUMOTO <mattn.jp@gmail.com>
+
+MIT License (Expat)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/licenses/golang.org/x/sys/LICENSE b/licenses/golang.org/x/sys/LICENSE
@@ -0,0 +1,27 @@
+Copyright (c) 2009 The Go Authors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+   * Neither the name of Google Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/spinner.go b/spinner.go
@@ -8,9 +8,7 @@ import (
 	"os/signal"
 	"runtime"
 	"strings"
-	"syscall"
 	"time"
-	"unicode/utf8"
 
 	"github.com/fatih/color"
 	"github.com/leaanthony/synx"
@@ -73,7 +71,7 @@ func NewSpinner(optionalMessage ...string) *Spinner {
 	if len(optionalMessage) > 0 {
 		message = optionalMessage[0]
 	}
-	return &Spinner{
+	result := &Spinner{
 		message:       synx.NewString(message),
 		stopChan:      make(chan struct{}),
 		speedUpdated:  synx.NewBool(true),
@@ -86,9 +84,10 @@ func NewSpinner(optionalMessage ...string) *Spinner {
 		abortMessage:  synx.NewString("Aborted."),
 		frameNumber:   0,
 		running:       synx.NewBool(false),
-		currentLine:   synx.NewString(""),
 		isTerminal:    synx.NewBool(isatty.IsTerminal(os.Stdout.Fd())),
 	}
+
+	return result
 }
 
 // New is solely here to make code cleaner for importers.
@@ -130,6 +129,12 @@ func (s *Spinner) getNextSpinnerFrame() (result string) {
 	return
 }
 
+func (s *Spinner) getCurrentSpinnerFrame() (result string) {
+	s.frameNumber = s.frameNumber % s.spinFrames.Length()
+	result = s.spinFrames.GetElement(s.frameNumber)
+	return result
+}
+
 // SetSpinSpeed sets the speed of the spinner animation.
 // The lower the value, the faster the spin.
 func (s *Spinner) SetSpinSpeed(ms int) {
@@ -149,14 +154,12 @@ func (s *Spinner) getSpinSpeed() (ms int) {
 // UpdateMessage sets the spinner message.
 // Can be flickery if not appending so use with care.
 func (s *Spinner) UpdateMessage(message string) {
-	if s.IsTerminal() {
-		// Clear line if this isn't an append.
-		// for smoother screen updates.
-		if strings.Index(message, s.getMessage()) != 0 {
-			s.clearCurrentLine()
-		}
-		s.setMessage(message)
+	// Clear line if this isn't an append.
+	// for smoother screen updates.
+	if strings.Index(message, s.getMessage()) != 0 {
+		s.clearCurrentLine()
 	}
+	s.setMessage(message)
 }
 
 // SetAbortMessage sets the message that gets printed when
@@ -185,25 +188,8 @@ func (s *Spinner) setRunning(value bool) {
 	s.running.SetValue(value)
 }
 
-func (s *Spinner) setCurrentLine(line string) {
-	s.currentLine.SetValue(line)
-}
-func (s *Spinner) getCurrentLine() string {
-	return s.currentLine.GetValue()
-}
-
-// IsTerminal returns true if the spinner is running in a terminal
-func (s *Spinner) IsTerminal() bool {
-	return s.isTerminal.GetValue()
-}
-
 func (s *Spinner) printSuccess(message string, args ...interface{}) {
-	if s.IsTerminal() {
-		color.HiGreen(message, args...)
-	} else {
-		fmt.Printf(message, args...)
-	}
-
+	color.HiGreen(message, args...)
 }
 
 // Start the spinner!
@@ -245,26 +231,14 @@ func (s *Spinner) Start(optionalMessage ...string) {
 		// Notify and clean up
 		s.stopChan <- struct{}{}
 		fmt.Println("")
-		if s.IsTerminal() {
-			color.HiRed("\r%s %s", s.getErrorSymbol(), s.getAbortMessage())
-		} else {
-			fmt.Printf("%s %s", s.getErrorSymbol(), s.getAbortMessage())
-		}
+		color.HiRed("\r%s %s", s.getErrorSymbol(), s.getAbortMessage())
 		os.Exit(1)
 	}(s.stopChan)
 
-	// Setup Resize
-	resizechan := make(chan os.Signal, 10)
-	signal.Notify(resizechan, syscall.SIGWINCH)
-
 	// spawn off a goroutine to handle the animation.
-	go func(resizechan chan os.Signal) {
+	go func() {
 
 		ticker := time.NewTicker(time.Millisecond * time.Duration(s.spinSpeed.GetValue()))
-		err := s.updateTermSize()
-		if err != nil {
-			fmt.Println(err)
-		}
 
 		// Let's go!
 		for {
@@ -273,30 +247,13 @@ func (s *Spinner) Start(optionalMessage ...string) {
 			case <-ticker.C:
 				// Rewind to start of line and print the current frame and message.
 				// Note: We don't fully clear the line here as this causes flickering.
-				if s.IsTerminal() || len(s.getCurrentLine()) == 0 {
-					fmt.Printf("\r")
-					var line = fmt.Sprintf("%s %s", s.getNextSpinnerFrame(), s.getMessage())
-					w := s.termWidth.GetValue()
-					var printLine = line
-					if utf8.RuneCountInString(line) > w {
-						printLine = string([]rune(line)[:w])
-						s.clearCurrentLine()
-					}
-					fmt.Printf(printLine)
-					s.setCurrentLine(line)
-
-					// Do we need to update the ticker?
-					if s.speedUpdated.GetValue() == true {
-						ticker.Stop()
-						ticker = time.NewTicker(time.Millisecond * time.Duration(s.spinSpeed.GetValue()))
-					}
-				}
+				fmt.Printf("\r")
+				fmt.Printf("%s %s", s.getNextSpinnerFrame(), s.getMessage())
 
-			// If we resize
-			case <-resizechan:
-				err := s.updateTermSize()
-				if err != nil {
-					fmt.Println(err)
+				// Do we need to update the ticker?
+				if s.speedUpdated.GetValue() == true {
+					ticker.Stop()
+					ticker = time.NewTicker(time.Millisecond * time.Duration(s.spinSpeed.GetValue()))
 				}
 
 			// If we get a stop signal
@@ -309,7 +266,7 @@ func (s *Spinner) Start(optionalMessage ...string) {
 				return
 			}
 		}
-	}(resizechan)
+	}()
 }
 
 // stop will stop the spinner.
