From b6b7690be440ff2c1fd0c4dfdc56a96e65a7505a Mon Sep 17 00:00:00 2001 From: Hamed Asghari Date: Sat, 17 Aug 2024 13:48:11 -0600 Subject: [PATCH 1/6] chore: Fix deprecation warnings --- spec/dummy/application.rb | 5 +++++ .../clearance/install/install_generator_spec.rb | 14 +++++--------- spec/support/generator_spec_helpers.rb | 11 +++++++++++ 3 files changed, 21 insertions(+), 9 deletions(-) diff --git a/spec/dummy/application.rb b/spec/dummy/application.rb index 884e27bc5..236f3d6ad 100644 --- a/spec/dummy/application.rb +++ b/spec/dummy/application.rb @@ -12,6 +12,11 @@ class Application < Rails::Application if Rails.version.match?(/(6.1|7.0)/) config.active_record.legacy_connection_handling = false end + + if Rails.gem_version >= Gem::Version.new("7.1") + config.active_support.cache_format_version = 7.0 + end + config.active_support.deprecation = :stderr config.eager_load = false diff --git a/spec/generators/clearance/install/install_generator_spec.rb b/spec/generators/clearance/install/install_generator_spec.rb index 8c50a8941..83ec4b6a9 100644 --- a/spec/generators/clearance/install/install_generator_spec.rb +++ b/spec/generators/clearance/install/install_generator_spec.rb @@ -2,10 +2,6 @@ require "generators/clearance/install/install_generator" describe Clearance::Generators::InstallGenerator, :generator do - def get_migration(path) - Pathname.new(migration_file(path)) - end - describe "initializer" do it "is copied to the application" do provide_existing_application_controller @@ -70,7 +66,7 @@ def get_migration(path) table_does_not_exist(:users) run_generator - migration = get_migration("db/migrate/create_users.rb") + migration = migration_file("db/migrate/create_users.rb") expect(migration).to exist expect(migration).to have_correct_syntax @@ -92,7 +88,7 @@ def get_migration(path) table_does_not_exist(:users) run_generator - migration = get_migration("db/migrate/create_users.rb") + migration = migration_file("db/migrate/create_users.rb") expect(migration).to exist expect(migration).to have_correct_syntax @@ -106,8 +102,8 @@ def get_migration(path) provide_existing_application_controller run_generator - create_migration = get_migration("db/migrate/create_users.rb") - add_migration = get_migration("db/migrate/add_clearance_to_users.rb") + create_migration = migration_file("db/migrate/create_users.rb") + add_migration = migration_file("db/migrate/add_clearance_to_users.rb") expect(create_migration).not_to exist expect(add_migration).not_to exist @@ -130,7 +126,7 @@ def get_migration(path) and_return(existing_indexes) run_generator - migration = get_migration("db/migrate/add_clearance_to_users.rb") + migration = migration_file("db/migrate/add_clearance_to_users.rb") expect(migration).to exist expect(migration).to have_correct_syntax diff --git a/spec/support/generator_spec_helpers.rb b/spec/support/generator_spec_helpers.rb index 9c296d72d..b04b957c0 100644 --- a/spec/support/generator_spec_helpers.rb +++ b/spec/support/generator_spec_helpers.rb @@ -3,6 +3,16 @@ require "ammeter/init" module GeneratorSpecHelpers + module FileMethods + def file(path) + Pathname.new(super) + end + + def migration_file(path) + Pathname.new(super) + end + end + TEMPLATE_PATH = File.expand_path("../../app_templates", __FILE__) def provide_existing_routes_file @@ -36,6 +46,7 @@ def copy_to_generator_root(destination, template) RSpec.configure do |config| config.include GeneratorSpecHelpers + config.prepend GeneratorSpecHelpers::FileMethods config.before(:example, :generator) do destination File.expand_path("../../../tmp", __FILE__) From 054df81f28df7e4eaa842be843ef7d8dad2e1657 Mon Sep 17 00:00:00 2001 From: Hamed Asghari Date: Tue, 13 Aug 2024 19:07:05 -0600 Subject: [PATCH 2/6] test: Add spec for BackDoor middleware --- spec/dummy/application.rb | 2 ++ spec/requests/backdoor_spec.rb | 11 +++++++++++ 2 files changed, 13 insertions(+) create mode 100644 spec/requests/backdoor_spec.rb diff --git a/spec/dummy/application.rb b/spec/dummy/application.rb index 236f3d6ad..591748661 100644 --- a/spec/dummy/application.rb +++ b/spec/dummy/application.rb @@ -27,6 +27,8 @@ class Application < Rails::Application config.paths["log"] = "tmp/log/development.log" config.paths.add "config/routes.rb", with: "#{APP_ROOT}/config/routes.rb" + config.middleware.use Clearance::BackDoor + def require_environment! initialize! end diff --git a/spec/requests/backdoor_spec.rb b/spec/requests/backdoor_spec.rb new file mode 100644 index 000000000..75887291e --- /dev/null +++ b/spec/requests/backdoor_spec.rb @@ -0,0 +1,11 @@ +require "spec_helper" + +describe "Backdoor Middleware" do + it "allows signing in using query parameter" do + user = create(:user) + + get root_path(as: user.to_param) + + expect(cookies["remember_token"]).to eq user.remember_token + end +end From 017e2b8c53447e16bacb911bd21b087538a3e7a5 Mon Sep 17 00:00:00 2001 From: Hamed Asghari Date: Sat, 17 Aug 2024 14:01:19 -0600 Subject: [PATCH 3/6] ci: Run tests against Rails 7.2 and Ruby 3.3 --- .github/workflows/tests.yml | 11 +- Appraisals | 4 + Gemfile.lock | 221 +++++++++++++++++------------ gemfiles/rails_7.2.gemfile | 21 +++ spec/support/html_escape_helper.rb | 2 +- 5 files changed, 162 insertions(+), 97 deletions(-) create mode 100644 gemfiles/rails_7.2.gemfile diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index e9d36be79..cc168fddc 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -19,10 +19,15 @@ jobs: - "6.1" - "7.0" - "7.1" + - "7.2" ruby: - - "3.0.4" - - "3.1.2" - - "3.2.2" + - "3.0.7" + - "3.1.6" + - "3.2.5" + - "3.3.4" + exclude: + - gemfile: "7.2" + ruby: "3.0.7" env: BUNDLE_GEMFILE: gemfiles/rails_${{ matrix.gemfile }}.gemfile diff --git a/Appraisals b/Appraisals index 016160470..983aa3da2 100644 --- a/Appraisals +++ b/Appraisals @@ -10,3 +10,7 @@ end appraise "rails_7.1" do gem "railties", "~> 7.1.0" end + +appraise "rails_7.2" do + gem "railties", "~> 7.2.0" +end diff --git a/Gemfile.lock b/Gemfile.lock index f8833fc22..17c83db0c 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -13,49 +13,57 @@ PATH GEM remote: https://rubygems.org/ specs: - actionmailer (7.0.3) - actionpack (= 7.0.3) - actionview (= 7.0.3) - activejob (= 7.0.3) - activesupport (= 7.0.3) - mail (~> 2.5, >= 2.5.4) - net-imap - net-pop - net-smtp - rails-dom-testing (~> 2.0) - actionpack (7.0.3) - actionview (= 7.0.3) - activesupport (= 7.0.3) - rack (~> 2.0, >= 2.2.0) + actionmailer (7.2.0) + actionpack (= 7.2.0) + actionview (= 7.2.0) + activejob (= 7.2.0) + activesupport (= 7.2.0) + mail (>= 2.8.0) + rails-dom-testing (~> 2.2) + actionpack (7.2.0) + actionview (= 7.2.0) + activesupport (= 7.2.0) + nokogiri (>= 1.8.5) + racc + rack (>= 2.2.4, < 3.2) + rack-session (>= 1.0.1) rack-test (>= 0.6.3) - rails-dom-testing (~> 2.0) - rails-html-sanitizer (~> 1.0, >= 1.2.0) - actionview (7.0.3) - activesupport (= 7.0.3) + rails-dom-testing (~> 2.2) + rails-html-sanitizer (~> 1.6) + useragent (~> 0.16) + actionview (7.2.0) + activesupport (= 7.2.0) builder (~> 3.1) - erubi (~> 1.4) - rails-dom-testing (~> 2.0) - rails-html-sanitizer (~> 1.1, >= 1.2.0) - activejob (7.0.3) - activesupport (= 7.0.3) + erubi (~> 1.11) + rails-dom-testing (~> 2.2) + rails-html-sanitizer (~> 1.6) + activejob (7.2.0) + activesupport (= 7.2.0) globalid (>= 0.3.6) - activemodel (7.0.3) - activesupport (= 7.0.3) - activerecord (7.0.3) - activemodel (= 7.0.3) - activesupport (= 7.0.3) - activesupport (7.0.3) - concurrent-ruby (~> 1.0, >= 1.0.2) + activemodel (7.2.0) + activesupport (= 7.2.0) + activerecord (7.2.0) + activemodel (= 7.2.0) + activesupport (= 7.2.0) + timeout (>= 0.4.0) + activesupport (7.2.0) + base64 + bigdecimal + concurrent-ruby (~> 1.0, >= 1.3.1) + connection_pool (>= 2.2.5) + drb i18n (>= 1.6, < 2) + logger (>= 1.4.2) minitest (>= 5.1) - tzinfo (~> 2.0) - addressable (2.8.0) - public_suffix (>= 2.0.2, < 5.0) - ammeter (1.1.5) + securerandom (>= 0.3) + tzinfo (~> 2.0, >= 2.0.5) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + ammeter (1.1.7) activesupport (>= 3.0) railties (>= 3.0) rspec-rails (>= 2.2) - appraisal (2.4.1) + appraisal (2.5.0) bundler rake thor (>= 0.14.0) @@ -63,6 +71,7 @@ GEM ffi (~> 1.15) ffi-compiler (~> 1.0) ast (2.4.2) + base64 (0.2.0) bcrypt (3.1.20) better_html (2.1.1) actionview (>= 6.0) @@ -71,41 +80,44 @@ GEM erubi (~> 1.4) parser (>= 2.4) smart_properties - builder (3.2.4) - capybara (3.37.1) + bigdecimal (3.1.8) + builder (3.3.0) + capybara (3.40.0) addressable matrix mini_mime (>= 0.1.3) - nokogiri (~> 1.8) + nokogiri (~> 1.11) rack (>= 1.6.0) rack-test (>= 0.6.3) regexp_parser (>= 1.5, < 3.0) xpath (~> 3.2) coderay (1.1.3) - concurrent-ruby (1.2.3) + concurrent-ruby (1.3.4) + connection_pool (2.4.1) crass (1.0.6) - database_cleaner (2.0.1) - database_cleaner-active_record (~> 2.0.0) - database_cleaner-active_record (2.0.1) + database_cleaner (2.0.2) + database_cleaner-active_record (>= 2, < 3) + database_cleaner-active_record (2.2.0) activerecord (>= 5.a) database_cleaner-core (~> 2.0.0) database_cleaner-core (2.0.1) date (3.3.4) - diff-lcs (1.5.0) + diff-lcs (1.5.1) + drb (2.2.1) email_validator (2.2.4) activemodel - erb_lint (0.5.0) + erb_lint (0.6.0) activesupport better_html (>= 2.0.1) parser (>= 2.7.1.4) rainbow - rubocop + rubocop (>= 1) smart_properties - erubi (1.12.0) - factory_bot (6.2.1) + erubi (1.13.0) + factory_bot (6.4.6) activesupport (>= 5.0.0) - factory_bot_rails (6.2.0) - factory_bot (~> 6.2.0) + factory_bot_rails (6.4.3) + factory_bot (~> 6.4) railties (>= 5.0.0) ffi (1.17.0) ffi-compiler (1.3.2) @@ -115,8 +127,13 @@ GEM activesupport (>= 6.1) i18n (1.14.5) concurrent-ruby (~> 1.0) + io-console (0.7.2) + irb (1.14.0) + rdoc (>= 4.0.0) + reline (>= 0.4.2) json (2.7.2) language_server-protocol (3.17.0.3) + logger (1.6.0) loofah (2.22.0) crass (~> 1.0.2) nokogiri (>= 1.12.0) @@ -126,10 +143,10 @@ GEM net-pop net-smtp matrix (0.4.2) - method_source (1.0.0) - mini_mime (1.1.2) - mini_portile2 (2.8.6) - minitest (5.22.3) + method_source (1.1.0) + mini_mime (1.1.5) + mini_portile2 (2.8.7) + minitest (5.24.1) net-imap (0.4.14) date net-protocol @@ -139,21 +156,28 @@ GEM timeout net-smtp (0.5.0) net-protocol - nokogiri (1.16.4) + nokogiri (1.16.7) mini_portile2 (~> 2.8.2) racc (~> 1.4) - parallel (1.24.0) - parser (3.3.1.0) + parallel (1.26.2) + parser (3.3.4.2) ast (~> 2.4.1) racc - pry (0.14.1) + pry (0.14.2) coderay (~> 1.1) method_source (~> 1.0) - public_suffix (4.0.7) - racc (1.7.3) - rack (2.2.3.1) - rack-test (1.1.0) - rack (>= 1.0, < 3) + psych (5.1.2) + stringio + public_suffix (6.0.1) + racc (1.8.1) + rack (3.1.7) + rack-session (2.0.0) + rack (>= 3.0.0) + rack-test (2.1.0) + rack (>= 1.3) + rackup (2.1.0) + rack (>= 3) + webrick (~> 1.8) rails-controller-testing (1.0.5) actionpack (>= 5.0.1.rc1) actionview (>= 5.0.1.rc1) @@ -165,62 +189,73 @@ GEM rails-html-sanitizer (1.6.0) loofah (~> 2.21) nokogiri (~> 1.14) - railties (7.0.3) - actionpack (= 7.0.3) - activesupport (= 7.0.3) - method_source + railties (7.2.0) + actionpack (= 7.2.0) + activesupport (= 7.2.0) + irb (~> 1.13) + rackup (>= 1.0.0) rake (>= 12.2) - thor (~> 1.0) - zeitwerk (~> 2.5) + thor (~> 1.0, >= 1.2.2) + zeitwerk (~> 2.6) rainbow (3.1.1) - rake (13.1.0) - regexp_parser (2.9.0) - rexml (3.2.6) - rspec-core (3.11.0) - rspec-support (~> 3.11.0) - rspec-expectations (3.11.0) + rake (13.2.1) + rdoc (6.7.0) + psych (>= 4.0.0) + regexp_parser (2.9.2) + reline (0.5.9) + io-console (~> 0.5) + rexml (3.3.5) + 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.11.0) - rspec-mocks (3.11.1) + rspec-support (~> 3.13.0) + rspec-mocks (3.13.1) diff-lcs (>= 1.2.0, < 2.0) - rspec-support (~> 3.11.0) - rspec-rails (5.1.2) - actionpack (>= 5.2) - activesupport (>= 5.2) - railties (>= 5.2) - rspec-core (~> 3.10) - rspec-expectations (~> 3.10) - rspec-mocks (~> 3.10) - rspec-support (~> 3.10) - rspec-support (3.11.0) - rubocop (1.63.4) + 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.65.1) json (~> 2.3) language_server-protocol (>= 3.17.0) parallel (~> 1.10) parser (>= 3.3.0.2) rainbow (>= 2.2.2, < 4.0) - regexp_parser (>= 1.8, < 3.0) + regexp_parser (>= 2.4, < 3.0) rexml (>= 3.2.5, < 4.0) rubocop-ast (>= 1.31.1, < 2.0) ruby-progressbar (~> 1.7) unicode-display_width (>= 2.4.0, < 3.0) - rubocop-ast (1.31.3) + rubocop-ast (1.32.0) parser (>= 3.3.1.0) ruby-progressbar (1.13.0) - shoulda-matchers (5.1.0) + securerandom (0.3.1) + shoulda-matchers (6.3.1) activesupport (>= 5.2.0) smart_properties (1.17.0) sqlite3 (1.7.3) mini_portile2 (~> 2.8.0) - thor (1.2.1) - timecop (0.9.5) + stringio (3.1.1) + strscan (3.1.0) + thor (1.3.1) + timecop (0.9.10) timeout (0.4.1) tzinfo (2.0.6) concurrent-ruby (~> 1.0) unicode-display_width (2.5.0) + useragent (0.16.10) + webrick (1.8.1) xpath (3.2.0) nokogiri (~> 1.8) - zeitwerk (2.5.4) + zeitwerk (2.6.17) PLATFORMS ruby diff --git a/gemfiles/rails_7.2.gemfile b/gemfiles/rails_7.2.gemfile new file mode 100644 index 000000000..6205f43dc --- /dev/null +++ b/gemfiles/rails_7.2.gemfile @@ -0,0 +1,21 @@ +# This file was generated by Appraisal + +source "https://rubygems.org" + +gem "addressable" +gem "ammeter" +gem "appraisal" +gem "capybara" +gem "database_cleaner" +gem "erb_lint", require: false +gem "factory_bot_rails" +gem "nokogiri" +gem "pry", require: false +gem "rails-controller-testing" +gem "rspec-rails" +gem "shoulda-matchers" +gem "sqlite3", "~> 1.7" +gem "timecop" +gem "railties", "~> 7.2.0" + +gemspec path: "../" diff --git a/spec/support/html_escape_helper.rb b/spec/support/html_escape_helper.rb index 5fcb8c44c..d47edc110 100644 --- a/spec/support/html_escape_helper.rb +++ b/spec/support/html_escape_helper.rb @@ -1,6 +1,6 @@ module HTMLEscapeHelper def translated_string(key) - if Rails.version >= "7.0" + if [7.0, 7.1].include?(Rails::VERSION::STRING.to_f) ERB::Util.html_escape_once(I18n.t(key)) else I18n.t(key) From 500aace11c176fb61352d1905a1b48e8f46f1fc9 Mon Sep 17 00:00:00 2001 From: Hamed Asghari Date: Tue, 13 Aug 2024 20:10:41 -0600 Subject: [PATCH 4/6] chore: Fix rack deprecation warning in BackDoor middleware --- lib/clearance/back_door.rb | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/clearance/back_door.rb b/lib/clearance/back_door.rb index 7736e91d8..f9e62c983 100644 --- a/lib/clearance/back_door.rb +++ b/lib/clearance/back_door.rb @@ -48,11 +48,13 @@ def call(env) # @api private def sign_in_through_the_back_door(env) - params = Rack::Utils.parse_query(env["QUERY_STRING"]) + params = Rack::Utils.parse_query(env[Rack::QUERY_STRING]) user_param = params.delete("as") if user_param.present? - env["QUERY_STRING"] = Rack::Utils.build_query(params) + query_string = Rack::Utils.build_query(params) + env[Rack::QUERY_STRING] = query_string + env[Rack::RACK_REQUEST_QUERY_STRING] = query_string user = find_user(user_param) env[:clearance].sign_in(user) end From aa8b80b303a5b109586f9adb3b43e7cc0fcbb21a Mon Sep 17 00:00:00 2001 From: Hamed Asghari Date: Sun, 18 Aug 2024 15:31:26 -0600 Subject: [PATCH 5/6] test: Use default settings of Rails version under test --- .github/workflows/tests.yml | 4 +- .gitignore | 5 +- Appraisals | 10 +++ Gemfile.lock | 10 +-- Rakefile | 11 +-- bin/setup | 4 +- clearance.gemspec | 3 +- db/schema.rb | 28 ------- gemfiles/rails_6.1.gemfile | 4 + gemfiles/rails_7.0.gemfile | 4 + spec/dummy/Rakefile | 6 ++ spec/dummy/app/assets/config/manifest.js | 0 spec/dummy/application.rb | 40 ---------- spec/dummy/config.ru | 6 ++ spec/dummy/config/application.rb | 13 ++++ spec/dummy/config/boot.rb | 5 ++ spec/dummy/config/environment.rb | 5 ++ spec/dummy/config/environments/test.rb | 31 ++++++++ .../20110111224543_create_clearance_users.rb | 5 +- spec/dummy/db/schema.rb | 25 +++++++ spec/{factories.rb => factories/users.rb} | 0 spec/requests/csrf_rotation_spec.rb | 6 +- spec/spec_helper.rb | 14 +--- spec/support/cookies.rb | 74 ------------------- 24 files changed, 134 insertions(+), 179 deletions(-) delete mode 100644 db/schema.rb create mode 100644 spec/dummy/Rakefile create mode 100644 spec/dummy/app/assets/config/manifest.js delete mode 100644 spec/dummy/application.rb create mode 100644 spec/dummy/config.ru create mode 100644 spec/dummy/config/application.rb create mode 100644 spec/dummy/config/boot.rb create mode 100644 spec/dummy/config/environment.rb create mode 100644 spec/dummy/config/environments/test.rb rename {db => spec/dummy/db}/migrate/20110111224543_create_clearance_users.rb (65%) create mode 100644 spec/dummy/db/schema.rb rename spec/{factories.rb => factories/users.rb} (100%) delete mode 100644 spec/support/cookies.rb diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index cc168fddc..40c30a20a 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -44,8 +44,8 @@ jobs: - name: "Reset app database" run: | - bundle exec rake dummy:db:drop - bundle exec rake dummy:db:setup + bundle exec rake db:drop + bundle exec rake db:setup - name: "Run tests" run: bundle exec rake diff --git a/.gitignore b/.gitignore index e6d58a954..a9de87411 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,10 @@ *.swp *~ .bundle -db/*.sqlite3 +.idea +.tool-versions +spec/dummy/db/*.sqlite3* +spec/dummy/log gemfiles/*.lock gemfiles/vendor/ log/*.log diff --git a/Appraisals b/Appraisals index 983aa3da2..dd0ff5647 100644 --- a/Appraisals +++ b/Appraisals @@ -1,10 +1,20 @@ appraise "rails_6.1" do gem "railties", "~> 6.1.0" gem "net-smtp", require: false # not bundled in ruby 3.1 + # The following gems will not be bundled with Ruby 3.4 + gem "base64", require: false + gem "bigdecimal", require: false + gem "drb", require: false + gem "mutex_m", require: false end appraise "rails_7.0" do gem "railties", "~> 7.0.0" + # The following gems will not be bundled with Ruby 3.4 + gem "base64", require: false + gem "bigdecimal", require: false + gem "drb", require: false + gem "mutex_m", require: false end appraise "rails_7.1" do diff --git a/Gemfile.lock b/Gemfile.lock index 17c83db0c..900f1463f 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -146,7 +146,7 @@ GEM method_source (1.1.0) mini_mime (1.1.5) mini_portile2 (2.8.7) - minitest (5.24.1) + minitest (5.25.1) net-imap (0.4.14) date net-protocol @@ -159,7 +159,7 @@ GEM nokogiri (1.16.7) mini_portile2 (~> 2.8.2) racc (~> 1.4) - parallel (1.26.2) + parallel (1.26.3) parser (3.3.4.2) ast (~> 2.4.1) racc @@ -214,7 +214,7 @@ GEM rspec-mocks (3.13.1) diff-lcs (>= 1.2.0, < 2.0) rspec-support (~> 3.13.0) - rspec-rails (6.1.3) + rspec-rails (6.1.4) actionpack (>= 6.1) activesupport (>= 6.1) railties (>= 6.1) @@ -234,11 +234,11 @@ GEM rubocop-ast (>= 1.31.1, < 2.0) ruby-progressbar (~> 1.7) unicode-display_width (>= 2.4.0, < 3.0) - rubocop-ast (1.32.0) + rubocop-ast (1.32.1) parser (>= 3.3.1.0) ruby-progressbar (1.13.0) securerandom (0.3.1) - shoulda-matchers (6.3.1) + shoulda-matchers (6.4.0) activesupport (>= 5.2.0) smart_properties (1.17.0) sqlite3 (1.7.3) diff --git a/Rakefile b/Rakefile index bbf731b9e..1055b16a2 100644 --- a/Rakefile +++ b/Rakefile @@ -1,15 +1,12 @@ -require "rubygems" require "bundler/setup" + +APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__) +load "rails/tasks/engine.rake" + require "bundler/gem_tasks" -require "rake" require "rspec/core/rake_task" -namespace :dummy do - require_relative "spec/dummy/application" - Dummy::Application.load_tasks -end - desc "Run specs other than spec/acceptance" RSpec::Core::RakeTask.new("spec") do |task| task.exclude_pattern = "spec/acceptance/**/*_spec.rb" diff --git a/bin/setup b/bin/setup index 63cb3481e..166e8554d 100755 --- a/bin/setup +++ b/bin/setup @@ -12,5 +12,5 @@ if [ -z "$CI" ]; then fi # Set up database for the application that Clearance tests against -RAILS_ENV=test bundle exec rake dummy:db:drop -RAILS_ENV=test bundle exec rake dummy:db:setup +RAILS_ENV=test bundle exec rake db:drop +RAILS_ENV=test bundle exec rake db:setup diff --git a/clearance.gemspec b/clearance.gemspec index e91d8c12e..bd989fbf6 100644 --- a/clearance.gemspec +++ b/clearance.gemspec @@ -1,5 +1,4 @@ -$LOAD_PATH.push File.expand_path('../lib', __FILE__) -require 'clearance/version' +require_relative 'lib/clearance/version' Gem::Specification.new do |s| s.add_dependency 'bcrypt', '>= 3.1.1' diff --git a/db/schema.rb b/db/schema.rb deleted file mode 100644 index ed0146752..000000000 --- a/db/schema.rb +++ /dev/null @@ -1,28 +0,0 @@ -# encoding: UTF-8 -# This file is auto-generated from the current state of the database. Instead -# of editing this file, please use the migrations feature of Active Record to -# incrementally modify your database, and then regenerate this schema definition. -# -# Note that this schema.rb definition is the authoritative source for your -# database schema. If you need to create the application database on another -# system, you should be using db:schema:load, not running all the migrations -# from scratch. The latter is a flawed and unsustainable approach (the more migrations -# you'll amass, the slower it'll run and the greater likelihood for issues). -# -# It's strongly recommended that you check this file into your version control system. - -ActiveRecord::Schema.define(version: 20110111224543) do - - create_table "users", force: true do |t| - t.datetime "created_at", null: false - t.datetime "updated_at", null: false - t.string "email", null: false - t.string "encrypted_password", limit: 128, null: false - t.string "confirmation_token", limit: 128 - t.string "remember_token", limit: 128, null: false - end - - add_index "users", ["email"], name: "index_users_on_email" - add_index "users", ["confirmation_token"], name: "index_users_on_confirmation_token", unique: true - add_index "users", ["remember_token"], name: "index_users_on_remember_token", unique: true -end diff --git a/gemfiles/rails_6.1.gemfile b/gemfiles/rails_6.1.gemfile index fa52260cf..a61e39f81 100644 --- a/gemfiles/rails_6.1.gemfile +++ b/gemfiles/rails_6.1.gemfile @@ -18,5 +18,9 @@ gem "sqlite3", "~> 1.7" gem "timecop" gem "railties", "~> 6.1.0" gem "net-smtp", require: false +gem "base64", require: false +gem "bigdecimal", require: false +gem "drb", require: false +gem "mutex_m", require: false gemspec path: "../" diff --git a/gemfiles/rails_7.0.gemfile b/gemfiles/rails_7.0.gemfile index 5b6bc25d9..f603939bc 100644 --- a/gemfiles/rails_7.0.gemfile +++ b/gemfiles/rails_7.0.gemfile @@ -17,5 +17,9 @@ gem "shoulda-matchers" gem "sqlite3", "~> 1.7" gem "timecop" gem "railties", "~> 7.0.0" +gem "base64", require: false +gem "bigdecimal", require: false +gem "drb", require: false +gem "mutex_m", require: false gemspec path: "../" diff --git a/spec/dummy/Rakefile b/spec/dummy/Rakefile new file mode 100644 index 000000000..9a5ea7383 --- /dev/null +++ b/spec/dummy/Rakefile @@ -0,0 +1,6 @@ +# Add your own tasks in files placed in lib/tasks ending in .rake, +# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake. + +require_relative "config/application" + +Rails.application.load_tasks diff --git a/spec/dummy/app/assets/config/manifest.js b/spec/dummy/app/assets/config/manifest.js new file mode 100644 index 000000000..e69de29bb diff --git a/spec/dummy/application.rb b/spec/dummy/application.rb deleted file mode 100644 index 591748661..000000000 --- a/spec/dummy/application.rb +++ /dev/null @@ -1,40 +0,0 @@ -require "rails/all" - -require "clearance" - -module Dummy - APP_ROOT = File.expand_path("..", __FILE__).freeze - - class Application < Rails::Application - config.action_controller.perform_caching = false - config.action_mailer.default_url_options = { host: "dummy.example.com" } - config.action_mailer.delivery_method = :test - if Rails.version.match?(/(6.1|7.0)/) - config.active_record.legacy_connection_handling = false - end - - if Rails.gem_version >= Gem::Version.new("7.1") - config.active_support.cache_format_version = 7.0 - end - - config.active_support.deprecation = :stderr - config.eager_load = false - - config.paths["app/controllers"] << "#{APP_ROOT}/app/controllers" - config.paths["app/models"] << "#{APP_ROOT}/app/models" - config.paths["app/views"] << "#{APP_ROOT}/app/views" - config.paths["config/database"] = "#{APP_ROOT}/config/database.yml" - config.paths["log"] = "tmp/log/development.log" - config.paths.add "config/routes.rb", with: "#{APP_ROOT}/config/routes.rb" - - config.middleware.use Clearance::BackDoor - - def require_environment! - initialize! - end - - def initialize!(&block) - super unless @initialized - end - end -end diff --git a/spec/dummy/config.ru b/spec/dummy/config.ru new file mode 100644 index 000000000..4a3c09a68 --- /dev/null +++ b/spec/dummy/config.ru @@ -0,0 +1,6 @@ +# This file is used by Rack-based servers to start the application. + +require_relative "config/environment" + +run Rails.application +Rails.application.load_server diff --git a/spec/dummy/config/application.rb b/spec/dummy/config/application.rb new file mode 100644 index 000000000..e384d724c --- /dev/null +++ b/spec/dummy/config/application.rb @@ -0,0 +1,13 @@ +require_relative "boot" + +require "rails/all" + +# Require the gems listed in Gemfile, including any gems +# you've limited to :test, :development, or :production. +Bundler.require(*Rails.groups) + +module Dummy + class Application < Rails::Application + config.load_defaults Rails::VERSION::STRING.to_f + end +end diff --git a/spec/dummy/config/boot.rb b/spec/dummy/config/boot.rb new file mode 100644 index 000000000..116591a4e --- /dev/null +++ b/spec/dummy/config/boot.rb @@ -0,0 +1,5 @@ +# Set up gems listed in the Gemfile. +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../Gemfile", __dir__) + +require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"]) +$LOAD_PATH.unshift File.expand_path("../../../lib", __dir__) diff --git a/spec/dummy/config/environment.rb b/spec/dummy/config/environment.rb new file mode 100644 index 000000000..cac531577 --- /dev/null +++ b/spec/dummy/config/environment.rb @@ -0,0 +1,5 @@ +# Load the Rails application. +require_relative "application" + +# Initialize the Rails application. +Rails.application.initialize! diff --git a/spec/dummy/config/environments/test.rb b/spec/dummy/config/environments/test.rb new file mode 100644 index 000000000..e61ca8af4 --- /dev/null +++ b/spec/dummy/config/environments/test.rb @@ -0,0 +1,31 @@ +require "active_support/core_ext/integer/time" + +Rails.application.configure do + config.enable_reloading = false + + config.eager_load = ENV["CI"].present? + + config.public_file_server.headers = { "Cache-Control" => "public, max-age=#{1.hour.to_i}" } + + # Show full error reports and disable caching. + config.consider_all_requests_local = true + config.action_controller.perform_caching = false + config.cache_store = :null_store + + config.action_dispatch.show_exceptions = :rescuable + + config.action_controller.allow_forgery_protection = false + + config.action_mailer.perform_caching = false + config.action_mailer.delivery_method = :test + + config.action_mailer.default_url_options = { host: "www.example.com" } + + config.active_support.deprecation = :stderr + config.active_support.disallowed_deprecation = :raise + config.active_support.disallowed_deprecation_warnings = [] + + config.factory_bot.definition_file_paths = [File.expand_path('../../../factories', __dir__)] + + config.middleware.use Clearance::BackDoor +end diff --git a/db/migrate/20110111224543_create_clearance_users.rb b/spec/dummy/db/migrate/20110111224543_create_clearance_users.rb similarity index 65% rename from db/migrate/20110111224543_create_clearance_users.rb rename to spec/dummy/db/migrate/20110111224543_create_clearance_users.rb index 75e22bfee..bd83cb9fb 100644 --- a/db/migrate/20110111224543_create_clearance_users.rb +++ b/spec/dummy/db/migrate/20110111224543_create_clearance_users.rb @@ -1,4 +1,4 @@ -class CreateClearanceUsers < ActiveRecord::Migration +class CreateClearanceUsers < ActiveRecord::Migration[Rails::VERSION::STRING.to_f] def self.up create_table :users do |t| t.timestamps null: false @@ -9,7 +9,8 @@ def self.up end add_index :users, :email - add_index :users, :remember_token + add_index :users, :confirmation_token, unique: true + add_index :users, :remember_token, unique: true end def self.down diff --git a/spec/dummy/db/schema.rb b/spec/dummy/db/schema.rb new file mode 100644 index 000000000..cad6f33ef --- /dev/null +++ b/spec/dummy/db/schema.rb @@ -0,0 +1,25 @@ +# This file is auto-generated from the current state of the database. Instead +# of editing this file, please use the migrations feature of Active Record to +# incrementally modify your database, and then regenerate this schema definition. +# +# This file is the source Rails uses to define your schema when running `bin/rails +# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to +# be faster and is potentially less error prone than running all of your +# migrations from scratch. Old migrations may fail to apply correctly if those +# migrations use external dependencies or application code. +# +# It's strongly recommended that you check this file into your version control system. + +ActiveRecord::Schema.define(version: 2011_01_11_224543) do + create_table "users", force: :cascade do |t| + t.datetime "created_at", null: false + t.datetime "updated_at", null: false + t.string "email", null: false + t.string "encrypted_password", limit: 128, null: false + t.string "confirmation_token", limit: 128 + t.string "remember_token", limit: 128, null: false + t.index ["confirmation_token"], name: "index_users_on_confirmation_token", unique: true + t.index ["email"], name: "index_users_on_email" + t.index ["remember_token"], name: "index_users_on_remember_token", unique: true + end +end diff --git a/spec/factories.rb b/spec/factories/users.rb similarity index 100% rename from spec/factories.rb rename to spec/factories/users.rb diff --git a/spec/requests/csrf_rotation_spec.rb b/spec/requests/csrf_rotation_spec.rb index 2119c8d67..ba03d652e 100644 --- a/spec/requests/csrf_rotation_spec.rb +++ b/spec/requests/csrf_rotation_spec.rb @@ -16,7 +16,7 @@ original_token = csrf_token post session_path, params: { - session: session_params(user, "password"), + authenticity_token: csrf_token, session: { email: user.email, password: "password" } } expect(csrf_token).not_to eq original_token @@ -28,8 +28,4 @@ def csrf_token session[:_csrf_token] end - - def session_params(user, password) - { email: user.email, password: password, authenticity_token: csrf_token } - end end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 191cb880a..320534a73 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -1,18 +1,10 @@ ENV["RAILS_ENV"] ||= "test" +require_relative "dummy/config/environment" -require "rails/all" -require "dummy/application" - -require "clearance/rspec" -require "factory_bot_rails" -require "rails-controller-testing" require "rspec/rails" -require "shoulda-matchers" -require "timecop" - -Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f } +require "clearance/rspec" -Dummy::Application.initialize! +Dir[File.expand_path("spec/support/**/*.rb")].each { |f| require f } RSpec.configure do |config| config.include FactoryBot::Syntax::Methods diff --git a/spec/support/cookies.rb b/spec/support/cookies.rb deleted file mode 100644 index fd608b9d5..000000000 --- a/spec/support/cookies.rb +++ /dev/null @@ -1,74 +0,0 @@ -RSpec::Matchers.define :set_cookie do |name, expected_value, expected_expires_at| - failure_message do - "Expected #{expectation} got #{result}" - end - - match do |subject| - @headers = subject - @expected_name = name - @expected_value = expected_value - @expected_expires_at = expected_expires_at - extract_cookies - find_expected_cookie - parse_expiration - parse_value - parse_path - ensure_cookie_set - ensure_expiration_correct - ensure_path_is_correct - end - - def ensure_cookie_set - expect(@value).to eq @expected_value - end - - def ensure_expiration_correct - expect(@expires_at).not_to be_nil - expect(@expires_at).to be_within(100).of(@expected_expires_at) - end - - def ensure_path_is_correct - expect(@path).to eq '/' - end - - def expectation - "a cookie named #{@expected_name} with value #{@expected_value.inspect} expiring at #{@expected_expires_at.inspect}" - end - - def extract_cookies - @cookie_headers = @headers["Set-Cookie"] || @headers["set-cookie"] || [] - @cookie_headers = [@cookie_headers] if @cookie_headers.respond_to?(:to_str) - end - - def find_expected_cookie - @cookie = @cookie_headers.detect do |header| - header =~ /^#{@expected_name}=[^;]*(;|$)/ - end - end - - def parse_expiration - if @cookie && result = @cookie.match(/; expires=(.*?)(;|$)/) - @expires_at = Time.parse(result[1]) - end - end - - def parse_path - if @cookie && result = @cookie.match(/; path=(.*?)(;|$)/) - @path = result[1] - end - end - - def parse_value - if @cookie && result = @cookie.match(/=(.*?)(?:;|$)/) - @value = result[1] - end - end - - def result - if @cookie - @cookie - else - @cookie_headers.join("; ") - end - end -end From 5fb25a845cc0b36ad626dc5b0aa5fd88e03d9816 Mon Sep 17 00:00:00 2001 From: Hamed Asghari Date: Sun, 18 Aug 2024 15:35:04 -0600 Subject: [PATCH 6/6] test: Remove dependency on timecop gem Use ActiveSupport::Testing::TimeHelpers instead --- Gemfile | 1 - Gemfile.lock | 2 -- gemfiles/rails_6.1.gemfile | 1 - gemfiles/rails_7.0.gemfile | 1 - gemfiles/rails_7.1.gemfile | 1 - gemfiles/rails_7.2.gemfile | 1 - spec/clearance/session_spec.rb | 4 ++-- spec/requests/token_expiration_spec.rb | 6 +++--- spec/spec_helper.rb | 1 + 9 files changed, 6 insertions(+), 12 deletions(-) diff --git a/Gemfile b/Gemfile index 973a4ccc9..e560bef2a 100644 --- a/Gemfile +++ b/Gemfile @@ -15,4 +15,3 @@ gem 'rails-controller-testing' gem 'rspec-rails' gem 'shoulda-matchers' gem 'sqlite3', '~> 1.7' -gem 'timecop' diff --git a/Gemfile.lock b/Gemfile.lock index 900f1463f..248104724 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -246,7 +246,6 @@ GEM stringio (3.1.1) strscan (3.1.0) thor (1.3.1) - timecop (0.9.10) timeout (0.4.1) tzinfo (2.0.6) concurrent-ruby (~> 1.0) @@ -275,7 +274,6 @@ DEPENDENCIES rspec-rails shoulda-matchers sqlite3 (~> 1.7) - timecop BUNDLED WITH 2.3.15 diff --git a/gemfiles/rails_6.1.gemfile b/gemfiles/rails_6.1.gemfile index a61e39f81..e5b063d36 100644 --- a/gemfiles/rails_6.1.gemfile +++ b/gemfiles/rails_6.1.gemfile @@ -15,7 +15,6 @@ gem "rails-controller-testing" gem "rspec-rails" gem "shoulda-matchers" gem "sqlite3", "~> 1.7" -gem "timecop" gem "railties", "~> 6.1.0" gem "net-smtp", require: false gem "base64", require: false diff --git a/gemfiles/rails_7.0.gemfile b/gemfiles/rails_7.0.gemfile index f603939bc..513bdec1f 100644 --- a/gemfiles/rails_7.0.gemfile +++ b/gemfiles/rails_7.0.gemfile @@ -15,7 +15,6 @@ gem "rails-controller-testing" gem "rspec-rails" gem "shoulda-matchers" gem "sqlite3", "~> 1.7" -gem "timecop" gem "railties", "~> 7.0.0" gem "base64", require: false gem "bigdecimal", require: false diff --git a/gemfiles/rails_7.1.gemfile b/gemfiles/rails_7.1.gemfile index a39b7c9c2..5d53a414d 100644 --- a/gemfiles/rails_7.1.gemfile +++ b/gemfiles/rails_7.1.gemfile @@ -15,7 +15,6 @@ gem "rails-controller-testing" gem "rspec-rails" gem "shoulda-matchers" gem "sqlite3", "~> 1.7" -gem "timecop" gem "railties", "~> 7.1.0" gemspec path: "../" diff --git a/gemfiles/rails_7.2.gemfile b/gemfiles/rails_7.2.gemfile index 6205f43dc..e5229eb19 100644 --- a/gemfiles/rails_7.2.gemfile +++ b/gemfiles/rails_7.2.gemfile @@ -15,7 +15,6 @@ gem "rails-controller-testing" gem "rspec-rails" gem "shoulda-matchers" gem "sqlite3", "~> 1.7" -gem "timecop" gem "railties", "~> 7.2.0" gemspec path: "../" diff --git a/spec/clearance/session_spec.rb b/spec/clearance/session_spec.rb index ec5517f21..7c33f9d5c 100644 --- a/spec/clearance/session_spec.rb +++ b/spec/clearance/session_spec.rb @@ -1,8 +1,8 @@ require 'spec_helper' describe Clearance::Session do - before { Timecop.freeze } - after { Timecop.return } + before { freeze_time } + after { unfreeze_time } let(:session) { Clearance::Session.new(env_without_remember_token) } let(:user) { create(:user) } diff --git a/spec/requests/token_expiration_spec.rb b/spec/requests/token_expiration_spec.rb index 0db8e9d25..4e1d394c3 100644 --- a/spec/requests/token_expiration_spec.rb +++ b/spec/requests/token_expiration_spec.rb @@ -3,13 +3,13 @@ describe "Token expiration" do describe "after signing in" do before do - Timecop.freeze + freeze_time create_user_and_sign_in @initial_cookies = remember_token_cookies end after do - Timecop.return + unfreeze_time end it "should have a remember_token cookie with a future expiration" do @@ -25,7 +25,7 @@ create_user_and_sign_in @initial_cookies = remember_token_cookies - Timecop.travel(1.minute.from_now) do + travel_to(1.minute.from_now) do get root_path @followup_cookies = remember_token_cookies end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 320534a73..f91a1d910 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -7,6 +7,7 @@ Dir[File.expand_path("spec/support/**/*.rb")].each { |f| require f } RSpec.configure do |config| + config.include ActiveSupport::Testing::TimeHelpers config.include FactoryBot::Syntax::Methods config.infer_spec_type_from_file_location! config.order = :random