axe-core-api 2.6.1.pre.acca0cb

data/lib/axe/api/context.rb

@@ -0,0 +1,35 @@
+require_relative "./selector"
+
+module Axe
+  module API
+    class Context
+      def initialize
+        @inclusion = []
+        @exclusion = []
+      end
+
+      def within(*selectors)
+        @inclusion.concat selectors.map { |s| Array(Selector.new s) }
+      end
+
+      def excluding(*selectors)
+        @exclusion.concat selectors.map { |s| Array(Selector.new s) }
+      end
+
+      def to_hash
+        { include: @inclusion, exclude: @exclusion }
+          .reject { |k, v| v.empty? }
+      end
+
+      def to_json
+        to_hash.to_json
+      end
+
+      def empty?
+        to_hash.empty?
+      end
+
+      alias :to_s :to_json
+    end
+  end
+end

data/lib/axe/api/options.rb

@@ -0,0 +1,32 @@
+require "forwardable"
+require_relative "./rules"
+
+module Axe
+  module API
+    class Options
+      extend Forwardable
+
+      def_delegators :@rules, :according_to, :checking, :checking_only, :skipping
+      def_delegator :@custom, :merge!, :with_options
+
+      def initialize
+        @rules = Rules.new
+        @custom = {}
+      end
+
+      def to_hash
+        @rules.to_hash.merge(@custom)
+      end
+
+      def to_json
+        to_hash.to_json
+      end
+
+      def empty?
+        to_hash.empty?
+      end
+
+      alias :to_s :to_json
+    end
+  end
+end

data/lib/axe/api/results.rb

@@ -0,0 +1,48 @@
+require_relative "./value_object"
+
+module Axe
+  module API
+    class Results < ValueObject
+      require_relative "./results/rule"
+
+      values do
+        attribute :inapplicable, ::Array[Rule]
+        attribute :incomplete, ::Array[Rule]
+        attribute :passes, ::Array[Rule]
+        attribute :timestamp
+        attribute :url, ::String
+        attribute :violations, ::Array[Rule]
+      end
+
+      def failure_message
+        [
+          "",
+          violation_count_message,
+          "",
+          violations_failure_messages,
+        ].flatten.join("\n")
+      end
+
+      def to_h
+        {
+          inapplicable: inapplicable.map(&:to_h),
+          incomplete: incomplete.map(&:to_h),
+          passes: passes.map(&:to_h),
+          timestamp: timestamp,
+          url: url,
+          violations: violations.map(&:to_h),
+        }
+      end
+
+      private
+
+      def violation_count_message
+        "Found #{violations.count} accessibility #{violations.count == 1 ? "violation" : "violations"}:"
+      end
+
+      def violations_failure_messages
+        violations.each_with_index.map(&:failure_messages)
+      end
+    end
+  end
+end

data/lib/axe/api/results/check.rb

@@ -0,0 +1,32 @@
+require_relative "../value_object"
+require_relative "../results/node"
+
+module Axe
+  module API
+    class Results
+      class Check < ValueObject
+        values do
+          attribute :data, ::String
+          attribute :id, ::Symbol
+          attribute :impact, ::Symbol
+          attribute :message, ::String
+          attribute :relatedNodes, ::Array[Node]
+        end
+
+        def failure_message
+          message
+        end
+
+        def to_h
+          {
+            data: data,
+            id: id,
+            impact: impact,
+            message: message,
+            relatedNodes: relatedNodes.map(&:to_h),
+          }
+        end
+      end
+    end
+  end
+end

data/lib/axe/api/results/checked_node.rb

@@ -0,0 +1,51 @@
+require_relative "./node"
+require_relative "./check"
+
+module Axe
+  module API
+    class Results
+      class CheckedNode < Node
+        values do
+          attribute :impact, ::Symbol
+          attribute :any, ::Array[Check]
+          attribute :all, ::Array[Check]
+          attribute :none, ::Array[Check]
+          attribute :failureSummary, ::Symbol
+          attribute :html, ::String
+          attribute :target
+        end
+
+        def failure_messages
+          [
+            super,
+            fix(all, "Fix all of the following:"),
+            fix(none, "Fix all of the following:"),
+            fix(any, "Fix any of the following:"),
+          ]
+        end
+
+        def to_h
+          {
+            all: all.map(&:to_h),
+            any: any.map(&:to_h),
+            failureSummary: failureSummary,
+            html: html,
+            impact: impact,
+            none: none.map(&:to_h),
+            target: target,
+          }
+        end
+
+        private
+
+        def fix(checks, message)
+          valid_checks = checks.reject { |c| c.nil? }
+          [
+            (message unless valid_checks.empty?),
+            valid_checks.map(&:failure_message).map { |line| line.prepend("- ") },
+          ].compact
+        end
+      end
+    end
+  end
+end

data/lib/axe/api/results/node.rb

@@ -0,0 +1,35 @@
+require_relative "../value_object"
+
+module Axe
+  module API
+    class Results
+      class Node < ValueObject
+        values do
+          attribute :html, ::String
+          attribute :target # String or Array[String]
+        end
+
+        def failure_messages
+          [selector_message, node_html]
+        end
+
+        def to_h
+          {
+            html: html,
+            target: target,
+          }
+        end
+
+        private
+
+        def selector_message
+          "Selector: #{Array(target).join(", ")}"
+        end
+
+        def node_html
+          "HTML: #{html.gsub(/^\s*|\n*/, "")}" unless html.nil?
+        end
+      end
+    end
+  end
+end

data/lib/axe/api/results/rule.rb

@@ -0,0 +1,58 @@
+require_relative "../value_object"
+require_relative "./checked_node"
+
+module Axe
+  module API
+    class Results
+      class Rule < ValueObject
+        values do
+          attribute :id, ::Symbol
+          attribute :description, ::String
+          attribute :help, ::String
+          attribute :helpUrl, ::String
+          attribute :impact, ::Symbol
+          attribute :tags, ::Array[::Symbol]
+          attribute :nodes, ::Array[CheckedNode]
+        end
+
+        def failure_messages(index)
+          [
+            title_message(index + 1),
+            *[
+              helpUrl,
+              node_count_message,
+              "",
+              nodes.reject { |n| n.nil? }.map(&:failure_messages).map { |n| n.push("") }.flatten.map(&indent),
+            ].flatten.map(&indent),
+          ]
+        end
+
+        def to_h
+          {
+            description: description,
+            help: help,
+            helpUrl: helpUrl,
+            id: id,
+            impact: impact,
+            nodes: nodes.map(&:to_h),
+            tags: tags,
+          }
+        end
+
+        private
+
+        def indent
+          ->(line) { line.prepend(" " * 4) unless line.nil? }
+        end
+
+        def title_message(count)
+          "#{count}) #{id}: #{help} (#{impact})"
+        end
+
+        def node_count_message
+          "The following #{nodes.length} #{nodes.length == 1 ? "node" : "nodes"} violate this rule:"
+        end
+      end
+    end
+  end
+end

data/lib/axe/api/rules.rb

@@ -0,0 +1,37 @@
+module Axe
+  module API
+    class Rules
+      def initialize
+        @tags = []
+        @included = []
+        @excluded = []
+        @exclusive = []
+      end
+
+      def according_to(*tags)
+        @tags.concat tags.flatten
+      end
+
+      def checking(*rules)
+        @included.concat rules.flatten
+      end
+
+      def checking_only(*rules)
+        @exclusive.concat rules.flatten
+      end
+
+      def skipping(*rules)
+        @excluded.concat rules.flatten
+      end
+
+      def to_hash
+        {}.tap do |options|
+          # TODO warn that tags + exclusive-rules are incompatible
+          options.merge! runOnly: { type: :tag, values: @tags } unless @tags.empty?
+          options.merge! runOnly: { type: :rule, values: @exclusive } unless @exclusive.empty?
+          options.merge! rules: Hash[@included.product([enabled: true]) + @excluded.product([enabled: false])] unless @included.empty? && @excluded.empty?
+        end
+      end
+    end
+  end
+end

data/lib/axe/api/run.rb

@@ -0,0 +1,53 @@
+require "forwardable"
+require "json"
+
+require_relative "../../chain_mail/chainable"
+require_relative "./audit"
+require_relative "./context"
+require_relative "./options"
+require_relative "./results"
+require_relative "../core"
+
+module Axe
+  module API
+    class Run
+      JS_NAME = "run"
+      METHOD_NAME = "#{Core::JS_NAME}.#{JS_NAME}"
+
+      extend Forwardable
+      def_delegators :@context, :within, :excluding
+      def_delegators :@options, :according_to, :checking, :checking_only, :skipping, :with_options
+
+      extend ChainMail::Chainable
+      chainable :within, :excluding, :according_to, :checking, :checking_only, :skipping, :with_options
+
+      def initialize
+        @context = Context.new
+        @options = Options.new
+      end
+
+      def call(page)
+        audit page do |results|
+          Audit.new to_js, Results.new(results)
+        end
+      end
+
+      private
+
+      def audit(page)
+        yield page.execute_async_script "#{METHOD_NAME}.apply(#{Core::JS_NAME}, arguments)", *js_args
+      end
+
+      def js_args
+        [@context, @options]
+          .reject(&:empty?)
+          .map(&:to_json)
+      end
+
+      def to_js
+        str_args = (js_args + ["callback"]).join(", ")
+        "#{METHOD_NAME}(#{str_args});"
+      end
+    end
+  end
+end

data/lib/axe/api/selector.rb

@@ -0,0 +1,18 @@
+module Axe
+  module API
+    class Selector
+      def initialize(s)
+        @selector = case s
+                    when Array then s
+                    when String, Symbol then [String(s)]
+                    when Hash then Selector.new(s[:selector]).to_a.unshift s[:iframe]
+                    else Selector.new(s.selector).to_a.unshift s.iframe
+                    end
+      end
+
+      def to_a
+        @selector
+      end
+    end
+  end
+end

data/lib/axe/api/value_object.rb

@@ -0,0 +1,9 @@
+require 'virtus'
+
+module Axe
+  module API
+    class ValueObject
+      include ::Virtus.value_object mass_assignment: false, nullify_blank: true
+    end
+  end
+end

data/lib/axe/configuration.rb

@@ -0,0 +1,44 @@
+require "singleton"
+require "forwardable"
+require "json"
+
+require_relative "../hooks"
+require_relative "../webdriver_script_adapter/execute_async_script_adapter"
+
+module Axe
+  class Configuration
+    include Singleton
+    include Common::Hooks
+    extend Forwardable
+
+    attr_writer :jslib
+    attr_accessor :page,
+                  :jslib_path,
+                  :skip_iframes
+    def_delegators ::WebDriverScriptAdapter,
+                   :async_results_identifier,
+                   :async_results_identifier=,
+                   :max_wait_time,
+                   :max_wait_time=,
+                   :wait_interval,
+                   :wait_interval=
+
+    # init
+    def initialize
+      @page = :page
+      @skip_iframes = :skip_iframes
+      @jslib_path = get_root + "/node_modules/axe-core/axe.min.js"
+    end
+
+    # jslib
+    def jslib
+      @jslib ||= Pathname.new(@jslib_path).read
+    end
+
+    private
+
+    def get_root
+      Gem::Specification.find_by_name('axe-core-api').gem_dir
+    end
+  end
+end