tty-spinner 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 78cca8f09f1905f3cc652e58d71e0e9aaa0b90af
-  data.tar.gz: 8b4776c0f0e1e347edf5f03af42a548198ad24fe
+SHA256:
+  metadata.gz: 6eab9dfc9f0d8787064da1d1e185288753ae915679a0852a28390355448209ed
+  data.tar.gz: a16e2d6cd158a62d6addb92d6bc591489350410e5d5b44774cceda2a94411c21
 SHA512:
-  metadata.gz: c098cbcad5c133655d05693bcbbbd4bdbc59118ae5334cb6f81fe196aa66aab6b67490b54887d467e7615847250ccf77b2d5f773c5f2f8b4c47905c18d898ba3
-  data.tar.gz: 690a4aa38f1b0955d9bb448e45896e3034eb4c6422aa57d177e6a6eb76148cf10d7d87c45bc6e37b79db27f68c090e3d64ab9aef02082ebf4158d941c63c32f0
+  metadata.gz: ae082cfc52d681f89aa1afc5454b3a16ae5987eeb6bb0ea7f1c0e7338bf0bd17def10978e3956b17216f4e1de48aa6c93e176441a4dbb5184119d71f2cc33398
+  data.tar.gz: ddada7e2bf3e2ea9430384d615e25307342106c1094780130b49ab483e1fdc1727a65faf5d3df5df06661f12ef618c5bce21ceba23881258ccc0cf34ec4f7358

data/CHANGELOG.md

