inertiax_rails 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15ef3b0b927cacf0828a1e26cfaf7df2cf2532a2919138875887890e92e38599
+  data.tar.gz: 5f0900f8a7fef40ea415011b92d3e7ff40874575c6c9b1432e9d80395a63c7f0
+SHA512:
+  metadata.gz: a37da9a54c63bd336a027345f9fb19d8ecedda372d620abaadd654657126421be712cf5494acb291bffb7935c92e5f8dc7672aee109ba0f51620e1f37658732a
+  data.tar.gz: 2a21636d441f491263f1bd8a742ab802bafa259cdb6eef48ed453c1a33d29b8740d42dcea2560cad769d2ca75d931202a1e4f4f9a3015bbf69cd9390c6936d02

data/.github/workflows/push.yml

@@ -0,0 +1,33 @@
+name: Testing
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.1', '3.2', '3.3']
+        rails: ['6.1', '7.0', '7.1']
+
+    runs-on: ubuntu-latest
+    name: Test against Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup System
+        run: sudo apt-get install libsqlite3-dev
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+        env:
+          RAILS_VERSION:  ${{ matrix.rails }}
+
+      - name: Run tests
+        run: bundle exec rake
+        env:
+          RAILS_VERSION: ${{ matrix.rails }}

data/.gitignore

