fix all pro rubocop errors

Author: Judahmeek

react_on_rails_pro/lib/react_on_rails_pro/license_public_key.rb

@@ -16,15 +16,15 @@ module LicensePublicKey
     # TODO: Add a prepublish check to ensure this key matches the latest public key from the API.
     #       This should be implemented after publishing the API endpoint on the ShakaCode website.
     KEY = OpenSSL::PKey::RSA.new(<<~PEM.strip.strip_heredoc)
-      -----BEGIN PUBLIC KEY-----
-MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzcS/fpHz5CbnTQxb4Zot
-khjzXu7xNS+Y9VKfapMaHOMzNoCMfy1++hxHJatRedr+YQfZRCjfiN168Cpe+dhe
-yfNtOoLU9/+/5jTsxH+WQJWNRswyKms5HNajlIMN1GEYdZmZbvOPaZvh6ENsT+EV
-HnhjJtsHl7qltBoL0ul7rONxaNHCzJcKk4lf3B2/1j1wpA91MKz4bbQVh4/6Th0E
-/39f0PWvvBXzQS+yt1qaa1DIX5YL6Aug5uEpb1+6QWcN3hCzqSPBv1HahrG50rsD
-gf8KORV3X2N9t6j6iqPmRqfRcTBKtmPhM9bORtKiSwBK8LsIUzp2/UUmkdHnkyzu
-NQIDAQAB
------END PUBLIC KEY-----
+            -----BEGIN PUBLIC KEY-----
+      MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzcS/fpHz5CbnTQxb4Zot
+      khjzXu7xNS+Y9VKfapMaHOMzNoCMfy1++hxHJatRedr+YQfZRCjfiN168Cpe+dhe
+      yfNtOoLU9/+/5jTsxH+WQJWNRswyKms5HNajlIMN1GEYdZmZbvOPaZvh6ENsT+EV
+      HnhjJtsHl7qltBoL0ul7rONxaNHCzJcKk4lf3B2/1j1wpA91MKz4bbQVh4/6Th0E
+      /39f0PWvvBXzQS+yt1qaa1DIX5YL6Aug5uEpb1+6QWcN3hCzqSPBv1HahrG50rsD
+      gf8KORV3X2N9t6j6iqPmRqfRcTBKtmPhM9bORtKiSwBK8LsIUzp2/UUmkdHnkyzu
+      NQIDAQAB
+      -----END PUBLIC KEY-----
     PEM
   end
 end

react_on_rails_pro/lib/react_on_rails_pro/request.rb

@@ -217,7 +217,7 @@ def common_form_data
         ReactOnRailsPro::Utils.common_form_data
       end
 
-      def create_connection
+      def create_connection # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         url = ReactOnRailsPro.configuration.renderer_url
         Rails.logger.info do
           "[ReactOnRailsPro] Setting up Node Renderer connection to #{url}"
@@ -229,28 +229,37 @@ def create_connection
           # https://honeyryderchuck.gitlab.io/httpx/wiki/Persistent
           .plugin(
             :retries, max_retries: 1,
-            retry_change_requests: true,
-            # Official HTTPx docs says that we should use the retry_on option to decide if teh request should be retried or not
-            # However, HTTPx assumes that connection errors such as timeout error should be retried by default and it doesn't consider retry_on block at all at that case
-            # So, we have to do the following trick to avoid retries when a Timeout error happens while streaming a component
-            # If the streamed component returned any chunks, it shouldn't retry on errors, as it would cause page duplication
-            # The SSR-generated html will be written to the page two times in this case
-            retry_after: ->(request, response) do
-              if (request.stream.instance_variable_get(:@react_on_rails_received_first_chunk))
-                e = response.error
-                raise ReactOnRailsPro::Error, "An error happened during server side render streaming of a component.\n" \
-                                              "Original error:\n#{e}\n#{e.backtrace}"
-              end
-
-              Rails.logger.info do
-                "[ReactOnRailsPro] An error happneding while making a request to the Node Renderer.\n" \
-                "Error: #{response.error}.\n" \
-                "Retrying by HTTPX \"retries\" plugin..."
-              end
-              # The retry_after block expects to return a delay to wait before retrying the request
-              # nil means no waiting delay
-              nil
-            end
+                      retry_change_requests: true,
+                      # Official HTTPx docs says that we should use the retry_on option to decide if the
+                      # request should be retried or not
+                      # However, HTTPx assumes that connection errors such as timeout error should be retried
+                      # by default and it doesn't consider retry_on block at all at that case
+                      # So, we have to do the following trick to avoid retries when a Timeout error happens
+                      # while streaming a component
+                      # If the streamed component returned any chunks, it shouldn't retry on errors, as it
+                      # would cause page duplication
+                      # The SSR-generated html will be written to the page two times in this case
+                      retry_after: lambda do |request, response|
+                                     if request.stream.instance_variable_get(:@react_on_rails_received_first_chunk)
+                                       e = response.error
+                                       raise(
+                                         ReactOnRailsPro::Error,
+                                         "An error happened during server side render streaming " \
+                                         "of a component.\nOriginal error:\n#{e}\n#{e.backtrace}"
+                                       )
+                                     end
+
+                                     Rails.logger.info do
+                                       "[ReactOnRailsPro] An error occurred while making " \
+                                         "a request to the Node Renderer.\n" \
+                                         "Error: #{response.error}.\n" \
+                                         "Retrying by HTTPX \"retries\" plugin..."
+                                     end
+                                     # The retry_after block expects to return a delay to wait before
+                                     # retrying the request
+                                     # nil means no waiting delay
+                                     nil
+                                   end
           )
           .plugin(:stream)
           # See https://www.rubydoc.info/gems/httpx/1.3.3/HTTPX%2FOptions:initialize for the available options

