From 13aa7db90d00b174f42b96139405424a246209ec Mon Sep 17 00:00:00 2001 From: Michael Ball Date: Wed, 24 Feb 2021 03:32:19 -0800 Subject: [PATCH] use TODO-SNAPCON for the comment tag since rubocop is not flexible enough --- .rubocop.yml | 2 +- config/initializers/devise.rb | 2 +- spec/controllers/admin/conferences_controller_spec.rb | 6 +++--- spec/features/commercials_spec.rb | 2 +- spec/features/organizer_ability_spec.rb | 2 +- spec/features/versions_spec.rb | 4 ++-- spec/models/registration_spec.rb | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 0c3179a5..bb2c0778 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -17,8 +17,8 @@ AllCops: Style/CommentAnnotation: Keywords: + - TODO-SNAPCON - TODO - - TODO (snapcon) - OPTIMIZE - HACK - REVIEW diff --git a/config/initializers/devise.rb b/config/initializers/devise.rb index ab9a2636..0ddb8415 100644 --- a/config/initializers/devise.rb +++ b/config/initializers/devise.rb @@ -14,7 +14,7 @@ Devise.setup do |config| name: 'google', scope: 'email' - # TODO (snapcon): This ought to be configurable. Use OSEM_DISCOURSE_KEY? + # TODO-SNAPCON: This ought to be configurable. Use OSEM_DISCOURSE_KEY? config.omniauth :discourse, sso_url: 'https://forum.snap.berkeley.edu/session/sso_provider', sso_secret: ENV['OSEM_DISCOURSE_SECRET'] diff --git a/spec/controllers/admin/conferences_controller_spec.rb b/spec/controllers/admin/conferences_controller_spec.rb index 9c317476..43d45573 100644 --- a/spec/controllers/admin/conferences_controller_spec.rb +++ b/spec/controllers/admin/conferences_controller_spec.rb @@ -98,7 +98,7 @@ describe Admin::ConferencesController do expect(response).to render_template :show end - # TODO (snapcon): This is currently disabled due to slow performance. + # TODO-SNAPCON: This is currently disabled due to slow performance. skip 'assigns conference withdrawn events distribution to event_type_distribution_withdrawn' do conference create(:event, program: conference.program) @@ -122,7 +122,7 @@ describe Admin::ConferencesController do expect(assigns(:event_type_distribution_withdrawn)).to eq(result) end - # TODO (snapcon): This is currently disabled due to slow performance. + # TODO-SNAPCON: This is currently disabled due to slow performance. skip 'assigns conference withdrawn difficulty level distribution to difficulty_levels_distribution_withdrawn' do conference create(:event, program: conference.program) @@ -146,7 +146,7 @@ describe Admin::ConferencesController do expect(assigns(:difficulty_levels_distribution_withdrawn)).to eq(result) end - # TODO (snapcon): This is currently disabled due to slow performance. + # TODO-SNAPCON: This is currently disabled due to slow performance. skip 'assigns conference withdrawn track distribution to tracks_distribution_withdrawn' do conference create(:event, program: conference.program) diff --git a/spec/features/commercials_spec.rb b/spec/features/commercials_spec.rb index 46cf8906..13c46f3b 100644 --- a/spec/features/commercials_spec.rb +++ b/spec/features/commercials_spec.rb @@ -68,7 +68,7 @@ feature Commercial do end scenario 'does not add an invalid commercial of an event', feature: true, js: true do - # TODO (snapcon) + # TODO-SNAPCON skip("Snap!Con allows all materials to be saved.") visit edit_conference_program_proposal_path(conference.short_title, event.id) click_link 'Materials' diff --git a/spec/features/organizer_ability_spec.rb b/spec/features/organizer_ability_spec.rb index 701d7446..3ddc4203 100644 --- a/spec/features/organizer_ability_spec.rb +++ b/spec/features/organizer_ability_spec.rb @@ -61,7 +61,7 @@ feature 'Has correct abilities' do expect(page).to_not have_link('New Conference', href: '/admin/conferences/new') visit admin_conference_path(other_conference.short_title) - # TODO (snapcon): This conference already seems to have a venue. + # TODO-SNAPCON: This conference already seems to have a venue. # expect(page).to have_link('Add venue', href: "/admin/conferences/#{other_conference.short_title}/venue/new") visit edit_admin_conference_path(conference.short_title) diff --git a/spec/features/versions_spec.rb b/spec/features/versions_spec.rb index 4b786326..17820104 100644 --- a/spec/features/versions_spec.rb +++ b/spec/features/versions_spec.rb @@ -231,7 +231,7 @@ feature 'Version' do expect(page).to have_text("Someone (probably via the console) deleted difficulty level Expert with ID #{difficulty_level_id} in conference #{conference.short_title}") end - # TODO (snapcon): Figure out why this is failing!! + # TODO-SNAPCON: Figure out why this is failing!! skip 'display changes in splashpages', feature: true, versioning: true, js: true do visit admin_conference_splashpage_path(conference.short_title) click_link 'Create Splashpage' @@ -300,7 +300,7 @@ feature 'Version' do visit admin_conference_program_event_path(conference.short_title, event_with_commercial) click_link 'History' - # TODO (snapcon): Figure out why this is here... + # TODO-SNAPCON: Figure out why this is here... # expect(page).to have_text('Someone (probably via the console) created new commercial') visit admin_conference_program_event_path(conference.short_title, event_without_commercial) click_link 'History' diff --git a/spec/models/registration_spec.rb b/spec/models/registration_spec.rb index 9d6273ce..45813810 100644 --- a/spec/models/registration_spec.rb +++ b/spec/models/registration_spec.rb @@ -45,7 +45,7 @@ describe Registration do describe 'association' do it { is_expected.to belong_to(:user) } - # TODO (snapcon): This fails because conference is nil, but obviously this works... + # TODO-SNAPCON: This fails because conference is nil, but obviously this works... # it { is_expected.to belong_to(:conference) } it { is_expected.to have_and_belong_to_many(:qanswers) } it { is_expected.to have_and_belong_to_many(:vchoices) }