nyan-cat-formatter 0.0.1 → 0.0.2

data/README.md

@@ -10,7 +10,7 @@ _-_-_-_-_-_-_-""  ""
 
 This is my take on the Nyan Cat RSpec Formatter. It simply creates a rainbow trail of test results. It also counts the number of examples as they execute and highlights failed and pending specs.
 
-The rainbow changes colors as it runs. See it in action [here](http://vimeo.com).
+The rainbow changes colors as it runs. See it in action [here](http://vimeo.com/32241727).
 
 ```
 rspec --format NyanCatFormatter
@@ -25,8 +25,25 @@ $ gem install nyan-cat-formatter
 
 If you want to use Nyan Cat as your default formatter, simply put the options in your .rspec file:
 
+```
 --format NyanCatFormatter
---color
+```
+
+Using with Rails rake spec
+----------
+
+To use Nyan Cat with Rails "rake spec" you need to add Nyan Cat dependecy in your Gemfile. 
+
+```
+group :test do
+  gem "nyan-cat-formatter"
+end
+```
+And then
+
+```
+bundle install
+```
 
 Contributing
 ----------

data/lib/nyan_cat_formatter.rb

@@ -3,19 +3,19 @@ require 'rspec/core/formatters/base_text_formatter'
 
 class NyanCatFormatter < RSpec::Core::Formatters::BaseTextFormatter
 
-  ESC     = "\e["
-  NND     = "#{ESC}0m"
-  PASS    = '='
-  FAIL    = '*'
-  ERROR   = '!'
-  PENDING = '·'
+  ESC      = "\e["
+  NND      = "#{ESC}0m"
+  PASS     = '='
+  PASS_ARY = ['-', '_']
+  FAIL     = '*'
+  ERROR    = '!'
+  PENDING  = '+'
 
-  attr_reader :title, :current, :example_results, :color_index
+  attr_reader :current, :example_results, :color_index
 
   def start(example_count)
     super(example_count)
-    @current, @color_index = 0,0
-    @bar_length = 70
+    @current, @color_index, @passing_count = 0,0,0
     @example_results = []
   end
 
@@ -49,70 +49,115 @@ class NyanCatFormatter < RSpec::Core::Formatters::BaseTextFormatter
   end
 
   def dump_failures
-    # noop
+    #no op
   end
 
   # Increments the example count and displays the current progress
   #
-  # Returns nothing
+  # @returns nothing
   def tick(mark = PASS)
     @example_results << mark
     @current =  (@current > @example_count) ? @example_count : @current + 1
-    @title = "  #{current}/#{example_count}"
     dump_progress
   end
 
   # Creates a rainbow trail
   #
-  # Returns the sprintf format of the Nyan cat
+  # @return [String] the sprintf format of the Nyan cat
   def nyan_trail
-    width =  percentage * @bar_length / 100
-    marker = @example_results.map{ |mark| highlight(mark) }.join
-    sprintf("%s#{nyan_cat}%s", marker, " " * (@bar_length - width) )
+    marks = @example_results.map{ |mark| highlight(mark) }
+    marks.shift(current_width - terminal_width) if current_width > terminal_width
+    nyan_cat_lines = nyan_cat.split("\n").each_with_index.map do |line, index|
+      format("%s#{line}", marks.join)
+    end.join("\n")
   end
 
-  # Calculates the percentage completed any given point
+  # Determine which Ascii Nyan Cat to display. If tests are complete,
+  # Nyan Cat goes to sleep. If there are failing or pending examples,
+  # Nyan Cat is concerned.
   #
-  # Returns Fixnum of the percentage
-  def percentage
-    @example_count.zero? ? 100 : @current * 100 / @example_count
-  end
-
-  # Ascii Nyan Cat. If tests are complete, Nyan Cat goes to sleep. If
-  # there are failing or pending examples, Nyan Cat is concerned.
-  #
-  # Returns String Nyan Cat
+  # @return [String] Nyan Cat
   def nyan_cat
     if @failure_count > 0 || @pending_count > 0
-      '~|_(o.o)'
+      ascii_cat('o')[@color_index%2].join("\n") #'~|_(o.o)'
     elsif (@current == @example_count)
-      '~|_(-.-)'
+      ascii_cat('-')[@color_index%2].join("\n") # '~|_(-.-)'
     else
-      '~|_(^.^)'
+      ascii_cat('^')[@color_index%2].join("\n") # '~|_(^.^)'
     end
   end
 
   # Displays the current progress in all Nyan Cat glory
   #
+  # @return nothing
   def dump_progress
-    max_width = 80
-    line  = sprintf("%-8s %s", @title[0,(7)] + ":", nyan_trail)
-    tail  = (@current == @example_count) ? "\n" : "\r"
-
-    if line.length == max_width - 1
-      output.print line + tail
-      output.flush
-    elsif line.length >= max_width
-      @bar_length = [@bar_length - (line.length - max_width + 1), 0].max
-      @bar_length == 0 ? output.print( rainbowify(line + tail) ) : dump_progress
-    else
-      @bar_length += max_width - line.length + 1
-      dump_progress
-    end
+    padding = @example_count.to_s.length * 2 + 2
+    line = nyan_trail.split("\n").each_with_index.inject([]) do |result, (trail, index)|
+      value = "#{scoreboard[index]}/#{@example_count}:"
+      result << format("%s %s", value, trail)
+    end.join("\n")
+    output.print line + eol
+  end
+
+  # Determines how we end the trail line. If complete, return a newline etc.
+  #
+  # @return [String]
+  def eol
+    return "\n" if @current == @example_count
+    length = (nyan_cat.split("\n").length - 1)
+    length > 0 ? format("\e[1A" * length + "\r") : "\r"
+  end
+
+  # Calculates the current flight length
+  #
+  # @return [Fixnum]
+  def current_width
+    padding    = @example_count.to_s.length * 2 + 6
+    cat_length = nyan_cat.split("\n").group_by(&:size).max.first
+    padding    + @current + cat_length
+  end
+
+  # A Unix trick using stty to get the console columns
+  # does not work in JRuby :-(
+  #
+  # @return [Fixnum]
+  def terminal_width
+    @terminal_width ||= `stty size`.split.map { |x| x.to_i }.reverse.first - 1
+  end
+
+  # Creates a data store of pass, failed, and pending example results
+  # We have to pad the results here because sprintf can't properly pad color
+  #
+  # @return [Array]
+  def scoreboard
+    padding = @example_count.to_s.length + 9
+    [ @current.to_s.rjust( @example_count.to_s.length),
+      green(@current - @pending_examples.size - @failed_examples.size).rjust(padding),
+      yellow(@pending_examples.size).rjust(padding),
+      red(@failed_examples.size).rjust(padding) ]
+  end
+
+  # Ascii version of Nyan cat. Two cats in the array allow Nyan to animate running.
+  #
+  # @param o [String] Nyan's eye
+  # @return [Array] Nyan cats
+  def ascii_cat(o = '^')
+    [[ "_,------,   ",
+        "_|  /\\_/\\ ",
+        "~|_( #{o} .#{o})  ",
+        " \"\"  \"\" "
+      ],
+      [ "_,------,   ",
+        "_|   /\\_/\\",
+        "^|__( #{o} .#{o}) ",
+        "  \"\"  \"\"    "
+      ]]
   end
 
   # Colorizes the string with raindow colors of the rainbow
   #
+  # @params string [String]
+  # @return [String]
   def rainbowify(string)
     c = colors[@color_index % colors.size]
     @color_index += 1
@@ -121,6 +166,7 @@ class NyanCatFormatter < RSpec::Core::Formatters::BaseTextFormatter
 
   # Calculates the colors of the rainbow
   #
+  # @return [Array]
   def colors
     @colors ||= (0...(6 * 7)).map do |n|
       pi_3 = Math::PI / 3
@@ -135,12 +181,13 @@ class NyanCatFormatter < RSpec::Core::Formatters::BaseTextFormatter
   # Determines how to color the example.  If pass, it is rainbowified, otherwise
   # we assign red if failed or yellow if an error occurred.
   #
+  # @return [String]
   def highlight(mark = PASS)
     case mark
-      when PASS;  rainbowify mark
-      when FAIL;  red mark
-      when ERROR; yellow mark
-      else mark
+    when PASS;  rainbowify PASS_ARY[@color_index%2]
+    when FAIL;  red mark
+    when ERROR; yellow mark
+    else mark
     end
   end
 

data/nyan-cat-formatter.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "nyan-cat-formatter"
-  s.version     = "0.0.1"
+  s.version     = "0.0.2"
   s.authors     = ["Matt Sears"]
   s.email       = ["matt@mattsears.com"]
   s.homepage    = ""

data/spec/nyan_cat_formatter_spec.rb

@@ -8,7 +8,7 @@ describe NyanCatFormatter do
     @formatter = NyanCatFormatter.new(@output)
     @formatter.start(2)
     @example = RSpec::Core::ExampleGroup.describe.example
-    sleep(0.2)  # Just to slow it down a little :-)
+    sleep(0.1)  # Just to slow it down a little :-)
   end
 
   describe 'passed, pending and failed' do
@@ -26,7 +26,15 @@ describe NyanCatFormatter do
 
       it 'should relax Nyan Cat' do
         @formatter.example_passed(@example)
-        @formatter.nyan_cat.should == '~|_(^.^)'
+        @formatter.nyan_cat.should == [ "_,------,   ",
+          "_|  /\\_/\\ ",
+          "~|_( ^ .^)  ",
+          " \"\"  \"\" "
+        ].join("\n")
+      end
+
+      it 'should update the scoreboard' do
+        @formatter.scoreboard.size.should == 4
       end
 
     end
@@ -45,7 +53,11 @@ describe NyanCatFormatter do
 
       it 'should alert Nyan Cat' do
         @formatter.example_pending(@example)
-        @formatter.nyan_cat.should == '~|_(o.o)'
+        @formatter.nyan_cat.should == [ "_,------,   ",
+          "_|  /\\_/\\ ",
+          "~|_( o .o)  ",
+          " \"\"  \"\" "
+        ].join("\n")
       end
 
     end
@@ -64,7 +76,11 @@ describe NyanCatFormatter do
 
       it 'should alert Nyan Cat' do
         @formatter.example_failed(@example)
-        @formatter.nyan_cat.should == '~|_(o.o)'
+        @formatter.nyan_cat.should == [ "_,------,   ",
+          "_|  /\\_/\\ ",
+          "~|_( o .o)  ",
+          " \"\"  \"\" "
+        ].join("\n")
       end
 
     end
@@ -78,14 +94,6 @@ describe NyanCatFormatter do
       @formatter.tick
     end
 
-    it 'should change title' do
-      @formatter.title.should == '  1/2'
-    end
-
-    it 'should calculate the percentage done' do
-      @formatter.percentage.should == 50
-    end
-
     it 'should increment the current' do
       @formatter.current.should == 1
     end
@@ -107,7 +115,7 @@ describe NyanCatFormatter do
   describe 'highlight' do
 
     it 'should rainbowify passing examples' do
-      @formatter.highlight('=').should == "\e[38;5;154m=\e[0m"
+      @formatter.highlight('=').should == "\e[38;5;154m-\e[0m"
     end
 
     it 'should mark failing examples as red' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nyan-cat-formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-15 00:00:00.000000000 Z
+date: 2011-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70257566354640 !ruby/object:Gem::Requirement
+  requirement: &70218576415240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70257566354640
+  version_requirements: *70218576415240
 description: ! 'Nyan Cat inspired RSpec formatter! '
 email:
 - matt@mattsears.com