tty-spinner 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e159c565080b22ece86e4771413feb3edcd39b3
-  data.tar.gz: 890c0f15b5b77de235f25295cbb861745c514b60
+  metadata.gz: 78cca8f09f1905f3cc652e58d71e0e9aaa0b90af
+  data.tar.gz: 8b4776c0f0e1e347edf5f03af42a548198ad24fe
 SHA512:
-  metadata.gz: 88a4bbd2545b596b43ff8ad0ffc9790a125da1a00c2bc4f436e4aa6879536767b3b32ae8de98e928adc785d9e55ff1120ef3c68270db265d691726b522a6606d
-  data.tar.gz: 7a138538758b9805c098e397d136dbfafb69bfcd596272078eb5294d3ad5df3a595cd547afe69fc6ba19ab3fd8fc552e9406a99cabfbab3176e098fa36559e59
+  metadata.gz: c098cbcad5c133655d05693bcbbbd4bdbc59118ae5334cb6f81fe196aa66aab6b67490b54887d467e7615847250ccf77b2d5f773c5f2f8b4c47905c18d898ba3
+  data.tar.gz: 690a4aa38f1b0955d9bb448e45896e3034eb4c6422aa57d177e6a6eb76148cf10d7d87c45bc6e37b79db27f68c090e3d64ab9aef02082ebf4158d941c63c32f0

data/README.md

