whirly 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27c78b557a26c8556df8bed870f97d256d9b13f9
-  data.tar.gz: 0740cc05c8e08ec9fd361dd97f84f3d7d5d0e875
+  metadata.gz: 676e277e0721c5b27b89f72b91d218c6132ecea9
+  data.tar.gz: c84ff19c62bc2dd2f178d266c06446465bbc2571
 SHA512:
-  metadata.gz: 07acf32c1433564b728587786c9e3ef0610d3b4e740341de46b648d784a7a470b6cf764287760068d38af0861ec2bfd0f324e88ebf3905001d2f110cdda6c1d6
-  data.tar.gz: 5e69bb87239a176c16f83e16cf154ad984e2b6132256c721d027794154b1ce5feee7d7a77ebfbc23ceace195660044b5693db466ea3e2aee07924a54f4aa7297
+  metadata.gz: 8cda16355b8fc8f217c05796bd6b9f524da98b4d9574e8b9a2827fefc05c336e706f3a2de5f5641965b9e95e88bbdfa7b89b3473b1a675c6d65d064ad6f5e205
+  data.tar.gz: ff67f700686adcdad1dd2b2d6c661aab1ec7a0a85f0ebdf6d0a03fbef97fe157daec8970b890020aa559356577ba33344cf50643c823c74fc6456b8b3e83549c

data/CHANGELOG.md

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

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

data/README.md

@@ -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)
 
-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 23 custom spinners and also includes those from the [cli-spinners](https://github.com/sindresorhus/cli-spinners) project.
 
 ## Demonstration
 

data/data/whirly-static-spinners.json

@@ -171,5 +171,55 @@
       "😿",
       "🙀"
     ]
+  },
+  "card": {
+    "interval": 90,
+    "stop": "🂠",
+    "frames": [
+      "🃁", "🃂", "🃃", "🃄", "🃅", "🃆", "🃇", "🃈", "🃉", "🃊", "🃋", "🃌", "🃍", "🃎",
+      "🂱", "🂲", "🂳", "🂴", "🂵", "🂶", "🂷", "🂸", "🂹", "🂺", "🂻", "🂼", "🂽", "🂾",
+      "🂡", "🂢", "🂣", "🂤", "🂥", "🂦", "🂧", "🂨", "🂩", "🂪", "🂫", "🂬", "🂭", "🂮",
+      "🃑", "🃒", "🃓", "🃔", "🃕", "🃖", "🃗", "🃘", "🃙", "🃚", "🃛", "🃜", "🃝", "🃞"
+    ]
+  },
+  "cloud": {
+    "interval": 140,
+    "frames": [
+      "🌥",
+      "🌦",
+      "🌧",
+      "🌨",
+      "🌩",
+      "🌪"
+    ]
+  },
+  "photo": {
+    "interval": 200,
+    "frames": [
+      "📷",
+      "📸"
+    ]
+  },
+  "banknote": {
+    "interval": 100,
+    "frames": [
+      "💴",
+      "💵",
+      "💶",
+      "💷"
+    ]
+  },
+  "white_square": {
+    "interval": 100,
+    "mode": "swing",
+    "frames": [
+      "🞓",
+      "🞒",
+      "🞑",
+      "🞐",
+      "🞏",
+      "🞎",
+      "🞔"
+    ]
   }
 }

data/lib/whirly.rb

@@ -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]
 
@@ -176,12 +176,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/version.rb

@@ -1,4 +1,3 @@
 module Whirly
-  VERSION = "0.2.2".freeze
+  VERSION = "0.2.3".freeze
 end
-

data/spec/whirly_spec.rb

@@ -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.2
 end
 
 def medium_sleep
-  sleep 0.5
+  sleep 0.6
 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)
+        medium_sleep
+        Whirly.stop
+
+        capture2 = StringIO.new
+        Whirly.start(stream: capture2, interval: 50)
+        medium_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;5;/ =~ @capture.string
+    end
+
+    it "will use color when :color option is truthy" do
+      Whirly.start(color: true)
+      short_sleep
+      Whirly.stop
+
+      assert /\[38;5;/ =~ @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;5;(\d+)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")
@@ -263,4 +377,3 @@ describe Whirly do
     end
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whirly
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-06 00:00:00.000000000 Z
+date: 2016-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode-display_width