sa11y 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25c2a67f3499df5c522d4e66622b1012365c50ee1b96a9f344076330bc651c3d
-  data.tar.gz: 5aa9383902ecf14392960ffb1d289c7e0696d675ecd122c1cbe5afe3df755ce8
+  metadata.gz: e457e53b58f1040f0598cbe44bb84ed5a6ec6c98768bdc0c5b0488037df96b6b
+  data.tar.gz: 60c7e99dd8574dce7988d23bdb3c4973455ad9993a60414d8d1a28ef2e689bef
 SHA512:
-  metadata.gz: b718733d4817c340b5540cbb8240401ba014d46b3a6dac5443c6881fcf41a7f3abce440709dc377467969265ac5a53d71feaac0212f7bab726b7aee228e8a3ae
-  data.tar.gz: 7e9ddd0cb43d12611913fd8e3ad0ff6450d75593dc095fee8d047b0f8ef56e71a4ee76f08d651dbe5c83e77f0537f792eb5fe6eb727c5561d5ac1a75223aab98
+  metadata.gz: 53efed9661b3fda64a6385f36f20bdf4cccd406b86f51eed73c022eaf59c2cfb0a8d74240bc0386749de79b5eb188a28af8394bf3e4233c00a7193be966af4da
+  data.tar.gz: 4d1f3f9cb17489dd3ae21a4030f733405116ba8d48e67822cb6a1dc4298e8774cff43c7c677e8ac2af7f65b70e59311b1509ab5f1af9eda1b91a6efe430309bd

data/README.md

@@ -52,18 +52,28 @@ driver = Selenium::WebDriver.for :chrome
 Sa11y::Analyze(driver).results
 ```
 
-If your site does not use iFrames, you can improve performance slightly by turning off iframe checks:
+By default, sa11y inspects elements in all frames and iframes on the page.
+If your site does not use frames, you can improve performance slightly by turning off frame checks:
 ```ruby
-driver = Selenium::WebDriver.for :chrome 
-analyze = Sa11y::Analyze(driver)
-analyze.iframes = false
+driver = Selenium::WebDriver.for :chrome
+analyze = Sa11y::Analyze(driver, frames: false)
+analyze.results
+```
+
+By default, sa11y does not inspect frames from cross origins. If you need to analyze frames
+originating from a different domain, you need to turn this on:
+```ruby
+driver = Selenium::WebDriver.for :chrome
+analyze = Sa11y::Analyze(driver, cross_origin: true)
+analyze.results
 ```
 
-This gem comes packaged with the latest axe™ version at release. If you want to change this, specify the JS library you want to use:
+This gem comes packaged with the latest axe™ version at release. If you want to change this, 
+specify the JS library you want to use:
 ```ruby
 driver = Selenium::WebDriver.for :chrome
-js_lib = File.read("path/to/axe.min.js"))
-Sa11y::Analyze(driver, js_lib: js_lib)
+Sa11y::Analyze(driver, js_lib: File.read("path/to/axe.min.js"))
+analyze.results
 ```
 
 ## Development

data/lib/sa11y/analyze.rb

@@ -5,42 +5,51 @@ require "selenium-webdriver"
 module Sa11y
   # Analyzes Current Webpage with axe™ Accessibility Tool from Deque
   class Analyze
-    attr_accessor :js_lib, :iframes
+    attr_accessor :js_lib, :frames, :cross_origin
 
     # https://github.com/dequelabs/axe-core-maven-html/blob/61447b/src/main/java/com/deque/html/axecore/selenium/
     # AxeBuilder.java#L83-L95
     # Copyright (C) 2020 Deque Systems Inc.,
-    AXE_RESULTS = <<~AXE
+    AXE_RUN_SCRIPT = <<~AXE
       var callback = arguments[arguments.length - 1];var context = typeof arguments[0] === 'string' ?
       JSON.parse(arguments[0]) : arguments[0];context = context || document;
       var options = JSON.parse(arguments[1]);axe.run(context, options,
       function (err, results) {  {    if (err) {      throw new Error(err);    }    callback(results);  }});
     AXE
 
-    def initialize(driver, js_lib: nil)
+    # https://github.com/dequelabs/axe-core-maven-html/blob/61447b/src/main/java/com/deque/html/axecore/selenium/
+    # AxeBuilder.java#L97
+    # Copyright (C) 2020 Deque Systems Inc.,
+    IFRAME_ALLOWED_SCRIPT = "axe.configure({ allowedOrigins: ['<unsafe_all_origins>'] });"
+
+
+    def initialize(driver, js_lib: nil, frames: true, cross_origin: false)
       @driver = driver
       @js_lib = js_lib || File.read(File.expand_path("../scripts/axe.min.js", __dir__))
-      @iframes = true
+      @frames = frames
+      @cross_origin = cross_origin
     end
 
     def results
-      @driver.execute_script(@js_lib)
-      if iframes
+      if @frames
         @driver.switch_to.default_content
         manage_frames
+      else
+        @driver.execute_script(@js_lib)
       end
-      @driver.execute_async_script(AXE_RESULTS, nil, "{}")
+      @driver.execute_async_script(AXE_RUN_SCRIPT, nil, "{}")
     end
 
     private
 
     def manage_frames
-      frames = @driver.find_elements(tag_name: "iframe")
-      return if frames.empty?
+      @driver.execute_script(@js_lib)
+      @driver.execute_script(IFRAME_ALLOWED_SCRIPT) if @cross_origin
+
+      frame_elements = @driver.find_elements(xpath: ".//*[local-name()='frame' or local-name()='iframe']")
 
-      frames.each do |frame|
+      frame_elements.each do |frame|
         @driver.switch_to.frame(frame)
-        @driver.execute_script(js_lib)
         manage_frames
         @driver.switch_to.parent_frame
       end

data/lib/sa11y/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sa11y
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sa11y
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - titusfortner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: The Selenium Accessibility Gem