@@ -1,8 +1,9 @@
 # TTY::Spinner [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+
 [![Gem Version](https://badge.fury.io/rb/tty-spinner.svg)][gem]
 [![Build Status](https://secure.travis-ci.org/piotrmurach/tty-spinner.svg?branch=master)][travis]
 [![Build status](https://ci.appveyor.com/api/projects/status/2i5lx3tvyi5l8x3j?svg=true)][appveyor]
-[![Code Climate](https://codeclimate.com/github/piotrmurach/tty-spinner/badges/gpa.png)][codeclimate]
+[![Maintainability](https://api.codeclimate.com/v1/badges/d5ae2219e194ac99be58/maintainability)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/piotrmurach/tty-spinner/badge.svg)][coverage]
 [![Inline docs](http://inch-ci.org/github/piotrmurach/tty-spinner.svg?branch=master)][inchpages]
 
@@ -10,7 +11,7 @@
 [gem]: http://badge.fury.io/rb/tty-spinner
 [travis]: http://travis-ci.org/piotrmurach/tty-spinner
 [appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-spinner
-[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-spinner
+[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-spinner/maintainability
 [coverage]: https://coveralls.io/r/piotrmurach/tty-spinner
 [inchpages]: http://inch-ci.org/github/piotrmurach/tty-spinner
 
@@ -356,9 +357,11 @@ spinner = TTY::Spinner.new(error_mark: 'x')
 
 ### 3.8 :output
 
-To change where data is streamed use `:output` option like so:
+The spinner only outputs to a console and when output is redirected to a file or a pipe it does nothing. This is so, for example, your error logs do not overflow with spinner output.
 
-```
+You can change where console output is streamed with `:output` option:
+
+```ruby
 spinner = TTY::Spinner.new(output: $stdout)
 ```
 
@@ -533,4 +536,4 @@ multi_spinner = TTY::Spinner::Multi.new("[:spinner] parent", style: {
 
 ## Copyright
 
-Copyright (c) 2014-2017 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2014-2018 Piotr Murach. See LICENSE for further details.

data/lib/tty/spinner.rb

@@ -373,7 +373,8 @@ module TTY
       if @hide_cursor
         write(TTY::Cursor.show, false)
       end
-      return clear_line if @clear
+      clear_line
+      return if @clear
 
       data = message.gsub(MATCHER, next_char)
       data = replace_tokens(data)
@@ -381,7 +382,7 @@ module TTY
         data << ' ' + stop_message
       end
 
-      write(data, true)
+      write(data, false)
       write("\n", false) unless @clear || @multispinner
     ensure
       @state      = :stopped
@@ -496,6 +497,8 @@ module TTY
     #
     # @api private
     def write(data, clear_first = false)
+      return unless tty? # write only to terminal
+
       execute_on_line do
         output.print(TTY::Cursor.column(1)) if clear_first
         # If there's a top level spinner, print with inset
@@ -505,6 +508,15 @@ module TTY
       end
     end
 
+    # Check if IO is attached to a terminal
+    #
+    # return [Boolean]
+    #
+    # @api public
+    def tty?
+      output.respond_to?(:tty?) && output.tty?
+    end
+
     # Emit callback
     #
     # @api private

data/lib/tty/spinner/formats.rb

@@ -20,7 +20,7 @@ module TTY
         frames: %w{◰ ◳ ◲ ◱}
       },
       spin_4: {
-        inteval: 10,
+        interval: 10,
         frames: %w{╫ ╪'}
       },
       pulse: {
@@ -37,7 +37,47 @@ module TTY
       },
       dots: {
         interval: 10,
-        frames: [ "⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏" ]
+        frames: %w{⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏}
+      },
+      dots_2: {
+        interval: 10,
+        frames: %w{⣾ ⣽ ⣻ ⢿ ⡿ ⣟ ⣯ ⣷}
+      },
+      dots_3: {
+        interval: 10,
+        frames: %w{⠋ ⠙ ⠚ ⠞ ⠖ ⠦ ⠴ ⠲ ⠳ ⠓}
+      },
+      dots_4: {
+        interval: 10,
+        frames: %w{⠄ ⠆ ⠇ ⠋ ⠙ ⠸ ⠰ ⠠ ⠰ ⠸ ⠙ ⠋ ⠇ ⠆}
+      },
+      dots_5: {
+        interval: 10,
+        frames: %w{⠋ ⠙ ⠚ ⠒ ⠂ ⠂ ⠒ ⠲ ⠴ ⠦ ⠖ ⠒ ⠐ ⠐ ⠒ ⠓ ⠋}
+      },
+      dots_6: {
+        interval: 10,
+        frames: %w{⠁ ⠉ ⠙ ⠚ ⠒ ⠂ ⠂ ⠒ ⠲ ⠴ ⠤ ⠄ ⠄ ⠤ ⠴ ⠲ ⠒ ⠂ ⠂ ⠒ ⠚ ⠙ ⠉ ⠁}
+      },
+      dots_7: {
+        interval: 10,
+        frames: %w{⠈ ⠉ ⠋ ⠓ ⠒ ⠐ ⠐ ⠒ ⠖ ⠦ ⠤ ⠠ ⠠ ⠤ ⠦ ⠖ ⠒ ⠐ ⠐ ⠒ ⠓ ⠋ ⠉ ⠈}
+      },
+      dots_8: {
+        interval: 10,
+        frames: %w{⠁ ⠁ ⠉ ⠙ ⠚ ⠒ ⠂ ⠂ ⠒ ⠲ ⠴ ⠤ ⠄ ⠄ ⠤ ⠠ ⠠ ⠤ ⠦ ⠖ ⠒ ⠐ ⠐ ⠒ ⠓ ⠋ ⠉ ⠈ ⠈}
+      },
+      dots_9: {
+        interval: 10,
+        frames: %w{⢹ ⢺ ⢼ ⣸ ⣇ ⡧ ⡗ ⡏}
+      },
+      dots_10: {
+        interval: 10,
+        frames: %w{⢄ ⢂ ⢁ ⡁ ⡈ ⡐ ⡠}
+      },
+      dots_11: {
+        interval: 10,
+        frames: %w{⠁ ⠂ ⠄ ⡀ ⢀ ⠠ ⠐ ⠈}
       },
       arrow: {
         interval: 10,
@@ -94,6 +134,10 @@ module TTY
           "(●     )"
         ]
       },
+      bounce: {
+        interval: 10,
+        frames: %w{ ⠁ ⠂ ⠄ ⠂ }
+      },
       box_bounce: {
         interval: 10,
         frames: %w{ ▌ ▀ ▐ ▄  }
@@ -121,6 +165,80 @@ module TTY
       flip: {
         interval: 10,
         frames: '-◡⊙-◠'.freeze
+      },
+      burger: {
+        interval: 6,
+        frames: %w{ ☱ ☲ ☴ }
+      },
+      dance: {
+        interval: 10,
+        frames: [">))'>", " >))'>", "  >))'>", "   >))'>", "    >))'>", "   <'((<", "  <'((<", " <'((<"]
+      },
+      shark: {
+        interval: 10,
+        frames: [
+          "▐|\\____________▌",
+          "▐_|\\___________▌",
+          "▐__|\\__________▌",
+          "▐___|\\_________▌",
+          "▐____|\\________▌",
+          "▐_____|\\_______▌",
+          "▐______|\\______▌",
+          "▐_______|\\_____▌",
+          "▐________|\\____▌",
+          "▐_________|\\___▌",
+          "▐__________|\\__▌",
+          "▐___________|\\_▌",
+          "▐____________|\\▌",
+          "▐____________/|▌",
+          "▐___________/|_▌",
+          "▐__________/|__▌",
+          "▐_________/|___▌",
+          "▐________/|____▌",
+          "▐_______/|_____▌",
+          "▐______/|______▌",
+          "▐_____/|_______▌",
+          "▐____/|________▌",
+          "▐___/|_________▌",
+          "▐__/|__________▌",
+          "▐_/|___________▌",
+          "▐/|____________▌"
+        ]
+      },
+      pong: {
+        interval: 10,
+        frames: [
+          "▐⠂       ▌",
+          "▐⠈       ▌",
+          "▐ ⠂      ▌",
+          "▐ ⠠      ▌",
+          "▐  ⡀     ▌",
+          "▐  ⠠     ▌",
+          "▐   ⠂    ▌",
+          "▐   ⠈    ▌",
+          "▐    ⠂   ▌",
+          "▐    ⠠   ▌",
+          "▐     ⡀  ▌",
+          "▐     ⠠  ▌",
+          "▐      ⠂ ▌",
+          "▐      ⠈ ▌",
+          "▐       ⠂▌",
+          "▐       ⠠▌",
+          "▐       ⡀▌",
+          "▐      ⠠ ▌",
+          "▐      ⠂ ▌",
+          "▐     ⠈  ▌",
+          "▐     ⠂  ▌",
+          "▐    ⠠   ▌",
+          "▐    ⡀   ▌",
+          "▐   ⠠    ▌",
+          "▐   ⠂    ▌",
+          "▐  ⠈     ▌",
+          "▐  ⠂     ▌",
+          "▐ ⠠      ▌",
+          "▐ ⡀      ▌",
+          "▐⠠       ▌"
+        ]
       }
     }
   end # Formats

data/lib/tty/spinner/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Spinner
-    VERSION = "0.7.0"
+    VERSION = '0.8.0'.freeze
   end # Spinner
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-spinner
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-11 00:00:00.000000000 Z
+date: 2018-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-cursor
@@ -45,33 +45,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
 description: A terminal spinner for tasks that have non-deterministic time frame.
 email:
 - pmurach@gmail.com
@@ -111,4 +111,3 @@ signing_key:
 specification_version: 4
 summary: A terminal spinner for tasks that have non-deterministic time frame.
 test_files: []
-has_rdoc: