From 951781a21b8e029b51ef16a571480cdb2ab3d097 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radan=20Skori=C4=87?= Date: Mon, 10 Jun 2024 17:23:58 +0200 Subject: [PATCH] Add blog post on breaking out of a frame on successful form submit The rails app inside the spec folder is an app added just to be able to add tests for Rails features mentioned in articles. --- .gitignore | 5 + ...euse-same-page-in-multiple-frames.markdown | 2 +- ...full-page-on-form-in-frame-submit.markdown | 152 ++++++++++++++++++ spec/rails_app/.ruby-version | 1 + spec/rails_app/Gemfile | 64 ++++++++ spec/rails_app/README.md | 24 +++ spec/rails_app/Rakefile | 6 + spec/rails_app/app/assets/images/.keep | 0 .../app/assets/stylesheets/application.css | 1 + .../app/channels/application_cable/channel.rb | 4 + .../channels/application_cable/connection.rb | 4 + .../app/controllers/application_controller.rb | 2 + spec/rails_app/app/controllers/concerns/.keep | 0 .../controllers/form_in_frame_controller.rb | 41 +++++ .../app/helpers/application_helper.rb | 2 + .../app/helpers/form_in_frame_helper.rb | 2 + spec/rails_app/app/javascript/application.js | 12 ++ .../app/javascript/controllers/application.js | 9 ++ .../controllers/hello_controller.js | 7 + .../app/javascript/controllers/index.js | 11 ++ spec/rails_app/app/jobs/application_job.rb | 7 + .../app/mailers/application_mailer.rb | 4 + .../app/models/application_record.rb | 3 + spec/rails_app/app/models/concerns/.keep | 0 .../app/views/form_in_frame/_error.html.erb | 3 + .../app/views/form_in_frame/index.html.erb | 49 ++++++ .../app/views/layouts/application.html.erb | 19 +++ .../app/views/layouts/mailer.html.erb | 13 ++ .../app/views/layouts/mailer.text.erb | 1 + spec/rails_app/bin/bundle | 109 +++++++++++++ spec/rails_app/bin/importmap | 4 + spec/rails_app/bin/rails | 4 + spec/rails_app/bin/rake | 4 + spec/rails_app/bin/setup | 33 ++++ spec/rails_app/config.ru | 6 + spec/rails_app/config/application.rb | 30 ++++ spec/rails_app/config/boot.rb | 4 + spec/rails_app/config/cable.yml | 10 ++ spec/rails_app/config/credentials.yml.enc | 1 + spec/rails_app/config/database.yml | 25 +++ spec/rails_app/config/environment.rb | 5 + .../config/environments/development.rb | 71 ++++++++ .../config/environments/production.rb | 91 +++++++++++ spec/rails_app/config/environments/test.rb | 64 ++++++++ spec/rails_app/config/importmap.rb | 7 + spec/rails_app/config/initializers/assets.rb | 7 + .../initializers/content_security_policy.rb | 25 +++ .../initializers/filter_parameter_logging.rb | 8 + .../config/initializers/inflections.rb | 16 ++ .../config/initializers/permissions_policy.rb | 13 ++ spec/rails_app/config/locales/en.yml | 31 ++++ spec/rails_app/config/master.key | 1 + spec/rails_app/config/puma.rb | 35 ++++ spec/rails_app/config/routes.rb | 14 ++ spec/rails_app/config/storage.yml | 34 ++++ spec/rails_app/db/seeds.rb | 9 ++ spec/rails_app/lib/assets/.keep | 0 spec/rails_app/lib/tasks/.keep | 0 spec/rails_app/log/.keep | 0 spec/rails_app/public/404.html | 67 ++++++++ spec/rails_app/public/422.html | 67 ++++++++ spec/rails_app/public/500.html | 66 ++++++++ .../public/apple-touch-icon-precomposed.png | 0 spec/rails_app/public/apple-touch-icon.png | 0 spec/rails_app/public/favicon.ico | 0 spec/rails_app/public/robots.txt | 1 + spec/rails_app/storage/.keep | 0 .../test/application_system_test_case.rb | 5 + .../application_cable/connection_test.rb | 13 ++ spec/rails_app/test/controllers/.keep | 0 .../form_in_frame_controller_test.rb | 8 + spec/rails_app/test/fixtures/files/.keep | 0 spec/rails_app/test/helpers/.keep | 0 spec/rails_app/test/integration/.keep | 0 spec/rails_app/test/mailers/.keep | 0 spec/rails_app/test/models/.keep | 0 spec/rails_app/test/system/.keep | 0 .../test/system/form_in_frame_test.rb | 67 ++++++++ spec/rails_app/test/test_helper.rb | 15 ++ 79 files changed, 1417 insertions(+), 1 deletion(-) create mode 100644 _posts/2024-06-11-update-full-page-on-form-in-frame-submit.markdown create mode 100644 spec/rails_app/.ruby-version create mode 100644 spec/rails_app/Gemfile create mode 100644 spec/rails_app/README.md create mode 100644 spec/rails_app/Rakefile create mode 100644 spec/rails_app/app/assets/images/.keep create mode 100644 spec/rails_app/app/assets/stylesheets/application.css create mode 100644 spec/rails_app/app/channels/application_cable/channel.rb create mode 100644 spec/rails_app/app/channels/application_cable/connection.rb create mode 100644 spec/rails_app/app/controllers/application_controller.rb create mode 100644 spec/rails_app/app/controllers/concerns/.keep create mode 100644 spec/rails_app/app/controllers/form_in_frame_controller.rb create mode 100644 spec/rails_app/app/helpers/application_helper.rb create mode 100644 spec/rails_app/app/helpers/form_in_frame_helper.rb create mode 100644 spec/rails_app/app/javascript/application.js create mode 100644 spec/rails_app/app/javascript/controllers/application.js create mode 100644 spec/rails_app/app/javascript/controllers/hello_controller.js create mode 100644 spec/rails_app/app/javascript/controllers/index.js create mode 100644 spec/rails_app/app/jobs/application_job.rb create mode 100644 spec/rails_app/app/mailers/application_mailer.rb create mode 100644 spec/rails_app/app/models/application_record.rb create mode 100644 spec/rails_app/app/models/concerns/.keep create mode 100644 spec/rails_app/app/views/form_in_frame/_error.html.erb create mode 100644 spec/rails_app/app/views/form_in_frame/index.html.erb create mode 100644 spec/rails_app/app/views/layouts/application.html.erb create mode 100644 spec/rails_app/app/views/layouts/mailer.html.erb create mode 100644 spec/rails_app/app/views/layouts/mailer.text.erb create mode 100755 spec/rails_app/bin/bundle create mode 100755 spec/rails_app/bin/importmap create mode 100755 spec/rails_app/bin/rails create mode 100755 spec/rails_app/bin/rake create mode 100755 spec/rails_app/bin/setup create mode 100644 spec/rails_app/config.ru create mode 100644 spec/rails_app/config/application.rb create mode 100644 spec/rails_app/config/boot.rb create mode 100644 spec/rails_app/config/cable.yml create mode 100644 spec/rails_app/config/credentials.yml.enc create mode 100644 spec/rails_app/config/database.yml create mode 100644 spec/rails_app/config/environment.rb create mode 100644 spec/rails_app/config/environments/development.rb create mode 100644 spec/rails_app/config/environments/production.rb create mode 100644 spec/rails_app/config/environments/test.rb create mode 100644 spec/rails_app/config/importmap.rb create mode 100644 spec/rails_app/config/initializers/assets.rb create mode 100644 spec/rails_app/config/initializers/content_security_policy.rb create mode 100644 spec/rails_app/config/initializers/filter_parameter_logging.rb create mode 100644 spec/rails_app/config/initializers/inflections.rb create mode 100644 spec/rails_app/config/initializers/permissions_policy.rb create mode 100644 spec/rails_app/config/locales/en.yml create mode 100644 spec/rails_app/config/master.key create mode 100644 spec/rails_app/config/puma.rb create mode 100644 spec/rails_app/config/routes.rb create mode 100644 spec/rails_app/config/storage.yml create mode 100644 spec/rails_app/db/seeds.rb create mode 100644 spec/rails_app/lib/assets/.keep create mode 100644 spec/rails_app/lib/tasks/.keep create mode 100644 spec/rails_app/log/.keep create mode 100644 spec/rails_app/public/404.html create mode 100644 spec/rails_app/public/422.html create mode 100644 spec/rails_app/public/500.html create mode 100644 spec/rails_app/public/apple-touch-icon-precomposed.png create mode 100644 spec/rails_app/public/apple-touch-icon.png create mode 100644 spec/rails_app/public/favicon.ico create mode 100644 spec/rails_app/public/robots.txt create mode 100644 spec/rails_app/storage/.keep create mode 100644 spec/rails_app/test/application_system_test_case.rb create mode 100644 spec/rails_app/test/channels/application_cable/connection_test.rb create mode 100644 spec/rails_app/test/controllers/.keep create mode 100644 spec/rails_app/test/controllers/form_in_frame_controller_test.rb create mode 100644 spec/rails_app/test/fixtures/files/.keep create mode 100644 spec/rails_app/test/helpers/.keep create mode 100644 spec/rails_app/test/integration/.keep create mode 100644 spec/rails_app/test/mailers/.keep create mode 100644 spec/rails_app/test/models/.keep create mode 100644 spec/rails_app/test/system/.keep create mode 100644 spec/rails_app/test/system/form_in_frame_test.rb create mode 100644 spec/rails_app/test/test_helper.rb diff --git a/.gitignore b/.gitignore index cbaef15..666bd26 100644 --- a/.gitignore +++ b/.gitignore @@ -22,3 +22,8 @@ package-lock.json # Misc assets/js/dist .DS_Store + +# The test rails app that's inside the spec folder +spec/rails_app/tmp/ +spec/rails_app/log/*.log +spec/rails_app/storage diff --git a/_posts/2024-05-28-reuse-same-page-in-multiple-frames.markdown b/_posts/2024-05-28-reuse-same-page-in-multiple-frames.markdown index 0c69703..ca8019f 100644 --- a/_posts/2024-05-28-reuse-same-page-in-multiple-frames.markdown +++ b/_posts/2024-05-28-reuse-same-page-in-multiple-frames.markdown @@ -1,7 +1,7 @@ --- layout: post title: "How to reuse the same page in different Turbo Frame flows" -date: 2024-05-24 +date: 2024-05-28 categories: articles tags: rails hotwire turbo turbo-frames --- diff --git a/_posts/2024-06-11-update-full-page-on-form-in-frame-submit.markdown b/_posts/2024-06-11-update-full-page-on-form-in-frame-submit.markdown new file mode 100644 index 0000000..37a00d7 --- /dev/null +++ b/_posts/2024-06-11-update-full-page-on-form-in-frame-submit.markdown @@ -0,0 +1,152 @@ +--- +layout: post +title: "How to refresh the full page when submitting a form inside a Turbo Frame?" +date: 2024-06-11 +categories: articles +tags: rails hotwire turbo turbo-frames forms +--- + +Let's consider some UI examples and check if we can get the Turbo magic by just slapping a Turbo Frame in the right place. By that I mean: can we make the implementation really **as simple as plain HTML** with the, as the slogan says *"the speed of a single-page web application"*: +- Navigating full pages of content. ✅ +- Links that change a fixed different part of UI, like tabs. ✅ +- Navigating a self contained small part of the UI like an image gallery. ✅ +- Inline editing of elements in a list. ✅ +- Submitting a form shows errors or modifies the full page, like adding an item to a list. ❌ +- ... + +Huh, that last one is relatively common, why is it not straightforward? + +All we want there is to have a list and a form that can both show errors and add to the list when there are no errors. It's by no means **hard**, but it's not trivial and it sounds like it should be. + +The general problem description would be: **having a Turbo Frame that might update itself or might update the full page**. The problematic part is that **the logic** for which of those two actions are needed is dynamically determined **on the server**. Turbo has a number of mechanisms to **statically** define the target of a link click or form submission in the page itself, but it's not as easy when we need to control it from the server. It's confusing enough that there's [a long standing open issue on Turbo Github repo, with many comments]`(https://github.com/hotwired/turbo/issues/257){:target="_blank"}`. + +I've faced this problem myself and used different solutions but I wanted to find the best one so I went through that whole thread. The answer: **it depends**. You don't have to go through the thread, here are all the techniques with their tradeoffs. + +## Techniques + +I am assuming you're using Rails but solutions should be easily transferable to a different backend framework. + +### Just add target="_top" to the Turbo Frame + +It's as simple as creating the frame with "_top" as its target: +```ruby +turbo_frame_tag :target_top, target: "_top" +``` +And voila, the form submission will navigate the full page rather than just the frame. + +The problem with that is that it will **always** navigate the full page. Even if there are errors that you want to render inside the frame, Turbo will attempt to navigate the full page, breaking the process. So this is not viable if you need to also show errors. But, if you know every form submission is successful, this is by far the simplest approach. + +### Emit a refresh action on a successful submit + +The idea is that on a successful submit you emit a [refresh stream action]`(https://turbo.hotwired.dev/reference/streams#refresh){:target="_blank"}` instead of a redirect like you might for a plain HTML page. This action was added when [morphing](/articles/turbo-morphing-deep-dive) functionality was introduced and it causes Turbo to "refresh" the current page. Depending on your other configuration this will mean fetching the full page again and then either *replacing* the content of the `body` tag or *morphing* it. Either way, the result will be that the full page will be updated in an efficient manner by Turbo. + +The neat part is that the error part doesn't need to change at all, it can stay identical to how it would be for the plain HTML approach. This is how it might look for an endpoint where we create a record that has validations: +```ruby +def create + @record = Record.create(record_params) + if @record.valid? + respond_to do |format| + format.turbo_stream { render turbo_stream: turbo_stream.action(:refresh, "") } + format.html { redirect_to :index } + end + else + render :new # Rely on the form rendering showing errors + end +end +``` +An important assumption of this approach is that you want to modify the current page. Next approach covers the case when that's not true. + +### Use custom full page redirect stream action + +If instead of modifying the current page you want to either show errors or move to a different page, you'd normally use a redirect. But this will not work with Turbo because it would redirect only the Turbo Frame. If you want to redirect the full page you'll need to create a [custom stream action]`(https://turbo.hotwired.dev/handbook/streams#custom-actions){:target="_blank"}`. Custom stream actions allow us to expand the default list of stream actions that Turbo provides. + +First define a new stream action for the full page redirect: +```javascript +Turbo.StreamActions.full_page_redirect = function() { + document.location = this.getAttribute("target") +} +``` +And then, similar to above example with the refresh action, respond with it when handling a turbo request: +```ruby +respond_to do |format| + format.turbo_stream do + render turbo_stream: turbo_stream.action(:full_page_redirect, redirect_path) + end + format.html { redirect_to redirect_path } +end + +``` + +### Rely on turbo-visit-control meta tag + +A page can advertise to Turbo that it always needs to be loaded as a full page load. It does this with a special [turbo-visit-control]`(https://turbo.hotwired.dev/reference/attributes#meta-tags){:target="_blank"}` meta tag. It's as simple as calling a helper inside the view template: +```erb +<% turbo_page_requires_reload %> +``` +When you respond with a redirect to a page with this meta tag, Turbo will: +1. Fetch the page. +2. Before attempting to update the Frame, check for this meta tag. +3. If it finds the meta tag it will abandon Frame update and instead issue a full page reload to the same url. + +This is very simple if the destination page always requires to be a full page load. The downside is that it will cause the page to be loaded **twice**. However, this is a good tradeoff if the scenario happens rarely. + +A common example is the login page. If you have authentication that might expire, it means that any visit might redirect to the login page. In that case it makes perfect sense to place this meta tag on the page. + +### Do not use a Turbo Frame + +If you've been paying attention you'll notice that the above solutions all make the sad path, an error showing on the form, very simple, and the small added complexity is on the happy path. This often makes sense but if for you it's really important that the happy path is the simple one you have another option. + +You can not use a Turbo Frame at all. The happy path is then literally identical to the plain HTML approach, since it really is a plain HTML form submission. + +But you still want to show errors inline. The trick is to wrap the form in a plain element with an id and then use stream actions to replace it, effectively simulating a frame update in the case of an error. + +First, in the view you use a plain `div` instead of a Turbo Frame: +```erb +
"> + <%= form_for record do |f| %> + ... + <% end %> +
+``` +and then in the controller use a regular redirect for the happy path and a stream action to [replace]`(https://rubydoc.info/github/hotwired/turbo-rails/main/Turbo/Streams/TagBuilder#replace-instance_method){:target="_blank"}` the form content in case of an error: +```ruby +if @record.valid? + redirect_to :index +else + respond_to do |format| + format.turbo_stream do + render turbo_stream: turbo_stream.replace( + dom_id(@record, "form"), + partial: "records/form", + locals: {record: @record} + ) + end + format.html { render :new } + end +end +``` + +As you can see, the reason that we opted before to keep the error path simple is that it *usually* results in overall simpler code. However, some cases might be different and then this can be a good choice. + +## Why is it like this and when will it be improved? + +It's fair to ask, why doesn't Turbo just work here? Is it really so hard? There are a number of heuristics we could use but they all have a problem of being correct in many cases but also being wrong in other, perfectly reasonable, cases. + +We can't make this logic fuzzy, Turbo needs to be predictable. And since a reasonable logic has not been found yet, we have to be explicit about it. And this is the direction that most promising solutions suggested in that [Github Issue]`(https://github.com/hotwired/turbo/issues/257){:target="_blank"}` explore: how to allow the developer to be explicit in the simplest way possible. However, a satisfactory solution that actually works has not been found yet. Most promising ones are limited by what can be done in the browser. So we might have to wait for browser evolution until being able to get a truly satisfactory solution. At this point, I'm leaning towards this being something that will always require us to add a little extra complexity. + +### Break out of the frame when missing matching frame? + +However there is one area where Turbo might offer a bit more out of the box. What to do when the response (or the page to which we redirected) **doesn't** contain the target turbo frame? Currently it results in an error so it's not possible that anyone is relying on it as a feature. Turbo could instead treat it as a signal to update the full page. This could simplify some of the cases. + +This might be a real future *partial solution*. It even has [DHH endorsing it]`(https://github.com/hotwired/turbo/issues/257#issuecomment-1188397132){:target="_blank"}`. + +The good news is that, if you want to get this behaviour today, all you need to do is add this global listener to the [frame-missing event]`(https://turbo.hotwired.dev/reference/events#turbo%3Aframe-missing){:target="_blank"}`: + +```javascript +document.addEventListener("turbo:frame-missing", function (event) { + event.preventDefault() + event.detail.visit(event.detail.response) +}) +``` + +Do you have an alternative solution that I missed or a different take on it? Please share it in the comments below! diff --git a/spec/rails_app/.ruby-version b/spec/rails_app/.ruby-version new file mode 100644 index 0000000..4a85a55 --- /dev/null +++ b/spec/rails_app/.ruby-version @@ -0,0 +1 @@ +ruby-3.3.1 diff --git a/spec/rails_app/Gemfile b/spec/rails_app/Gemfile new file mode 100644 index 0000000..531476a --- /dev/null +++ b/spec/rails_app/Gemfile @@ -0,0 +1,64 @@ +source "https://rubygems.org" + +ruby "3.3.1" + +# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main" +gem "rails", "~> 7.1.3", ">= 7.1.3.3" + +# The modern asset pipeline for Rails [https://github.com/rails/propshaft] +gem "propshaft" + +# Use sqlite3 as the database for Active Record +gem "sqlite3", "~> 1.4" + +# Use the Puma web server [https://github.com/puma/puma] +gem "puma", ">= 5.0" + +# Use JavaScript with ESM import maps [https://github.com/rails/importmap-rails] +gem "importmap-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" + +# Use Redis adapter to run Action Cable in production +# gem "redis", ">= 4.0.1" + +# Use Kredis to get higher-level data types in Redis [https://github.com/rails/kredis] +# gem "kredis" + +# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword] +# gem "bcrypt", "~> 3.1.7" + +# Windows does not include zoneinfo files, so bundle the tzinfo-data gem +gem "tzinfo-data", platforms: %i[ windows jruby ] + +# Reduces boot times through caching; required in config/boot.rb +gem "bootsnap", require: false + +# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images] +# gem "image_processing", "~> 1.2" + +group :development, :test do + # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem + gem "debug", platforms: %i[ mri windows ] +end + +group :development do + # Use console on exceptions pages [https://github.com/rails/web-console] + gem "web-console" + + # Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler] + # gem "rack-mini-profiler" + + # Speed up commands on slow machines / big apps [https://github.com/rails/spring] + # gem "spring" +end + +group :test do + # Use system testing [https://guides.rubyonrails.org/testing.html#system-testing] + gem "capybara" + gem "selenium-webdriver" +end diff --git a/spec/rails_app/README.md b/spec/rails_app/README.md new file mode 100644 index 0000000..7db80e4 --- /dev/null +++ b/spec/rails_app/README.md @@ -0,0 +1,24 @@ +# README + +This README would normally document whatever steps are necessary to get the +application up and running. + +Things you may want to cover: + +* Ruby version + +* System dependencies + +* Configuration + +* Database creation + +* Database initialization + +* How to run the test suite + +* Services (job queues, cache servers, search engines, etc.) + +* Deployment instructions + +* ... diff --git a/spec/rails_app/Rakefile b/spec/rails_app/Rakefile new file mode 100644 index 0000000..9a5ea73 --- /dev/null +++ b/spec/rails_app/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/rails_app/app/assets/images/.keep b/spec/rails_app/app/assets/images/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/app/assets/stylesheets/application.css b/spec/rails_app/app/assets/stylesheets/application.css new file mode 100644 index 0000000..dcd7273 --- /dev/null +++ b/spec/rails_app/app/assets/stylesheets/application.css @@ -0,0 +1 @@ +/* Application styles */ diff --git a/spec/rails_app/app/channels/application_cable/channel.rb b/spec/rails_app/app/channels/application_cable/channel.rb new file mode 100644 index 0000000..d672697 --- /dev/null +++ b/spec/rails_app/app/channels/application_cable/channel.rb @@ -0,0 +1,4 @@ +module ApplicationCable + class Channel < ActionCable::Channel::Base + end +end diff --git a/spec/rails_app/app/channels/application_cable/connection.rb b/spec/rails_app/app/channels/application_cable/connection.rb new file mode 100644 index 0000000..0ff5442 --- /dev/null +++ b/spec/rails_app/app/channels/application_cable/connection.rb @@ -0,0 +1,4 @@ +module ApplicationCable + class Connection < ActionCable::Connection::Base + end +end diff --git a/spec/rails_app/app/controllers/application_controller.rb b/spec/rails_app/app/controllers/application_controller.rb new file mode 100644 index 0000000..09705d1 --- /dev/null +++ b/spec/rails_app/app/controllers/application_controller.rb @@ -0,0 +1,2 @@ +class ApplicationController < ActionController::Base +end diff --git a/spec/rails_app/app/controllers/concerns/.keep b/spec/rails_app/app/controllers/concerns/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/app/controllers/form_in_frame_controller.rb b/spec/rails_app/app/controllers/form_in_frame_controller.rb new file mode 100644 index 0000000..4bea8bb --- /dev/null +++ b/spec/rails_app/app/controllers/form_in_frame_controller.rb @@ -0,0 +1,41 @@ +class FormInFrameController < ApplicationController + before_action :save_message, except: %i[index] + + def index + end + + def target_top + redirect_to action: :index + end + + def refresh_action + respond_to do |format| + format.turbo_stream { render turbo_stream: turbo_stream.action(:refresh, "") } + format.html { redirect_to :index } + end + end + + def visit_control + redirect_to action: :index, params: { force_reload: true} + end + + def custom_action + redirect_path = form_in_frame_path + respond_to do |format| + format.turbo_stream { render turbo_stream: turbo_stream.action(:full_page_redirect, redirect_path) } + format.html { redirect_to redirect_path } + end + end + + private + + def save_message + if params[:message].blank? + render partial: "error", status: :unprocessable_entity + return + end + + session[:form_in_frame] = params[:message] + end + +end diff --git a/spec/rails_app/app/helpers/application_helper.rb b/spec/rails_app/app/helpers/application_helper.rb new file mode 100644 index 0000000..de6be79 --- /dev/null +++ b/spec/rails_app/app/helpers/application_helper.rb @@ -0,0 +1,2 @@ +module ApplicationHelper +end diff --git a/spec/rails_app/app/helpers/form_in_frame_helper.rb b/spec/rails_app/app/helpers/form_in_frame_helper.rb new file mode 100644 index 0000000..5440b2e --- /dev/null +++ b/spec/rails_app/app/helpers/form_in_frame_helper.rb @@ -0,0 +1,2 @@ +module FormInFrameHelper +end diff --git a/spec/rails_app/app/javascript/application.js b/spec/rails_app/app/javascript/application.js new file mode 100644 index 0000000..80572fd --- /dev/null +++ b/spec/rails_app/app/javascript/application.js @@ -0,0 +1,12 @@ +// Configure your import map in config/importmap.rb. Read more: https://github.com/rails/importmap-rails +import "@hotwired/turbo-rails" +import "controllers" + +addEventListener("turbo:render", (event) => { + console.log("Turbo Rendered with: ", event.detail.renderMethod, (event.detail.isPreview ? "(preview)" : "")); +}) + +Turbo.StreamActions.full_page_redirect = function() { + document.location = this.getAttribute("target") +} + diff --git a/spec/rails_app/app/javascript/controllers/application.js b/spec/rails_app/app/javascript/controllers/application.js new file mode 100644 index 0000000..1213e85 --- /dev/null +++ b/spec/rails_app/app/javascript/controllers/application.js @@ -0,0 +1,9 @@ +import { Application } from "@hotwired/stimulus" + +const application = Application.start() + +// Configure Stimulus development experience +application.debug = false +window.Stimulus = application + +export { application } diff --git a/spec/rails_app/app/javascript/controllers/hello_controller.js b/spec/rails_app/app/javascript/controllers/hello_controller.js new file mode 100644 index 0000000..5975c07 --- /dev/null +++ b/spec/rails_app/app/javascript/controllers/hello_controller.js @@ -0,0 +1,7 @@ +import { Controller } from "@hotwired/stimulus" + +export default class extends Controller { + connect() { + this.element.textContent = "Hello World!" + } +} diff --git a/spec/rails_app/app/javascript/controllers/index.js b/spec/rails_app/app/javascript/controllers/index.js new file mode 100644 index 0000000..54ad4ca --- /dev/null +++ b/spec/rails_app/app/javascript/controllers/index.js @@ -0,0 +1,11 @@ +// Import and register all your controllers from the importmap under controllers/* + +import { application } from "controllers/application" + +// Eager load all controllers defined in the import map under controllers/**/*_controller +import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading" +eagerLoadControllersFrom("controllers", application) + +// Lazy load controllers as they appear in the DOM (remember not to preload controllers in import map!) +// import { lazyLoadControllersFrom } from "@hotwired/stimulus-loading" +// lazyLoadControllersFrom("controllers", application) diff --git a/spec/rails_app/app/jobs/application_job.rb b/spec/rails_app/app/jobs/application_job.rb new file mode 100644 index 0000000..d394c3d --- /dev/null +++ b/spec/rails_app/app/jobs/application_job.rb @@ -0,0 +1,7 @@ +class ApplicationJob < ActiveJob::Base + # Automatically retry jobs that encountered a deadlock + # retry_on ActiveRecord::Deadlocked + + # Most jobs are safe to ignore if the underlying records are no longer available + # discard_on ActiveJob::DeserializationError +end diff --git a/spec/rails_app/app/mailers/application_mailer.rb b/spec/rails_app/app/mailers/application_mailer.rb new file mode 100644 index 0000000..3c34c81 --- /dev/null +++ b/spec/rails_app/app/mailers/application_mailer.rb @@ -0,0 +1,4 @@ +class ApplicationMailer < ActionMailer::Base + default from: "from@example.com" + layout "mailer" +end diff --git a/spec/rails_app/app/models/application_record.rb b/spec/rails_app/app/models/application_record.rb new file mode 100644 index 0000000..b63caeb --- /dev/null +++ b/spec/rails_app/app/models/application_record.rb @@ -0,0 +1,3 @@ +class ApplicationRecord < ActiveRecord::Base + primary_abstract_class +end diff --git a/spec/rails_app/app/models/concerns/.keep b/spec/rails_app/app/models/concerns/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/app/views/form_in_frame/_error.html.erb b/spec/rails_app/app/views/form_in_frame/_error.html.erb new file mode 100644 index 0000000..ef2d082 --- /dev/null +++ b/spec/rails_app/app/views/form_in_frame/_error.html.erb @@ -0,0 +1,3 @@ +<%= turbo_frame_tag turbo_frame_request_id do %> + An error has occurred: the message can't be empty +<% end %> diff --git a/spec/rails_app/app/views/form_in_frame/index.html.erb b/spec/rails_app/app/views/form_in_frame/index.html.erb new file mode 100644 index 0000000..eddef95 --- /dev/null +++ b/spec/rails_app/app/views/form_in_frame/index.html.erb @@ -0,0 +1,49 @@ +<% turbo_page_requires_reload if params[:force_reload] %> + +

FormInFrame#index

+

Testing different approaches for the form in a frame to navigate the full page

+ +
+ Control value, simulating database with cache using memory store: <%= session.fetch(:form_in_frame, "NONE") %> +
+ +

Just have the form target top

+ +<%= turbo_frame_tag :target_top, target: "_top" do %> + <%= form_with url: form_in_frame_target_top_path, method: :post do |f| %> + <%= f.label :message %> + <%= f.text_field :message %> + <%= f.submit "The frame targets the top!" %> + <% end %> +<% end %> + +

Respond with refresh action

+ +<%= turbo_frame_tag :refresh_action do %> + <%= form_with url: form_in_frame_refresh_action_path, method: :post do |f| %> + <%= f.label :message %> + <%= f.text_field :message %> + <%= f.submit "Use refresh action!" %> + <% end %> +<% end %> + +

Rely on turbo-visit-control meta tag

+ +<%= turbo_frame_tag :visit_control do %> + <%= form_with url: form_in_frame_visit_control_path, method: :post do |f| %> + <%= f.label :message %> + <%= f.text_field :message %> + <%= f.submit "Make redirect target have turbo-visit-control meta tag!" %> + <% end %> +<% end %> + +

Use custom full page redirect stream action

+ +<%= turbo_frame_tag :custom_action do %> + <%= form_with url: form_in_frame_custom_action_path, method: :post do |f| %> + <%= f.label :message %> + <%= f.text_field :message %> + <%= f.submit "Make redirect target have turbo-visit-control meta tag!" %> + <% end %> +<% end %> + diff --git a/spec/rails_app/app/views/layouts/application.html.erb b/spec/rails_app/app/views/layouts/application.html.erb new file mode 100644 index 0000000..12798a6 --- /dev/null +++ b/spec/rails_app/app/views/layouts/application.html.erb @@ -0,0 +1,19 @@ + + + + RailsApp + + <%= csrf_meta_tags %> + <%= csp_meta_tag %> + + <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %> + <%= javascript_importmap_tags %> + + <% turbo_refreshes_with method: :morph, scroll: :preserve %> + <%= yield :head %> + + + + <%= yield %> + + diff --git a/spec/rails_app/app/views/layouts/mailer.html.erb b/spec/rails_app/app/views/layouts/mailer.html.erb new file mode 100644 index 0000000..3aac900 --- /dev/null +++ b/spec/rails_app/app/views/layouts/mailer.html.erb @@ -0,0 +1,13 @@ + + + + + + + + + <%= yield %> + + diff --git a/spec/rails_app/app/views/layouts/mailer.text.erb b/spec/rails_app/app/views/layouts/mailer.text.erb new file mode 100644 index 0000000..37f0bdd --- /dev/null +++ b/spec/rails_app/app/views/layouts/mailer.text.erb @@ -0,0 +1 @@ +<%= yield %> diff --git a/spec/rails_app/bin/bundle b/spec/rails_app/bin/bundle new file mode 100755 index 0000000..50da5fd --- /dev/null +++ b/spec/rails_app/bin/bundle @@ -0,0 +1,109 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +# +# This file was generated by Bundler. +# +# The application 'bundle' is installed as part of a gem, and +# this file is here to facilitate running it. +# + +require "rubygems" + +m = Module.new do + module_function + + def invoked_as_script? + File.expand_path($0) == File.expand_path(__FILE__) + end + + def env_var_version + ENV["BUNDLER_VERSION"] + end + + def cli_arg_version + return unless invoked_as_script? # don't want to hijack other binstubs + return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update` + bundler_version = nil + update_index = nil + ARGV.each_with_index do |a, i| + if update_index && update_index.succ == i && a.match?(Gem::Version::ANCHORED_VERSION_PATTERN) + bundler_version = a + end + next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/ + bundler_version = $1 + update_index = i + end + bundler_version + end + + def gemfile + gemfile = ENV["BUNDLE_GEMFILE"] + return gemfile if gemfile && !gemfile.empty? + + File.expand_path("../Gemfile", __dir__) + end + + def lockfile + lockfile = + case File.basename(gemfile) + when "gems.rb" then gemfile.sub(/\.rb$/, ".locked") + else "#{gemfile}.lock" + end + File.expand_path(lockfile) + end + + def lockfile_version + return unless File.file?(lockfile) + lockfile_contents = File.read(lockfile) + return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/ + Regexp.last_match(1) + end + + def bundler_requirement + @bundler_requirement ||= + env_var_version || + cli_arg_version || + bundler_requirement_for(lockfile_version) + end + + def bundler_requirement_for(version) + return "#{Gem::Requirement.default}.a" unless version + + bundler_gem_version = Gem::Version.new(version) + + bundler_gem_version.approximate_recommendation + end + + def load_bundler! + ENV["BUNDLE_GEMFILE"] ||= gemfile + + activate_bundler + end + + def activate_bundler + gem_error = activation_error_handling do + gem "bundler", bundler_requirement + end + return if gem_error.nil? + require_error = activation_error_handling do + require "bundler/version" + end + return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION)) + warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`" + exit 42 + end + + def activation_error_handling + yield + nil + rescue StandardError, LoadError => e + e + end +end + +m.load_bundler! + +if m.invoked_as_script? + load Gem.bin_path("bundler", "bundle") +end diff --git a/spec/rails_app/bin/importmap b/spec/rails_app/bin/importmap new file mode 100755 index 0000000..36502ab --- /dev/null +++ b/spec/rails_app/bin/importmap @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby + +require_relative "../config/application" +require "importmap/commands" diff --git a/spec/rails_app/bin/rails b/spec/rails_app/bin/rails new file mode 100755 index 0000000..efc0377 --- /dev/null +++ b/spec/rails_app/bin/rails @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby +APP_PATH = File.expand_path("../config/application", __dir__) +require_relative "../config/boot" +require "rails/commands" diff --git a/spec/rails_app/bin/rake b/spec/rails_app/bin/rake new file mode 100755 index 0000000..4fbf10b --- /dev/null +++ b/spec/rails_app/bin/rake @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby +require_relative "../config/boot" +require "rake" +Rake.application.run diff --git a/spec/rails_app/bin/setup b/spec/rails_app/bin/setup new file mode 100755 index 0000000..3cd5a9d --- /dev/null +++ b/spec/rails_app/bin/setup @@ -0,0 +1,33 @@ +#!/usr/bin/env ruby +require "fileutils" + +# path to your application root. +APP_ROOT = File.expand_path("..", __dir__) + +def system!(*args) + system(*args, exception: true) +end + +FileUtils.chdir APP_ROOT do + # This script is a way to set up or update your development environment automatically. + # This script is idempotent, so that you can run it at any time and get an expectable outcome. + # Add necessary setup steps to this file. + + puts "== Installing dependencies ==" + system! "gem install bundler --conservative" + system("bundle check") || system!("bundle install") + + # puts "\n== Copying sample files ==" + # unless File.exist?("config/database.yml") + # FileUtils.cp "config/database.yml.sample", "config/database.yml" + # end + + puts "\n== Preparing database ==" + system! "bin/rails db:prepare" + + puts "\n== Removing old logs and tempfiles ==" + system! "bin/rails log:clear tmp:clear" + + puts "\n== Restarting application server ==" + system! "bin/rails restart" +end diff --git a/spec/rails_app/config.ru b/spec/rails_app/config.ru new file mode 100644 index 0000000..4a3c09a --- /dev/null +++ b/spec/rails_app/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/rails_app/config/application.rb b/spec/rails_app/config/application.rb new file mode 100644 index 0000000..b187bca --- /dev/null +++ b/spec/rails_app/config/application.rb @@ -0,0 +1,30 @@ +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 RailsApp + class Application < Rails::Application + # Initialize configuration defaults for originally generated Rails version. + config.load_defaults 7.1 + + # Please, add to the `ignore` list any other `lib` subdirectories that do + # not contain `.rb` files, or that should not be reloaded or eager loaded. + # Common ones are `templates`, `generators`, or `middleware`, for example. + config.autoload_lib(ignore: %w(assets tasks)) + + # Configuration for the application, engines, and railties goes here. + # + + config.cache_store = :memory_store + + # These settings can be overridden in specific environments using the files + # in config/environments, which are processed later. + # + # config.time_zone = "Central Time (US & Canada)" + # config.eager_load_paths << Rails.root.join("extras") + end +end diff --git a/spec/rails_app/config/boot.rb b/spec/rails_app/config/boot.rb new file mode 100644 index 0000000..988a5dd --- /dev/null +++ b/spec/rails_app/config/boot.rb @@ -0,0 +1,4 @@ +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__) + +require "bundler/setup" # Set up gems listed in the Gemfile. +require "bootsnap/setup" # Speed up boot time by caching expensive operations. diff --git a/spec/rails_app/config/cable.yml b/spec/rails_app/config/cable.yml new file mode 100644 index 0000000..fb5503f --- /dev/null +++ b/spec/rails_app/config/cable.yml @@ -0,0 +1,10 @@ +development: + adapter: async + +test: + adapter: test + +production: + adapter: redis + url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %> + channel_prefix: rails_app_production diff --git a/spec/rails_app/config/credentials.yml.enc b/spec/rails_app/config/credentials.yml.enc new file mode 100644 index 0000000..741a125 --- /dev/null +++ b/spec/rails_app/config/credentials.yml.enc @@ -0,0 +1 @@ +8PuZ+LgB/zkP2gsOlwckW+7itt6NWrQBKXRF/KxDb+UpggJuECTnzKIxI+h5QV/ZUAzG8ay3UGAkWlpusAocRM8tO3K0DayyrI9iznly9yJ8AxBbpkMhrIoXNH++gEfiV2FrGdMVIKEiDDJBAIb8nl+HGEgoc9cFnTr2vyCf/fL89qgMeoSa7mYy26625Pz3d9tEdRXbDNG3oyi6Kd4Mv6N8x2BI04iHadRrVgxVxR1UUrqWRqKaau/kpUiNJbasvDjnkw5xOH6sYLGYk2OhHGUhkoKAQQSpQuYjaIdw+zACHXHZF3h+qrHoIXn18IzctH6foDWPRmH7dap6ghm3ZsXYo0xs1JI1H4c/GcQyChNm526hwnSHwajU7dlHP2n4FiCRUElqrn9vysC99vNN3OSEuugo--Ljsjcz/Tt5yF27Xt--gRLueQf5P57xdbQUv4sFfg== \ No newline at end of file diff --git a/spec/rails_app/config/database.yml b/spec/rails_app/config/database.yml new file mode 100644 index 0000000..796466b --- /dev/null +++ b/spec/rails_app/config/database.yml @@ -0,0 +1,25 @@ +# SQLite. Versions 3.8.0 and up are supported. +# gem install sqlite3 +# +# Ensure the SQLite 3 gem is defined in your Gemfile +# gem "sqlite3" +# +default: &default + adapter: sqlite3 + pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> + timeout: 5000 + +development: + <<: *default + database: storage/development.sqlite3 + +# Warning: The database defined as "test" will be erased and +# re-generated from your development database when you run "rake". +# Do not set this db to the same as development or production. +test: + <<: *default + database: storage/test.sqlite3 + +production: + <<: *default + database: storage/production.sqlite3 diff --git a/spec/rails_app/config/environment.rb b/spec/rails_app/config/environment.rb new file mode 100644 index 0000000..cac5315 --- /dev/null +++ b/spec/rails_app/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/rails_app/config/environments/development.rb b/spec/rails_app/config/environments/development.rb new file mode 100644 index 0000000..2a3a3eb --- /dev/null +++ b/spec/rails_app/config/environments/development.rb @@ -0,0 +1,71 @@ +require "active_support/core_ext/integer/time" + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # In the development environment your application's code is reloaded any time + # it changes. This slows down response time but is perfect for development + # since you don't have to restart the web server when you make code changes. + config.enable_reloading = true + + # Do not eager load code on boot. + config.eager_load = false + + # Show full error reports. + config.consider_all_requests_local = true + + # Enable server timing + config.server_timing = true + + # Enable/disable caching. By default caching is disabled. + # Run rails dev:cache to toggle caching. + if Rails.root.join("tmp/caching-dev.txt").exist? + config.action_controller.perform_caching = true + config.action_controller.enable_fragment_cache_logging = true + + config.public_file_server.headers = { + "Cache-Control" => "public, max-age=#{2.days.to_i}" + } + else + config.action_controller.perform_caching = false + end + + # Store uploaded files on the local file system (see config/storage.yml for options). + config.active_storage.service = :local + + # Don't care if the mailer can't send. + config.action_mailer.raise_delivery_errors = false + + config.action_mailer.perform_caching = false + + # Print deprecation notices to the Rails logger. + config.active_support.deprecation = :log + + # Raise exceptions for disallowed deprecations. + config.active_support.disallowed_deprecation = :raise + + # Tell Active Support which deprecation messages to disallow. + config.active_support.disallowed_deprecation_warnings = [] + + # Raise an error on page load if there are pending migrations. + config.active_record.migration_error = :page_load + + # Highlight code that triggered database queries in logs. + config.active_record.verbose_query_logs = true + + # Highlight code that enqueued background job in logs. + config.active_job.verbose_enqueue_logs = true + + + # Raises error for missing translations. + # config.i18n.raise_on_missing_translations = true + + # Annotate rendered view with file names. + # config.action_view.annotate_rendered_view_with_filenames = true + + # Uncomment if you wish to allow Action Cable access from any origin. + # config.action_cable.disable_request_forgery_protection = true + + # Raise error when a before_action's only/except options reference missing actions + config.action_controller.raise_on_missing_callback_actions = true +end diff --git a/spec/rails_app/config/environments/production.rb b/spec/rails_app/config/environments/production.rb new file mode 100644 index 0000000..562044c --- /dev/null +++ b/spec/rails_app/config/environments/production.rb @@ -0,0 +1,91 @@ +require "active_support/core_ext/integer/time" + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # Code is not reloaded between requests. + config.enable_reloading = false + + # Eager load code on boot. This eager loads most of Rails and + # your application in memory, allowing both threaded web servers + # and those relying on copy on write to perform better. + # Rake tasks automatically ignore this option for performance. + config.eager_load = true + + # Full error reports are disabled and caching is turned on. + config.consider_all_requests_local = false + config.action_controller.perform_caching = true + + # Ensures that a master key has been made available in ENV["RAILS_MASTER_KEY"], config/master.key, or an environment + # key such as config/credentials/production.key. This key is used to decrypt credentials (and other encrypted files). + # config.require_master_key = true + + # Disable serving static files from `public/`, relying on NGINX/Apache to do so instead. + # config.public_file_server.enabled = false + + # Enable serving of images, stylesheets, and JavaScripts from an asset server. + # config.asset_host = "http://assets.example.com" + + # Specifies the header that your server uses for sending files. + # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache + # config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # for NGINX + + # Store uploaded files on the local file system (see config/storage.yml for options). + config.active_storage.service = :local + + # Mount Action Cable outside main process or domain. + # config.action_cable.mount_path = nil + # config.action_cable.url = "wss://example.com/cable" + # config.action_cable.allowed_request_origins = [ "http://example.com", /http:\/\/example.*/ ] + + # Assume all access to the app is happening through a SSL-terminating reverse proxy. + # Can be used together with config.force_ssl for Strict-Transport-Security and secure cookies. + # config.assume_ssl = true + + # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. + config.force_ssl = true + + # Log to STDOUT by default + config.logger = ActiveSupport::Logger.new(STDOUT) + .tap { |logger| logger.formatter = ::Logger::Formatter.new } + .then { |logger| ActiveSupport::TaggedLogging.new(logger) } + + # Prepend all log lines with the following tags. + config.log_tags = [ :request_id ] + + # "info" includes generic and useful information about system operation, but avoids logging too much + # information to avoid inadvertent exposure of personally identifiable information (PII). If you + # want to log everything, set the level to "debug". + config.log_level = ENV.fetch("RAILS_LOG_LEVEL", "info") + + # Use a different cache store in production. + # config.cache_store = :mem_cache_store + + # Use a real queuing backend for Active Job (and separate queues per environment). + # config.active_job.queue_adapter = :resque + # config.active_job.queue_name_prefix = "rails_app_production" + + config.action_mailer.perform_caching = false + + # Ignore bad email addresses and do not raise email delivery errors. + # Set this to true and configure the email server for immediate delivery to raise delivery errors. + # config.action_mailer.raise_delivery_errors = false + + # Enable locale fallbacks for I18n (makes lookups for any locale fall back to + # the I18n.default_locale when a translation cannot be found). + config.i18n.fallbacks = true + + # Don't log any deprecations. + config.active_support.report_deprecations = false + + # Do not dump schema after migrations. + config.active_record.dump_schema_after_migration = false + + # Enable DNS rebinding protection and other `Host` header attacks. + # config.hosts = [ + # "example.com", # Allow requests from example.com + # /.*\.example\.com/ # Allow requests from subdomains like `www.example.com` + # ] + # Skip DNS rebinding protection for the default health check endpoint. + # config.host_authorization = { exclude: ->(request) { request.path == "/up" } } +end diff --git a/spec/rails_app/config/environments/test.rb b/spec/rails_app/config/environments/test.rb new file mode 100644 index 0000000..adbb4a6 --- /dev/null +++ b/spec/rails_app/config/environments/test.rb @@ -0,0 +1,64 @@ +require "active_support/core_ext/integer/time" + +# The test environment is used exclusively to run your application's +# test suite. You never need to work with it otherwise. Remember that +# your test database is "scratch space" for the test suite and is wiped +# and recreated between test runs. Don't rely on the data there! + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # While tests run files are not watched, reloading is not necessary. + config.enable_reloading = false + + # Eager loading loads your entire application. When running a single test locally, + # this is usually not necessary, and can slow down your test suite. However, it's + # recommended that you enable it in continuous integration systems to ensure eager + # loading is working properly before deploying your code. + config.eager_load = ENV["CI"].present? + + # Configure public file server for tests with Cache-Control for performance. + config.public_file_server.enabled = true + 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 + + # Render exception templates for rescuable exceptions and raise for other exceptions. + config.action_dispatch.show_exceptions = :rescuable + + # Disable request forgery protection in test environment. + config.action_controller.allow_forgery_protection = false + + # Store uploaded files on the local file system in a temporary directory. + config.active_storage.service = :test + + config.action_mailer.perform_caching = false + + # Tell Action Mailer not to deliver emails to the real world. + # The :test delivery method accumulates sent emails in the + # ActionMailer::Base.deliveries array. + config.action_mailer.delivery_method = :test + + # Print deprecation notices to the stderr. + config.active_support.deprecation = :stderr + + # Raise exceptions for disallowed deprecations. + config.active_support.disallowed_deprecation = :raise + + # Tell Active Support which deprecation messages to disallow. + config.active_support.disallowed_deprecation_warnings = [] + + # Raises error for missing translations. + # config.i18n.raise_on_missing_translations = true + + # Annotate rendered view with file names. + # config.action_view.annotate_rendered_view_with_filenames = true + + # Raise error when a before_action's only/except options reference missing actions + config.action_controller.raise_on_missing_callback_actions = true +end diff --git a/spec/rails_app/config/importmap.rb b/spec/rails_app/config/importmap.rb new file mode 100644 index 0000000..6c54bce --- /dev/null +++ b/spec/rails_app/config/importmap.rb @@ -0,0 +1,7 @@ +# Pin npm packages by running ./bin/importmap + +pin "application" +pin "@hotwired/turbo-rails", to: "turbo.js" +pin "@hotwired/stimulus", to: "stimulus.min.js" +pin "@hotwired/stimulus-loading", to: "stimulus-loading.js" +pin_all_from "app/javascript/controllers", under: "controllers" diff --git a/spec/rails_app/config/initializers/assets.rb b/spec/rails_app/config/initializers/assets.rb new file mode 100644 index 0000000..4873244 --- /dev/null +++ b/spec/rails_app/config/initializers/assets.rb @@ -0,0 +1,7 @@ +# Be sure to restart your server when you modify this file. + +# Version of your assets, change this if you want to expire all your assets. +Rails.application.config.assets.version = "1.0" + +# Add additional assets to the asset load path. +# Rails.application.config.assets.paths << Emoji.images_path diff --git a/spec/rails_app/config/initializers/content_security_policy.rb b/spec/rails_app/config/initializers/content_security_policy.rb new file mode 100644 index 0000000..b3076b3 --- /dev/null +++ b/spec/rails_app/config/initializers/content_security_policy.rb @@ -0,0 +1,25 @@ +# Be sure to restart your server when you modify this file. + +# Define an application-wide content security policy. +# See the Securing Rails Applications Guide for more information: +# https://guides.rubyonrails.org/security.html#content-security-policy-header + +# Rails.application.configure do +# config.content_security_policy do |policy| +# policy.default_src :self, :https +# policy.font_src :self, :https, :data +# policy.img_src :self, :https, :data +# policy.object_src :none +# policy.script_src :self, :https +# policy.style_src :self, :https +# # Specify URI for violation reports +# # policy.report_uri "/csp-violation-report-endpoint" +# end +# +# # Generate session nonces for permitted importmap, inline scripts, and inline styles. +# config.content_security_policy_nonce_generator = ->(request) { request.session.id.to_s } +# config.content_security_policy_nonce_directives = %w(script-src style-src) +# +# # Report violations without enforcing the policy. +# # config.content_security_policy_report_only = true +# end diff --git a/spec/rails_app/config/initializers/filter_parameter_logging.rb b/spec/rails_app/config/initializers/filter_parameter_logging.rb new file mode 100644 index 0000000..c2d89e2 --- /dev/null +++ b/spec/rails_app/config/initializers/filter_parameter_logging.rb @@ -0,0 +1,8 @@ +# Be sure to restart your server when you modify this file. + +# Configure parameters to be partially matched (e.g. passw matches password) and filtered from the log file. +# Use this to limit dissemination of sensitive information. +# See the ActiveSupport::ParameterFilter documentation for supported notations and behaviors. +Rails.application.config.filter_parameters += [ + :passw, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn +] diff --git a/spec/rails_app/config/initializers/inflections.rb b/spec/rails_app/config/initializers/inflections.rb new file mode 100644 index 0000000..3860f65 --- /dev/null +++ b/spec/rails_app/config/initializers/inflections.rb @@ -0,0 +1,16 @@ +# Be sure to restart your server when you modify this file. + +# Add new inflection rules using the following format. Inflections +# are locale specific, and you may define rules for as many different +# locales as you wish. All of these examples are active by default: +# ActiveSupport::Inflector.inflections(:en) do |inflect| +# inflect.plural /^(ox)$/i, "\\1en" +# inflect.singular /^(ox)en/i, "\\1" +# inflect.irregular "person", "people" +# inflect.uncountable %w( fish sheep ) +# end + +# These inflection rules are supported but not enabled by default: +# ActiveSupport::Inflector.inflections(:en) do |inflect| +# inflect.acronym "RESTful" +# end diff --git a/spec/rails_app/config/initializers/permissions_policy.rb b/spec/rails_app/config/initializers/permissions_policy.rb new file mode 100644 index 0000000..7db3b95 --- /dev/null +++ b/spec/rails_app/config/initializers/permissions_policy.rb @@ -0,0 +1,13 @@ +# Be sure to restart your server when you modify this file. + +# Define an application-wide HTTP permissions policy. For further +# information see: https://developers.google.com/web/updates/2018/06/feature-policy + +# Rails.application.config.permissions_policy do |policy| +# policy.camera :none +# policy.gyroscope :none +# policy.microphone :none +# policy.usb :none +# policy.fullscreen :self +# policy.payment :self, "https://secure.example.com" +# end diff --git a/spec/rails_app/config/locales/en.yml b/spec/rails_app/config/locales/en.yml new file mode 100644 index 0000000..6c349ae --- /dev/null +++ b/spec/rails_app/config/locales/en.yml @@ -0,0 +1,31 @@ +# Files in the config/locales directory are used for internationalization and +# are automatically loaded by Rails. If you want to use locales other than +# English, add the necessary files in this directory. +# +# To use the locales, use `I18n.t`: +# +# I18n.t "hello" +# +# In views, this is aliased to just `t`: +# +# <%= t("hello") %> +# +# To use a different locale, set it with `I18n.locale`: +# +# I18n.locale = :es +# +# This would use the information in config/locales/es.yml. +# +# To learn more about the API, please read the Rails Internationalization guide +# at https://guides.rubyonrails.org/i18n.html. +# +# Be aware that YAML interprets the following case-insensitive strings as +# booleans: `true`, `false`, `on`, `off`, `yes`, `no`. Therefore, these strings +# must be quoted to be interpreted as strings. For example: +# +# en: +# "yes": yup +# enabled: "ON" + +en: + hello: "Hello world" diff --git a/spec/rails_app/config/master.key b/spec/rails_app/config/master.key new file mode 100644 index 0000000..869c970 --- /dev/null +++ b/spec/rails_app/config/master.key @@ -0,0 +1 @@ +ea63e1ab07d20341a5ed07a185aa00ef \ No newline at end of file diff --git a/spec/rails_app/config/puma.rb b/spec/rails_app/config/puma.rb new file mode 100644 index 0000000..afa809b --- /dev/null +++ b/spec/rails_app/config/puma.rb @@ -0,0 +1,35 @@ +# This configuration file will be evaluated by Puma. The top-level methods that +# are invoked here are part of Puma's configuration DSL. For more information +# about methods provided by the DSL, see https://puma.io/puma/Puma/DSL.html. + +# Puma can serve each request in a thread from an internal thread pool. +# The `threads` method setting takes two numbers: a minimum and maximum. +# Any libraries that use thread pools should be configured to match +# the maximum value specified for Puma. Default is set to 5 threads for minimum +# and maximum; this matches the default thread size of Active Record. +max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 } +min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count } +threads min_threads_count, max_threads_count + +# Specifies that the worker count should equal the number of processors in production. +if ENV["RAILS_ENV"] == "production" + require "concurrent-ruby" + worker_count = Integer(ENV.fetch("WEB_CONCURRENCY") { Concurrent.physical_processor_count }) + workers worker_count if worker_count > 1 +end + +# Specifies the `worker_timeout` threshold that Puma will use to wait before +# terminating a worker in development environments. +worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development" + +# Specifies the `port` that Puma will listen on to receive requests; default is 3000. +port ENV.fetch("PORT") { 3000 } + +# Specifies the `environment` that Puma will run in. +environment ENV.fetch("RAILS_ENV") { "development" } + +# Specifies the `pidfile` that Puma will use. +pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" } + +# Allow puma to be restarted by `bin/rails restart` command. +plugin :tmp_restart diff --git a/spec/rails_app/config/routes.rb b/spec/rails_app/config/routes.rb new file mode 100644 index 0000000..fa6b9ef --- /dev/null +++ b/spec/rails_app/config/routes.rb @@ -0,0 +1,14 @@ +Rails.application.routes.draw do + get 'form_in_frame' => 'form_in_frame#index' + %i[target_top refresh_action visit_control custom_action].each do |action| + post "form_in_frame/#{action}" => "form_in_frame##{action}", as: "form_in_frame_#{action}" + end + # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html + + # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500. + # Can be used by load balancers and uptime monitors to verify that the app is live. + get "up" => "rails/health#show", as: :rails_health_check + + # Defines the root path route ("/") + # root "posts#index" +end diff --git a/spec/rails_app/config/storage.yml b/spec/rails_app/config/storage.yml new file mode 100644 index 0000000..4942ab6 --- /dev/null +++ b/spec/rails_app/config/storage.yml @@ -0,0 +1,34 @@ +test: + service: Disk + root: <%= Rails.root.join("tmp/storage") %> + +local: + service: Disk + root: <%= Rails.root.join("storage") %> + +# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key) +# amazon: +# service: S3 +# access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %> +# secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %> +# region: us-east-1 +# bucket: your_own_bucket-<%= Rails.env %> + +# Remember not to checkin your GCS keyfile to a repository +# google: +# service: GCS +# project: your_project +# credentials: <%= Rails.root.join("path/to/gcs.keyfile") %> +# bucket: your_own_bucket-<%= Rails.env %> + +# Use bin/rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key) +# microsoft: +# service: AzureStorage +# storage_account_name: your_account_name +# storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %> +# container: your_container_name-<%= Rails.env %> + +# mirror: +# service: Mirror +# primary: local +# mirrors: [ amazon, google, microsoft ] diff --git a/spec/rails_app/db/seeds.rb b/spec/rails_app/db/seeds.rb new file mode 100644 index 0000000..4fbd6ed --- /dev/null +++ b/spec/rails_app/db/seeds.rb @@ -0,0 +1,9 @@ +# This file should ensure the existence of records required to run the application in every environment (production, +# development, test). The code here should be idempotent so that it can be executed at any point in every environment. +# The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup). +# +# Example: +# +# ["Action", "Comedy", "Drama", "Horror"].each do |genre_name| +# MovieGenre.find_or_create_by!(name: genre_name) +# end diff --git a/spec/rails_app/lib/assets/.keep b/spec/rails_app/lib/assets/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/lib/tasks/.keep b/spec/rails_app/lib/tasks/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/log/.keep b/spec/rails_app/log/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/public/404.html b/spec/rails_app/public/404.html new file mode 100644 index 0000000..2be3af2 --- /dev/null +++ b/spec/rails_app/public/404.html @@ -0,0 +1,67 @@ + + + + The page you were looking for doesn't exist (404) + + + + + + +
+
+

The page you were looking for doesn't exist.

+

You may have mistyped the address or the page may have moved.

+
+

If you are the application owner check the logs for more information.

+
+ + diff --git a/spec/rails_app/public/422.html b/spec/rails_app/public/422.html new file mode 100644 index 0000000..c08eac0 --- /dev/null +++ b/spec/rails_app/public/422.html @@ -0,0 +1,67 @@ + + + + The change you wanted was rejected (422) + + + + + + +
+
+

The change you wanted was rejected.

+

Maybe you tried to change something you didn't have access to.

+
+

If you are the application owner check the logs for more information.

+
+ + diff --git a/spec/rails_app/public/500.html b/spec/rails_app/public/500.html new file mode 100644 index 0000000..78a030a --- /dev/null +++ b/spec/rails_app/public/500.html @@ -0,0 +1,66 @@ + + + + We're sorry, but something went wrong (500) + + + + + + +
+
+

We're sorry, but something went wrong.

+
+

If you are the application owner check the logs for more information.

+
+ + diff --git a/spec/rails_app/public/apple-touch-icon-precomposed.png b/spec/rails_app/public/apple-touch-icon-precomposed.png new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/public/apple-touch-icon.png b/spec/rails_app/public/apple-touch-icon.png new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/public/favicon.ico b/spec/rails_app/public/favicon.ico new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/public/robots.txt b/spec/rails_app/public/robots.txt new file mode 100644 index 0000000..c19f78a --- /dev/null +++ b/spec/rails_app/public/robots.txt @@ -0,0 +1 @@ +# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file diff --git a/spec/rails_app/storage/.keep b/spec/rails_app/storage/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/test/application_system_test_case.rb b/spec/rails_app/test/application_system_test_case.rb new file mode 100644 index 0000000..d19212a --- /dev/null +++ b/spec/rails_app/test/application_system_test_case.rb @@ -0,0 +1,5 @@ +require "test_helper" + +class ApplicationSystemTestCase < ActionDispatch::SystemTestCase + driven_by :selenium, using: :chrome, screen_size: [1400, 1400] +end diff --git a/spec/rails_app/test/channels/application_cable/connection_test.rb b/spec/rails_app/test/channels/application_cable/connection_test.rb new file mode 100644 index 0000000..6340bf9 --- /dev/null +++ b/spec/rails_app/test/channels/application_cable/connection_test.rb @@ -0,0 +1,13 @@ +require "test_helper" + +module ApplicationCable + class ConnectionTest < ActionCable::Connection::TestCase + # test "connects with cookies" do + # cookies.signed[:user_id] = 42 + # + # connect + # + # assert_equal connection.user_id, "42" + # end + end +end diff --git a/spec/rails_app/test/controllers/.keep b/spec/rails_app/test/controllers/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/test/controllers/form_in_frame_controller_test.rb b/spec/rails_app/test/controllers/form_in_frame_controller_test.rb new file mode 100644 index 0000000..823eb53 --- /dev/null +++ b/spec/rails_app/test/controllers/form_in_frame_controller_test.rb @@ -0,0 +1,8 @@ +require "test_helper" + +class FormInFrameControllerTest < ActionDispatch::IntegrationTest + test "should get index" do + get form_in_frame_index_url + assert_response :success + end +end diff --git a/spec/rails_app/test/fixtures/files/.keep b/spec/rails_app/test/fixtures/files/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/test/helpers/.keep b/spec/rails_app/test/helpers/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/test/integration/.keep b/spec/rails_app/test/integration/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/test/mailers/.keep b/spec/rails_app/test/mailers/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/test/models/.keep b/spec/rails_app/test/models/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/test/system/.keep b/spec/rails_app/test/system/.keep new file mode 100644 index 0000000..e69de29 diff --git a/spec/rails_app/test/system/form_in_frame_test.rb b/spec/rails_app/test/system/form_in_frame_test.rb new file mode 100644 index 0000000..8182345 --- /dev/null +++ b/spec/rails_app/test/system/form_in_frame_test.rb @@ -0,0 +1,67 @@ +require "application_system_test_case" + +class TicketsTest < ApplicationSystemTestCase + test "target_top approach with message" do + visit "/form_in_frame" + within "#target_top" do + fill_in "Message", with: "target_top" + click_on "The frame targets the top!" + end + + assert_text "target_top" + end + + test "refresh_action approach with message" do + visit "/form_in_frame" + within "#refresh_action" do + fill_in "Message", with: "refresh_action" + click_on "Use refresh action!" + end + + assert_text "refresh_action" + end + + test "refresh_action approach with no message entered" do + visit "/form_in_frame" + within "#refresh_action" do + click_on "Use refresh action!" + assert_text "An error has occurred: the message can't be empty" + end + end + + test "visit_control approach with message" do + visit "/form_in_frame" + within "#visit_control" do + fill_in "Message", with: "visit_control" + click_on "Make redirect target have turbo-visit-control meta tag!" + end + + assert_text "visit_control" + end + + test "visit_control approach with no message entered" do + visit "/form_in_frame" + within "#visit_control" do + click_on "Make redirect target have turbo-visit-control meta tag!" + assert_text "An error has occurred: the message can't be empty" + end + end + + test "custom_action approach with message" do + visit "/form_in_frame" + within "#custom_action" do + fill_in "Message", with: "custom_action" + click_on "Make redirect target have turbo-visit-control meta tag!" + end + + assert_text "custom_action" + end + + test "custom_action approach with no message entered" do + visit "/form_in_frame" + within "#custom_action" do + click_on "Make redirect target have turbo-visit-control meta tag!" + assert_text "An error has occurred: the message can't be empty" + end + end +end diff --git a/spec/rails_app/test/test_helper.rb b/spec/rails_app/test/test_helper.rb new file mode 100644 index 0000000..0c22470 --- /dev/null +++ b/spec/rails_app/test/test_helper.rb @@ -0,0 +1,15 @@ +ENV["RAILS_ENV"] ||= "test" +require_relative "../config/environment" +require "rails/test_help" + +module ActiveSupport + class TestCase + # Run tests in parallel with specified workers + parallelize(workers: :number_of_processors) + + # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order. + fixtures :all + + # Add more helper methods to be used by all tests here... + end +end