spinning_cursor 0.1.2 → 0.2.0

data/CHANGELOG

@@ -1,6 +1,21 @@
 CHANGELOG
 ===============================================================================
 
+v0.2.0 (2013-07-13)
+  - Several bug fixes/internal API improvements (#4 #8 #9 #10 #11 #13)
+  - Suppress output from action block (#7)
+  - Add `output` option to display inline or all at once at the end (#13)
+  - Add `delay` option to specify cursor speed (#2)
+  - Hide terminal cursor during cursor animation (#11)
+  - Better exception handling (#13)
+
+
+v0.1.1 - v0.1.2 (2012-04-25)
+  - Task timing is more concentrated (times, yields, works out the difference)
+  - Trying to set the message/banner after a task has finished raises an
+    exception
+  - Exceptions are showing now (promise this time D;)
+
 v0.1.0 (2012-04-10)
   - First non-pre release
   - Exceptions in the task cause the cursor to stop and the exception is shown
@@ -15,4 +30,4 @@ v0.1.0.rc1 (2012-04-09)
     - 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
+    - Change the finish message within your task block

data/Gemfile

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

data/Gemfile.lock

@@ -1,32 +1,77 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.10)
+    builder (3.2.2)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
     git (1.2.5)
-    github-markup (0.7.2)
-    jeweler (1.8.3)
+    github-markup (0.7.5)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.4)
+    jeweler (1.8.6)
+      builder
       bundler (~> 1.0)
       git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
       rake
       rdoc
-    json (1.6.6)
-    rake (0.9.2.2)
-    rdoc (3.12)
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
       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)
+    redcarpet (3.0.0)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.4)
+    shoulda-matchers (2.2.0)
+      activesupport (>= 3.0.0)
+    thread_safe (0.1.0)
+      atomic
+    tzinfo (0.3.37)
+    yard (0.8.6.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.1.3)
+  bundler (~> 1.3.5)
   github-markup
-  jeweler (~> 1.8.3)
+  jeweler (~> 1.8.4)
   redcarpet
   shoulda
-  yard
+  yard (~> 0.8.6.2)

data/README.md

@@ -56,6 +56,11 @@ It's as easy as that!
 * `action` - The stuff you want to do whilst the cursor is spinning.
 * `message` - The message you want to show the user once the task is finished.
   Defaults to "Done".
+* `delay` - Sets the delay in seconds between the frames of the animation.
+  Defaults depend on type of cursor animation (spinner 0.5s, dots 1s)
+* `output` - Sets how to display program output during cursor animation
+  (`:inline` or `:at_stop`).
+  Defaults to `:inline`.
 
 ### But the action block would get too messy!
 
@@ -82,7 +87,7 @@ 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.
+the cursor running if an `action` block isn't passed to it.
 
 ### I want to be able to change the finish message conditionally!
 
@@ -147,7 +152,7 @@ The hash contains the following, self-explanatory keys:
 #### 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
+welcome. Make sure to use the issue tracker on GitHub to make suggestions -- and
 fork & pull request if you want to implement it yourself, of course.
 
 #### More Cursors!
@@ -166,7 +171,7 @@ indebted to you. It's a learning experience for me!
 
 * 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
+* Check out the issue tracker to make sure someone hasn't already requested it
   and/or contributed it.
 * Fork the project.
 * Start a feature/bugfix branch.
@@ -177,3 +182,9 @@ indebted to you. It's a learning experience for me!
   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.
 
+### List of contributors
+
+A massive thanks to those who have taken some time out to help improve
+Spinning Cursor!
+
+* Abinoam P. Marques Jr. (@abinoam)

data/TODO

@@ -1,4 +1,5 @@
-Suppress output and show later?
+Suppress output and show later? (give option to produce log file, or just print it to the screen after it's finished),
+  default to hide though.
 deal with returns?
 test changes to spinning cursor, check diff for changes
 refactor tests to use minitest

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/spinning_cursor.rb

@@ -1,8 +1,12 @@
+require "spinning_cursor/console_helpers"
 require "spinning_cursor/cursor"
 require "spinning_cursor/parser"
+require "spinning_cursor/stop_watch"
 
 module SpinningCursor
   extend self
+  include self::ConsoleHelpers
+  extend  self::ConsoleHelpers
 
   #
   # Sends passed block to Parser, and starts cursor thread
@@ -10,30 +14,36 @@ module SpinningCursor
   # thread if an action block is passed.
   #
   def start(&block)
-    if not @curs.nil?
-      if @curs.alive?
-        stop
-      end
-    end
+    stop if alive?
 
-    @parsed = Parser.new(block)
-    @cursor = Cursor.new(@parsed.banner nil)
-    @curs = Thread.new { @cursor.spin(@parsed.type nil) }
+    save_stdout_sync_status
+    capture_console
+    hide_cursor
 
-    if @parsed.action.nil?
-      # record start time
-      do_exec_time
-      return
+    @parsed = Parser.new(&block)
+    @cursor = Cursor.new(@parsed)
+    @spinner = Thread.new do
+      abort_on_exception = true
+      @cursor.spin
     end
-    # The action
-    begin
-      do_exec_time do
-        @parsed.originator.instance_eval &@parsed.action
+
+    @stop_watch = StopWatch.new
+
+    if @parsed.action
+      # The action
+      begin
+        @stop_watch.measure do
+          @parsed.outer_scope_object.instance_eval &@parsed.action
+        end
+      rescue StandardError => e
+        set_message "#{e.message}\n#{e.backtrace.join("\n")}"
+        raise
+      ensure
+        stop
       end
-    rescue Exception => e
-      set_message "#{e.message}\n#{e.backtrace.join("\n")}"
-    ensure
-      return stop
+    else
+      # record start time
+      @stop_watch.start
     end
   end
 
@@ -43,20 +53,28 @@ module SpinningCursor
   #
   def stop
     begin
-      @curs.kill
+      restore_stdout_sync_status
+      if console_captured?
+        $console.print ESC_R_AND_CLR + $stdout.string
+        release_console
+      end
+      show_cursor
+
+      @spinner.kill
       # Wait for the cursor to die -- can cause problems otherwise
-      while @curs.alive? ; end
+      @spinner.join
       # Set cursor to nil so set_banner method only works
       # when cursor is actually running.
       @cursor = nil
       reset_line
-      puts (@parsed.message nil)
+      puts @parsed.message
       # Set parsed to nil so set_message method only works
       # when cursor is actually running.
       @parsed = nil
 
       # Return execution time
-      get_exec_time
+      @stop_watch.stop
+      @stop_watch.timing
     rescue NameError
       raise CursorNotRunning.new "Can't stop, no cursor running."
     end
@@ -66,11 +84,7 @@ module SpinningCursor
   # Determines whether the cursor thread is still running
   #
   def alive?
-    if @curs.nil?
-      return false
-    else
-      @curs.alive?
-    end
+    @spinner and @spinner.alive?
   end
 
   #
@@ -91,47 +105,15 @@ module SpinningCursor
   #
   def set_banner(banner)
     begin
-      @cursor.banner = banner
+      @parsed.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
-    if not @start.nil?
-      if @finish.nil? && @curs.alive? == false
-        do_exec_time
-      end
-      return { :started => @start, :finished => @finish,
-        :elapsed => @elapsed }
-    else
-      raise NoTaskError.new "An execution hasn't started or finished."
-    end
-  end
-
   private
 
-  #
-  # Takes a block, and returns the start, finish and elapsed times
-  #
-  def do_exec_time
-    if @curs.alive?
-      @start = Time.now
-      if block_given?
-        yield
-        @finish = Time.now
-        @elapsed = @finish - @start
-      end
-    else
-      @finish = Time.now
-      @elapsed = @finish - @start
-    end
-  end
-
   class NoTaskError < Exception ; end
   class CursorNotRunning < NoTaskError ; end
-end
+end

data/lib/spinning_cursor/console_helpers.rb

@@ -0,0 +1,88 @@
+require 'stringio'
+
+$console = STDOUT
+
+module SpinningCursor
+  module ConsoleHelpers
+    if RUBY_PLATFORM =~ /(win|w)32$/
+      # DOS
+      # Contains a string to clear the line in the shell
+      CLR = "                                                               \r"
+    else
+      # Unix
+      # Contains a string to clear the line in the shell
+      CLR = "\e[0K"
+    end
+
+    # ANSI escape sequence for hiding terminal cursor
+    ESC_CURS_INVIS = "\e[?25l"
+    # ANSI escape sequence for showing terminal cursor
+    ESC_CURS_VIS   = "\e[?25h"
+    # ANSI escape sequence for clearing line in terminal
+    ESC_R_AND_CLR  = "\r#{CLR}"
+
+    #
+    # Manages line reset in the console
+    #
+    def reset_line(text = "")
+      $console.print "#{ESC_R_AND_CLR}#{text}"
+    end
+
+    #
+    # Stores current `STDOUT.sync` value and sets it to true
+    #
+    def save_stdout_sync_status
+      @stdout_sync_saved_status = STDOUT.sync
+      STDOUT.sync = true
+    end
+
+    #
+    # Restores the previously stored `STDOUT.sync` value
+    #
+    def restore_stdout_sync_status
+      STDOUT.sync = @stdout_sync_saved_status
+    end
+
+    #
+    # Sets `$stdout` global variable to a `StringIO` object to buffer output
+    #
+    def capture_console
+      $stdout = StringIO.new
+    end
+
+    #
+    # Resets `$stdout` global variable to `STDOUT`
+    #
+    def release_console
+      $stdout = $console
+    end
+
+    #
+    # Returns true if `$stdout` is a `StringIO` object
+    #
+    def console_captured?
+      $stdout.is_a?(StringIO)
+    end
+
+    #
+    # Returns true if the output buffer is currently empty
+    #
+    def captured_console_empty?
+      console_captured? and $stdout.string.empty?
+    end
+
+    #
+    # Hides the terminal cursor
+    #
+    def hide_cursor
+      $console.print ESC_CURS_INVIS
+    end
+
+    #
+    # Shows the terminal cursor
+    #
+    def show_cursor
+      $console.print ESC_CURS_VIS
+    end
+  end
+end

data/lib/spinning_cursor/cursor.rb

@@ -1,43 +1,30 @@
 module SpinningCursor
-  if RUBY_PLATFORM =~ /(win|w)32$/
-    # DOS
-    # Contains a string to clear the line in the shell
-    CLR = "                                                               \r"
-  else
-    # Unix
-    # Contains a string to clear the line in the shell
-    CLR = "\e[0K"
-  end
-
-  #
-  # Manages line reset in the console
-  #
-  def reset_line(text = "")
-    print "\r#{CLR}#{text}"
-  end
-
   #
   # This class contains the cursor types (and their helper methods)
   #
   class Cursor
-    attr_accessor :banner
+    include SpinningCursor::ConsoleHelpers
 
     #
     # As of v0.1.0: only initializes the cursor class, use the spin
     # method to start the printing. Takes only the banner argument as
     # a result of this.
     #
-    def initialize(banner = "Loading")
-      @banner = banner
+    def initialize(parsed)
+      @parsed = parsed
     end
 
     #
-    # Takes a cursor type symbol and starts the printing
+    # Takes a cursor type symbol and delay, and starts the printing
     #
-    def spin(type = :spinner)
+    def spin
       $stdout.sync = true
-      print @banner
-      send type
+      $console.print @parsed.banner
+      if @parsed.delay
+        send @parsed.type, @parsed.delay
+      else
+        send @parsed.type
+      end
     end
 
     private
@@ -45,33 +32,30 @@ module SpinningCursor
     #
     # Prints three dots and clears the line
     #
-    def dots
-      i = 1
-      loop do
-        sleep 1
-        if i % 4 == 0
-          SpinningCursor.reset_line @banner
-          i += 1
-          next
-        end
-        i += 1
-        print "."
-      end
+    def dots(delay = 1)
+      cycle_through ['.', '..', '...', ''], delay
     end
 
     #
     # Cycles through '|', '/', '-', '\', resembling a spinning cursor
     #
-    def spinner
-      spinners = ['|', '/', '-', '\\']
-      i = 0
-      loop do
-        print " " unless @banner.empty?
-        print spinners[i % 4]
-        sleep 0.5
-        SpinningCursor.reset_line @banner
-        i += 1
+    def spinner(delay = 0.5)
+      cycle_through ['|', '/', '-', '\\'], delay
+    end
+
+    def cycle_through(chars, delay)
+      chars.cycle do |char|
+        unless @parsed.output==:at_stop or captured_console_empty?
+          $console.print "#{ESC_R_AND_CLR}"
+          $console.print $stdout.string
+          $console.print "\n" unless $stdout.string[-1,1] == "\n"
+          $stdout.string = "" # TODO: Check for race condition.
+        end
+        $console.print "#{ESC_R_AND_CLR}#{@parsed.banner}"
+        $console.print " " unless @parsed.banner.empty?
+        $console.print "#{char}"
+        sleep delay
       end
     end
   end
-end
+end

data/lib/spinning_cursor/parser.rb

@@ -1,43 +1,50 @@
 module SpinningCursor
   class Parser
-    attr_reader :originator
+    attr_accessor :outer_scope_object
 
     #
     # Parses proc
     #
-    def initialize(proc)
-      @banner = "Loading"
-      @type = :spinner
+    def initialize(&block)
+      @banner  = "Loading"
+      @type    = :spinner
       @message = "Done"
+      @delay   = nil
+      @action  = nil
+      @output  = :inline
 
-      if not proc.nil?
-        # Store the originating class for use in method_missing
-        @originator = eval "self", proc.binding
-        instance_eval &proc
+      if block_given?
+        @outer_scope_object = eval("self", block.binding)
+        instance_eval &block
       end
-
-      self
     end
 
     #
     # Getter and setter for the action block
     #
     def action(&block)
-      @action = block unless block.nil?
+      @action = block if block
 
       @action
     end
 
-    #
-    # Getters and setters for +banner+, +type+ and +message+
-    # attributes.
-    # Note:: for getting, pass nil e.g. <tt>banner nil</tt>
-    #
-    %w[banner type message].each do |method|
-      define_method(method) do |string|
+    # @method banner(banner)
+    # @method type(type)
+    # @method message(message)
+    # @method delay(delay)
+    # @method output(output)
+    # Getters and setters for `banner`, `type`, `message`, `delay` and `output`
+    # attributes
+    # @note For getting, use method without arguments
+    #   e.g. `banner`<br />
+    #   For setting, use method with arguments
+    #   e.g. `banner "my banner"`
+    #
+    %w[banner type message delay output].each do |method|
+      define_method(method) do |*args|
         var = "@#{method}"
-        return instance_variable_get(var) if string.nil?
-        instance_variable_set(var, string)
+        return instance_variable_get(var) unless args.first
+        instance_variable_set(var, args.first)
       end
     end
 
@@ -47,7 +54,7 @@ module SpinningCursor
     # Pass any other methods to the calling class
     #
     def method_missing(method, *args, &block)
-      @originator.send method, *args, &block
+      @outer_scope_object.send method, *args, &block
     end
   end
-end
+end

data/lib/spinning_cursor/stop_watch.rb

@@ -0,0 +1,78 @@
+class StopWatch
+
+  #
+  # Instantiate class and call {#measure}
+  #
+  def self.measure(&block)
+    sw = self.new
+    sw.measure &block
+  end
+
+  #
+  # Measures the time taken to process the passed block and returns the
+  # measurment (see {timing})
+  #
+  def measure(&block)
+    start
+    yield
+    stop
+    timing
+  end
+
+  #
+  # Starts timer
+  #
+  def start
+    @start_time = Time.now
+    @stop_time = nil
+    self
+  end
+
+  #
+  # Stops timer
+  #
+  def stop
+    if @start_time
+      @stop_time = Time.now
+    end
+    self
+  end
+
+  #
+  # Resets timer
+  #
+  def reset
+    @start_time = @stop_time = nil
+  end
+
+  #
+  # Returns the elapsed time
+  # @note If the timer has not yet stopped, the time elapsed from the start of
+  #   the timer till `Time.now` is returned
+  #
+  def elapsed_time
+    time_now = Time.now
+    (@stop_time || time_now ) - (@start_time || time_now)
+  end
+
+  alias old_inspect inspect
+
+  def inspect
+    puts "#{old_inspect} #{{:elapsed_time => elapsed_time}}"
+  end
+
+  #
+  # Returns the measurement in a hash containing
+  # * the start time
+  # * the stop time
+  # * the total elapsed time
+  #
+  def timing
+    { :start_time   => @start_time,
+      :stop_time    => @stop_time,
+      :elapsed_time => elapsed_time }
+  end
+
+end
+
+

data/spinning_cursor.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "spinning_cursor"
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adnan Abdulhussein"]
-  s.date = "2012-04-25"
+  s.date = "2013-07-13"
   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 = [
@@ -29,8 +29,10 @@ Gem::Specification.new do |s|
     "TODO",
     "VERSION",
     "lib/spinning_cursor.rb",
+    "lib/spinning_cursor/console_helpers.rb",
     "lib/spinning_cursor/cursor.rb",
     "lib/spinning_cursor/parser.rb",
+    "lib/spinning_cursor/stop_watch.rb",
     "spinning_cursor.gemspec",
     "test/helper.rb",
     "test/test_cursors.rb",
@@ -49,24 +51,24 @@ Gem::Specification.new do |s|
 
     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<bundler>, ["~> 1.3.5"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<yard>, ["~> 0.8.6.2"])
       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<bundler>, ["~> 1.3.5"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<yard>, ["~> 0.8.6.2"])
       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<bundler>, ["~> 1.3.5"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<yard>, ["~> 0.8.6.2"])
     s.add_dependency(%q<redcarpet>, [">= 0"])
     s.add_dependency(%q<github-markup>, [">= 0"])
   end

data/test/helper.rb

@@ -18,16 +18,31 @@ require 'spinning_cursor'
 # (http://thinkingdigitally.com/archive/capturing-output-from-puts-in-ruby/)
 
 require 'stringio'
+
+def kill_other_threads
+  other_threads = Thread.list - [Thread.current]
+  other_threads.each do |th|
+    th.kill
+    th.join
+  end
+end
  
 module Kernel
   def capture_stdout
+    SpinningCursor.capture_console
     out = StringIO.new
-    $stdout = out
+    $console = out
     yield out
   ensure
-    $stdout = STDOUT
+    kill_other_threads
+    $console = STDOUT
+    SpinningCursor.release_console
   end
 end
 
+include SpinningCursor
+
+Thread.abort_on_exception=true
+
 class Test::Unit::TestCase
 end

data/test/test_cursors.rb

@@ -2,40 +2,80 @@ require 'helper'
 
 class TestSpinningCursorCursor < Test::Unit::TestCase
   context "dots" do
-    should "reset line after printing three dots" do
+    parsed = Parser.new { type :dots; delay 0.2; banner ""}
+    delay = parsed.delay
+    should "change 'frames' with correct delay" do
       capture_stdout do |out|
         dots = Thread.new do
-          SpinningCursor::Cursor.new("").spin :dots
+          SpinningCursor::Cursor.new(parsed).spin
         end
-        sleep 5
+        # slight delay to get things started
+        sleep (delay/4.0)
+        buffer = "#{ESC_R_AND_CLR}" << "."
+        assert_equal buffer, out.string
+
+        sleep delay
+        buffer << "#{ESC_R_AND_CLR}" << ".."
+        assert_equal buffer, out.string
+
+        sleep delay
+        buffer << "#{ESC_R_AND_CLR}" << "..."
+        assert_equal buffer, out.string
+
+        sleep delay
+        buffer << "#{ESC_R_AND_CLR}"
+        assert_equal buffer, out.string
+        # don't need to go through the whole thing, otherwise test will take
+        # too long
         dots.kill
-        # \r\e[0K is move cursor to the start of the line and clear line
-        # in bash
-        assert_equal "...\r\e[0K", out.string
       end
     end
   end
 
   context "spinner" do
     should "cycle through correctly" do
+      parsed = Parser.new { type :spinner; delay 0.2; banner ""}
+      delay = parsed.delay
+      capture_stdout do |out|
+        spinner = Thread.new do
+          SpinningCursor::Cursor.new(parsed).spin
+        end
+        # slight delay to get things started
+        sleep (delay/3.0)
+        buffer =  (ESC_R_AND_CLR + "|")
+        assert_equal buffer, out.string
+        buffer += (ESC_R_AND_CLR + "/")
+        sleep delay
+        assert_equal buffer, out.string
+        buffer += (ESC_R_AND_CLR + "-")
+        sleep delay
+        assert_equal buffer, out.string
+        buffer += (ESC_R_AND_CLR + "\\")
+        sleep delay
+        assert_equal buffer, out.string
+        sleep delay
+        buffer += (ESC_R_AND_CLR + "|")
+        assert_equal buffer, out.string
+        spinner.kill
+      end
+    end
+
+    should "changes 'frames' with correct delay" do
+      parsed = Parser.new { type :spinner; delay 0.2; banner ""}
+      delay = parsed.delay
       capture_stdout do |out|
         spinner = Thread.new do
-          SpinningCursor::Cursor.new("").spin :spinner
+          SpinningCursor::Cursor.new(parsed).spin
         end
-        sleep 0.1
-        assert_equal "|", out.string
-        buffer = "|\r\e[0K"
-        sleep 0.5
-        assert_equal "#{buffer}/", out.string
-        buffer += "/\r\e[0K"
-        sleep 0.5
-        assert_equal "#{buffer}-", out.string
-        buffer += "-\r\e[0K"
-        sleep 0.5
-        assert_equal "#{buffer}\\", out.string
-        buffer += "\\\r\e[0K"
-        sleep 0.5
-        assert_equal "#{buffer}|", out.string
+        sleep (delay/4.0)
+        buffer = (ESC_R_AND_CLR + "|")
+        assert_equal buffer, out.string
+        buffer += (ESC_R_AND_CLR + "/")
+        sleep delay
+        # next frame after 'delay' second
+        assert_equal buffer, out.string
+        # don't need to go through the whole thing, otherwise test will take
+        # too long
         spinner.kill
       end
     end

data/test/test_exceptions.rb

@@ -17,12 +17,6 @@ class TestSpinningCursor < Test::Unit::TestCase
       end
     end
 
-    should "a) raise NoTaskError when getting execution time if no task ran" do
-      assert_raise SpinningCursor::NoTaskError do
-        SpinningCursor.get_exec_time
-      end
-    end
-
     should "raise CursorNotRunning errors when cursor has run and finished" do
       SpinningCursor.start
       SpinningCursor.stop

data/test/test_parser.rb

@@ -1,34 +1,78 @@
 require 'helper'
 
 class TestSpinningCursorParser < Test::Unit::TestCase
-  context "parser" do
-    should "check calling class for any missing methods" do
-      def banner_text
-        "Banner"
+  context "A Parser instance" do
+    should "always respond to outer_scope_object method" do
+      assert_respond_to Parser.new, :outer_scope_object
+    end
+
+    context "initialized WITHOUT a block" do
+      should "have outer_scope_object equal nil" do
+        assert_equal nil, Parser.new.outer_scope_object
+      end
+    end
+
+    context "initialized WITH a block" do
+      should "have outer_scope_object point to 'caller'" do
+        parsed = Parser.new {}
+        assert_equal self, parsed.outer_scope_object
+      end
+
+      context "having an 'action' block within this block" do
+        should "have this action block retrievable with Parser#action" do
+          action_block = Proc.new { }
+          parsed = Parser.new do
+                     action &action_block
+                   end
+          assert_equal action_block, parsed.action
+        end
+      end
+
+      context "and instance evaluating this block at Parser context" do
+        should "NOT have access to instance variables of outer_scope_object from inside the block" do
+          @outer_instance_variable = 1
+          parsed = Parser.new { @outer_instance_variable = 2 }
+          assert_not_equal 2, @outer_instance_variable
+          assert_equal     2, parsed.instance_variable_get(:@outer_instance_variable)
+        end
+
+        should "have direct access to instance variables of the Parser instance itself" do
+          parsed = Parser.new { @banner = "this is Parser instance"}
+          assert_equal parsed.banner, "this is Parser instance"
+        end
+
+        should "have access to methods of outer_scope_object from inside the block (thanks method_missing)" do
+          def outer_method
+            "Outer Method"
+          end
+          parsed = Parser.new { banner outer_method }
+          assert_equal outer_method, parsed.banner
+        end
       end
-      parser = SpinningCursor::Parser.new Proc.new { banner banner_text }
-      assert_equal banner_text, (parser.banner nil)
     end
   end
 
-  context "banner, type, message and action methods" do
+  context "banner, type, message, delay and action methods" do
     setup do
-      @parser = SpinningCursor::Parser.new Proc.new { }
+      @parser = SpinningCursor::Parser.new
     end
 
     should "act as getters and setters" do
       @parser.banner "a new banner"
-      assert_equal "a new banner", (@parser.banner nil)
+      assert_equal "a new banner", @parser.banner
 
       @parser.type :dots
-      assert_equal :dots, (@parser.type nil)
+      assert_equal :dots, @parser.type
 
       @parser.message "a message"
-      assert_equal "a message", (@parser.message nil)
+      assert_equal "a message", @parser.message
+
+      @parser.delay 5
+      assert_equal 5, @parser.delay
 
       proc = Proc.new { }
       @parser.action &proc
       assert_equal proc, @parser.action
     end
   end
-end
+end

data/test/test_spinning_cursor.rb

@@ -6,13 +6,22 @@ class TestSpinningCursor < Test::Unit::TestCase
       # Hide any output
       capture_stdout do |out|
         SpinningCursor.start do
-          action { sleep 1 }
+          action { sleep 0.1 }
         end
         # Give it some time to abort
         assert_equal false, SpinningCursor.alive?
       end
     end
 
+    should "Parser#outer_scope_object point to 'caller'" do
+      capture_stdout do |out|
+        SpinningCursor.start { }
+        parsed = SpinningCursor.instance_variable_get(:@parsed)
+        assert_equal self, parsed.outer_scope_object
+        SpinningCursor.stop
+      end
+    end
+
     should "evalute the block from the calling class" do
       @num = 1
       capture_stdout do |out|
@@ -23,6 +32,17 @@ class TestSpinningCursor < Test::Unit::TestCase
         assert_equal 2, @num
       end
     end
+
+    should "raise an exception if something wrong inside the 'action' block" do
+      class SomethingWrongHappened < StandardError; end
+      assert_raise SomethingWrongHappened do
+        capture_stdout do |out|
+          SpinningCursor.start do
+            action { raise SomethingWrongHappened }
+          end
+        end
+      end
+    end
   end
 
   context "when an action block isn't passed it" do
@@ -31,7 +51,7 @@ class TestSpinningCursor < Test::Unit::TestCase
         SpinningCursor.start do
           banner "no action block"
         end
-        sleep 2
+        sleep 0.5
         assert_equal true, SpinningCursor.alive?
         SpinningCursor.stop
         sleep 0.1
@@ -56,12 +76,14 @@ class TestSpinningCursor < Test::Unit::TestCase
 
     should "stop and display error if an unmanaged exception is thrown" do
       capture_stdout do |out|
-        SpinningCursor.start do
-          action do
-            raise "An exception!"
+        begin
+          SpinningCursor.start do
+            action do
+              raise "An exception!"
+            end
           end
+        rescue # Just to let the test go on
         end
-
         assert_equal true, (out.string.include? "An exception!")
       end
     end
@@ -85,18 +107,61 @@ class TestSpinningCursor < Test::Unit::TestCase
     should "allow you to change the banner" do
       capture_stdout do |out|
         SpinningCursor.start do
+          delay 0.2
           action do
             # Have to give it time to print the banners
             sleep 0.1
-            assert_equal true, (out.string.include? "Loading")
+            assert_equal true, (out.string.include? "Loading"), "It should initialy show default banner"
             sleep 0.1
             SpinningCursor.set_banner "Finishing up"
-            sleep 0.5
-            assert_equal true, (out.string.include? "Finishing up")
+            sleep 0.2
+            assert_equal true, (out.string.include? "Finishing up"), "It should have changed banner"
             sleep 0.1
           end
         end
       end
     end
   end
+
+  context "when running for the second time" do
+    should "(without a block) return similar timing values" do
+      capture_stdout do |out|
+        SpinningCursor.start
+        sleep 0.2
+        result = SpinningCursor.stop
+        timing_1 = result[:elapsed_time]
+
+        SpinningCursor.start
+        sleep 0.2
+        result = SpinningCursor.stop
+        timing_2 = result[:elapsed_time]
+
+        assert_equal (timing_1*10).round, (timing_2*10).round,
+        "t1 #{timing_1} and t2 #{timing_2} should be equal"
+      end
+    end
+
+    should "(with a block) return similar timing values" do
+      capture_stdout do |out|
+        result =
+        SpinningCursor.start do
+          action do
+            sleep 0.2
+          end
+        end
+        timing_1 = result[:elapsed_time]
+
+        result =
+        SpinningCursor.start do
+          action do
+            sleep 0.2
+          end
+        end
+        timing_2 = result[:elapsed_time]
+
+        assert_equal (timing_1*10).round, (timing_2*10).round,
+        "t1 #{timing_1} and t2 #{timing_2} should be equal"
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spinning_cursor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-25 00:00:00.000000000 Z
+date: 2013-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: 1.3.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: 1.3.5
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 1.8.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,23 +58,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 1.8.4
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.6.2
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -130,8 +130,10 @@ files:
 - TODO
 - VERSION
 - lib/spinning_cursor.rb
+- lib/spinning_cursor/console_helpers.rb
 - lib/spinning_cursor/cursor.rb
 - lib/spinning_cursor/parser.rb
+- lib/spinning_cursor/stop_watch.rb
 - spinning_cursor.gemspec
 - test/helper.rb
 - test/test_cursors.rb
@@ -153,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1437049553814384370
+      hash: 2712039492645402918
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: