Rails: add ControllerHelpers in tests (#822)

I want to make the tests look more like Rails controller tests, so we
can add custom methods here.

Author: mockdeep

.rubocop.yml

@@ -30,6 +30,9 @@ Style/StringLiterals: { EnforcedStyle: double_quotes }
 Style/SymbolArray: { EnforcedStyle: brackets }
 Style/WordArray: { EnforcedStyle: brackets }
 
+# enable after Rails
+RSpec/Rails/InferredSpecType: { Enabled: false }
+
 # want to enable these, but they don't work right when using `.rubocop_todo.yml`
 Style/DocumentationMethod: { Enabled: false }
 Style/Documentation: { Enabled: false }

spec/app_spec.rb

@@ -4,6 +4,8 @@
 require "support/active_record"
 
 describe "App" do
+  include ControllerHelpers
+
   describe "Rails" do
     it "returns a fake application" do
       expect(Rails.application.config.cache_classes).to be(true)

spec/config/asset_pipeline_spec.rb

@@ -3,6 +3,8 @@
 require "spec_helper"
 
 describe "AssetPipeline" do
+  include ControllerHelpers
+
   it "handles asset requests" do
     get("/assets/stylesheets/application.css")
 

spec/controllers/debug_controller_spec.rb

@@ -5,7 +5,7 @@
 
 app_require "controllers/debug_controller"
 
-describe DebugController do
+describe DebugController, type: :controller do
   describe "GET /debug" do
     def setup
       expect(Delayed::Job).to receive(:count).and_return(42)

spec/controllers/exports_controller_spec.rb

@@ -4,7 +4,7 @@
 
 app_require "controllers/exports_controller"
 
-describe ExportsController do
+describe ExportsController, type: :controller do
   describe "GET /feeds/export" do
     def expected_xml
       <<~XML

spec/controllers/feeds_controller_spec.rb

@@ -4,7 +4,7 @@
 
 app_require "controllers/feeds_controller"
 
-describe FeedsController do
+describe FeedsController, type: :controller do
   describe "#index" do
     it "renders a list of feeds" do
       create_pair(:feed)

spec/controllers/imports_controller_spec.rb

@@ -4,7 +4,7 @@
 
 app_require "controllers/imports_controller"
 
-describe ImportsController do
+describe ImportsController, type: :controller do
   describe "GET /feeds/import" do
     it "displays the import options" do
       get "/feeds/import"

spec/controllers/passwords_controller_spec.rb

@@ -3,7 +3,7 @@
 require "spec_helper"
 require "support/active_record"
 
-RSpec.describe PasswordsController do
+RSpec.describe PasswordsController, type: :controller do
   def setup
     expect(UserRepository).to receive(:setup_complete?).twice.and_return(false)
   end

spec/controllers/sessions_controller_spec.rb

@@ -2,7 +2,7 @@
 
 require "spec_helper"
 
-describe SessionsController do
+describe SessionsController, type: :controller do
   describe "#new" do
     it "has a password input and login button" do
       get "/login"

spec/controllers/stories_controller_spec.rb

@@ -2,7 +2,7 @@
 
 require "spec_helper"
 
-describe StoriesController do
+describe StoriesController, type: :controller do
   let(:story_one) { create(:story) }
   let(:story_two) { create(:story) }
   let(:stories) { [story_one, story_two] }

spec/controllers/tutorials_controller_spec.rb

@@ -3,7 +3,7 @@
 require "spec_helper"
 require "support/active_record"
 
-RSpec.describe TutorialsController do
+RSpec.describe TutorialsController, type: :controller do
   describe "#index" do
     context "when a user has not been setup" do
       let(:user) { instance_double(User) }

spec/spec_helper.rb

@@ -14,6 +14,7 @@
 require "date"
 
 require_relative "support/coverage"
+require_relative "support/controller_helpers"
 require_relative "support/factory_bot"
 require_relative "support/webmock"
 require_relative "factories"
@@ -36,18 +37,10 @@ def custom_request(method, path, params = {}, env = {}, &)
 end
 
 RSpec.configure do |config|
-  config.include(Rack::Test::Methods)
+  config.include(ControllerHelpers, type: :controller)
   config.include(RSpecHtmlMatchers)
 end
 
 def app_require(file)
   require File.expand_path(File.join("app", file))
 end
-
-def app
-  Stringer
-end
-
-def session
-  last_request.env["rack.session"]
-end

spec/support/controller_helpers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ControllerHelpers
+  include Rack::Test::Methods
+
+  def app
+    Stringer
+  end
+
+  def session
+    last_request.env["rack.session"]
+  end
+end

spec/utils/i18n_support_spec.rb

@@ -3,6 +3,8 @@
 require "spec_helper"
 
 describe "i18n" do
+  include ControllerHelpers
+
   before do
     allow(UserRepository).to receive(:setup_complete?).and_return(false)
     ENV["LOCALE"] = locale