axe-core-cucumber 2.6.1.pre.acca0cb → 4.0.0.pre.7ce7a3d

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +27 -25
  3. data/lib/{axe-core-cucumber-step-definitions.rb → axe-cucumber-steps.rb} +1 -1
  4. data/lib/{axe-core-cucumber.rb → axe-cucumber.rb} +4 -4
  5. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ce2105a49eab17b6edfffc52ce2c75de4a6a04a635716a4916a4c82ac89269e3
4
- data.tar.gz: dca09640bc1520c151636418f2ae44a5818af969f80673db0680d8e5fa475c74
3
+ metadata.gz: 26e166c1966eab6cdfba59ad8df8294cfdd8badca565cf8802583e7b20c83aff
4
+ data.tar.gz: b1087a9f2c7ff2ecea68f5b29d0a1e40c4321ac4379e58e4eb8e06f9bd2fb6f0
5
5
  SHA512:
6
- metadata.gz: 922397cce05e53e8a401159daf0016104f1bb1f782cff91265a86a49bfc4841e586588b208e2108a113b2643561444b4e815b7a213ef8ac83d8014619cc1494d
7
- data.tar.gz: 2ce5896e3280f9a8127dd4d451a48a3cafac02e63bb42f4e6322732710a9e3bb20e265a132d3fa8a428c3cbc0b87c5e2d18f3074195122c0262f35216fcb8326
6
+ metadata.gz: 04dcfb23c4f894da3524620eb9d8999eeef9cf83fcf633f298043c513fbdd68ad0dfd72c85d3eaf4f138b0e123c5e710b418a8e0553337d371e04a35dd124571
7
+ data.tar.gz: 4faf76aaf7fdd4a244783e147bdbf3d4ffda92e34d02875595c6b7308fec0b53a4c6c64b2689391fcfdfb7633dcb483748fd8d2d1a8b6b2629e06b04b31660b8
data/README.md CHANGED
@@ -3,33 +3,35 @@ The `axe-core-cucumber` gem provides a custom step defintions to evalaute the ac
3
3
 
4
4
  ## Usage
5
5
 
6
- 1. Install the required gem:
6
+ - In your Gemfile, add the `axe-core-cucumber` gem.
7
+
8
+ ```Gemfile
9
+ source "https://rubygems.org"
7
10
 
8
- ``` gemspec
9
11
  gem 'axe-core-cucumber'
10
12
  ```
11
13
 
12
- 2. Require the step defintions:
14
+ - Require `axe-cucumber-steps` to makes all of the axe-cucumber step definitions available to be used directly in your cucumber features.
13
15
 
14
16
  ``` rb
15
- require 'axe-core-cucumber-step-definitions'
17
+ require 'axe-cucumber-steps'
16
18
  ```
17
19
 
18
- 3. Use with webdriver of choice.
20
+ - Use with webdriver of choice.
19
21
 
20
22
  ## Cucumber Steps
21
23
 
22
24
  ### Base Step
23
25
 
24
- 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).
25
27
 
26
28
  ```gherkin
27
- Then the page should be accessible
29
+ Then the page should be axe clean
28
30
  ```
29
31
 
30
32
  #### Clauses
31
33
 
32
- 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.
33
35
 
34
36
  ##### `within` - Inclusion clause
35
37
 
@@ -37,7 +39,7 @@ The inclusion clause ( `within "#selector"` ) specifies which elements of the pa
37
39
  *see additional [context parameter documentation][context-param]*
38
40
 
39
41
  ``` gherkin
40
- Then the page should be accessible within "#selector"
42
+ Then the page should be axe clean within "#selector"
41
43
  ```
42
44
 
43
45
  ##### `excluding` - Exclusion clause
@@ -46,14 +48,14 @@ The exclusion clause ( `excluding "#selector"` ) specifies which elements of the
46
48
  *see additional [context parameter documentation][context-param]*
47
49
 
48
50
  ``` gherkin
49
- Then the page should be accessible excluding "#selector"
51
+ Then the page should be axe clean excluding "#selector"
50
52
  ```
51
53
 
52
54
  If desired, a semicolon ( `;` ) or the word `but` may be used to separate the exclusion clause from the inclusion clause (if present).
53
55
 
54
56
  ``` gherkin
