inertia_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 671869c4438679ee4343c013de503e09f283cbdc46c4335426b14a1902e006b3
+  data.tar.gz: bdb6b02a5cf77582a76d9b924775afa58a33aff02bdc677aab23b0c21ba124da
+SHA512:
+  metadata.gz: 6729a9608eeaf81447b9d38350d25080b4856de2150f9e3a6b1a556af4dd73012c5ddf4a34d3e29e0d6ae220a93f156c0b616b4abcdebd2246858df5718645c6
+  data.tar.gz: 55b3c90f175f655aefb21912ab84e34e99e481b61580af7baa87f2da23d40ff24ac945eb0bdee4a3e0d72fe276262f12b1c6ba7193db6c75c632643729a83fd0

data/lib/inertia_builder/controller.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module InertiaBuilder
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      layout -> { inertia_json_request? ? false : 'application' }
+
+      before_action :force_json_response_with_html_template, if: -> { inertia_json_request? }
+    end
+
+    private
+
+    def inertia_json_request?
+      request.headers['X-Inertia'].present?
+    end
+
+    def force_json_response_with_html_template
+      response.content_type = Mime[:json]
+      response.headers['Vary'] = if response.headers['Vary'].blank?
+                                   'X-Inertia'
+                                 else
+                                   "#{response.headers['Vary']}, X-Inertia"
+                                 end
+      response.set_header('X-Inertia', 'true')
+    end
+  end
+end

data/lib/inertia_builder/handler.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module InertiaBuilder
+  class Handler
+    def self.call(template, source = nil)
+      source ||= template.source
+
+      # Keep line numbers right in the error.
+      %{__already_defined = defined?(prop); prop||=InertiaBuilder::PropBuilder.new(self);component=true;#{source};
+      InertiaBuilder::Renderer.new(self, prop.props, component).render unless __already_defined}
+    end
+  end
+end

data/lib/inertia_builder/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module InertiaBuilder
+  class Railtie < ::Rails::Railtie
+    initializer :inertia_builder do
+      ActiveSupport.on_load(:action_controller) do
+        include InertiaBuilder::Controller
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Template.register_template_handler :inertia, InertiaBuilder::Handler
+      end
+    end
+  end
+end

data/lib/inertia_builder/renderer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module InertiaBuilder
+  class Renderer
+    def initialize(view_context, props, component)
+      @view_context = view_context
+      @inertia_renderer = ::InertiaRails::Renderer.new(
+        component,
+        view_context.controller,
+        view_context.request,
+        view_context.response,
+        view_context.controller.method(:render),
+        props: props
+      )
+    end
+
+    def render
+      page = @inertia_renderer.send(:page)
+
+      if @view_context.request.headers['X-Inertia']
+        page.to_json
+      else
+        @view_context.controller.render_to_string(
+          template: 'inertia',
+          layout: false,
+          locals: @inertia_renderer.send(:view_data).merge(page: page)
+        )
+      end
+    end
+  end
+end

data/lib/inertia_builder/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module InertiaBuilder
+  VERSION = '0.1.0'
+end

data/lib/inertia_builder.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'jbuilder/jbuilder_template'
+require 'inertia_builder/handler'
+require 'inertia_builder/controller'
+require 'inertia_builder/renderer'
+require 'inertia_builder/railtie' if defined?(Rails)
+
+module InertiaBuilder
+  class PropBuilder < JbuilderTemplate
+    alias props attributes!
+
+    private
+
+    def _render_partial(options)
+      options[:handlers] = [:inertia]
+      options[:locals][:prop] = self
+      @context.render options
+    end
+
+    def _render_active_model_partial(object)
+      @context.render object, prop: self, handlers: [:inertia]
+    end
+  end
+end

