From 9bca2fc9076f51ad8f936ee319e01bc0340b3324 Mon Sep 17 00:00:00 2001 From: Leonid Svyatov Date: Sun, 30 Jun 2024 14:58:39 +0400 Subject: [PATCH] chore: Setups RSpec (#1) --- .github/workflows/ci.yml | 36 ++++++++++++++ .gitignore | 3 ++ .rspec | 1 + .rubocop.yml | 4 ++ Gemfile | 26 +++++++--- Gemfile.lock | 26 ++++++++++ Rakefile | 2 +- bin/brakeman | 24 +++++++++- bin/rspec | 27 +++++++++++ bin/rubocop | 25 ++++++++-- spec/rails_helper.rb | 66 ++++++++++++++++++++++++++ spec/requests/index_spec.rb | 15 ++++++ spec/spec_helper.rb | 95 +++++++++++++++++++++++++++++++++++++ 13 files changed, 338 insertions(+), 12 deletions(-) create mode 100644 .rspec create mode 100755 bin/rspec create mode 100644 spec/rails_helper.rb create mode 100644 spec/requests/index_spec.rb create mode 100644 spec/spec_helper.rb diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9dd210f..9b351fb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -37,3 +37,39 @@ jobs: - name: Lint code for consistent style run: bin/rubocop -f github + test: + runs-on: ubuntu-latest + + services: + postgres: + image: postgres:16-alpine + ports: + - 5432:5432 + env: + POSTGRES_USER: postgres + POSTGRES_PASSWORD: postgres + + env: + RAILS_ENV: test + DB_HOST: localhost + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: .ruby-version + bundler-cache: true + + - name: Set up Node.js + uses: actions/setup-node@v4 + with: + node-version-file: .node-version + + - name: Set up database schema + run: bin/rails db:prepare + + - name: Run RSpec + run: bin/rspec diff --git a/.gitignore b/.gitignore index a127197..d9056c5 100644 --- a/.gitignore +++ b/.gitignore @@ -42,3 +42,6 @@ # JetBrains /.idea + +# Tests +/spec/examples.txt diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..c99d2e7 --- /dev/null +++ b/.rspec @@ -0,0 +1 @@ +--require spec_helper diff --git a/.rubocop.yml b/.rubocop.yml index 9dba82d..ab29bb0 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -1,6 +1,10 @@ # Omakase Ruby styling for Rails inherit_gem: { rubocop-rails-omakase: rubocop.yml } +require: + - rubocop-rspec + - rubocop-rspec_rails + AllCops: TargetRubyVersion: 3.3 TargetRailsVersion: 7.2 diff --git a/Gemfile b/Gemfile index 586930d..81b4c3b 100644 --- a/Gemfile +++ b/Gemfile @@ -6,22 +6,31 @@ gem 'net-pop', github: 'ruby/net-pop' # Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main" gem 'rails', '~> 7.2.0.beta2' + # The original asset pipeline for Rails [https://github.com/rails/sprockets-rails] gem 'sprockets-rails' + # Use postgresql as the database for Active Record gem 'pg', '~> 1.1' + # Use the Puma web server [https://github.com/puma/puma] gem 'puma', '>= 5.0' + # Bundle and transpile JavaScript [https://github.com/rails/jsbundling-rails] gem 'jsbundling-rails' + # Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev] gem 'turbo-rails' + # Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev] gem 'stimulus-rails' + # Bundle and process CSS [https://github.com/rails/cssbundling-rails] gem 'cssbundling-rails' + # Build JSON APIs with ease [https://github.com/rails/jbuilder] gem 'jbuilder' + # Use Redis adapter to run Action Cable in production gem 'redis', '>= 4.0.1' @@ -37,6 +46,11 @@ gem 'tzinfo-data', platforms: %i[ windows jruby ] # Reduces boot times through caching; required in config/boot.rb gem 'bootsnap', require: false +group :development do + # Use console on exceptions pages [https://github.com/rails/web-console] + gem 'web-console' +end + group :development, :test do # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem gem 'debug', platforms: %i[ mri windows ], require: 'debug/prelude' @@ -44,11 +58,11 @@ group :development, :test do # Static analysis for security vulnerabilities [https://brakemanscanner.org/] gem 'brakeman', require: false - # Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/] - gem 'rubocop-rails-omakase', require: false -end + # Rubocop is a Ruby static code analyzer and code formatter [https://github.com/rubocop/rubocop] + gem 'rubocop-rails-omakase', require: false # https://github.com/rails/rubocop-rails-omakase + gem 'rubocop-rspec', require: false # https://github.com/rubocop/rubocop-rspec + gem 'rubocop-rspec_rails', require: false # https://github.com/rubocop/rubocop-rspec_rails -group :development do - # Use console on exceptions pages [https://github.com/rails/web-console] - gem 'web-console' + # Simply the best testing framework for Ruby [https://github.com/rspec/rspec-rails] + gem 'rspec-rails', '~> 6.1.3' end diff --git a/Gemfile.lock b/Gemfile.lock index c5b976e..b35dc10 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -93,6 +93,7 @@ GEM debug (1.9.2) irb (~> 1.10) reline (>= 0.3.8) + diff-lcs (1.5.1) drb (2.2.1) erubi (1.13.0) globalid (1.2.1) @@ -202,6 +203,23 @@ GEM io-console (~> 0.5) rexml (3.3.1) strscan + rspec-core (3.13.0) + rspec-support (~> 3.13.0) + rspec-expectations (3.13.1) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.13.0) + rspec-mocks (3.13.1) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.13.0) + rspec-rails (6.1.3) + actionpack (>= 6.1) + activesupport (>= 6.1) + railties (>= 6.1) + rspec-core (~> 3.13) + rspec-expectations (~> 3.13) + rspec-mocks (~> 3.13) + rspec-support (~> 3.13) + rspec-support (3.13.1) rubocop (1.64.1) json (~> 2.3) language_server-protocol (>= 3.17.0) @@ -231,6 +249,11 @@ GEM rubocop-minitest rubocop-performance rubocop-rails + rubocop-rspec (3.0.1) + rubocop (~> 1.61) + rubocop-rspec_rails (2.30.0) + rubocop (~> 1.61) + rubocop-rspec (~> 3, >= 3.0.1) ruby-progressbar (1.13.0) sprockets (4.2.1) concurrent-ruby (~> 1.0) @@ -284,7 +307,10 @@ DEPENDENCIES puma (>= 5.0) rails (~> 7.2.0.beta2) redis (>= 4.0.1) + rspec-rails (~> 6.1.3) rubocop-rails-omakase + rubocop-rspec + rubocop-rspec_rails sprockets-rails stimulus-rails turbo-rails diff --git a/Rakefile b/Rakefile index dfc0c40..4a6dac5 100644 --- a/Rakefile +++ b/Rakefile @@ -20,5 +20,5 @@ if %w[development test].include? Rails.env task lint: %i[rubocop brakeman] task(:default).clear - task default: %i[lint] + task default: %i[lint spec] end diff --git a/bin/brakeman b/bin/brakeman index ace1c9b..b4fe8de 100755 --- a/bin/brakeman +++ b/bin/brakeman @@ -1,7 +1,27 @@ #!/usr/bin/env ruby +# frozen_string_literal: true + +# +# This file was generated by Bundler. +# +# The application 'brakeman' is installed as part of a gem, and +# this file is here to facilitate running it. +# + +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__) + +bundle_binstub = File.expand_path("bundle", __dir__) + +if File.file?(bundle_binstub) + if File.read(bundle_binstub, 300).include?("This file was generated by Bundler") + load(bundle_binstub) + else + abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run. +Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.") + end +end + require "rubygems" require "bundler/setup" -ARGV.unshift("--ensure-latest") - load Gem.bin_path("brakeman", "brakeman") diff --git a/bin/rspec b/bin/rspec new file mode 100755 index 0000000..cb53ebe --- /dev/null +++ b/bin/rspec @@ -0,0 +1,27 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +# +# This file was generated by Bundler. +# +# The application 'rspec' is installed as part of a gem, and +# this file is here to facilitate running it. +# + +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__) + +bundle_binstub = File.expand_path("bundle", __dir__) + +if File.file?(bundle_binstub) + if File.read(bundle_binstub, 300).include?("This file was generated by Bundler") + load(bundle_binstub) + else + abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run. +Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.") + end +end + +require "rubygems" +require "bundler/setup" + +load Gem.bin_path("rspec-core", "rspec") diff --git a/bin/rubocop b/bin/rubocop index 40330c0..369a05b 100755 --- a/bin/rubocop +++ b/bin/rubocop @@ -1,8 +1,27 @@ #!/usr/bin/env ruby +# frozen_string_literal: true + +# +# This file was generated by Bundler. +# +# The application 'rubocop' is installed as part of a gem, and +# this file is here to facilitate running it. +# + +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__) + +bundle_binstub = File.expand_path("bundle", __dir__) + +if File.file?(bundle_binstub) + if File.read(bundle_binstub, 300).include?("This file was generated by Bundler") + load(bundle_binstub) + else + abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run. +Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.") + end +end + require "rubygems" require "bundler/setup" -# explicit rubocop config increases performance slightly while avoiding config confusion. -ARGV.unshift("--config", File.expand_path("../.rubocop.yml", __dir__)) - load Gem.bin_path("rubocop", "rubocop") diff --git a/spec/rails_helper.rb b/spec/rails_helper.rb new file mode 100644 index 0000000..e11a972 --- /dev/null +++ b/spec/rails_helper.rb @@ -0,0 +1,66 @@ +# This file is copied to spec/ when you run 'rails generate rspec:install' +require 'spec_helper' +ENV['RAILS_ENV'] ||= 'test' +require_relative '../config/environment' +# Prevent database truncation if the environment is production +abort("The Rails environment is running in production mode!") if Rails.env.production? +require 'rspec/rails' +# 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. +# +# Rails.root.glob('spec/support/**/*.rb').sort.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 + abort e.to_s.strip +end + +RSpec.configure do |config| + # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures + config.fixture_paths = [ + Rails.root.join('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 + + # You can uncomment this line to turn off ActiveRecord support entirely. + # config.use_active_record = false + + # 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://rspec.info/features/6-0/rspec-rails + 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 diff --git a/spec/requests/index_spec.rb b/spec/requests/index_spec.rb new file mode 100644 index 0000000..1aa0276 --- /dev/null +++ b/spec/requests/index_spec.rb @@ -0,0 +1,15 @@ +require 'rails_helper' + +RSpec.describe "Index", type: :request do + describe "GET /" do + it "responds successfully with an HTTP 200 status code" do + get "/" + expect(response).to have_http_status(200) + end + + it "renders the 'Hello world!' text" do + get "/" + expect(response.body).to eq 'Hello world!' + end + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..ae4d380 --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,95 @@ +# This file was generated by the `rails generate rspec:install` command. Conventionally, all +# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`. +# The generated `.rspec` file contains `--require spec_helper` which will cause +# this file to always be loaded, without a need to explicitly require it in any +# files. +# +# Given that it is always loaded, you are encouraged to keep this file as +# light-weight as possible. Requiring heavyweight dependencies from this file +# will add to the boot time of your test suite on EVERY test run, even for an +# individual file that may not need all of that loaded. Instead, consider making +# a separate helper file that requires the additional dependencies and performs +# the additional setup, and require it from the spec files that actually need +# it. +# +# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration +RSpec.configure do |config| + # rspec-expectations config goes here. You can use an alternate + # assertion/expectation library such as wrong or the stdlib/minitest + # assertions if you prefer. + config.expect_with :rspec do |expectations| + # This option will default to `true` in RSpec 4. It makes the `description` + # and `failure_message` of custom matchers include text for helper methods + # defined using `chain`, e.g.: + # be_bigger_than(2).and_smaller_than(4).description + # # => "be bigger than 2 and smaller than 4" + # ...rather than: + # # => "be bigger than 2" + expectations.include_chain_clauses_in_custom_matcher_descriptions = true + end + + # rspec-mocks config goes here. You can use an alternate test double + # library (such as bogus or mocha) by changing the `mock_with` option here. + config.mock_with :rspec do |mocks| + # Prevents you from mocking or stubbing a method that does not exist on + # a real object. This is generally recommended, and will default to + # `true` in RSpec 4. + mocks.verify_partial_doubles = true + end + + # This option will default to `:apply_to_host_groups` in RSpec 4 (and will + # have no way to turn it off -- the option exists only for backwards + # compatibility in RSpec 3). It causes shared context metadata to be + # inherited by the metadata hash of host groups and examples, rather than + # triggering implicit auto-inclusion in groups with matching metadata. + config.shared_context_metadata_behavior = :apply_to_host_groups + + # The settings below are suggested to provide a good initial experience + # with RSpec, but feel free to customize to your heart's content. + + # This allows you to limit a spec run to individual examples or groups + # you care about by tagging them with `:focus` metadata. When nothing + # is tagged with `:focus`, all examples get run. RSpec also provides + # aliases for `it`, `describe`, and `context` that include `:focus` + # metadata: `fit`, `fdescribe` and `fcontext`, respectively. + config.filter_run_when_matching :focus + + # Allows RSpec to persist some state between runs in order to support + # the `--only-failures` and `--next-failure` CLI options. We recommend + # you configure your source control system to ignore this file. + config.example_status_persistence_file_path = "spec/examples.txt" + + # Limits the available syntax to the non-monkey patched syntax that is + # recommended. For more details, see: + # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/ + config.disable_monkey_patching! + + # Many RSpec users commonly either run the entire suite or an individual + # file, and it's useful to allow more verbose output when running an + # individual spec file. + if config.files_to_run.one? + # Use the documentation formatter for detailed output, + # unless a formatter has already been configured + # (e.g. via a command-line flag). + config.default_formatter = "doc" + end + + # Print the 10 slowest examples and example groups at the + # end of the spec run, to help surface which specs are running + # particularly slow. + config.profile_examples = 10 + + # Run specs in random order to surface order dependencies. If you find an + # order dependency and want to debug it, you can fix the order by providing + # the seed, which is printed after each run. + # --seed 1234 + config.order = :random + + # Seed global randomization in this process using the `--seed` CLI option. + # Setting this allows you to use `--seed` to deterministically reproduce + # test failures related to randomization by passing the same `--seed` value + # as the one that triggered the failure. + Kernel.srand config.seed +end + +RSpec::Matchers.define_negated_matcher :not_change, :change