tty-spinner 0.8.0 → 0.9.0

data/spec/unit/run_spec.rb

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+RSpec.describe TTY::Spinner, '#run' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "runs animation while executing block" do
+    spinner = TTY::Spinner.new(output: output, interval: 100)
+    allow(spinner).to receive(:spin)
+    spinner.run("done") { sleep(0.1) }
+    expect(spinner).to have_received(:spin).at_least(5).times
+  end
+
+  it "runs animation and executes block within context" do
+    context = spy('context')
+    spinner = TTY::Spinner.new(":title", output: output)
+
+    spinner.run("done") do
+      context.call
+      spinner.update(title: 'executing')
+    end
+
+    expect(context).to have_received(:call).once
+  end
+
+  it "yields spinner instance when block argument is provided" do
+    spinner = TTY::Spinner.new(":title", output: output)
+
+    expect { |job|
+      spinner.run("done", &job)
+    }.to yield_with_args(spinner)
+  end
+end

data/spec/unit/spin_spec.rb

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+RSpec.describe TTY::Spinner, '#spin' do
+  let(:output) { StringIO.new('', 'w+') }
+  let(:save)    { TTY::Cursor.save }
+  let(:restore) { TTY::Cursor.restore }
+
+  it "spins default frames" do
+    spinner = TTY::Spinner.new(output: output)
+
+    expect(spinner.done?).to eq(false)
+
+    5.times { spinner.spin }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G|",
+      "\e[1G/",
+      "\e[1G-",
+      "\e[1G\\",
+      "\e[1G|"
+    ].join)
+  end
+
+  it "spins chosen frame" do
+    spinner = TTY::Spinner.new(output: output, format: :spin)
+    5.times { spinner.spin }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G◴",
+      "\e[1G◷",
+      "\e[1G◶",
+      "\e[1G◵",
+      "\e[1G◴"
+    ].join)
+  end
+
+  it "spins with message" do
+    spinner = TTY::Spinner.new("Loading ... :spinner", output: output)
+    4.times { spinner.spin }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1GLoading ... |",
+      "\e[1GLoading ... /",
+      "\e[1GLoading ... -",
+      "\e[1GLoading ... \\"
+    ].join)
+  end
+
+  it "can spin and redraw indent" do
+    multi_spinner = double("MultiSpinner")
+    allow(multi_spinner).to receive(:synchronize).and_yield
+    allow(multi_spinner).to receive(:next_row).and_return(1)
+    allow(multi_spinner).to receive(:rows).and_return(1)
+    allow(multi_spinner).to receive(:line_inset).and_return("--- ")
+
+    spinner = TTY::Spinner.new(output: output)
+    spinner.attach_to(multi_spinner)
+    spinner.spin
+    spinner.redraw_indent
+
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G--- |\n",
+      save,
+      "\e[1A",
+      "--- ",
+      restore,
+    ].join)
+  end
+
+  it "spins with many threads" do
+    spinner = TTY::Spinner.new(output: output)
+
+    th1 = Thread.new { 3.times { spinner.spin; sleep(0.05) } }
+    th2 = Thread.new { 4.times { spinner.spin; sleep(0.05) } }
+
+    [th1, th2].each(&:join)
+
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G|",
+      "\e[1G/",
+      "\e[1G-",
+      "\e[1G\\",
+      "\e[1G|",
+      "\e[1G/",
+      "\e[1G-"
+    ].join)
+  end
+end

data/spec/unit/stop_spec.rb

@@ -0,0 +1,64 @@
+# coding: utf-8
+
+RSpec.describe TTY::Spinner, '#stop' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "doesn't reprint stop message" do
+    spinner = TTY::Spinner.new(output: output)
+    spinner.spin
+    3.times { spinner.stop }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G|",
+      "\e[0m\e[2K",
+      "\e[1G|\n",
+    ].join)
+  end
+
+  it "stops after 2 spins" do
+    spinner = TTY::Spinner.new(output: output)
+    5.times do |n|
+      spinner.spin
+      spinner.stop if n == 1
+    end
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G|",
+      "\e[1G/",
+      "\e[0m\e[2K",
+      "\e[1G/\n"
+    ].join)
+  end
+
+  it "stops after 2 spins and prints stop message" do
+    spinner = TTY::Spinner.new(output: output)
+    5.times do |n|
+      spinner.spin
+      spinner.stop('Done!') if n == 1
+    end
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G|",
+      "\e[1G/",
+      "\e[0m\e[2K",
+      "\e[1G/ Done!\n"
+    ].join)
+
+    expect(spinner.done?).to eq(true)
+  end
+
+  it "stops after 2 spins with message and prints stop message" do
+    spinner = TTY::Spinner.new("Loading ... :spinner", output: output)
+    5.times do |n|
+      spinner.spin
+      spinner.stop('Done!') if n == 1
+    end
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1GLoading ... |",
+      "\e[1GLoading ... /",
+      "\e[0m\e[2K",
+      "\e[1GLoading ... / Done!\n"
+    ].join)
+  end
+end

