Rename validation methods to use ! convention for exception-throwing

Author: AbanoubGhadban

lib/react_on_rails/utils.rb

@@ -239,7 +239,7 @@ def self.react_on_rails_pro?
       @react_on_rails_pro = begin
         return false unless gem_available?("react_on_rails_pro")
 
-        ReactOnRailsPro::Utils.licence_valid?
+        ReactOnRailsPro::Utils.validate_licence!
       end
     end
 

react_on_rails_pro/lib/react_on_rails_pro/engine.rb

@@ -15,7 +15,7 @@ class Engine < Rails::Engine
       config.after_initialize do
         Rails.logger.info "[React on Rails Pro] Validating license..."
 
-        if ReactOnRailsPro::LicenseValidator.valid?
+        if ReactOnRailsPro::LicenseValidator.validate!
           Rails.logger.info "[React on Rails Pro] License validation successful"
         else
           # License validation will raise an error, so this line won't be reached

react_on_rails_pro/lib/react_on_rails_pro/license_public_key.rb

@@ -6,7 +6,7 @@ module LicensePublicKey
     # The private key corresponding to this public key is held by ShakaCode
     # and is never committed to the repository
     # Last updated: 2025-10-09 15:57:09 UTC
-    # Source: http://localhost:8788/api/public-key
+    # Source: http://shakacode.com/api/public-key
     KEY = OpenSSL::PKey::RSA.new(<<~PEM.strip.strip_heredoc)
       -----BEGIN PUBLIC KEY-----
 MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlJFK3aWuycVp9X05qhGo

react_on_rails_pro/lib/react_on_rails_pro/license_validator.rb

@@ -6,14 +6,19 @@
 module ReactOnRailsPro
   class LicenseValidator
     class << self
-      def valid?
-        return @valid if defined?(@valid)
-
-        @valid = validate_license
+      # Validates the license and raises an exception if invalid.
+      # Caches the result after first validation.
+      #
+      # @return [Boolean] true if license is valid
+      # @raise [ReactOnRailsPro::Error] if license is invalid
+      def validate!
+        return @validate if defined?(@validate)
+
+        @validate = validate_license
       end
 
       def reset!
-        remove_instance_variable(:@valid) if defined?(@valid)
+        remove_instance_variable(:@validate) if defined?(@validate)
         remove_instance_variable(:@license_data) if defined?(@license_data)
         remove_instance_variable(:@validation_error) if defined?(@validation_error)
       end
@@ -22,55 +27,51 @@ def license_data
         @license_data ||= load_and_decode_license
       end
 
-      def validation_error
-        @validation_error
-      end
+      attr_reader :validation_error
 
       private
 
       def validate_license
-        begin
-          license = load_and_decode_license
-          # If no license found, load_license_string already handled the error
-          return false unless license
-
-          # Check that exp field exists
-          unless license["exp"]
-            @validation_error = "License is missing required expiration field. " \
-                               "Your license may be from an older version. " \
-                               "Get a FREE evaluation license at https://shakacode.com/react-on-rails-pro"
-            handle_invalid_license(@validation_error)
-            return false
-          end
-
-          # Check expiry
-          if Time.now.to_i > license["exp"]
-            @validation_error = "License has expired. " \
-                               "Get a FREE evaluation license (3 months) at https://shakacode.com/react-on-rails-pro " \
-                               "or upgrade to a paid license for production use."
-            handle_invalid_license(@validation_error)
-            return false
-          end
-
-          # Log license type if present (for analytics)
-          log_license_info(license)
-
-          true
-        rescue ReactOnRailsPro::Error
-          # Re-raise errors from handle_invalid_license
-          raise
-        rescue JWT::DecodeError => e
-          @validation_error = "Invalid license signature: #{e.message}. " \
-                             "Your license file may be corrupted. " \
-                             "Get a FREE evaluation license at https://shakacode.com/react-on-rails-pro"
+        license = load_and_decode_license
+        # If no license found, load_license_string already handled the error
+        return false unless license
+
+        # Check that exp field exists
+        unless license["exp"]
+          @validation_error = "License is missing required expiration field. " \
+                              "Your license may be from an older version. " \
+                              "Get a FREE evaluation license at https://shakacode.com/react-on-rails-pro"
           handle_invalid_license(@validation_error)
-          false
-        rescue StandardError => e
-          @validation_error = "License validation error: #{e.message}. " \
-                             "Get a FREE evaluation license at https://shakacode.com/react-on-rails-pro"
+          return false
+        end
+
+        # Check expiry
+        if Time.now.to_i > license["exp"]
+          @validation_error = "License has expired. " \
+                              "Get a FREE evaluation license (3 months) at https://shakacode.com/react-on-rails-pro " \
+                              "or upgrade to a paid license for production use."
           handle_invalid_license(@validation_error)
-          false
+          return false
         end
+
+        # Log license type if present (for analytics)
+        log_license_info(license)
+
+        true
+      rescue ReactOnRailsPro::Error
+        # Re-raise errors from handle_invalid_license
+        raise
+      rescue JWT::DecodeError => e
+        @validation_error = "Invalid license signature: #{e.message}. " \
+                            "Your license file may be corrupted. " \
+                            "Get a FREE evaluation license at https://shakacode.com/react-on-rails-pro"
+        handle_invalid_license(@validation_error)
+        false
+      rescue StandardError => e
+        @validation_error = "License validation error: #{e.message}. " \
+                            "Get a FREE evaluation license at https://shakacode.com/react-on-rails-pro"
+        handle_invalid_license(@validation_error)
+        false
       end
 
       def load_and_decode_license
