spec_views 3.4.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6be6b1290f526d5601ea7896dfd29bda9913888f4620b752504d6e2931ba6fa
-  data.tar.gz: 9d6c11ddb9c2ff9b0898f9c887a07823555732e714341680feb8dba4ecb9e020
+  metadata.gz: b4862f0d853b34af72a88330522aa151badd6e4b2379d7c48cbcd762f74bcfe9
+  data.tar.gz: bc86734dc64a77d10e3ea0d9ded7fb4ac6382b3a3b134b4cba0ccf8a4ca95d87
 SHA512:
-  metadata.gz: 3a120d0d9d5b5810dbc6978c191ca378118a8554eb9aaa0e391afc41605b7652292205545a74402a85ddecce82faf235aaa6195e5513bc24f3509710520928c9
-  data.tar.gz: ec0abff6c3d017ced148a464001bc58f9730314c8d4334122f22d29c42ec0fe61f09ea97fbb12f2fc38b2b9a543c4198f4f91167b9274c77da5aecafca6c690d
+  metadata.gz: 8680677d0d527f89f09e18dfdd71a1ae9d85b5e17341aa0823ce94a792b43d35e7b9bab21a6936f70ca0419485823fad817bb4e967fe04728d303458570430cd
+  data.tar.gz: 72a5abde93d36f10cac9b998b4271e93224062277848d9cadd6f3041402babcba56787abc234b64eb03817004ac3fb7189ac06b8fafb6d940d5a1f9b3177608c

data/README.md

@@ -79,6 +79,23 @@ RSpec.describe "Articles", type: :request do
 end
 ```
 
+### Add an affix
+If you have two requests with the same description, you can add an affix to the generated name:
+
+```ruby
+RSpec.describe "Articles", type: :request do
+  describe 'GET /articles' do
+    it 'renders the listing' do
+      get articles_path
+      expect(response).to match_html_fixture.with_affix('only 10')
+
+      get articles_path(all: '1')
+      expect(response).to match_html_fixture.with_affix('all')
+    end
+  end
+end
+```
+
 ### PDF matching
 If your request responds with a PDF you can compare it as well:
 

data/app/models/spec_views/base_matcher.rb

@@ -25,6 +25,9 @@ module SpecViews
       @failure_message = "#{subject_name} has changed."
       @failure_message = "#{subject_name} has been added." if champion_html.nil?
 
+      preview = diff_preview
+      @failure_message += preview if preview.present?
+
       directory.write_last_run(run_time)
       directory.write_meta(description, type, content_type)
       @directory.write_challenger(challenger_body)
@@ -56,6 +59,10 @@ module SpecViews
       raise NotImplementedError
     end
 
+    def diff_preview
+      nil
+    end
+
     def extractor_class
       return CapybaraSessionExtractor if type == :feature
       return MailMessageExtractor if type == :mailer

data/app/models/spec_views/html_matcher.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'diff/lcs'
+
 module SpecViews
   class HtmlMatcher < BaseMatcher
     delegate :champion_html, to: :directory
@@ -22,6 +24,40 @@ module SpecViews
       champion_html == challenger_body
     end
 
+    def diff_preview
+      return nil unless champion_html.present?
+
+      champion_lines = champion_html.lines
+      challenger_lines = challenger_body.lines
+
+      diffs = Diff::LCS.diff(champion_lines, challenger_lines)
+      return nil if diffs.empty?
+
+      first_change = diffs.first.first
+      line_number = first_change.position + 1
+
+      preview = "\nFirst difference at line #{line_number}:\n"
+
+      if first_change.action == '-'
+        old_line = first_change.element.chomp
+        addition = diffs.first.find { |change| change.action == '+' && change.position == first_change.position }
+
+        if addition
+          new_line = addition.element.chomp
+          truncated_old, truncated_new, marker_pos = truncate_diff_lines_with_marker(old_line, new_line)
+          preview += "  - #{truncated_old}\n"
+          preview += "  + #{truncated_new}\n"
+          preview += "    #{' ' * marker_pos}^\n" if marker_pos
+        else
+          preview += "  - #{truncate_line(old_line)}\n"
+        end
+      elsif first_change.action == '+'
+        preview += "  + #{truncate_line(first_change.element.chomp)}\n"
+      end
+
+      preview
+    end
+
     private
 
     def sanitized_body
@@ -37,5 +73,39 @@ module SpecViews
     def remove_pack_digests_from_body(body)
       body.gsub(%r{(packs.*/js/[a-z0-9_]+)(-[a-z0-9]{20})(\.js)}, '\1\3')
     end
+
+    def truncate_diff_lines_with_marker(old_line, new_line, max_common_prefix: 10, max_length: 100)
+      common_length = 0
+      [old_line.length, new_line.length].min.times do |i|
+        break if old_line[i] != new_line[i]
+
+        common_length = i + 1
+      end
+
+      prefix_offset = 0
+      prefix_marker = ''
+      if common_length > max_common_prefix
+        prefix_offset = common_length - max_common_prefix
+        prefix_marker = '...'
+      end
+
+      old_relevant = prefix_marker + old_line[prefix_offset..]
+      new_relevant = prefix_marker + new_line[prefix_offset..]
+
+      marker_pos = prefix_marker.length + (common_length - prefix_offset)
+
+      truncated_old = truncate_line(old_relevant, max_length)
+      truncated_new = truncate_line(new_relevant, max_length)
+
+      marker_pos = nil if marker_pos >= max_length
+
+      [truncated_old, truncated_new, marker_pos]
+    end
+
+    def truncate_line(line, max_length = 100)
+      return line if line.length <= max_length
+
+      "#{line[0...max_length]}..."
+    end
   end
 end

data/lib/spec_views/support.rb

@@ -55,10 +55,14 @@ matchers.each do |matcher|
     chain :for_status do |status|
       @status = status
     end
+    chain :with_affix do |affix|
+      @affix = affix
+    end
 
     match do |actual|
       example = @matcher_execution_context.instance_variable_get('@_spec_view_example')
       description = example.full_description
+      description = "#{description}-#{@affix}" if @affix.present?
       type = example.metadata[:type]
       run_time = $_spec_view_time # rubocop:disable Style/GlobalVars
       @status ||= :ok

data/lib/spec_views/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SpecViews
-  VERSION = '3.4.0'
+  VERSION = '3.6.0'
 end

data/lib/tasks/spec_views_tasks.rake

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :spec_views do
 #   # Task goes here

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spec_views
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Sebastian Gaul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-16 00:00:00.000000000 Z
+date: 2025-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs