inertia_builder 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 671869c4438679ee4343c013de503e09f283cbdc46c4335426b14a1902e006b3
-  data.tar.gz: bdb6b02a5cf77582a76d9b924775afa58a33aff02bdc677aab23b0c21ba124da
+  metadata.gz: d326ccb567aaf8b60dd19a3ec57358008e620e575e725e0827cf9378e64bf8e7
+  data.tar.gz: 4876abe3f8910c981e628417876b88598b643564dd471f6b8bdb66bd9064e799
 SHA512:
-  metadata.gz: 6729a9608eeaf81447b9d38350d25080b4856de2150f9e3a6b1a556af4dd73012c5ddf4a34d3e29e0d6ae220a93f156c0b616b4abcdebd2246858df5718645c6
-  data.tar.gz: 55b3c90f175f655aefb21912ab84e34e99e481b61580af7baa87f2da23d40ff24ac945eb0bdee4a3e0d72fe276262f12b1c6ba7193db6c75c632643729a83fd0
+  metadata.gz: 64a1c8f5f14eefd54908e53b6e88f7b199e4e30a9b9ce7d8fa25932508ccc1727481d89f8b40f4f638eace0a1609bf270e98ead3931fe46a86b4969860bca38f
+  data.tar.gz: 3f4026b1fbc067905de4a5eae7f8289bfe3987d6464be4622d254b9efabf8acac319c92dc6cd6c1cf8a147ff94b9a625c5fe60c4a6b40e1446c0470cd2a2159b

data/lib/inertia_builder/controller.rb

@@ -5,19 +5,12 @@ module InertiaBuilder
     extend ActiveSupport::Concern
 
     included do
-      layout -> { inertia_json_request? ? false : 'application' }
-
-      before_action :force_json_response_with_html_template, if: -> { inertia_json_request? }
+      before_action :format_inertia_json_response, 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]
+    def format_inertia_json_response
       response.headers['Vary'] = if response.headers['Vary'].blank?
                                    'X-Inertia'
                                  else
@@ -25,5 +18,13 @@ module InertiaBuilder
                                  end
       response.set_header('X-Inertia', 'true')
     end
+
+    def action_has_layout?
+      !inertia_json_request? && super
+    end
+
+    def inertia_json_request?
+      request.headers['X-Inertia'] == 'true'
+    end
   end
 end

data/lib/inertia_builder/version.rb

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

data/lib/inertia_builder.rb

@@ -4,22 +4,81 @@ require 'jbuilder/jbuilder_template'
 require 'inertia_builder/handler'
 require 'inertia_builder/controller'
 require 'inertia_builder/renderer'
-require 'inertia_builder/railtie' if defined?(Rails)
+require 'inertia_builder/railtie'
+
+class JbuilderTemplate
+  self.template_lookup_options = { handlers: %i[inertia jbuilder] }
+end
 
 module InertiaBuilder
   class PropBuilder < JbuilderTemplate
     alias props attributes!
 
+    def optional!(&block)
+      _call_inertia_block(:optional, &block)
+    end
+
+    def always!(&block)
+      _call_inertia_block(:always, &block)
+    end
+
+    def defer!(**opts, &block)
+      _call_inertia_block(:defer, **opts, &block)
+    end
+
+    def method_missing(name, *args, &block)
+      prop = self
+
+      if @inertia_block
+        method, opts = @inertia_block
+        _set_value(name, ::InertiaRails.send(method, **opts) { prop.set!(name, *args, &block) })
+      elsif !@in_scope
+        # Lazy evaluate outermost properties.
+        _set_value(name, -> { prop.set!(name, *args, &block); })
+      else
+        super
+      end
+    end
+
     private
 
+    def _call_inertia_block(method, **opts)
+      ::Kernel.raise "Nesting #{method}! in a #{@inertia_block[0]}! block is not allowed" if @inertia_block
+
+      @inertia_block = [method, opts]
+      yield
+      @inertia_block = nil
+    end
+
+    def _render_partial_with_options(options)
+      options[:locals] ||= options.except(:partial, :as, :collection, :cached)
+      options[:locals][:prop] = self
+      super(options)
+    end
+
     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]
+      @context.render object, prop: self
+    end
+
+    def _scope
+      @in_scope = true
+      super
+    ensure
+      @in_scope = false
+    end
+
+    def _merge_values(current_value, updates)
+      # Always override lazy evaluation procs.
+      if current_value.is_a?(::Proc)
+        updates
+      else
+        super
+      end
     end
   end
 end

data/test/controller_test.rb

@@ -2,28 +2,39 @@
 
 require 'test_helper'
 require 'action_view/testing/resolvers'
-require 'rails/controller/testing'
 
 class TestController < ActionController::Base
   include InertiaBuilder::Controller
 
+  layout 'application'
+
   def index; end