@@ -0,0 +1,120 @@
+# Change log
+
+## [v0.9.0] - 2018-12-01
+
+### Changed
+* Change tty-cursor dependency
+* Change to Ruby >= 2.0
+* Change to freeze all string literals
+* Change #execute_job to stop evaluating in spinner context and just execute the job
+* Change #register to accept a spinner instance by Shane Cavanaugh(@shanecav84)
+
+### Fixed
+* Fix to remove a stray single quote in spin_4 by Kristofer Rye(@rye)
+* Fix Multi#line_inset to correctly assign styling in threaded environment
+* Fix #stop & #auto_spin to always restore hidden cursor if enabled
+* Fix deadlock when registering multi spinners
+
+## [v0.8.0] - 2018-01-11
+
+### Added
+* Add new formats :bounce, :burger, :dance, :dot_2, ..., dot_11, :shark, :pong
+
+### Changed
+* Change to only output to a console and stop output to a file, pipe etc...
+
+### Fixed
+* Fix spinner #stop to clear line before printing final message
+
+## [v0.7.0] - 2017-09-11
+
+### Added
+* Add :spin event type and emit from TTY::Spinner#spin
+
+### Changed
+* Change to automatically spin top level multi spinner when registered spinners spin
+* Remove unnecessary checks for top spinner in multi spinner #stop, #success, #error
+
+### Fixed
+* Fix multi spinner #observe to only listen for events from registered spinners
+
+## [v0.6.0] - 2017-09-07
+
+### Changed
+* Change TTY::Spinner::Multi to render registerd spinners at row
+  position at point of redering and not registration
+
+### Fixed
+* Fix handling of multi spinner events
+* Fix multi spinner display for unicode inset characters
+
+## [v0.5.0] - 2017-08-09
+
+### Added
+* Add TTY::Spinner::Multi to allow for parallel spinners executation by Austin Blatt[@austb]
+* Add formatting for multi spinner display by Austin Blatt[@austb]
+* Add ability to add and execute jobs for single and multi spinners
+* Add abilty to register multi spinners with async jobs
+* Add #pause and #resume for single and multispinner
+
+### Changed
+* Change to unify success category to mark spinner as succeded or errored
+* Change Spinner to be thread safe
+
+### Fixed
+* Stop firing events when a spinner is stopped
+
+## [v0.4.1] - 2016-08-07
+
+### Changed
+* Change #update to clear output when in spinning state
+
+## [v0.4.0] - 2016-08-07
+
+### Added
+* Add #auto_spin to automatically displaying spinning animation
+
+### Changed
+* Change #start to setup timer and reset done state
+
+## [v0.3.0] - 2016-07-14
+
+### Added
+* Add #run to automatically execute job with spinning animation by @Thermatix
+* Add #update to allow for dynamic label name replacement
+
+### Fixed
+* Fixed cursor hiding for success and error calls by @m-o-e
+* Fix #join call to define actual error
+* Fix #stop to print only once when finished
+
+## [v0.2.0] - 2016-03-13
+
+### Added
+* Add new spinner formats by @rlqualls
+* Add ability to specify custom frames through :frames option
+* Add :clear option for removing spinner output when done
+* Add #success and #error calls for stopping spinner
+* Add :done, :success, :error completion events
+* Add :success_mark & :error_mark to allow changing markers
+* Add :interval for automatic spinning duration
+* Add #start, #join and #kill for automatic spinner animation
+
+### Changed
+* Change message formatting, use :spinner token to customize message
+* Change format for definining spinner formats and intervals
+
+## [v0.1.0] - 2014-11-15
+
+* Initial implementation and release
+
+[v0.9.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.8.0...v0.9.0
+[v0.8.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.7.0...v0.8.0
+[v0.7.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.6.0...v0.7.0
+[v0.6.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.5.0...v0.6.0
+[v0.5.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.4.1...v0.5.0
+[v0.4.1]: https://github.com/piotrmurach/tty-spinner/compare/v0.4.0...v0.4.1
+[v0.4.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.3.0...v0.4.0
+[v0.3.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.2.0...v0.3.0
+[v0.2.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.1.0

data/README.md

@@ -1,3 +1,7 @@
+<div align="center">
+  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty logo" /></a>
+</div>
+
 # TTY::Spinner [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [![Gem Version](https://badge.fury.io/rb/tty-spinner.svg)][gem]
@@ -78,7 +82,7 @@ Or install it yourself as:
 
 ## 1. Usage
 
-**TTY::Spinner** by default uses `:classic` type of formatter and requires no paramters:
+**TTY::Spinner** by default uses `:classic` type of formatter and requires no parameters:
 
 ```ruby
 spinner = TTY::Spinner.new
@@ -108,12 +112,13 @@ and when finished output:
 _ Loading ... Done!
 ```
 
-Use **TTY::Spinner::Multi** to synchornize multiple spinners:
+Use **TTY::Spinner::Multi** to synchronize multiple spinners:
 
 ```ruby
 spinners = TTY::Spinner::Multi.new("[:spinner] top")
 
 sp1 = spinners.register "[:spinner] one"
+# or sp1 = ::TTY::Spinner.new("[:spinner] one")
 sp2 = spinners.register "[:spinner] two"
 
 sp1.auto_spin
@@ -177,10 +182,20 @@ spinner.resume
 
 ### 2.3 run
 
-Use `run` with a code block that will automatically display spinning animation while the block executes and finish animation when the block terminates. Optionally you can provide a stop message to display when animation is finished.
+Use `run` passing a block with a job that will automatically display spinning animation while the block executes and finish animation when the block terminates. The block yields a spinner instance.
 
 ```ruby
-spinner.run('Done!') { ... }
+spinner.run do |spinner|
+  ...
+end
+```
+
+Optionally you can provide a stop message to display when animation is finished.
+
+```ruby
+spinner.run('Done!') do |spinner|
+  ...
+end
 ```
 
 ### 2.4 start
@@ -207,7 +222,7 @@ spinner.stop('Done!')
 
 #### 2.5.1 success
 
-Use `success` call to stop the spinning animation and replace the spinning symbol with checkmark character to indicate successful completion.
+Use `success` call to stop the spinning animation and replace the spinning symbol with check mark character to indicate successful completion.
 
 ```ruby
 spinner = TTY::Spinner.new("[:spinner] Task name")
@@ -222,7 +237,7 @@ This will produce:
 
 #### 2.5.2 error
 
-Use `error` call to stop the spining animation and replace the spinning symbol with cross character to indicate error completion.
+Use `error` call to stop the spinning animation and replace the spinning symbol with cross character to indicate error completion.
 
 ```ruby
 spinner = TTY::Spinner.new("[:spinner] Task name")
@@ -403,6 +418,9 @@ Create and register a `TTY::Spinner` under the multispinner
 
 ```ruby
 new_spinner = multi_spinner.register("[:spinner] Task 1 name", options)
+# or
+#   spinner = ::TTY::Spinner.new("[:spinner] one")
+#   sp1 = multi_spinner.register(spinner)
 ```
 
 If no options are given it will use the options given to the multi_spinner when it was initialized to create the new spinner.
@@ -448,7 +466,7 @@ spinner_1.auto_spin
 spinner_2.auto_spin
 ```
 
-Finnally, you need to stop each spinner manually, in our case we mark the second spinner as failure which in turn will stop the top level multi spinner automatically and mark it as failure:
+Finally, you need to stop each spinner manually, in our case we mark the second spinner as failure which in turn will stop the top level multi spinner automatically and mark it as failure:
 
 ```ruby
 spinner_1.success
@@ -498,7 +516,7 @@ multi_spinner.stop
 
 #### 5.3.1 success
 
-Use `success` call to stop the spinning animation and replace the spinning symbol with checkmark character to indicate successful completion.
+Use `success` call to stop the spinning animation and replace the spinning symbol with a check mark character to indicate successful completion.
 This will also call `#success` on any sub-spinners that are still spinning.
 
 ```ruby
@@ -507,7 +525,7 @@ multi_spinner.success
 
 #### 5.3.2 error
 
-Use `error` call to stop the spining animation and replace the spinning symbol with cross character to indicate error completion.
+Use `error` call to stop the spinning animation and replace the spinning symbol with cross character to indicate error completion.
 This will also call `#error` on any sub-spinners that are still spinning.
 
 ```ruby
@@ -536,4 +554,4 @@ multi_spinner = TTY::Spinner::Multi.new("[:spinner] parent", style: {
 
 ## Copyright
 
-Copyright (c) 2014-2018 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2014 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+require "bundler/gem_tasks"
+
+FileList['tasks/**/*.rake'].each(&method(:import))
+
+desc 'Run all specs'
+task ci: %w[ spec ]

data/examples/auto_spin.rb

@@ -0,0 +1,8 @@
+require_relative '../lib/tty-spinner'
+
+spinner = TTY::Spinner.new("Loading :spinner ...", format: :bouncing_ball)
+spinner.auto_spin
+
+sleep 1 # Some long task
+
+spinner.stop('done')

data/examples/basic.rb

@@ -0,0 +1,8 @@
+require_relative '../lib/tty-spinner'
+
+spinner = TTY::Spinner.new("Loading :spinner ... ", format: :spin_2)
+20.times do
+  spinner.spin
+  sleep(0.1)
+end
+spinner.stop('done')

data/examples/clear.rb

@@ -0,0 +1,9 @@
+require_relative '../lib/tty-spinner'
+
+spinner = TTY::Spinner.new("[:spinner] Task name", format: :bouncing_ball)
+20.times do
+  spinner.spin
+  sleep(0.1)
+end
+
+spinner.success

data/examples/color.rb

@@ -0,0 +1,12 @@
+require 'pastel'
+require_relative '../lib/tty-spinner'
+
+pastel = Pastel.new
+
+format = "[#{pastel.yellow(':spinner')}] " + pastel.yellow("Task name")
+spinner = TTY::Spinner.new(format, success_mark: pastel.green('+'))
+20.times do
+  spinner.spin
+  sleep(0.1)
+end
+spinner.success(pastel.green("(successful)"))

data/examples/error.rb

@@ -0,0 +1,9 @@
+require_relative '../lib/tty-spinner'
+
+spinner = TTY::Spinner.new("[:spinner] Task name")
+20.times do
+  spinner.spin
+  sleep(0.1)
+end
+
+spinner.error('(error)')

data/examples/formats.rb

@@ -0,0 +1,11 @@
+require_relative '../lib/tty-spinner'
+
+TTY::Formats::FORMATS.keys.each do |token|
+  options = {format: token, hide_cursor: true}
+  spinner = TTY::Spinner.new("#{token}: :spinner", options)
+  20.times do
+    spinner.spin
+    sleep(0.1)
+  end
+  spinner.stop
+end

data/examples/hide_cursor.rb

@@ -0,0 +1,12 @@
+require 'pastel'
+require_relative '../lib/tty-spinner'
+
+pastel = Pastel.new
+
+format = "[#{pastel.yellow(':spinner')}] " + pastel.yellow("Task name")
+spinner = TTY::Spinner.new(format, success_mark: pastel.green('+'), hide_cursor: true)
+10.times do
+  spinner.spin
+  sleep(0.1)
+end
+spinner.success(pastel.green("(successful)"))

data/examples/multi/basic.rb

@@ -0,0 +1,13 @@
+require_relative '../../lib/tty-spinner'
+
+spinners = TTY::Spinner::Multi.new
+
+sp1 = spinners.register "[:spinner] one"
+sp2 = spinners.register "[:spinner] two"
+sp3 = spinners.register "[:spinner] three"
+
+th1 = Thread.new { 20.times { sleep(0.2); sp1.spin }}
+th2 = Thread.new { 30.times { sleep(0.1); sp2.spin }}
+th3 = Thread.new { 10.times { sleep(0.3); sp3.spin }}
+
+[th1, th2, th3].each(&:join)

data/examples/multi/basic_top_level.rb

@@ -0,0 +1,13 @@
+require_relative '../../lib/tty-spinner'
+
+spinners = TTY::Spinner::Multi.new "[:spinner] main", format: :pulse
+
+sp1 = spinners.register "[:spinner] one", format: :classic
+sp2 = spinners.register "[:spinner] two", format: :classic
+sp3 = spinners.register "[:spinner] three", format: :classic
+
+th1 = Thread.new { 20.times { sleep(0.2); sp1.spin }}
+th2 = Thread.new { 30.times { sleep(0.1); sp2.spin }}
+th3 = Thread.new { 10.times { sleep(0.3); sp3.spin }}
+
+[th1, th2, th3].each(&:join)

data/examples/multi/custom_style.rb

@@ -0,0 +1,26 @@
+require_relative '../../lib/tty-spinner'
+
+opts = {
+  style: {
+    top: ". ",
+    middle: "|-> ",
+    bottom: "|__ ",
+  },
+  format: :bouncing_ball
+}
+spinners = TTY::Spinner::Multi.new("[:spinner] Top level spinner", opts)
+
+sp1 = spinners.register "[:spinner] one"
+sp2 = spinners.register "[:spinner] two"
+sp3 = spinners.register "[:spinner] three"
+
+sp1.auto_spin
+sp2.auto_spin
+sp3.auto_spin
+
+sleep(2)
+sp1.success
+sleep 1
+sp2.success
+sleep 1
+sp3.error

data/examples/multi/files.rb

@@ -0,0 +1,14 @@
+require 'pastel'
+require_relative '../../lib/tty-spinner'
+
+pastel = Pastel.new
+spinners = TTY::Spinner::Multi.new("[:spinner] Downloading files...")
+
+['file1', 'file2', 'file3'].each do |file|
+  spinners.register("[:spinner] #{file}") do |sp|
+    sleep(rand * 5)
+    sp.success(pastel.green("success"))
+  end
+end
+
+spinners.auto_spin

data/examples/multi/jobs.rb

@@ -0,0 +1,10 @@
+require_relative '../../lib/tty-spinner'
+
+spinners = TTY::Spinner::Multi.new("[:spinner] top")
+
+spinners.register("[:spinner] one")   { |sp| sleep(2); sp.success('yes 2') }
+spinners.register("[:spinner] two")   { |sp| sleep(3); sp.error('no 2') }
+spinners.register("[:spinner] three") { |sp| sleep(1); sp.success('yes 3') }
+
+spinners.auto_spin
+

data/examples/multi/multi.rb

@@ -0,0 +1,17 @@
+require_relative '../../lib/tty-spinner'
+
+spinners = TTY::Spinner::Multi.new
+
+sp1 = spinners.register "[:spinner] one"
+sp2 = spinners.register "[:spinner] two"
+sp3 = spinners.register "[:spinner] three"
+
+sp1.auto_spin
+sp2.auto_spin
+sp3.auto_spin
+
+sleep(2)
+
+sp1.stop
+sp2.stop
+sp3.stop

data/examples/multi/multi_top_level.rb

@@ -0,0 +1,18 @@
+require_relative '../../lib/tty-spinner'
+
+spinners = TTY::Spinner::Multi.new("[:spinner] Top level spinner")
+
+sp1 = spinners.register "[:spinner] one"
+sp2 = spinners.register "[:spinner] two"
+sp3 = spinners.register "[:spinner] three"
+
+sp1.auto_spin
+sp2.auto_spin
+sp3.auto_spin
+
+sleep(2)
+sp1.success
+sleep 1
+sp2.success
+sleep 1
+sp3.error