No commit activity in last 3 years
No release in over 3 years
Automatically open a screenshot when System Test fails.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.15
~> 5.0
>= 0
~> 10.0

Runtime

>= 5.1.0
 Project Readme

ScreenshotOpener

Build Status Gem Version

Automatically open a screenshot when System Test fails.

Rails' System Test gets screenshots automatically when the test fails and displays it on the terminal. However, its display is premised on iTerm, it will not be displayed on other terminals.

ScreenshotOpener should open a screenshot instead of displaying it on terminal.

Installation

Add this line to your application's Gemfile:

gem 'screenshot_opener'

And then execute:

$ bundle

Or install it yourself as:

$ gem install screenshot_opener

Usage

By default, it tries to open a file using xdg-open, gnome-open, or open commands. If you want to use other commands, please set as follows.

ScreenshotOpener.command = "xxx" # Specify command that you want to use.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/y-yagi/screenshot_opener. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the ScreenshotOpener project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.