brush up

Author: naofumi

README.md

@@ -5,6 +5,7 @@ This is an example web application proposing a way to integrate React Router Fra
 Consider using this if you wish to easily create a better React SPA integrated with Ruby on Rails.
 
 [Jump to how to build it](#how-it-is-built)
+[See this example app deployed using Kamal](https://rrrails.castle104.com)
 
 ## The problem
 
@@ -167,10 +168,9 @@ This ensures that assets use the browser cache effectively, whereas the HTML tem
 
 ### Deployment
 
-The React Router build step is integrated into the `bin/rails assets:precompile` task.
+Yarn installation and the React Router build step are integrated into the `bin/rails assets:precompile` task.
 Artifacts are stored inside the Ruby on Rails `public` folder.
 Note that we don't use Propshaft for the React Router build, and therefore artifacts are not saved into `app/assets/builds`.
 
 Your Dockerfile and CI setup can stay the same with the exception that you will need to install Node.js.
-If you want to learn how to do this, creating a new rails app configured with jsbundling is a great way
-to learn how to write a good Dockerfile that installs Node.js.
+See the `Dockerfile` for an example.

app/controllers/react_controller.rb

@@ -4,16 +4,19 @@ class ReactController < ApplicationController
   # This is the catch-all action for React Router. This will render the index.html file
   # for all React Router requests.
   #
-  # Unlike typical webpack or esbuild setups, we do not render ERB files which use
+  # Unlike typical webpack or esbuild setups, we do not render ERB files which include
   # `javascript_include_tag` (propshaft, sprockets) or `javascript_pack_tag` (webpack)
   # to load the React app.
-  # Instead, we render the index.html file that was generated by the React Router build
-  # and renamed to "react-router-index.html".
+  # Instead, take the index.html file that was generated by the React Router build
+  # and rename it to "react-router-index.html".
+  # This is served as a file from the controller in response to the bootstrap file request.
   #
-  # This setup allows us to better benefit from the optimizations that React Router includes
-  # in its build.
+  # Benefits:
   #
-  # The response will also send cookies and other headers set in the controller.
+  # * We can use the index.html file that React Router generates as is.
+  #   This file contains optimizations that would be challenging to recreate on the Rails-side.
+  # * By going through the Rails controller, we can adjust cache and cookie headers to
+  #   improve performance, reliability, and integration with Rails.
   def show
     render file: Rails.root.join("public", "react-router", "react-router-index.html")
   end

app/controllers/sessions_controller.rb

@@ -1,3 +1,10 @@
+# We have implemented a very simply but mostly sufficient login system to
+# illustrate how easy it is to add authentication when done on Rails,
+# thanks to the robust session framework that it provides.
+#
+# Obviously lacking is a password hashing mechanism which Rails provides out of the box
+# as the `use_secure_password` method on ActiveRecord.
+# We use simple clear text passwords here.
 class SessionsController < ApplicationController
   # GET /users/new
   def new

app/controllers/users_controller.rb

@@ -1,78 +1,9 @@
 class UsersController < ApplicationController
-  before_action :set_user, only: %i[ show edit update destroy ]
-
-  # GET /users or /users.json
-  def index
-    @users = User.all
-  end
-
-  # GET /users/1 or /users/1.json
-  def show
-  end
-
   def me
     if @user = current_user
-      render :show
+      render :me
     else
       head :no_content
     end
   end
-
-  # GET /users/new
-  def new
-    @user = User.new
-  end
-
-  # GET /users/1/edit
-  def edit
-  end
-
-  # POST /users or /users.json
-  def create
-    @user = User.new(user_params)
-
-    respond_to do |format|
-      if @user.save
-        format.html { redirect_to @user, notice: "User was successfully created." }
-        format.json { render :show, status: :created, location: @user }
-      else
-        format.html { render :new, status: :unprocessable_entity }
-        format.json { render json: @user.errors, status: :unprocessable_entity }
-      end
-    end
-  end
-
-  # PATCH/PUT /users/1 or /users/1.json
-  def update
-    respond_to do |format|
-      if @user.update(user_params)
-        format.html { redirect_to @user, notice: "User was successfully updated." }
-        format.json { render :show, status: :ok, location: @user }
-      else
-        format.html { render :edit, status: :unprocessable_entity }
-        format.json { render json: @user.errors, status: :unprocessable_entity }
-      end
-    end
-  end
-
-  # DELETE /users/1 or /users/1.json
-  def destroy
-    @user.destroy!
-
-    respond_to do |format|
-      format.html { redirect_to users_path, status: :see_other, notice: "User was successfully destroyed." }
-      format.json { head :no_content }
-    end
-  end
-
-  private
-    # Use callbacks to share common setup or constraints between actions.
-    def set_user
-      @user = User.find(params.expect(:id))
-    end
-
-    # Only allow a list of trusted parameters through.
-    def user_params
-      params.expect(user: [ :email, :clear_password ])
-    end
 end