whirly 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f12112b921f3f00166d7acf85d4d86cac8836005
-  data.tar.gz: ec7da03c93842811b381ca1fdfbe0df418ff05e1
+  metadata.gz: 49d0b7549d709f596eb1371e60ca6955f27f40ae
+  data.tar.gz: cedb70f10956ebb3197642ba3470435c4e9f7cf1
 SHA512:
-  metadata.gz: eccb4074399d77acf9e4454fddc27b894d08506095285f4004271d116fa03e6450d2fe2cdd3a1ff6ca8a445b634a6e6ab32a379d8cb2c4b9edc0756cb2ae2a10
-  data.tar.gz: 5a1e9ae823be1884e8e1f0e6783a63b2b540dbfe17d8e74c8cd6634949b69fa6df41d4cb0724fb47760b2fd45984d44c5729b5b8ef70174e264652d0cfce1d00
+  metadata.gz: 17b9d7c49c44f18471b72d4af58a5eea30da8a7b3a7a03b9ea38abed6324a09d8ec5a2238e9a9908f43c08c799fa93cc2f596f5762b11709d5f15f54f4ae8f3f
+  data.tar.gz: 7afee607c939d42eff7aa0f3d9bf68780c395896e46fb8bc830a2e195c4ce9babccbf41ff9ff5b108757d86b773256c3cf5fb9ec7496a92b587ed4836a286a92

data/.travis.yml

@@ -18,3 +18,8 @@ cache:
 
 # matrix:
 #   fast_finish: true
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: rbx-2

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## CHANGELOG
 
+### 0.2.0
+
+- Make paint dependency optional
+- Remove pause feature
+- Separate configuring into its own method, remember whirly's configuration, can be cleared with the new .reset method
+- Introduce "stop" frames to display when spinner is over
+- Different newline behaviour; append newline by default after spinner ran. Use position: "below" for old behaviour
+- Support multiple frame modes: "linear", "random", "reverse", "swing"
+- Proper unrendering (use unicode-display\_width)
+- Introduce spinner packs (to deal with eventual name conflicts, currently: whirly + cli)
+- Add more bundled spinners
+- Update CLI spinners to v0.3.0 (two new spinners)
+- Rename option :use\_color to just :color
+- Option to set spinner can also take frames or proc directly
+- Add ANSI escape mode option
+- Add remove\_after\_stop option
+
 ### 0.1.1
 
 - `non_tty` option to force TTY behaviour (whirly deactivates itself for non TTY by default)
@@ -7,5 +24,5 @@
 
 ### 0.1.0
 
-- Inital release
+- Initial release
 

data/Gemfile

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

data/README.md

@@ -1,8 +1,17 @@
 # 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 terminal spinner for Ruby, influenced by [ora](https://github.com/sindresorhus/ora), includes [cli-spinners](https://github.com/sindresorhus/cli-spinners).
