axe-core-cucumber 2.6.1.pre.0f0b25b → 4.0.0.pre.a442c75

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -20
  3. data/lib/axe-cucumber.rb +4 -4
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 12c622105a18aa0c9cbdd6e80f451c96f47affc06a65a3c449028faed045e889
4
- data.tar.gz: f4ea28f8bd25cd74ec153cd215350ff73716f07a3043f52a4f944ee2dba84ad4
3
+ metadata.gz: 3bd8cedebfe6f40243f870e2618caf9618ded9d2080728d7f00ab4f2f91bd555
4
+ data.tar.gz: 06b5ec3944825ddd9fed8c4d73eefe4ff8e69d6a031070cd14f1d46ff3168d4e
5
5
  SHA512:
6
- metadata.gz: d9ed5c60dcb494caf603e3e17133903800e7b9c56a25f3aa8d63a4a6459b47a48ef525a4705024cda35c892d4101a0fc63ba394c68fc123d352a2fbe2035bf2b
7
- data.tar.gz: c93a94dc5456b6719f3e7e3be694c385cba0afda0edbfb0dee1fc66b48fd29875bc7ab6293aaac232d2a1b296efeb9a00d4992189780a76b18db33e573c30c7d
6
+ metadata.gz: f53adb6a3f383a91716bad9e6a6ab93ca192f994de5c6193f088020c0b0ad03c7e247c0a1c4ffdc40918d1d5477d9874d5d0342ac67aba49db9587441d83973f
7
+ data.tar.gz: 7ee15b746694396aac30c21e230cea3e1120efdfd6a31a9866c28f02d831ee38df8e4d56ae74c1a78ebcf808c2046787e4da02f42f81613bc3308d341448df0e
data/README.md CHANGED
@@ -23,15 +23,15 @@ require 'axe-cucumber-steps'
23
23
 
24
24
  ### Base Step
25
25
 
26
- The base step `be accessible` is the core component of the step. It is a complete step on its own and will verify the currently loaded page is accessible using the default configuration of [axe.run][axe-run] (the entire document is checked using the default rules).
26
+ The base step `be axe clean` is the core component of the step. It is a complete step on its own and will verify the currently loaded page is axe clean using the default configuration of [axe.run][axe-run] (the entire document is checked using the default rules).
27
27
 
28
28
  ```gherkin
29
- Then the page should be accessible
29
+ Then the page should be axe clean
30
30
  ```
31
31
 
32
32
  #### Clauses
33
33
 
34
- Clauses are chainable methods for the `be accessible` custom step.Configurable clauses allows for greater granularity with testing and expectaions.
34
+ Clauses are chainable methods for the `be axe clean` custom step.Configurable clauses allows for greater granularity with testing and expectaions.
35
35
 
36
36
  ##### `within` - Inclusion clause
37
37
 
@@ -39,7 +39,7 @@ The inclusion clause ( `within "#selector"` ) specifies which elements of the pa
39
39
  *see additional [context parameter documentation][context-param]*
40
40
 
41
41
  ``` gherkin
42
- Then the page should be accessible within "#selector"
42
+ Then the page should be axe clean within "#selector"
43
43
  ```
44
44
 
45
45
  ##### `excluding` - Exclusion clause
@@ -48,14 +48,14 @@ The exclusion clause ( `excluding "#selector"` ) specifies which elements of the
48
48
  *see additional [context parameter documentation][context-param]*
49
49
 
50
50
  ``` gherkin
51
- Then the page should be accessible excluding "#selector"
51
+ Then the page should be axe clean excluding "#selector"
52
52
  ```
53
53
 
54
54
  If desired, a semicolon ( `;` ) or the word `but` may be used to separate the exclusion clause from the inclusion clause (if present).
55
55
 
56
56
  ``` gherkin
57
- Then the page should be accessible within "main"; excluding "aside"
58
- Then the page should be accessible within "main" but excluding "aside"
57
+ Then the page should be axe clean within "main"; excluding "aside"
58
+ Then the page should be axe clean within "main" but excluding "aside"
59
59
  ```
60
60
 
61
61
  ##### `according to` - Accessibility Standard (Tag) clause
@@ -64,13 +64,13 @@ The tag clause specifies which accessibility standard (or standards) should be u
64
64
  The acceptable [tag names are documented][options-param] as well as a [complete listing of rules][rules] that correspond to each tag.
65
65
 
66
66
  ``` gherkin
67
- Then the page should be accessible according to: tag-name
67
+ Then the page should be axe clean according to: tag-name
68
68
  ```
69
69
 
70
70
  If desired, a semicolon ( `;` ) may be used to separate the tag clause from the preceding clause.
71
71
 
72
72
  ``` gherkin
73
- Then the page should be accessible within "#header"; according to: best-practice
73
+ Then the page should be axe clean within "#header"; according to: best-practice
74
74
  ```
75
75
 
76
76
  ##### `checking` - Checking Rules clause
@@ -78,7 +78,7 @@ Then the page should be accessible within "#header"; according to: best-practice
78
78
  The checking-rules clause specifies which *additional* rules to run (in addition to the specified tags, if any, or the default ruleset). The rules are specified by comma-separated rule IDs.
79
79
 
80
80
  ``` gherkin
81
- Then the page should be accessible checking: ruleId
81
+ Then the page should be axe clean checking: ruleId
82
82
  ```
83
83
 
84
84
  *see [rules documentation][rules] for a list of valid rule IDs*
@@ -86,8 +86,8 @@ Then the page should be accessible checking: ruleId
86
86
  If desired, a semicolon ( `;` ) or the word `and` may be used to separate the checking-rules clause from the preceding clause.
87
87
 
88
88
  ``` gherkin
89
- Then the page should be accessible according to: wcag2a; checking: color-contrast
90
- Then the page should be accessible according to: wcag2a and checking: color-contrast
89
+ Then the page should be axe clean according to: wcag2a; checking: color-contrast
90
+ Then the page should be axe clean according to: wcag2a and checking: color-contrast
91
91
  ```
92
92
 
93
93
  ##### `checking only` - Exclusive Rules clause
@@ -95,7 +95,7 @@ Then the page should be accessible according to: wcag2a and checking: color-cont
95
95
  This clause is not really a separate clause. But rather, by adding the word `only` to the checking-rules clause, the meaning of the step can be changed. As described above, by default the checking-rules clause specifies *additional* rules to run. If the word `only` is used, then *only* the specified rules are checked.
96
96
 
97
97
  ``` gherkin
98
- Then the page should be accessible checking only: ruleId
98
+ Then the page should be axe clean checking only: ruleId
99
99
  ```
100
100
 
101
101
  ##### `skipping` - Skipping Rules clause
@@ -103,7 +103,7 @@ Then the page should be accessible checking only: ruleId
103
103
  The skipping-rules clause specifies which rules to skip. This allows an accessibility standard to be provided (via the tag clause) while ignoring a particular rule. The rules are specified by comma-separated rule IDs.
104
104
 
105
105
  ``` gherkin
106
- Then the page should be accessible skipping: ruleId
106
+ Then the page should be axe clean skipping: ruleId
107
107
  ```
108
108
 
109
109
  *see [rules documentation][rules] for a list of valid rule IDs*
@@ -111,8 +111,8 @@ Then the page should be accessible skipping: ruleId
111
111
  If desired, a semicolon ( `;` ) or the word `but` may be used to separate the skipping-rules clause from the preceding clause.
112
112
 
113
113
  ``` gherkin
114
- Then the page should be accessible according to: wcag2a; skipping: accesskeys
115
- Then the page should be accessible according to: wcag2a but skipping: accesskeys
114
+ Then the page should be axe clean according to: wcag2a; skipping: accesskeys
115
+ Then the page should be axe clean according to: wcag2a but skipping: accesskeys
116
116
  ```
117
117
 
118
118
  ##### Interoperability between clauses
@@ -120,13 +120,13 @@ Then the page should be accessible according to: wcag2a but skipping: accesskeys
120
120
  All of the described clauses may be mixed and matched with method chaining. Below are some examples.
121
121
 
122
122
  ``` gherkin
123
- Then the page should be accessible within "main, header" but excluding "footer"
123
+ Then the page should be axe clean within "main, header" but excluding "footer"
124
124
 
125
- Then the page should be accessible excluding "#sidebar" according to: wcag2a, wcag2aa but skipping: color-contrast
125
+ Then the page should be axe clean excluding "#sidebar" according to: wcag2a, wcag2aa but skipping: color-contrast
126
126
 
127
- Then the page should be accessible checking only: document-title, label
127
+ Then the page should be axe clean checking only: document-title, label
128
128
 
129
- Then the page should be accessible according to: best-practice and checking: aria-roles, definition-list
129
+ Then the page should be axe clean according to: best-practice and checking: aria-roles, definition-list
130
130
  ```
131
131
 
132
132
  [inclusion-clause]: #inclusion-clause
data/lib/axe-cucumber.rb CHANGED
@@ -1,6 +1,6 @@
1
1
  require "yaml"
2
2
 
3
- require "axe/matchers/be_accessible"
3
+ require "axe/matchers/be_axe_clean"
4
4
  require "axe/finds_page"
5
5
  require "axe/expectation"
6
6
 
@@ -16,7 +16,7 @@ module AxeCucumber
16
16
  # Extracting regex into variable to allow for easier consumption elsewhere
17
17
  ###############
18
18
  # require initial phrasing, with 'not' to negate the matcher
19
- REGEX_CAPTURE_NEGATE = "(?-x:the page should( not)? be accessible)"
19
+ REGEX_CAPTURE_NEGATE = "(?-x:the page should( not)? be axe clean)"
20
20
  # optionally specify which subtree to check, via CSS selector
21
21
  REGEX_CAPTURE_INCLUSION = '(?-x:;? within "(.*?)")?'
22
22
  # optionally specify subtrees to be excluded, via CSS selector
@@ -52,7 +52,7 @@ module AxeCucumber
52
52
  skip_rules = "",
53
53
  options = nil
54
54
  )
55
- is_accessible = Axe::Matchers::BeAccessible.new.tap do |a|
55
+ is_axe_clean = Axe::Matchers::BeAxeClean.new.tap do |a|
56
56
  a.within(*selector(inclusion))
57
57
  a.excluding(*selector(exclusion))
58
58
  a.according_to(*split(tags))
@@ -62,7 +62,7 @@ module AxeCucumber
62
62
  a.with_options to_hash(options)
63
63
  end
64
64
 
65
- Axe::AccessibilityExpectation.create(negate).assert @page, is_accessible
65
+ Axe::AccessibilityExpectation.create(negate).assert @page, is_axe_clean
66
66
  end
67
67
 
68
68
  private
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: axe-core-cucumber
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.6.1.pre.0f0b25b
4
+ version: 4.0.0.pre.a442c75
5
5
  platform: ruby
6
6
  authors:
7
7
  - Deque Systems