data/test/controller_test.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'action_view/testing/resolvers'
+require 'rails/controller/testing'
+
+class TestController < ActionController::Base
+  include InertiaBuilder::Controller
+
+  def index; end
+end
+
+class ControllerTest < ActionController::TestCase
+  include Rails::Controller::Testing::TemplateAssertions
+
+  tests TestController
+
+  def setup
+    super
+
+    @routes = ActionDispatch::Routing::RouteSet.new
+    @routes.draw { get 'index' => 'test#index' }
+
+    resolver = ActionView::FixtureResolver.new(
+      'layouts/application.html.erb' => '<html><body><%= yield %></body></html>',
+      'test/index.html.inertia' => 'prop.content "content"'
+    )
+
+    @controller.prepend_view_path(resolver)
+  end
+
+  def teardown
+    super
+    @routes.clear!
+  end
+
+  def test_renders_index_html_inertia_for_a_standard_non_inertia_request
+    get :index
+
+    assert_response :success
+    assert_template 'test/index'
+
+    assert_equal 'text/html; charset=utf-8', response.content_type
+    assert_nil response.headers['X-Inertia']
+
+    assert_equal response.body, inertia_html_with_props(content: 'content')
+  end
+
+  def test_renders_index_html_inertia_for_an_inertia_request_with_json_headers
+    @request.headers['X-Inertia'] = 'true'
+    get :index
+
+    assert_response :success
+    assert_template 'test/index'
+
+    assert_equal 'application/json; charset=utf-8', response.content_type
+    assert_equal 'X-Inertia', response.headers['Vary']
+    assert_equal 'true',      response.headers['X-Inertia']
+
+    assert_equal response.body, inertia_json_with_props(content: 'content')
+  end
+
+  private
+
+  def inertia_html_with_props(props)
+    <<~HTML.chomp
+      <html><body><div id="app" data-page="#{ERB::Util.html_escape(inertia_json_with_props(props))}"></div>
+      </body></html>
+    HTML
+  end
+
+  def inertia_json_with_props(props)
+    {
+      component: 'test/index',
+      props:,
+      url: '/index',
+      version: nil,
+      encryptHistory: false,
+      clearHistory: false,
+    }.to_json
+  end
+end

data/test/inertia_builder_test.rb

