tty-spinner 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e2a6c489b56c8375abe0015bff1ac62ad9eb208
-  data.tar.gz: 69bb91f2cbc1781b7aae9126a306ffc942683aa2
+  metadata.gz: 8e04e5566451769e21e19b19e1e737a2a4680529
+  data.tar.gz: f62fbd9e4da87305573bdf3214f32029d51efd41
 SHA512:
-  metadata.gz: 0eef90653e7d511c3653668e08aa4728f2ea5a17225a7c60f31cad9c8059b340e00f1087cabf8e6343eea212a67fd8a7fe7cb5fc54268c0b8efd6c7511c2d7fe
-  data.tar.gz: e8e97d5647daee951fe742431deddfa785c0c490a0fa04d08f00dde7c25cf70497ddb6d2ece86a53eeda0c2bab17fc406f78bfb8c6ecd851d11e4ce2f0bac36a
+  metadata.gz: 36bc537184f487b0d0b1ee2b97075c0179eb07e5bd1e7cdc42036d1a7fc67972b22161fd178577e96dbdd959a498073aa6f4cd7b36aef5c35f8ad7c6a326a81c
+  data.tar.gz: 02d7cf58e0fd5650249ee89e249211217f10793feee1d9aaa77600a220de2c789ec029150ebc5848e6446a105cdf9db673bfadd29306c31df1bf78de9e79b157

data/README.md

@@ -1,15 +1,17 @@
 # TTY::Spinner