data/spec/unit/success_spec.rb

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+RSpec.describe TTY::Spinner, '#success' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "marks spinner as success" do
+    spinner = TTY::Spinner.new(output: output)
+    3.times { spinner.spin }
+    spinner.success
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G|",
+      "\e[1G/",
+      "\e[1G-",
+      "\e[0m\e[2K",
+      "\e[1G#{TTY::Spinner::TICK}\n"
+    ].join)
+
+    expect(spinner.success?).to eq(true)
+  end
+
+  it "marks spinner as success with message" do
+    spinner = TTY::Spinner.new(output: output)
+    3.times { spinner.spin }
+    spinner.success('Successful')
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G|",
+      "\e[1G/",
+      "\e[1G-",
+      "\e[0m\e[2K",
+      "\e[1G#{TTY::Spinner::TICK} Successful\n"
+    ].join)
+
+    expect(spinner.success?).to be(true)
+  end
+
+  it "changes success spinner marker" do
+    spinner = TTY::Spinner.new(success_mark: '*', output: output)
+    spinner.success('(successful)')
+    output.rewind
+    expect(output.read).to eq("\e[0m\e[2K\e[1G* (successful)\n")
+
+    expect(spinner.success?).to be(true)
+  end
+end

data/spec/unit/update_spec.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Spinner, '#update' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "updates message content with custom token" do
+    spinner = TTY::Spinner.new(":title :spinner", output: output, interval: 100)
+    spinner.update(title: 'task')
+    5.times { spinner.spin }
+    spinner.stop('done')
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1Gtask |",
+      "\e[1Gtask /",
+      "\e[1Gtask -",
+      "\e[1Gtask \\",
+      "\e[1Gtask |",
+      "\e[0m\e[2K",
+      "\e[1Gtask | done\n"
+    ].join)
+  end
+
+  it "updates message many times before stopping" do
+    spinner = TTY::Spinner.new(":title :spinner", output: output)
+
+    spinner.update(title: 'task_a')
+    2.times { spinner.spin }
+    spinner.update(title: 'task_b')
+    2.times { spinner.spin }
+    spinner.stop('done')
+    output.rewind
+
+    expect(output.read).to eq([
+      "\e[1Gtask_a |",
+      "\e[1Gtask_a /",
+      "\e[0m\e[2K\e[1G",
+      "\e[1Gtask_b -",
+      "\e[1Gtask_b \\",
+      "\e[0m\e[2K",
+      "\e[1Gtask_b \\ done\n"
+    ].join)
+  end
+
+  it "updates message after stopping" do
+    spinner = TTY::Spinner.new(":title :spinner", output: output)
+
+    spinner.update(title: 'task_a')
+    2.times { spinner.spin }
+    spinner.stop('done')
+
+    spinner.start
+    spinner.update(title: 'task_b')
+    2.times { spinner.spin }
+    spinner.stop('done')
+
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1Gtask_a |",
+      "\e[1Gtask_a /",
+      "\e[0m\e[2K",
+      "\e[1Gtask_a / done\n",
+      "\e[1Gtask_b |",
+      "\e[1Gtask_b /",
+      "\e[0m\e[2K",
+      "\e[1Gtask_b / done\n"
+    ].join)
+  end
+
+  it "maintains current tokens" do
+    spinner = TTY::Spinner.new(":foo :bar", output: output)
+    expect(spinner.tokens).to eq({})
+
+    spinner.update(foo: 'FOO')
+    spinner.update(bar: 'BAR')
+
+    expect(spinner.tokens).to include({foo: 'FOO', bar: 'BAR'})
+  end
+
+  it "updates more than one token" do
+    spinner = TTY::Spinner.new(":foo :bar", output: output)
+    expect(spinner.tokens).to eq({})
+
+    spinner.update(foo: 'FOO', bar: 'BAR')
+
+    expect(spinner.tokens).to include({foo: 'FOO', bar: 'BAR'})
+  end
+end

