nyan-cat-formatter 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format NyanCatFormatter

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@nyan-cat-formatter@nyan-cat-formatter --create

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in nyan-cat-formatter.gemspec
+gemspec

data/README.md

@@ -0,0 +1,45 @@
+Nyan Cat RSpec Formatter
+========
+
+```
+-_-_-_-_-_-_-_,------,
+_-_-_-_-_-_-_-|   /\_/\
+-_-_-_-_-_-_-~|__( ^ .^)
+_-_-_-_-_-_-_-""  ""
+```
+
+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).
+
+```
+rspec --format NyanCatFormatter
+```
+
+Installing Nyan Cat
+----------
+
+```
+$ 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
+
+Contributing
+----------
+
+Once you've made your great commits:
+
+1. Fork Nyan Cat
+2. Create a topic branch - git checkout -b my_branch
+3. Push to your branch - git push origin my_branch
+4. Create a Pull Request from your branch
+5. That's it!
+
+Author
+----------
+[Matt Sears](https://wwww.mattsears.com) :: @mattsears
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/lib/nyan_cat_formatter.rb

@@ -0,0 +1,148 @@
+# -*- coding: utf-8 -*-
+require 'rspec/core/formatters/base_text_formatter'
+
+class NyanCatFormatter < RSpec::Core::Formatters::BaseTextFormatter
+
+  ESC     = "\e["
+  NND     = "#{ESC}0m"
+  PASS    = '='
+  FAIL    = '*'
+  ERROR   = '!'
+  PENDING = '·'
+
+  attr_reader :title, :current, :example_results, :color_index
+
+  def start(example_count)
+    super(example_count)
+    @current, @color_index = 0,0
+    @bar_length = 70
+    @example_results = []
+  end
+
+  def example_passed(example)
+    super(example)
+    tick PASS
+  end
+
+  def example_pending(example)
+    super(example)
+    @pending_count =+1
+    tick PENDING
+  end
+
+  def example_failed(example)
+    super(example)
+    @failure_count =+1
+    tick FAIL
+  end
+
+  def start_dump
+    @current = @example_count
+  end
+
+  def dump_summary(duration, example_count, failure_count, pending_count)
+    dump_profile if profile_examples? && failure_count == 0
+    summary = "\nNyan Cat flew #{format_seconds(duration)} seconds".split(//).map { |c| rainbowify(c) }
+    output.puts summary.join
+    output.puts colorise_summary(summary_line(example_count, failure_count, pending_count))
+    dump_commands_to_rerun_failed_examples
+  end
+
+  def dump_failures
+    # noop
+  end
+
+  # Increments the example count and displays the current progress
+  #
+  # 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
+  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) )
+  end
+
+  # Calculates the percentage completed any given point
+  #
+  # 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
+  def nyan_cat
+    if @failure_count > 0 || @pending_count > 0
+      '~|_(o.o)'
+    elsif (@current == @example_count)
+      '~|_(-.-)'
+    else
+      '~|_(^.^)'
+    end
+  end
+
+  # Displays the current progress in all Nyan Cat glory
+  #
+  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
+  end
+
+  # Colorizes the string with raindow colors of the rainbow
+  #
+  def rainbowify(string)
+    c = colors[@color_index % colors.size]
+    @color_index += 1
+    "#{ESC}38;5;#{c}m#{string}#{NND}"
+  end
+
+  # Calculates the colors of the rainbow
+  #
+  def colors
+    @colors ||= (0...(6 * 7)).map do |n|
+      pi_3 = Math::PI / 3
+      n *= 1.0 / 6
+      r  = (3 * Math.sin(n           ) + 3).to_i
+      g  = (3 * Math.sin(n + 2 * pi_3) + 3).to_i
+      b  = (3 * Math.sin(n + 4 * pi_3) + 3).to_i
+      36 * r + 6 * g + b + 16
+    end
+  end
+
+  # Determines how to color the example.  If pass, it is rainbowified, otherwise
+  # we assign red if failed or yellow if an error occurred.
+  #
+  def highlight(mark = PASS)
+    case mark
+      when PASS;  rainbowify mark
+      when FAIL;  red mark
+      when ERROR; yellow mark
+      else mark
+    end
+  end
+
+end
+

data/nyan-cat-formatter.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "nyan-cat-formatter"
+  s.version     = "0.0.1"
+  s.authors     = ["Matt Sears"]
+  s.email       = ["matt@mattsears.com"]
+  s.homepage    = ""
+  s.summary     = %q{Nyan Cat inspired RSpec formatter! }
+  s.description = %q{Nyan Cat inspired RSpec formatter! }
+
+  s.rubyforge_project = "nyan-cat-formatter"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+end

data/spec/nyan_cat_formatter_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+require 'stringio'
+
+describe NyanCatFormatter do
+
+  before do
+    @output = StringIO.new
+    @formatter = NyanCatFormatter.new(@output)
+    @formatter.start(2)
+    @example = RSpec::Core::ExampleGroup.describe.example
+    sleep(0.2)  # Just to slow it down a little :-)
+  end
+
+  describe 'passed, pending and failed' do
+
+    before do
+      @formatter.stub!(:tick)
+    end
+
+    describe 'example_passed' do
+
+      it 'should call the increment method' do
+        @formatter.should_receive :tick
+        @formatter.example_passed(@example)
+      end
+
+      it 'should relax Nyan Cat' do
+        @formatter.example_passed(@example)
+        @formatter.nyan_cat.should == '~|_(^.^)'
+      end
+
+    end
+
+    describe 'example_pending' do
+
+      it 'should call the tick method' do
+        @formatter.should_receive :tick
+        @formatter.example_pending(@example)
+      end
+
+      it 'should increment the pending count' do
+        lambda { @formatter.example_pending(@example)}.
+          should change(@formatter, :pending_count).by(1)
+      end
+
+      it 'should alert Nyan Cat' do
+        @formatter.example_pending(@example)
+        @formatter.nyan_cat.should == '~|_(o.o)'
+      end
+
+    end
+
+    describe 'example_failed' do
+
+      it 'should call the increment method' do
+        @formatter.should_receive :tick
+        @formatter.example_failed(@example)
+      end
+
+      it 'should increment the failure count' do
+        lambda { @formatter.example_failed(@example)}.
+          should change(@formatter, :failure_count).by(1)
+      end
+
+      it 'should alert Nyan Cat' do
+        @formatter.example_failed(@example)
+        @formatter.nyan_cat.should == '~|_(o.o)'
+      end
+
+    end
+  end
+
+  describe 'tick' do
+
+    before do
+      @formatter.stub!(:current).and_return(1)
+      @formatter.stub!(:example_count).and_return(2)
+      @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
+
+    it 'should store the marks in an array' do
+      @formatter.example_results.should include('=')
+    end
+
+  end
+
+  describe 'rainbowify' do
+
+    it 'should increment the color index count' do
+      lambda { @formatter.rainbowify('=') }.should change(@formatter, :color_index).by(1)
+    end
+
+  end
+
+  describe 'highlight' do
+
+    it 'should rainbowify passing examples' do
+      @formatter.highlight('=').should == "\e[38;5;154m=\e[0m"
+    end
+
+    it 'should mark failing examples as red' do
+      @formatter.highlight('*').should == "\e[31m*\e[0m"
+    end
+
+    it 'should mark pending examples as yellow' do
+      @formatter.highlight('!').should == "\e[33m!\e[0m"
+    end
+
+  end
+
+  describe 'start' do
+
+    it 'should set the total amount of specs' do
+      @formatter.example_count.should == 2
+    end
+
+    it 'should set the current to 0' do
+      @formatter.current.should == 0
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'nyan_cat_formatter'

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: nyan-cat-formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matt Sears
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70257566354640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70257566354640
+description: ! 'Nyan Cat inspired RSpec formatter! '
+email:
+- matt@mattsears.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- lib/nyan_cat_formatter.rb
+- nyan-cat-formatter.gemspec
+- spec/nyan_cat_formatter_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: nyan-cat-formatter
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Nyan Cat inspired RSpec formatter!
+test_files:
+- spec/nyan_cat_formatter_spec.rb
+- spec/spec_helper.rb