Rails 8 で作る RSpec テスト環境

group :development, :test do
  gem "rspec-rails", "~> 8.0"
  gem "factory_bot_rails", "~> 6.5"
  gem "faker", "~> 3.6"
end

group :test do
  gem "shoulda-matchers", "~> 7.0"
  gem "simplecov", require: false
  gem "simplecov-console", require: false
  gem "webmock"
  gem "test-prof", "~> 1.4"
end

# frozen_string_literal: true

require 'simplecov'
require 'simplecov-console'

RSpec.configure do |config|
  config.expect_with :rspec do |expectations|
    # カスタムマッチャーで chain を使ったときに説明文へ含める
    # 例: be_bigger_than(2).and_smaller_than(4) の説明が
    # "be bigger than 2 and smaller than 4" になる
    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
  end

  config.mock_with :rspec do |mocks|
    # 存在しないメソッドをモック/スタブしようとするとエラーになる
    # メソッド名のタイポや、実装変更後のモック漏れを検出できる
    mocks.verify_partial_doubles = true
  end

  # shared_context のメタデータを継承する方式を設定
  # RSpec 4 ではこれがデフォルトになる予定
  config.shared_context_metadata_behavior = :apply_to_host_groups

  SimpleCov.start do
    # ターミナルと HTML の両方にレポート出力
    # CI ではターミナル出力、ローカルでは HTML が便利
    formatter SimpleCov::Formatter::MultiFormatter.new([
      SimpleCov::Formatter::HTMLFormatter,
      SimpleCov::Formatter::Console
    ])

    # テストコードと設定ファイルはカバレッジ計測から除外
    add_filter '/spec/'
    add_filter '/config/'

    # レポートをディレクトリ別にグループ化
    # 「Models: 95%」「Services: 87%」のように表示される
    add_group 'Models', 'app/models'
    add_group 'Controllers', 'app/controllers'
    add_group 'Services', 'app/services'
    add_group 'Jobs', 'app/jobs'
  end
end

# frozen_string_literal: true

require 'spec_helper'
ENV['RAILS_ENV'] ||= 'test'
require_relative '../config/environment'
abort('The Rails environment is running in production mode!') if Rails.env.production?
require 'rspec/rails'
require 'webmock/rspec'

# 外部 HTTP リクエストをブロック（localhost は許可）
# スタブ化し忘れた外部リクエストがあるとテストが失敗するので、
# 意図しない外部通信を防げる
WebMock.disable_net_connect!(allow_localhost: true)

# spec/support 以下のファイルを自動読み込み
# ヘルパーモジュールや共通設定をここに配置できる
Rails.root.glob('spec/support/**/*.rb').each { |f| require f }

# テスト実行前にマイグレーションが最新かチェック
# 未適用のマイグレーションがあるとエラーメッセージを表示して終了
begin
  ActiveRecord::Migration.maintain_test_schema!
rescue ActiveRecord::PendingMigrationError => e
  abort e.to_s.strip
end

RSpec.configure do |config|
  # フィクスチャファイルの配置先
  config.fixture_paths = [Rails.root.join('spec/fixtures').to_s]

  # create(:user) のように FactoryBot. のプレフィックスを省略できる
  # build, create, build_list, create_list なども同様
  config.include FactoryBot::Syntax::Methods

  # 各テストをトランザクションで囲み、終了後に自動ロールバック
  # テスト間でデータが干渉することを防ぐ
  config.use_transactional_fixtures = true

  # ファイルの配置場所からテストの種類を自動推測
  # spec/models/ に置けば type: :model、spec/requests/ なら type: :request
  config.infer_spec_type_from_file_location!

  # エラー時のバックトレースから Rails 内部のコードを除外
  # 自分のコードに集中できる
  config.filter_rails_from_backtrace!
end

# shoulda-matchers を RSpec + Rails で使う設定
# この設定により、モデルスペックで validate_presence_of などが使える
Shoulda::Matchers.configure do |config|
  config.integrate do |with|
    with.test_framework :rspec
    with.library :rails
  end
end

# frozen_string_literal: true

require 'test_prof/recipes/rspec/let_it_be'
require 'test_prof/recipes/rspec/before_all'

RSpec.describe User do
  # 各 example で毎回 User が作成される（遅い）
  let(:user) { create(:user) }

  # describe 全体で 1 回だけ作成される（速い）
  let_it_be(:user) { create(:user) }
end

# 各 example の前に user.reload が呼ばれる
let_it_be(:user, reload: true) { create(:user) }

before_all do
  @user = create(:user)
  @posts = create_list(:post, 5, user: @user)
end

RSpec.describe User, type: :model do
  describe 'バリデーション' do
    # validates :email, presence: true と同等のテスト
    it { is_expected.to validate_presence_of(:email) }

    # validates :email, uniqueness: { case_sensitive: false } と同等
    it { is_expected.to validate_uniqueness_of(:email).case_insensitive }

    # validates :name, length: { maximum: 100 } と同等
    it { is_expected.to validate_length_of(:name).is_at_most(100) }
  end

  describe 'アソシエーション' do
    # belongs_to :tenant と同等のテスト
    it { is_expected.to belong_to(:tenant) }

    # has_many :posts, dependent: :destroy と同等
    it { is_expected.to have_many(:posts).dependent(:destroy) }
  end
end

RSpec.describe GithubService do
  describe '#fetch_user' do
    before do
      # このURLへのGETリクエストをスタブ化
      stub_request(:get, 'https://api.github.com/users/octocat')
        .to_return(
          status: 200,
          body: { login: 'octocat', id: 1 }.to_json,
          headers: { 'Content-Type' => 'application/json' }
        )
    end

    it 'ユーザー情報を取得する' do
      user = GithubService.new.fetch_user('octocat')
      expect(user['login']).to eq 'octocat'
    end
  end
end

context 'ユーザーが存在しない場合' do
  before do
    stub_request(:get, 'https://api.github.com/users/unknown')
      .to_return(status: 404)
  end

  it 'nil を返す' do
    expect(GithubService.new.fetch_user('unknown')).to be_nil
  end
end

context 'タイムアウトした場合' do
  before do
    stub_request(:get, 'https://api.github.com/users/octocat')
      .to_timeout
  end

  it '例外を発生させる' do
    expect { GithubService.new.fetch_user('octocat') }
      .to raise_error(Faraday::ConnectionFailed)
  end
end