spec_views 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3184a08acda31e87ed515d6f32819e70183e5ae887f430e3d21b8e84828a66fe
-  data.tar.gz: 7a852a0f05d557cef81590cea27faf5db52a4c82726a384823985b4a3ebf2cb2
+  metadata.gz: 42a03f1d324852c51d56e4afdadadcc00e6449954917f396599df6c4568176d0
+  data.tar.gz: 466b8bddc2f1c78bed3bbe57370b26bc87f71ecf38e2476ccc46fa4237a5410a
 SHA512:
-  metadata.gz: 19c5aeeef63e2db2b68073076fca8217631241a1aa65e45f94ebacf45d141135e93f9f001c882aff5b9f2b2e62aeaa0bcf3afd38a890682256b1dfad8e53daec
-  data.tar.gz: 1bb5e90a3fe9fad27653d439bc6b91d140f18c0be9500125f8a2bda0573fb7f68aca301c0fef0f545a6bf6fa9e5e4f5698c91fcbd02c0ce3a4b89c86bf782f25
+  metadata.gz: 48a9730de38ccc7927d852015fcb7c051e783a8a603cb665df17095a45799e882a1cc276d09b31177a2bc7ee93c8c86a455e5d0f24314e80ad19b77adcb36860
+  data.tar.gz: a837bcd14d1e95707830291dbd621c41bef508c3fc858854bc22c6142aee2170b24d29f991c055b457da173db0b6a94e0920aaeef87cca13b5d4f13724393238

data/README.md

@@ -40,6 +40,18 @@ end
 
 Run this spec to see it failing. Open SpecView UI [http://localhost:3000/spec_views](http://localhost:3000/spec_views) on Rails development server to accept the new view. When rerunning the spec it compares its rendering with the reference view. Use SpecView UI to review, accept or reject changed views.
 
+### view_sanitizer
+Sometimes it is hard to remove dynamic elements like IDs and times. Use `view_sanitizer.gsub` to replace dynamic strings with fixed ones before comparing and saving the views automatically:
+
+```ruby
+before do
+  view_sanitizer.gsub(%r{(users/)[0-9]+}, '\1ID')
+  view_sanitizer.gsub(/value="[0-9]+"/, 'value="ID"')
+end
+```
+
+`view_sanitizer.gsub` supports the same arguments as `String#gsub` including blocks.
+
 ### it_renders
 You can also use the shortcut to skip the matcher and the word "renders" from your description:
 
@@ -85,7 +97,7 @@ end
 Compare HTML mailers. `match_html_fixture` tries to find the HTML part of your mail automatically:
 
 ```ruby
-RSpec.describe NotificationsMailer, :type => :mailer do
+RSpec.describe NotificationsMailer, type: :mailer do
   describe '#notify' do
     let(:mail) { NotificationsMailer.signup }
 
@@ -96,6 +108,17 @@ RSpec.describe NotificationsMailer, :type => :mailer do
 end
 ```
 
+### Feature specs
+Compare pages from feature specs:
+
+```ruby
+RSpec.describe 'Articles', type: :feature do
+  it 'are shown as list' do
+    expect(page).to match_html_fixture
+  end
+end
+```
+
 ### Controller specs
 Prefer request specs over controller specs. If you still want to use controller specs enable the `render_views` feature:
 

data/app/controllers/spec_views/views_controller.rb

@@ -19,16 +19,16 @@ module SpecViews
     end
 
     def show
-      view = filename('view')
-      view = filename('challenger') if params[:view] == 'challenger'
-      if pdf?
+      path = directory.champion_path
+      path = directory.challenger_path if params[:view] == 'challenger'
+      if directory.content_type.pdf?
         send_data(
-          get_view(view),
+          get_view(path),
           filename: 'a.pdf',
           type: 'application/pdf', disposition: 'inline'
         )
       else
-        render html: get_view(view)
+        render html: get_view(path)
       end
     end
 
@@ -37,12 +37,12 @@ module SpecViews
     end
 
     def diff
-      if pdf?
+      if directory.content_type.pdf?
         redirect_to action: :compare
         return
       end
-      @champion = get_view(filename('view'), html_safe: false)
-      @challenger = get_view(filename('challenger'), html_safe: false)
+      @champion = get_view(directory.champion_path, html_safe: false)
+      @challenger = get_view(directory.challenger_path, html_safe: false)
       @directory = directory
     end
 
@@ -54,7 +54,7 @@ module SpecViews
     end
 
     def accept
-      accept_directory(params[:id])
+      accept_directory(directory)
       redirect_to action: :index, challenger: :next
     end
 
@@ -66,8 +66,7 @@ module SpecViews
     end
 
     def reject
-      challenger = file_path(filename('challenger'))
-      FileUtils.remove_file(challenger)
+      FileUtils.remove_file(directory.challenger_path)
       redirect_to action: :index, challenger: :next
     end
 
@@ -85,7 +84,15 @@ module SpecViews
     def directories
       @directories ||= Pathname.new(directory_path).children.select(&:directory?).map do |path|
         SpecViews::Directory.new(path)
-      end.sort_by(&:basename)
+      end
+      latest_run = @directories.map(&:last_run).max
+
+      @directories.sort_by! do |dir|
+        prefix = '3-'
+        prefix = '2-' if dir.last_run < latest_run
+        prefix = '1-' if dir.challenger?
+        "#{prefix}#{dir.basename}"
+      end
     end
 
     def directory_path
@@ -96,34 +103,17 @@ module SpecViews
       directories.detect { |dir| dir.to_param == params[:id] }
     end
 
-    def get_view(filename = nil, html_safe: true)
-      filename ||= pdf? ? 'view.pdf' : 'view.html'
-      content = File.read(file_path(filename))
+    def get_view(path, html_safe: true)
+      content = File.read(path)
       content = content.html_safe if html_safe
       content
     rescue Errno::ENOENT
       ''
     end
 
-    def file_path(filename, id: nil)
-      id ||= params[:id]
-      id = id.to_param if id.respond_to?(:to_param)
-      directory_path.join(id, filename)
-    end
-
-    def filename(base = 'view')
-      pdf? ? "#{base}.pdf" : "#{base}.html"
-    end
-
-    def pdf?
-      params[:id]&.end_with?('__pdf')
-    end
-
-    def accept_directory(id)
-      champion = file_path(filename('view'), id: id)
-      challenger = file_path(filename('challenger'), id: id)
-      FileUtils.copy_file(challenger, champion)
-      FileUtils.remove_file(challenger)
+    def accept_directory(dir)
+      FileUtils.copy_file(dir.challenger_path, dir.champion_path)
+      FileUtils.remove_file(dir.challenger_path)
     end
   end
 end

data/app/models/spec_views/base_matcher.rb

@@ -2,30 +2,30 @@
 
 module SpecViews
   class BaseMatcher
-    attr_reader :response, :directory, :failure_message, :type
+    attr_reader :response, :directory, :failure_message, :sanitizer, :type
 
     delegate :champion_html, to: :directory
 
-    def initialize(response, description, run_time:, expected_status: :ok, type: :request)
+    def initialize(response, description, run_time:, expected_status: :ok, sanitizer: nil, type: :request)
       @response = response
       @type = type
+      @sanitizer = sanitizer
       @extractor = extractor_class.new(response, expected_status: expected_status)
       @directory = SpecViews::Directory.for_description(description, content_type: content_type)
       @extractor_failure = @extractor.extractor_failure?
       @match = !extractor_failure? && match_challenger
-      @directory.write_last_run(run_time) if champion_html
+      directory.write_meta(description, run_time, type, content_type) if champion_html
       return if match?
 
       if extractor_failure?
-        @failure_message = @extractor.failure_message 
+        @failure_message = @extractor.failure_message
         return
       end
 
       @failure_message = "#{subject_name} has changed."
       @failure_message = "#{subject_name} has been added." if champion_html.nil?
 
-      @directory.write_last_run(run_time)
-      @directory.write_description(description)
+      directory.write_meta(description, run_time, type, content_type)
       @directory.write_challenger(challenger_body)
     end
 
@@ -56,6 +56,7 @@ module SpecViews
     end
 
     def extractor_class
+      return CapybaraSessionExtractor if type == :feature
       return MailMessageExtractor if type == :mailer
 
       HttpResponseExtractor

data/app/models/spec_views/capybara_session_extractor.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SpecViews
+  class CapybaraSessionExtractor
+    attr_reader :page, :failure_message
+
+    def initialize(page, expected_status:)
+      @page = page
+      @status_match = response_status_match?(page, expected_status)
+      return if @status_match
+
+      @failure_message = "Unexpected response status #{page.status_code}."
+    end
+
+    def extractor_failure?
+      failure_message.present?
+    end
+
+    def body
+      page.source
+    end
+
+    private
+
+    def response_status_match?(page, expected_status)
+      page.status_code == expected_status ||
+        Rack::Utils::SYMBOL_TO_STATUS_CODE.invert[page.status_code] == expected_status.to_sym
+    end
+  end
+end

data/app/models/spec_views/directory.rb

@@ -6,12 +6,12 @@ module SpecViews
 
     def self.for_description(description, content_type: :html)
       dir_name = description.strip.gsub(/[^0-9A-Za-z.\-]/, '_').gsub('__', '_')
-      dir_name = "#{dir_name}__pdf" if content_type == :pdf
-      new(Rails.root.join(Rails.configuration.spec_views.directory, dir_name))
+      new(Rails.root.join(Rails.configuration.spec_views.directory, dir_name), content_type)
     end
 
-    def initialize(path)
+    def initialize(path, content_type = nil)
       @path = path
+      @content_type = ActiveSupport::StringInquirer.new(content_type.to_s) if content_type
     end
 
     def basename
@@ -26,10 +26,6 @@ module SpecViews
       basename
     end
 
-    def challenger?
-      File.file?(path.join('challenger.html')) || File.file?(path.join('challenger.pdf'))
-    end
-
     def controller_name
       splitted_description.first.gsub(/Controller(_.*)$/, 'Controller').gsub(/Controller$/, '').gsub('_', '::')
     end
@@ -39,15 +35,7 @@ module SpecViews
     end
 
     def description_tail
-      splitted_description.third.gsub(/__pdf$/, '')
-    end
-
-    def last_run
-      @last_run ||= begin
-        Time.zone.parse(File.read(path.join('last_run.txt')))
-      rescue Errno::ENOENT
-        Time.zone.at(0)
-      end
+      splitted_description.third
     end
 
     def delete!
@@ -68,52 +56,71 @@ module SpecViews
       path.join("challenger.#{file_extension}")
     end
 
+    def challenger?
+      File.file?(challenger_path)
+    end
+
     def write_challenger(content)
       FileUtils.mkdir_p(path)
       File.open(challenger_path, binary? ? 'wb' : 'w') { |f| f.write(content) }
     end
 
-    def last_run_path
-      path.join('last_run.txt')
+    def meta_path
+      path.join('meta.txt')
     end
 
-    def write_last_run(time)
+    def write_meta(description, run_time, spec_type, content_type)
       FileUtils.mkdir_p(path)
-      File.write(last_run_path, time)
+      lines = [
+        description.to_s.gsub("\n", ' '),
+        run_time.to_s,
+        spec_type.to_s,
+        content_type.to_s
+      ]
+      File.write(meta_path, lines.join("\n"))
     end
 
-    def description_path
-      path.join('description.txt')
-    end
-
-    def write_description(description)
-      FileUtils.mkdir_p(path)
-      File.write(description_path, description)
+    def meta
+      @meta ||= File.read(meta_path).lines.map(&:strip)
     end
 
     def description
-      File.read(description_path)
+      meta[0]
     rescue Errno::ENOENT
       name
     end
 
-    def pdf?
-      name.to_s.ends_with?('__pdf')
+    def last_run
+      Time.zone.parse(meta[1])
+    rescue Errno::ENOENT
+      Time.zone.at(0)
+    end
+
+    def spec_type
+      ActiveSupport::StringInquirer.new(meta[2])
+    rescue Errno::ENOENT
+      :response
     end
 
-    def mailer?
-      @mailer ||= name.to_s.start_with?(/[a-zA-Z0-9:]+Mailer[^a-zA-Z0-9]/)
+    def content_type
+      @content_type ||= begin
+        ActiveSupport::StringInquirer.new(meta[3])
+      rescue Errno::ENOENT
+        :response
+      end
     end
 
     def binary?
-      pdf?
+      content_type.pdf?
     end
 
     private
 
     def splitted_description
       @splitted_description ||= begin
-        if mailer?
+        if spec_type.feature?
+          split = ['', 'FEAT', description]
+        elsif spec_type.mailer?
           split = description.to_s.match(/(\A[a-zA-Z0-9:]+)(Mailer)(.*)/)
           split = split[1..3]
           split[0] += 'Mailer'
@@ -127,7 +134,7 @@ module SpecViews
     end
 
     def file_extension
-      pdf? ? 'pdf' : 'html'
+      content_type.pdf? ? 'pdf' : 'html'
     end
   end
 end

data/app/models/spec_views/html_matcher.rb

@@ -25,7 +25,9 @@ module SpecViews
     private
 
     def sanitized_body
-      remove_pack_digests_from_body(remove_digests_from_body(@extractor.body))
+      body = remove_pack_digests_from_body(remove_digests_from_body(@extractor.body))
+      body = sanitizer.sanitize(body) if sanitizer
+      body
     end
 
     def remove_digests_from_body(body)

data/app/models/spec_views/http_response_extractor.rb

@@ -9,7 +9,6 @@ module SpecViews
       @status_match = response_status_match?(response, expected_status)
       return if @status_match
 
-
       @failure_message = "Unexpected response status #{response.status}."
     end
 

data/app/models/spec_views/mail_message_extractor.rb

@@ -9,7 +9,7 @@ module SpecViews
       @body = extract_body(mail)
       return if body.present?
 
-      @failure_message = "Failed to find mail part"
+      @failure_message = 'Failed to find mail part'
     end
 
     def extractor_failure?
@@ -20,7 +20,8 @@ module SpecViews
       return part.raw_source if part.respond_to?(:raw_source) && part.raw_source.present?
       return extract_body(part.body) if part.respond_to?(:body)
       return part if part.is_a?(String)
-      return if nil unless part.respond_to?(:parts)
+
+      return if !part.respond_to?(:parts) && nil
 
       part.parts.map do |inner_part|
         extract_body(inner_part)

data/app/models/spec_views/pdf_matcher.rb

@@ -35,7 +35,11 @@ module SpecViews
     end
 
     def sanitized_body
-      @sanitized_body ||= remove_headers_from_pdf(@extractor.body)
+      @sanitized_body ||= begin
+        body = remove_headers_from_pdf(@extractor.body)
+        body = sanitizer.sanitize(body) if sanitizer
+        body
+      end
     end
 
     def remove_headers_from_pdf(body)

data/app/models/spec_views/view_sanitizer.rb

@@ -0,0 +1,20 @@
+module SpecViews
+  class ViewSanitizer
+    delegate :each, to: :@sanitizers
+
+    def initialize
+      @sanitizers = []
+    end
+
+    def gsub(*args, &block)
+      @sanitizers << [:gsub, args, block]
+    end
+
+    def sanitize(string)
+      each do |sanitize_method, args, block|
+        string = string.send(sanitize_method, *args, &block)
+      end
+      string
+    end
+  end
+end

data/lib/spec_views/support.rb

@@ -22,11 +22,16 @@ module SpecViews
   end
 end
 
+RSpec.shared_context 'SpecViews ViewSanitizer' do
+  let(:view_sanitizer) { SpecViews::ViewSanitizer.new }
+end
+
 RSpec.configure do |c|
   c.before(:suite) do |_example|
     $_spec_view_time = Time.zone.now # rubocop:disable Style/GlobalVars
   end
-  %i[controller mailer request].each do |type|
+  c.include_context 'SpecViews ViewSanitizer'
+  %i[controller feature mailer request].each do |type|
     c.extend SpecViews::Support::SpecViewExample, type: type
     c.before(type: type) do |example|
       @_spec_view_example = example
@@ -40,7 +45,6 @@ RSpec.configure do |c|
   end
 end
 
-
 matchers = [
   [:match_html_fixture, SpecViews::HtmlMatcher],
   [:match_pdf_fixture, SpecViews::PdfMatcher]
@@ -63,6 +67,7 @@ matchers.each do |matcher|
         description,
         expected_status: @status,
         run_time: run_time,
+        sanitizer: view_sanitizer,
         type: type
       )
       return @matcher.match?

data/lib/spec_views/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spec_views
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Sebastian Gaul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -81,11 +81,13 @@ files:
 - app/assets/javascripts/spec_views/jsdiff.js
 - app/controllers/spec_views/views_controller.rb
 - app/models/spec_views/base_matcher.rb
+- app/models/spec_views/capybara_session_extractor.rb
 - app/models/spec_views/directory.rb
 - app/models/spec_views/html_matcher.rb
 - app/models/spec_views/http_response_extractor.rb
 - app/models/spec_views/mail_message_extractor.rb
 - app/models/spec_views/pdf_matcher.rb
+- app/models/spec_views/view_sanitizer.rb
 - app/views/layouts/spec_views.html.erb
 - app/views/spec_views/views/_actions.html.erb
 - app/views/spec_views/views/_directory_footer.html.erb