+
+  def create
+    respond_to do |format|
+      format.html { render :create, status: :created }
+      format.json { render :create, status: :created }
+    end
+  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' }
+    @routes.draw do
+      get 'index' => 'test#index'
+      post 'create' => 'test#create'
+    end
 
     resolver = ActionView::FixtureResolver.new(
       'layouts/application.html.erb' => '<html><body><%= yield %></body></html>',
-      'test/index.html.inertia' => 'prop.content "content"'
+      'test/index.html.inertia' => 'prop.content "content"',
+      'test/create.html.inertia' => 'prop.content "This is Inertia content"',
+      'test/create.json.jbuilder' => 'json.content "This is JSON content"'
     )
 
     @controller.prepend_view_path(resolver)
@@ -35,10 +46,10 @@ class ControllerTest < ActionController::TestCase
   end
 
   def test_renders_index_html_inertia_for_a_standard_non_inertia_request
+    @request.headers['X-Inertia'] = nil
     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']
@@ -51,15 +62,31 @@ class ControllerTest < ActionController::TestCase
     get :index
 
     assert_response :success
-    assert_template 'test/index'
 
-    assert_equal 'application/json; charset=utf-8', response.content_type
+    # 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
 
+  def test_respects_respond_to_block
+    @request.headers['X-Inertia'] = 'true'
+    post :create
+
+    assert_response :created
+    assert_equal response.body, inertia_json_with_props(
+      { content: 'This is Inertia content' },
+      component: 'test/create',
+      url: '/create'
+    )
+
+    post :create, format: :json
+
+    assert_response :created
+    assert_equal response.body, { content: 'This is JSON content' }.to_json
+  end
+
   private
 
   def inertia_html_with_props(props)
@@ -69,14 +96,14 @@ class ControllerTest < ActionController::TestCase
     HTML
   end
 
-  def inertia_json_with_props(props)
+  def inertia_json_with_props(props, opts = {})
     {
-      component: 'test/index',
-      props:,
-      url: '/index',
+      component: opts.fetch(:component, 'test/index'),
+      props: { errors: {} }.merge(props),
+      url: opts.fetch(:url, '/index'),
       version: nil,
       encryptHistory: false,
-      clearHistory: false,
+      clearHistory: false
     }.to_json
   end
 end

data/test/inertia_builder_test.rb

@@ -1,9 +1,10 @@
 require 'test_helper'
 require 'action_view'
-require "active_model"
+require 'active_model'
 require 'action_view/testing/resolvers'
 
 class User < Struct.new(:id, :first_name, :last_name, :email)
+  extend ActiveModel::Naming
   include ActiveModel::Conversion
 end
 
@@ -16,7 +17,7 @@ class InertiaBuilderTest < Minitest::Test
   INERTIA
 
   PARTIALS = {
-    "users/_user.html.inertia" => USER_PARTIAL,
+    'users/_user.html.inertia' => USER_PARTIAL
   }
 
   def test_basic_html_rendering
@@ -46,8 +47,8 @@ class InertiaBuilderTest < Minitest::Test
       }
     }
 
-    assert_equal inertia_html_with_props(expected_props), render_view(template)
     assert_equal inertia_json_with_props(expected_props), render_view(template, json: true)
+    assert_equal inertia_html_with_props(expected_props), render_view(template)
   end
 
   def test_collection_prop
@@ -72,10 +73,11 @@ class InertiaBuilderTest < Minitest::Test
       end
     INERTIA
 
-    expected_props = { products: }
+    expected_props = { products: 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)
+    assert_equal inertia_json_with_props(expected_props),
+                 render_view(template, assigns: { products: products }, json: true)
+    assert_equal inertia_html_with_props(expected_props), render_view(template, assigns: { products: products })
   end
 
   def test_basic_partial_prop
@@ -87,16 +89,16 @@ class InertiaBuilderTest < Minitest::Test
       end
     INERTIA
 
-    expected_props = { user: }
+    expected_props = { user: 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)
+    assert_equal inertia_json_with_props(expected_props), render_view(template, assigns: { user: user }, json: true)
+    assert_equal inertia_html_with_props(expected_props), render_view(template, assigns: { user: user })
   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' }),
+      User.new({ id: 43, first_name: 'Jane', last_name: 'Smith', email: 'jane@email.com' })
     ]
 
     template = <<~INERTIA
@@ -105,10 +107,24 @@ class InertiaBuilderTest < Minitest::Test
       end
     INERTIA
 
-    expected_props = { users: }
+    expected_props = { users: users }
+
+    assert_equal inertia_html_with_props(expected_props), render_view(template, assigns: { users: users })
+    assert_equal inertia_json_with_props(expected_props), render_view(template, assigns: { users: users }, json: true)
+  end
+
+  def test_shorthand_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 = "prop.users @users, partial: 'users/user', as: :user"
 
-    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)
+    expected_props = { users: users }
+
+    assert_equal inertia_html_with_props(expected_props), render_view(template, assigns: { users: users })
+    assert_equal inertia_json_with_props(expected_props), render_view(template, assigns: { users: users }, json: true)
   end
 
   def test_nil_prop_block