+A simple, colorful and customizable terminal spinner library for Ruby. It comes with 17 custom spinners and also includes those from the [cli-spinners](https://github.com/sindresorhus/cli-spinners) project.
 
-ALPHA RELEASE FOR EURUKO
+## Demonstration
+### Bundled Whirly Spinners
+
+[Play on asciinema](https://asciinema.org/a/88198?size=big)
+
+### Bundled Spinners from CLI Spinners
+
+![](https://raw.githubusercontent.com/sindresorhus/cli-spinners/master/screenshot.gif)
+
+[Play on asciinema](https://asciinema.org/a/9mlcoussb137m32swwuqtb2p1?size=big)
 
 ## Setup
 
@@ -17,26 +26,35 @@ gem 'paint' # makes whirly colorful (recommended)
 
 ### Basic Usage
 
+The spinner is shown while the block executes:
+
 ```ruby
 Whirly.start do
-  Whirly.status = "Working on it…"
+  # do the heavy work here
+  sleep 5
+end
+```
+
+You can update the spinner text from inside the block:
+
+```ruby
+Whirly.start do
+  Whirly.status = "Set some text to display alongside the spinner symbol"
   sleep 3
-  Whirly.status = "Almoste done…"
+  Whirly.status = "Update it"
   sleep 2
 end
 ```
 
-### Non-Block Syntax, World Spinner
+If you want to avoid the block syntax, you can also stop it manually:
 
 ```ruby
-Whirly.start spinner: "world"
-Whirly.status = "Working on it…"
-sleep 3
-Whirly.status = "Almoste done…"
+Whirly.start
+sleep 5
 Whirly.stop
 ```
 
-### No Colors, Pong Spinner, Initial Status
+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
@@ -44,25 +62,189 @@ Whirly.start spinner: "pong", use_color: false, status: "The Game of Pong" do
 end
 ```
 
-### Slower Interval, Don't Hide Cursor
+### Configuring Whirly
+
+You can pass the same options you would pass to `.start` to `.configure` instead to create a persistent configuration that will be used by `.start`:
 
 ```ruby
-Whirly.start spinner: "clock", interval: 1000, hide_cursor: false do
-  sleep 5
+Whirly.configure spinner: "dots"
+
+Whirly.start do
+  sleep 3 # will use dots
+end
+
+Whirly.start do
+  sleep 3 # will use dots again
+end
+```
+
+Call `.reset` to restore unconfigured behaviour:
+
+```ruby
+Whirly.configure spinner: "dots"
+
+Whirly.reset
+
+Whirly.start do
+  sleep 3 # will use default spinner
+end
+```
+
+## Spinners
+
+### 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.
+
+## All `Whirly.start` / `Whirly.configure` Configuration Options
+
+### Main Options
+
+#### `spinner:`
+
+You have multiple ways of telling *Whirly* which spinner should be used. You can pass the following to the `spinner:` option:
+
+*Default:* `"whirly"`
+
+- The name of a bundled spinner
+- An array of spinner frames to use
+- A proc which generates the frames dynamically
+- A full spinner hash object ([explained below](https://github.com/janlelis/whirly#full-spinner-hash-format))
+
+#### `status:`
+
+*Default:* None
+
+Allows you to directly set the first status text to display alongside the spinner icon.
+
+#### `interval:`
+
+*Default:* `100`
+
+The number of milliseconds between changing to the next spinner icon frame.
+
+### Advanced Options
+
+#### `ambiguous_characters_width:`
+
+*Default:* `1`
+
+If set to `2`, ambiguous Unicode charatcers will be treated as 2 colums wide. See [unicode-display_width](https://github.com/janlelis/unicode-display_width) for more details.
+
+#### `ansi_escape_mode:`
+
+*Default:* `"restore"`
+
+Can be set to `"line"` to use an different way of producing ANSI escape sequences (experimental)
+
+#### `append_newline:`
+
+*Default:* `true`
+
+When the Whirly block is over (or `.stop` was called), a `"\n"` will be outputted. Change to `false` to prevent this.
+
+#### `color:`
+
+*Default:* `!!defined?(Paint)`
+
+This option is responsible for displaying the spinner icon in random colors. Set to `false` if you do not want this. Related option `:color_change_rate`.
+
+#### `color_change_rate:`
+
+*Default:* `30`
+
+A value which describes how fast the color of the spinner icon changes.
+
+#### `hide_cursor:`
+
+*Default:* `true`
+
+By default, the terminal cursor gets hidden while displaying the spinner. This also registers an `at_exit` callback, which always restores the cursor when exitting the program. If you do not want to hide the cursor, change this option to `false`.
+
+#### `mode:`
+
+*Default:* `"linear"`
+
+Instructs Whirly to play the frames in a different order. Possible values: `"linear"`, `"reverse"`, `"swing"`, and `"random"`. See spinner format section for more details.
+
+#### `non_tty:`
+
+*Default:* `false`
+
+Whirly only gets activated if the current process appears to be a real terminal. If you want to activate it for non-terimnals, set this option to `true`.
+
+#### `position:`
+
+*Default:* `"normal"`
+
+You can set this to `"below"` to let Whirly appear one line below its normal position.
+
+#### `remove_after_stop:`
+
+*Default:* `"false"`
+
+Causes the last frame to be removed after the spinner stopped.
+
+#### `stop:`
+
+*Default:* None
+
+You can pass a custom frame to be used to end the animation, for example:
+
+```ruby
+Whirly.start spinner: "clock", interval: 1000, stop: "⏰" do
+  sleep 12
 end
 ```
 
-## Included Spinners & Custom Spinners
+#### `spinner_packs:`
+
+*Default:* `[:whirly, :cli]`
+
+Whirly comes with spinners from different sources. This options defines which sources to consider (the value refers to an uppercased child constant of `Whirly::Spinners`) and in which order.
+
+#### `stream:`
+
+*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`.
+
+## Full Spinner Hash Format
+
+A full spinner is defined by a hash which can have the following key-value pairs. Please note that in order to keep the format more portable, all keys are strings and not Ruby symbols. Except for `"frames"` and `"proc"`, all options are overwritable when starting/configuring Whirly. See the included spinners for example definitions of spinners.
+
+### `"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.
+
+### `"proc"`
+
+Instead of using `"frames"`: A proc which will generate the next frame with each call.
+
+### `"interval"`
+
+The number of milliseconds between changing to the next spinner icon frame.
+
+### `"mode"`
+
+The order in which frames should be played. It can be one of the following:
+
+- `"linear"`: Cycle through all frames in normal order
+- `"reverse"`: Cycle through all frames in reverse order
+- `"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).
+
+### `"stop"`
 
-- See `data/cursors.json`
-- Spinners are either an Array of frames or an enumerator [...]
-- Extra fun spinners :random_character, :random_emoticon (SOON)
+A frame to be used to end the spinner icon animation.
 
 ## Remarks, Troubleshooting, Caveats
 
 - Interval is milliseconds, but don't rely on exact timing
-- Will not do anything if stream is not a real console
-- Colors not working? Be sure to include the [paint](https://github.com/janlelis/paint/) gem
+- 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)
 
 ## MIT License

data/Rakefile

@@ -30,10 +30,31 @@ task :irb do
 end
 
 
+# # #
+# Run Specs
+
+desc "#{gemspec.name} | Spec"
+task :spec do
+  sh "for file in spec/*.rb; do ruby $file; done"
+end
+task default: :spec
+
+
 # # #
 # Update spinners
+
 desc "Update spinners"
 task :update_spinners do
-  sh "git submodule update"
-  cp "data/external/cli-spinners/spinners.json", "data/spinners.json"
+  sh "git submodule update --recursive --remote"
+  cp "data/external/cli-spinners/spinners.json", "data/cli-spinners.json"
 end
+
+
+# # #
+# Record ASCIICAST
+
+desc "Record an asciicast via asciinema"
+task :record_acsiicast do
+  sh "cd && asciinema rec whirly-bundled-spinners-v0.2.0.json --title='Whirly v0.2.0 Bundled Spinners' --command='ruby #{File.dirname(__FILE__)}/examples/asciinema_bundled_spinners.rb'"
+end
+

data/data/{spinners.json → cli-spinners.json}

@@ -213,6 +213,67 @@
 			"⠈"
 		]
 	},
+	"dots12": {
+		"interval": 80,
+		"frames": [
+			"⢀⠀",
+			"⡀⠀",
+			"⠄⠀",
+			"⢂⠀",
+			"⡂⠀",
+			"⠅⠀",
+			"⢃⠀",
+			"⡃⠀",
+			"⠍⠀",
+			"⢋⠀",
+			"⡋⠀",
+			"⠍⠁",
+			"⢋⠁",
+			"⡋⠁",
+			"⠍⠉",
+			"⠋⠉",
+			"⠋⠉",
+			"⠉⠙",
+			"⠉⠙",
+			"⠉⠩",
+			"⠈⢙",
+			"⠈⡙",
+			"⢈⠩",
+			"⡀⢙",
+			"⠄⡙",
+			"⢂⠩",
+			"⡂⢘",
+			"⠅⡘",
+			"⢃⠨",
+			"⡃⢐",
+			"⠍⡐",
+			"⢋⠠",
+			"⡋⢀",
+			"⠍⡁",
+			"⢋⠁",
+			"⡋⠁",
+			"⠍⠉",
+			"⠋⠉",
+			"⠋⠉",
+			"⠉⠙",
+			"⠉⠙",
+			"⠉⠩",
+			"⠈⢙",
+			"⠈⡙",
+			"⠈⠩",
+			"⠀⢙",
+			"⠀⡙",
+			"⠀⠩",
+			"⠀⢘",
+			"⠀⡘",
+			"⠀⠨",
+			"⠀⢐",
+			"⠀⡐",
+			"⠀⠠",
+			"⠀⢀",
+			"⠀⡀"
+		]
+	},
 	"line": {
 		"interval": 130,
 		"frames": [
@@ -727,5 +788,36 @@
 			"▐ ⡀      ▌",
 			"▐⠠       ▌"
 		]
+	},
+	"shark": {
+		"interval": 120,
+		"frames": [
+			"▐|\\____________▌",
+			"▐_|\\___________▌",
+			"▐__|\\__________▌",
+			"▐___|\\_________▌",
+			"▐____|\\________▌",
+			"▐_____|\\_______▌",
+			"▐______|\\______▌",
+			"▐_______|\\_____▌",
+			"▐________|\\____▌",
+			"▐_________|\\___▌",
+			"▐__________|\\__▌",
+			"▐___________|\\_▌",
+			"▐____________|\\▌",
+			"▐____________/|▌",
+			"▐___________/|_▌",
+			"▐__________/|__▌",
+			"▐_________/|___▌",
+			"▐________/|____▌",
+			"▐_______/|_____▌",
+			"▐______/|______▌",
+			"▐_____/|_______▌",
+			"▐____/|________▌",
+			"▐___/|_________▌",
+			"▐__/|__________▌",
+			"▐_/|___________▌",
+			"▐/|____________▌"
+		]
 	}
 }