@@ -0,0 +1,161 @@
+require 'test_helper'
+require 'action_view'
+require "active_model"
+require 'action_view/testing/resolvers'
+
+class User < Struct.new(:id, :first_name, :last_name, :email)
+  include ActiveModel::Conversion
+end
+
+class InertiaBuilderTest < Minitest::Test
+  USER_PARTIAL = <<~INERTIA
+    prop.id user.id
+    prop.first_name user.first_name
+    prop.last_name user.last_name
+    prop.email user.email
+  INERTIA
+
+  PARTIALS = {
+    "users/_user.html.inertia" => USER_PARTIAL,
+  }
+
+  def test_basic_html_rendering
+    result = render_view('prop.hello "World"')
+    assert_equal inertia_html_with_props({ hello: 'World' }), result
+  end
+
+  def test_basic_json_rendering
+    result = render_view('prop.hello "World"', json: true)
+    assert_equal inertia_json_with_props({ hello: 'World' }), result
+  end
+
+  def test_nested_prop
+    template = <<~INERTIA
+      prop.product do
+        prop.id 10
+        prop.name 'Keyboard'
+        prop.price 29.99
+      end
+    INERTIA
+
+    expected_props = {
+      product: {
+        id: 10,
+        name: 'Keyboard',
+        price: 29.99
+      }
+    }
+
+    assert_equal inertia_html_with_props(expected_props), render_view(template)
+    assert_equal inertia_json_with_props(expected_props), render_view(template, json: true)
+  end
+
+  def test_collection_prop
+    products = [
+      {
+        id: 10,
+        name: 'Keyboard',
+        price: 29.99
+      },
+      {
+        id: 11,
+        name: 'Monitor',
+        price: 599.00
+      }
+    ]
+
+    template = <<~INERTIA
+      prop.products @products do |product|
+        prop.id product.fetch(:id)
+        prop.name product.fetch(:name)
+        prop.price product.fetch(:price)
+      end
+    INERTIA
+
+    expected_props = { products: }
+
+    assert_equal inertia_html_with_props(expected_props), render_view(template, assigns: { products: })
+    assert_equal inertia_json_with_props(expected_props), render_view(template, assigns: { products: }, json: true)
+  end
+
+  def test_basic_partial_prop
+    user = User.new({ id: 42, first_name: 'John', last_name: 'Doe', email: 'john@email.com' })
+
+    template = <<~INERTIA
+      prop.user do
+        prop.partial! 'users/user', user: @user
+      end
+    INERTIA
+
+    expected_props = { user: }
+
+    assert_equal inertia_html_with_props(expected_props), render_view(template, assigns: { user: })
+    assert_equal inertia_json_with_props(expected_props), render_view(template, assigns: { user: }, json: true)
+  end
+
+  def test_collection_partial_prop
+    users = [
+      User.new({ id: 42, first_name: 'John', last_name: 'Doe', email: 'john@email.com' }),
+      User.new({ id: 43, first_name: 'Jane', last_name: 'Smith', email: 'jane@email.com' }),
+    ]
+
+    template = <<~INERTIA
+      prop.users @users do |user|
+        prop.partial! user
+      end
+    INERTIA
+
+    expected_props = { users: }
+
+    assert_equal inertia_html_with_props(expected_props), render_view(template, assigns: { users: })
+    assert_equal inertia_json_with_props(expected_props), render_view(template, assigns: { users: }, json: true)
+  end
+
+  def test_nil_prop_block
+    template = <<~INERTIA
+      prop.current_user do
+        prop.nil!
+      end
+    INERTIA
+
+
+    expected_props = { current_user: nil }
+
+    assert_equal inertia_html_with_props(expected_props), render_view(template)
+    assert_equal inertia_json_with_props(expected_props), render_view(template, json: true)
+  end
+
+  private
+
+  def render_view(source, assigns: {}, json: false)
+    req = ActionDispatch::TestRequest.create
+    req.headers['X-Inertia'] = 'true' if json
+
+    controller = ActionView::TestCase::TestController.new
+    controller.request = req
+
+    resolver = ActionView::FixtureResolver.new(PARTIALS.merge('source.html.inertia' => source))
+    lookup = ActionView::LookupContext.new([resolver], {}, [''])
+
+    view = ActionView::Base.with_empty_template_cache.new(lookup, assigns, controller)
+
+    view.render(template: 'source')
+  end
+
+  def inertia_html_with_props(props)
+    <<~HTML
+      <div id="app" data-page="#{ERB::Util.html_escape(inertia_json_with_props(props))}"></div>
+    HTML
+  end
+
+  def inertia_json_with_props(props)
+    {
+      component: '/',
+      props:,
+      url: '/',
+      version: nil,
+      encryptHistory: false,
+      clearHistory: false,
+    }.to_json
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rails'
+require 'action_controller/railtie'
+
+require 'jbuilder'
+require 'inertia_rails'
+require 'inertia_builder'
+require 'active_support/testing/autorun'
+
+ActiveSupport.test_order = :random
+
+# Instantiate an Application in order to trigger the initializers
+Class.new(Rails::Application) do
+  config.secret_key_base = 'secret'
+  config.eager_load = false
+end.initialize!
+
+# Touch AV::Base in order to trigger :action_view on_load hook before running the tests
+ActionView::Base.inspect

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: inertia_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo Lima
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inertia_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+email: rodrigotavio91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/inertia_builder.rb
+- lib/inertia_builder/controller.rb
+- lib/inertia_builder/handler.rb
+- lib/inertia_builder/railtie.rb
+- lib/inertia_builder/renderer.rb
+- lib/inertia_builder/version.rb
+- test/controller_test.rb
+- test/inertia_builder_test.rb
+- test/test_helper.rb
+homepage: https://github.com/rodrigotavio91/inertia-builder
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/rodrigotavio91/inertia-builder/issues
+  changelog_uri: https://github.com/rodrigotavio91/inertia-builder/releases/tag/v0.1.0
+  source_code_uri: https://github.com/rodrigotavio91/inertia-builder/tree/v0.1.0
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Create Inertia.js props via a Jbuilder-style DSL
+test_files:
+- test/controller_test.rb
+- test/inertia_builder_test.rb
+- test/test_helper.rb