whirly 0.1.1 → 0.2.0

data/lib/whirly/spinners.rb

@@ -1,6 +1,7 @@
-require "json"
-
 module Whirly
-  SPINNERS = JSON.load(File.read(File.dirname(__FILE__) + "/../../data/spinners.json"))
-  SPINNERS["whirly"] = { "proc" => ->(){ [0x1F600 + rand(55)].pack("U") }, "interval" => 200 }
+  module Spinners
+  end
 end
+
+require_relative "spinners/whirly"
+require_relative "spinners/cli"

data/lib/whirly/spinners/cli.rb

@@ -0,0 +1,7 @@
+require "json"
+
+module Whirly
+  module Spinners
+    CLI = JSON.load(File.read(File.dirname(__FILE__) + "/../../../data/cli-spinners.json")).freeze
+  end
+end

data/lib/whirly/spinners/whirly.rb

@@ -0,0 +1,20 @@
+require "json"
+
+module Whirly
+  module Spinners
+    WHIRLY = {
+      "whirly"              => { "proc" => ->(){ [0x1F600 + rand(55) ].pack("U") }, "interval" => 200 },
+      "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 },
+    }
+    WHIRLY.merge! JSON.load(File.read(File.dirname(__FILE__) + "/../../../data/whirly-static-spinners.json"))
+
+    WHIRLY.freeze
+  end
+end

data/lib/whirly/version.rb

@@ -1,4 +1,4 @@
 module Whirly
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.0".freeze
 end
 

data/spec/whirly_spec.rb

@@ -1,29 +1,250 @@
 require_relative "../lib/whirly"
 require "minitest/autorun"
+# require "irbtools/binding"
+require "stringio"
+
+def short_sleep
+  sleep 0.1
+end
+
+def medium_sleep
+  sleep 0.4
+end
+
+def long_sleep
+  sleep 1
+end
 
 describe Whirly do
-  describe "usage" do
+  before do
+    Whirly.reset
+    @capture = StringIO.new
+    Whirly.configure(non_tty: true, stream: @capture)
+  end
+
+  describe "General Usage" do
     it "outputs every frame of the spinner" do
-      spinner = { "frames" => ["first", "second", "third"], "interval" => 10 }
+      spinner = { "frames" => ["first", "second", "third"], "interval" => 5 }
+
+      Whirly.start(spinner: spinner)
+      short_sleep
+      Whirly.stop
+
+      assert_match /first.*second.*third/m, @capture.string
+    end
+
+    it "calls spinner proc instead of frames if proc is given" do
+      spinner = { "proc" => ->(){ "frame" }, "interval" => 5 }
 
