RubyGems - whirly - Versions diffs - 0.2.2 → 0.3.0 - Mend

whirly 0.2.2 → 0.3.0

Files changed (17) hide show

checksums.yaml +5 -5
data/CHANGELOG.md +24 -0
data/Gemfile +2 -0
data/MIT-LICENSE.txt +1 -1
data/README.md +11 -11
data/Rakefile +1 -1
data/data/cli-spinners.json +592 -0
data/data/whirly-static-spinners.json +99 -0
data/examples/euruko.rb +1 -1
data/examples/single.rb +1 -1
data/lib/whirly.rb +15 -10
data/lib/whirly/spinners/whirly.rb +1 -5
data/lib/whirly/version.rb +3 -2
data/spec/whirly_spec.rb +132 -5
data/whirly.gemspec +3 -3
metadata +10 -9
data/.travis.yml +0 -26

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 27c78b557a26c8556df8bed870f97d256d9b13f9
-  data.tar.gz: 0740cc05c8e08ec9fd361dd97f84f3d7d5d0e875
+SHA256:
+  metadata.gz: 0d29fbecff7cd421276c1212e4f78775d153dbdaa911c9c0ab4455cc95f7af02
+  data.tar.gz: a390b99e94244688c8bc6a283b1f8e407d2031f03fec6be9f9e7bfd0727c0e83
 SHA512:
-  metadata.gz: 07acf32c1433564b728587786c9e3ef0610d3b4e740341de46b648d784a7a470b6cf764287760068d38af0861ec2bfd0f324e88ebf3905001d2f110cdda6c1d6
-  data.tar.gz: 5e69bb87239a176c16f83e16cf154ad984e2b6132256c721d027794154b1ce5feee7d7a77ebfbc23ceace195660044b5693db466ea3e2aee07924a54f4aa7297
+  metadata.gz: a5ad854b00b8d9b8e620cbe96b456fbaa98ec116233ca531e840f4204986f9397a32494e2aea1bf73057a97dc7541a6c0f868a6c901441cdf6e19a3602e2ff78
+  data.tar.gz: 85171c117d3f3d1d77b1fbfd9af2e864b6e2bd39d55d3673c63d8247e404c36d4f89a7de2acb4aabd250d7c247131f91833651d18c7f9b4ccabd1423b38ae11a

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,29 @@
 ## CHANGELOG
+### 0.3.0
+- Allow more recent versions of Ruby and unicode-display_width gem
+- Update CLI spinners to 2.6.0
+### 0.2.6
+- Update CLI spinners to 1.1.0 (adds "weather" and "christmas")
+### 0.2.5
+- Update CLI spinners to 1.0.1
+### 0.2.4
+- Fix bug that the Whirly thread will also stop when main thread throws error
+  (patch by @monkbroc)
+- New spinner: xberg
+### 0.2.3
+- Fix bug that in some cases whirly output would be shown on non-ttys
+- New spinners: card, cloud, photo, banknote, white_square
 ### 0.2.2
 - More emotions for whirly (the spinner)

data/Gemfile CHANGED Viewed

@@ -3,4 +3,6 @@ source 'https://rubygems.org'
 gemspec
 gem 'minitest'
+gem 'paint'
+gem 'rake'
 # gem 'irbtools-more', require: 'irbtools/binding'

data/MIT-LICENSE.txt CHANGED Viewed

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Jan Lelis, mail@janlelis.de
+Copyright (c) 2016 Jan Lelis, https://janlelis.com
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md CHANGED Viewed