-[![Gem Version](https://badge.fury.io/rb/tty-spinner.png)][gem]
-[![Build Status](https://secure.travis-ci.org/peter-murach/tty-spinner.png?branch=master)][travis]
-[![Code Climate](https://codeclimate.com/github/peter-murach/tty-spinner.png)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/peter-murach/tty-spinner/badge.png)][coverage]
+[![Gem Version](https://badge.fury.io/rb/tty-spinner.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/peter-murach/tty-spinner.svg?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/peter-murach/tty-spinner/badges/gpa.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/peter-murach/tty-spinner/badge.svg)][coverage]
+[![Inline docs](http://inch-ci.org/github/peter-murach/tty-spinner.svg?branch=master)][inchpages]
 
 [gem]: http://badge.fury.io/rb/tty-spinner
 [travis]: http://travis-ci.org/peter-murach/tty-spinner
 [codeclimate]: https://codeclimate.com/github/peter-murach/tty-spinner
 [coverage]: https://coveralls.io/r/peter-murach/tty-spinner
+[inchpages]: http://inch-ci.org/github/peter-murach/tty-spinner
 
-A terminal spinner for tasks that have non-deterministic time frame.
+> A terminal spinner for tasks that have non-deterministic time frame.
 
 **TTY::Spinner** provides independent spinner component for [TTY](https://github.com/peter-murach/tty) toolkit.
 
@@ -32,61 +34,122 @@ Or install it yourself as:
 ## Contents
 
 * [1. Usage](#1-usage)
-  * [1.1 spin](#11-spin)
-  * [1.2 stop](#12-stop)
-  * [1.3 reset](#13-reset)
-* [2. Configuration](#2-configuration)
-* [3. Formatting](#3-formatting)
+* [2. API](#2-api)
+  * [2.1 spin](#21-spin)
+  * [2.2 start](#22-start)
+  * [2.3 stop](#23-stop)
+  * [2.4 success](#24-success)
+  * [2.5 error](#25-error)
+  * [2.6 reset](#26-reset)
+  * [2.7 join](#27-join)
+* [3. Configuration](#3-configuration)
+  * [3.1 :format](#31-format)
+  * [3.2 :frames](#32-frames)
+  * [3.3 :interval](#33-interval)
+  * [3.4 :hide_cursor](#34-hide_cursor)
+  * [3.5 :clear](#35-clear)
+  * [3.6 :success_mark](#36-success_mark)
+  * [3.7 :error_mark](#37-error_mark)
+  * [3.8 :output](#38-output)
+* [4. Events](#4-events)
+  * [4.1 done](#41-done)
+  * [4.2 success](#42-success)
+  * [4.3 error](#43-error)
 
 ## 1. Usage
 
-**TTY::ProgressBar** by default uses `:spin_1` type of formatter and requires no paramters:
+**TTY::Spinner** by default uses `:classic` type of formatter and requires no paramters:
 
 ```ruby
 spinner = TTY::Spinner.new
 ```
 
-In addition you can provide a message and format type you would like for the spinning display like so:
+In addition you can provide a message with `:spinner` token and format type you would like for the spinning display:
 
 ```ruby
-spinner = TTY::Spinner.new('Loading ... ', format: :spin_2)
+spinner = TTY::Spinner.new("[:spinner] Loading ...", format: :pulse_2)
 30.times do
   spinner.spin
   sleep(0.1)
 end
+spinner.stop('Done!')
+```
+
+This would produce animation in your terminal:
+
+```ruby
+⎺ Loading ...
 ```
 
-This would product animation in your terminal:
+and when finished output:
 
 ```ruby
-Loading ... ⎺
+_ Loading ... Done!
 ```
 
-### 1.1 spin
+For more usage examples please see [examples directory](https://github.com/peter-murach/tty-spinner/tree/master/examples)
+
+## 2. API
+
+### 2.1 spin
 
 The main workhorse of the spinner is the `spin` method. Looping over `spin` method will animate a given spinner.
 
-### 1.2 stop
+### 2.2 start
+
+To perform automatic spinning call `start` method like so:
+
+```ruby
+spinner.start
+```
+
+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/peter-murach/tty-spinner/blob/master/lib/tty/spinner/formats.rb)
 
-In order to stop the spinner call `stop`. This will finish drawing the spinning and return to new line.
+### 2.3 stop
+
+In order to stop the spinner call `stop`. This will finish drawing the spinning animation and return to new line.
 
 ```ruby
 spinner.stop
 ```
 
-You can further pass a stop message to print in place of spinning animation:
+You can further pass a message to print when animation is finished.
 
 ```ruby
 spinner.stop('Done!')
 ```
 
-which would produce for the above example the following:
+### 2.4 success
+
+Use `success` call to stop the spinning animation and replace the spinning symbol with checkmark character to indicate successful completion.
+
+```ruby
+spinner = TTY::Spinner.new("[:spinner] Task name")
+spinner.success('(successful)')
+```
+
+This will produce:
+
+```
+[✔] Task name (successful)
+```
+
+### 2.5 error
+
+Use `error` call to stop the spining animation and replace the spinning symbol with cross character to indicate error completion.
+
+```ruby
+spinner = TTY::Spinner.new("[:spinner] Task name")
+spinner.error('(error)')
+```
+
+This will produce:
 
 ```ruby
-Loading ... Done!
+[✖] Task name (error)
 ```
 
-### 1.3 reset
+### 2.6 reset
 
 In order to reset the spinner to its initial frame do:
 
@@ -94,30 +157,125 @@ In order to reset the spinner to its initial frame do:
 spinner.reset
 ```
 
-## 2. Configuration
+### 2.7 join
+
+One way to wait while the spinning animates is to join the thread started with `start` method:
+
+```ruby
+spinner.join
+```
+
+Optionally you can provide timeout:
+
+```ruby
+spinner.join(0.5)
+```
+
+## 3. Configuration
 
-There are number of configuration options that can be provided:
+There are number of configuration options that can be provided to customise the behaviour of a spinner.
 
-* `format` the formatting token (see [Formatting](#3-formatting))
-* `output` the output stream defaulting to `stderr`
-* `hide_cursor` to hide display cursor defaulting to `false`
+### 3.1 :format
 
-## 3. Formatting
+Use one of the predefined spinner styles by passing the formatting token `:format`
 
-**TTY::Spinner** supports the following formatting for its spinners:
+```ruby
+spinner = TTY::Spinner.new(format: :pulse_2)
+```
+
+All spinner formats that **TTY::Spinner** accepts are defined in [/lib/tty/spinner/formats.rb](https://github.com/peter-murach/tty-spinner/blob/master/lib/tty/spinner/formats.rb)
+
+If you wish to see all available formats in action run the `formats.rb` file in examples folder like so:
+
+```ruby
+bundle exec ruby examples/formats.rb
+```
+
+### 3.2 :frames
+
+If you wish to use custom formatting use the `:frames` option with either `array` or `string` of characters.
+
+```ruby
+spinner = TTY::Spinner.new(frames: [".", "o", "0", "@", "*"])
+```
 
-| Type     | Animation   |
-| -------- | ----------- |
-| :spin_1  |             |
-| :spin_2  |             |
-| :spin_3  |             |
-| :spin_4  |             |
-| :spin_5  |             |
-| :spin_6  |             |
-| :spin_7  |             |
-| :spin_8  |             |
-| :spin_9  |             |
-| :spin_10 |             |
+### 3.3 :interval
+
+The `:interval` option  accepts `integer` representing number of `Hz` units, for instance, frequency of 10 will mean that the spinning animation will be displayed 10 times per second.
+
+```ruby
+spinner = TTY::Spinner.new(interval: 20) # 20 Hz (20 times per second)
+```
+
+### 3.4 :hide_cursor
+
+Hides cursor when spinning animation performs. Defaults to `false`.
+
+```ruby
+spinner = TTY::Spinner.new(hide_cursor: true)
+```
+
+### 3.5 :clear
+
+After spinner is finished clears its output. Defaults to `false`.
+
+```ruby
+spinner = TTY::Spinner.new(clear: true)
+```
+
+### 3.6 :success_mark
+
+To change marker indicating successful completion use the `:success_mark` option:
+
+```ruby
+spinner = TTY::Spinner.new(success_mark: '+')
+```
+
+### 3.7 :error_mark
+
+To change marker indicating error completion use the `:error_mark` option:
+
+```ruby
+spinner = TTY::Spinner.new(error_mark: 'x')
+```
+
+### 3.8 :output
+
+To change where data is streamed use `:output` option like so:
+
+```
+spinner = TTY::Spinner.new(output: $stdout)
+```
+
+The output stream defaults to `stderr`.
+
+## 4. Events
+
+**TTY::Spinner** emits `:done`, `:success` and `:error` event types when spinner is stopped.
+
+### 4.1 done
+
+This event is emitted irrespective of the completion method. In order to listen for this event you need to register callback:
+
+```ruby
+spinner.on(:done) { ... }
+```
+
+### 4.2 success
+
+This event is fired when `success` call is made. In order to respond to the event, you need to register callback:
+
+```ruby
+spinner.on(:success) { ... }
+```
+
+### 4.3 error
+
+This event is fired when `error` completion is called. In order to respond to the event, you need to register callback:
+
+```ruby
+spinner.on(:error) { ... }
+```
 
 ## Contributing
 
@@ -129,4 +287,4 @@ There are number of configuration options that can be provided:
 
 ## Copyright
 
-Copyright (c) 2014 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2014-2016 Piotr Murach. See LICENSE for further details.

data/lib/tty/spinner.rb

@@ -9,13 +9,19 @@ module TTY
   # @api public
   class Spinner
     include Formats
-    ECMA_ESC = "\x1b"
-    ECMA_CSI = "\x1b["
-    ECMA_CHA = 'G'
 
-    DEC_RST = 'l'
-    DEC_SET = 'h'
-    DEC_TCEM = '?25'
+    ECMA_ESC = "\x1b".freeze
+    ECMA_CSI = "\x1b[".freeze
+    ECMA_CHA = 'G'.freeze
+    ECMA_CLR = 'K'.freeze
+
+    DEC_RST = 'l'.freeze
+    DEC_SET = 'h'.freeze
+    DEC_TCEM = '?25'.freeze
+
+    MATCHER = /:spinner/.freeze
+    TICK = '✔'.freeze
+    CROSS = '✖'.freeze
 
     # The object that responds to print call defaulting to stderr
     #
@@ -59,21 +65,98 @@ module TTY
     #   the object that responds to print call defaulting to stderr
     # @option options [Boolean] :hide_cursor
     #   display or hide cursor
+    # @option options [Boolean] :clear
+    #   clear ouptut when finished
+    # @option options [Float] :interval
+    #   the interval for auto spinning
     #
     # @api public
     def initialize(*args)
       options  = args.last.is_a?(::Hash) ? args.pop : {}
-      @message = args.empty? ? '' : args.pop
+      @message = args.empty? ? ':spinner' : args.pop
 
-      @format      = options.fetch(:format) { :spin_1 }
+      @format      = options.fetch(:format) { :classic }
       @output      = options.fetch(:output) { $stderr }
       @hide_cursor = options.fetch(:hide_cursor) { false }
+      @frames      = options.fetch(:frames) {
+                       fetch_format(@format.to_sym, :frames) }
+      @clear       = options.fetch(:clear) { false }
+      @success_mark= options.fetch(:success_mark) { TICK }
+      @error_mark  = options.fetch(:error_mark) { CROSS }
+      @interval    = options.fetch(:interval) {
+                       fetch_format(@format.to_sym, :interval) }
 
-      @frames      = FORMATS[@format.to_sym]
+      @callbacks   = Hash.new { |h, k| h[k] = [] }
       @length      = @frames.length
       @current     = 0
       @done        = false
-      @spinning    = false
+      @state       = :stopped
+    end
+
+    def spinning?
+      @state == :spinning
+    end
+
+    def success?
+      @state == :success
+    end
+
+    def error?
+      @state == :error
+    end
+
+    # Register callback
+    #
+    # @api public
+    def on(name, &block)
+      @callbacks[name] << block
+      self
+    end
+
+    # Start automatic spinning
+    #
+    #
+    # @api public
+    def start
+      @started_at = Time.now
+      sleep_time = 1.0 / @interval
+
+      @thread = Thread.new do
+        while @started_at do
+          spin
+          sleep(sleep_time)
+        end
+      end
+    end
+
+    # Duration of the spinning animation
+    #
+    # @return [Numeric]
+    #
+    # @api public
+    def duration
+      @started_at ? Time.now - @started_at : nil
+    end
+
+    # Join running spinner
+    #
+    # @param [Float] timeout
+    #   the timeout for join
+    #
+    # @api public
+    def join(timeout = nil)
+      fail NotSpinningError.new(
+        "Cannot join spinner that is not running"
+      ) unless @thread
+
+      timeout ? @thread.join(timeout) : @thread.join
+    end
+
+    # Kill running spinner
+    #
+    # @api public
+    def kill
+      @thread.kill if @thread
     end
 
     # Perform a spin
@@ -85,14 +168,14 @@ module TTY
     def spin
       return if @done
 
-      if @hide_cursor && !@spinning
+      if @hide_cursor && !spinning?
         write(ECMA_CSI + DEC_TCEM + DEC_RST)
       end
 
-      data = message + @frames[@current]
+      data = message.gsub(MATCHER, @frames[@current])
       write(data, true)
-      @current  = (@current + 1) % @length
-      @spinning = true
+      @current = (@current + 1) % @length
+      @state = :spinning
       data
     end
 
@@ -103,12 +186,55 @@ module TTY
     #
     # @api public
     def stop(stop_message = '')
-      if @hide_cursor && @spinning
+      if @hide_cursor && spinning?
         write(ECMA_CSI + DEC_TCEM + DEC_SET, false)
       end
       @done = true
-      return if message.empty? && stop_message.empty?
-      write(message + stop_message, true)
+      @started_at = nil
+      emit(:done)
+      return clear_line if @clear
+
+      char = if success?
+               @success_mark
+             elsif error?
+               @error_mark
+             else
+               @frames[@current - 1]
+             end
+      data = message.gsub(MATCHER, char)
+
+      if !stop_message.empty?
+        data << ' ' + stop_message
+      end
+
+      write(data, true)
+      write("\n", false) unless @clear
+      reset
+    end
+
+    # Finish spinning and set state to :success
+    #
+    # @api public
+    def success(stop_message = '')
+      @state = :success
+      stop(stop_message)
+      emit(:success)
+    end
+
+    # Finish spinning and set state to :error
+    #
+    # @api public
+    def error(stop_message = '')
+      @state = :error
+      stop(stop_message)
+      emit(:error)
+    end
+
+    # Clear current line
+    #
+    # @api public
+    def clear_line
+      output.print(ECMA_CSI + '0m' + ECMA_CSI + '1000D' + ECMA_CSI + ECMA_CLR)
     end
 
     # Reset the spinner to initial frame
@@ -116,6 +242,7 @@ module TTY
     # @api public
     def reset
       @current = 0
+      @state   = :stopped
     end
 
     private
@@ -130,5 +257,30 @@ module TTY
       output.print(data)
       output.flush
     end
+
+    # Emit callback
+    #
+    # @api private
+    def emit(name, *args)
+      @callbacks[name].each do |block|
+        block.call(*args)
+      end
+    end
+
+    # Find frames by token name
+    #
+    # @param [Symbol] token
+    #   the name for the frames
+    #
+    # @return [Array, String]
+    #
+    # @api private
+    def fetch_format(token, property)
+      if FORMATS.key?(token)
+        FORMATS[token][property]
+      else
+        raise ArgumentError, "Unknown format token `:#{token}`"
+      end
+    end
   end # Spinner
 end # TTY

data/lib/tty/spinner/formats.rb

@@ -3,16 +3,125 @@
 module TTY
   module Formats
     FORMATS = {
-      spin_1: "|/-\\",
-      spin_2: '⎺⎻⎼⎽⎼⎻',
-      spin_3: '◴◷◶◵',
-      spin_4: '◐◓◑◒',
-      spin_5: '◰◳◲◱',
-      spin_6: '▉▊▋▌▍▎▏▎▍▌▋▊▉',
-      spin_7: '▌▄▐▀',
-      spin_8: '■□▪▫',
-      spin_9: '←↑→↓',
-      spin_10: '╫╪'
+      classic: {
+        interval: 10,
+        frames: %w{| / - \\}
+      },
+      spin: {
+        interval: 10,
+        frames: %w{◴ ◷ ◶ ◵ }
+      },
+      spin_2: {
+        interval: 10,
+        frames: %w{◐ ◓ ◑ ◒ }
+      },
+      spin_3: {
+        interval: 10,
+        frames: %w{◰ ◳ ◲ ◱}
+      },
+      spin_4: {
+        inteval: 10,
+        frames: %w{╫ ╪'}
+      },
+      pulse: {
+        interval: 10,
+        frames: %w{⎺ ⎻ ⎼ ⎽ ⎼ ⎻}
+      },
+      pulse_2: {
+        interval: 15,
+        frames: %w{▁ ▃ ▅ ▆ ▇ █ ▇ ▆ ▅ ▃ }
+      },
+      pulse_3: {
+        interval: 20,
+        frames: '▉▊▋▌▍▎▏▎▍▌▋▊▉'
+      },
+      dots: {
+        interval: 10,
+        frames: [ "⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏" ]
+      },
+      arrow: {
+        interval: 10,
+        frames: %w{← ↖ ↑ ↗ → ↘ ↓ ↙ }
+      },
+      arrow_pulse: {
+        interval: 10,
+        frames: [
+          "▹▹▹▹▹",
+          "▸▹▹▹▹",
+          "▹▸▹▹▹",
+          "▹▹▸▹▹",
+          "▹▹▹▸▹",
+          "▹▹▹▹▸"
+        ]
+      },
+      triangle: {
+        interval: 10,
+        frames: %w{◢ ◣ ◤ ◥}
+      },
+      arc: {
+        interval: 10,
+        frames: %w{ ◜ ◠ ◝ ◞ ◡ ◟ }
+      },
+      pipe: {
+        interval: 10,
+        frames: %w{ ┤ ┘ ┴ └ ├ ┌ ┬ ┐ }
+      },
+      bouncing: {
+        interval: 10,
+        frames: [
+          "[    ]",
+          "[   =]",
+          "[  ==]",
+          "[ ===]",
+          "[====]",
+          "[=== ]",
+          "[==  ]",
+          "[=   ]"
+        ]
+      },
+      bouncing_ball: {
+        interval: 10,
+        frames: [
+          "( ●    )",
+          "(  ●   )",
+          "(   ●  )",
+          "(    ● )",
+          "(     ●)",
+          "(    ● )",
+          "(   ●  )",
+          "(  ●   )",
+          "( ●    )",
+          "(●     )"
+        ]
+      },
+      box_bounce: {
+        interval: 10,
+        frames: %w{ ▌ ▀ ▐ ▄  }
+      },
+      box_bounce_2: {
+        interval: 10,
+        frames: %w{ ▖ ▘ ▝ ▗ }
+      },
+      star: {
+        interval: 10,
+        frames: %w{ ✶ ✸ ✹ ✺ ✹ ✷ }
+      },
+      toggle: {
+        interval: 10,
+        frames: %w{ ■ □ ▪ ▫ }
+      },
+      balloon: {
+        interval: 10,
+        frames: %w{ . o O @ * }
+      },
+      balloon_2: {
+        interval: 10,
+        frames: %w{. o O ° O o . }
+      },
+      flip: {
+        interval: 10,
+        frames: '-◡⊙-◠'.freeze
+      }
     }
   end # Formats
 end # TTY

data/lib/tty/spinner/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Spinner
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end # Spinner
 end # TTY

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: tty-spinner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-15 00:00:00.000000000 Z
+date: 2016-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.5.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - <
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: A terminal spinner for tasks that have non-deterministic time frame.
 email:
 - pmurach@gmail.com
@@ -45,29 +51,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-version
-- .travis.yml
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- examples/basic.rb
-- lib/tty-spinner.rb
-- lib/tty/spinner.rb
 - lib/tty/spinner/formats.rb
 - lib/tty/spinner/version.rb
-- spec/spec_helper.rb
-- spec/unit/hide_cursor_spec.rb
-- spec/unit/new_spec.rb
-- spec/unit/reset_spec.rb
-- spec/unit/spin_spec.rb
-- spec/unit/stop_spec.rb
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-- tty-spinner.gemspec
+- lib/tty/spinner.rb
+- lib/tty-spinner.rb
+- LICENSE.txt
+- README.md
 homepage: https://github.com/peter-murach/tty-spinner
 licenses:
 - MIT
@@ -92,11 +81,5 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A terminal spinner for tasks that have non-deterministic time frame.
-test_files:
-- spec/spec_helper.rb
-- spec/unit/hide_cursor_spec.rb
-- spec/unit/new_spec.rb
-- spec/unit/reset_spec.rb
-- spec/unit/spin_spec.rb
-- spec/unit/stop_spec.rb
+test_files: []
 has_rdoc: 

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.ruby-version

@@ -1 +0,0 @@
-2.0.0

data/.travis.yml

@@ -1,24 +0,0 @@
-language: ruby
-bundler_args: --without yard benchmarks
-script: "bundle exec rake ci"
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - ruby-head
-matrix:
-  include:
-    - rvm: jruby-19mode
-    - rvm: jruby-20mode
-    - rvm: jruby-21mode
-    - rvm: jruby-head
-    - rvm: rbx-2
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: jruby-19mode
-    - rvm: jruby-20mode
-    - rvm: jruby-21mode
-  fast_finish: true
-branches:
-  only: master

data/Gemfile

@@ -1,17 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :development do
-  gem 'rake',    '~> 10.3.2'
-  gem 'rspec',   '~> 3.1.0'
-  gem 'yard',    '~> 0.8.7'
-  gem 'timecop', '~> 0.7.1'
-  gem 'pastel',  '~> 0.3.0'
-end
-
-group :metrics do
-  gem 'coveralls', '~> 0.7.0'
-  gem 'simplecov', '~> 0.8.2'
-  gem 'yardstick', '~> 0.9.9'
-end

data/Rakefile

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

data/examples/basic.rb

@@ -1,9 +0,0 @@
-# coding: utf-8
-
-require 'tty-spinner'
-
-spinner = TTY::Spinner.new("Loading ... ", format: :spin_2)
-20.times do
-  spinner.spin
-  sleep(0.1)
-end

data/spec/spec_helper.rb

@@ -1,45 +0,0 @@
-# encoding: utf-8
-
-if RUBY_VERSION > '1.9' and (ENV['COVERAGE'] || ENV['TRAVIS'])
-  require 'simplecov'
-  require 'coveralls'
-
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ]
-
-  SimpleCov.start do
-    command_name 'spec'
-    add_filter 'spec'
-  end
-end
-
-require 'tty-spinner'
-
-RSpec.configure do |config|
-  config.expect_with :rspec do |expectations|
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  config.mock_with :rspec do |mocks|
-    mocks.verify_partial_doubles = true
-  end
-
-  # Limits the available syntax to the non-monkey patched syntax that is recommended.
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  if config.files_to_run.one?
-    config.default_formatter = 'doc'
-  end
-
-  config.profile_examples = 2
-
-  config.order = :random
-
-  Kernel.srand config.seed
-end

data/spec/unit/hide_cursor_spec.rb

@@ -1,21 +0,0 @@
-# coding: utf-8
-
-require 'spec_helper'
-
-RSpec.describe TTY::Spinner, 'hide_cursor' do
-  let(:output) { StringIO.new('', 'w+') }
-
-  it "hides cursor" do
-    spinner = TTY::Spinner.new(output: output, hide_cursor: true)
-    4.times { spinner.spin }
-    spinner.stop
-    output.rewind
-    expect(output.read).to eq([
-      "\e[?25l\e[1G|",
-      "\e[1G/",
-      "\e[1G-",
-      "\e[1G\\",
-      "\e[?25h"
-    ].join)
-  end
-end

data/spec/unit/new_spec.rb

@@ -1,22 +0,0 @@
-# coding: utf-8
-
-require 'spec_helper'
-
-RSpec.describe TTY::Spinner, '.new' do
-
-  it "creates spinner with default format" do
-    spinner = TTY::Spinner.new
-    expect(spinner.format).to eq(:spin_1)
-  end
-
-  it "allows to pass message in" do
-    spinner = TTY::Spinner.new("Initializing...")
-    expect(spinner.message).to eq("Initializing...")
-  end
-
-  it "allows to set default output" do
-    output = $stdout
-    spinner = TTY::Spinner.new(output: output)
-    expect(spinner.output).to eq(output)
-  end
-end

data/spec/unit/reset_spec.rb

@@ -1,23 +0,0 @@
-# coding: utf-8
-
-require 'spec_helper'
-
-RSpec.describe TTY::Spinner, '.reset' do
-  let(:output) { StringIO.new('', 'w+') }
-
-  it "spins default frames" do
-    spinner = TTY::Spinner.new(output: output)
-    5.times do |n|
-      spinner.spin
-      spinner.reset if n == 2
-    end
-    output.rewind
-    expect(output.read).to eq([
-      "\e[1G|",
-      "\e[1G/",
-      "\e[1G-",
-      "\e[1G|",
-      "\e[1G/"
-    ].join)
-  end
-end

data/spec/unit/spin_spec.rb

@@ -1,46 +0,0 @@
-# coding: utf-8
-
-require 'spec_helper'
-
-RSpec.describe TTY::Spinner, '.spin' do
-  let(:output) { StringIO.new('', 'w+') }
-
-  it "spins default frames" do
-    spinner = TTY::Spinner.new(output: output)
-    5.times { spinner.spin }
-    output.rewind
-    expect(output.read).to eq([
-      "\e[1G|",
-      "\e[1G/",
-      "\e[1G-",
-      "\e[1G\\",
-      "\e[1G|"
-    ].join)
-  end
-
-  it "spins chosen frame" do
-    spinner = TTY::Spinner.new(output: output, format: :spin_3)
-    5.times { spinner.spin }
-    output.rewind
-    expect(output.read).to eq([
-      "\e[1G◴",
-      "\e[1G◷",
-      "\e[1G◶",
-      "\e[1G◵",
-      "\e[1G◴"
-    ].join)
-  end
-
-  it "spins with message" do
-    message = "Loading ... "
-    spinner = TTY::Spinner.new(message, output: output)
-    4.times { spinner.spin }
-    output.rewind
-    expect(output.read).to eq([
-      "\e[1G#{message}|",
-      "\e[1G#{message}/",
-      "\e[1G#{message}-",
-      "\e[1G#{message}\\"
-    ].join)
-  end
-end

data/spec/unit/stop_spec.rb

@@ -1,49 +0,0 @@
-# coding: utf-8
-
-require 'spec_helper'
-
-RSpec.describe TTY::Spinner, '.stop' do
-  let(:output) { StringIO.new('', 'w+') }
-
-  it "stops after 2 spins" do
-    spinner = TTY::Spinner.new(output: output)
-    5.times do |n|
-      spinner.spin
-      spinner.stop if n == 1
-    end
-    output.rewind
-    expect(output.read).to eq([
-      "\e[1G|",
-      "\e[1G/"
-    ].join)
-  end
-
-  it "stops after 2 spins and prints stop message" do
-    spinner = TTY::Spinner.new(output: output)
-    5.times do |n|
-      spinner.spin
-      spinner.stop('Done!') if n == 1
-    end
-    output.rewind
-    expect(output.read).to eq([
-      "\e[1G|",
-      "\e[1G/",
-      "\e[1GDone!"
-    ].join)
-  end
-
-  it "stops after 2 spins with message and prints stop message" do
-    message = "Loading ... "
-    spinner = TTY::Spinner.new(message, output: output)
-    5.times do |n|
-      spinner.spin
-      spinner.stop('Done!') if n == 1
-    end
-    output.rewind
-    expect(output.read).to eq([
-      "\e[1G#{message}|",
-      "\e[1G#{message}/",
-      "\e[1G#{message}Done!"
-    ].join)
-  end
-end

data/tasks/console.rake

@@ -1,10 +0,0 @@
-# encoding: utf-8
-
-desc 'Load gem inside irb console'
-task :console do
-  require 'irb'
-  require 'irb/completion'
-  require File.join(__FILE__, '../../lib/tty-spinner')
-  ARGV.clear
-  IRB.start
-end

data/tasks/coverage.rake

@@ -1,11 +0,0 @@
-# encoding: utf-8
-
-desc 'Measure code coverage'
-task :coverage do
-  begin
-    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
-    Rake::Task['spec'].invoke
-  ensure
-    ENV['COVERAGE'] = original
-  end
-end

data/tasks/spec.rake

@@ -1,29 +0,0 @@
-# encoding: utf-8
-
-begin
-  require 'rspec/core/rake_task'
-
-  desc 'Run all specs'
-  RSpec::Core::RakeTask.new(:spec) do |task|
-    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
-  end
-
-  namespace :spec do
-    desc 'Run unit specs'
-    RSpec::Core::RakeTask.new(:unit) do |task|
-      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
-    end
-
-    desc 'Run integration specs'
-    RSpec::Core::RakeTask.new(:integration) do |task|
-      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
-    end
-  end
-
-rescue LoadError
-  %w[spec spec:unit spec:integration].each do |name|
-    task name do
-      $stderr.puts "In order to run #{name}, do `gem install rspec`"
-    end
-  end
-end

data/tty-spinner.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'tty/spinner/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "tty-spinner"
-  spec.version       = TTY::Spinner::VERSION
-  spec.authors       = ["Piotr Murach"]
-  spec.email         = ["pmurach@gmail.com"]
-  spec.summary       = %q{A terminal spinner for tasks that have non-deterministic time frame.}
-  spec.description   = %q{A terminal spinner for tasks that have non-deterministic time frame.}
-  spec.homepage      = "https://github.com/peter-murach/tty-spinner"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-end