Emoji-RSpec

A set of emoji based RSpec formatters for use with test output.

Installation

Note: Stuck on Ruby 1.8.7? 😬 See 0.x version end of life note.

Add this line to your application's Gemfile:

group :test do
  gem 'emoji-rspec'
end

And then execute:

$ bundle

Or install it yourself as:

$ gem install emoji-rspec

If you want to always have it included, add it to the top of your .rspec file:

# .rspec
--require emoji-rspec

Usage

If not using the .rspec file method, you will need to manually include emoji-rspec on the command line when you call rspec:

$ rspec --require emoji-rspec --format smiles

Formatters

Adventure Time

WARNING: This is crazy, but then that's the idea if you've seen the show. You take full responsibility for any insanity caused by this formatter.

Pass: 💖 ⭐ 🌟 💫 ✨ 👸 :person_with_blond_hair: 🐕 💝

Fail: 👿 😈 💢 💥 👹 👺 💩 🐲

Pending: 👽 📱 💊 🎲 🎒 🐧 🔦 👾

This can be used with the following --format names:

• adventure
• adventure_time
• adventuretime
• EmojiTestLove::AdventureTimeFormatter

Aggressive Thumbs

See also Thumbs

Pass: 👌

Fail: 👊

Pending: ✊

This can be used with the following --format names:

• aggressive_thumbs
• aggressivethumbs
• EmojiTestLove::AggressiveThumbsFormatter

Books

Pass: 📗

Fail: 📕

Pending: 📙

This can be used with the following --format names:

• books
• reading_rainbow
• EmojiTestLove::BooksFormatter

Celebrate

Similar to Kanpai and Drinking Game. Here you get to celebrate your hard work when your tests pass. Have a 🍺 and cheers with friends 🍻.

Pass: 🍻 (cheers with friends / pair programmer)

Fail: ☕ (oops maybe too many 🍺, have some coffee)

Pending: 🍕 (still work to do, have some nom noms)

This can be used with the following --format names:

• celebrate
• celebration
• cheers
• EmojiTestLove::CelebrateFormatter

Drinking Game

See also Celebrate and Kanpai

Ever have that late night coding session? Now you can do it in style.

This is the one time that we do not advise you write failing tests first!

Also we advise that you turn on fail fast during these sessions:

RSpec.configure{ |c| c.fail_fast = true }

Or if you prefer the command line persuasion: --fail-fast

Now without further delay

Pass: ☕

Fail: 🍸 (gulp of a mixed drink or a shot)

Pending: 🍺 (gulp of beer)

This can be used with the following --format names:

• drinking
• drinking_game
• drinkingame
• EmojiTestLove::DrinkingGameFormatter

If coffee isn't your thing, there is a tea version too.

Pass: 🍵

Fail: 🍸 (gulp of a mixed drink or a shot)

Pending: 🍺 (gulp of beer)

This can be used with the following --format names:

• drinking_tea
• drinkingtea
• drinking_game_tea
• drinkinggametea
• EmojiTestLove::DrinkingGameTeaFormatter

Fruit

Pass: 🍏

Fail: 🍅

Pending: 🍋

This can be used with the following --format names:

• apples
• fruit
• EmojiTestLove::FruitFormatter

Kanpai

Similar to Celebrate and Drinking Game. Here you get to celebrate your hard work when your tests pass. So lift some 🍶 and 'Kanpai!'.

Pass: 🍶 ("Kanpai!" with friends / pair programmer)

Fail: 🍵 (oops maybe too much 🍶, have some green tea)

Pending: 🍣 (still work to do, have some nom noms)

This can be used with the following --format names:

• kanpai
• 乾杯
• EmojiTestLove::KanpaiFormatter

Life Hearts

Pass: 💚

Fail: 💔

Pending: 💛

This can be used with the following --format names:

• hearts
• life
• life_hearts
• lifehearts
• EmojiTestLove::LifeHeartsFormatter

Lucky

Pass: 🍀

Fail: 🍄

Pending: 🌰

This can be used with the following --format names:

• lucky
• EmojiTestLove::LuckyFormatter

Omkase

I wish Apple had more emoji to make this one a bit more interesting.

Pass: 🍡

Fail: 🍘

Pending: 🍥

This can be used with the following --format names:

• omkase
• お任せ
• EmojiTestLove::OmkaseFormatter

Smile Dip

Pass: 🍭

Fail: 👻

Pending: 🐬 (aoshima)

This can be used with the following --format names:

• smile_dip
• smiledip
• fun_dip
• fundip
• aoshima
• EmojiTestLove::SmileDipFormatter

Smiles

Pass: 😊

Fail: 😡

Pending: 😬

This can be used with the following --format names:

• smiles
• EmojiTestLove::SmileyFacesFormatter

Sunshine

Pass: ☀️

Fail: ☔

Pending: ☁️

This can be used with the following --format names:

• sunshine
• sunny
• EmojiTestLove::SunshineFormatter

Turtles

Pass: 🐢

Fail: 🪲

Pending: 🐌

This can be used with the following --format names:

• turtles
• turtles_all_the_way_down
• all_the_way_down
• EmojiTestLove::TurtlesFormatter

Thumbs

See also Aggressive Thumbs

Pass: 👍

Fail: 👎

Pending: ✋

This can be used with the following --format names:

• thumbs
• EmojiTestLove::ThumbsFormatter

Waddles

Pass: 🐷

Fail: 🐛

Pending: 🌱

This can be used with the following --format names:

• waddles
• EmojiTestLove::WaddlesFormatter

Zen Smiles

Pass: 😑

Fail: 😞

Pending: 😔

This can be used with the following --format names:

• zen
• zen_smiles
• zensmiles
• EmojiTestLove::ZenSmilesFormatter

Bugs, Issues, and Suggestions

Please submit them here https://github.com/cupakromer/emoji-rspec/issues

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Versions

1.x

The current main release. Full support for 2.0.0, with some backwards support for 1.9.2 and 1.9.3.

0.x

This has reached end of life. Further improvements will only be on the 1.x line. Pull Requests will be welcome on this branch, but new formatters will not be added. If you submit a PR for this, please maintain 1.8.7 support.

Copyright / License

Copyright (c) 2012 Aaron Kromer, released under the MIT License.

See LICENSE for details.