axe-core-api 4.2.0.pre.4575cbd → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63ae938fa9b0c8bdf71e552a7ceb3c0d4ee92618725ed44c0092786f452212fc
-  data.tar.gz: 2210a9a032d3bab1a7c8791499725025fb108ca23339b02560b0286596c80ee3
+  metadata.gz: 8361ef42d11b51e5c441e0f3d876744702bdff28e205d54d53431ab017381143
+  data.tar.gz: dd4e4aa2b104ae60c5f1d8c10eb36fded46e7748734cbfad36ca82ab5a3a71f2
 SHA512:
-  metadata.gz: 4e94415243f47672e0c32803e9364be14e54c2e3337986d0d4565ec657a7766067c990459df8023f0ba50f3d163d8fd25f453091e544e6688f0602fa79bda735
-  data.tar.gz: 54b8e2d0a840c6d43426a28414d42dde39b5444083508c0f44a62e84b6b6a0bf9a665539091d7c126be2db303af2d5fb8bb0823a734265f7f4ada752b1739fae
+  metadata.gz: e0b656db925bbc4162c100ab18be01d8cc2adef9108ab0e38c40a91d99d392a9e036714632facf27ea356f5c1ce972ffbef4f3c87c1767316c90d5d2c15f8bc6
+  data.tar.gz: 240e7562d8a7b322a76abb87ceab1055cb580a378a8841ed1e18c5f33ab8ac79b7113a9017089ceeb45b6807f3d43e84db97c5cc21948e8ef45dc41435b7c920

data/lib/axe/api/context.rb

@@ -16,19 +16,13 @@ module Axe
         @exclusion.concat selectors.map { |s| Array(Selector.new s) }
       end
 
-      def to_h
-        to_hash
-      end
       def to_hash
-        return { exclude: @exclusion } if @inclusion.empty?
-        h = {}
-        h["include"] = @inclusion unless @inclusion.empty?
-        h["exclude"] = @exclusion unless @exclusion.empty?
-        h
+        { include: @inclusion, exclude: @exclusion }
+          .reject { |k, v| v.empty? }
       end
 
-      def to_json(options = nil)
-        to_hash.to_json options
+      def to_json
+        to_hash.to_json
       end
 
       def empty?

data/lib/axe/api/options.rb

@@ -14,16 +14,12 @@ module Axe
         @custom = {}
       end
 
-      def to_h
-        to_hash
-      end
-
       def to_hash
         @rules.to_hash.merge(@custom)
       end
 
-      def to_json(options = nil)
-        to_hash.to_json options
+      def to_json
+        to_hash.to_json
       end
 
       def empty?

data/lib/axe/api/results.rb

@@ -10,10 +10,6 @@ module Axe
         attribute :incomplete, ::Array[Rule]
         attribute :passes, ::Array[Rule]
         attribute :timestamp
-        attribute :testEngine
-        attribute :testEnvironment
-        attribute :testRunner
-        attribute :toolOptions
         attribute :url, ::String
         attribute :violations, ::Array[Rule]
       end
@@ -32,18 +28,12 @@ module Axe
           inapplicable: inapplicable.map(&:to_h),
           incomplete: incomplete.map(&:to_h),
           passes: passes.map(&:to_h),
-          testEngine: testEngine,
           timestamp: timestamp,
           url: url,
           violations: violations.map(&:to_h),
         }
       end
 
-      def timestamp=(ts)
-        timestamp = ts
-      end
-
-
       private
 
       def violation_count_message

data/lib/axe/api/run.rb

@@ -27,182 +27,21 @@ module Axe
       end
 
       def call(page)
-        results = audit page
-        Audit.new to_js, Results.new(results)
-      end
-
-      def analyze_post_43x(page, lib)
-        @original_window = window_handle page
-        partial_results = run_partial_recursive(page, @context, lib, true)
-        throw partial_results if partial_results.respond_to?("key?") and partial_results.key?("errorMessage")
-        results = within_about_blank_context(page) { |page|
-          Common::Loader.new(page, lib).load_top_level Axe::Configuration.instance.jslib
-          begin
-            axe_finish_run page, partial_results
-          rescue
-            raise StandardError.new "axe.finishRun failed. Please check out https://github.com/dequelabs/axe-core-gems/error-handling.md`"
-          end
-        }
-        Audit.new to_js, Results.new(results)
+        audit page do |results|
+          Audit.new to_js, Results.new(results)
+        end
       end
 
       private
 
       def audit(page)
