react_on_rails 16.5.1 → 16.6.0.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4952f875c502a91d85699aee567b2f7f682ef818faf8bc3eb584a20b8cbd617
-  data.tar.gz: 40d9fb9a20e26322a2a67a3da1815f36ad75bfd018e8db84f37fb34d318f9d00
+  metadata.gz: 2294c0aab02fdb0995b81b139099a0585b25ee39ebe903d6238e91a40e2a0341
+  data.tar.gz: 76c6b154c56c639566069a5840496e4ba142b6130429f38ab7580f6bb33bbc29
 SHA512:
-  metadata.gz: 0fc060fcfab135a7f237f44b640a56ac220c18e69ceeeaae107159085855ead5edfc116f207a539decf605006ad4162f59a0f9191602a666de92e7ab1c9dd11a
-  data.tar.gz: d64e7656d3a0ddc657495b36c71cda152e7159aacfc9edbd1a5e10a22c149292498849d44443031b1c4fff49d55cc2fbaa81d853c43115136a6c6250323f2a42
+  metadata.gz: 0521bd2c98262935f0f7bac35e779aec25a6cb8a8039906141ab7e560d27deade2c3b1601d389d4e362ead52ed64b4be0e851ae22a07cb61e15948407e925a69
+  data.tar.gz: bd80ca64b259c5e303111d7f46aeaa2b1e1bcda60af3fcc1873db9e51b39db2bf42bb4f846b9678ea9b8d6b5d4dac0b70183ce6fa30b7953ad2d0a65ee6d7dc4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    react_on_rails (16.5.1)
+    react_on_rails (16.6.0.rc.0)
       addressable
       connection_pool
       execjs (~> 2.5)
@@ -175,7 +175,7 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.7.0)
-    loofah (2.25.0)
+    loofah (2.25.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     mail (2.9.0)
@@ -204,7 +204,7 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.5)
-    nokogiri (1.19.1)
+    nokogiri (1.19.2)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     ostruct (0.6.1)

data/lib/generators/react_on_rails/base_generator.rb

@@ -48,6 +48,13 @@ module ReactOnRails
                    default: false,
                    hide: true
 
