spinner.rb 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ae85912762746269f1904e657622d271850b2cb
-  data.tar.gz: 4ab07fad82243fd0ea66517bf78b0e28d1e1cf24
+  metadata.gz: bda3e4e335db85c46e9609b2c5c5da9b34ecc62b
+  data.tar.gz: 82646380d9692331f3e3e1d1a38e2afa9b6b86dd
 SHA512:
-  metadata.gz: fc3d11b44f065a65dfdc8f9fb8da5a3bfd8c99518345dd043d9a26a637cca7d1a2320b13f709aff69eec9347e0d44ff9ef4e2406511effa99191f371d9ffb4a1
-  data.tar.gz: 1d18ccfb5db6ca8f503fac6ff8582d355b6a86cb998d54be5ff06bc28960e267503734bfcd8ec68ffbb8b3a582698adb94c2afb363626d3ab533f52c323dc664
+  metadata.gz: 35af4ca9508c56716f3a402f5734de401e22082d4fbccfd932a56b957baf408b3d7d45e746074be0dc77b10321e45317f7027ab5c0f1d9f75c810a3c197599c8
+  data.tar.gz: 180d71fd9959853b43821693b6c045a5c78339d4d6766d987fd62902dfee74294cad129aca78b2e323d7c910fd37e1c6ce2aec8f1463a451f2e7b491b5313dd0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+TODO

data/.ruby-gemset

@@ -0,0 +1 @@
+spinner

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/{MIT-LICENSE → LICENSE.txt}

@@ -1,4 +1,6 @@
-Copyright 2011 Mike Fulcher
+Copyright (c) 2013 Mike Fulcher
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/spinner.rb

@@ -1,15 +1,17 @@
-require 'bundler/setup'
 require 'rake'
 require 'stringio'
 
 class Spinner
+  VERSION = "0.3.0".freeze
+
   attr_reader :queue
+
   def initialize(*tasks)
     @queue = tasks
     @width = 0
     @chars = %w{ | / - \\ }
   end
-  
+
   # Injects a new task into the queue.
   def task(title=nil, task_name=nil, &block)
     # Handle no task being supplied.
@@ -25,7 +27,7 @@ class Spinner
     elsif task_name
       task_block = Rake::Task[task_name]
     end
-    
+
     # Inject the task into the queue.
     @queue << [ title, task_block ]
 
@@ -37,57 +39,57 @@ class Spinner
     # Return the new list of tasks.
     @queue.map(&:first)
   end
-  
+
   # Starts executing the queued tasks.
   def spin!
     # Handle no tasks in the queue.
     return unless @queue.any?
-    
+
     # Mark the current time in order to calculate the total duration.
     start_time = Time.now
 
     # Pluralize the number of tasks in the queue.
     task_counter = "#{@queue.size} task" << (@queue.size == 1 ? '' : 's')
-    
+
     # Update the print width.
     @width = (@width + (@queue.size.to_s.length + 2) * 2) + 1
-    
+
     # Execute each task in sequence.
     @queue.each_with_index do |task, i|
       run_task(task, i+1)
     end
-    
+
     # Reset this spinner instance so that it can be reused.
     reset!
 
     # Mark the completion time and calculate the duration.
     end_time = Time.now
     time_taken = distance_of_time_in_words(start_time, end_time)
-    
+
     # Print the completion message.
     print("Done! #{task_counter} completed in #{time_taken} :-)\n")
   end
-  
+
   private
-  
+
   # Outputs to the console.
   def print(*args)
     STDOUT.print(*args)
   end
-  
+
   # Clears the current printed output.
   def clear
     print("\r")
     print(" ".ljust(@width + 5))
     print("\r")
   end
-  
+
   # Reset this spinner instance to defaults.
   def reset!
     @width = 0
     @queue = []
   end
-  
+
   # Executes a single task.
   def run_task(item, counter)
     # Extract the title & task block.
@@ -95,7 +97,7 @@ class Spinner
 
     # Print the task counter and title.
     print("#{counter}/#{queue.size}: #{title}".ljust(@width, '.') + '... ')
-    
+
     # Begin a new thread to update the printed output while
     # the task runs.
     t = Thread.new {
@@ -107,14 +109,14 @@ class Spinner
         task.call
       end
     }
-    
+
     # Run the spinner for the duration of the task,
     # then clear the output.
     spin while t.alive?
     t.join
     clear
   end
-  
+
   # Update the position of the spinner.
   def spin
     print(@chars[0])          # Print the next character...
@@ -144,4 +146,4 @@ class Spinner
       else              "over an hour"
     end
   end
-end
+end

data/spinner.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spinner.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spinner.rb"
+  spec.version       = Spinner::VERSION
+  spec.authors       = ["Mike Fulcher"]
+  spec.email         = ["mike@drawingablank.me"]
+  spec.summary       = "Ruby progress spinner for tasks with an unknown duration"
+  spec.description   = "Ruby progress spinner for tasks with an unknown duration."
+  spec.homepage      = "http://drawingablank.me/blog/spinner-a-ruby-gem-for-tasks-with-unknown-duration.html"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/test/spinner_test.rb

@@ -0,0 +1,42 @@
+require 'minitest/autorun'
+require File.join(__FILE__, '../../lib/spinner')
+
+class SpinnerTest < Minitest::Test
+
+  GLOBAL = []
+
+  def setup
+    STDOUT.puts("\n")
+    @spinner = Spinner.new
+  end
+
+  def test_adding_block_tasks
+    @spinner.task { sleep(0.1) }
+    assert @spinner.queue.size == 1
+    assert @spinner.queue.first[1].respond_to?(:call)
+  end
+
+  def test_adding_rake_tasks
+    @spinner.task(nil, "test")
+    assert @spinner.queue.size == 1
+    assert Rake::Task.tasks.include?(@spinner.queue.first[1])
+    Rake::Task.clear
+  end
+
+  def test_adding_initial_tasks
+    tasks = []
+    tasks << [ "One", lambda { sleep(0.1) } ]
+    spinner = Spinner.new(*tasks)
+    assert spinner.queue.first[0] == "One"
+  end
+
+  def test_executing_tasks
+    @spinner.task { GLOBAL << '1' }
+    @spinner.task { GLOBAL << '2' }
+    @spinner.task { GLOBAL << '3' }
+    @spinner.spin!
+    assert GLOBAL.size == 3
+    GLOBAL.slice!(0, 3)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spinner.rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mike Fulcher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-08 00:00:00.000000000 Z
+date: 2013-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -39,18 +39,26 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby progress spinner for tasks with an unknown duration.
-email: 
+email:
+- mike@drawingablank.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/spinner.rb
-- MIT-LICENSE
-- Rakefile
+- .gitignore
+- .ruby-gemset
+- .ruby-version
 - Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
-homepage: 
-licenses: []
+- Rakefile
+- lib/spinner.rb
+- spinner.gemspec
+- test/spinner_test.rb
+homepage: http://drawingablank.me/blog/spinner-a-ruby-gem-for-tasks-with-unknown-duration.html
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -68,8 +76,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Ruby progress spinner for tasks with an unknown duration
-test_files: []
+test_files:
+- test/spinner_test.rb