@@ -0,0 +1,22 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+/spec/dummy/db/*.sqlite3
+/spec/dummy/db/*.sqlite3-journal
+/spec/dummy/db/log/*.log
+/spec/dummy/tmp/
+/spec/dummy/.sass-cache
+/spec/dummy/log/
+
+# rspec failure tracking
+.rspec_status
+
+# Appraisal
+gemfiles/*.gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require rails_helper

data/CHANGELOG.md

@@ -0,0 +1,173 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [3.2.0] - 2024-06-19
+
+* Refactor the internals of shared Inertia data to use controller instance variables instead of module level variables that run a higher risk of being leaked between requests. Big thanks to @ledermann for the initial work many years ago and to @PedroAugustoRamalhoDuarte for finishing it up!
+* Change the Inertia response to set the `Vary` header to `X-Inertia` instead of `Accept`, Thanks @osbre!
+* Always set the `XSRF-TOKEN` in an `after_action` request instead of only on non-Inertia requests. This fixes a bug where logging out (and resetting the session) via Inertia would create a CSRF token mismatch on a subsequent Inertia request (until you manually hard refreshed the page). Thanks @jordanhiltunen!
+
+## [3.1.4] - 2024-04-28
+
+* Reset Inertia shared data after each RSpec example where `inertia: true` is used. Thanks @coreyaus!
+* Update Github Actions workflows to use currently supported Ruby/Rails versions. Thanks @PedroAugustoRamalhoDuarte!
+
+## [3.1.3] - 2023-11-03
+
+* Depend on railties instead of rails so that applications which only use pieces of Rails can avoid a full Rails installation. Thanks @BenMorganMY!
+
+## [3.1.2] - 2023-09-26
+
+* Fix `have_exact_props` RSpec matcher in the situation where shared props are defined in a lambda that outputs a hash with symbolized keys
+
+## [3.1.1] - 2023-08-21
+
+* Fix broken partial reloads caused by comparing a list of symbolized keys with string keys from HashWithIndifferentAccess
+
+## [3.1.0] - 2023-08-21
+
+### Features
+
+* CSRF protection works without additional configuration now.
+* Optional deep merging of shared props.
+
+### Fixes
+
+* Document Inertia headers. @buhrmi
+* Documentation typo fix. @lujanfernaud
+* Changelog URI fix. @PedroAugustoRamalhoDuarte
+
+## [3.0.0] - 2022-09-22
+
+* Allow rails layout to set inertia layout. Thanks @ElMassimo!
+* Add the ability to set inertia props and components via rails conventions (see readme)
+
+## [2.0.1] - 2022-07-12
+
+* Fix for a middleware issue where global state could be polluted if an exception occurs in a request. Thanks @ElMassimo!
+
+## [2.0.0] - 2022-06-20
+
+* Fix an issue with Rails 7.0. Thanks @0xDing and @aviemet!
+* Drop support for Rails 5.0 (and mentally, though not literally drop support for Rails < 6)
+
+## [1.12.1] - 2022-05-09
+
+* Allow inertia to take over after initial pageload when using ssr. Thanks @99monkey!
+
+## [1.12.0] - 2022-05-04
+
+* SSR!
+
+## [1.11.1] - 2021-06-27
+
+* Fixed thread safety in the middleware. Thanks @caifara!
+
+## [1.11.0] - 2021-03-23
+
+* Fixed the install generator. `installable?` was always returning false, preventing it from actually running.
+* Added an install generator for Vue.
+
+## [1.10.0] - 2021-03-22
+
+* Added install generator to quickly add Inertia to existing rails apps via `rails inertia_rails:install:react`
+
+## [1.9.2] - 2021-02-23
+
+* Improve method for detecting whether a user used the RSpec helpers without adding `inertia: true` to the spec
+* Emit a warning when expecting an Inertia response in RSpec and never reaching a `render inertia:` call
+
+## [1.9.1] - 2021-02-10
+
+* Define `redirect_to` and `redirect_back` as public methods for compatibility with other code using them
+
+## [1.9.0] - 2021-01-17
+
+* Added the same inertia awareness that redirect_to has to redirect_back
+
+## [1.8.0] - 2020-12-08
+
+* Add `inertia` route helper feature
+
+## [1.7.1] - 2020-11-24
+
+* Fix the definition for InertiaRails::Lazy to avoid an uninitialized constant error when booting an application. 
+
+## [1.7.0] - 2020-11-24
+
+* Add support for "lazy" props while rendering. These are props that never compute on the initial page load. The only render during a partial update that calls for them explicitly.
+
+## [1.6.0] - 2020-11-20
+
+* Built in error sharing across redirects! adding `{ inertia: { errors: 'errors go here' } }` as an option in `redirect_to` will automatically feed an `errors` prop to whatever is rendered after the redirect.
+* Set content type to json for Inertia responses
+* Return the original response status with Inertia responses
+
+## [1.5.0] - 2020-10-07
+
+* Test against multiple Rails versions in Github Actions
+* Add the `inertia_location` controller method that forces a full page refresh
+
+## [1.4.1] - 2020-08-06
+
+* Fixed a bug involving threadsafe versions and layouts
+
+## [1.4.0] - 2020-07-09
+
+* Fixed Ruby 2.7 deprecation warnings
+* Added `inertia_partial?` method
+* Fixed homepage in the gemspec
+* Make the InertiaRails module data threadsafe
+
+## [1.3.1] - 2020-02-20
+
+* Fix a typo in the README (inertia only has 1 t!)
+
+## [1.3.0] - 2020-01-28
+
+### Added
+
+* Added request.inertia? method
+
+## [1.2.2] - 2020-01-21
+
+### Fixed
+
+* Added patches to allow Rails errors to show properly in the inertia modal
+* Fixed a middleware issue caused by a breaking change in Rack v2.1.*
+
+## [1.2.1] - 2019-12-6
+
+### Fixed
+
+* Change page url to use path instead of url
+* Moved Inertia Share logic to a before_action to ensure it runs on every request
+
+## [1.2.0] - 2019-11-1
+
+### Added
+
+* Added rspec helpers
+
+### Fixed
+
+* Make sure that `inertia_share` properties are reset before each request
+
+## [1.1.0] - 2019-10-24
+
+### Changed
+
+* Switches mattr_accessor defaults to block syntax to allow pre Rails 5.2 compatibility
+
+## [1.0.1] - 2019-10-23
+
+### Fixed
+
+* Allow `Intertia.share` within a controller to access controller methods
+
+## [1.0.0] - 2019-10-09
+
+* Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in inertia-rails.gemspec
+gemspec
+
+version = ENV["RAILS_VERSION"] || "7.1"
+gem "rails", "~> #{version}.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Bellawatt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,273 @@
+![image](https://user-images.githubusercontent.com/6599653/114456558-032e2200-9bab-11eb-88bc-a19897f417ba.png)
+
+
+# Inertia X Rails Adapter
+
+This is a fork of the original [Inertia Rails](https://github.com/inertiajs/inertia-rails) adapter. It is designed to be compatible with buhrmi's [Inertia X](https://github.com/buhrmi/inertia) branch.
+
+## Installation
+
+### Backend
+
+Just add the inertia rails gem to your Gemfile
+```ruby
+gem 'inertiax_rails'
+```
+
+### Frontend
+
+Rails 7 specific frontend docs coming soon. For now, check out the official Inertia docs at https://inertiajs.com/ or see an example using React/Vite [here](https://github.com/BrandonShar/inertia-rails-template)
+
+## Usage
+
+### Responses
+
+Render Inertia responses is simple, just use the inertia renderer in your controller methods. The renderer accepts two arguments, the first is the name of the component you want to render from within your pages directory (without extension). The second argument is an options hash where you can provide `props` to your components. This options hash also allows you to pass `view_data` to your layout, but this is much less common.
+
+```ruby
+def index
+  render inertia: 'Event/Index', props: {
+    events: Event.all,
+  }
+end
+```
+
+#### Rails Component and Instance Props 
+
+Starting in version 3.0, Inertia Rails allows you to provide your component name and props via common rails conventions. 
+
+```ruby
+class EventsController < ApplicationController
+  use_inertia_instance_props
+
+  def index
+    @events = Event.all
+  end
+
+end
+```
+
+is the same as 
+
+
+```ruby
+class EventsController < ApplicationController
+  def index
+    render inertia: 'events/index', props: {
+      events: Event.all
+    }
+  end
+end
+```
+
+#### Instance Props and Default Render Notes 
+
+In order to use instance props, you must call `use_inertia_instance_props` on the controller (or a base controller it inherits from). If any props are provided manually, instance props
+are automatically disabled for that response. Instance props are only included if they are defined after the before filter is set from `use_inertia_instance_props`.
+
+Automatic component name is also opt in, you must set the `default_render` config value to `true`. Otherwise, you can simply `render inertia: true` for the same behavior explicitly. 
+
+### Layout 
+
+Inertia layouts use the rails layout convention and can be set or changed in the same way. The original `layout` config option is still functional, but will likely be deprecated in the future in favor
+of using rails layouts.
+
+```ruby
+class EventsController < ApplicationController
+  layout 'inertia_application'
+end
+```
+
+
+### Shared Data
+
+If you have data that you want to be provided as a prop to every component (a common use-case is information about the authenticated user) you can use the `shared_data` controller method.
+
+```ruby
+class EventsController < ApplicationController
+  # share syncronously
+  inertia_share app_name: env['app.name']
+  
+  # share lazily, evaluated at render time
+  inertia_share do
+    if logged_in?
+      {
+        user: logged_in_user,
+      }
+    end
+  end
+  
+  # share lazily alternate syntax
+  inertia_share user_count: lambda { User.count }
+  
+end
+```
+
+#### Deep Merging Shared Data
+
+By default, Inertia will shallow merge data defined in an action with the shared data. You might want a deep merge. Imagine using shared data to represent defaults you'll override sometimes.
+
+```ruby
+class ApplicationController
+  inertia_share do
+    { basketball_data: { points: 50, rebounds: 100 } }
+  end
+end
+```
+
+Let's say we want a particular action to change only part of that data structure. The renderer accepts a `deep_merge` option:
+
+```ruby
+class CrazyScorersController < ApplicationController
+  def index
+    render inertia: 'CrazyScorersComponent',
+    props: { basketball_data: { points: 100 } },
+    deep_merge: true
+  end
+end
+
+# The renderer will send this to the frontend:
+{
+  basketball_data: {
+    points: 100,
+    rebounds: 100,
+  }
+}
+```
+
+Deep merging can be set as the project wide default via the InertiaRails configuration:
+
+```ruby
+# config/initializers/some_initializer.rb
+InertiaRails.configure do |config|
+  config.deep_merge_shared_data = true
+end
+
+```
+
+If deep merging is enabled by default, it's possible to opt out within the action:
+
+```ruby
+class CrazyScorersController < ApplicationController
+  inertia_share do
+    {
+      basketball_data: {
+        points: 50,
+        rebounds: 10,
+      }
+    }
+  end
+
+  def index
+    render inertia: 'CrazyScorersComponent',
+    props: { basketball_data: { points: 100 } },
+    deep_merge: false
+  end
+end
+
+# Even if deep merging is set by default, since the renderer has `deep_merge: false`, it will send a shallow merge to the frontend:
+{
+  basketball_data: {
+    points: 100,
+  }
+}
+```
+
+### Lazy Props
+
+On the front end, Inertia supports the concept of "partial reloads" where only the props requested are returned by the server. Sometimes, you may want to use this flow to avoid processing a particularly slow prop on the intial load. In this case, you can use Lazy props. Lazy props aren't evaluated unless they're specifically requested by name in a partial reload.
+
+```ruby
+  inertia_share some_data: InertiaRails.lazy(lambda { some_very_slow_method })
+```
+
+### Routing
+
+If you don't need a controller to handle a static component, you can route directly to a component with the inertia route helper
+
+```ruby
+inertia 'about' => 'AboutComponent'
+```
+
+### SSR
+
+Enable SSR via the config settings for `ssr_enabled` and `ssr_url`.
+
+When using SSR, don't forget to add `<%= inertia_headers %>` to the `<head>` of your `application.html.erb`.
+
+## Configuration
+
+Inertia Rails has a few different configuration options that can be set anywhere, but the most common location is from within an initializer.
+
+The default config is shown below
+```ruby
+InertiaRails.configure do |config|
+  
+  # set the current version for automatic asset refreshing. A string value should be used if any.
+  config.version = nil
+  # enable default inertia rendering (warning! this will override rails default rendering behavior)
+  config.default_render = true
+  
+  # ssr specific options
+  config.ssr_enabled = false
+  config.ssr_url = 'http://localhost:13714'
+
+  config.deep_merge_shared_data = false
+  
+end
+```
+
+## Testing
+
+If you're using Rspec, Inertia Rails comes with some nice test helpers to make things simple. 
+
+To use these helpers, just add the following require statement to your `spec/rails_helper.rb`
+
+```ruby
+require 'inertia_rails/rspec'
+```
+
+And in any test you want to use the inertia helpers, add the inertia flag to the describe block
+
+```ruby
+RSpec.describe EventController, type: :request do
+  describe '#index', inertia: true do
+    # ...
+  end
+end
+```
+
+### Assertions
+
+```ruby
+RSpec.describe EventController, type: :request do
+  describe '#index', inertia: true do
+    
+    # check the component
+    expect_inertia.to render_component 'Event/Index'
+    
+    # access the component name
+    expect(inertia.component).to eq 'TestComponent'
+    
+    # props (including shared props)
+    expect_inertia.to have_exact_props({name: 'Brandon', sport: 'hockey'})
+    expect_inertia.to include_props({sport: 'hockey'})
+    
+    # access props
+    expect(inertia.props[:name]).to eq 'Brandon'
+    
+    # view data
+    expect_inertia.to have_exact_view_data({name: 'Brian', sport: 'basketball'})
+    expect_inertia.to include_view_data({sport: 'basketball'})
+    
+    # access view data 
+    expect(inertia.view_data[:name]).to eq 'Brian'
+    
+  end
+end
+
+```
+
+*Maintained and sponsored by the team at [bellaWatt](https://bellawatt.com/)*
+
+[![bellaWatt Logo](https://user-images.githubusercontent.com/6599653/114456832-5607d980-9bab-11eb-99c8-ab39867c384e.png)](https://bellawatt.com/)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/inertia_rails/static_controller.rb

@@ -0,0 +1,7 @@
+module InertiaRails
+  class StaticController < ::ApplicationController
+    def static
+      render inertia: params[:component]
+    end
+  end
+end

data/app/views/inertia.html.erb

@@ -0,0 +1 @@
+<div id="app" data-page="<%= page.to_json %>"></div>

data/app/views/inertia_ssr.html.erb

@@ -0,0 +1 @@
+<div id="app" data-server-rendered="true" data-page="<%= page.to_json %>"><%= html %></div>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "inertia_rails/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here