Add bin and edit workflow

bin/gems/html-proofer-5.0.10/lib/html_proofer/check.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module HTMLProofer
+  # Mostly handles issue management and collecting of external URLs.
+  class Check
+    include HTMLProofer::Utils
+
+    attr_reader :failures, :options, :internal_urls, :external_urls
+
+    def initialize(runner, html)
+      @runner = runner
+      @html   = remove_ignored(html)
+
+      @external_urls = {}
+      @internal_urls = {}
+      @failures = []
+    end
+
+    def create_element(node)
+      Element.new(@runner, node, base_url: base_url)
+    end
+
+    def run
+      raise NotImplementedError, "HTMLProofer::Check subclasses must implement #run"
+    end
+
+    def add_failure(description, element: nil, line: nil, status: nil, content: nil)
+      @failures << Failure.new(
+        @runner.current_filename,
+        short_name,
+        description,
+        line: element.nil? ? line : element.line,
+        status: status,
+        content: element.nil? ? content : element.content,
+      )
+    end
+
+    def short_name
+      self.class.name.split("::").last
+    end
+
+    def add_to_internal_urls(url, line)
+      url_string = url.raw_attribute
+
+      @internal_urls[url_string] = [] if @internal_urls[url_string].nil?
+
+      metadata = {
+        source: url.source,
+        filename: url.filename,
+        line: line,
+        base_url: base_url,
+        found: false,
+      }
+      @internal_urls[url_string] << metadata
+    end
+
+    def add_to_external_urls(url, line)
+      url_string = url.to_s
+
+      @external_urls[url_string] = [] if @external_urls[url_string].nil?
+
+      @external_urls[url_string] << { filename: url.filename, line: line }
+    end
+
+    class << self
+      def subchecks(runner_options)
+        # grab all known checks
+        checks = ObjectSpace.each_object(Class).select do |klass|
+          klass < self
+        end
+
+        # remove any checks not explicitly included
+        checks.each_with_object([]) do |check, arr|
+          next unless runner_options[:checks].include?(check.short_name)
+
+          arr << check
+        end
+      end
+
+      def short_name
+        name.split("::").last
+      end
+    end
+
+    private def base_url
+      return @base_url if defined?(@base_url)
+
+      return (@base_url = "") if (base = @html.at_css("base")).nil?
+
+      @base_url = base["href"]
+    end
+
+    private def remove_ignored(html)
+      return if html.nil?
+
+      html.css("code, pre, tt").each(&:unlink)
+      html
+    end
+  end
+end