spinning_cursor 0.2.0 → 0.2.1

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  # - jruby-18mode # JRuby in 1.8 mode
+  # - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+  - 1.8.7
+bundler_args: --without development
+script: bundle exec rake -f Rakefile.ci

data/CHANGELOG

@@ -1,6 +1,10 @@
 CHANGELOG
 ===============================================================================
 
+v0.2.1 (2013-07-28)
+  - Fix banner overflowing issue #19
+  - Ensure cross-platform support #22 #23
+
 v0.2.0 (2013-07-13)
   - Several bug fixes/internal API improvements (#4 #8 #9 #10 #11 #13)
   - Suppress output from action block (#7)

data/Gemfile

@@ -5,11 +5,19 @@ source "http://rubygems.org"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
+
+gem "highline", "~> 1.6.19"
+
 group :development do
-  gem "shoulda", ">= 0"
   gem "bundler", "~> 1.3.5"
   gem "jeweler", "~> 1.8.4"
   gem "yard", "~> 0.8.6.2"
   gem "redcarpet"
   gem "github-markup"
 end
+
+group :test do
+  gem "minitest", "~> 4.7", :require => "minitest/unit"
+  gem "rake"
+  gem "shoulda-context", ">= 0"
+end

data/Gemfile.lock

@@ -1,14 +1,7 @@
 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)
@@ -24,7 +17,6 @@ GEM
     hashie (2.0.5)
     highline (1.6.19)
     httpauth (0.2.0)
-    i18n (0.6.4)
     jeweler (1.8.6)
       builder
       bundler (~> 1.0)
@@ -42,6 +34,7 @@ GEM
     multi_xml (0.5.4)
     multipart-post (1.2.0)
     nokogiri (1.5.10)
+    nokogiri (1.5.10-x86-mingw32)
     oauth2 (0.9.2)
       faraday (~> 0.8)
       httpauth (~> 0.2)
@@ -54,24 +47,20 @@ GEM
     rdoc (4.0.1)
       json (~> 1.4)
     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
+  x86-mingw32
 
 DEPENDENCIES
   bundler (~> 1.3.5)
   github-markup
+  highline (~> 1.6.19)
   jeweler (~> 1.8.4)
+  minitest (~> 4.7)
+  rake
   redcarpet
-  shoulda
+  shoulda-context
   yard (~> 0.8.6.2)

data/README.md

@@ -10,6 +10,8 @@ Inspired by Chris Wanstrath's
 [Choice](https://github.com/defunkt/choice), Spinning Cursor provides
 you with a _sexy_ DSL for easy use of the library.
 
+[![Build Status](https://travis-ci.org/prydonius/spinning_cursor.png?branch=master)](https://travis-ci.org/prydonius/spinning_cursor)
+
 ## Installation
 
 As easy as RubyGems:

data/Rakefile.ci

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/spinning_cursor.rb

@@ -53,6 +53,13 @@ module SpinningCursor
   #
   def stop
     begin
+      @spinner.kill
+      # Wait for the cursor to die -- can cause problems otherwise
+      @spinner.join
+      # Set cursor to nil so set_banner method only works
+      # when cursor is actually running.
+      @cursor = nil
+
       restore_stdout_sync_status
       if console_captured?
         $console.print ESC_R_AND_CLR + $stdout.string
@@ -60,12 +67,6 @@ module SpinningCursor
       end
       show_cursor
 
-      @spinner.kill
-      # Wait for the cursor to die -- can cause problems otherwise
-      @spinner.join
-      # Set cursor to nil so set_banner method only works
-      # when cursor is actually running.
-      @cursor = nil
       reset_line
       puts @parsed.message
       # Set parsed to nil so set_message method only works

data/lib/spinning_cursor/console_helpers.rb

@@ -1,4 +1,5 @@
 require 'stringio'
+require 'highline/system_extensions'
 
 $console = STDOUT
 
@@ -7,7 +8,7 @@ module SpinningCursor
     if RUBY_PLATFORM =~ /(win|w)32$/
       # DOS
       # Contains a string to clear the line in the shell
-      CLR = "                                                               \r"
+      CLR = "#{(2..HighLine::SystemExtensions.terminal_size[0]).map{' '}.join}\r"
     else
       # Unix
       # Contains a string to clear the line in the shell
@@ -20,12 +21,39 @@ module SpinningCursor
     ESC_CURS_VIS   = "\e[?25h"
     # ANSI escape sequence for clearing line in terminal
     ESC_R_AND_CLR  = "\r#{CLR}"
+    # ANSI escape sequence for going up a line in terminal
+    ESC_UP_A_LINE  = "\e[1A"
+
+    @@prev = 0
 
     #
     # Manages line reset in the console
     #
     def reset_line(text = "")
-      $console.print "#{ESC_R_AND_CLR}#{text}"
+      # Initialise ANSI escape string
+      escape = ""
+
+      # Get terminal window width
+      cols = console_columns
+
+      # The number of lines the previous message spanned
+      lines = @@prev / cols
+
+      # If cols == 80 and @@prev == 80, @@prev / cols == 1 but we don't want to
+      # go up an extra line since it fits exactly
+      lines -= 1 if @@prev % cols == 0
+
+      # Clear and go up a line
+      lines.times { escape += "#{ESC_R_AND_CLR}#{ESC_UP_A_LINE}" }
+
+      # Clear the line that is to be printed on
+      escape += "#{ESC_R_AND_CLR}"
+
+      # Console is clear, we can print!
+      $console.print "#{escape}#{text}"
+
+      # Store the current message so we know how many lines it spans
+      @@prev = text.to_s.length
     end
 
     #
@@ -84,5 +112,12 @@ module SpinningCursor
     def show_cursor
       $console.print ESC_CURS_VIS
     end
+
+    #
+    # Returns the width of the terminal window
+    #
+    def console_columns
+      HighLine::SystemExtensions.terminal_size.first
+    end
   end
 end

data/lib/spinning_cursor/cursor.rb

@@ -19,7 +19,6 @@ module SpinningCursor
     #
     def spin
       $stdout.sync = true
-      $console.print @parsed.banner
       if @parsed.delay
         send @parsed.type, @parsed.delay
       else
@@ -51,9 +50,7 @@ module SpinningCursor
           $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}"
+        reset_line @parsed.banner.empty? ? char : "#{@parsed.banner} #{char}"
         sleep delay
       end
     end

data/spinning_cursor.gemspec

@@ -5,20 +5,20 @@
 
 Gem::Specification.new do |s|
   s.name = "spinning_cursor"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adnan Abdulhussein"]
-  s.date = "2013-07-13"
+  s.date = "2013-07-28"
   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"
+    "README.md"
   ]
   s.files = [
     ".document",
+    ".travis.yml",
     ".yardopts",
     "CHANGELOG",
     "Gemfile",
@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
     "LICENSE.txt",
     "README.md",
     "Rakefile",
-    "TODO",
+    "Rakefile.ci",
     "VERSION",
     "lib/spinning_cursor.rb",
     "lib/spinning_cursor/console_helpers.rb",
@@ -50,14 +50,14 @@ Gem::Specification.new do |s|
     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_runtime_dependency(%q<highline>, ["~> 1.6.19"])
       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<highline>, ["~> 1.6.19"])
       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"])
@@ -65,7 +65,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<github-markup>, [">= 0"])
     end
   else
-    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<highline>, ["~> 1.6.19"])
     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"])

data/test/helper.rb

@@ -1,14 +1,14 @@
 require 'rubygems'
 require 'bundler'
 begin
-  Bundler.setup(:default, :development)
+  Bundler.setup(:default, :development, :test)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
 require 'test/unit'
-require 'shoulda'
+require 'shoulda-context'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -26,7 +26,7 @@ def kill_other_threads
     th.join
   end
 end
- 
+
 module Kernel
   def capture_stdout
     SpinningCursor.capture_console

data/test/test_cursors.rb

@@ -1,83 +1,120 @@
 require 'helper'
 
 class TestSpinningCursorCursor < Test::Unit::TestCase
-  context "dots" do
-    parsed = Parser.new { type :dots; delay 0.2; banner ""}
-    delay = parsed.delay
-    should "change 'frames' with correct delay" do
+  context "SpinningCursor::ConsoleHelpers.reset_line" do
+    # get the current shell width
+    cols = SpinningCursor::ConsoleHelpers.console_columns
+    regex = Regexp.new(Regexp.escape("#{ESC_R_AND_CLR}#{ESC_UP_A_LINE}"))
+    should "not clear lines above if it fits within the width of the shell" do
+      # general case
       capture_stdout do |out|
-        dots = Thread.new do
-          SpinningCursor::Cursor.new(parsed).spin
+        SpinningCursor.start do
+          banner (1..cols-20).map { ('a'..'z').to_a[rand(26)] }.join
+          action { sleep 0.1 }
         end
-        # slight delay to get things started
-        sleep (delay/4.0)
-        buffer = "#{ESC_R_AND_CLR}" << "."
-        assert_equal buffer, out.string
+        assert_no_match regex, out.string
+      end
+    end
 
-        sleep delay
-        buffer << "#{ESC_R_AND_CLR}" << ".."
-        assert_equal buffer, out.string
+    should "not clear lines above if it fits exactly on the line (edge case)" do
+      capture_stdout do |out|
+        SpinningCursor.start do
+          # spinner type takes up two characters, so minus 2 to fit exactly
+          banner (1..cols-2).map { ('a'..'z').to_a[rand(26)] }.join
+          action { sleep 0.1 }
+        end
+        assert_no_match regex, out.string
+      end
+    end
 
-        sleep delay
-        buffer << "#{ESC_R_AND_CLR}" << "..."
-        assert_equal buffer, out.string
+    should "clear lines above if banner message overflows" do
+      capture_stdout do |out|
+        SpinningCursor.start do
+          # spinner type takes up two characters, so minus 2 to fit exactly
+          banner (1..400).map { ('a'..'z').to_a[rand(26)] }.join
+          action { sleep 0.1 }
+        end
+        assert_match regex, out.string
+      end
+    end
 
-        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
+    should "clear lines above if banner message overflows (edge case)" do
+      capture_stdout do |out|
+        SpinningCursor.start do
+          # spinner type takes up two characters, so minus 2 to fit exactly
+          banner (1..cols-1).map { ('a'..'z').to_a[rand(26)] }.join
+          action { sleep 0.1 }
+        end
+        assert_match regex, 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
+  context "dots" do
+    setup do
+      parsed = Parser.new { type :dots; delay 0.2; banner ""}
+      @delay = parsed.delay
+      $cycle_steps = []
+      $cycle_times = []
       capture_stdout do |out|
         spinner = Thread.new do
-          SpinningCursor::Cursor.new(parsed).spin
+          test_cursor = SpinningCursor::Cursor.new(parsed)
+          class << test_cursor
+            def reset_line(str)
+              $cycle_steps.push str
+              $cycle_times.push Time.now
+              Thread.current.kill if $cycle_times.size == 5
+            end
+          end
+          test_cursor.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
+        spinner.join
+      end
+    end
+
+    should "change 'frames' with correct delay" do
+      $cycle_times.each_cons(2) do |t1, t2|
+        interval = t2-t1
+        assert (interval > @delay and interval < (1.5 * @delay))
       end
     end
 
-    should "changes 'frames' with correct delay" do
+    should "cycle through correctly" do
+      assert_equal [".", "..", "...", "", "."], $cycle_steps
+    end
+  end
+
+  context "spinner" do
+    setup do
       parsed = Parser.new { type :spinner; delay 0.2; banner ""}
-      delay = parsed.delay
+      @delay = parsed.delay
+      $cycle_steps = []
+      $cycle_times = []
       capture_stdout do |out|
         spinner = Thread.new do
-          SpinningCursor::Cursor.new(parsed).spin
+          test_cursor = SpinningCursor::Cursor.new(parsed)
+          class << test_cursor
+            def reset_line(str)
+              $cycle_steps.push str
+              $cycle_times.push Time.now
+              Thread.current.kill if $cycle_times.size == 5
+            end
+          end
+          test_cursor.spin
         end
-        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
+        spinner.join
+      end
+    end
+
+    should "change 'frames' with correct delay" do
+      $cycle_times.each_cons(2) do |t1, t2|
+        interval = t2-t1
+        assert (interval > @delay and interval < (1.5 * @delay))
       end
     end
+
+    should "cycle through correctly" do
+      assert_equal ["|", "/", "-", "\\", "|"], $cycle_steps
+    end
   end
 end

data/test/test_spinning_cursor.rb

@@ -112,11 +112,9 @@ class TestSpinningCursor < Test::Unit::TestCase
             # Have to give it time to print the banners
             sleep 0.1
             assert_equal true, (out.string.include? "Loading"), "It should initialy show default banner"
-            sleep 0.1
             SpinningCursor.set_banner "Finishing up"
-            sleep 0.2
+            sleep 0.3
             assert_equal true, (out.string.include? "Finishing up"), "It should have changed banner"
-            sleep 0.1
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spinning_cursor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-13 00:00:00.000000000 Z
+date: 2013-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: highline
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.6.19
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.19
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -117,9 +117,9 @@ extensions: []
 extra_rdoc_files:
 - LICENSE.txt
 - README.md
-- TODO
 files:
 - .document
+- .travis.yml
 - .yardopts
 - CHANGELOG
 - Gemfile
@@ -127,7 +127,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- TODO
+- Rakefile.ci
 - VERSION
 - lib/spinning_cursor.rb
 - lib/spinning_cursor/console_helpers.rb
@@ -155,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2712039492645402918
+      hash: 699468937831844808
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/TODO

@@ -1,6 +0,0 @@
-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
-setup travis ci to test across different versions of ruby