way_of_working-inclusive_language-alex 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4cc57c1a43843e292dd345f897327d08b8e87c6d3449751aa92429327f95eb3
+  data.tar.gz: 57c2222badd862a9af214dfc160a3e6abebd682470b49502c64efb55cd15d9e3
+SHA512:
+  metadata.gz: 1c5e58dc0f7a700c5338cc1cf474e715a1bd18ca9b66141d8ccc779bd063a1d2a6b46981ccd4fdb262d916ef35b8a0d92d0b5ac6ab46698990cc3df1b613508b
+  data.tar.gz: d6675bceed02fb0647a785890a1bcf9503cdfa8ddd407f3475d8cb13aaa83cc1806b84f2e8c6baa9a26c2fa3454dd424f0fa7a76a8f8ae5dc84a745e81235593

data/.alexrc

@@ -0,0 +1,3 @@
+{
+  "profanitySureness": 1
+}

data/.mega-linter.yml

@@ -0,0 +1,129 @@
+---
+# Configuration file for MegaLinter
+# See all available variables at https://megalinter.io/configuration/ and in linters documentation
+
+APPLY_FIXES: none  # all, none, or list of linter keys
+ENABLE_LINTERS:  # If you use ENABLE_LINTERS variable, all other linters will be disabled by default
+  ### Languages
+  - BASH_EXEC  # in Super-Linter
+  - BASH_SHELLCHECK  # in Super-Linter
+  - BASH_SHFMT  # in Super-Linter
+  - C_CPPLINT
+  # - CLOJURE_CLJ_KONDO  # in Super-Linter
+  - COFFEE_COFFEELINT  # in Super-Linter
+  - CPP_CPPLINT  # in Super-Linter
+  - CSHARP_DOTNET_FORMAT  # in Super-Linter
+  - DART_DARTANALYZER  # in Super-Linter
+  - GO_GOLANGCI_LINT  # in Super-Linter
+  - GO_REVIVE
+  # - GROOVY_NPM_GROOVY_LINT  # in Super-Linter
+  - JAVA_CHECKSTYLE  # in Super-Linter
+  - JAVA_PMD
+  - JAVASCRIPT_ES  # in Super-Linter
+  # - JAVASCRIPT_PRETTIER
+  - JAVASCRIPT_STANDARD  # in Super-Linter
+  - JSX_ESLINT
+  - KOTLIN_KTLINT  # in Super-Linter
+  # - LUA_LUACHECK  # in Super-Linter
+  - MAKEFILE_CHECKMAKE
+  # - PERL_PERLCRITIC  # in Super-Linter
+  # - PHP_PHPCS  # in Super-Linter
+  # - PHP_PHPLINT  # in Super-Linter
+  # - PHP_PHPSTAN  # in Super-Linter
+  # - PHP_PSALM  # in Super-Linter
+  # - POWERSHELL_POWERSHELL
+  # - POWERSHELL_POWERSHELL_FORMATTER
+  - PYTHON_BANDIT
+  - PYTHON_BLACK  # in Super-Linter
+  - PYTHON_FLAKE8  # in Super-Linter
+  - PYTHON_ISORT  # in Super-Linter
+  - PYTHON_MYPY
+  - PYTHON_PYLINT  # in Super-Linter
+  - PYTHON_PYRIGHT
+  - R_LINTR  # in Super-Linter
+  # - RAKU_RAKU  # in Super-Linter
+  # - RUBY_RUBOCOP  # in Super-Linter
+  - RUST_CLIPPY  # in Super-Linter
+  # - SALESFORCE_SFDX_SCANNER_APEX
+  # - SALESFORCE_SFDX_SCANNER_AURA
+  # - SALESFORCE_SFDX_SCANNER_LWC
+  - SCALA_SCALAFIX
+  - SQL_SQL_LINT  # in Super-Linter
+  - SQL_SQLFLUFF  # in Super-Linter
+  - SQL_TSQLLINT
+  - SWIFT_SWIFTLINT
+  - TSX_ESLINT
+  - TYPESCRIPT_ES  # in Super-Linter
+  # - TYPESCRIPT_PRETTIER
+  - TYPESCRIPT_STANDARD  # in Super-Linter
+  # - VBDOTNET_DOTNET_FORMAT
+
+  ### Formats
+  # - CSS_SCSS_LINT  # Deprecated in favour of stylelint
+  - CSS_STYLELINT  # in Super-Linter
+  - ENV_DOTENV_LINTER  # in Super-Linter
+  # - GRAPHQL_GRAPHQL_SCHEMA_LINTER
+  # - HTML_DJLINT # Refuses to see config file
+  - HTML_HTMLHINT  # in Super-Linter
+  - JSON_ESLINT_PLUGIN_JSONC  # in Super-Linter
+  - JSON_JSONLINT
+  - JSON_NPM_PACKAGE_JSON_LINT
+  # - JSON_PRETTIER
+  - JSON_V8R
+  # - LATEX_CHKTEX  # in Super-Linter
+  - MARKDOWN_MARKDOWNLINT  # in Super-Linter
+  - MARKDOWN_MARKDOWN_LINK_CHECK
+  - MARKDOWN_MARKDOWN_TABLE_FORMATTER
+  - MARKDOWN_REMARK_LINT
+  # - PROTOBUF_PROTOLINT  # in Super-Linter
+  # - RST_RSTCHECK
+  # - RST_RSTFMT
+  # - RST_RST_LINT
+  - XML_XMLLINT  # in Super-Linter
+  # - YAML_PRETTIER
+  - YAML_V8R
+  - YAML_YAMLLINT  # in Super-Linter
+
+  ### Tooling
+  - ACTION_ACTIONLINT  # in Super-Linter
+  - ANSIBLE_ANSIBLE_LINT  # in Super-Linter
+  - ARM_ARM_TTK  # in Super-Linter
+  # - BICEP_BICEP_LINTER
+  - CLOUDFORMATION_CFN_LINT  # in Super-Linter
+  - DOCKERFILE_HADOLINT  # in Super-Linter
+  - EDITORCONFIG_EDITORCONFIG_CHECKER  # in Super-Linter
+  # - GHERKIN_GHERKIN_LINT  # in Super-Linter
+  - KUBERNETES_KUBECONFORM
+  - KUBERNETES_KUBEVAL  # in Super-Linter
+  - OPENAPI_SPECTRAL  # in Super-Linter
+  - PUPPET_PUPPET_LINT
+  # - SNAKEMAKE_LINT  # in Super-Linter
+  # - SNAKEMAKE_SNAKEFMT  # in Super-Linter
+  # - TEKTON_TEKTON_LINT  # in Super-Linter
+  - TERRAFORM_CHECKOV
+  - TERRAFORM_KICS
+  - TERRAFORM_TERRAFORM_FMT  # in Super-Linter
+  - TERRAFORM_TERRAGRUNT  # in Super-Linter
+  - TERRAFORM_TERRASCAN  # in Super-Linter
+  - TERRAFORM_TFLINT  # in Super-Linter
+
+  ### Code quality checkers
+  - COPYPASTE_JSCPD  # in Super-Linter
+  - REPOSITORY_CHECKOV
+  - REPOSITORY_DEVSKIM
+  - REPOSITORY_DUSTILOCK
+  - REPOSITORY_GITLEAKS  # in Super-Linter
+  - REPOSITORY_GIT_DIFF
+  - REPOSITORY_GOODCHECK
+  - REPOSITORY_SECRETLINT
+  - REPOSITORY_SEMGREP
+  - REPOSITORY_SYFT
+  - REPOSITORY_TRIVY
+  # - SPELL_CSPELL
+  - SPELL_MISSPELL
+  - SPELL_PROSELINT
+
+SHOW_ELAPSED_TIME: false
+FILEIO_REPORTER: false
+FAIL_IF_MISSING_LINTER_IN_FLAVOR: true
+# DISABLE_ERRORS: true # Uncomment if you want MegaLinter to detect errors but not block CI to pass

