Module: InertiaRails

Defined in:
lib/inertia_rails/extensions/better_errors.rb,
lib/inertia_rails.rb,
lib/inertia_rails/ssr.rb,
lib/inertia_rails/rspec.rb,
lib/inertia_rails/engine.rb,
lib/inertia_rails/errors.rb,
lib/inertia_rails/helper.rb,
lib/inertia_rails/current.rb,
lib/inertia_rails/testing.rb,
lib/inertia_rails/version.rb,
lib/inertia_rails/meta_tag.rb,
lib/inertia_rails/minitest.rb,
lib/inertia_rails/raw_json.rb,
lib/inertia_rails/renderer.rb,
lib/inertia_rails/base_prop.rb,
lib/inertia_rails/lazy_prop.rb,
lib/inertia_rails/once_prop.rb,
lib/inertia_rails/controller.rb,
lib/inertia_rails/defer_prop.rb,
lib/inertia_rails/merge_prop.rb,
lib/inertia_rails/middleware.rb,
lib/inertia_rails/always_prop.rb,
lib/inertia_rails/cached_prop.rb,
lib/inertia_rails/scroll_prop.rb,
lib/inertia_rails/precognition.rb,
lib/inertia_rails/ssr_renderer.rb,
lib/inertia_rails/configuration.rb,
lib/inertia_rails/optional_prop.rb,
lib/inertia_rails/prop_onceable.rb,
lib/inertia_rails/prop_cacheable.rb,
lib/inertia_rails/prop_evaluator.rb,
lib/inertia_rails/prop_mergeable.rb,
lib/inertia_rails/props_resolver.rb,
lib/inertia_rails/flash_extension.rb,
lib/inertia_rails/scroll_metadata.rb,
lib/inertia_rails/meta_tag_builder.rb,
lib/inertia_rails/rspec/deprecated.rb,
lib/inertia_rails/extensions/mapper.rb,
lib/inertia_rails/generators/helper.rb,
lib/inertia_rails/extensions/request.rb,
lib/inertia_rails/ignore_on_first_load_prop.rb,
lib/inertia_rails/xsrf_cookie_refresh_policy.rb,
lib/inertia_rails/extensions/debug_exceptions.rb,
app/controllers/inertia_rails/static_controller.rb,
lib/inertia_rails/generators/scaffold_template_base.rb,
lib/inertia_rails/generators/controller_template_base.rb

Overview

Patch ActionDispatch::DebugExceptions to render HTML for Inertia requests

The original source needs to be patched, so that Inertia requests are NOT responded with plain text, but with HTML.

Original source: https://github.com/rails/rails/blob/8-0-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb https://github.com/rails/rails/blob/main/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb

Defined Under Namespace

Modules: Controller, FlashExtension, Generators, Helper, InertiaBetterErrors, InertiaDebugExceptions, InertiaMapper, InertiaRequest, Minitest, Precognition, PropCacheable, PropMergeable, PropOnceable, RSpec, SSR, ScrollMetadata, Testing Classes: AlwaysProp, BaseProp, CachedProp, Configuration, Current, DeferProp, DoublePrecognitionError, Engine, Error, IgnoreOnFirstLoadProp, LazyProp, MergeProp, MetaTag, MetaTagBuilder, Middleware, OnceProp, OptionalProp, PrecognitionResponse, PropEvaluator, PropsResolver, RawJson, Renderer, SSRError, SSRRenderer, ScrollProp, StaticController, XsrfCookieRefreshPolicy

Constant Summary collapse

VERSION = 
'3.22.0'

Class Method Summary collapse

Class Method Details

.always(&block) ⇒ Object 



77
78
79
 
# File 'lib/inertia_rails.rb', line 77

def always(&block)
  AlwaysProp.new(&block)
end

.cache ⇒ Object 



93
94
95
 
# File 'lib/inertia_rails.rb', line 93

def cache(...)
  CachedProp.new(...)
end

.cache_store ⇒ Object 



61
62
63
 
# File 'lib/inertia_rails.rb', line 61

def cache_store
  configuration.cache_store
end

.configuration ⇒ Object 



57
58
59
 
# File 'lib/inertia_rails.rb', line 57

def configuration
  @configuration ||= Configuration.default
end

.configure {|configuration| ... } ⇒ Object

Yields:



53
54
55
 
# File 'lib/inertia_rails.rb', line 53

def configure
  yield(configuration)
end

.deep_merge(match_on: nil, &block) ⇒ Object 



89
90
91
 
# File 'lib/inertia_rails.rb', line 89

def deep_merge(match_on: nil, &block)
  MergeProp.new(deep_merge: true, match_on: match_on, &block)
end

.defer ⇒ Object 



97
98
99
 
# File 'lib/inertia_rails.rb', line 97

def defer(...)
  DeferProp.new(...)
end

.deprecator ⇒ Object

:nodoc:



65
66
67
 
# File 'lib/inertia_rails.rb', line 65

def deprecator # :nodoc:
  @deprecator ||= ActiveSupport::Deprecation.new
end

.lazy(value = nil, &block) ⇒ Object 



69
70
71
 
# File 'lib/inertia_rails.rb', line 69

def lazy(value = nil, &block)
  LazyProp.new(value, &block)
end

.merge ⇒ Object 



85
86
87
 
# File 'lib/inertia_rails.rb', line 85

def merge(...)
  MergeProp.new(...)
end

.once ⇒ Object 



81
82
83
 
# File 'lib/inertia_rails.rb', line 81

def once(...)
  OnceProp.new(...)
end

.optional ⇒ Object 



73
74
75
 
# File 'lib/inertia_rails.rb', line 73

def optional(...)
  OptionalProp.new(...)
end

.precognition!(model_or_errors) ⇒ Object

Raises:



59
60
61
62
63
64
 
# File 'lib/inertia_rails/precognition.rb', line 59

def self.precognition!(model_or_errors)
  errors = Precognition.validate(model_or_errors)
  return false if errors.nil?

  raise PrecognitionResponse, errors, []
end

.scroll(metadata = nil, **options, &block) ⇒ Object 



101
102
103
 
# File 'lib/inertia_rails.rb', line 101

def scroll(metadata = nil, **options, &block)
  ScrollProp.new(metadata: metadata, **options, &block)
end