data/tasks/console.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require_relative '../lib/tty-spinner'
+  ARGV.clear
+  IRB.start
+end
+task :c => :console

data/tasks/coverage.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Measure code coverage'
+task :coverage do
+  begin
+    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
+    Rake::Task['spec'].invoke
+  ensure
+    ENV['COVERAGE'] = original
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
+  end
+
+  namespace :spec do
+    desc 'Run unit specs'
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
+    end
+  end
+
+rescue LoadError
+  %w[spec spec:unit spec:integration].each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do `gem install rspec`"
+    end
+  end
+end

data/tty-spinner.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tty/spinner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tty-spinner'
+  spec.version       = TTY::Spinner::VERSION
+  spec.authors       = ['Piotr Murach']
+  spec.email         = ['pmurach@gmail.com']
+  spec.summary       = %q{A terminal spinner for tasks that have non-deterministic time frame.}
+  spec.description   = %q{A terminal spinner for tasks that have non-deterministic time frame.}
+  spec.homepage      = "https://piotrmurach.github.io/tty"
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['{lib,spec,examples}/**/*.rb']
+  spec.files        += Dir['{bin,tasks}/*', 'tty-spinner.gemspec']
+  spec.files        += Dir['README.md', 'CHANGELOG.md', 'LICENSE.txt', 'Rakefile']
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency 'tty-cursor', '~> 0.6.0'
+
+  spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: tty-spinner
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-11 00:00:00.000000000 Z
+date: 2018-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-cursor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -79,14 +79,67 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
+- Rakefile
+- examples/auto_spin.rb
+- examples/basic.rb
+- examples/clear.rb
+- examples/color.rb
+- examples/error.rb
+- examples/formats.rb
+- examples/hide_cursor.rb
+- examples/multi/basic.rb
+- examples/multi/basic_top_level.rb
+- examples/multi/custom_style.rb
+- examples/multi/files.rb
+- examples/multi/jobs.rb
+- examples/multi/multi.rb
+- examples/multi/multi_top_level.rb
+- examples/multi/pause.rb
+- examples/multi/threaded.rb
+- examples/pause.rb
+- examples/run.rb
+- examples/success.rb
+- examples/threaded.rb
+- examples/update.rb
 - lib/tty-spinner.rb
 - lib/tty/spinner.rb
 - lib/tty/spinner/formats.rb
 - lib/tty/spinner/multi.rb
 - lib/tty/spinner/version.rb
-homepage: https://github.com/piotrmurach/tty-spinner
+- spec/spec_helper.rb
+- spec/unit/auto_spin_spec.rb
+- spec/unit/clear_spec.rb
+- spec/unit/error_spec.rb
+- spec/unit/events_spec.rb
+- spec/unit/formats_spec.rb
+- spec/unit/frames_spec.rb
+- spec/unit/hide_cursor_spec.rb
+- spec/unit/job_spec.rb
+- spec/unit/join_spec.rb
+- spec/unit/multi/auto_spin_spec.rb
+- spec/unit/multi/error_spec.rb
+- spec/unit/multi/line_inset_spec.rb
+- spec/unit/multi/on_spec.rb
+- spec/unit/multi/register_spec.rb
+- spec/unit/multi/spin_spec.rb
+- spec/unit/multi/stop_spec.rb
+- spec/unit/multi/success_spec.rb
+- spec/unit/new_spec.rb
+- spec/unit/pause_spec.rb
+- spec/unit/reset_spec.rb
+- spec/unit/run_spec.rb
+- spec/unit/spin_spec.rb
+- spec/unit/stop_spec.rb
+- spec/unit/success_spec.rb
+- spec/unit/update_spec.rb
+- tasks/console.rake
+- tasks/coverage.rake
+- tasks/spec.rake
+- tty-spinner.gemspec
+homepage: https://piotrmurach.github.io/tty
 licenses:
 - MIT
 metadata: {}
@@ -98,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -106,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A terminal spinner for tasks that have non-deterministic time frame.