Merge pull request #139 from inertiajs/add-specs-from-config-refactor

Add specs from config refactor

Author: bknoles

inertia_rails.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name          = "inertia_rails"
   spec.version       = InertiaRails::VERSION
   spec.authors       = ["Brian Knoles", "Brandon Shar", "Eugene Granovsky"]
-  spec.email         = ["brain@bellawatt.com", "[email protected]", "[email protected]"]
+  spec.email         = ["brian@bellawatt.com", "[email protected]", "[email protected]"]
 
   spec.summary       = %q{Inertia adapter for Rails}
   spec.homepage      = "https://github.com/inertiajs/inertia-rails"

spec/dummy/app/controllers/inertia_conditional_sharing_controller.rb

@@ -1,4 +1,6 @@
 class InertiaConditionalSharingController < ApplicationController
+  before_action :conditionally_share_a_prop, only: :show_with_a_problem
+
   inertia_share normal_shared_prop: 1
 
   inertia_share do
@@ -16,4 +18,16 @@ def show
       show_only_prop: 1,
     }
   end
+
+  def show_with_a_problem
+    render inertia: 'EmptyTestComponent', props: {
+      show_only_prop: 1,
+    }
+  end
+
+  protected
+
+  def conditionally_share_a_prop
+    self.class.inertia_share incorrectly_conditionally_shared_prop: 1
+  end
 end

spec/dummy/app/controllers/inertia_share_test_controller.rb

@@ -1,6 +1,7 @@
 class InertiaShareTestController < ApplicationController
   inertia_share name: 'Brandon'
   inertia_share sport: -> { 'hockey' }
+  inertia_share({a_hash: 'also works'})
   inertia_share do
     {
       position: 'center',

spec/dummy/config/environments/test.rb

@@ -29,7 +29,7 @@
   config.cache_store = :null_store
 
   # Raise exceptions instead of rendering exception templates.
-  config.action_dispatch.show_exceptions = :none
+  config.action_dispatch.show_exceptions = false
 
   # Disable request forgery protection in test environment.
   config.action_controller.allow_forgery_protection = false

spec/dummy/config/routes.rb

@@ -52,4 +52,5 @@
 
   get 'conditional_share_index' => 'inertia_conditional_sharing#index'
   get 'conditional_share_show' => 'inertia_conditional_sharing#show'
+  get 'conditional_share_show_with_a_problem' => 'inertia_conditional_sharing#show_with_a_problem'
 end

spec/inertia/conditional_sharing_spec.rb

@@ -1,28 +1,30 @@
+# Specs as documentation. Per-action shared data isn't explicity supported,
+# but it can be done by referencing the action name in an inertia_share block.
 RSpec.describe "conditionally shared data in a controller", type: :request do
-  context "when there is conditional data inside inertia_share" do
-    it "does not leak data between requests" do
-      get conditional_share_index_path, headers: {'X-Inertia' => true}
-      expect(JSON.parse(response.body)['props'].deep_symbolize_keys).to eq({
-                                                                             index_only_prop: 1,
-                                                                             normal_shared_prop: 1,
-                                                                           })
-
-      # NOTE: we actually have to run the show action twice since the new implementation
-      # sets up a before_action within a before_action to share the data.
-      # In effect, that means that the shared data isn't rendered until the second time the action is run.
-      get conditional_share_show_path, headers: {'X-Inertia' => true}
+  context "when there is data inside inertia_share only applicable to a single action" do
+    it "does not leak the data between requests" do
       get conditional_share_show_path, headers: {'X-Inertia' => true}
       expect(JSON.parse(response.body)['props'].deep_symbolize_keys).to eq({
-                                                                             normal_shared_prop: 1,
-                                                                             show_only_prop: 1,
-                                                                             conditionally_shared_show_prop: 1,
-                                                                           })
+        normal_shared_prop: 1,
+        show_only_prop: 1,
+        conditionally_shared_show_prop: 1,
+      })
 
       get conditional_share_index_path, headers: {'X-Inertia' => true}
-      expect(JSON.parse(response.body)['props'].deep_symbolize_keys).to eq({
-                                                                             index_only_prop: 1,
-                                                                             normal_shared_prop: 1,
-                                                                           })
+      expect(JSON.parse(response.body)['props'].deep_symbolize_keys).not_to include({
+        conditionally_shared_show_prop: 1,
+      })
+    end
+  end
+
+  context "when there is conditional data shared via before_action" do
+    it "raises an error because it is frozen" do
+      # InertiaSharedData isn't frozen until after the first time it's accessed.
+      InertiaConditionalSharingController.send(:_inertia_shared_data)
+
+      expect {
+        get conditional_share_show_with_a_problem_path, headers: {'X-Inertia' => true}
+      }.to raise_error(FrozenError)
     end
   end
 end

spec/inertia/request_spec.rb

@@ -154,4 +154,12 @@
       end
     end
   end
+
+  describe 'a non existent route' do
+    it 'raises a 404 exception' do
+      expect {
+        get '/non_existent_route', headers: { 'X-Inertia' => true }
+      }.to raise_error(ActionController::RoutingError,  /No route matches/)
+    end
+  end
 end

spec/inertia/sharing_spec.rb

@@ -2,7 +2,7 @@
   subject { JSON.parse(response.body)['props'].deep_symbolize_keys }
 
   context 'using inertia share' do
-    let(:props) { {name: 'Brandon', sport: 'hockey', position: 'center', number: 29} }
+    let(:props) { {name: 'Brandon', sport: 'hockey', position: 'center', number: 29, a_hash: 'also works'} }
     before { get share_path, headers: {'X-Inertia' => true} }
 
     it { is_expected.to eq props }
@@ -18,7 +18,7 @@
   end
 
   context 'using inertia share in subsequent requests' do
-    let(:props) { {name: 'Brandon', sport: 'hockey', position: 'center', number: 29} }
+    let(:props) { {name: 'Brandon', sport: 'hockey', position: 'center', number: 29, a_hash: 'also works'} }
 
     before do
       get share_path, headers: {'X-Inertia' => true}
@@ -29,7 +29,7 @@
   end
 
   context 'using inertia share with inheritance' do
-    let(:props) { {name: 'No Longer Brandon', sport: 'hockey', position: 'center', number: 29} }
+    let(:props) { {name: 'No Longer Brandon', sport: 'hockey', position: 'center', number: 29, a_hash: 'also works'} }
 
     before do
       get share_with_inherited_path, headers: {'X-Inertia' => true}
@@ -39,7 +39,7 @@
   end
 
   context 'with errors' do
-    let(:props) { {name: 'Brandon', sport: 'hockey', position: 'center', number: 29} }
+    let(:props) { {name: 'Brandon', sport: 'hockey', position: 'center', number: 29, a_hash: 'also works'} }
     let(:errors) { 'rearview mirror is present' }
     before {
       allow_any_instance_of(ActionDispatch::Request).to receive(:session) {