tty-spinner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e2a6c489b56c8375abe0015bff1ac62ad9eb208
+  data.tar.gz: 69bb91f2cbc1781b7aae9126a306ffc942683aa2
+SHA512:
+  metadata.gz: 0eef90653e7d511c3653668e08aa4728f2ea5a17225a7c60f31cad9c8059b340e00f1087cabf8e6343eea212a67fd8a7fe7cb5fc54268c0b8efd6c7511c2d7fe
+  data.tar.gz: e8e97d5647daee951fe742431deddfa785c0c490a0fa04d08f00dde7c25cf70497ddb6d2ece86a53eeda0c2bab17fc406f78bfb8c6ecd851d11e4ce2f0bac36a

data/.gitignore

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

data/.rspec

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

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,17 @@
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Piotr Murach
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,132 @@
+# 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]: 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
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tty-spinner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tty-spinner
+
+## 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)
+
+## 1. Usage
+
+**TTY::ProgressBar** by default uses `:spin_1` 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:
+
+```ruby
+spinner = TTY::Spinner.new('Loading ... ', format: :spin_2)
+30.times do
+  spinner.spin
+  sleep(0.1)
+end
+```
+
+This would product animation in your terminal:
+
+```ruby
+Loading ... ⎺
+```
+
+### 1.1 spin
+
+The main workhorse of the spinner is the `spin` method. Looping over `spin` method will animate a given spinner.
+
+### 1.2 stop
+
+In order to stop the spinner call `stop`. This will finish drawing the spinning and return to new line.
+
+```ruby
+spinner.stop
+```
+
+You can further pass a stop message to print in place of spinning animation:
+
+```ruby
+spinner.stop('Done!')
+```
+
+which would produce for the above example the following:
+
+```ruby
+Loading ... Done!
+```
+
+### 1.3 reset
+
+In order to reset the spinner to its initial frame do:
+
+```ruby
+spinner.reset
+```
+
+## 2. Configuration
+
+There are number of configuration options that can be provided:
+
+* `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. Formatting
+
+**TTY::Spinner** supports the following formatting for its spinners:
+
+| Type     | Animation   |
+| -------- | ----------- |
+| :spin_1  |             |
+| :spin_2  |             |
+| :spin_3  |             |
+| :spin_4  |             |
+| :spin_5  |             |
+| :spin_6  |             |
+| :spin_7  |             |
+| :spin_8  |             |
+| :spin_9  |             |
+| :spin_10 |             |
+
+## Contributing
+
+1. Fork it ( https://github.com/peter-murach/tty-spinner/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Copyright
+
+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/basic.rb

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

data/lib/tty-spinner.rb

@@ -0,0 +1 @@
+require 'tty/spinner'

data/lib/tty/spinner.rb

@@ -0,0 +1,134 @@
+# coding: utf-8
+
+require 'tty/spinner/version'
+require 'tty/spinner/formats'
+
+module TTY
+  # Used for creating terminal spinner
+  #
+  # @api public
+  class Spinner
+    include Formats
+    ECMA_ESC = "\x1b"
+    ECMA_CSI = "\x1b["
+    ECMA_CHA = 'G'
+
+    DEC_RST = 'l'
+    DEC_SET = 'h'
+    DEC_TCEM = '?25'
+
+    # The object that responds to print call defaulting to stderr
+    #
+    # @api public
+    attr_reader :output
+
+    # The current format type
+    #
+    # @return [String]
+    #
+    # @api public
+    attr_reader :format
+
+    # Whether to show or hide cursor
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    attr_reader :hide_cursor
+
+    # The message to print before the spinner
+    #
+    # @return [String]
+    #   the current message
+    #
+    # @api public
+    attr_reader :message
+
+    # Initialize a spinner
+    #
+    # @example
+    #   spinner = TTY::Spinner.new
+    #
+    # @param [String] message
+    #   the message to print in front of the spinner
+    #
+    # @param [Hash] options
+    # @option options [String] :format
+    #   the spinner format type defaulting to :spin_1
+    # @option options [Object] :output
+    #   the object that responds to print call defaulting to stderr
+    # @option options [Boolean] :hide_cursor
+    #   display or hide cursor
+    #
+    # @api public
+    def initialize(*args)
+      options  = args.last.is_a?(::Hash) ? args.pop : {}
+      @message = args.empty? ? '' : args.pop
+
+      @format      = options.fetch(:format) { :spin_1 }
+      @output      = options.fetch(:output) { $stderr }
+      @hide_cursor = options.fetch(:hide_cursor) { false }
+
+      @frames      = FORMATS[@format.to_sym]
+      @length      = @frames.length
+      @current     = 0
+      @done        = false
+      @spinning    = false
+    end
+
+    # Perform a spin
+    #
+    # @return [String]
+    #   the printed data
+    #
+    # @api public
+    def spin
+      return if @done
+
+      if @hide_cursor && !@spinning
+        write(ECMA_CSI + DEC_TCEM + DEC_RST)
+      end
+
+      data = message + @frames[@current]
+      write(data, true)
+      @current  = (@current + 1) % @length
+      @spinning = true
+      data
+    end
+
+    # Finish spining
+    #
+    # @param [String] stop_message
+    #   the stop message to print
+    #
+    # @api public
+    def stop(stop_message = '')
+      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)
+    end
+
+    # Reset the spinner to initial frame
+    #
+    # @api public
+    def reset
+      @current = 0
+    end
+
+    private
+
+    # Write data out to output
+    #
+    # @return [nil]
+    #
+    # @api private
+    def write(data, clear_first = false)
+      output.print(ECMA_CSI + '1' + ECMA_CHA) if clear_first
+      output.print(data)
+      output.flush
+    end
+  end # Spinner
+end # TTY

data/lib/tty/spinner/formats.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+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: '╫╪'
+    }
+  end # Formats
+end # TTY

data/lib/tty/spinner/version.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+module TTY
+  class Spinner
+    VERSION = "0.1.0"
+  end # Spinner
+end # TTY

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+# 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

@@ -0,0 +1,21 @@
+# 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

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,23 @@
+# 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

@@ -0,0 +1,46 @@
+# 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

@@ -0,0 +1,49 @@
+# 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

@@ -0,0 +1,10 @@
+# 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

@@ -0,0 +1,11 @@
+# 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

@@ -0,0 +1,29 @@
+# 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

@@ -0,0 +1,23 @@
+# 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

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: tty-spinner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-15 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A terminal spinner for tasks that have non-deterministic time frame.
+email:
+- pmurach@gmail.com
+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
+homepage: https://github.com/peter-murach/tty-spinner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+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
+has_rdoc: