mensa 0.6.17 → 0.6.19

data/lib/mensa/verifier/result.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Mensa
+  class Verifier
+    # One verified aspect of a table, e.g. sorting a column descending.
+    #
+    # +section+ groups checks in the report (:loads, :columns, :filters, ...),
+    # +subject+ is the column, filter or view it relates to. Warnings (N+1
+    # queries, slow queries) don't fail the table unless it's verified strict.
+    Check = Struct.new(:section, :subject, :name, :status, :message, :sql, :error) do
+      def passed?
+        status == :passed
+      end
+
+      def failed?
+        status == :failed
+      end
+
+      def skipped?
+        status == :skipped
+      end
+
+      def warning?
+        status == :warning
+      end
+
+      def label
+        [subject, name].compact.join(": ")
+      end
+    end
+
+    class Result
+      SECTIONS = {
+        loads: "Loads",
+        columns: "Columns",
+        filters: "Filters",
+        search: "Search",
+        render: "Rendering",
+        combined: "Combined",
+        exports: "Exports",
+        grouping: "Grouping",
+        views: "Views"
+      }.freeze
+
+      SYMBOLS = {passed: "✓", failed: "✗", skipped: "-", warning: "!"}.freeze
+
+      attr_reader :table_class, :checks, :label
+
+      # +label+ names the context it was verified in, e.g. "user: User#1"
+      def initialize(table_class, strict: false, label: nil)
+        @table_class = table_class
+        @strict = strict
+        @label = label
+        @checks = []
+      end
+
+      # False for a class that isn't a Mensa::Base subclass, which is skipped
+      def mensa_table?
+        table_class.is_a?(Class) && table_class < Mensa::Base
+      end
+
+      def strict?
+        @strict
+      end
+
+      def success?
+        failures.empty? && (!strict? || warnings.empty?)
+      end
+
+      def failures
+        checks.select(&:failed?)
+      end
+
+      def passes
+        checks.select(&:passed?)
+      end
+
+      def skips
+        checks.select(&:skipped?)
+      end
+
+      def warnings
+        checks.select(&:warning?)
+      end
+
+      def summary
+        "#{passes.size} passed, #{failures.size} failed, #{skips.size} skipped, #{warnings.size} #{"warning".pluralize(warnings.size)}"
+      end
+
+      def title
+        [table_class.name || table_class.to_s, ("(#{label})" if label)].compact.join(" ")
+      end
+
+      def to_s
+        return "#{title}\n  - skipped: #{checks.first&.message}" unless mensa_table?
+
+        lines = [title]
+
+        checks.group_by(&:section).each do |section, section_checks|
+          lines << "  #{SECTIONS.fetch(section, section.to_s.humanize)}"
+          section_checks.each do |check|
+            lines << "    #{SYMBOLS[check.status]} #{check.label}#{" (skipped: #{check.message})" if check.skipped?}"
+            next unless check.failed? || check.warning?
+
+            check.message.to_s.each_line { |line| lines << "        #{line.chomp}" }
+            lines << "        SQL: #{check.sql}" if check.sql.present?
+          end
+        end
+
+        lines << ""
+        lines << "#{success? ? "OK" : "FAILED"}: #{summary}#{" (strict: warnings fail)" if strict? && warnings.any?}"
+        lines.join("\n")
+      end
+      alias_method :report, :to_s
+
+      def inspect
+        "#<#{self.class.name} #{title} #{summary}>"
+      end
+    end
+  end
+end