-      assert_output /first.*second.*third/m do
-        Whirly.start(spinner: spinner,  non_tty: true)
-        sleep 0.1
+      Whirly.start(spinner: spinner)
+      short_sleep
+      Whirly.stop
+
+      assert_match /frame/, @capture.string
+    end
+  end
+
+  describe "Status Updates" do
+    it "shows status text alongside spinner" do
+      Whirly.start
+      Whirly.status = "Fetching…"
+      medium_sleep
+      Whirly.status = "Updates…"
+      medium_sleep
+      Whirly.stop
+
+      assert_match /Fetching.*Updates…/m, @capture.string
+    end
+
+    it "shows initial status" do
+      Whirly.start(status: "Initial")
+      short_sleep
+      Whirly.stop
+
+      assert_match /Initial/, @capture.string
+    end
+  end
+
+  describe "Finishing" do
+    it "shows spinner finished frame if stop is set in spinner definition" do
+      spinner = { "frames" => ["first", "second", "third"], "stop" => "STOP", "interval" => 5 }
+
+      Whirly.start(spinner: spinner)
+      short_sleep
+      Whirly.stop
+
+      assert_match /STOP/, @capture.string
+    end
+
+    it "shows spinner finished frame if stop frame is passed when stopping" do
+      spinner = { "frames" => ["first", "second", "third"], "interval" => 5 }
+
+      Whirly.start(spinner: spinner)
+      short_sleep
+      Whirly.stop("STOP")
+
+      assert_match /STOP/, @capture.string
+    end
+
+    it "shows spinner finished frame if stop frame is passed when starting" do
+      spinner = { "frames" => ["first", "second", "third"], "interval" => 5 }
+
+      Whirly.start(spinner: spinner, stop: "STOP")
+      short_sleep
+      Whirly.stop
+
+      assert_match /STOP/, @capture.string
+    end
+
+    it "appends newline when stopping" do
+      Whirly.start(hide_cursor: false)
+      short_sleep
+      Whirly.stop
+
+      assert_match /\n\z/, @capture.string
+    end
+
+    it "appends no newline when stopping when :append_newline option is false" do
+      Whirly.start(hide_cursor: false, append_newline: false)
+      short_sleep
+      Whirly.stop
+
+      assert_match /[^\n]\z/, @capture.string
+    end
+
+    it "removes the spinner after stopping when :remove_after_stop is true" do
+      Whirly.start(hide_cursor: false, remove_after_stop: true)
+      short_sleep
+      Whirly.stop
+
+      assert_match /\e\[u\n\z/, @capture.string
+    end
+  end
+
+  describe "Spinner" do
+    describe "Passing a Spinner" do
+      it "can be the name of a bundled spinner (whirly-spinners)" do
+        Whirly.start(spinner: "pencil")
+        medium_sleep
+        Whirly.stop
+
+        assert_match /✎/, @capture.string
+      end
+
+      it "can be the name of a bundled spinner (cli-spinners)" do
+        Whirly.start(spinner: "dots3")
+        medium_sleep
+        Whirly.stop
+
+        assert_match /⠋/, @capture.string
+      end
+
+      it "can be an Array of frames" do
+        Whirly.start(spinner: ["A", "B"])
+        medium_sleep
         Whirly.stop
+
+        assert_match /A.*B/m, @capture.string
+      end
+
+      it "can be an Enumerator of frames" do
+        Whirly.start(spinner: "A".."B")
+        medium_sleep
+        Whirly.stop
+
+        assert_match /A.*B/m, @capture.string
+      end
+
+      it "can be a Proc which generates frames" do
+        Whirly.start(spinner: ->(){ "frame" })
+        medium_sleep
+        Whirly.stop
+
+        assert_match /frame/m, @capture.string
       end
     end
 
-    it "calls spinner proc instead of frames if proc is given" do
-      spinner = { "proc" => ->(){ "frame" }, "interval" => 10 }
+    describe "Frame Mode" do
+      it "can be set to random" do
+        spinner = { "frames" => "A".."H", "mode" => "random", "interval" => 10 }
+
+        Whirly.start(spinner: spinner)
+        medium_sleep
+        Whirly.stop
+
+        refute /A.*B.*C.*D.*E.*F.*G.*H/m =~ @capture.string
+      end
+
+      it "can be set to reverse" do
+        spinner = { "frames" => "A".."H", "mode" => "reverse", "interval" => 10 }
+
+        Whirly.start(spinner: spinner)
+        medium_sleep
+        Whirly.stop
+
+        assert_match /H.*G.*F.*E.*D.*C.*B.*A/m, @capture.string
+      end
+
+      it "can be set to swing" do
+        spinner = { "frames" => "A".."H", "mode" => "swing", "interval" => 10 }
 
-      assert_output /frame/ do
-        Whirly.start(spinner: spinner, non_tty: true)
-        sleep 0.1
+        Whirly.start(spinner: spinner)
+        medium_sleep
         Whirly.stop
+
+        assert_match /A.*B.*C.*D.*E.*F.*G.*H.*G.*F.*E.*D.*C.*B.*A/m, @capture.string
       end
     end
   end
 
+  describe "Ansi Escape Mode" do
+    it "will use save and restore ANSI sequences as default (or when 'restore') is given" do
+      Whirly.start
+      short_sleep
+      Whirly.stop
+      assert_match /\e\[s.*\e\[u/m, @capture.string
+    end
+
+    it "will use beginning of line and clear line ANSI sequences when 'line' is given" do
+      Whirly.start(ansi_escape_mode: 'line')
+      medium_sleep
+      Whirly.stop
+      assert_match /\e\[G.*\e\[1K/m, @capture.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")
+      short_sleep
+      Whirly.stop
+
+      assert_match /\n.*\e\[1A/m, @capture.string
+    end
+  end
+
+  describe "Configure and Reset" do
+    it "can be configured before starting" do
+      Whirly.configure spinner: "dots", interval: 5
+
+      Whirly.start
+      short_sleep
+      Whirly.stop
+
+      assert_match /⠧/, @capture.string
+    end
+
+    it "can be reset using .reset" do
+      Whirly.configure spinner: "dots", interval: 5
+      Whirly.reset
+
+      Whirly.start(non_tty: true, stream: @capture)
+      short_sleep
+      Whirly.stop
+      assert_match /\A[^⠧]+\z/, @capture.string
+    end
+  end
+
   describe ".enabled?" do
     it "returns false if whirly was not started yet" do
       refute_predicate Whirly, :enabled?

data/whirly.gemspec

@@ -6,18 +6,21 @@ Gem::Specification.new do |gem|
   gem.name          = "whirly"
   gem.version       = Whirly::VERSION
   gem.summary       = "Whirly: The friendly terminal spinner"
-  gem.description   = "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.homepage      = "https://github.com/janlelis/whirly"
   gem.license       = "MIT"
 
   gem.files         = Dir["{**/}{.*,*}"].select{ |path| File.file?(path) && path !~ /^(pkg|data)/ } + %w[
-                        data/spinners.json
+                        data/cli-spinners.json
+                        data/whirly-static-spinners.json
                       ]
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_dependency "unicode-display_width", "~> 1.1"
+
   gem.required_ruby_version = "~> 2.0"
 end

metadata

@@ -1,16 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: whirly
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
-dependencies: []
-description: 'Whirly: The friendly terminal spinner'
+date: 2016-10-05 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
 executables: []
@@ -27,13 +42,19 @@ files:
 - MIT-LICENSE.txt
 - README.md
 - Rakefile
-- data/spinners.json
-- euruko.rb
+- data/cli-spinners.json
+- data/whirly-static-spinners.json
+- examples/all_spinners.rb
+- examples/asciinema_bundled_spinners.rb
+- examples/euruko.rb
+- examples/multi_lines.rb
+- examples/single.rb
+- examples/status.rb
 - lib/whirly.rb
-- lib/whirly/.spinners.rb.swp
 - lib/whirly/spinners.rb
+- lib/whirly/spinners/cli.rb
+- lib/whirly/spinners/whirly.rb
 - lib/whirly/version.rb
-- spec/.whirly_spec.rb.swp
 - spec/whirly_spec.rb
 - whirly.gemspec
 homepage: https://github.com/janlelis/whirly
@@ -61,5 +82,4 @@ signing_key:
 specification_version: 4
 summary: 'Whirly: The friendly terminal spinner'
 test_files:
-- spec/.whirly_spec.rb.swp
 - spec/whirly_spec.rb