@@ -118,18 +134,102 @@ class InertiaBuilderTest < Minitest::Test
       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
 
+  def test_optional_block
+    template = <<~INERTIA
+      prop.id 1
+      prop.optional! do
+        prop.user 'User'
+        prop.calculation 'Calculation'
+      end
+    INERTIA
+
+    partial_headers = {
+      'X-Inertia-Partial-Data' => 'user,calculation',
+      'X-Inertia-Partial-Component' => '/'
+    }
+    assert_equal inertia_json_with_props({ id: 1 }), render_view(template, json: true)
+    assert_equal inertia_json_with_props({ user: 'User', calculation: 'Calculation' }),
+                 render_view(template, json: true, headers: partial_headers)
+  end
+
+  def test_always_block
+    template = <<~INERTIA
+      prop.id 1
+      prop.always! do
+        prop.user 'User'
+      end
+      prop.optional! do
+        prop.calculation 'Calculation'
+      end
+    INERTIA
+
+    partial_headers = {
+      'X-Inertia-Partial-Data' => 'calculation',
+      'X-Inertia-Partial-Component' => '/'
+    }
+    assert_equal inertia_json_with_props({ id: 1, user: 'User' }), render_view(template, json: true)
+    assert_equal inertia_json_with_props({ user: 'User', calculation: 'Calculation' }),
+                 render_view(template, json: true, headers: partial_headers)
+  end
+
+  def test_defer_block
+    template = <<~INERTIA
+      prop.id 1
+      prop.defer! do
+        prop.user 'User'
+        prop.calculation 'Calculation'
+      end
+    INERTIA
+
+    assert_equal inertia_json_with_props({ id: 1 }, deferredProps: { default: %w[user calculation] }),
+                 render_view(template, json: true)
+  end
+
+  def test_defer_block_grouping
+    template = <<~INERTIA
+      prop.id 1
+      prop.defer! group: 'group1' do
+        prop.user 'User'
+      end
+      prop.defer! group: 'group2' do
+        prop.calculation 'Calculation'
+      end
+    INERTIA
+
+    assert_equal inertia_json_with_props({ id: 1 }, deferredProps: { group1: ['user'], group2: ['calculation'] }),
+                 render_view(template, json: true)
+  end
+
+  def test_defer_block_fetching
+    template = <<~INERTIA
+      prop.id 1
+      prop.defer! do
+        prop.user 'User'
+        prop.calculation 'Calculation'
+      end
+    INERTIA
+
+    partial_headers = {
+      'X-Inertia-Partial-Data' => 'user,calculation',
+      'X-Inertia-Partial-Component' => '/'
+    }
+
+    assert_equal inertia_json_with_props({ user: 'User', calculation: 'Calculation' }),
+                 render_view(template, json: true, headers: partial_headers)
+  end
+
   private
 
-  def render_view(source, assigns: {}, json: false)
+  def render_view(source, **opts)
     req = ActionDispatch::TestRequest.create
-    req.headers['X-Inertia'] = 'true' if json
+    req.headers.merge!(opts[:headers] || {})
+    req.headers['X-Inertia'] = 'true' if opts[:json]
 
     controller = ActionView::TestCase::TestController.new
     controller.request = req
@@ -137,7 +237,7 @@ class InertiaBuilderTest < Minitest::Test
     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 = ActionView::Base.with_empty_template_cache.new(lookup, opts[:assigns] || [], controller)
 
     view.render(template: 'source')
   end
@@ -148,14 +248,14 @@ class InertiaBuilderTest < Minitest::Test
     HTML
   end
 
-  def inertia_json_with_props(props)
+  def inertia_json_with_props(props, **extra_fields)
     {
       component: '/',
-      props:,
+      props: { errors: {} }.merge(props),
       url: '/',
       version: nil,
       encryptHistory: false,
-      clearHistory: false,
-    }.to_json
+      clearHistory: false
+    }.merge(extra_fields).to_json
   end
 end

data/test/test_helper.rb

@@ -16,5 +16,9 @@ Class.new(Rails::Application) do
   config.eager_load = false
 end.initialize!
 
+InertiaRails.configure do |c|
+  c.always_include_errors_hash = true # Fix deprecated warning in tests.
+end
+
 # Touch AV::Base in order to trigger :action_view on_load hook before running the tests
 ActionView::Base.inspect

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inertia_builder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rodrigo Lima
@@ -38,47 +38,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: appraisal
   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'
+        version: '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'
+        version: '0'
 email: rodrigotavio91@gmail.com
 executables: []
 extensions: []
@@ -98,8 +70,8 @@ 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
+  changelog_uri: https://github.com/rodrigotavio91/inertia-builder/releases/tag/v0.2.0
+  source_code_uri: https://github.com/rodrigotavio91/inertia-builder/tree/v0.2.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: