devise_g5_authenticatable 0.3.0 → 1.0.0.pre.1

data/spec/routing/registrations_routing_spec.rb

@@ -1,68 +1,82 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe 'Registrations controller' do
+require 'rails_helper'
+
+RSpec.describe 'Registrations controller' do
   describe 'routing' do
     context 'with user scope' do
       it 'should route GET /users/sign_up' do
-        expect(get '/users/sign_up').to route_to(controller: 'devise_g5_authenticatable/registrations',
-                                             action: 'new')
+        expect(get('/users/sign_up'))
+          .to route_to(controller: 'devise_g5_authenticatable/registrations',
+                       action: 'new')
       end
 
       it 'should route POST /users' do
-        expect(post '/users').to route_to(controller: 'devise_g5_authenticatable/registrations',
-                                          action: 'create')
+        expect(post('/users'))
+          .to route_to(controller: 'devise_g5_authenticatable/registrations',
+                       action: 'create')
       end
 
       it 'should route GET /users/edit' do
-        expect(get '/users/edit').to route_to(controller: 'devise_g5_authenticatable/registrations',
-                                              action: 'edit')
+        expect(get('/users/edit'))
+          .to route_to(controller: 'devise_g5_authenticatable/registrations',
+                       action: 'edit')
       end
 
       it 'should route PUT /users' do
