spinning_cursor 0.1.0 → 0.1.2

data/README.md

@@ -7,7 +7,7 @@ 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
+[Choice](https://github.com/defunkt/choice), Spinning Cursor provides
 you with a _sexy_ DSL for easy use of the library.
 
 ## Installation
@@ -51,9 +51,9 @@ 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`).
+* `type` - The type of cursor (currently only `:dots` and `:spinner`).
   Defaults to `:spinner`.
-* `action` - The stuff you want to do whilst the spinner is spinning.
+* `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".
 
@@ -111,7 +111,7 @@ 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
+Yay! All you need is the new version of the gem (v0.1.0) and you can change
 the banner message in the same way you would the finish message, using
 `set_banner`:
 

data/TODO

@@ -0,0 +1,5 @@
+Suppress output and show later?
+deal with returns?
+test changes to spinning cursor, check diff for changes
+refactor tests to use minitest
+setup travis ci to test across different versions of ruby

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.2

data/lib/spinning_cursor.rb

@@ -10,27 +10,28 @@ module SpinningCursor
   # thread if an action block is passed.
   #
   def start(&block)
-    if defined? @@curs
-      if @@curs.alive?
+    if not @curs.nil?
+      if @curs.alive?
         stop
       end
     end
 
-    @@parsed = Parser.new(block)
-    @@cursor = Cursor.new(@@parsed.banner nil)
-    @@curs = Thread.new { @@cursor.spin(@@parsed.type nil) }
+    @parsed = Parser.new(block)
+    @cursor = Cursor.new(@parsed.banner nil)
+    @curs = Thread.new { @cursor.spin(@parsed.type nil) }
 
-    # Time the execution
-    @@start = Time.now
-
-    if @@parsed.action.nil?
+    if @parsed.action.nil?
+      # record start time
+      do_exec_time
       return
     end
     # The action
     begin
-      @@parsed.originator.instance_eval &@@parsed.action
-    rescue
-      set_message "Task failed..."
+      do_exec_time do
+        @parsed.originator.instance_eval &@parsed.action
+      end
+    rescue Exception => e
+      set_message "#{e.message}\n#{e.backtrace.join("\n")}"
     ensure
       return stop
     end
@@ -42,12 +43,17 @@ module SpinningCursor
   #
   def stop
     begin
-      @@end = Time.now
-      @@elapsed = @@end - @@start
-
-      @@curs.kill
+      @curs.kill
+      # Wait for the cursor to die -- can cause problems otherwise
+      while @curs.alive? ; end
+      # 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 nil)
+      # Set parsed to nil so set_message method only works
+      # when cursor is actually running.
+      @parsed = nil
 
       # Return execution time
       get_exec_time
@@ -60,10 +66,10 @@ module SpinningCursor
   # Determines whether the cursor thread is still running
   #
   def alive?
-    if not defined? @@curs
+    if @curs.nil?
       return false
     else
-      @@curs.alive?
+      @curs.alive?
     end
   end
 
@@ -73,7 +79,7 @@ module SpinningCursor
   #
   def set_message(msg)
     begin
-      @@parsed.message msg
+      @parsed.message msg
     rescue NameError
       raise CursorNotRunning.new "Cursor isn't running... are you sure " +
         "you're calling this from an action block?"
@@ -85,7 +91,7 @@ module SpinningCursor
   #
   def set_banner(banner)
     begin
-      @@cursor.banner = banner
+      @cursor.banner = banner
     rescue NameError
       raise CursorNotRunning.new "Cursor isn't running... are you sure " +
         "you're calling this from an action block?"
@@ -96,14 +102,36 @@ module SpinningCursor
   # Retrieves execution time information
   #
   def get_exec_time
-    begin
-      return { :started => @@start, :finished => @@end,
-        :elapsed => @@elapsed }
-    rescue NameError
+    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

data/lib/spinning_cursor/cursor.rb

@@ -23,7 +23,7 @@ module SpinningCursor
     attr_accessor :banner
 
     #
-    # As of v0.1.0: only initializes the cursor class, use the print
+    # 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.
     #

data/spinning_cursor.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "spinning_cursor"
-  s.version = "0.1.0"
+  s.version = "0.1.2"
 
   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.date = "2012-04-25"
   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 = [
@@ -41,7 +41,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/Prydonius/spinning_cursor"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.21"
+  s.rubygems_version = "1.8.23"
   s.summary = "A DSL for adding animated loaders to your Ruby command line application."
 
   if s.respond_to? :specification_version then

data/test/test_exceptions.rb

@@ -17,10 +17,26 @@ class TestSpinningCursor < Test::Unit::TestCase
       end
     end
 
-    should "raise NoTaskError when getting execution time if no task ran" do
+    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
+      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
   end
 end

data/test/test_spinning_cursor.rb

@@ -9,7 +9,6 @@ class TestSpinningCursor < Test::Unit::TestCase
           action { sleep 1 }
         end
         # Give it some time to abort
-        sleep 0.1
         assert_equal false, SpinningCursor.alive?
       end
     end
@@ -63,7 +62,7 @@ class TestSpinningCursor < Test::Unit::TestCase
           end
         end
 
-        assert_equal true, (out.string.end_with? "Task failed...\n")
+        assert_equal true, (out.string.include? "An exception!")
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spinning_cursor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-10 00:00:00.000000000 Z
+date: 2012-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -153,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1396887062628828548
+      hash: 1437049553814384370
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A DSL for adding animated loaders to your Ruby command line application.