axe-cuprite 0.1.0

data/lib/axe/cuprite/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module AxeCuprite
+  # Version of the axe-cuprite gem itself.
+  VERSION = "0.1.0"
+
+  # Version of the axe-core engine vendored under lib/axe/cuprite/vendor/axe.min.js.
+  # Keep this in sync with the vendored file via `rake axe:update`.
+  AXE_CORE_VERSION = "4.12.0"
+end

data/lib/axe/cuprite.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "axe/cuprite/version"
+require "axe/cuprite/errors"
+require "axe/cuprite/configuration"
+require "axe/cuprite/results"
+require "axe/cuprite/injector"
+require "axe/cuprite/runner"
+
+# axe-cuprite drives the axe-core accessibility engine through Capybara's
+# driver-neutral JavaScript API, so it works with Cuprite (Ferrum/CDP) and any
+# other real-browser Capybara driver — without ever touching Selenium internals.
+#
+# Quick start:
+#
+#   require "axe/cuprite"
+#   require "axe/cuprite/rspec"   # in a spec_helper, to load the matchers
+#
+#   expect(page).to be_axe_clean.checking_only(:color_contrast)
+#
+module AxeCuprite
+  class << self
+    # The global configuration object. See AxeCuprite::Configuration.
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Configure axe-cuprite:
+    #
+    #   AxeCuprite.configure do |c|
+    #     c.timeout = 30
+    #     c.report_only = true
+    #   end
+    def configure
+      yield configuration if block_given?
+      configuration
+    end
+
+    # Reset configuration to defaults (mainly useful in tests).
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
+    # Path to the vendored axe-core JavaScript engine.
+    def axe_path
+      File.expand_path("cuprite/vendor/axe.min.js", __dir__)
+    end
+
+    # The cached source of the vendored axe-core engine.
+    def axe_source
+      @axe_source ||= File.read(axe_path)
+    end
+  end
+end

data/lib/axe-cuprite.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Convenience entry point so `require "axe-cuprite"` works.
+# The canonical require path is "axe/cuprite".
+require "axe/cuprite"

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: axe-cuprite
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abdullah Hashim
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: cuprite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: ferrum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: |
+  axe-cuprite runs the axe-core accessibility engine against pages rendered in
+  Capybara system/feature tests and exposes the results as RSpec matchers
+  (be_axe_clean / be_accessible). Unlike Deque's official axe-core-capybara gem,
+  it never touches Selenium-specific driver internals: axe is driven entirely
+  through Capybara's driver-neutral JavaScript API, so it works with Cuprite
+  (the Ferrum/CDP headless-Chrome driver) and any other real-browser driver.
+  The headline use case is catching WCAG color-contrast failures in CI.
+email:
+- abdullah@guidedrails.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/axe-cuprite.rb
+- lib/axe/cuprite.rb
+- lib/axe/cuprite/configuration.rb
+- lib/axe/cuprite/errors.rb
+- lib/axe/cuprite/injector.rb
+- lib/axe/cuprite/normalize.rb
+- lib/axe/cuprite/results.rb
+- lib/axe/cuprite/rspec.rb
+- lib/axe/cuprite/rspec/matchers.rb
+- lib/axe/cuprite/runner.rb
+- lib/axe/cuprite/tasks/axe.rake
+- lib/axe/cuprite/vendor/axe-core-LICENSE.txt
+- lib/axe/cuprite/vendor/axe.min.js
+- lib/axe/cuprite/version.rb
+homepage: https://github.com/Guided-Rails/axe-cuprite
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/Guided-Rails/axe-cuprite
+  changelog_uri: https://github.com/Guided-Rails/axe-cuprite/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Run axe-core accessibility tests in Capybara + Cuprite (CDP), no Selenium.
+test_files: []