spec_views 1.1.0 → 3.0.0

data/app/controllers/spec_views/views_controller.rb

@@ -2,7 +2,7 @@
 
 module SpecViews
   class ViewsController < ApplicationController
-    skip_authorization_check
+    skip_authorization_check if respond_to?(:skip_authorization_check)
     layout 'spec_views'
 
     def index
@@ -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
 
@@ -36,15 +36,25 @@ module SpecViews
       @directory = directory
     end
 
+    def diff
+      if directory.content_type.pdf?
+        redirect_to action: :compare
+        return
+      end
+      @champion = get_view(directory.champion_path, html_safe: false)
+      @challenger = get_view(directory.challenger_path, html_safe: false)
+      @directory = directory
+    end
+
     def preview
       @directory = directory
       @next = directories[directories.index(@directory) + 1]
       index = directories.index(@directory)
-      @previous = directories[index - 1] if index > 0
+      @previous = directories[index - 1] if index.positive?
     end
 
     def accept
-      accept_directory(params[:id])
+      accept_directory(directory)
       redirect_to action: :index, challenger: :next
     end
 
@@ -56,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
 
@@ -72,66 +81,20 @@ module SpecViews
 
     private
 
-    class Directory
-      attr_reader :path
-
-      def initialize(path)
-        @path = path
-      end
-
-      def basename
-        path.basename
-      end
-
-      def to_param
-        basename.to_s
-      end
-
-      def name
-        basename
-      end
-
-      def challenger?
-        File.file?(path.join('challenger.html')) || File.file?(path.join('challenger.pdf'))
-      end
-
-      def controller_name
-        splitted_name.first.gsub(/Controller(_.*)$/, 'Controller').gsub(/Controller$/, '').gsub('_', '::')
-      end
-
-      def method
-        splitted_name.second
-      end
-
-      def description
-        splitted_name.third.humanize
-      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
-      end
-
-      def delete!
-        FileUtils.remove_dir(path)
+    def directories
+      @directories ||= Pathname.new(directory_path).children.select(&:directory?).map do |path|
+        SpecViews::Directory.new(path)
       end
+      latest_run = @directories.map(&:last_run).max
 
-      private
-
-      def splitted_name
-        @splitted_name ||= name.to_s.split(/_(DELETE|GET|PATCH|POST|PUT)_/)
+      @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 directories
-      @directories ||= Pathname.new(directory_path).children.select(&:directory?).map do |path|
-        Directory.new(path)
-      end.sort_by(&:basename)
-    end
-
     def directory_path
       Rails.root.join(Rails.configuration.spec_views.directory)
     end
@@ -140,32 +103,17 @@ module SpecViews
       directories.detect { |dir| dir.to_param == params[:id] }
     end
 
-    def get_view(filename = nil)
-      filename ||= pdf? ? 'view.pdf' : 'view.html'
-      File.read(file_path(filename)).html_safe # rubocop:disable Rails/OutputSafety
+    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] && 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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module SpecViews
+  class BaseMatcher
+    attr_reader :response, :directory, :failure_message, :sanitizer, :type
+
+    delegate :champion_html, to: :directory
+
+    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_meta(description, run_time, type, content_type) if champion_html
+      return if match?
+
+      if extractor_failure?
+        @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_meta(description, run_time, type, content_type)
+      @directory.write_challenger(challenger_body)
+    end
+
+    def match?
+      @match
+    end
+
+    def extractor_failure?
+      @extractor_failure
+    end
+
+    protected
+
+    def subject_name
+      raise NotImplementedError
+    end
+
+    def challenger_body
+      raise NotImplementedError
+    end
+
+    def match_challenger
+      raise NotImplementedError
+    end
+
+    def content_type
+      raise NotImplementedError
+    end
+
+    def extractor_class
+      return CapybaraSessionExtractor if type == :feature
+      return MailMessageExtractor if type == :mailer
+
+      HttpResponseExtractor
+    end
+  end
+end

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

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module SpecViews
+  class Directory
+    attr_reader :path
+
+    def self.for_description(description, content_type: :html)
+      dir_name = description.strip.gsub(/[^0-9A-Za-z.\-]/, '_').gsub('__', '_')
+      new(Rails.root.join(Rails.configuration.spec_views.directory, dir_name), content_type)
+    end
+
+    def initialize(path, content_type = nil)
+      @path = path
+      @content_type = ActiveSupport::StringInquirer.new(content_type.to_s) if content_type
+    end
+
+    def basename
+      path.basename
+    end
+
+    def to_param
+      basename.to_s
+    end
+
+    def name
+      basename
+    end
+
+    def controller_name
+      splitted_description.first.gsub(/Controller(_.*)$/, 'Controller').gsub(/Controller$/, '').gsub('_', '::')
+    end
+
+    def method
+      splitted_description.second[0, 4]
+    end
+
+    def description_tail
+      splitted_description.third
+    end
+
+    def delete!
+      FileUtils.remove_dir(path)
+    end
+
+    def champion_path
+      path.join("view.#{file_extension}")
+    end
+
+    def champion_html
+      File.read(champion_path)
+    rescue Errno::ENOENT
+      nil
+    end
+
+    def challenger_path
+      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 meta_path
+      path.join('meta.txt')
+    end
+
+    def write_meta(description, run_time, spec_type, content_type)
+      FileUtils.mkdir_p(path)
+      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 meta
+      @meta ||= File.read(meta_path).lines.map(&:strip)
+    end
+
+    def description
+      meta[0]
+    rescue Errno::ENOENT
+      name
+    end
+
+    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 content_type
+      @content_type ||= begin
+        ActiveSupport::StringInquirer.new(meta[3])
+      rescue Errno::ENOENT
+        :response
+      end
+    end
+
+    def binary?
+      content_type.pdf?
+    end
+
+    private
+
+    def splitted_description
+      @splitted_description ||= begin
+        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'
+          split[1] = 'MAIL'
+        else
+          split = description.to_s.split(/\s(DELETE|GET|PATCH|POST|PUT)\s/)
+        end
+        split = ['', '', split[0]] if split.size == 1
+        split
+      end
+    end
+
+    def file_extension
+      content_type.pdf? ? 'pdf' : 'html'
+    end
+  end
+end