@@ -1,6 +1,6 @@
-# Whirly 😀 [![[version]](https://badge.fury.io/rb/whirly.svg)](http://badge.fury.io/rb/whirly)  [![[travis]](https://travis-ci.org/janlelis/whirly.png)](https://travis-ci.org/janlelis/whirly)
+# Whirly 😀 [![[version]](https://badge.fury.io/rb/whirly.svg)](https://badge.fury.io/rb/whirly)  [<img src="https://github.com/janlelis/whirly/workflows/Test/badge.svg" />](https://github.com/janlelis/whirly/actions/workflows/test.yml)
-A simple, colorful and customizable terminal spinner library for Ruby. It comes with 18 custom spinners and also includes those from the [cli-spinners](https://github.com/sindresorhus/cli-spinners) project.
+A simple, colorful and customizable terminal spinner library for Ruby. It comes with 24 custom spinners and also includes those from the [cli-spinners](https://github.com/sindresorhus/cli-spinners) project.
 ## Demonstration
@@ -12,7 +12,7 @@ A simple, colorful and customizable terminal spinner library for Ruby. It comes
 ### Bundled Spinners from CLI Spinners
-![](https://raw.githubusercontent.com/sindresorhus/cli-spinners/master/screenshot.gif)
+![](https://raw.githubusercontent.com/sindresorhus/cli-spinners/main/screenshot.gif)
 [Play on asciinema](https://asciinema.org/a/9mlcoussb137m32swwuqtb2p1?size=big)
@@ -60,12 +60,12 @@ Whirly.stop
 The `start` method takes a lot of options, like which spinner to use or an initial status. See further below for the full description of available options.
 ```ruby
-Whirly.start spinner: "pong", use_color: false, status: "The Game of Pong" do
+Whirly.start spinner: "pong", color: false, status: "The Game of Pong" do
   sleep 10
 end
 ```
-Also see the [examples directory](https://github.com/janlelis/whirly/tree/master/examples) for example scripts.
+Also see the [examples directory](https://github.com/janlelis/whirly/tree/main/examples) for example scripts.
 ### Configuring Whirly
@@ -99,7 +99,7 @@ end
 ### Included Spinners
-See [`data/whirly-static-spinnes.json`](https://github.com/janlelis/whirly/blob/master/data/whirly-static-spinners.json), [`lib/whirly/spinners/whirly.rb`](https://github.com/janlelis/whirly/blob/master/lib/whirly/spinners/whirly.rb) and [cli-spinners](https://github.com/sindresorhus/cli-spinners). You can get a demonstration of all bundled spinners by running the [`examples/all_spinners.rb`](https://github.com/janlelis/whirly/blob/master/examples/all_spinners.rb) script.
+See [`data/whirly-static-spinnes.json`](https://github.com/janlelis/whirly/blob/main/data/whirly-static-spinners.json), [`lib/whirly/spinners/whirly.rb`](https://github.com/janlelis/whirly/blob/main/lib/whirly/spinners/whirly.rb) and [cli-spinners](https://github.com/sindresorhus/cli-spinners). You can get a demonstration of all bundled spinners by running the [`examples/all_spinners.rb`](https://github.com/janlelis/whirly/blob/main/examples/all_spinners.rb) script.
 ## All `Whirly.start` / `Whirly.configure` Configuration Options
@@ -212,7 +212,7 @@ Whirly comes with spinners from different sources. This options defines which so
 *Default:* `$stdout`
-You can pass in an [IO](https://ruby-doc.org/core-2.3.1/IO.html)-like object, if you want to display *Whirly* on an other stream than `$stdout`.
+You can pass in an [IO](https://ruby-doc.org/core/IO.html)-like object, if you want to display *Whirly* on an other stream than `$stdout`.
 ## Full Spinner Hash Format
@@ -220,7 +220,7 @@ A full spinner is defined by a hash which can have the following key-value pairs
 ### `"frames"`
-An [Array](https://ruby-doc.org/core-2.3.1/Array.html) or [Enumerable](https://ruby-doc.org/core-2.3.1/Enumerable.html) of strings that will be used as the spinner icon.
+An [Array](https://ruby-doc.org/core/Array.html) or [Enumerable](https://ruby-doc.org/core/Enumerable.html) of strings that will be used as the spinner icon.
 ### `"proc"`
@@ -239,7 +239,7 @@ The order in which frames should be played. It can be one of the following:
 - `"swing"`: Cycle through all frames in normal order, and then in reverse order, but only play first and last frame once each round
 - `"random"`: Play random frames
-Please note: While `"linear"` also works with frames that are just an [Enumerable](https://ruby-doc.org/core-2.3.1/Enumerable.html), all other frame modes require the object to be representable as an [Array](https://ruby-doc.org/core-2.3.1/Array.html).
+Please note: While `"linear"` also works with frames that are just an [Enumerable](https://ruby-doc.org/core/Enumerable.html), all other frame modes require the object to be representable as an [Array](https://ruby-doc.org/core/Array.html).
 ### `"stop"`
@@ -250,9 +250,9 @@ A frame to be used to end the spinner icon animation.
 - Interval is milliseconds, but don't rely on exact timing
 - Will not do anything if stream is not a real console (or `non_tty: true` is passed)
 - Colors not working? Be sure to include the [paint](https://github.com/janlelis/paint/) gem in your Gemfile
-- Don't set very short intervals (or it might affect performance substantly)
+- Don't set very short intervals (or it might affect performance substantially)
 ## MIT License
-- Copyright (C) 2016 Jan Lelis <http://janlelis.com>. Released under the MIT license.
+- Copyright (C) 2016 Jan Lelis <https://janlelis.com>. Released under the MIT license.
 - Contains data from cli-spinners:  MIT License, Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)

data/Rakefile CHANGED Viewed

@@ -35,7 +35,7 @@ end
 desc "#{gemspec.name} | Spec"
 task :spec do
-  sh "for file in spec/*.rb; do ruby $file; done"
+  ruby "spec/whirly_spec.rb"
 end
 task default: :spec

data/data/cli-spinners.json CHANGED Viewed

@@ -274,6 +274,267 @@
 			"⠀⡀"
 		]
 	},
+	"dots8Bit": {
+		"interval": 80,
+		"frames": [
+			"⠀",
+			"⠁",
+			"⠂",
+			"⠃",
+			"⠄",
+			"⠅",
+			"⠆",
+			"⠇",
+			"⡀",
+			"⡁",
+			"⡂",
+			"⡃",
+			"⡄",
+			"⡅",
+			"⡆",
+			"⡇",
+			"⠈",
+			"⠉",
+			"⠊",
+			"⠋",
+			"⠌",
+			"⠍",
+			"⠎",
+			"⠏",
+			"⡈",
+			"⡉",
+			"⡊",
+			"⡋",
+			"⡌",
+			"⡍",
+			"⡎",
+			"⡏",
+			"⠐",
+			"⠑",
+			"⠒",
+			"⠓",
+			"⠔",
+			"⠕",
+			"⠖",
+			"⠗",
+			"⡐",
+			"⡑",
+			"⡒",
+			"⡓",
+			"⡔",
+			"⡕",
+			"⡖",
+			"⡗",
+			"⠘",
+			"⠙",
+			"⠚",
+			"⠛",
+			"⠜",
+			"⠝",
+			"⠞",
+			"⠟",
+			"⡘",
+			"⡙",
+			"⡚",
+			"⡛",
+			"⡜",
+			"⡝",
+			"⡞",
+			"⡟",
+			"⠠",
+			"⠡",
+			"⠢",
+			"⠣",
+			"⠤",
+			"⠥",
+			"⠦",
+			"⠧",
+			"⡠",
+			"⡡",
+			"⡢",
+			"⡣",
+			"⡤",
+			"⡥",
+			"⡦",
+			"⡧",
+			"⠨",
+			"⠩",
+			"⠪",
+			"⠫",
+			"⠬",
+			"⠭",
+			"⠮",
+			"⠯",
+			"⡨",
+			"⡩",
+			"⡪",
+			"⡫",
+			"⡬",
+			"⡭",
+			"⡮",
+			"⡯",
+			"⠰",
+			"⠱",
+			"⠲",
+			"⠳",
+			"⠴",
+			"⠵",
+			"⠶",
+			"⠷",
+			"⡰",
+			"⡱",
+			"⡲",
+			"⡳",
+			"⡴",
+			"⡵",
+			"⡶",
+			"⡷",
+			"⠸",
+			"⠹",
+			"⠺",
+			"⠻",
+			"⠼",
+			"⠽",
+			"⠾",
+			"⠿",
+			"⡸",
+			"⡹",
+			"⡺",
+			"⡻",
+			"⡼",
+			"⡽",
+			"⡾",
+			"⡿",
+			"⢀",
+			"⢁",
+			"⢂",
+			"⢃",
+			"⢄",
+			"⢅",
+			"⢆",
+			"⢇",
+			"⣀",
+			"⣁",
+			"⣂",
+			"⣃",
+			"⣄",
+			"⣅",
+			"⣆",
+			"⣇",
+			"⢈",
+			"⢉",
+			"⢊",
+			"⢋",
+			"⢌",
+			"⢍",
+			"⢎",
+			"⢏",
+			"⣈",
+			"⣉",
+			"⣊",
+			"⣋",
+			"⣌",
+			"⣍",
+			"⣎",
+			"⣏",
+			"⢐",
+			"⢑",
+			"⢒",
+			"⢓",
+			"⢔",
+			"⢕",
+			"⢖",
+			"⢗",
+			"⣐",
+			"⣑",
+			"⣒",
+			"⣓",
+			"⣔",
+			"⣕",
+			"⣖",
+			"⣗",
+			"⢘",
+			"⢙",
+			"⢚",
+			"⢛",
+			"⢜",
+			"⢝",
+			"⢞",
+			"⢟",
+			"⣘",
+			"⣙",
+			"⣚",
+			"⣛",
+			"⣜",
+			"⣝",
+			"⣞",
+			"⣟",
+			"⢠",
+			"⢡",
+			"⢢",
+			"⢣",
+			"⢤",
+			"⢥",
+			"⢦",
+			"⢧",
+			"⣠",
+			"⣡",
+			"⣢",
+			"⣣",
+			"⣤",
+			"⣥",
+			"⣦",
+			"⣧",
+			"⢨",
+			"⢩",
+			"⢪",
+			"⢫",
+			"⢬",
+			"⢭",
+			"⢮",
+			"⢯",
+			"⣨",
+			"⣩",
+			"⣪",
+			"⣫",
+			"⣬",
+			"⣭",
+			"⣮",
+			"⣯",
+			"⢰",
+			"⢱",
+			"⢲",
+			"⢳",
+			"⢴",
+			"⢵",
+			"⢶",
+			"⢷",
+			"⣰",
+			"⣱",
+			"⣲",
+			"⣳",
+			"⣴",
+			"⣵",
+			"⣶",
+			"⣷",
+			"⢸",
+			"⢹",
+			"⢺",
+			"⢻",
+			"⢼",
+			"⢽",
+			"⢾",
+			"⢿",
+			"⣸",
+			"⣹",
+			"⣺",
+			"⣻",
+			"⣼",
+			"⣽",
+			"⣾",
+			"⣿"
+		]
+	},
 	"line": {
 		"interval": 130,
 		"frames": [
@@ -659,6 +920,13 @@
 	"bouncingBar": {
 		"interval": 80,
 		"frames": [
+			"[    ]",
+			"[=   ]",
+			"[==  ]",
+			"[=== ]",
+			"[ ===]",
+			"[  ==]",
+			"[   =]",
 			"[    ]",
 			"[   =]",
 			"[  ==]",
@@ -713,6 +981,7 @@
 	"clock": {
 		"interval": 100,
 		"frames": [
+			"🕛 ",
 			"🕐 ",
 			"🕑 ",
 			"🕒 ",
@@ -734,6 +1003,103 @@
 			"🌏 "
 		]
 	},
+	"material": {
+		"interval": 17,
+		"frames": [
+			"█▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁",
+			"██▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁",
+			"███▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁",
+			"████▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁",
+			"██████▁▁▁▁▁▁▁▁▁▁▁▁▁▁",
+			"██████▁▁▁▁▁▁▁▁▁▁▁▁▁▁",
+			"███████▁▁▁▁▁▁▁▁▁▁▁▁▁",
+			"████████▁▁▁▁▁▁▁▁▁▁▁▁",
+			"█████████▁▁▁▁▁▁▁▁▁▁▁",
+			"█████████▁▁▁▁▁▁▁▁▁▁▁",
+			"██████████▁▁▁▁▁▁▁▁▁▁",
+			"███████████▁▁▁▁▁▁▁▁▁",
+			"█████████████▁▁▁▁▁▁▁",
+			"██████████████▁▁▁▁▁▁",
+			"██████████████▁▁▁▁▁▁",
+			"▁██████████████▁▁▁▁▁",
+			"▁██████████████▁▁▁▁▁",
+			"▁██████████████▁▁▁▁▁",
+			"▁▁██████████████▁▁▁▁",
+			"▁▁▁██████████████▁▁▁",
+			"▁▁▁▁█████████████▁▁▁",
+			"▁▁▁▁██████████████▁▁",
+			"▁▁▁▁██████████████▁▁",
+			"▁▁▁▁▁██████████████▁",
+			"▁▁▁▁▁██████████████▁",
+			"▁▁▁▁▁██████████████▁",
+			"▁▁▁▁▁▁██████████████",
+			"▁▁▁▁▁▁██████████████",
+			"▁▁▁▁▁▁▁█████████████",
+			"▁▁▁▁▁▁▁█████████████",
+			"▁▁▁▁▁▁▁▁████████████",
+			"▁▁▁▁▁▁▁▁████████████",
+			"▁▁▁▁▁▁▁▁▁███████████",
+			"▁▁▁▁▁▁▁▁▁███████████",
+			"▁▁▁▁▁▁▁▁▁▁██████████",
+			"▁▁▁▁▁▁▁▁▁▁██████████",
+			"▁▁▁▁▁▁▁▁▁▁▁▁████████",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁███████",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁██████",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█████",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█████",
+			"█▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁████",
+			"██▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁███",
+			"██▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁███",
+			"███▁▁▁▁▁▁▁▁▁▁▁▁▁▁███",
+			"████▁▁▁▁▁▁▁▁▁▁▁▁▁▁██",
+			"█████▁▁▁▁▁▁▁▁▁▁▁▁▁▁█",
+			"█████▁▁▁▁▁▁▁▁▁▁▁▁▁▁█",
+			"██████▁▁▁▁▁▁▁▁▁▁▁▁▁█",
+			"████████▁▁▁▁▁▁▁▁▁▁▁▁",
+			"█████████▁▁▁▁▁▁▁▁▁▁▁",
+			"█████████▁▁▁▁▁▁▁▁▁▁▁",
+			"█████████▁▁▁▁▁▁▁▁▁▁▁",
+			"█████████▁▁▁▁▁▁▁▁▁▁▁",
+			"███████████▁▁▁▁▁▁▁▁▁",
+			"████████████▁▁▁▁▁▁▁▁",
+			"████████████▁▁▁▁▁▁▁▁",
+			"██████████████▁▁▁▁▁▁",
+			"██████████████▁▁▁▁▁▁",
+			"▁██████████████▁▁▁▁▁",
+			"▁██████████████▁▁▁▁▁",
+			"▁▁▁█████████████▁▁▁▁",
+			"▁▁▁▁▁████████████▁▁▁",
+			"▁▁▁▁▁████████████▁▁▁",
+			"▁▁▁▁▁▁███████████▁▁▁",
+			"▁▁▁▁▁▁▁▁█████████▁▁▁",
+			"▁▁▁▁▁▁▁▁█████████▁▁▁",
+			"▁▁▁▁▁▁▁▁▁█████████▁▁",
+			"▁▁▁▁▁▁▁▁▁█████████▁▁",
+			"▁▁▁▁▁▁▁▁▁▁█████████▁",
+			"▁▁▁▁▁▁▁▁▁▁▁████████▁",
+			"▁▁▁▁▁▁▁▁▁▁▁████████▁",
+			"▁▁▁▁▁▁▁▁▁▁▁▁███████▁",
+			"▁▁▁▁▁▁▁▁▁▁▁▁███████▁",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁███████",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁███████",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█████",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁████",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁████",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁████",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁███",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁███",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁██",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁██",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁██",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁",
+			"▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁"
+		]
+	},
 	"moon": {
 		"interval": 80,
 		"frames": [
@@ -819,5 +1185,231 @@
 			"▐_/|___________▌",
 			"▐/|____________▌"
 		]
+	},
+	"dqpb": {
+		"interval": 100,
+		"frames": [
+			"d",
+			"q",
+			"p",
+			"b"
+		]
+	},
+	"weather": {
+		"interval": 100,
+		"frames": [
+			"☀️ ",
+			"☀️ ",
+			"☀️ ",
+			"🌤 ",
+			"⛅️ ",
+			"🌥 ",
+			"☁️ ",
+			"🌧 ",
+			"🌨 ",
+			"🌧 ",
+			"🌨 ",
+			"🌧 ",
+			"🌨 ",
+			"⛈ ",
+			"🌨 ",
+			"🌧 ",
+			"🌨 ",
+			"☁️ ",
+			"🌥 ",
+			"⛅️ ",
+			"🌤 ",
+			"☀️ ",
+			"☀️ "
+		]
+	},
+	"christmas": {
+		"interval": 400,
+		"frames": [
+			"🌲",
+			"🎄"
+		]
+	},
+	"grenade": {
+		"interval": 80,
+		"frames": [
+			"،  ",
+			"′  ",
+			" ´ ",
+			" ‾ ",
+			"  ⸌",
+			"  ⸊",
+			"  |",
+			"  ⁎",
+			"  ⁕",
+			" ෴ ",
+			"  ⁓",
+			"   ",
+			"   ",
+			"   "
+		]
+	},
+	"point": {
+		"interval": 125,
+		"frames": [
+			"∙∙∙",
+			"●∙∙",
+			"∙●∙",
+			"∙∙●",
+			"∙∙∙"
+		]
+	},
+	"layer": {
+		"interval": 150,
+		"frames": [
+			"-",
+			"=",
+			"≡"
+		]
+	},
+	"betaWave": {
+		"interval": 80,
+		"frames": [
+			"ρββββββ",
+			"βρβββββ",
+			"ββρββββ",
+			"βββρβββ",
+			"ββββρββ",
+			"βββββρβ",
+			"ββββββρ"
+		]
+	},
+	"fingerDance": {
+		"interval": 160,
+		"frames": [
+			"🤘 ",
+			"🤟 ",
+			"🖖 ",
+			"✋ ",
+			"🤚 ",
+			"👆 "
+		]
+	},
+	"fistBump": {
+		"interval": 80,
+		"frames": [
+			"🤜\u3000\u3000\u3000\u3000🤛 ",
+			"🤜\u3000\u3000\u3000\u3000🤛 ",
+			"🤜\u3000\u3000\u3000\u3000🤛 ",
+			"\u3000🤜\u3000\u3000🤛\u3000 ",
+			"\u3000\u3000🤜🤛\u3000\u3000 ",
+			"\u3000🤜✨🤛\u3000\u3000 ",
+			"🤜\u3000✨\u3000🤛\u3000 "
+		]
+	},
+	"soccerHeader": {
+		"interval": 80,
+		"frames": [
+			" 🧑⚽️       🧑 ",
+			"🧑  ⚽️      🧑 ",
+			"🧑   ⚽️     🧑 ",
+			"🧑    ⚽️    🧑 ",
+			"🧑     ⚽️   🧑 ",
+			"🧑      ⚽️  🧑 ",
+			"🧑       ⚽️🧑  ",
+			"🧑      ⚽️  🧑 ",
+			"🧑     ⚽️   🧑 ",
+			"🧑    ⚽️    🧑 ",
+			"🧑   ⚽️     🧑 ",
+			"🧑  ⚽️      🧑 "
+		]
+	},
+	"mindblown": {
+		"interval": 160,
+		"frames": [
+			"😐 ",
+			"😐 ",
+			"😮 ",
+			"😮 ",
+			"😦 ",
+			"😦 ",
+			"😧 ",
+			"😧 ",
+			"🤯 ",
+			"💥 ",
+			"✨ ",
+			"\u3000 ",
+			"\u3000 ",
+			"\u3000 "
+		]
+	},
+	"speaker": {
+		"interval": 160,
+		"frames": [
+			"🔈 ",
+			"🔉 ",
+			"🔊 ",
+			"🔉 "
+		]
+	},
+	"orangePulse": {
+		"interval": 100,
+		"frames": [
+			"🔸 ",
+			"🔶 ",
+			"🟠 ",
+			"🟠 ",
+			"🔶 "
+		]
+	},
+	"bluePulse": {
+		"interval": 100,
+		"frames": [
+			"🔹 ",
+			"🔷 ",
+			"🔵 ",
+			"🔵 ",
+			"🔷 "
+		]
+	},
+	"orangeBluePulse": {
+		"interval": 100,
+		"frames": [
+			"🔸 ",
+			"🔶 ",
+			"🟠 ",
+			"🟠 ",
+			"🔶 ",
+			"🔹 ",
+			"🔷 ",
+			"🔵 ",
+			"🔵 ",
+			"🔷 "
+		]
+	},
+	"timeTravel": {
+		"interval": 100,
+		"frames": [
+			"🕛 ",
+			"🕚 ",
+			"🕙 ",
+			"🕘 ",
+			"🕗 ",
+			"🕖 ",
+			"🕕 ",
+			"🕔 ",
+			"🕓 ",
+			"🕒 ",
+			"🕑 ",
+			"🕐 "
+		]
+	},
+	"aesthetic": {
+		"interval": 80,
+		"frames": [
+			"▰▱▱▱▱▱▱",
+			"▰▰▱▱▱▱▱",
+			"▰▰▰▱▱▱▱",
+			"▰▰▰▰▱▱▱",
+			"▰▰▰▰▰▱▱",
+			"▰▰▰▰▰▰▱",
+			"▰▰▰▰▰▰▰",
+			"▰▱▱▱▱▱▱"
+		]
 	}
 }

data/data/whirly-static-spinners.json CHANGED Viewed

@@ -171,5 +171,104 @@
       "😿",
       "🙀"
     ]
+  },
+  "card": {
+    "interval": 90,
+    "stop": "🂠",
+    "frames": [
+      "🃁", "🃂", "🃃", "🃄", "🃅", "🃆", "🃇", "🃈", "🃉", "🃊", "🃋", "🃌", "🃍", "🃎",
+      "🂱", "🂲", "🂳", "🂴", "🂵", "🂶", "🂷", "🂸", "🂹", "🂺", "🂻", "🂼", "🂽", "🂾",
+      "🂡", "🂢", "🂣", "🂤", "🂥", "🂦", "🂧", "🂨", "🂩", "🂪", "🂫", "🂬", "🂭", "🂮",
+      "🃑", "🃒", "🃓", "🃔", "🃕", "🃖", "🃗", "🃘", "🃙", "🃚", "🃛", "🃜", "🃝", "🃞"
+    ]
+  },
+  "cloud": {
+    "interval": 140,
+    "frames": [
+      "🌥",
+      "🌦",
+      "🌧",
+      "🌨",
+      "🌩",
+      "🌪"
+    ]
+  },
+  "photo": {
+    "interval": 200,
+    "frames": [
+      "📷",
+      "📸"
+    ]
+  },
+  "banknote": {
+    "interval": 100,
+    "frames": [
+      "💴",
+      "💵",
+      "💶",
+      "💷"
+    ]
+  },
+  "white_square": {
+    "interval": 100,
+    "mode": "swing",
+    "frames": [
+      "🞓",
+      "🞒",
+      "🞑",
+      "🞐",
+      "🞏",
+      "🞎",
+      "🞔"
+    ]
+  },
+  "xberg": {
+    "interval": 150,
+    "mode": "random",
+    "frames": [
+      "⨯",
+      "⛰",
+      "⛰",
+      "⛰",
+      "⛰",
+      "⛰",
+      "⛰"
+    ]
+  },
+  "circled_letter": {
+    "interval": 120,
+    "mode": "random",
+    "frames": [
+      "Ⓐ", "Ⓑ", "Ⓒ", "Ⓓ", "Ⓔ", "Ⓕ", "Ⓖ", "Ⓗ", "Ⓘ",
+      "Ⓙ", "Ⓚ", "Ⓛ", "Ⓜ", "Ⓝ", "Ⓞ", "Ⓟ", "Ⓠ", "Ⓡ",
+      "Ⓢ", "Ⓣ", "Ⓤ", "Ⓥ", "Ⓦ", "Ⓧ", "Ⓨ", "Ⓩ"
+    ]
+  },
+  "circled_number": {
+    "interval": 120,
+    "mode": "random",
+    "frames": [
+      "①", "②", "③", "④", "⑤", "⑥", "⑦", "⑧", "⑨"
+    ]
+  },
+  "letter_with_parens": {
+    "interval": 150,
+    "mode": "random",
+    "frames": [
+      "🄐", "🄑", "🄒", "🄓", "🄔", "🄕", "🄖", "🄗", "🄘",
+      "🄙", "🄚", "🄛", "🄜", "🄝", "🄞", "🄟", "🄠", "🄡",
+      "🄢", "🄣", "🄤", "🄥", "🄦", "🄧", "🄨", "🄩"
+    ]
+  },
+  "starlike": {
+    "interval": 120,
+    "mode": "random",
+    "frames": [
+      "✩", "✪", "✫", "✬", "✭", "✮", "✯", "✰",
+      "✱", "✲", "✳", "✴", "✵", "✶", "✷", "✸",
+      "✹", "✺", "✻", "✼", "✽", "✾", "✿", "❀",
+      "❁", "❂", "❃", "❄", "❅", "❆", "❇", "❈",
+      "❉", "❊"
+    ]
   }
 }

data/examples/euruko.rb CHANGED Viewed

@@ -45,7 +45,7 @@ sleep 5
 print "\033c"
 puts Paint["Pong", :underline]
-Whirly.start spinner: "pong", use_color: false, status: "Two computers in a game of Pong" do
+Whirly.start spinner: "pong", color: false, status: "Two computers in a game of Pong" do
   sleep 9
 end

data/examples/single.rb CHANGED Viewed

@@ -3,4 +3,4 @@ require "paint"
 # Call a single spinner from the command-line
-Whirly.start(spinner: $*[0], status: $*[2] || $*[0], use_color: false){ sleep(($*[1] || 10).to_i) }
+Whirly.start(spinner: $*[0], status: $*[2] || $*[0], color: false){ sleep(($*[1] || 10).to_i) }

data/lib/whirly.rb CHANGED Viewed

@@ -133,13 +133,6 @@ module Whirly
     # optionally overwrite configuration on start
     configure(**options)
-    # ensure cursor is visible after exit the program (only register for the very first time)
-    if (!defined?(@at_exit_handler_registered) || !@at_exit_handler_registered) && @options[:hide_cursor]
-      @at_exit_handler_registered = true
-      stream = @options[:stream]
-      at_exit{ stream.print CLI_COMMANDS[:show_cursor] }
-    end
     # only enable once
     return false if defined?(@enabled) && @enabled
@@ -149,6 +142,13 @@ module Whirly
     # only do something if we are on a real terminal (or forced)
     return false unless @options[:stream].tty? || @options[:non_tty]
+    # ensure cursor is visible after exit the program (only register for the very first time)
+    if (!defined?(@at_exit_handler_registered) || !@at_exit_handler_registered) && @options[:hide_cursor]
+      @at_exit_handler_registered = true
+      stream = @options[:stream]
+      at_exit{ stream.print CLI_COMMANDS[:show_cursor] }
+    end
     # init color
     initialize_color if @options[:color]
@@ -167,8 +167,11 @@ module Whirly
     # idiomatic block syntax support
     if block_given?
-      yield
-      Whirly.stop
+      begin
+        yield
+      ensure
+        Whirly.stop
+      end
     end
     true
@@ -176,12 +179,14 @@ module Whirly
   def self.stop(stop_frame = nil)
     return false unless @enabled
+    @enabled = false
+    return false unless @options[:stream].tty? || @options[:non_tty]
     @thread.terminate if @thread
     render(stop_frame || @stop) if stop_frame || @stop
     unrender if @options[:remove_after_stop]
     @options[:stream].puts if @options[:append_newline]
     @options[:stream].print CLI_COMMANDS[:show_cursor] if @options[:hide_cursor]
-    @enabled = false
     true
   end

data/lib/whirly/spinners/whirly.rb CHANGED Viewed

@@ -4,13 +4,9 @@ module Whirly
   module Spinners
     WHIRLY = {
       "random_dots"         => { "proc" => ->(){ [ 0x2800 + rand(256)].pack("U") }, "interval" => 100 },
-      "circled_letter"      => { "proc" => ->(){ [ 0x24B6 + rand(26) ].pack("U") }, "interval" => 120 },
-      "circled_number"      => { "proc" => ->(){ [ 0x2460 + rand(9)  ].pack("U") }, "interval" => 120 },
-      "starlike"            => { "proc" => ->(){ [ 0x2729 + rand(34) ].pack("U") }, "interval" => 120 },
       "mahjong"             => { "proc" => ->(){ [0x1F000 + rand(44)].pack("U") }, "interval" => 200 },
       "domino"              => { "proc" => ->(){ [0x1F030 + rand(50)].pack("U") }, "interval" => 200 },
-      "vertical_domino"     => { "proc" => ->(){ [0x1F062 + rand(50)].pack("U") }, "interval" => 200 },
-      "letters_with_parens" => { "proc" => ->(){ [0x1F110 + rand(26)].pack("U") }, "interval" => 150 },
+      "vertical_domino"     => { "proc" => ->(){ [0x1F062 + rand(50)].pack("U") }, "interval" => 200 }
     }
     WHIRLY.merge! JSON.load(File.read(File.dirname(__FILE__) + "/../../../data/whirly-static-spinners.json"))

data/lib/whirly/version.rb CHANGED Viewed

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module Whirly
-  VERSION = "0.2.2".freeze
+  VERSION = "0.3.0"
 end

data/spec/whirly_spec.rb CHANGED Viewed

@@ -1,14 +1,15 @@
 require_relative "../lib/whirly"
 require "minitest/autorun"
+require "paint"
 # require "irbtools/binding"
 require "stringio"
 def short_sleep
-  sleep 0.15
+  sleep 0.4
 end
 def medium_sleep
-  sleep 0.5
+  sleep 0.7
 end
 def long_sleep
@@ -169,10 +170,10 @@ describe Whirly do
         spinner = { "frames" => "A".."H", "mode" => "random", "interval" => 10 }
         Whirly.start(spinner: spinner)
-        medium_sleep
+        short_sleep
         Whirly.stop
-        refute /A.*B.*C.*D.*E.*F.*G.*H/m =~ @capture.string
+        refute /\A.*?A.*?B.*?C.*?D.*?E.*?F.*?G.*?H/m =~ @capture.string
       end
       it "can be set to reverse" do
@@ -195,6 +196,91 @@ describe Whirly do
         assert_match /A.*B.*C.*D.*E.*F.*G.*H.*G.*F.*E.*D.*C.*B.*A/m, @capture.string
       end
     end
+    describe "Interval" do
+      it "spins more often when interval is lower" do
+        capture1 = StringIO.new
+        Whirly.start(stream: capture1, interval: 100)
+        long_sleep
+        Whirly.stop
+        capture2 = StringIO.new
+        Whirly.start(stream: capture2, interval: 50)
+        long_sleep
+        Whirly.stop
+        assert capture1.string.size < capture2.string.size
+      end
+    end
+  end
+  describe "Colors" do
+    it "will use no color when :color option is falsey" do
+      Whirly.start(color: false)
+      short_sleep
+      Whirly.stop
+      refute /\[38;/ =~ @capture.string
+    end
+    it "will use color when :color option is truthy" do
+      Whirly.start(color: true)
+      short_sleep
+      Whirly.stop
+      assert /\[38;/ =~ @capture.string
+    end
+    it "defaults :color to true when the paint gem is available" do
+      Whirly.reset
+      Whirly.configure
+      assert Whirly.options[:color]
+    end
+    # it "defaults :color to true when the paint gem is not available" do
+    #   remember_paint = Paint
+    #   Object.send(:remove_const, :Paint)
+    #   Whirly.reset
+    #   Whirly.configure
+    #   Object.send(:const_set, :Paint, remember_paint)
+    #   refute Whirly.options[:color]
+    # end
+    it "changes the the color" do
+      Whirly.start
+      long_sleep
+      Whirly.stop
+      colors = @capture.string.scan(/\[38;.*?m/).flatten
+      assert colors.uniq.size > 1
+    end
+  end
+  describe "Cursor" do
+    it "hides (and later shows) cursor when :hide_cursor => true option is given (default)" do
+      Whirly.start(hide_cursor: true)
+      short_sleep
+      Whirly.stop
+      assert_match /\[?25l.*\[?25h/m, @capture.string
+    end
+    it "does not hide cursor when :hide_cursor => false option is given" do
+      Whirly.start(hide_cursor: false)
+      short_sleep
+      Whirly.stop
+      refute /\[?25l.*\[?25h/m =~ @capture.string
+    end
+  end
+  describe "Spinner Packs" do
+    it "can be passed an alternative set of :spinner_packs" do
+      assert_raises ArgumentError do
+        Whirly.start(spinner_packs: [:cli], spinner: "cat") # whirly is part of :whirly, but not of :cli
+        Whirly.stop
+      end
+    end
   end
   describe "Ansi Escape Mode" do
@@ -213,6 +299,34 @@ describe Whirly do
     end
   end
+  describe "Streams and TTYs" do
+    it "will not output anything on non-ttys" do
+      Whirly.reset
+      @capture = StringIO.new
+      Whirly.start(stream: @capture)
+      short_sleep
+      Whirly.stop
+      assert_equal "", @capture.string
+    end
+    it "will output something on non-ttys when :non_tty => true option is given" do
+      Whirly.reset
+      @capture = StringIO.new
+      Whirly.start(stream: @capture, non_tty: true)
+      short_sleep
+      Whirly.stop
+      refute_equal "", @capture.string
+    end
+    it "can be configured to which stream whirly's output goes" do
+      iolike = StringIO.new
+      Whirly.start(stream: iolike, non_tty: true)
+      short_sleep
+      Whirly.stop
+      refute_equal "", iolike.string
+    end
+  end
   describe "Positioning" do
     it "will render spinner 1 line further below (useful for spinning while git cloning)" do
       Whirly.start(position: "below")
@@ -262,5 +376,18 @@ describe Whirly do
       refute_predicate Whirly, :enabled?
     end
   end
-end
+  describe "Error Handling" do
+    it "stops the spinner, when the main thread threw an exception [gh#3]" do
+      begin
+        Whirly.start status: "working" do
+          short_sleep
+          raise 'error!'
+        end
+      rescue
+      end
+      refute_predicate Whirly, :enabled?
+    end
+  end
+end

data/whirly.gemspec CHANGED Viewed

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.summary       = "Whirly: The friendly terminal spinner"
   gem.description   = "Simple terminal spinner with support for custom spinners. Includes spinners from npm's cli-spinners."
   gem.authors       = ["Jan Lelis"]
-  gem.email         = ["mail@janlelis.de"]
+  gem.email         = ["hi@ruby.consulting"]
   gem.homepage      = "https://github.com/janlelis/whirly"
   gem.license       = "MIT"
@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.add_dependency "unicode-display_width", "~> 1.1"
+  gem.add_dependency "unicode-display_width", ">= 1.1"
-  gem.required_ruby_version = "~> 2.0"
+  gem.required_ruby_version = ">= 2.0", "< 4.0"
 end

metadata CHANGED Viewed

@@ -1,40 +1,39 @@
 --- !ruby/object:Gem::Specification
 name: whirly
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Jan Lelis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-10-06 00:00:00.000000000 Z
+date: 2021-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
 description: Simple terminal spinner with support for custom spinners. Includes spinners
   from npm's cli-spinners.
 email:
-- mail@janlelis.de
+- hi@ruby.consulting
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitmodules"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -68,17 +67,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: 'Whirly: The friendly terminal spinner'

data/.travis.yml DELETED Viewed

@@ -1,26 +0,0 @@
-sudo: false
-language: ruby
-script: bundle exec ruby spec/whirly_spec.rb
-rvm:
-- 2.3.0
-- 2.2
-- 2.1
-- 2.0
-- ruby-head
-- rbx-2
-- jruby-head
-- jruby-9000
-cache:
-- bundler
-# matrix:
-#   fast_finish: true
-matrix:
-  allow_failures:
-    - rvm: jruby-head
-    - rvm: jruby-9000
-    - rvm: rbx-2