react_on_rails_pro/lib/react_on_rails_pro/stream_request.rb

@@ -51,23 +51,23 @@ def handle_chunk(chunk, position)
       end
     end
 
-    def each_chunk(&block)
+    def each_chunk(&block) # rubocop:disable Metrics/CyclomaticComplexity
       return enum_for(:each_chunk) unless block
 
       first_chunk = true
       @component.each_chunk do |chunk|
         position = first_chunk ? :first : :middle
         modified_chunk = handle_chunk(chunk, position)
-        block.call(modified_chunk)
+        yield(modified_chunk)
         first_chunk = false
       end
 
       # The last chunk contains the append content after the transformation
       # All transformations are applied to the append content
       last_chunk = handle_chunk("", :last)
-      block.call(last_chunk) unless last_chunk.empty?
-    rescue StandardError => err
-      current_error = err
+      yield(last_chunk) unless last_chunk.empty?
+    rescue StandardError => e
+      current_error = e
       rescue_block_index = 0
       while current_error.present? && (rescue_block_index < @rescue_blocks.size)
         begin

react_on_rails_pro/rakelib/public_key_management.rake

@@ -13,9 +13,9 @@ require "uri"
 #   rake react_on_rails_pro:verify_public_key              # Verify current configuration
 #   rake react_on_rails_pro:public_key_help                # Show help
 
-namespace :react_on_rails_pro do
+namespace :react_on_rails_pro do # rubocop:disable Metrics/BlockLength
   desc "Update the public key for React on Rails Pro license validation"
-  task :update_public_key, [:source] do |_task, args|
+  task :update_public_key, [:source] do |_task, args| # rubocop:disable Metrics/BlockLength
     source = args[:source] || "production"
 
     # Determine the API URL based on the source
@@ -68,7 +68,7 @@ namespace :react_on_rails_pro do
             # ShakaCode's public key for React on Rails Pro license verification
             # The private key corresponding to this public key is held by ShakaCode
             # and is never committed to the repository
-            # Last updated: #{Time.now.utc.strftime("%Y-%m-%d %H:%M:%S UTC")}
+            # Last updated: #{Time.now.utc.strftime('%Y-%m-%d %H:%M:%S UTC')}
             # Source: #{api_url}
             #
             # You can update this public key by running the rake task:
@@ -86,12 +86,13 @@ namespace :react_on_rails_pro do
       puts "✅ Updated Ruby public key: #{ruby_file_path}"
 
       # Update Node/TypeScript public key file
-      node_file_path = File.join(File.dirname(__FILE__), "..", "packages", "node-renderer", "src", "shared", "licensePublicKey.ts")
+      node_file_path = File.join(File.dirname(__FILE__), "..", "packages", "node-renderer", "src", "shared",
+                                 "licensePublicKey.ts")
       node_content = <<~TYPESCRIPT
         // ShakaCode's public key for React on Rails Pro license verification
         // The private key corresponding to this public key is held by ShakaCode
         // and is never committed to the repository
-        // Last updated: #{Time.now.utc.strftime("%Y-%m-%d %H:%M:%S UTC")}
+        // Last updated: #{Time.now.utc.strftime('%Y-%m-%d %H:%M:%S UTC')}
         // Source: #{api_url}
         //
         // You can update this public key by running the rake task:

react_on_rails_pro/spec/dummy/app/controllers/pages_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class PagesController < ApplicationController
+class PagesController < ApplicationController # rubocop:disable Metrics/ClassLength
   include ReactOnRailsPro::RSCPayloadRenderer
   include RscPostsPageOverRedisHelper
 
@@ -85,8 +85,8 @@ def redis_receiver
     ensure
       begin
         redis&.close
-      rescue StandardError => close_err
-        Rails.logger.warn "Failed to close Redis: #{close_err.message}"
+      rescue StandardError => e
+        Rails.logger.warn "Failed to close Redis: #{e.message}"
       end
     end
 

react_on_rails_pro/spec/dummy/spec/system/integration_spec.rb

@@ -396,14 +396,14 @@ def change_text_expect_dom_selector(dom_selector, expect_no_change: false)
 
   it "hydrates the component" do
     visit path
-    expect(page.html).to match(/client-bundle[^\"]*.js/)
+    expect(page.html).to match(/client-bundle[^"]*.js/)
     change_text_expect_dom_selector(selector)
   end
 
   it "renders the page completely on server and displays content on client even without JavaScript" do
     # Don't add client-bundle.js to the page to ensure that the app is not hydrated
     visit "#{path}?skip_js_packs=true"
-    expect(page.html).not_to match(/client-bundle[^\"]*.js/)
+    expect(page.html).not_to match(/client-bundle[^"]*.js/)
     # Ensure that the component state is not updated
     change_text_expect_dom_selector(selector, expect_no_change: true)
 
@@ -432,7 +432,7 @@ def change_text_expect_dom_selector(dom_selector, expect_no_change: false)
                   "#ServerComponentRouter-react-component-0"
 
   # Skip the test that fails without JavaScript - being addressed in another PR
-  it "renders the page completely on server and displays content on client even without JavaScript",
+  it "renders the page completely on server and displays content on client even without JavaScript", # rubocop:disable RSpec/NoExpectationExample
      skip: "Being addressed in another PR" do
     # This test is overridden to skip it
   end

react_on_rails_pro/spec/react_on_rails_pro/configuration_spec.rb

@@ -2,7 +2,7 @@
 
 require_relative "spec_helper"
 
-module ReactOnRailsPro
+module ReactOnRailsPro # rubocop:disable Metrics/ModuleLength
   RSpec.describe Configuration do
     after do
       ReactOnRailsPro.instance_variable_set(:@configuration, nil)
@@ -205,7 +205,8 @@ def self.fetch(*)
 
         expect(ReactOnRailsPro.configuration.rsc_bundle_js_file).to eq("rsc-bundle.js")
         expect(ReactOnRailsPro.configuration.react_client_manifest_file).to eq("react-client-manifest.json")
-        expect(ReactOnRailsPro.configuration.react_server_client_manifest_file).to eq("react-server-client-manifest.json")
+        expect(ReactOnRailsPro.configuration.react_server_client_manifest_file)
+          .to eq("react-server-client-manifest.json")
       end
 
       it "allows setting rsc_bundle_js_file" do
@@ -229,7 +230,8 @@ def self.fetch(*)
           config.react_server_client_manifest_file = "custom-server-client-manifest.json"
         end
 
-        expect(ReactOnRailsPro.configuration.react_server_client_manifest_file).to eq("custom-server-client-manifest.json")
+        expect(ReactOnRailsPro.configuration.react_server_client_manifest_file)
+          .to eq("custom-server-client-manifest.json")
       end
 
       it "allows nil values for RSC configuration options" do

react_on_rails_pro/spec/react_on_rails_pro/license_validator_spec.rb

@@ -75,26 +75,30 @@
         ENV["REACT_ON_RAILS_PRO_LICENSE"] = expired_token
       end
 
-      context "in development/test environment" do
+      context "when in development/test environment" do
         before do
           allow(Rails).to receive(:env).and_return(ActiveSupport::StringInquirer.new("development"))
         end
 
         it "raises error immediately" do
-          expect { described_class.validated_license_data! }.to raise_error(ReactOnRailsPro::Error, /License has expired/)
+          expect do
+            described_class.validated_license_data!
+          end.to raise_error(ReactOnRailsPro::Error, /License has expired/)
         end
 
         it "includes FREE license information in error message" do
-          expect { described_class.validated_license_data! }.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
+          expect do
+            described_class.validated_license_data!
+          end.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
         end
       end
 
-      context "in production environment" do
+      context "when in production environment" do
         before do
           allow(Rails).to receive(:env).and_return(ActiveSupport::StringInquirer.new("production"))
         end
 
-        context "within grace period (expired < 1 month ago)" do
+        context "with grace period (expired < 1 month ago)" do
           let(:expired_within_grace) do
             {
               sub: "[email protected]",
@@ -113,7 +117,8 @@
           end
 
           it "logs warning with grace period remaining" do
-            expect(mock_logger).to receive(:error).with(/WARNING:.*License has expired.*Grace period:.*day\(s\) remaining/)
+            expect(mock_logger).to receive(:error)
+              .with(/WARNING:.*License has expired.*Grace period:.*day\(s\) remaining/)
             described_class.validated_license_data!
           end
 
@@ -123,7 +128,7 @@
           end
         end
 
-        context "outside grace period (expired > 1 month ago)" do
+        context "when outside grace period (expired > 1 month ago)" do
           let(:expired_outside_grace) do
             {
               sub: "[email protected]",
@@ -138,11 +143,15 @@
           end
 
           it "raises error" do
-            expect { described_class.validated_license_data! }.to raise_error(ReactOnRailsPro::Error, /License has expired/)
+            expect do
+              described_class.validated_license_data!
+            end.to raise_error(ReactOnRailsPro::Error, /License has expired/)
           end
 
           it "includes FREE license information in error message" do
-            expect { described_class.validated_license_data! }.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
+            expect do
+              described_class.validated_license_data!
+            end.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
           end
         end
       end
@@ -168,7 +177,9 @@
       end
 
       it "includes FREE license information in error message" do
-        expect { described_class.validated_license_data! }.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
+        expect do
+          described_class.validated_license_data!
+        end.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
       end
     end
 
@@ -180,11 +191,15 @@
       end
 
       it "raises error" do
-        expect { described_class.validated_license_data! }.to raise_error(ReactOnRailsPro::Error, /Invalid license signature/)
+        expect do
+          described_class.validated_license_data!
+        end.to raise_error(ReactOnRailsPro::Error, /Invalid license signature/)
       end
 
       it "includes FREE license information in error message" do
-        expect { described_class.validated_license_data! }.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
+        expect do
+          described_class.validated_license_data!
+        end.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
       end
     end
 

react_on_rails_pro/spec/react_on_rails_pro/stream_decorator_spec.rb

@@ -65,7 +65,7 @@
 
   describe "#rescue" do
     it "catches the error happens inside the component" do
-      allow(mock_component).to receive(:each_chunk).and_raise(StandardError.new "Fake Error")
+      allow(mock_component).to receive(:each_chunk).and_raise(StandardError.new("Fake Error"))
       mocked_block = mock_block
 
       stream_decorator.rescue(&mocked_block.block)
@@ -80,7 +80,7 @@
     end
 
     it "catches the error happens inside subsequent component calls" do
-      allow(mock_component).to receive(:each_chunk).and_yield("Chunk1").and_raise(ArgumentError.new "Fake Error")
+      allow(mock_component).to receive(:each_chunk).and_yield("Chunk1").and_raise(ArgumentError.new("Fake Error"))
       mocked_block = mock_block
 
       stream_decorator.rescue(&mocked_block.block)
@@ -96,7 +96,7 @@
     end
 
     it "can yield values to the stream" do
-      allow(mock_component).to receive(:each_chunk).and_yield("Chunk1").and_raise(ArgumentError.new "Fake Error")
+      allow(mock_component).to receive(:each_chunk).and_yield("Chunk1").and_raise(ArgumentError.new("Fake Error"))
       mocked_block = mock_block
 
       stream_decorator.rescue(&mocked_block.block)
@@ -115,11 +115,11 @@
     end
 
     it "can convert the error into another error" do
-      allow(mock_component).to receive(:each_chunk).and_raise(StandardError.new "Fake Error")
+      allow(mock_component).to receive(:each_chunk).and_raise(StandardError.new("Fake Error"))
       mocked_block = mock_block do |error|
         expect(error).to be_a(StandardError)
         expect(error.message).to eq("Fake Error")
-        raise ArgumentError.new "Another Error"
+        raise ArgumentError, "Another Error"
       end
 
       stream_decorator.rescue(&mocked_block.block)
@@ -129,12 +129,12 @@
     end
 
     it "chains multiple rescue blocks" do
-      allow(mock_component).to receive(:each_chunk).and_yield("Chunk1").and_raise(StandardError.new "Fake Error")
+      allow(mock_component).to receive(:each_chunk).and_yield("Chunk1").and_raise(StandardError.new("Fake Error"))
       fist_rescue_block = mock_block do |error, &block|
         expect(error).to be_a(StandardError)
         expect(error.message).to eq("Fake Error")
         block.call "Chunk from first rescue block"
-        raise ArgumentError.new "Another Error"
+        raise ArgumentError, "Another Error"
       end
 
       second_rescue_block = mock_block do |error, &block|