rspec_skel: Минимальный каркас проекта с RSpec

👉Страница проекта на GitHub

Домашняя страница данного проекта находится на GitHub: dadooda/rspec_skel. Все ссылки ведут туда же.

Что это?

Это — минимальный проект на чистом Ruby с готовым к работе RSpec. Хорошо подходит в качестве стартовой точки для опытов с тестами на любой ОС, версии Ruby или самого RSpec.

Установка

💡 Предполагается, что Git у вас есть.

Клонируем репозиторий:

git clone git@github.com:dadooda/rspec_skel.git

Ставим gems:

bundle install

Редактируем .gitignore. Удаляем из него две строки:

# REMOVE this comment and the line following it …
/Gemfile.lock

Убираем связь с каркасным репозиторием и инициализируем свой:

rm -rf .git &&
git init

Применение

💡 Предполагается, что Ruby у вас есть.

Исходники классов находятся в lib/. RSpec-тесты находятся в spec/.

Запускаем RSpec

bundle exec rspec

С информацией о покрытии:

SPEC_COV=! bundle exec rspec

Генерируем YARD-документацию

bundle exec yard

Документация генерится в doc/. Открываем doc/index.html и читаем.

Расширения shell

В состав проекта входят расширения для Unix-шелла, которые могут оказаться полезными. Расширения находятся в shell/. Чтобы загрузить их, выполняем команду:

. shell/all.sh

⚠️ На данный момент поддерживается только Bash.

Краткое описание расширений:

Команда	Файл	Действие
`b`	`bundler.sh`	Сокращение для `bundle`.
`bx`	`bundler.sh`	Сокращение для `bundle exec`.
`cov`	`rspec.sh`	Запускаем `sp` с генерацией информации о покрытии.
`rc`	`rg.sh`	`rg` с цветами и нужными опциями.
`sp`	`rspec.sh`	Запускаем RSpec-тесты, имена файлов которых соответствуют выражению Egrep.

Приглашаю к соавторству

Присылайте свои дополнения. Сделайте fork и предложите ваши изменения через pull request, или напишите мне письмо.

Помогите распространить

Если вы пользуетесь продуктом, поставьте звёдочку⭐, расскажите другу, упомяните в соцсетях. Совершенно нет времени на саморекламу. Буду рад, если продукт принесёт пользу большему количеству добрых людей.

Copyright

Продукт распространяется свободно на условиях лицензии MIT.