data/.rubocop

@@ -0,0 +1 @@
+--config .github/linters/rubocop_defaults.yml

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Added alex inclusive language testing

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+<!--alex disable sex sexual-->
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not only for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+<report.complaints@healthdatainsight.org.uk>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Health Data Insight
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# WayOfWorking::InclusiveLanguage::Alex
+
+<!-- HDI Way of Working: Badge Holder Start -->
+[![HDI Way of Working](https://img.shields.io/badge/HDI-Way%20of%20Working-8169e3?labelColor=000)](https://healthdatainsight.github.io/way_of_working/)
+<!-- HDI Way of Working: Badge Holder End -->
+
+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.
+
+Therefore, it is essential to be mindful of the impact of our words and to choose language that is respectful, inclusive, and considerate of others. Doing so can create a more welcoming and inclusive environment for everyone, fostering greater understanding, empathy, and cooperation.
+
+This is a plugin for the [Way of Working](https://github.com/HealthDataInsight/way_of_working) framework. It uses [alex](https://alexjs.com) for automated testing of inclusive language, both at the command line and as a GitHub workflow.
+
+## Installation
+
+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.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+To add [alex](https://alexjs.com) to your project, run the following at the command line:
+
+```bash
+way_of_working init inclusive_language
+```
+
+to run alex in your project, run:
+
+```bash
+way_of_working exec inclusive_language
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the WayOfWorking::InclusiveLanguage::Alex project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'way_of_working/tasks'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = false
+  t.warning = false
+end
+
+desc 'Run tests'
+task default: :test

data/code_safety.yml

@@ -0,0 +1,138 @@
+---
+file safety:
+  ".alexrc":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  ".github/linters/.markdown-link-check.json":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  ".github/linters/rubocop_defaults.yml":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  ".github/workflows/inclusive-language.yml":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 321bc80b15da3c679252c5a507115396d9fcbd25
+  ".github/workflows/main.yml":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  ".github/workflows/mega-linter.yml":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  ".gitignore":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  ".mega-linter.yml":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  ".rubocop":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  CHANGELOG.md:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  CODE_OF_CONDUCT.md:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  Gemfile:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 321bc80b15da3c679252c5a507115396d9fcbd25
+  Gemfile.lock:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 321bc80b15da3c679252c5a507115396d9fcbd25
+  LICENSE.txt:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 60dabfa968761af6f34984036e86dbcceb8dcfd0
+  README.md:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 321bc80b15da3c679252c5a507115396d9fcbd25
+  Rakefile:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  bin/console:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 60dabfa968761af6f34984036e86dbcceb8dcfd0
+  bin/setup:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 60dabfa968761af6f34984036e86dbcceb8dcfd0
+  lib/way_of_working/inclusive_language/alex.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 321bc80b15da3c679252c5a507115396d9fcbd25
+  lib/way_of_working/inclusive_language/alex/generators/exec.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  lib/way_of_working/inclusive_language/alex/generators/init.rb:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 321bc80b15da3c679252c5a507115396d9fcbd25
+  lib/way_of_working/inclusive_language/alex/github_audit_rule.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 321bc80b15da3c679252c5a507115396d9fcbd25
+  lib/way_of_working/inclusive_language/alex/paths.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  lib/way_of_working/inclusive_language/alex/plugin.rb:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 321bc80b15da3c679252c5a507115396d9fcbd25
+  lib/way_of_working/inclusive_language/alex/templates/.alexignore:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 321bc80b15da3c679252c5a507115396d9fcbd25
+  lib/way_of_working/inclusive_language/alex/templates/.alexrc:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  lib/way_of_working/inclusive_language/alex/templates/.github/workflows/inclusive-language.yml:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 321bc80b15da3c679252c5a507115396d9fcbd25
+  lib/way_of_working/inclusive_language/alex/templates/docs/way_of_working/inclusive-language.md:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  lib/way_of_working/inclusive_language/alex/version.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 60dabfa968761af6f34984036e86dbcceb8dcfd0
+  test/test_helper.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  test/way_of_working/inclusive_language/alex_test.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  test/way_of_working/inclusive_language/generators/exec_test.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: cbe4ccee99e97402a6b17a3453d80fde37311328
+  test/way_of_working/inclusive_language/generators/init_test.rb:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 321bc80b15da3c679252c5a507115396d9fcbd25
+  way_of_working-inclusive_language-alex.gemspec:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 321bc80b15da3c679252c5a507115396d9fcbd25

data/lib/way_of_working/inclusive_language/alex/generators/exec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'rainbow'
+
+module WayOfWorking
+  module InclusiveLanguage
+    module Alex
+      module Generators
+        # This generator runs the inclusive language tests
+        class Exec < Thor::Group
+          argument :path, type: :string, required: false, desc: 'Optional path of the file to test'
+
+          desc 'This runs the inclusive language tests on this project'
+
+          def run_first
+            @start_time = Time.now
+
+            say(Rainbow("Limiting tests to #{path}\n").yellow) if path
+          end
+
+          def prep_and_run_alex
+            command = ['npx', 'alex', '--why']
+            # Configure alex to only test a specific file or folder, if defined
+            command << path if path
+
+            say(Rainbow("\nRunning alex...").yellow)
+
+            @alex_ok = run_alex(command)
+          end
+
+          def run_last
+            say(Rainbow("\nTotal time taken: #{(Time.now - @start_time).to_i} seconds").yellow)
+
+            if @alex_ok
+              say(Rainbow("\nInclusive language tests succeeded!").green)
+            else
+              abort(Rainbow("\nInclusive language tests failed!").red)
+            end
+          end
+
+          private
+
+          def run_alex(arguments)
+            system(*arguments)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/inclusive_language/alex/generators/init.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module WayOfWorking
+  module InclusiveLanguage
+    module Alex
+      module Generators
+        # This generator adds the alexrc file
+        class Init < Thor::Group
+          include Thor::Actions
+
+          source_root ::WayOfWorking::InclusiveLanguage::Alex.source_root
+
+          def copy_inclusive_language_github_workflow_action
+            copy_file '.github/workflows/inclusive-language.yml'
+          end
+
+          def copy_alexignore_file
+            copy_file '.alexignore'
+          end
+
+          def copy_alexrc_file
+            copy_file '.alexrc'
+          end
+
+          def copy_way_of_working_documentation
+            copy_file 'docs/way_of_working/inclusive-language.md'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/inclusive_language/alex/github_audit_rule.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'way_of_working/github_audit/rules/base'
+
+module WayOfWorking
+  module InclusiveLanguage
+    # The namespace for plugin
+    module Alex
+      # This rule checks for the Inclusive Language workflow action and README badge.
+      class GithubAuditRule < ::WayOfWorking::Audit::Github::Rules::Base
+        def valid?
+          response = @client.workflows(@repo_name)
+
+          unless response.workflows.map(&:name).include?('Inclusive Language')
+            @errors << 'No Inclusive Language GitHub Action'
+          end
+
+          @errors << 'Default branch is named "master"' if @repo.default_branch == 'master'
+
+          @errors << 'No Inclusive Language README Badge' unless inclusive_language_badge?
+
+          @errors.empty? ? :passed : :failed
+        end
+
+        private
+
+        def inclusive_language_badge?
+          readme_content.include?("[![Inclusive Language](https://github.com/#{@repo_name}/actions/workflows/inclusive-language.yml/badge.svg)]")
+        end
+      end
+
+      ::WayOfWorking::Audit::Github::Rules::Registry.register(GithubActionAndBadge,
+                        'Inclusive Language GitHub Action and README badge')
+    end
+  end
+end

data/lib/way_of_working/inclusive_language/alex/paths.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module WayOfWorking
+  module InclusiveLanguage
+    # Mixin that provides a couple of pathname convenience methods
+    module Alex
+      class << self
+        def root
+          Pathname.new(File.expand_path('../../../..', __dir__))
+        end
+
+        def source_root
+          root.join('lib', 'way_of_working', 'inclusive_language', 'alex', 'templates')
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/inclusive_language/alex/plugin.rb

@@ -0,0 +1 @@
+require 'way_of_working/inclusive_language/alex'

data/lib/way_of_working/inclusive_language/alex/templates/.alexignore

@@ -0,0 +1,2 @@
+/CODE_OF_CONDUCT.md
+/docs/way_of_working/code-of-conduct.md

data/lib/way_of_working/inclusive_language/alex/templates/.alexrc

@@ -0,0 +1,3 @@
+{
+  "profanitySureness": 1
+}

data/lib/way_of_working/inclusive_language/alex/templates/.github/workflows/inclusive-language.yml

@@ -0,0 +1,17 @@
+---
+name: "Inclusive Language"
+on: push  # yamllint disable-line rule:truthy
+
+permissions: read-all
+
+jobs:
+  test_inclusivity:
+    name: Inclusive Language Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Run alex
+        run: npx alex --why

data/lib/way_of_working/inclusive_language/alex/templates/docs/way_of_working/inclusive-language.md

@@ -0,0 +1,28 @@
+---
+layout: page
+---
+
+# Inclusive Language
+
+We have adopted [alex](https://alexjs.com) for automated testing of inclusive language.
+
+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.
+
+Therefore, it is essential to be mindful of the impact of our words and to choose language that is respectful, inclusive, and considerate of others. Doing so can create a more welcoming and inclusive environment for everyone, fostering greater understanding, empathy, and cooperation.
+
+To quote from the alex README:
+
+> No automated tool can replace studying inclusive communication and listening to the lived experiences of others. **An error from alex can be an invitation to learn more**.
+
+{: .important }
+Please take the opportunity to read some of the [further reading](https://github.com/get-alex/alex#further-reading) they reference and click on the links against individual warnings when they appear.
+
+## Usage
+
+To add alex to your project, run the following at the command line:
+
+    way_of_working init inclusive_language
+
+to run alex in your project, run:
+
+    way_of_working exec inclusive_language

data/lib/way_of_working/inclusive_language/alex/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module WayOfWorking
+  module InclusiveLanguage
+    module Alex
+      VERSION = '1.0.0'
+    end
+  end
+end

data/lib/way_of_working/inclusive_language/alex.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'way_of_working'
+require_relative 'alex/paths'
+require 'zeitwerk'
+
+# If way_of_working-audit-github is used we can add a rule
+github_audit_used =
+  begin
+    require 'way_of_working/audit/github/rules/registry'
+  rescue LoadError
+    false
+  end
+require_relative 'alex/github_audit_rule' if github_audit_used
+
+loader = Zeitwerk::Loader.for_gem_extension(WayOfWorking::InclusiveLanguage)
+loader.ignore("#{__dir__}/alex/plugin.rb")
+loader.setup
+
+module WayOfWorking
+  module InclusiveLanguage
+    module Alex
+      class Error < StandardError; end
+    end
+  end
+
+  module SubCommands
+    # This reopens the "way_of_working exec" (i.e. run) sub command
+    class Exec
+      register(InclusiveLanguage::Alex::Generators::Exec, 'inclusive_language', 'inclusive_language',
+               <<~LONGDESC)
+                 Description:
+                     This runs inclusive language tests on this project
+
+                 Example:
+                     way_of_working exec inclusive_language
+               LONGDESC
+    end
+
+    # This reopens the "way_of_working init" sub command
+    class Init
+      register(InclusiveLanguage::Alex::Generators::Init, 'inclusive_language', 'inclusive_language',
+               <<~LONGDESC)
+                 Description:
+                     Installs alex config file into the project
+
+                 Example:
+                     way_of_working init inclusive_language
+
+                     This will create:
+                         .alexrc
+               LONGDESC
+    end
+  end
+end

data/way_of_working-inclusive_language-alex.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'lib/way_of_working/inclusive_language/alex/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'way_of_working-inclusive_language-alex'
+  spec.version = WayOfWorking::InclusiveLanguage::Alex::VERSION
+  spec.authors = ['Tim Gentry']
+  spec.email = ['52189+timgentry@users.noreply.github.com']
+
+  spec.summary = 'Way of Working plugin for Inclusive Language using Alex'
+  spec.homepage = 'https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex'
+  spec.metadata['changelog_uri'] = 'https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'way_of_working', '~> 2.0'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: way_of_working-inclusive_language-alex
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Gentry
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: way_of_working
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
+email:
+- 52189+timgentry@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".alexrc"
+- ".mega-linter.yml"
+- ".rubocop"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- code_safety.yml
+- lib/way_of_working/inclusive_language/alex.rb
+- lib/way_of_working/inclusive_language/alex/generators/exec.rb
+- lib/way_of_working/inclusive_language/alex/generators/init.rb
+- lib/way_of_working/inclusive_language/alex/github_audit_rule.rb
+- lib/way_of_working/inclusive_language/alex/paths.rb
+- lib/way_of_working/inclusive_language/alex/plugin.rb
+- lib/way_of_working/inclusive_language/alex/templates/.alexignore
+- lib/way_of_working/inclusive_language/alex/templates/.alexrc
+- lib/way_of_working/inclusive_language/alex/templates/.github/workflows/inclusive-language.yml
+- lib/way_of_working/inclusive_language/alex/templates/docs/way_of_working/inclusive-language.md
+- lib/way_of_working/inclusive_language/alex/version.rb
+- way_of_working-inclusive_language-alex.gemspec
+homepage: https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex
+  source_code_uri: https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex
+  changelog_uri: https://github.com/HealthDataInsight/way_of_working-inclusive_language-alex/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Way of Working plugin for Inclusive Language using Alex
+test_files: []