https://github.com/eendroroy/spin_r

shell spinner
https://github.com/eendroroy/spin_r

rubygem spinner

Last synced: 2 months ago
JSON representation

shell spinner

• Host: GitHub
• URL: https://github.com/eendroroy/spin_r
• Owner: eendroroy
• License: mit
• Created: 2017-10-05T03:56:56.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-10-28T12:57:14.000Z (over 8 years ago)
• Last Synced: 2025-01-26T19:21:50.357Z (over 1 year ago)
• Topics: rubygem, spinner
• Language: Ruby
• Homepage:
• Size: 50.8 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# SpinR

[![GitHub tag](https://img.shields.io/github/tag/eendroroy/spin_r.svg)](https://github.com/eendroroy/spin_r)

[![Gem Version](https://badge.fury.io/rb/spin_r.svg)](https://rubygems.org/gems/spin_r)

[![Downloads](https://img.shields.io/gem/dt/spin_r.svg)](https://rubygems.org/gems/spin_r)

[![Contributors](https://img.shields.io/github/contributors/eendroroy/spin_r.svg)](CONTRIBUTORS.md)

Show any time consuming process's output with a spinner.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'spin_r'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install spin_r

## Usage

```ruby

SpinR.spin do

  sleep 4

  puts 'You spin my head right round!'

end

```

Define spinner style:

```ruby

SpinR.spin SpinR::Spinners::TRIANGLE do

  sleep 4

  puts 'You spin my head right round!'

end

```

Available spinners:

- SpinR::Spinners::TRADITIONAL

- SpinR::Spinners::BLOCK

- SpinR::Spinners::DOTTED_1

- SpinR::Spinners::DOTTED_2

- SpinR::Spinners::DOTTED_3

- SpinR::Spinners::DOTTED_4

- SpinR::Spinners::WORLD

- SpinR::Spinners::TRIANGLE

- SpinR::Spinners::EMOJI

## asciicast

**v1.0.2**

[![asciicast](http://asciinema.org/a/144694.png)](https://asciinema.org/a/144694)

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/eendroroy/spin_r. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the SpinR project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/eendroroy/spin_r/blob/master/CODE_OF_CONDUCT.md).