-        expect(put '/users').to route_to(controller: 'devise_g5_authenticatable/registrations',
+        expect(put('/users'))
+          .to route_to(controller: 'devise_g5_authenticatable/registrations',
                                          action: 'update')
       end
 
       it 'should route DELETE /users' do
-        expect(delete '/users').to route_to(controller: 'devise_g5_authenticatable/registrations',
-                                            action: 'destroy')
+        expect(delete('/users'))
+          .to route_to(controller: 'devise_g5_authenticatable/registrations',
+                       action: 'destroy')
       end
 
       it 'should route GET /users/cancel' do
-        expect(get '/users/cancel').to route_to(controller: 'devise_g5_authenticatable/registrations',
-                                                action: 'cancel')
+        expect(get('/users/cancel'))
+          .to route_to(controller: 'devise_g5_authenticatable/registrations',
+                       action: 'cancel')
       end
     end
 
     context 'with admin scope' do
       it 'should route GET /registered/admins/custom_sign_up' do
-        expect(get '/registered/admins/custom_sign_up').to route_to(controller: 'custom_registrations',
-                                                                    action: 'new')
+        expect(get('/registered/admins/custom_sign_up'))
+          .to route_to(controller: 'custom_registrations',
+                       action: 'new')
       end
 
       it 'should route POST /registered/admins' do
-        expect(post '/registered/admins').to route_to(controller: 'custom_registrations',
-                                                      action: 'create')
+        expect(post('/registered/admins'))
+          .to route_to(controller: 'custom_registrations',
+                       action: 'create')
       end
 
       it 'should route GET /registered/admins/edit' do
-        expect(get '/registered/admins/edit').to route_to(controller: 'custom_registrations',
-                                              action: 'edit')
+        expect(get('/registered/admins/edit'))
+          .to route_to(controller: 'custom_registrations',
+                       action: 'edit')
       end
 
       it 'should route PUT /registered/admins' do
-        expect(put '/registered/admins').to route_to(controller: 'custom_registrations',
-                                         action: 'update')
+        expect(put('/registered/admins'))
+          .to route_to(controller: 'custom_registrations',
+                       action: 'update')
       end
 
       it 'should route DELETE /registered/admins' do
-        expect(delete '/registered/admins').to route_to(controller: 'custom_registrations',
-                                                        action: 'destroy')
+        expect(delete('/registered/admins'))
+          .to route_to(controller: 'custom_registrations',
+                       action: 'destroy')
       end
 
       it 'should route GET /registered/admins/custom_cancel' do
-        expect(get '/registered/admins/custom_cancel').to route_to(controller: 'custom_registrations',
-                                                                   action: 'cancel')
+        expect(get('/registered/admins/custom_cancel'))
+          .to route_to(controller: 'custom_registrations',
+                       action: 'cancel')
       end
     end
   end
@@ -88,7 +102,8 @@ describe 'Registrations controller' do
 
     context 'with admin scope' do
       it 'should generate new_admin_registration_path' do
-        expect(new_admin_registration_path).to eq('/registered/admins/custom_sign_up')
+        expect(new_admin_registration_path)
+          .to eq('/registered/admins/custom_sign_up')
       end
 
       it 'should generate admin_registration_path' do
@@ -100,7 +115,8 @@ describe 'Registrations controller' do
       end
 
       it 'should generate cancel_admin_registration_path' do
-        expect(cancel_admin_registration_path).to eq('/registered/admins/custom_cancel')
+        expect(cancel_admin_registration_path)
+          .to eq('/registered/admins/custom_cancel')
       end
     end
   end

data/spec/routing/sessions_routing_spec.rb

@@ -1,36 +1,44 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe 'Sessions controller' do
+require 'rails_helper'
+
+RSpec.describe 'Sessions controller' do
   describe 'routing' do
     context 'with user scope' do
       it 'should route GET /users/sign_in' do
-        expect(get '/users/sign_in').to route_to(controller: 'devise_g5_authenticatable/sessions',
-                                                 action: 'new')
+        expect(get('/users/sign_in'))
+          .to route_to(controller: 'devise_g5_authenticatable/sessions',
+                       action: 'new')
       end
 
       it 'should route DELETE /users/sign_out' do
-        expect(delete '/users/sign_out').to route_to(controller: 'devise_g5_authenticatable/sessions',
-                                                     action: 'destroy')
+        expect(delete('/users/sign_out'))
+          .to route_to(controller: 'devise_g5_authenticatable/sessions',
+                       action: 'destroy')
       end
 
       it 'should route GET /users/auth/g5' do
-        expect(get '/users/auth/g5').to route_to(controller: 'devise_g5_authenticatable/sessions',
-                                                 action: 'omniauth_passthru')
+        expect(get('/users/auth/g5'))
+          .to route_to(controller: 'devise_g5_authenticatable/sessions',
+                       action: 'omniauth_passthru')
       end
 
       it 'should route POST /users/auth/g5' do
-        expect(post '/users/auth/g5').to route_to(controller: 'devise_g5_authenticatable/sessions',
-                                                  action: 'omniauth_passthru')
+        expect(post('/users/auth/g5'))
+          .to route_to(controller: 'devise_g5_authenticatable/sessions',
+                       action: 'omniauth_passthru')
       end
 
       it 'should route GET /users/auth/g5/callback' do
-        expect(get '/users/auth/g5/callback').to route_to(controller: 'devise_g5_authenticatable/sessions',
-                                                          action: 'create')
+        expect(get('/users/auth/g5/callback'))
+          .to route_to(controller: 'devise_g5_authenticatable/sessions',
+                       action: 'create')
       end
 
       it 'should route POST /users/auth/g5/callback' do
-        expect(post '/users/auth/g5/callback').to route_to(controller: 'devise_g5_authenticatable/sessions',
-                                                           action: 'create')
+        expect(post('/users/auth/g5/callback'))
+          .to route_to(controller: 'devise_g5_authenticatable/sessions',
+                       action: 'create')
       end
 
       it 'should set the OmniAuth path prefix' do
@@ -40,33 +48,39 @@ describe 'Sessions controller' do
 
     context 'with admin scope' do
       it 'should route GET /registered/admins/custom_sign_in' do
-        expect(get '/registered/admins/custom_sign_in').to route_to(controller: 'custom_sessions',
-                                                      action: 'new')
+        expect(get('/registered/admins/custom_sign_in'))
+          .to route_to(controller: 'custom_sessions',
+                       action: 'new')
       end
 
       it 'should route DELETE /registered/admins/custom_sign_out' do
-        expect(delete '/registered/admins/custom_sign_out').to route_to(controller: 'custom_sessions',
-                                                          action: 'destroy')
+        expect(delete('/registered/admins/custom_sign_out'))
+          .to route_to(controller: 'custom_sessions',
+                       action: 'destroy')
       end
 
       it 'should route GET /registered/admins/auth/g5' do
-        expect(get '/registered/admins/auth/g5').to route_to(controller: 'custom_sessions',
-                                                             action: 'omniauth_passthru')
+        expect(get('/registered/admins/auth/g5'))
+          .to route_to(controller: 'custom_sessions',
+                       action: 'omniauth_passthru')
       end
 
       it 'should route POST /registered/admins/auth/g5' do
-        expect(post '/registered/admins/auth/g5').to route_to(controller: 'custom_sessions',
-                                                             action: 'omniauth_passthru')
+        expect(post('/registered/admins/auth/g5'))
+          .to route_to(controller: 'custom_sessions',
+                       action: 'omniauth_passthru')
       end
 
       it 'should route GET /registered/admins/auth/g5/callback' do
-        expect(get '/registered/admins/auth/g5/callback').to route_to(controller: 'custom_sessions',
-                                                                      action: 'create')
+        expect(get('/registered/admins/auth/g5/callback'))
+          .to route_to(controller: 'custom_sessions',
+                       action: 'create')
       end
 
       it 'should route POST /registered/admins/auth/g5/callback' do
-        expect(post '/registered/admins/auth/g5/callback').to route_to(controller: 'custom_sessions',
-                                                                       action: 'create')
+        expect(post('/registered/admins/auth/g5/callback'))
+          .to route_to(controller: 'custom_sessions',
+                       action: 'create')
       end
     end
   end
@@ -92,11 +106,13 @@ describe 'Sessions controller' do
 
     context 'with admin scope' do
       it 'should route new_admin_session_path' do
-        expect(new_admin_session_path).to eq('/registered/admins/custom_sign_in')
+        expect(new_admin_session_path)
+          .to eq('/registered/admins/custom_sign_in')
       end
 
       it 'should route destroy_admin_session_path' do
-        expect(destroy_admin_session_path).to eq('/registered/admins/custom_sign_out')
+        expect(destroy_admin_session_path)
+          .to eq('/registered/admins/custom_sign_out')
       end
 
       it 'should generate admin_g5_authorize_path' do
@@ -104,7 +120,8 @@ describe 'Sessions controller' do
       end
 
       it 'should generate admin_g5_callback_path' do
-        expect(admin_g5_callback_path).to eq('/registered/admins/auth/g5/callback')
+        expect(admin_g5_callback_path)
+          .to eq('/registered/admins/auth/g5/callback')
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,46 +1,112 @@
+# frozen_string_literal: true
+
+# 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.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
 # Setup for test coverage instrumentation (e.g. simplecov, codeclimate)
 # MUST happen before any other code is loaded
 require 'simplecov'
-SimpleCov.start 'test_frameworks'
 
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
+# save to CircleCI's artifacts directory if we're on CircleCI
+if ENV['CIRCLE_ARTIFACTS']
+  dir = File.join(ENV['CIRCLE_ARTIFACTS'], 'coverage')
+  SimpleCov.coverage_dir(dir)
+end
+
+SimpleCov.start('rails')
 
 require 'pry'
 
-# Load rails dummy application
-ENV['RAILS_ENV'] = 'test'
-require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+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
 
-require 'rspec/rails'
-require 'capybara/rspec'
-require 'webmock/rspec'
-require 'shoulda-matchers'
-require 'factory_girl_rails'
+  # 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
 
-# Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+  # 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
 
-RSpec.configure do |config|
-  config.include FactoryGirl::Syntax::Methods
+  # 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:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
 
-  config.use_transactional_fixtures = true
+  # 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
 
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
+  # 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'
-
-  # The integration tests can be run with:
-  # rspec -t type:feature
-  # config.filter_run_excluding type: 'feature'
-
-  config.after(:suite) { WebMock.disable! }
+  config.order = :random
 
-  config.infer_spec_type_from_file_location!
+  # 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

data/spec/support/controller_test_helpers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ControllerTestHelpers
+  def build_params(hash)
+    if Rails.version.starts_with?('4')
+      hash
+    else
+      { params: hash }
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include ControllerTestHelpers, type: :controller
+end

data/spec/support/devise.rb

@@ -1,4 +1,12 @@
+# frozen_string_literal: true
+
 RSpec.configure do |config|
   config.before(:each) { Devise.g5_strict_token_validation = false }
-  config.include Devise::TestHelpers, type: :controller
+
+  config.include Devise::Test::ControllerHelpers, type: :controller
+  config.include Devise::Test::ControllerHelpers, type: :view
+
+  # We're only adding the integration test helpers to request specs
+  # because the feature specs use the omniauth helpers instead
+  config.include Devise::Test::IntegrationHelpers, type: :request
 end

data/spec/support/shared_contexts/custom_router.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+RSpec.shared_context 'custom router' do
+  before { Devise.router_name = :my_engine }
+  after { Devise.router_name = nil }
+
+  let(:custom_router) { double(:my_engine_router) }
+
+  controller do
+    def my_engine; end
+  end
+
+  before do
+    allow(controller).to receive(:my_engine).and_return(custom_router)
+  end
+end

data/spec/support/shared_contexts/oauth_error.rb

@@ -1,8 +1,10 @@
-shared_context 'OAuth2::Error' do
+# frozen_string_literal: true
+
+RSpec.shared_context 'OAuth2::Error' do
   let(:oauth_error) { OAuth2::Error.new(oauth_response) }
   let(:oauth_response) do
     double(:oauth_response,
-           parsed: {'error' => error_message}).as_null_object
+           parsed: { 'error' => error_message }).as_null_object
   end
 
   let(:error_message) { 'Validation failed: Email is already taken' }

