shell-spinner 1.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in shell-spinner.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,42 @@
+# Shell Spinner
+
+Gem provides animated spinner for UNIX shell and could be used with rake tasks and any console scripts.
+It basically wraps any code and show spinner until code isn't completed.
+
+## Installation
+
+    gem install shell-spinner
+
+In Rails 3, add this to your Gemfile and run the bundle command.
+
+    gem "shell-spinner"
+
+## Usage
+
+The main gem function ```ShellSpinner``` accepts text string as first argument,
+which is not required, but it's better to have it for pretty output.
+And it accepts block of code. So spinner will be presented while block is running.
+
+    require 'shell-spinner'
+
+    # With message
+    ShellSpinner "Positive result" do
+      Rake::Task["foo:bar"].invoke
+    end
+
+    # Spinner without message
+    ShellSpinner do
+      sleep 1
+    end
+
+    # With exception
+    ShellSpinner "Code with exception" do
+      sleep 2
+      raise "Some exception"
+    end
+
+This code produces output similar to:
+
+    > Positive result... done
+    > Code with exception... fail
+    > <exception message and backtrace>

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/shell-spinner.rb

@@ -0,0 +1,52 @@
+require "shell-spinner/version"
+
+module ShellSpinner
+
+  def self.wrap text = nil, &block
+    with_message text do
+      join_spinner_thread(block)
+    end
+  end
+
+  private
+
+    def self.with_message text = nil
+      require 'colorize'
+
+      begin
+        print "#{text}... " unless text.nil?
+        yield
+        print "done\n".colorize(:green) unless text.nil?
+      rescue Exception => e
+        print "fail\n".colorize(:red) unless text.nil?
+        re_raise_exception e
+      end
+    end
+
+    def self.join_spinner_thread proc
+      chars  = %w{ | / - \\ }
+      thread = Thread.new { proc.call }
+
+      while thread.alive?
+        print chars[0]
+        sleep 0.1
+        print "\b"
+
+        chars.push chars.shift
+      end
+
+      thread.join
+    end
+
+    def self.re_raise_exception e
+      raise begin
+        e.class.new(e.message).tap do |exception|
+          exception.set_backtrace e.backtrace
+        end
+      end
+    end
+end
+
+def ShellSpinner text = nil, &block
+  ShellSpinner.wrap text, &block
+end

data/lib/shell-spinner/version.rb

@@ -0,0 +1,3 @@
+module ShellSpinner
+  VERSION = "1.0.0"
+end

data/shell-spinner.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "shell-spinner/version"
+
+Gem::Specification.new do |s|
+  s.name        = "shell-spinner"
+  s.version     = ShellSpinner::VERSION
+  s.authors     = ["Ivan Garmatenko"]
+  s.email       = %w(cheef.che@gmail.ru)
+  s.homepage    = "https://github.com/cheef/shell-spinner"
+  s.summary     = %q{Animated spinner for shell}
+  s.description = %q{Gem provides animated spinner for UNIX shell and could be used with rake tasks and any console scripts}
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = %w(lib)
+
+  s.add_runtime_dependency "colorize"
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: shell-spinner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Ivan Garmatenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: &84013340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *84013340
+description: Gem provides animated spinner for UNIX shell and could be used with rake
+  tasks and any console scripts
+email:
+- cheef.che@gmail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/shell-spinner.rb
+- lib/shell-spinner/version.rb
+- shell-spinner.gemspec
+homepage: https://github.com/cheef/shell-spinner
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Animated spinner for shell
+test_files: []