Add custom ActionDispatch::Request inspection

Author: jas14

lib/super_diff/action_dispatch.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'super_diff/action_dispatch/inspection_tree_builders'
+
+module SuperDiff
+  module ActionDispatch
+    SuperDiff.configure do |config|
+      config.prepend_extra_inspection_tree_builder_classes(
+        InspectionTreeBuilders::Request
+      )
+    end
+  end
+end

lib/super_diff/action_dispatch/inspection_tree_builders.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module SuperDiff
+  module ActionDispatch
+    module InspectionTreeBuilders
+      autoload(
+        :Request,
+        'super_diff/action_dispatch/inspection_tree_builders/request'
+      )
+    end
+  end
+end

lib/super_diff/action_dispatch/inspection_tree_builders/request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SuperDiff
+  module ActionDispatch
+    module InspectionTreeBuilders
+      class Request < Core::AbstractInspectionTreeBuilder
+        def self.applies_to?(value)
+          value.is_a?(::ActionDispatch::Request)
+        end
+
+        def call
+          Core::InspectionTree.new do |t1|
+            t1.as_lines_when_rendering_to_lines do |t2|
+              t2.add_text object.inspect
+            end
+          end
+        end
+      end
+    end
+  end
+end

lib/super_diff/rails.rb

@@ -2,3 +2,4 @@
 
 require 'super_diff/active_support'
 require 'super_diff/active_record' if defined?(ActiveRecord)
+require 'super_diff/action_dispatch' if defined?(ActionDispatch)

spec/spec_helper.rb

@@ -25,6 +25,12 @@
   active_record_available = false
 end
 
+begin
+  require 'action_dispatch'
+rescue LoadError
+  # ActionDispatch isn't available (presumably because we're not testing it)
+end
+
 Dir
   .glob(File.expand_path('support/**/*.rb', __dir__))
   .reject { |file| file.include?('/models/active_record/') && !active_record_available }
@@ -52,6 +58,7 @@
   config.default_formatter = 'documentation' unless %w[true 1].include?(ENV.fetch('CI', nil))
 
   config.filter_run_excluding active_record: true unless active_record_available
+  config.filter_run_excluding action_dispatch: true unless defined?(ActionDispatch)
   config.filter_run_excluding active_support: true unless defined?(ActiveSupport)
   config.filter_run_excluding with_superdiff_rspec: false
 

spec/unit/action_dispatch/object_inspection_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SuperDiff, type: :unit do
+  describe '.inspect_object', 'for ActionDispatch objects', action_dispatch: true do
+    context 'given an ActionDispatch::Request' do
+      context 'given as_lines: false' do
+        it 'returns an inspected version of the object' do
+          string =
+            described_class.inspect_object(
+              ActionDispatch::Request.new(
+                {
+                  'REQUEST_METHOD' => 'PUT',
+                  'REMOTE_ADDR' => '10.0.0.1',
+                  Rack::RACK_URL_SCHEME => 'http',
+                  'HTTP_HOST' => 'host.local'
+                }
+              ),
+              as_lines: false
+            )
+          expect(string).to eq(
+            %(#<ActionDispatch::Request PUT "http://host.local" for 10.0.0.1>)
+          )
+        end
+      end
+
+      context 'given as_lines: true' do
+        it 'returns an inspected version of the object on one line' do
+          tiered_lines =
+            described_class.inspect_object(
+              ActionDispatch::Request.new(
+                {
+                  'REQUEST_METHOD' => 'PUT',
+                  'REMOTE_ADDR' => '10.0.0.1',
+                  Rack::RACK_URL_SCHEME => 'http',
+                  'HTTP_HOST' => 'host.local'
+                }
+              ),
+              as_lines: true,
+              type: :noop,
+              indentation_level: 1
+            )
+
+          expect(tiered_lines).to match(
+            [
+              an_object_having_attributes(
+                type: :noop,
+                indentation_level: 1,
+                value: '#<ActionDispatch::Request PUT "http://host.local" for 10.0.0.1>'
+              )
+            ]
+          )
+        end
+      end
+    end
+  end
+end