data/spec/support/shared_contexts/rake.rb

@@ -1,21 +1,27 @@
+# frozen_string_literal: true
+
 # Based on: http://robots.thoughtbot.com/test-rake-tasks-like-a-boss
 # Modified for a non-Rails environment
 require 'rake'
 
-shared_context 'rake' do
+RSpec.shared_context 'rake' do
   let(:rake)      { Rake::Application.new }
   let(:task_name) { self.class.top_level_description }
-  let(:task_path) { "lib/tasks/#{task_name.split(':').first}/#{task_name.split(':').last}" }
+  let(:task_path) do
+    "lib/tasks/#{task_name.split(':').first}/#{task_name.split(':').last}"
+  end
   let(:root_path) { File.expand_path('../../../..', __FILE__) }
   subject(:task)  { rake[task_name] }
 
   def loaded_files_excluding_current_rake_file
-    $".reject {|file| file =~ /#{task_path}\.rake$/ }
+    $LOADED_FEATURES.reject { |file| file =~ /#{task_path}\.rake$/ }
   end
 
   before do
     Rake.application = rake
-    Rake.application.rake_require(task_path, [root_path], loaded_files_excluding_current_rake_file)
+    Rake.application.rake_require(task_path,
+                                  [root_path],
+                                  loaded_files_excluding_current_rake_file)
     Rake::Task.define_task(:environment)
   end
 end

data/spec/support/shared_examples/registration_error.rb

@@ -1,4 +1,6 @@
-shared_examples_for 'a registration validation error' do
+# frozen_string_literal: true
+
+RSpec.shared_examples_for 'a registration validation error' do
   it 'should not create a user' do
     expect { subject }.to_not change { User.count }
   end

data/spec/support/{user_feature_methods.rb → user_omniauth_methods.rb}

@@ -1,10 +1,12 @@
-module UserFeatureMethods
-  def stub_g5_omniauth(user, options={})
+# frozen_string_literal: true
+
+module UserOmniauthMethods
+  def stub_g5_omniauth(user, options = {})
     OmniAuth.config.mock_auth[:g5] = OmniAuth::AuthHash.new({
       uid: user.uid,
       provider: 'g5',
-      info: {email: user.email},
-      credentials: {token: user.g5_access_token}
+      info: { email: user.email },
+      credentials: { token: user.g5_access_token }
     }.merge(options))
   end
 
@@ -19,11 +21,13 @@ module UserFeatureMethods
 end
 
 RSpec.configure do |config|
+  config.before(:all) { OmniAuth.config.logger = Logger.new('/dev/null') }
+
   config.before(:each) do
     OmniAuth.config.test_mode = true
     OmniAuth.config.mock_auth[:g5] = nil
   end
   config.after(:each) { OmniAuth.config.test_mode = false }
 
-  config.include UserFeatureMethods, type: :feature
+  config.include UserOmniauthMethods, type: :feature
 end

data/spec/tasks/export_users_spec.rb

@@ -1,6 +1,8 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe 'g5:export_users' do
+require 'rails_helper'
+
+RSpec.describe 'g5:export_users' do
   include_context 'rake'
 
   let(:user_exporter) { double(:user_exporter, export: nil) }
@@ -43,7 +45,7 @@ describe 'g5:export_users' do
     task.invoke
   end
 
-  it 'should allow the default authorization code to be overridden by an argument' do
+  it 'allows the default authorization code to be overridden by an argument' do
     auth_code_arg = 'some new auth code'
     expect_init_user_exporter_with(:authorization_code, auth_code_arg)
     task.invoke(auth_code_arg)