https://github.com/sshaw/selfie_formatter

The RSpec Selfie Formatter: A Formatter that takes photos of you while your tests run and uses them to track progress and format the results.
https://github.com/sshaw/selfie_formatter

imagesnap photos rspec rspec-formatter ruby selfie-formatter selfies test

Last synced: about 2 months ago
JSON representation

The RSpec Selfie Formatter: A Formatter that takes photos of you while your tests run and uses them to track progress and format the results.

• Host: GitHub
• URL: https://github.com/sshaw/selfie_formatter
• Owner: sshaw
• License: mit
• Created: 2016-06-19T06:15:33.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-12-05T04:48:06.000Z (about 4 years ago)
• Last Synced: 2024-12-09T09:14:44.937Z (2 months ago)
• Topics: imagesnap, photos, rspec, rspec-formatter, ruby, selfie-formatter, selfies, test
• Language: Ruby
• Homepage:
• Size: 3.74 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# The RSpec Selfie Formatter

An RSpec Formatter for the new generation of programmers.

![Selfie Formatter Animation](example.gif)

The Selfie Formatter takes photos of you while your tests run and uses them to track

progress and format the results.

Currently only works on OS X with iTerm2 >= 3.0. **Warning** see [known issues](#known-issues).

## Installation

ImageMagick is required

```

brew install imagemagick --with-fontconfig

```

Then

```

gem install selfie_formatter

```

Or, in your `Gemfile`

```ruby

gem "selfie_formatter", :group => "test"

```

## Usage

```

rspec -f SelfieFormatter

```

## Known Issues

1. Slower tests. Yes, vanity has its price: the camera takes time to warm up, and a small sleep time is added prior to taking the each photo. At some point the sleep time

may be added as an option.

1. Photos are taken via [imagesnap](https://github.com/rharder/imagesnap), which is a fine program but can quickly eat up memory.

Upwards of 500 MB after 10 or 15 seconds.

1. Photos are taken every 300ms. Unused photos are cleaned up after every test completes but if a single test takes a while to

complete photos can start to eat up disk space.

At some point I may write something that does not [fake the `Camera` interface via `fork`](https://github.com/sshaw/selfie_formatter/blob/34f1999391695ce7633d79638a0903e1eb612e9e/lib/selfie/camera.rb). [imagesnap](https://github.com/rharder/imagesnap) and [CaptureCamera](https://github.com/fernyb/CaptureCamera) are good starting points.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).