@@ -92,16 +93,16 @@ def load_and_decode_license
 
       def load_license_string
         # First try environment variable
-        license = ENV["REACT_ON_RAILS_PRO_LICENSE"]
+        license = ENV.fetch("REACT_ON_RAILS_PRO_LICENSE", nil)
         return license if license.present?
 
         # Then try config file
         config_path = Rails.root.join("config", "react_on_rails_pro_license.key")
         return File.read(config_path).strip if config_path.exist?
 
         @validation_error = "No license found. Please set REACT_ON_RAILS_PRO_LICENSE environment variable " \
-                           "or create config/react_on_rails_pro_license.key file. " \
-                           "Get a FREE evaluation license at https://shakacode.com/react-on-rails-pro"
+                            "or create config/react_on_rails_pro_license.key file. " \
+                            "Get a FREE evaluation license at https://shakacode.com/react-on-rails-pro"
         handle_invalid_license(@validation_error)
         nil
       end

react_on_rails_pro/lib/react_on_rails_pro/utils.rb

@@ -16,8 +16,12 @@ def self.rorp_puts(message)
       puts "[ReactOnRailsPro] #{message}"
     end
 
-    def self.licence_valid?
-      LicenseValidator.valid?
+    # Validates the license and raises an exception if invalid.
+    #
+    # @return [Boolean] true if license is valid
+    # @raise [ReactOnRailsPro::Error] if license is invalid
+    def self.validate_licence!
+      LicenseValidator.validate!
     end
 
     def self.copy_assets

react_on_rails_pro/spec/react_on_rails_pro/license_validator_spec.rb

@@ -40,31 +40,30 @@
     ENV.delete("REACT_ON_RAILS_PRO_LICENSE")
 
     # Stub Rails.logger to avoid nil errors in unit tests
-    allow(Rails).to receive(:logger).and_return(mock_logger)
     # Stub Rails.root for config file path tests
-    allow(Rails).to receive(:root).and_return(mock_root)
+    allow(Rails).to receive_messages(logger: mock_logger, root: mock_root)
   end
 
   after do
     described_class.reset!
     ENV.delete("REACT_ON_RAILS_PRO_LICENSE")
   end
 
-  describe ".valid?" do
+  describe ".validate!" do
     context "with valid license in ENV" do
       before do
         valid_token = JWT.encode(valid_payload, test_private_key, "RS256")
         ENV["REACT_ON_RAILS_PRO_LICENSE"] = valid_token
       end
 
       it "returns true" do
-        expect(described_class.valid?).to be true
+        expect(described_class.validate!).to be true
       end
 
       it "caches the result" do
         expect(described_class).to receive(:validate_license).once.and_call_original
-        described_class.valid?
-        described_class.valid? # Second call should use cache
+        described_class.validate!
+        described_class.validate! # Second call should use cache
       end
     end
 
@@ -75,11 +74,11 @@
       end
 
       it "raises error" do
-        expect { described_class.valid? }.to raise_error(ReactOnRailsPro::Error, /License has expired/)
+        expect { described_class.validate! }.to raise_error(ReactOnRailsPro::Error, /License has expired/)
       end
 
       it "includes FREE license information in error message" do
-        expect { described_class.valid? }.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
+        expect { described_class.validate! }.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
       end
     end
 
@@ -98,12 +97,12 @@
       end
 
       it "raises error" do
-        expect { described_class.valid? }
+        expect { described_class.validate! }
           .to raise_error(ReactOnRailsPro::Error, /License is missing required expiration field/)
       end
 
       it "includes FREE license information in error message" do
-        expect { described_class.valid? }.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
+        expect { described_class.validate! }.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
       end
     end
 
@@ -115,11 +114,11 @@
       end
 
       it "raises error" do
-        expect { described_class.valid? }.to raise_error(ReactOnRailsPro::Error, /Invalid license signature/)
+        expect { described_class.validate! }.to raise_error(ReactOnRailsPro::Error, /Invalid license signature/)
       end
 
       it "includes FREE license information in error message" do
-        expect { described_class.valid? }.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
+        expect { described_class.validate! }.to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
       end
     end
 
@@ -130,11 +129,11 @@
       end
 
       it "raises error" do
-        expect { described_class.valid? }.to raise_error(ReactOnRailsPro::Error, /No license found/)
+        expect { described_class.validate! }.to raise_error(ReactOnRailsPro::Error, /No license found/)
       end
 
       it "includes FREE license information in error message" do
-        expect { described_class.valid? }
+        expect { described_class.validate! }
           .to raise_error(ReactOnRailsPro::Error, /FREE evaluation license/)
       end
     end
@@ -152,7 +151,7 @@
       end
 
       it "returns true" do
-        expect(described_class.valid?).to be true
+        expect(described_class.validate!).to be true
       end
     end
   end
@@ -180,7 +179,7 @@
 
       it "returns the error message" do
         begin
-          described_class.valid?
+          described_class.validate!
         rescue ReactOnRailsPro::Error
           # Expected error
         end
@@ -193,13 +192,13 @@
     before do
       valid_token = JWT.encode(valid_payload, test_private_key, "RS256")
       ENV["REACT_ON_RAILS_PRO_LICENSE"] = valid_token
-      described_class.valid? # Cache the result
+      described_class.validate! # Cache the result
     end
 
     it "clears the cached validation result" do
-      expect(described_class.instance_variable_get(:@valid)).to be true
+      expect(described_class.instance_variable_get(:@validate)).to be true
       described_class.reset!
-      expect(described_class.instance_variable_defined?(:@valid)).to be false
+      expect(described_class.instance_variable_defined?(:@validate)).to be false
     end
   end
 end