55
- Then the page should be accessible within "main"; excluding "aside"
56
- 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"
57
59
  ```
58
60
 
59
61
  ##### `according to` - Accessibility Standard (Tag) clause
@@ -62,13 +64,13 @@ The tag clause specifies which accessibility standard (or standards) should be u
62
64
  The acceptable [tag names are documented][options-param] as well as a [complete listing of rules][rules] that correspond to each tag.
63
65
 
64
66
  ``` gherkin
65
- Then the page should be accessible according to: tag-name
67
+ Then the page should be axe clean according to: tag-name
66
68
  ```
67
69
 
68
70
  If desired, a semicolon ( `;` ) may be used to separate the tag clause from the preceding clause.
69
71
 
70
72
  ``` gherkin
71
- 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
72
74
  ```
73
75
 
74
76
  ##### `checking` - Checking Rules clause
@@ -76,7 +78,7 @@ Then the page should be accessible within "#header"; according to: best-practice
76
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.
77
79
 
78
80
  ``` gherkin
79
- Then the page should be accessible checking: ruleId
81
+ Then the page should be axe clean checking: ruleId
80
82
  ```
81
83
 
82
84
  *see [rules documentation][rules] for a list of valid rule IDs*
@@ -84,8 +86,8 @@ Then the page should be accessible checking: ruleId
84
86
  If desired, a semicolon ( `;` ) or the word `and` may be used to separate the checking-rules clause from the preceding clause.
85
87
 
86
88
  ``` gherkin
87
- Then the page should be accessible according to: wcag2a; checking: color-contrast
88
- 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
89
91
  ```
90
92
 
91
93
  ##### `checking only` - Exclusive Rules clause
@@ -93,7 +95,7 @@ Then the page should be accessible according to: wcag2a and checking: color-cont
93
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.
94
96
 
95
97
  ``` gherkin
96
- Then the page should be accessible checking only: ruleId
98
+ Then the page should be axe clean checking only: ruleId
97
99
  ```
98
100
 
99
101
  ##### `skipping` - Skipping Rules clause
@@ -101,7 +103,7 @@ Then the page should be accessible checking only: ruleId
101
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.
102
104
 
103
105
  ``` gherkin
104
- Then the page should be accessible skipping: ruleId
106
+ Then the page should be axe clean skipping: ruleId
105
107
  ```
106
108
 
107
109
  *see [rules documentation][rules] for a list of valid rule IDs*
@@ -109,8 +111,8 @@ Then the page should be accessible skipping: ruleId
109
111
  If desired, a semicolon ( `;` ) or the word `but` may be used to separate the skipping-rules clause from the preceding clause.
110
112
 
111
113
  ``` gherkin
112
- Then the page should be accessible according to: wcag2a; skipping: accesskeys
113
- 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
114
116
  ```
115
117
 
116
118
  ##### Interoperability between clauses
@@ -118,13 +120,13 @@ Then the page should be accessible according to: wcag2a but skipping: accesskeys
118
120
  All of the described clauses may be mixed and matched with method chaining. Below are some examples.
119
121
 
120
122
  ``` gherkin
121
- 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"
122
124
 
123
- 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
124
126
 
125
- Then the page should be accessible checking only: document-title, label
127
+ Then the page should be axe clean checking only: document-title, label
126
128
 
127
- 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
128
130
  ```
129
131
 
130
132
  [inclusion-clause]: #inclusion-clause
data/lib/{axe-core-cucumber-step-definitions.rb → axe-cucumber-steps.rb} RENAMED
@@ -1,3 +1,3 @@
1
- require_relative "./axe-core-cucumber"
1
+ require_relative "./axe-cucumber"
2
2
 
3
3
  Then AxeCucumber::Step::REGEX, :assert_accessibility, on: -> { AxeCucumber::Step.create_for self }
data/lib/{axe-core-cucumber.rb → axe-cucumber.rb} RENAMED
@@ -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,14 +1,14 @@
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.acca0cb
4
+ version: 4.0.0.pre.7ce7a3d
5
5
  platform: ruby
6
6
  authors:
7
7
  - Deque Systems
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-08-24 00:00:00.000000000 Z
11
+ date: 2020-10-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: dumb_delegator
@@ -131,8 +131,8 @@ extra_rdoc_files: []
131
131
  files:
132
132
  - LICENSE
133
133
  - README.md
134
- - lib/axe-core-cucumber-step-definitions.rb
135
- - lib/axe-core-cucumber.rb
134
+ - lib/axe-cucumber-steps.rb
135
+ - lib/axe-cucumber.rb
136
136
  homepage: https://www.deque.com
137
137
  licenses: []
138
138
  metadata: