ChuckTestar 0.0.1

data/README.md

@@ -0,0 +1,33 @@
+# Chuck testr RSpec formatter
+
+The gem is a game changer... Nope! It's just **Chuck Testar - Chuck's Testa RSpec formatter**
+
+## Requirements
+
+It requires only `rspec` gem, obviously.
+
+## Installation
+
+If you are using bundler, add this to your `Gemfile`:
+
+    gem 'ChuckTestar'
+
+Or install the gem manually with `gem install ChuckTestar`.
+
+## Usage
+
+To start using the formatter you can either specify it in the rspec's command line options or add it to `.rspec` file:
+
+- With `.rspec` file
+
+Add this line to your `.rspec` file:
+
+    --format ChuckTestar
+
+- With command line options
+
+    rspec spec/* --format ChuckTestar
+
+## License
+ChuckTestar is released under the MIT license
+

data/chuck_testar.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'bundler'
+
+Gem::Specification.new do |s|
+  s.name        = "ChuckTestar"
+  s.version     = '0.0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mariusz Lusiak"]
+  s.email       = ["mariusz@applicake.com"]
+  s.homepage    = "http://applicake.com"
+  s.summary     = %q{Chuck Testar Formatter for RSpec}
+  s.description = %q{}
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_runtime_dependency 'rspec'
+  s.add_runtime_dependency 'growl_notify' if RbConfig::CONFIG['host_os'] =~ /darwin/
+
+  s.files = %w( README.md chuck_testar.gemspec ) + Dir["lib/**/*.rb"] + Dir["assets/*.png"]
+  s.test_files = Dir["spec/**/*.rb"]
+  s.require_paths = ["lib"]
+end

data/lib/chuck_testar.rb

@@ -0,0 +1,128 @@
+require 'rspec/core/formatters/base_text_formatter'
+require 'notifications/growl' if RbConfig::CONFIG['host_os'] =~ /darwin/
+
+module ChuckTesta
+  class GnomeNotify
+    attr_accessor :title, :description, :icon
+
+    def initialize params={}
+      params.each { |k,v| send("#{k}=", v) }
+    end
+
+    def build_params
+      "-i #{icon} \"#{title}\" \"#{description}\""
+    end
+
+    def notify!
+      installed? ? `notify-send #{build_params}` : print_hint
+    end
+
+    def installed?
+      `which notify-send`.empty? ? false : true
+    end
+
+    private
+    def print_hint
+      `echo hint: sudo apt-get install libnotify-bin to see Chuck on your Desktop!`
+    end
+  end
+
+  module Portable
+    def self.platform
+      if RbConfig::CONFIG['host_os'] =~ /mswin|windows|cygwin/i
+        'windows'
+      elsif RbConfig::CONFIG['host_os'] =~ /darwin/
+        'osx'
+      else
+        'linux'
+      end
+    end
+
+    def self.linux?
+      ChuckTesta::Portable::platform == 'linux'
+    end
+
+    def self.osx?
+      ChuckTesta::Portable::platform == 'osx'
+    end
+  end
+end
+
+
+
+class ChuckTestar < RSpec::Core::Formatters::BaseTextFormatter
+
+  def icon(name)
+    File.join(File.dirname(__FILE__), '../assets', name)
+  end
+
+  def notify(text, icon_filename)
+    notification = {
+      :title => 'RSpec',
+      :description => text,
+      :icon => icon(icon_filename)
+    }
+
+    unless ChuckTesta::Portable::linux?
+      GrowlNotify.normal(notification)
+    else
+      notifier = ChuckTesta::GnomeNotify.new(notification)
+      notifier.notify!
+    end
+  end
+
+  def say(text)
+    if ChuckTesta::Portable.platform == 'linux'
+      `echo "#{text}" | espeak 2>/dev/null`
+    elsif ChuckTesta::Portable.platform == 'osx'
+      `say "#{text}"`
+    end
+  end
+
+  def notify_with_voice!(text, icon_filename)
+    notify(text, icon_filename)
+    say(text)
+  end
+
+  def delay(seconds)
+    sleep(seconds)
+  end
+
+  def start(example_count)
+    super(example_count)
+    output.print green('Y')
+  end
+
+  def stop
+    output.print green('p')
+    output.print green("\n\nYour tests pass!\n")
+    notify_with_voice!('Your tests pass', 'chuck-normal.png')
+    delay(2)
+    if @failed_examples.length > 0
+      output.print magenta("\n\nNope! It's just Chuck Testa!")
+      notify_with_voice!("Nope! It\'s just Chuck Testa!", 'chuck-nope.png')
+      delay(1)
+    end
+  end
+
+  def example_passed(example)
+    super(example)
+    output.print green('e')
+  end
+
+  def example_pending(example)
+    super(example)
+    output.print green('e')
+  end
+
+  def example_failed(example)
+    super(example)
+    output.print green('e')
+  end
+
+  def start_dump
+    super()
+    output.puts
+  end
+end
+

data/lib/notifications/growl.rb

@@ -0,0 +1,11 @@
+begin
+  require "growl_notify"
+
+  GrowlNotify.config do |config|
+    config.notifications = ["Chuck Testar"]
+    config.default_notifications = ["Chuck Testar"]
+    config.application_name = "Chuck Testar RSpec formatter" # this shoes up in the growl applications list in systems settings
+  end
+rescue LoadError
+    puts "Please install growl_notify gem to enable growl notifications"
+end

data/spec/chuck_testar_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe ChuckTestar do
+  let(:output)    { StringIO.new }
+  let(:formatter) { ChuckTestar.new(output) }
+
+  before do
+    formatter.stub(:delay => true)
+  end
+
+  describe "output" do
+    let(:example) {
+      double("example 1",
+       :execution_result => {:status => 'failed', :exception => Exception.new }
+      )
+    }
+
+    it "displays 'Y' at the start of the suite" do
+      formatter.start(1)
+      output.string.should =~ /Y/
+    end
+
+    it "displays 'e' when examples pass" do
+      formatter.example_passed(example)
+      output.string.should =~ /e/
+    end
+
+    it "displays 'e' when examples fails" do
+      formatter.example_failed(example)
+      output.string.should =~ /e/
+    end
+
+    it "displays 'p' at the end of tests suite" do
+      formatter.stub(:notify_with_voice! => true)
+      formatter.stop
+      output.string.should =~ /p/
+    end
+  end
+
+  describe "notifications" do
+    before do
+      formatter.stub(:say => true)
+    end
+
+    if ChuckTesta::Portable::osx?
+      it "display growl success notification when spec pass" do
+        formatter.example_passed(example)
+        GrowlNotify.should_receive(:normal).with(:title => 'RSpec', :description => 'Your tests pass', :icon => formatter.icon('chuck-normal.png'))
+        formatter.stop
+      end
+
+      it "display growl success and fail notifications when spec fail" do
+        formatter.example_failed(example)
+        GrowlNotify.should_receive(:normal).with(:title => 'RSpec', :description => 'Your tests pass', :icon => formatter.icon('chuck-normal.png'))
+        GrowlNotify.should_receive(:normal).with(:title => 'RSpec', :description => "Nope! It's just Chuck Testa!", :icon => formatter.icon('chuck-nope.png'))
+        formatter.stop
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+#require 'simplecov'
+#SimpleCov.start
+
+require 'rubygems'
+require 'spork'
+
+Spork.prefork do
+  $:.unshift File.expand_path('../../lib', __FILE__)
+
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup
+  require 'rspec'
+  Dir[File.join(File.expand_path('../', __FILE__), "support/**/*.rb")].each do |file|
+    require file
+  end
+
+  require 'chuck_testar'
+end
+
+Spork.each_run do
+
+end
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: ChuckTestar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mariusz Lusiak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70164759505860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70164759505860
+- !ruby/object:Gem::Dependency
+  name: growl_notify
+  requirement: &70164759504460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70164759504460
+description: ''
+email:
+- mariusz@applicake.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- chuck_testar.gemspec
+- lib/chuck_testar.rb
+- lib/notifications/growl.rb
+- assets/chuck-nope.png
+- assets/chuck-normal.png
+- spec/chuck_testar_spec.rb
+- spec/spec_helper.rb
+homepage: http://applicake.com
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Chuck Testar Formatter for RSpec
+test_files:
+- spec/chuck_testar_spec.rb
+- spec/spec_helper.rb