data/app/models/spec_views/html_matcher.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SpecViews
+  class HtmlMatcher < BaseMatcher
+    delegate :champion_html, to: :directory
+
+    protected
+
+    def subject_name
+      'View'
+    end
+
+    def content_type
+      :html
+    end
+
+    def challenger_body
+      sanitized_body
+    end
+
+    def match_challenger
+      champion_html == challenger_body
+    end
+
+    private
+
+    def sanitized_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)
+      body.gsub(/(-[a-z0-9]{64})(\.css|\.js|\.ico|\.png|\.jpg|\.jpeg|\.svg|\.gif)/, '\2')
+    end
+
+    def remove_pack_digests_from_body(body)
+      body.gsub(%r{(packs.*/js/[a-z0-9_]+)(-[a-z0-9]{20})(\.js)}, '\1\3')
+    end
+  end
+end

data/app/models/spec_views/http_response_extractor.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SpecViews
+  class HttpResponseExtractor
+    attr_reader :response, :failure_message
+
+    def initialize(response, expected_status:)
+      @response = response
+      @status_match = response_status_match?(response, expected_status)
+      return if @status_match
+
+      @failure_message = "Unexpected response status #{response.status}."
+    end
+
+    def extractor_failure?
+      failure_message.present?
+    end
+
+    def body
+      response.body
+    end
+
+    private
+
+    def response_status_match?(response, expected_status)
+      response.status == expected_status ||
+        response.message.parameterize.underscore == expected_status.to_s
+    end
+  end
+end

data/app/models/spec_views/mail_message_extractor.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SpecViews
+  class MailMessageExtractor
+    attr_reader :mail, :failure_message, :body
+
+    def initialize(mail, expected_status:)
+      @mail = mail
+      @body = extract_body(mail)
+      return if body.present?
+
+      @failure_message = 'Failed to find mail part'
+    end
+
+    def extractor_failure?
+      failure_message.present?
+    end
+
+    def extract_body(part)
+      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 !part.respond_to?(:parts) && nil
+
+      part.parts.map do |inner_part|
+        extract_body(inner_part)
+      end.compact.first
+    end
+  end
+end

data/app/models/spec_views/pdf_matcher.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module SpecViews
+  class PdfMatcher < BaseMatcher
+    protected
+
+    def subject_name
+      'PDF'
+    end
+
+    def content_type
+      :pdf
+    end
+
+    def challenger_body
+      sanitized_body
+    end
+
+    def match_challenger
+      champion_hash == challenger_hash
+    end
+
+    private
+
+    def champion_hash
+      @champion_hash ||= begin
+        Digest::MD5.file(directory.champion_path).hexdigest
+      rescue Errno::ENOENT
+        nil
+      end
+    end
+
+    def challenger_hash
+      @challenger_hash ||= Digest::MD5.hexdigest(sanitized_body)
+    end
+
+    def sanitized_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)
+      body
+        .force_encoding('BINARY')
+        .gsub(%r{^/CreationDate \(.*\)$}, '')
+        .gsub(%r{^/ModDate \(.*\)$}, '')
+        .gsub(%r{^/ID \[<.+><.+>\]$}, '')
+    end
+  end
+end

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