inertia-rage 0.0.1

data/lib/inertia/request_context.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Inertia
+  ##
+  # Encapsulates request-specific context for Inertia partial reloads.
+  class RequestContext
+    EMPTY = [].freeze
+    private_constant :EMPTY
+
+    # Creates a new request context.
+    #
+    # @param request [Rage::Request] the HTTP request object
+    # @param component [String] the Inertia component name being rendered
+    def initialize(request, component:)
+      @request = request
+      @component = component
+    end
+
+    # Returns the full request path including query string.
+    # @return [String] the request URL path
+    def url
+      @request.fullpath
+    end
+
+    # Determines the inclusion status of a prop based on partial reload headers.
+    #
+    # @param prop_name [String] the full path of the prop (e.g., "user.profile")
+    # @return [Symbol] the prop status:
+    #   - `:unspecified` - no partial reload filtering applies
+    #   - `:requested` - prop is explicitly requested in partial reload
+    #   - `:excluded` - prop is excluded from partial reload
+    def prop_status(prop_name)
+      return :unspecified unless partial_render?
+
+      is_excluded = partial_except.any? do |except_prop_name|
+        prop_name == except_prop_name ||
+          (prop_name.start_with?(except_prop_name) && prop_name.start_with?("#{except_prop_name}."))
+      end
+
+      return :excluded if is_excluded
+      return :requested if partial_only.empty? && partial_except.any?
+      return :unspecified if partial_only.empty?
+
+      is_included_in_partial_reload = partial_only.any? do |only_prop_name|
+        prop_name == only_prop_name ||
+          (only_prop_name.start_with?(prop_name) && only_prop_name.start_with?("#{prop_name}.")) ||
+          (prop_name.start_with?(only_prop_name) && prop_name.start_with?("#{only_prop_name}."))
+      end
+
+      is_included_in_partial_reload ? :requested : :excluded
+    end
+
+    # Checks if a once prop should be excluded based on the client's cached props.
+    #
+    # @param prop_name [String] the cache key of the once prop
+    # @return [Boolean] `true` if the client already has this prop cached
+    def once_prop_excluded?(prop_name)
+      except_once.include?(prop_name)
+    end
+
+    # Checks if this is a partial reload request for the current component.
+    # @return [Boolean] `true` if the client requested a partial reload for this component
+    def partial_render?
+      partial_component == @component
+    end
+
+    private
+
+    def partial_except
+      @partial_except ||= @request.env["HTTP_X_INERTIA_PARTIAL_EXCEPT"]&.split(",") || EMPTY
+    end
+
+    def partial_only
+      @partial_only ||= @request.env["HTTP_X_INERTIA_PARTIAL_DATA"]&.split(",") || EMPTY
+    end
+
+    def except_once
+      @except_once ||= @request.env["HTTP_X_INERTIA_EXCEPT_ONCE_PROPS"]&.split(",") || EMPTY
+    end
+
+    def partial_component
+      @partial_component ||= @request.env["HTTP_X_INERTIA_PARTIAL_COMPONENT"]
+    end
+  end
+end