-        script = <<-JS
-          var callback = arguments[arguments.length - 1];
-          var context = arguments[0] || document;
-          var options = arguments[1] || {};
-          #{METHOD_NAME}(context, options).then(callback);
-        JS
-        page.execute_async_script_fixed script, *js_args
-      end
-
-      def switch_to_frame_by_handle(page, handle)
-        page = get_selenium page
-        page.switch_to.frame handle
-      end
-
-      def switch_to_parent_frame(page)
-        page = get_selenium page
-        page.switch_to.parent_frame
-      end
-
-      def within_about_blank_context(page)
-        driver = get_selenium page
-
-        num_handles = page.window_handles.length
-        begin
-          driver.execute_script("window.open('about:blank'), '_blank'")
-          if num_handles == page.window_handles.length
-            raise StandardError.new "Could not open new window. Please make sure that you have popup blockers disabled."
-          end
-          driver.switch_to.window page.window_handles[-1]
-        rescue
-            raise StandardError.new "switchToWindow failed. Are you using updated browser drivers?"
-        end
-        driver.get "about:blank"
-
-        ret = yield page
-
-        driver.switch_to.window page.window_handles[-1]
-        driver.close
-        driver.switch_to.window @original_window
-
-        ret
-      end
-      def window_handle(page)
-        page = get_selenium page
-
-        return page.window_handle if page.respond_to?("window_handle")
-        page.current_window_handle
-      end
-
-      def run_partial_recursive(page, context, lib, top_level = false)
-        begin
-          if not top_level
-            begin
-              Common::Loader.new(page, lib).load_top_level Axe::Configuration.instance.jslib
-            rescue
-              return [nil]
-            end
-
-          end
-
-          frame_contexts = get_frame_context_script page
-          if frame_contexts.respond_to?("key?") and frame_contexts.key?("errorMessage")
-            throw frame_contexts if top_level
-            return [nil]
-          end
-
-          res = axe_run_partial page, context
-          if res.key?("errorMessage")
-            throw res if top_level
-            return [nil]
-          else
-            results = [res]
-          end
-
-          for frame_context in frame_contexts
-            frame_selector = frame_context["frameSelector"]
-            frame_context = frame_context["frameContext"]
-            frame = axe_shadow_select page, frame_selector
-            switch_to_frame_by_handle page, frame
-            res = run_partial_recursive page, frame_context, lib
-            results += res
-          end
-
-        ensure
-          switch_to_parent_frame page if not top_level
-        end
-        return results
-      end
-
-      def axe_finish_run(page, partial_results)
-        script = <<-JS
-          const partialResults = arguments[0];
-          return axe.finishRun(partialResults);
-        JS
-        page.execute_script_fixed script, partial_results
-      end
-
-      def axe_shadow_select(page, frame_selector)
-        script = <<-JS
-          const frameSelector = arguments[0];
-          return axe.utils.shadowSelect(frameSelector);
-        JS
-        page.execute_script_fixed script, frame_selector
-      end
-
-      def axe_run_partial(page, context)
-        script = <<-JS
-          const context = arguments[0];
-          const options = arguments[1];
-          const cb = arguments[arguments.length - 1];
-          try {
-            const ret = window.axe.runPartial(context, options);
-            cb(ret);
-          } catch (err) {
-            const ret = {
-              violations: [],
-              passes: [],
-              url: '',
-              timestamp: new Date().toString(),
-              errorMessage: err.message
-            };
-            cb(ret);
-          }
-        JS
-        page.execute_async_script_fixed script, context, @options
-      end
-
-      def get_frame_context_script(page)
-        script = <<-JS
-          const context = arguments[0];
-          try {
-            return window.axe.utils.getFrameContexts(context);
-          } catch (err) {
-            return {
-              violations: [],
-              passes: [],
-              url: '',
-              timestamp: new Date().toString(),
-              errorMessage: err.message
-            };
-          }
-        JS
-        page.execute_script_fixed script, @context
-      end
-
-      def get_selenium(page)
-        page = page.driver if page.respond_to?("driver")
-        page = page.browser if page.respond_to?("browser") and not page.browser.is_a?(::Symbol)
-        page
+        yield page.execute_async_script "#{METHOD_NAME}.apply(#{Core::JS_NAME}, arguments)", *js_args
       end
 
       def js_args
         [@context, @options]
-          .map(&:to_h)
+          .reject(&:empty?)
+          .map(&:to_json)
       end
 
       def to_js

data/lib/axe/configuration.rb

@@ -14,8 +14,7 @@ module Axe
     attr_writer :jslib
     attr_accessor :page,
                   :jslib_path,
-                  :skip_iframes,
-                  :legacy_mode
+                  :skip_iframes
     def_delegators ::WebDriverScriptAdapter,
                    :async_results_identifier,
                    :async_results_identifier=,

data/lib/axe/core.rb