+      # Hidden option: used by create-react-on-rails-app so fresh apps get a
+      # generated home page without changing existing-app installs.
+      class_option :new_app,
+                   type: :boolean,
+                   default: false,
+                   hide: true
+
       # Keep this map in sync with templates under:
       # lib/generators/react_on_rails/templates/**/config/webpack/*.tt
       MANAGED_WEBPACK_FILE_TEMPLATES = {
@@ -98,6 +105,51 @@ module ReactOnRails
       private_constant :MANAGED_WEBPACK_FILE_TEMPLATES, :REMOVABLE_WEBPACK_FILES, :TemplateRenderContext,
                        :DOCS_REFERENCE_MESSAGE, :TEMPLATE_RENDER_FAILED
 
+      def add_root_route
+        return unless options.new_app?
+        # add_root_route normally runs before copy_base_files as a generator action.
+        # Guard against accidental double invocation (for example, if future
+        # refactors trigger lazy initialization in generate_new_app_home_page?).
+        return if defined?(@new_app_root_route_added)
+
+        @new_app_root_route_added = false
+
+        if preexisting_root_route?
+          say_status :skip, "Root route already exists; keeping existing root route", :yellow
+          return
+        end
+
+        routes_path = "config/routes.rb"
+        routes_full_path = File.join(destination_root, routes_path)
+
+        unless File.file?(routes_full_path)
+          say_status :warn, "Could not inject root route; config/routes.rb was not found", :yellow
+          return
+        end
+
+        # Support both LF and CRLF route files so new-app onboarding works on Windows checkouts too.
+        routes_draw_declaration = /^\s*Rails\.application\.routes\.draw do\r?\n/
+        unless File.read(routes_full_path).match?(routes_draw_declaration)
+          say_status :warn, "Could not inject root route; config/routes.rb format was unexpected", :yellow
+          return
+        end
+
+        inject_into_file routes_path,
+                         %(  root to: "home#index"\n),
+                         after: routes_draw_declaration
+        if options[:pretend]
+          @new_app_root_route_added = true
+          return
+        end
+
+        if File.read(routes_full_path).include?('root to: "home#index"')
+          @new_app_root_route_added = true
+          return
+        end
+
+        say_status :warn, "Could not inject root route; config/routes.rb format was unexpected", :yellow
+      end
+
       def add_hello_world_route
         # RSC uses HelloServer instead of HelloWorld, but Redux still needs hello_world route
         return if use_rsc? && !options.redux?
@@ -113,6 +165,8 @@ module ReactOnRails
       end
 
       def copy_base_files
+        ensure_new_app_root_route_initialized
+
         base_path = "base/base/"
         base_files = %w[Procfile.dev
                         Procfile.dev-static-assets
@@ -128,12 +182,18 @@ module ReactOnRails
         # HelloWorld controller only when not using RSC (RSC uses HelloServer)
         # Exception: Redux still needs the HelloWorld controller even with RSC
         base_files << "app/controllers/hello_world_controller.rb" unless use_rsc? && !options.redux?
+        base_files << "app/controllers/home_controller.rb" if generate_new_app_home_page?
         base_templates = %w[config/initializers/react_on_rails.rb]
         base_files.each { |file| copy_file("#{base_path}#{file}", file) }
         base_templates.each do |file|
           template("#{base_path}/#{file}.tt", file)
         end
 
+        if generate_new_app_home_page?
+          empty_directory("app/views/home")
+          template("#{base_path}/app/views/home/index.html.erb.tt", "app/views/home/index.html.erb", home_page_config)
+        end
+
         # Make the hook script executable (copy_file guarantees it exists)
         if options[:pretend]
           say_status :pretend, "Skipping chmod on shakapacker-precompile-hook in --pretend mode", :yellow
@@ -237,13 +297,11 @@ module ReactOnRails
       end
 
       CONFIGURE_RSPEC_TO_COMPILE_ASSETS = <<~STR
-        RSpec.configure do |config|
-          # Ensure that if we are running js tests, we are using latest webpack assets
-          # This will use the defaults of :js and :server_rendering meta tags
-          # Requires config.build_test_command in config/initializers/react_on_rails.rb.
-          # This is the default setup for React on Rails generated apps.
-          ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
-        end
+        # Ensure that if we are running js tests, we are using latest webpack assets
+        # This will use the defaults of :js and :server_rendering meta tags
+        # Requires config.build_test_command in config/initializers/react_on_rails.rb.
+        # This is the default setup for React on Rails generated apps.
+        ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
       STR
 
       CONFIGURE_MINITEST_TO_COMPILE_ASSETS = <<~STR
@@ -255,6 +313,362 @@ module ReactOnRails
 
       private
 
+      def generate_new_app_home_page?
+        options.new_app? && new_app_root_route_added?
+      end
+
+      def new_app_root_route_added?
+        return false unless options.new_app?
+        return @new_app_root_route_added if defined?(@new_app_root_route_added)
+
+        false
+      end
+
+      def preexisting_root_route?
+        return @preexisting_root_route if defined?(@preexisting_root_route)
+
+        @preexisting_root_route = root_route_present?
+      end
+
+      def ensure_new_app_root_route_initialized
+        return unless options.new_app?
+        return if defined?(@new_app_root_route_added)
+
+        # add_root_route should run as a generator action first, but keep this
+        # explicit call so copy_base_files remains safe if action ordering changes.
+        add_root_route
+      end
+
+      def home_page_config
+        docs_url = if use_rsc?
+                     "https://reactonrails.com/docs/pro/react-server-components/"
+                   else
+                     "https://reactonrails.com/docs/"
+                   end
+
+        {
+          app_name: app_name,
+          docs_url: docs_url,
+          examples: home_page_examples,
+          file_hints: home_page_file_hints,
+          stack_badges: home_page_stack_badges,
+          learning_links: home_page_learning_links,
+          pro_cta: home_page_pro_cta,
+          pro_section: home_page_pro_section,
+          rendering_paths: home_page_rendering_paths
+        }
+      end
+
+      def home_page_examples
+        examples = []
+
+        if use_rsc?
+          examples << {
+            label: "Open RSC demo",
+            title: "HelloServer",
+            path: "/hello_server",
+            badge: "RSC",
+            description: "Async React Server Components streamed from Rails " \
+                         "with only client islands shipping JavaScript."
+          }
+        end
+
+        unless use_rsc? && !options.redux?
+          example_description = if options.redux?
+                                  "Redux-backed server rendering with hydration."
+                                else
+                                  "Server-rendered React with hydration and hot reloading."
+                                end
+
+          examples << {
+            label: "Open SSR demo",
+            title: options.redux? ? "HelloWorldApp" : "HelloWorld",
+            path: "/hello_world",
+            badge: "SSR",
+            description: example_description
+          }
+        end
+
+        examples
+      end
+
+      def home_page_file_hints
+        hints = [
+          {
+            path: "app/views/home/index.html.erb",
+            description: "Generated landing page. Replace this once your product has a real root route."
+          },
+          {
+            path: example_source_path,
+            description: "React source for the generated example components."
+          },
+          {
+            path: example_view_path,
+            description: "Rails view that mounts the generated example."
+          },
+          {
+            path: using_rspack? ? "config/rspack/" : "config/webpack/",
+            description: "Bundler configuration generated for this app."
+          },
+          {
+            path: "bin/dev",
+            description: "Launch Rails and the asset watcher together from one command."
+          }
+        ]
+
+        if use_pro?
+          hints << {
+            path: "client/node-renderer.js",
+            description: "Node renderer entrypoint used for Pro SSR and RSC."
+          }
+        end
+
+        hints
+      end
+
+      def home_page_learning_links
+        links = [
+          {
+            title: "Documentation guide",
+            url: "https://reactonrails.com/docs/",
+            description: "Core install, generator, and API docs for the OSS stack."
+          },
+          {
+            title: "Compare OSS and Pro",
+            url: "https://reactonrails.com/docs/getting-started/oss-vs-pro/",
+            description: "See which capabilities stay in OSS and which move into the Pro track."
+          },
+          {
+            title: "Pro quick start",
+            url: "https://reactonrails.com/docs/getting-started/pro-quick-start/",
+            description: "Add the Pro gem and package changes when you are ready for the upgrade."
+          },
+          {
+            title: "Marketplace RSC demo",
+            url: "https://github.com/shakacode/react-server-components-marketplace-demo",
+            description: "Study a larger app comparing traditional SSR, client boundaries, and streamed RSC."
+          }
+        ]
+
+        return links unless use_rsc?
+
+        [
+          {
+            title: "React Server Components guide",
+            url: "https://reactonrails.com/docs/pro/react-server-components/",
+            description: "Read the architecture, rendering flow, and migration guidance for the Pro RSC stack."
+          },
+          {
+            title: "RSC tutorial",
+            url: "https://reactonrails.com/docs/pro/react-server-components/tutorial/",
+            description: "Walk through the generated HelloServer example end to end."
+          }
+        ] + links
+      end
+
+      def home_page_pro_cta
+        if use_rsc?
+          {
+            label: "RSC tutorial",
+            url: "https://reactonrails.com/docs/pro/react-server-components/tutorial/"
+          }
+        elsif use_pro?
+          {
+            label: "See Pro docs",
+            url: "https://reactonrails.com/pro/"
+          }
+        else
+          {
+            label: "Compare OSS and Pro",
+            url: "https://reactonrails.com/docs/getting-started/oss-vs-pro/"
+          }
+        end
+      end
+
+      def home_page_pro_section
+        {
+          eyebrow: use_pro? ? "Included in this app" : "Worth evaluating next",
+          title: use_pro? ? "React on Rails Pro is already wired in" : "Why teams move from OSS to Pro",
+          description: use_pro? ? home_page_pro_description_for_enabled_app : home_page_pro_description_for_oss_app,
+          note: use_pro? ? home_page_pro_note_for_enabled_app : home_page_pro_note_for_oss_app,
+          features: home_page_pro_features,
+          links: home_page_pro_links
+        }
+      end
+
+      def home_page_pro_features
+        [
+          {
+            title: "React Server Components",
+            description: "Stream async server components from Rails and keep JavaScript on the client " \
+                         "only where it adds value."
+          },
+          {
+            title: "Node renderer",
+            description: "Use a Node-based rendering path when you need higher-throughput SSR or " \
+                         "richer runtime support."
+          },
+          {
+            title: "Upgrade path",
+            description: "Compare OSS and Pro, follow the quick start, and study the marketplace " \
+                         "demo before rolling changes into a real app."
+          }
+        ]
+      end
+
+      def home_page_pro_links
+        links = [
+          {
+            label: "React on Rails Pro",
+            url: "https://reactonrails.com/pro/"
+          },
+          {
+            label: "Marketplace demo",
+            url: "https://github.com/shakacode/react-server-components-marketplace-demo"
+          }
+        ]
+
+        if use_rsc?
+          links.unshift(
+            {
+              label: "RSC guide",
+              url: "https://reactonrails.com/docs/pro/react-server-components/"
+            }
+          )
+        else
+          links.unshift(
+            {
+              label: "OSS vs Pro",
+              url: "https://reactonrails.com/docs/getting-started/oss-vs-pro/"
+            }
+          )
+        end
+
+        links
+      end
+
+      def home_page_rendering_paths
+        [
+          home_page_ssr_path,
+          home_page_rsc_path,
+          home_page_compare_path
+        ]
+      end
+
+      def home_page_ssr_path
+        if use_rsc? && !options.redux?
+          {
+            badge: "SSR",
+            title: "Server render + hydrate",
+            description: "The OSS baseline: render HTML on the server, then hydrate React in the browser.",
+            url: "https://reactonrails.com/docs/getting-started/tutorial/",
+            cta: "Read the SSR tutorial",
+            external: true
+          }
+        else
+          {
+            badge: "SSR",
+            title: "Server render + hydrate",
+            description: "Rendered on the server, hydrated in the browser, and ready for hot reloading in development.",
+            url: "/hello_world",
+            cta: "Open SSR demo",
+            external: false
+          }
+        end
+      end
+
+      def home_page_rsc_path
+        if use_rsc?
+          {
+            badge: "RSC",
+            title: "Async server components",
+            description: "This app already streams React Server Components from Rails with small client islands.",
+            url: "/hello_server",
+            cta: "Open RSC demo",
+            external: false
+          }
+        else
+          {
+            badge: "RSC",
+            title: "Streaming with server/client boundaries",
+            description: "Use the Pro stack when you want React Server Components and streamed rendering.",
+            url: "https://reactonrails.com/docs/pro/react-server-components/",
+            cta: "See RSC docs",
+            external: true
+          }
+        end
+      end
+
+      def home_page_compare_path
+        if use_pro?
+          {
+            badge: "PRO",
+            title: "Node renderer + upgrade docs",
+            description: "Pro keeps the Rails integration story but adds the Node renderer, RSC " \
+                         "docs, and support paths.",
+            url: "https://reactonrails.com/pro/",
+            cta: "Open Pro overview",
+            external: true
+          }
+        else
+          {
+            badge: "COMPARE",
+            title: "Know when to upgrade",
+            description: "Stay on OSS for the baseline, then compare with Pro before you need RSC " \
+                         "or higher-throughput SSR.",
+            url: "https://reactonrails.com/docs/getting-started/oss-vs-pro/",
+            cta: "Compare OSS and Pro",
+            external: true
+          }
+        end
+      end
+
+      def home_page_stack_badges
+        badges = [
+          options.typescript? ? "TypeScript" : "JavaScript",
+          using_rspack? ? "Rspack" : "Webpack",
+          use_rsc? ? "React Server Components" : "Server-side rendering",
+          "Rails + PostgreSQL"
+        ]
+        badges << "React on Rails Pro" if use_pro?
+        badges
+      end
+
+      def example_source_path
+        return "app/javascript/src/HelloServer/" if use_rsc? && !options.redux?
+        return "app/javascript/src/HelloWorldApp/" if options.redux?
+
+        "app/javascript/src/HelloWorld/"
+      end
+
+      def example_view_path
+        use_rsc? && !options.redux? ? "app/views/hello_server/index.html.erb" : "app/views/hello_world/index.html.erb"
+      end
+
+      def home_page_pro_description_for_enabled_app
+        if use_rsc?
+          "This fresh app already includes the Pro RSC stack. Use the links below to go deeper on " \
+            "the generated HelloServer route, the Node renderer, and larger example apps."
+        else
+          "This fresh app already includes the Pro stack. Use the links below to learn the Node " \
+            "renderer and the broader upgrade story before you shape the app into your own product."
+        end
+      end
+
+      def home_page_pro_description_for_oss_app
+        "Stay on OSS for the base Rails + React workflow. Move to Pro when you want React Server Components, " \
+          "the Node renderer, or a clearer path for performance-focused rendering work."
+      end
+
+      def home_page_pro_note_for_enabled_app
+        "React on Rails Pro can be enabled route by route, so validate the flows that matter before " \
+          "expanding the footprint."
+      end
+
+      def home_page_pro_note_for_oss_app
+        "You can evaluate React on Rails Pro without a license while deciding whether it fits your app."
+      end
+
       def preferred_rspec_helper_file
         rails_helper = File.join(destination_root, "spec/rails_helper.rb")
         return rails_helper if File.exist?(rails_helper)
@@ -731,7 +1145,11 @@ module ReactOnRails
         content = File.read(helper_file)
         return if content.match?(/^\s*[^#\s][^#]*ReactOnRails::TestHelper\.configure_rspec_to_compile_assets/)
 
-        updated_content = content.sub("RSpec.configure do |config|", CONFIGURE_RSPEC_TO_COMPILE_ASSETS)
+        updated_content = content.sub(/^(?<indent>\s*)RSpec\.configure do \|config\|\s*$/) do |header|
+          indent = Regexp.last_match[:indent]
+          insertion = CONFIGURE_RSPEC_TO_COMPILE_ASSETS.lines.map { |line| "#{indent}  #{line}" }.join
+          "#{header}\n#{insertion}"
+        end
         return if updated_content == content
 
         File.write(helper_file, updated_content)