Рельсовый Гамбит (Rails Gambit)

Rails Gambit — это образовательный проект по реализации онлайн платформы для совместной игры в шахматы и не только. Он создан с целью изучения Ruby on Rails студентами. Упор делается на применение передовых подходов в современной веб-разработке, погружение в процесс "на всю глубину" включая обслуживание серверов, доставку продуктового кода и популяризацию шахмат.

Планы, возможности, фичи (To Do)

• Регистрация/Авторизация
• Профиль игрока
• Рейтинг игрока
• Шахматные упражения
• Панель администратора
• Сетевая игра вдвоём
• Загрузка/Выгрузка PGN и FEN
• Сохранение истории партии
• Чат
• Приглашения
• Авторизация через VKontakte
• Авторизация через Google

Инфраструктура разработки и эксплуатации (Infrastructure)

Подробнее в INFRASTRUCTURE.md.

Зависимости (Requirements)

• Ruby
• Node.js
• Yarn
• Bundler
• PostgreSQL
• Redis
• Docker
• VS Code или RubyMine

С чего начать? (Beginners Guide)

Если вы мало знакомы с языком Ruby, то можете подчерпнуть знаний из следующих источников:

• Getting Started with Rails — официальный гайд от разработчиков Ruby on Rails. Пошаговое создание простенького блога со статьями и комментариями. Есть русская версия от комьюнити, но там может быть устаревшая версия гайда.
• Ruby on Rails 6/7: уроки — плейлист с хорошими уроками по Ruby on Rails на русском языке.
• Turbo Rails Tutorial — гайд по Hotwire, которые используются для обновления данных на странице без её перезагрузки.
• Codewars — сайт с задачками по различным языкам программирования, в том числе и по Ruby.

Запуск (Install)

1. Устанавливаем зависимости приложения:

   bundle install
   yarn install

2. Настраиваем доступ к БД через переменные окружения в файлах database.yml и cable.yml.

3. Теперь необходимо создать базу данных, мигрировать схему веб-приложения и заполнить БД тестовыми данными:

   rails db:create
   rails db:migrate
   rails db:seed

4. Запустить приложение:

   bin/dev

Проблемы при запуске (Troubleshooting)

Тестирование (Running Tests)

В качестве фреймворка тестирования используется RSpec, в частности rspec-rails. Для запуска тестов достаточно выполнить команду:

rspec

Результаты теcтирования (Tests Results)

Результаты тестирования в формате JUnit появятся в файле junits/rspec.xml.

Покрытие кода (Code Coverage)

Для рассчёта покрытия кода используется библиотека SimpleCov. Результаты выводятся в двух форматах: в виде статического HTML сайта в папке coverage/tests/index.html и в терминале.

Пример вывода в терминал:

Run options: exclude {:capybara=>true}

ApplicationRecord
  is expected to be
  is expected to be a kind of Class

Finished in 0.00907 seconds (files took 1.19 seconds to load)
2 examples, 0 failures

Coverage report generated for tests to /home/jerry/devel/gitlab/rails-gambit/coverage/tests. 3 / 26 LOC (11.54%) covered.

COVERAGE:  11.54% -- 3/26 lines in 8 files

+----------+----------------------------------------------+-------+--------+-------------+
| coverage | file                                         | lines | missed | missing     |
+----------+----------------------------------------------+-------+--------+-------------+
|   0.00%  | app/channels/application_cable/channel.rb    | 4     | 4      | 1-4         |
|   0.00%  | app/channels/application_cable/connection.rb | 4     | 4      | 1-4         |
|   0.00%  | app/controllers/application_controller.rb    | 2     | 2      | 1-2         |
|   0.00%  | app/jobs/application_job.rb                  | 2     | 2      | 1, 7        |
+----------+----------------------------------------------+-------+--------+-------------+
2 file(s) with 100% coverage not shown

Присоединиться к разработке (Contributing)

В CONTRIBUTING.md собраны правила и рекомендации для разработчиков. Ждём и тебя тоже!