rspec の環境構築

#rspec の環境構築

## rspec-rails の導入

gemfailにGemを追加する。

```ruby:gemfail
# (中略)

group :development, :test do
  # (中略)
  gem 'rspec-rails'
end

# (中略)
```

修正したら bundle install

## rspec-rails のセットアップ

```ruby
$ bundle exec rails generate rspec:install

Running via Spring preloader in process 33377
      create  .rspec -新ファイル
      create  spec
      create  spec/spec_helper.rb　-新ファイル
      create  spec/rails_helper.rb　-新ファイル
```


## gitinore の修正

デフォルトだと、.rspec が git 管理外なので、管理するために、.gitignoreファイルから記述を外す。

```:gitinore
*.rbc
capybara-*.html
-.rspec
/log
/tmp

# 中略
```


## .rspec の修正

```:.rspec
--require rails_helper
--format documentation
```

これにより下記が設定された。

1. spec_helperを自動的に読み込んでいたのが、rails_helperを読み込むようになる
2. テスト実行時にテスト内容をログとして出力してくれるようになる 

＊ rails_helper さえ require しておけば、自動的に spec_helper も読み込んでくれるようになっている。

## その他のテストで使う便利なgemの導入

```ruby:Gemfile
# 中略
group :development, :test do
  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
  gem 'pry-byebug'
  gem 'pry-rails'
  gem 'rspec-rails'
+  gem 'factory_bot_rails' -追加
+  gem 'faker'　-追加
end

# 中略
```

bundle install

### factory_bot_rails

factory_bot_rails は、model のデータに紐づいたテストデータを簡単に作るための gem。

**rails_helper の設定**

```:rails_helper
# 中略

RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
# 中略
end

# 中略
```

この設定で、FactoryBotのメソッドを省略した形で呼び出すことができるようになる。


### faker
fakerは、ランダムでダミーデータを作るのに便利なgem。


**rails_helper の設定**

```:rails_helper
+ Faker::Config.locale = :ja
```

上記の設定を加えておくと、Faker で作成されるデータが日本語の値になる。


## generator の設定を修正


### application.rb の修正

以下のように、application.rb を修正すると、model や controller を作成するタイミングで、rspec のテストファイルも同時に作成されるようになる。

```ruby:application.rb
module HelloWorldRails
  class Application < Rails::Application
    # 中略
    config.generators do |g|
      g.template_engine false
      g.javascripts false
      g.stylesheets false
      g.helper false
      g.test_framework :rspec,
                       fixtures: true,
                       fixture_replacement: :factory_bot,
                       view_specs: false,
                       routing_specs: false,
                       helper_specs: false,
                       controller_specs: false,
                       request_specs: true
    end
    # 中略
  end
end
```


### 設定を反映させる

```
$ bundle exec rails g
```

rspec のテストファイルも同時に作成されるように反映された。



## まとめ

**rails_helperの全容**

```ruby:rails_helper
# This file is copied to spec/ when you run 'rails generate rspec:install'
require 'spec_helper'
ENV['RAILS_ENV'] ||= 'test'
require File.expand_path('../../config/environment', __FILE__)
# Prevent database truncation if the environment is production
abort("The Rails environment is running in production mode!") if Rails.env.production?
require 'rspec/rails'
Faker::Config.locale = :ja #言語を日本語に設定してる。追加要素。
# Add additional requires below this line. Rails is not loaded until this point!

# Requires supporting ruby files with custom matchers and macros, etc, in
# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
# run as spec files by default. This means that files in spec/support that end
# in _spec.rb will both be required and run as specs, causing the specs to be
# run twice. It is recommended that you do not name files matching this glob to
# end with _spec.rb. You can configure this pattern with the --pattern
# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
#
# The following line is provided for convenience purposes. It has the downside
# of increasing the boot-up time by auto-requiring all files in the support
# directory. Alternatively, in the individual `*_spec.rb` files, manually
# require only the support files necessary.
#
# Dir[Rails.root.join('spec', 'support', '**', '*.rb')].each { |f| require f }

# Checks for pending migrations and applies them before tests are run.
# If you are not using ActiveRecord, you can remove these lines.
begin
  ActiveRecord::Migration.maintain_test_schema!
rescue ActiveRecord::PendingMigrationError => e
  puts e.to_s.strip
  exit 1
end
RSpec.configure do |config|
  config.include FactoryBot::Syntax::Methods #FactoryBotのメソッドを省略した形で呼び出すための記述。追加要素。
  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
  config.fixture_path = "#{::Rails.root}/spec/fixtures"

  # If you're not using ActiveRecord, or you'd prefer not to run each of your
  # examples within a transaction, remove the following line or assign false
  # instead of true.
  config.use_transactional_fixtures = true

  # RSpec Rails can automatically mix in different behaviours to your tests
  # based on their file location, for example enabling you to call `get` and
  # `post` in specs under `spec/controllers`.
  #
  # You can disable this behaviour by removing the line below, and instead
  # explicitly tag your specs with their type, e.g.:
  #
  #     RSpec.describe UsersController, :type => :controller do
  #       # ...
  #     end
  #
  # The different available types are documented in the features, such as in
  # https://relishapp.com/rspec/rspec-rails/docs
  config.infer_spec_type_from_file_location!

  # Filter lines from Rails gems in backtraces.
  config.filter_rails_from_backtrace!
  # arbitrary gems may also be filtered via:
  # config.filter_gems_from_backtrace("gem name")
end
```