way_of_working-inclusive_language-alex 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/README.md +13 -7
- data/code_safety.yml +36 -24
- data/lib/way_of_working/inclusive_language/alex/github_audit_rule.rb +5 -6
- data/lib/way_of_working/inclusive_language/alex/version.rb +1 -1
- data/lib/way_of_working/inclusive_language/alex.rb +5 -7
- data/way_of_working-inclusive_language-alex.gemspec +2 -3
- metadata +19 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f2e62c5906db400c8bc2709d30e7d4e62d23a793725ac7e349bcf75bd9a18820
|
4
|
+
data.tar.gz: 19117945d53705b40f6c5c29dad6ad422818827372cffe73e34f340676f8a703
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 646c97f8ecae9b7c5b86cd825ac96887166580df03b7162da29debe059bccd63dfa3262738c3661d9d7470b41933536dbd3039dec6219cb9e3bac42675fce9f8
|
7
|
+
data.tar.gz: 312e2c5b18a7bdc48390a842b3be67663ecfd00e20788be1426d4e668f9e6a4bb0d99126f49913c6465017c487950e630ac4bec29d74e06e629fc7ee19718568
|
data/CHANGELOG.md
CHANGED
@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
7
7
|
|
8
8
|
## [Unreleased]
|
9
9
|
|
10
|
+
## [1.0.1] - 2025-01-22
|
11
|
+
|
12
|
+
### Fixed
|
13
|
+
|
14
|
+
- Fixed Zeitwerk eager loading
|
15
|
+
- Fixed the GitHub audit rule registration and signature
|
16
|
+
- Fixed stale Megalinter workflow action
|
17
|
+
- Fixed project root path
|
18
|
+
- Linted YAML files
|
19
|
+
|
20
|
+
### Security
|
21
|
+
|
22
|
+
- Bumped minimum patch versions of dependencies to avoid known vulnerabilities
|
23
|
+
|
24
|
+
## [1.0.0] - 2024-10-24
|
25
|
+
|
10
26
|
### Added
|
11
27
|
|
12
28
|
- Added alex inclusive language testing
|
29
|
+
|
30
|
+
[Unreleased]: https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex/compare/v1.0.1...HEAD
|
31
|
+
[1.0.1]: https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex/compare/v1.0.0...v1.0.0
|
32
|
+
[1.0.0]: https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex/releases/tag/v1.0.0
|
data/README.md
CHANGED
@@ -1,8 +1,12 @@
|
|
1
1
|
# WayOfWorking::InclusiveLanguage::Alex
|
2
2
|
|
3
|
-
<!--
|
4
|
-
|
5
|
-
<!--
|
3
|
+
<!-- Way of Working: Main Badge Holder Start -->
|
4
|
+
![Way of Working Badge](https://img.shields.io/badge/Way_of_Working-v2.0.1-%238169e3?labelColor=black)
|
5
|
+
<!-- Way of Working: Additional Badge Holder Start -->
|
6
|
+
<!-- Way of Working: Badge Holder End -->
|
7
|
+
|
8
|
+
[![Gem Version](https://badge.fury.io/rb/way_of_working-inclusive_language-alex.svg)](https://badge.fury.io/rb/way_of_working-inclusive_language-alex)
|
9
|
+
<br />
|
6
10
|
|
7
11
|
Using insensitive and inconsiderate language can cause harm to others, create barriers to communication, and damage relationships. It can make people feel excluded, disrespected, and devalued and may perpetuate negative stereotypes and biases. When we use insensitive or offensive language, we undermine our ability to connect with others and build trust.
|
8
12
|
|
@@ -12,15 +16,17 @@ This is a plugin for the [Way of Working](https://github.com/HealthDataInsight/w
|
|
12
16
|
|
13
17
|
## Installation
|
14
18
|
|
15
|
-
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
|
16
|
-
|
17
19
|
Install the gem and add to the application's Gemfile by executing:
|
18
20
|
|
19
|
-
|
21
|
+
```bash
|
22
|
+
bundle add way_of_working-inclusive_language-alex
|
23
|
+
```
|
20
24
|
|
21
25
|
If bundler is not being used to manage dependencies, install the gem by executing:
|
22
26
|
|
23
|
-
|
27
|
+
```bash
|
28
|
+
gem install way_of_working-inclusive_language-alex
|
29
|
+
```
|
24
30
|
|
25
31
|
## Usage
|
26
32
|
|
data/code_safety.yml
CHANGED
@@ -18,12 +18,12 @@ file safety:
|
|
18
18
|
safe_revision: 321bc80b15da3c679252c5a507115396d9fcbd25
|
19
19
|
".github/workflows/main.yml":
|
20
20
|
comments:
|
21
|
-
reviewed_by:
|
22
|
-
safe_revision:
|
21
|
+
reviewed_by: shilpigoeldev
|
22
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
23
23
|
".github/workflows/mega-linter.yml":
|
24
24
|
comments:
|
25
|
-
reviewed_by:
|
26
|
-
safe_revision:
|
25
|
+
reviewed_by: shilpigoeldev
|
26
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
27
27
|
".gitignore":
|
28
28
|
comments:
|
29
29
|
reviewed_by: timgentry
|
@@ -38,28 +38,28 @@ file safety:
|
|
38
38
|
safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
|
39
39
|
CHANGELOG.md:
|
40
40
|
comments:
|
41
|
-
reviewed_by:
|
42
|
-
safe_revision:
|
41
|
+
reviewed_by: shilpigoeldev
|
42
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
43
43
|
CODE_OF_CONDUCT.md:
|
44
44
|
comments:
|
45
45
|
reviewed_by: timgentry
|
46
46
|
safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
|
47
47
|
Gemfile:
|
48
48
|
comments:
|
49
|
-
reviewed_by:
|
50
|
-
safe_revision:
|
49
|
+
reviewed_by: shilpigoeldev
|
50
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
51
51
|
Gemfile.lock:
|
52
52
|
comments:
|
53
|
-
reviewed_by:
|
54
|
-
safe_revision:
|
53
|
+
reviewed_by: shilpigoeldev
|
54
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
55
55
|
LICENSE.txt:
|
56
56
|
comments:
|
57
57
|
reviewed_by: timgentry
|
58
58
|
safe_revision: 60dabfa968761af6f34984036e86dbcceb8dcfd0
|
59
59
|
README.md:
|
60
60
|
comments:
|
61
|
-
reviewed_by:
|
62
|
-
safe_revision:
|
61
|
+
reviewed_by: shilpigoeldev
|
62
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
63
63
|
Rakefile:
|
64
64
|
comments:
|
65
65
|
reviewed_by: shilpigoeldev
|
@@ -75,7 +75,7 @@ file safety:
|
|
75
75
|
lib/way_of_working/inclusive_language/alex.rb:
|
76
76
|
comments:
|
77
77
|
reviewed_by: shilpigoeldev
|
78
|
-
safe_revision:
|
78
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
79
79
|
lib/way_of_working/inclusive_language/alex/generators/exec.rb:
|
80
80
|
comments:
|
81
81
|
reviewed_by: shilpigoeldev
|
@@ -87,7 +87,7 @@ file safety:
|
|
87
87
|
lib/way_of_working/inclusive_language/alex/github_audit_rule.rb:
|
88
88
|
comments:
|
89
89
|
reviewed_by: shilpigoeldev
|
90
|
-
safe_revision:
|
90
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
91
91
|
lib/way_of_working/inclusive_language/alex/paths.rb:
|
92
92
|
comments:
|
93
93
|
reviewed_by: shilpigoeldev
|
@@ -115,24 +115,36 @@ file safety:
|
|
115
115
|
lib/way_of_working/inclusive_language/alex/version.rb:
|
116
116
|
comments:
|
117
117
|
reviewed_by: shilpigoeldev
|
118
|
-
safe_revision:
|
118
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
119
119
|
test/test_helper.rb:
|
120
120
|
comments:
|
121
121
|
reviewed_by: shilpigoeldev
|
122
122
|
safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
|
123
|
-
test/way_of_working/
|
123
|
+
test/way_of_working/audit_github_stub_classes.rb:
|
124
124
|
comments:
|
125
125
|
reviewed_by: shilpigoeldev
|
126
|
-
safe_revision:
|
127
|
-
test/way_of_working/inclusive_language/generators/exec_test.rb:
|
126
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
127
|
+
test/way_of_working/inclusive_language/alex/generators/exec_test.rb:
|
128
128
|
comments:
|
129
129
|
reviewed_by: shilpigoeldev
|
130
|
-
safe_revision:
|
131
|
-
test/way_of_working/inclusive_language/generators/init_test.rb:
|
130
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
131
|
+
test/way_of_working/inclusive_language/alex/generators/init_test.rb:
|
132
132
|
comments:
|
133
|
-
reviewed_by:
|
134
|
-
safe_revision:
|
133
|
+
reviewed_by: shilpigoeldev
|
134
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
135
|
+
test/way_of_working/inclusive_language/alex/github_audit_rule_test.rb:
|
136
|
+
comments:
|
137
|
+
reviewed_by: shilpigoeldev
|
138
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
139
|
+
test/way_of_working/inclusive_language/alex/zeitwerk_loader_test.rb:
|
140
|
+
comments:
|
141
|
+
reviewed_by: shilpigoeldev
|
142
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
143
|
+
test/way_of_working/inclusive_language/alex_test.rb:
|
144
|
+
comments:
|
145
|
+
reviewed_by: shilpigoeldev
|
146
|
+
safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
|
135
147
|
way_of_working-inclusive_language-alex.gemspec:
|
136
148
|
comments:
|
137
|
-
reviewed_by:
|
138
|
-
safe_revision:
|
149
|
+
reviewed_by: shilpigoeldev
|
150
|
+
safe_revision: d340a14df1545bacb5e851ba8687275992e41709
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
-
require 'way_of_working/
|
3
|
+
require 'way_of_working/audit/github/rules/base'
|
4
4
|
|
5
5
|
module WayOfWorking
|
6
6
|
module InclusiveLanguage
|
@@ -8,7 +8,7 @@ module WayOfWorking
|
|
8
8
|
module Alex
|
9
9
|
# This rule checks for the Inclusive Language workflow action and README badge.
|
10
10
|
class GithubAuditRule < ::WayOfWorking::Audit::Github::Rules::Base
|
11
|
-
def
|
11
|
+
def validate
|
12
12
|
response = @client.workflows(@repo_name)
|
13
13
|
|
14
14
|
unless response.workflows.map(&:name).include?('Inclusive Language')
|
@@ -18,8 +18,6 @@ module WayOfWorking
|
|
18
18
|
@errors << 'Default branch is named "master"' if @repo.default_branch == 'master'
|
19
19
|
|
20
20
|
@errors << 'No Inclusive Language README Badge' unless inclusive_language_badge?
|
21
|
-
|
22
|
-
@errors.empty? ? :passed : :failed
|
23
21
|
end
|
24
22
|
|
25
23
|
private
|
@@ -29,8 +27,9 @@ module WayOfWorking
|
|
29
27
|
end
|
30
28
|
end
|
31
29
|
|
32
|
-
::WayOfWorking::Audit::Github::Rules::Registry.register(
|
33
|
-
|
30
|
+
::WayOfWorking::Audit::Github::Rules::Registry.register(
|
31
|
+
GithubAuditRule, 'Inclusive Language GitHub Action and README badge'
|
32
|
+
)
|
34
33
|
end
|
35
34
|
end
|
36
35
|
end
|
@@ -5,13 +5,11 @@ require_relative 'alex/paths'
|
|
5
5
|
require 'zeitwerk'
|
6
6
|
|
7
7
|
# If way_of_working-audit-github is used we can add a rule
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
end
|
14
|
-
require_relative 'alex/github_audit_rule' if github_audit_used
|
8
|
+
begin
|
9
|
+
require 'way_of_working/audit/github/rules/registry'
|
10
|
+
require_relative 'alex/github_audit_rule'
|
11
|
+
rescue LoadError # rubocop:disable Lint/SuppressedException
|
12
|
+
end
|
15
13
|
|
16
14
|
loader = Zeitwerk::Loader.for_gem_extension(WayOfWorking::InclusiveLanguage)
|
17
15
|
loader.ignore("#{__dir__}/alex/plugin.rb")
|
@@ -32,9 +32,8 @@ Gem::Specification.new do |spec|
|
|
32
32
|
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
|
33
33
|
spec.require_paths = ['lib']
|
34
34
|
|
35
|
-
|
36
|
-
|
37
|
-
spec.add_dependency 'way_of_working', '~> 2.0'
|
35
|
+
spec.add_dependency 'way_of_working', '~> 2.0.1'
|
36
|
+
spec.add_dependency 'zeitwerk', '~> 2.6.18'
|
38
37
|
|
39
38
|
# For more information and examples about making a new gem, check out our
|
40
39
|
# guide at: https://bundler.io/guides/creating_gem.html
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: way_of_working-inclusive_language-alex
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Tim Gentry
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2025-01-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: way_of_working
|
@@ -16,14 +16,28 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version:
|
19
|
+
version: 2.0.1
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
24
|
- - "~>"
|
25
25
|
- !ruby/object:Gem::Version
|
26
|
-
version:
|
26
|
+
version: 2.0.1
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: zeitwerk
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 2.6.18
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 2.6.18
|
27
41
|
description:
|
28
42
|
email:
|
29
43
|
- 52189+timgentry@users.noreply.github.com
|
@@ -76,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
76
90
|
- !ruby/object:Gem::Version
|
77
91
|
version: '0'
|
78
92
|
requirements: []
|
79
|
-
rubygems_version: 3.5.
|
93
|
+
rubygems_version: 3.5.22
|
80
94
|
signing_key:
|
81
95
|
specification_version: 4
|
82
96
|
summary: Way of Working plugin for Inclusive Language using Alex
|