@@ -14,36 +14,13 @@ module Axe
     end
 
     def call(callable)
-      if use_run_partial
-        callable.analyze_post_43x @page, self
-      else
-        callable.call @page
-      end
-    end
-
-    def call_verbatim(callable)
-      callable.call @page
+      callable.call(@page)
     end
 
     private
 
-    def use_run_partial
-      has_run_partial? and not Axe::Configuration.instance.legacy_mode
-    end
-
     def load_axe_core(source)
-      return if already_loaded?
-      loader = Common::Loader.new(@page, self)
-      loader.load_top_level source
-      return if use_run_partial
-
-      loader.call source
-    end
-
-    def has_run_partial?
-      @page.evaluate_script <<-JS
-          typeof window.axe.runPartial === 'function'
-      JS
+      Common::Loader.new(@page, self).call(source) unless already_loaded?
     end
 
     def already_loaded?

data/lib/loader.rb

@@ -6,33 +6,20 @@ module Common
     def initialize(page, lib)
       @page = page
       @lib = lib
-      @loaded_top_level = false
     end
 
-    def load_top_level(source)
+    def call(source)
       @page.execute_script source
-      @loaded_top_level = true
-      Common::Hooks.run_after_load @lib
-    end
-
-    def call(source, is_top_level = true)
-      @page.execute_script source unless (@loaded_top_level and is_top_level)
-      set_allowed_origins
+      @page.execute_script "axe.configure({ allowedOrigins: ['<unsafe_all_origins>'] });"
       Common::Hooks.run_after_load @lib
       load_into_iframes(source) unless Axe::Configuration.instance.skip_iframes
     end
 
     private
 
-    def set_allowed_origins
-      allowed_origins = "<unsafe_all_origins>"
-      allowed_origins = "<same_origin>" if Axe::Configuration.instance.legacy_mode
-      @page.execute_script "axe.configure({ allowedOrigins: ['#{allowed_origins}'] });"
-    end
-
     def load_into_iframes(source)
       @page.find_frames.each do |iframe|
-        @page.within_frame(iframe) { call source, false }
+        @page.within_frame(iframe) { call source }
       end
     end
   end

data/lib/webdriver_script_adapter/exec_eval_script_adapter.rb

@@ -8,7 +8,7 @@ module WebDriverScriptAdapter
     def self.wrap(driver)
       raise WebDriverError, "WebDriver must respond to #execute_script" unless driver.respond_to? :execute_script
 
-      driver.respond_to?(:evaluate_script) ? ExecEvalScriptAdapter2.new(driver) : new(driver)
+      driver.respond_to?(:evaluate_script) ? driver : new(driver)
     end
 
     # executes script without returning result
@@ -21,19 +21,6 @@ module WebDriverScriptAdapter
     def evaluate_script(script)
       __getobj__.execute_script "return #{script}"
     end
-
-    def execute_script_fixed(script, *args)
-      page = __getobj__
-      page.execute_script(script, *args)
-    end
-  end
-  class ExecEvalScriptAdapter2 < ::DumbDelegator
-    def execute_script_fixed(script, *args)
-      page = __getobj__
-      page = page.driver if page.respond_to?("driver")
-      page = page.browser if page.respond_to?("browser") and not page.browser.is_a?(::Symbol)
-      page.execute_script(script, *args)
-    end
   end
 
   class WebDriverError < TypeError; end

data/lib/webdriver_script_adapter/execute_async_script_adapter.rb

@@ -3,11 +3,6 @@ require "securerandom"
 require "timeout"
 require_relative "./exec_eval_script_adapter"
 
-def get_selenium(page)
-  page = page.driver if page.respond_to?("driver")
-  page = page.browser if page.respond_to?("browser") and not page.browser.is_a?(Symbol)
-  page
-end
 module WebDriverScriptAdapter
   class << self
     attr_accessor :async_results_identifier,
@@ -81,7 +76,7 @@ module WebDriverScriptAdapter
 
   class ExecuteAsyncScriptAdapter < ::DumbDelegator
     def self.wrap(driver)
-      new driver
+      new ExecEvalScriptAdapter.wrap driver
     end
 
     def execute_async_script(script, *args)
@@ -89,13 +84,6 @@ module WebDriverScriptAdapter
       execute_script ScriptWriter.async_wrapper(script, *args, ScriptWriter.callback(results))
       Patiently.wait_until { evaluate_script results }
     end
-
-    def execute_async_script_fixed(script, *args)
-      page = __getobj__
-      page = page.driver if page.respond_to?("driver")
-      page = page.browser if page.respond_to?("browser") and not page.browser.is_a?(::Symbol)
-      page.execute_async_script(script, *args)
-    end
   end
 
   configure do |c|