tty-spinner 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b97fa767937b67b27ecbba2fb06a5b9f69c4d6b
-  data.tar.gz: 20dee6fe62ec0e5f431424f54a26848291773245
+  metadata.gz: 806a1cadc39a03d6b98e3e365fd1c528cc250ae8
+  data.tar.gz: 05929fcc41b54e854a141ff8b52a599081acce85
 SHA512:
-  metadata.gz: bae4dcda349f6d01fe50d39dafbc1519a386e160e0d3568702c588648fcbdd2d673c2e06a8c6508c3b8623cf558ddbe76101c67384892e37d41e7e195f321458
-  data.tar.gz: e319158428db89baa850bbcd14dba26caa9ad9230377bb2f65cde8fdfd42c40b53eec9f205962421e8745a44f31d0406b8cd85f67a49f191aa55956d4b82fbfa
+  metadata.gz: f64c7e4b3d3acc4a9bc2bc688481d3146210498484931c22a0549494c3d494c198f17dd0457a567ede62fee8838431637e09395804e0735943edb87c32857ebc
+  data.tar.gz: 107b562da5049da6b968bd1ada2fc58521b949abcd225b4793d2f36a5d434ec4a9873895ebe6f937bdbdea2a5f25cfeb71c2c66c0f5221082479e9bac4056e35

data/README.md

@@ -39,14 +39,15 @@ Or install it yourself as:
 * [1. Usage](#1-usage)
 * [2. API](#2-api)
   * [2.1 spin](#21-spin)
-  * [2.2 start](#22-start)
-  * [2.3 stop](#23-stop)
-    * [2.3.1 success](#231-success)
-    * [2.3.2 error](#232-error)
-  * [2.4 run](#24-run)
-  * [2.5 update](#25-update)
-  * [2.6 reset](#26-reset)
-  * [2.7 join](#27-join)
+  * [2.2 auto_spin](#22-auto_spin)
+  * [2.3 run](#23-run)
+  * [2.4 start](#24-start)
+  * [2.5 stop](#25-stop)
+    * [2.5.1 success](#251-success)
+    * [2.5.2 error](#252-error)
+  * [2.6 update](#26-update)
+  * [2.7 reset](#27-reset)
+  * [2.8 join](#28-join)
 * [3. Configuration](#3-configuration)
   * [3.1 :format](#31-format)
   * [3.2 :frames](#32-frames)
@@ -108,17 +109,33 @@ loop do
 end
 ```
 
-### 2.2 start
+### 2.2 auto_spin
 
-To perform automatic spinning call `start` method like so:
+To perform automatic spinning animation use `auto_spin` method like so:
 
 ```ruby
-spinner.start
+spinner.auto_spin
 ```
 
 The speed with which the spinning happens is determined by the `:interval` parameter. All the spinner formats have their default intervals specified ([see](https://github.com/piotrmurach/tty-spinner/blob/master/lib/tty/spinner/formats.rb)).
 
-### 2.3 stop
+### 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.
+
+```ruby
+spinner.run('Done!') { ... }
+```
+
+### 2.4 start
+
+In order to set start time or reuse the same spinner after it has stopped, call `start` method:
+
+```ruby
+spinner.start
+```
+
+### 2.5 stop
 
 In order to stop the spinner call `stop`. This will finish drawing the spinning animation and return to new line.
 
@@ -132,7 +149,7 @@ You can further pass a message to print when animation is finished.
 spinner.stop('Done!')
 ```
 
-#### 2.3.1 success
+#### 2.5.1 success
 
 Use `success` call to stop the spinning animation and replace the spinning symbol with checkmark character to indicate successful completion.
 
@@ -147,7 +164,7 @@ This will produce:
 [✔] Task name (successful)
 ```
 
-#### 2.3.2 error
+#### 2.5.2 error
 
 Use `error` call to stop the spining animation and replace the spinning symbol with cross character to indicate error completion.
 
@@ -162,15 +179,8 @@ This will produce:
 [✖] Task name (error)
 ```
 
-### 2.4 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.
-
-```ruby
-spinner.run('Done!') { ... }
-```
 
-### 2.5 update
+### 2.6 update
 
 Use `update` call to dynamically change label name(s).
 
@@ -200,7 +210,7 @@ spinner.update(title: 'Downloading file2')
 spinner.run { ... }
 ```
 
-### 2.6 reset
+### 2.7 reset
 
 In order to reset the spinner to its initial frame do:
 
@@ -208,7 +218,7 @@ In order to reset the spinner to its initial frame do:
 spinner.reset
 ```
 
-### 2.7 join
+### 2.8 join
 
 One way to wait while the spinning animates is to join the thread started with `start` method:
 

data/lib/tty/spinner/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Spinner
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end # Spinner
 end # TTY

data/lib/tty/spinner.rb

@@ -128,12 +128,20 @@ module TTY
       self
     end
 
-    # Start automatic spinning animation
+    # Start timer and unlock spinner
     #
     # @api public
     def start
       @started_at = Time.now
       @done = false
+      reset
+    end
+
+    # Start automatic spinning animation
+    #
+    # @api public
+    def auto_spin
+      start
       sleep_time = 1.0 / @interval
 
       @thread = Thread.new do
@@ -155,8 +163,9 @@ module TTY
     #   spinner.run('Migrated DB') { ... }
     #
     # @api public
-    def run(stop_message = nil, &block)
-      start
+    def run(stop_message = '', &block)
+      auto_spin
+
       @work = Thread.new(&block)
       @work.join
     ensure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-spinner
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2016-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler