spinning_cursor 0.1.0.rc1 → 0.1.0

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider=redcarpet
+--markup=markdown

data/CHANGELOG

@@ -0,0 +1,18 @@
+CHANGELOG
+===============================================================================
+
+v0.1.0 (2012-04-10)
+  - First non-pre release
+  - Exceptions in the task cause the cursor to stop and the exception is shown
+  - Added the ability to change the banner message in the task block, allowing
+    you to update the user on the ongoing task.
+  - Returns a hash containing the start, finish and elapsed times
+
+v0.1.0.rc1 (2012-04-09)
+  - Initial release
+  - Features:
+    - A sexy DSL
+    - Set the loading message, type of spinner and finished message
+    - Pass in an action block to do the whole start stop loop, or don't and
+      call stop yourself
+    - Change the finish message within your task block

data/Gemfile

@@ -7,7 +7,9 @@ source "http://rubygems.org"
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "shoulda", ">= 0"
-  gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.1.3"
   gem "jeweler", "~> 1.8.3"
+  gem "yard"
+  gem "redcarpet"
+  gem "github-markup"
 end

data/Gemfile.lock

@@ -2,6 +2,7 @@ GEM
   remote: http://rubygems.org/
   specs:
     git (1.2.5)
+    github-markup (0.7.2)
     jeweler (1.8.3)
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -11,17 +12,21 @@ GEM
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
+    redcarpet (2.1.1)
     shoulda (3.0.1)
       shoulda-context (~> 1.0.0)
       shoulda-matchers (~> 1.0.0)
     shoulda-context (1.0.0)
     shoulda-matchers (1.0.0)
+    yard (0.7.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.1.3)
+  github-markup
   jeweler (~> 1.8.3)
-  rdoc (~> 3.12)
+  redcarpet
   shoulda
+  yard

data/README.md

@@ -0,0 +1,179 @@
+# Spinning Cursor
+
+Spinning Cursor is a flexible DSL that allows you to easily produce a
+customizable waiting/loading message for your Ruby command line program.
+
+Beautifully keep your users informed with what your program is doing when a
+more complex solution, such as a progress bar, doesn't fit your needs.
+
+Inspired by Chris Wanstrath's
+[Choice](http://https://github.com/defunkt/choice), Spinning Cursor provides
+you with a _sexy_ DSL for easy use of the library.
+
+## Installation
+
+As easy as RubyGems:
+
+```
+$ gem install spinning_cursor
+```
+
+## Usage
+
+_It's so simple it hurts!_
+
+### Example
+
+```ruby
+require 'spinning_cursor' # you'll definitely need this bit
+
+SpinningCursor.start do
+  banner "An amazing task is happening"
+  type :spinner
+  action do
+    # Zzz
+    sleep 10
+  end
+  message "Huh?! I'm awake!"
+end
+
+# [OUPUT]
+# The cursor can't be shown but it would look like this:
+#   An amazing task is happening \ <= that's the 'cursor', it animates!
+#
+# Huh?! I'm awake!
+# => {:started=>2012-04-10 17:01:07 +0100,
+#     :finished=>2012-04-10 17:01:17 +0100, :elapsed=>10.000513}
+```
+
+It's as easy as that!
+
+### Options
+
+* `banner` - This displays before the cursor. Defaults to "Loading".
+* `type` - The type of spinner (currently only `:dots` and `:spinner`).
+  Defaults to `:spinner`.
+* `action` - The stuff you want to do whilst the spinner is spinning.
+* `message` - The message you want to show the user once the task is finished.
+  Defaults to "Done".
+
+### But the action block would get too messy!
+
+Fear not, lost soul. There are two ways to prevent messy code as a result of
+the block.
+
+1. Call a method e.g. `action my_awesome_method`
+2. Start and stop the cursor manually
+
+The first option is the simplest, but the second isn't so bad either.
+It's pretty simple, just do:
+
+```ruby
+SpinningCursor.start do
+  banner "Loading"
+  type :dots
+  message "Done"
+end
+
+# Complex code that takes a long time
+sleep 20
+
+SpinningCursor.stop
+```
+
+**Notice** the absence of the `action` option. The start method will only keep
+the cursor running if an `action` block isn't passed into it.
+
+### I want to be able to change the finish message conditionally!
+
+Do you? Well that's easy too (I'm starting to see a pattern here...)!
+
+Use the `set_message` method to change the message during the execution:
+
+```ruby
+SpinningCursor.start do
+  banner "Calculating your favour colour, please wait"
+  type :dots
+  action do
+    sleep 20
+    if you_are_romantic
+      SpinningCursor.set_message "Your favourite colour is pink."
+    elsif you_are_peaceful
+      SpinningCursor.set_message "Your favourite colour is blue."
+    else
+      SpinningCursor.set_message "Can't figure it out =[!"
+    end
+  end
+end
+```
+
+You get the message. (see what I did there?)
+
+### I need to change the banner message during the task
+
+Yay! All you need is the new version of the gem (v1.0.1) and you can change
+the banner message in the same way you would the finish message, using
+`set_banner`:
+
+```ruby
+SpinningCursor.start do
+  banner "Stealing your food"
+  action do
+    sleep 10
+    SpinningCursor.set_banner "Now eating your food"
+    sleep 10
+  end
+  message "Thanks for the free food!"
+end
+```
+
+### Timing the execution
+
+Spinning Cursor will return a hash with the execution times. If an action
+block is passed, it will be returned in the `SpinningCursor.start` method.
+Otherwise, it will be returned once you call `SpinningCursor.stop`. You can
+also get it with `SpinningCursor.get_exec_time`.
+
+The hash contains the following, self-explanatory keys:
+
+* `:started`
+* `:finished`
+* `:elapsed`
+
+## Contributing to Spinning Cursor
+
+### What to contribute
+
+#### Suggestions
+
+There isn't much this library should do, but a good suggestion is always
+welcome. Make sure to use the issue track on GitHub to make suggestions -- and
+fork & pull request if you want to implement it yourself, of course.
+
+#### More Cursors!
+
+Spinning Cursor could always use some cooler animated cursors, you can add a
+cursor easily by creating a new method in the Cursor class that runs your
+custom cursor.
+
+#### Code optimisations
+
+I'm pretty new to Ruby and this is my first attempt at a DSL. If you could
+have a look at the source and offer any optimisations I would be greatly
+indebted to you. It's a learning experience for me!
+
+### How to contribute
+
+* Check out the latest master to make sure the feature hasn't been implemented
+  or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it
+  and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want
+  to have your own version, or is otherwise necessary, that is fine, but
+  please isolate to its own commit so I can cherry-pick around it.
+

data/Rakefile

@@ -17,9 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "spinning_cursor"
   gem.homepage = "http://github.com/Prydonius/spinning_cursor"
   gem.license = "MIT"
-  gem.summary = "A loader for command line tools in Ruby."
-  gem.description = "Spinning Cursor is a tiny library that allows you to easily produce a
-waiting/loading message for your Ruby command line program."
+  gem.summary = "A DSL for adding animated loaders to your Ruby command line application."
+  gem.description = "Spinning Cursor is a flexible DSL that allows you to easily produce a customizable waiting/loading message for your Ruby command line program. Beautifully keep your users informed with what your program is doing when a more complex solution, such as a progress bar, doesn't fit your needs."
   gem.email = "adnan@prydoni.us"
   gem.authors = ["Adnan Abdulhussein"]
   # dependencies defined in Gemfile
@@ -34,16 +33,3 @@ Rake::TestTask.new(:test) do |test|
 end
 
 task :default => :test
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "spinning_cursor #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('LICENSE*')
-  rdoc.rdoc_files.include('VERSION')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.main = "README.rdoc"
-end

data/VERSION

@@ -1 +1 @@
-0.1.0.rc1
+0.1.0

data/lib/spinning_cursor.rb

@@ -17,30 +17,54 @@ module SpinningCursor
     end
 
     @@parsed = Parser.new(block)
-    @@curs = Thread.new {
-      Cursor.new((@@parsed.type nil), (@@parsed.banner nil))
-    }
+    @@cursor = Cursor.new(@@parsed.banner nil)
+    @@curs = Thread.new { @@cursor.spin(@@parsed.type nil) }
+
+    # Time the execution
+    @@start = Time.now
+
     if @@parsed.action.nil?
       return
     end
-    @@parsed.originator.instance_eval &@@parsed.action
-    stop
+    # The action
+    begin
+      @@parsed.originator.instance_eval &@@parsed.action
+    rescue
+      set_message "Task failed..."
+    ensure
+      return stop
+    end
   end
 
   #
   # Kills the cursor thread and prints the finished message
+  # Returns execution time
   #
   def stop
-    @@curs.kill
-    reset_line
-    puts (@@parsed.message nil)
+    begin
+      @@end = Time.now
+      @@elapsed = @@end - @@start
+
+      @@curs.kill
+      reset_line
+      puts (@@parsed.message nil)
+
+      # Return execution time
+      get_exec_time
+    rescue NameError
+      raise CursorNotRunning.new "Can't stop, no cursor running."
+    end
   end
 
   #
   # Determines whether the cursor thread is still running
   #
   def alive?
-    @@curs.alive?
+    if not defined? @@curs
+      return false
+    else
+      @@curs.alive?
+    end
   end
 
   #
@@ -48,6 +72,38 @@ module SpinningCursor
   # non-deterministic output)
   #
   def set_message(msg)
-    @@parsed.message msg
+    begin
+      @@parsed.message msg
+    rescue NameError
+      raise CursorNotRunning.new "Cursor isn't running... are you sure " +
+        "you're calling this from an action block?"
+    end
   end
+
+  #
+  # Sets the banner message during execution
+  #
+  def set_banner(banner)
+    begin
+      @@cursor.banner = banner
+    rescue NameError
+      raise CursorNotRunning.new "Cursor isn't running... are you sure " +
+        "you're calling this from an action block?"
+    end
+  end
+
+  #
+  # Retrieves execution time information
+  #
+  def get_exec_time
+    begin
+      return { :started => @@start, :finished => @@end,
+        :elapsed => @@elapsed }
+    rescue NameError
+      raise NoTaskError.new "An execution hasn't started or finished."
+    end
+  end
+
+  class NoTaskError < Exception ; end
+  class CursorNotRunning < NoTaskError ; end
 end

data/lib/spinning_cursor/cursor.rb

@@ -1,10 +1,11 @@
 module SpinningCursor
   if RUBY_PLATFORM =~ /(win|w)32$/
+    # DOS
     # Contains a string to clear the line in the shell
     CLR = "                                                               \r"
-    # Haven't yet found a good solution for Windows...
   else
     # Unix
+    # Contains a string to clear the line in the shell
     CLR = "\e[0K"
   end
 
@@ -19,16 +20,28 @@ module SpinningCursor
   # This class contains the cursor types (and their helper methods)
   #
   class Cursor
+    attr_accessor :banner
+
     #
-    # Start the printing
+    # As of v0.1.0: only initializes the cursor class, use the print
+    # method to start the printing. Takes only the banner argument as
+    # a result of this.
     #
-    def initialize(type = :spinner, banner = "Loading")
+    def initialize(banner = "Loading")
       @banner = banner
+    end
+
+    #
+    # Takes a cursor type symbol and starts the printing
+    #
+    def spin(type = :spinner)
       $stdout.sync = true
       print @banner
       send type
     end
 
+    private
+
     #
     # Prints three dots and clears the line
     #

data/lib/spinning_cursor/parser.rb

@@ -41,6 +41,8 @@ module SpinningCursor
       end
     end
 
+    private
+
     #
     # Pass any other methods to the calling class
     #

data/spinning_cursor.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "spinning_cursor"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Adnan Abdulhussein"]
+  s.date = "2012-04-10"
+  s.description = "Spinning Cursor is a flexible DSL that allows you to easily produce a customizable waiting/loading message for your Ruby command line program. Beautifully keep your users informed with what your program is doing when a more complex solution, such as a progress bar, doesn't fit your needs."
+  s.email = "adnan@prydoni.us"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "TODO"
+  ]
+  s.files = [
+    ".document",
+    ".yardopts",
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "TODO",
+    "VERSION",
+    "lib/spinning_cursor.rb",
+    "lib/spinning_cursor/cursor.rb",
+    "lib/spinning_cursor/parser.rb",
+    "spinning_cursor.gemspec",
+    "test/helper.rb",
+    "test/test_cursors.rb",
+    "test/test_exceptions.rb",
+    "test/test_parser.rb",
+    "test/test_spinning_cursor.rb"
+  ]
+  s.homepage = "http://github.com/Prydonius/spinning_cursor"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.21"
+  s.summary = "A DSL for adding animated loaders to your Ruby command line application."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
+      s.add_development_dependency(%q<github-markup>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
+      s.add_dependency(%q<github-markup>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
+    s.add_dependency(%q<github-markup>, [">= 0"])
+  end
+end
+

data/test/test_cursors.rb

@@ -5,7 +5,7 @@ class TestSpinningCursorCursor < Test::Unit::TestCase
     should "reset line after printing three dots" do
       capture_stdout do |out|
         dots = Thread.new do
-          SpinningCursor::Cursor.new :dots, ""
+          SpinningCursor::Cursor.new("").spin :dots
         end
         sleep 5
         dots.kill
@@ -20,7 +20,7 @@ class TestSpinningCursorCursor < Test::Unit::TestCase
     should "cycle through correctly" do
       capture_stdout do |out|
         spinner = Thread.new do
-          SpinningCursor::Cursor.new :spinner, ""
+          SpinningCursor::Cursor.new("").spin :spinner
         end
         sleep 0.1
         assert_equal "|", out.string

data/test/test_exceptions.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+class TestSpinningCursor < Test::Unit::TestCase
+  context "API" do
+    should "raise CursorNotRunning error for set_message, set_banner, and 
+      stop methods" do
+      assert_raise SpinningCursor::CursorNotRunning do
+        SpinningCursor.set_message "Hi!"
+      end
+
+      assert_raise SpinningCursor::CursorNotRunning do
+        SpinningCursor.set_banner "Hi!"
+      end
+
+      assert_raise SpinningCursor::CursorNotRunning do
+        SpinningCursor.stop
+      end
+    end
+
+    should "raise NoTaskError when getting execution time if no task ran" do
+      assert_raise SpinningCursor::NoTaskError do
+        SpinningCursor.get_exec_time
+      end
+    end
+  end
+end

data/test/test_spinning_cursor.rb

@@ -54,5 +54,50 @@ class TestSpinningCursor < Test::Unit::TestCase
         assert_equal true, (out.string.end_with? "Failed!\n")
       end
     end
+
+    should "stop and display error if an unmanaged exception is thrown" do
+      capture_stdout do |out|
+        SpinningCursor.start do
+          action do
+            raise "An exception!"
+          end
+        end
+
+        assert_equal true, (out.string.end_with? "Task failed...\n")
+      end
+    end
+
+    should "not stop if an exception is handled" do
+      capture_stdout do |out|
+        SpinningCursor.start do
+          action do
+            begin
+              raise "An exception!"
+            rescue
+              # rescued!
+            end
+          end
+        end
+
+        assert_equal true, (out.string.end_with? "Done\n")
+      end
+    end
+
+    should "allow you to change the banner" do
+      capture_stdout do |out|
+        SpinningCursor.start do
+          action do
+            # Have to give it time to print the banners
+            sleep 0.1
+            assert_equal true, (out.string.include? "Loading")
+            sleep 0.1
+            SpinningCursor.set_banner "Finishing up"
+            sleep 0.5
+            assert_equal true, (out.string.include? "Finishing up")
+            sleep 0.1
+          end
+        end
+      end
+    end
   end
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: spinning_cursor
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc1
-  prerelease: 6
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Adnan Abdulhussein
@@ -28,13 +28,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 1.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,15 +42,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: jeweler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: 1.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,46 +58,84 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: 1.8.3
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
-description: ! 'Spinning Cursor is a tiny library that allows you to easily produce
-  a
-
-  waiting/loading message for your Ruby command line program.'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Spinning Cursor is a flexible DSL that allows you to easily produce a
+  customizable waiting/loading message for your Ruby command line program. Beautifully
+  keep your users informed with what your program is doing when a more complex solution,
+  such as a progress bar, doesn't fit your needs.
 email: adnan@prydoni.us
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
+- TODO
 files:
 - .document
+- .yardopts
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
+- TODO
 - VERSION
 - lib/spinning_cursor.rb
 - lib/spinning_cursor/cursor.rb
 - lib/spinning_cursor/parser.rb
+- spinning_cursor.gemspec
 - test/helper.rb
 - test/test_cursors.rb
+- test/test_exceptions.rb
 - test/test_parser.rb
 - test/test_spinning_cursor.rb
 homepage: http://github.com/Prydonius/spinning_cursor
@@ -115,17 +153,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 837562280990932011
+      hash: 1396887062628828548
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: A loader for command line tools in Ruby.
+summary: A DSL for adding animated loaders to your Ruby command line application.
 test_files: []

data/README.rdoc

@@ -1,111 +0,0 @@
-== Spinning Cursor
-
-Spinning Cursor is a tiny library that allows you to easily produce a
-waiting/loading message for your Ruby command line program, when a more
-complex solution, such as a progress bar, doesn't fit your needs.
-
-Inspired by Chris Wanstrath's Choice[http://https://github.com/defunkt/choice],
-Spinning Cursor provides you with a DSL for easy use of the library.
-
-== Installation
-
-As easy as RubyGems:
-
-  $ gem install spinning_cursor --pre
-
-== Usage
-
-It's so simple it hurts!
-
-=== Example
-
-  # my_awesome_ruby_class.rb
-
-  require 'spinning_cursor' # you'll definitely need this bit
-
-  class MyAwesomeRubyClass
-    def amazing_task
-      SpinningCursor.start do
-        banner "An amazing task is happening"
-        type :spinner
-        action do
-          # Zzz
-          sleep 10
-        end
-        message "Huh?! I'm awake!"
-      end
-    end
-  end
-
-  great_instance = MyAwesomeRubyClass.new
-  great_instance.amazing_task
-
-It's as easy as that!
-
-=== Options
-
-* +banner+ - This displays before the cursor. Defaults to "Loading".
-* +type+ - The type of spinner (currently only +:dots+ and +:spinner+).
-  Defaults to +:spinner+.
-* +action+ - The stuff you want to do whilst the spinner is spinning.
-* +message+ - The message you want to show the user once the task is finished.
-  Defaults to "Done".
-
-=== But the +action+ block would get too messy!
-
-Fear not, lost soul. There are two ways to prevent messy code as a result of
-the block.
-
-1. Call a method
-2. Start and stop the cursor manually
-
-The first option is the simplest, but the second isn't so bad either.
-It's pretty simple, just do:
-
-  SpinningCursor.start do
-    banner "Loading"
-    type :dots
-    message "Done"
-  end
-
-  # Complex code that takes a long time
-  sleep 20
-
-  SpinningCursor.stop
-
-*Notice* the absense of the +action+ option. The start method will only keep
-the cursor running if an +action+ block isn't passed into it.
-
-=== I want to be able to change the finish message conditionally!
-
-Do you? Well that's easy too (I'm starting to see a pattern here...)!
-
-Use the +set_message+ method to change the message during the execution:
-
-  SpinningCursor.start do
-    banner "Calculating your favour colour, please wait"
-    type :dots
-    action do
-      sleep 20
-      if you_are_romantic
-        SpinningCursor.set_message "Your favourite colour is pink."
-      elsif you_are_peaceful
-        SpinningCursor.set_message "Your favourite colour is blue."
-      else
-        SpinningCursor.set_message "Can't figure it out =[!"
-      end
-    end
-  end
-
-You get the +message+. (see what I did there?)
-
-== Contributing to Spinning Cursor
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-