data/lib/inertia/rspec.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require "rage/rspec"
+
+module Inertia
+  module RSpec
+    # Wraps an Inertia response for test assertions.
+    #
+    # @example Accessing response data
+    #   require "inertia/rspec"
+    #
+    #   RSpec.describe UsersController, type: :request do
+    #     it "renders user posts" do
+    #       get "posts"
+    #
+    #       expect(inertia.component).to eq("Posts/Index")
+    #       expect(inertia.props).to have_key(:posts)
+    #     end
+    #   end
+    class TestResponse
+      # @param data [Hash] the raw Inertia response data
+      def initialize(data)
+        @data = data
+      end
+
+      # Returns the props with symbolized keys.
+      # @note To comply with the Inertia protocol, props always include the `errors` object.
+      #
+      # @return [Hash{Symbol => Object}] the props hash
+      def props
+        sybmolize_keys(@data[:props])
+      end
+
+      # Returns the component name.
+      #
+      # @return [String] the Inertia component name
+      def component
+        @data[:component]
+      end
+
+      # Returns the deferred props configuration.
+      #
+      # @return [Hash] the deferred props, or an empty hash if none
+      def deferred_props
+        @data[:deferredProps] || {}
+      end
+
+      private
+
+      def sybmolize_keys(data)
+        data.each_with_object({}).each do |(k, v), memo|
+          transformed_value = if v.is_a?(Hash)
+            sybmolize_keys(v)
+          elsif v.is_a?(Array)
+            v.map { |el| el.is_a?(Hash) ? sybmolize_keys(el) : el }
+          else
+            v
+          end
+
+          memo[k.to_sym] = transformed_value
+        end
+      end
+    end
+
+    module TestHelpers
+      # Returns the Inertia response from the last request.
+      #
+      # @return [TestResponse, nil] the wrapped Inertia response, or nil if the last
+      #   request was not an Inertia response
+      #
+      # @example
+      #   get "/users/1"
+      #   expect(inertia.component).to eq("Users/Show")
+      #   expect(inertia.props[:user]).to include(name: "John")
+      def inertia
+        inertia_response = Fiber.current.instance_variable_get(:@__inertia_current_response)
+        return unless inertia_response
+
+        TestResponse.new(inertia_response)
+      end
+    end
+
+    module RequestHelpers
+      # Performs a GET request with optional Inertia partial reload headers.
+      #
+      # @param inertia [Hash] partial reload options
+      # @option inertia [String, Symbol, Array<String, Symbol>] :only request only these props
+      # @option inertia [String, Symbol, Array<String, Symbol>] :except request all props except these
+      # @param headers [Hash] additional request headers
+      # @raise [ArgumentError] if unknown options are passed in the inertia hash
+      #
+      # @example Request only specific props
+      #   get "/users/1", inertia: { only: [:user, :permissions] }
+      #
+      # @example Request all props except some
+      #   get "/users/1", inertia: { except: :audit_log }
+      def get(*, inertia: nil, headers: {}, **)
+        if inertia
+          inertia = {} unless inertia.is_a?(Hash)
+
+          if inertia.except(:only, :except).any?
+            raise ArgumentError, "Unknown :inertia option. Supported values are :only and :except"
+          end
+
+          headers = headers.merge({
+            "X-Inertia" => "true",
+            "X-Inertia-Partial-Component" => self.inertia&.component || double(:== => true)
+          })
+
+          if only = inertia[:only]
+            headers["X-Inertia-Partial-Data"] = Array(only).join(",")
+          elsif except = inertia[:except]
+            headers["X-Inertia-Partial-Except"] = Array(except).join(",")
+          end
+        end
+
+        super(*, headers:, **)
+      end
+    end
+  end
+end
+
+RSpec::Matchers.matcher :redirect_to do |expected, external: false|
+  failure_message do |response|
+    header = external ? "x-inertia-location" : "location"
+    actual = response.headers[header]
+
+    if expected.is_a?(Regexp)
+      "expected response to be a redirect to /#{expected.source}/ but was a redirect to \"#{actual}\""
+    else
+      "expected response to be a redirect to \"#{expected}\" but was a redirect to \"#{actual}\""
+    end
+  end
+
+  failure_message_when_negated do |response|
+    if expected.is_a?(Regexp)
+      "expected not to redirect to /#{expected.source}/, but did"
+    else
+      "expected not to redirect to \"#{expected}\", but did"
+    end
+  end
+
+  match do |response|
+    header = external ? "x-inertia-location" : "location"
+    actual = response.headers[header]
+
+    if expected.is_a?(Regexp)
+      actual&.match?(expected)
+    else
+      actual == expected
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(Inertia::RSpec::TestHelpers, type: :request)
+  config.prepend(Inertia::RSpec::RequestHelpers, type: :request)
+
+  config.before(:each) do
+    Fiber.current.instance_variable_set(:@__inertia_current_response, nil)
+  end
+
+  config.before(:each) do
+    test_fiber = Fiber.current
+
+    allow_any_instance_of(Inertia::ProtocolBuilder).to receive(:call).and_wrap_original do |m, *args, **kwargs|
+      data = m.call(*args, **kwargs)
+      test_fiber.instance_variable_set(:@__inertia_current_response, data)
+    end
+  end
+end

data/lib/inertia/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Inertia
+  VERSION = "0.0.1"
+end

data/lib/inertia/vite_dev_server.rb

@@ -0,0 +1,27 @@
+module Inertia
+  ##
+  # A daemon that runs the Vite development server alongside the Rage process.
+  #
+  class ViteDevServer < Rage::Daemon
+    def perform
+      puts "INFO: Starting Vite dev server"
+
+      config = Inertia.config.dev_server
+      host, port = config.host, config.port
+
+      command = "#{Frontend.package_runner} vite dev --clearScreen false --host #{host} --port #{port}"
+      @pid = Process.spawn(command, chdir: Frontend.root)
+      Process.wait(@pid)
+
+      # Vite child process sometimes receives a shutdown signal first. The supervisor sees that
+      # the Vite process has exited and schedules a restart before Rage processes its own shutdown.
+      # The delay allows Rage to handle the signal, stop supervision, and avoid a confusing log message.
+      sleep 0.1
+    end
+
+    def cleanup
+      Process.kill("TERM", @pid)
+    rescue Errno::ESRCH
+    end
+  end
+end

data/lib/inertia-rage.rb

@@ -0,0 +1 @@
+require_relative "inertia/inertia"

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: inertia-rage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Roman Samoilov
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rage-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+email:
+- developers@rage-rb.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/inertia-rage.rb
+- lib/inertia/configuration.rb
+- lib/inertia/controller_helpers.rb
+- lib/inertia/frontend.rb
+- lib/inertia/inertia.rb
+- lib/inertia/middleware/assets.rb
+- lib/inertia/middleware/version.rb
+- lib/inertia/props.rb
+- lib/inertia/protocol_builder.rb
+- lib/inertia/rage_extension.rb
+- lib/inertia/renderer.rb
+- lib/inertia/request_context.rb
+- lib/inertia/rspec.rb
+- lib/inertia/version.rb
+- lib/inertia/vite_dev_server.rb
+homepage: https://rage-rb.dev
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rage-rb.dev
+  source_code_uri: https://github.com/rage-rb/inertia-rage
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Inertia.js adapter for the Rage framework
+test_files: []