spinner.rb 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ae85912762746269f1904e657622d271850b2cb
+  data.tar.gz: 4ab07fad82243fd0ea66517bf78b0e28d1e1cf24
+SHA512:
+  metadata.gz: fc3d11b44f065a65dfdc8f9fb8da5a3bfd8c99518345dd043d9a26a637cca7d1a2320b13f709aff69eec9347e0d44ff9ef4e2406511effa99191f371d9ffb4a1
+  data.tar.gz: 1d18ccfb5db6ca8f503fac6ff8582d355b6a86cb998d54be5ff06bc28960e267503734bfcd8ec68ffbb8b3a582698adb94c2afb363626d3ab533f52c323dc664

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Mike Fulcher
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Spinner
+
+```ruby
+# Create a new spinner instance
+spinner = Spinner.new
+
+# Add a task block
+spinner.task("Number 1") do
+  sleep(5) # simulate taking a while to do something awesome
+end
+
+# Add another task
+Spinner.task("Number 2") do
+  sleep(2)
+end
+
+# Run the tasks
+spinner.spin!
+```
+
+## Spinner can call rake tasks, too
+
+```ruby
+# Example: completely reconstruct a Rails database using migrations
+
+spinner = Spinner.new
+spinner.task("Dropping", 'db:drop')
+spinner.task("Creating", 'db:create')
+spinner.task("Migrating", 'db:migrate')
+spinner.task("Loading", 'db:test:load')
+spinner.task("Seeding", 'db:seed')
+spinner.spin!
+```
+
+## Initialize with tasks
+
+```ruby
+# Tasks are just arrays with two items: the name of the task (defaults to "Executing") and the task (either a string representing a rake task, or a block that responds to "call")
+
+tasks = []
+tasks << [ "Drop database", "db:drop" ]
+tasks << [ "Sleep 2 seconds", lambda { sleep(2) } ]
+spinner = Spinner.new(*tasks)
+spinner.spin!
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end

data/lib/spinner.rb

@@ -0,0 +1,147 @@
+require 'bundler/setup'
+require 'rake'
+require 'stringio'
+
+class Spinner
+  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.
+    return @queue.map(&:title) unless block_given? || task_name
+
+    # Set default title.
+    title = 'Executing' unless title
+
+    # Tasks can be given a block to evaluate or
+    # a rake task name to invoke.
+    if block_given?
+      task_block = block
+    elsif task_name
+      task_block = Rake::Task[task_name]
+    end
+    
+    # Inject the task into the queue.
+    @queue << [ title, task_block ]
+
+    # Amend the output width if necessary.
+    if @width < title.length
+      @width = title.length
+    end
+
+    # 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.
+    title, task = *item
+
+    # 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 {
+      # Suppress $stdout during the task's execution.
+      $stdout = StringIO.new
+      if task.respond_to?(:invoke)
+        task.invoke
+      else
+        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...
+    sleep(0.1)                # ...wait 100ms...
+    print("\b")               # ...move the cursor back by one...
+    @chars.push(@chars.shift) # ...rotate the characters array.
+  end
+
+  # Simplified extraction from ActionView.
+  def distance_of_time_in_words(from_time, to_time)
+    distance_in_minutes = ((to_time - from_time) / 60.0).round
+    distance_in_seconds = (to_time - from_time).round
+
+    case distance_in_minutes
+      when 0..1
+        case distance_in_seconds
+          when 0..4   then "less than 5 seconds"
+          when 5..9   then "less than 10 seconds"
+          when 10..19 then "less than 20 seconds"
+          when 20..39 then "about half a minute"
+          when 40..59 then "less than one minute"
+          else             "one minute"
+        end
+
+      when 2...45  then "about #{distance_in_minutes} minutes"
+      when 45...90 then "about an hour"
+      else              "over an hour"
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: spinner.rb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Mike Fulcher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby progress spinner for tasks with an unknown duration.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/spinner.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.md
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby progress spinner for tasks with an unknown duration
+test_files: []