yard_example_runner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 345b261e6c081cd9351aff0a274c6ee9c3aa696b401aa48f2b883690cc1689ae
+  data.tar.gz: 23bf543b020fc4c496e514190457d1a3b7218f83cdc8a998224e8e1cb6cf04cc
+SHA512:
+  metadata.gz: b07b1f30ac4d668eb04450401c9b1941eaa6518c70e04740c6c77a9116f134447e29cc0fe0ed11647d1919f70914f9f7d30fbdcae9433f84319f8b3f644f0366
+  data.tar.gz: 39d63edeb4611dbb07ac89b3d5dacb2e4b09e6e9176cf8533bbcb7c63831fe688fed9c99177da561a1a12e29e3586617a3ff55fa1b61cbd63d940d6579dbc868

data/.commitlintrc.yml

@@ -0,0 +1,38 @@
+---
+extends: '@commitlint/config-conventional'
+
+rules:
+  # See: https://commitlint.js.org/reference/rules.html
+  #
+  # Rules are made up by a name and a configuration array. The configuration
+  # array contains:
+  #
+  # * Severity [0..2]: 0 disable rule, 1 warning if violated, or 2 error if
+  #   violated
+  # * Applicability [always|never]: never inverts the rule
+  # * Value: value to use for this rule (if applicable)
+  #
+  # Run `npx commitlint --print-config` to see the current setting for all
+  # rules.
+  #
+  header-max-length:      [2, always, 100]        # Header can not exceed 100 chars
+
+  type-case:              [2, always, lower-case] # Type must be lower case
+  type-empty:             [2, never]              # Type must not be empty
+
+  # Supported conventional commit types
+  type-enum:              [2, always, [build, ci, chore, docs, feat, fix, perf, refactor, revert, style, test]]
+
+  scope-case:             [2, always, lower-case] # Scope must be lower case
+
+  # Error if subject is one of these cases (encourages lower-case)
+  subject-case:           [2, never, [sentence-case, start-case, pascal-case, upper-case]]
+  subject-empty:          [2, never]              # Subject must not be empty
+  subject-full-stop:      [2, never, "."]         # Subject must not end with a period
+
+  body-leading-blank:     [2, always]             # Body must have a blank line before it
+  body-max-line-length:   [2, always, 100]        # Body lines can not exceed 100 chars
+
+  footer-leading-blank:   [2, always]             # Footer must have a blank line before it
+  footer-max-line-length: [2, always, 100]        # Footer lines can not exceed 100 chars
+  

data/.github/workflows/continuous-integration.yml

@@ -0,0 +1,47 @@
+name: Continuous Integration
+
+on:
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Ruby ${{ matrix.ruby }} on ${{ matrix.operating-system }}
+
+    # Skip this job if triggered by a release PR
+    if: >-
+      github.event_name == 'workflow_dispatch' ||
+      (github.event_name == 'pull_request' && !startsWith(github.event.pull_request.head.ref, 'release-please--'))
+
+    runs-on: ${{ matrix.operating-system }}
+    continue-on-error: ${{ matrix.experimental == 'Yes' }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        # Only tested on non-EOL Ruby versions
+        ruby: ["3.3", "3.4", "4.0"]
+        operating-system: [ubuntu-latest]
+        experimental: [No]
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v6
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Setup Node
+        uses: actions/setup-node@v6
+        with:
+          node-version: 'lts/*'
+
+      - name: Install Node dependencies
+        run: npm ci || npm install
+
+      - name: Run Build
+        run: bundle exec rake default

data/.github/workflows/enforce_conventional_commits.yml

@@ -0,0 +1,27 @@
+---
+name: Conventional Commits
+
+permissions:
+  contents: read
+
+on:
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  commit-lint:
+    name: Verify Conventional Commits
+
+    # Skip this job if this is a release PR
+    if: (github.event_name == 'pull_request' && !startsWith(github.event.pull_request.head.ref, 'release-please--'))
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with: { fetch-depth: 0 }
+
+      - name: Check Commit Messages
+        uses: wagoid/commitlint-github-action@v6
+        with: { configFile: .commitlintrc.yml }

data/.github/workflows/release.yml

@@ -0,0 +1,52 @@
+---
+name: Release Gem
+
+description: |
+  This workflow creates a new release on GitHub and publishes the gem to
+  RubyGems.org.
+
+  The workflow uses the `googleapis/release-please-action` to handle the
+  release creation process and the `rubygems/release-gem` action to publish
+  the gem to rubygems.org
+
+on:
+  push:
+    branches: ["main"]
+
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    environment:
+      name: RubyGems
+      url: https://rubygems.org/gems/yard_example_runner
+
+    permissions:
+      contents: write
+      pull-requests: write
+      id-token: write
+
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v4
+
+      - name: Create release
+        uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          token: ${{ secrets.AUTO_RELEASE_TOKEN }}
+          config-file: .release-please-config.json
+          manifest-file: .release-please-manifest.json
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      - name: Push to RubyGems.org
+        uses: rubygems/release-gem@v1
+        if: ${{ steps.release.outputs.release_created }}

data/.gitignore

@@ -0,0 +1,28 @@
+
+_yardoc
+.bundle
+.config
+.DS_Store
+.rspec_status
+.yardoc
+.yardoc
+*.gem
+*.kpf
+*.rbc
+*.sw?
+coverage
+doc
+doc/
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+node_modules
+package-lock.json
+pkg
+rdoc
+rdoc
+rubocop-report.json
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no-install commitlint --edit "$1"

data/.markdownlint.yml

@@ -0,0 +1,25 @@
+default: true
+
+# Unordered list indentation
+MD007: { indent: 2 }
+
+# Line length
+MD013: { line_length: 90, tables: false, code_blocks: false }
+
+# Heading duplication is allowed for non-sibling headings
+MD024: { siblings_only: true }
+
+# Do not allow the specified trailing punctuation in a header
+MD026: { punctuation: '.,;:' }
+
+# Order list items must have a prefix that increases in numerical order
+MD029: { style: 'ordered' }
+
+# Lists do not need to be surrounded by blank lines
+MD032: false
+
+# Allow raw HTML in Markdown
+MD033: false
+
+# Allow emphasis to be used instead of a heading
+MD036: false

data/.release-please-config.json

@@ -0,0 +1,35 @@
+{
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "package-name": "yard_example_runner",
+      "changelog-path": "CHANGELOG.md",
+      "version-file": "lib/yard_example_runner/version.rb",
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": true,
+      "draft": false,
+      "versioning-strategy": "default",
+      "include-component-in-tag": false,
+      "pull-request-title-pattern": "chore: release v${version}",
+      "changelog-sections": [
+        { "type": "feat",     "section": "Features",      "hidden": false },
+        { "type": "fix",      "section": "Bug Fixes",     "hidden": false },
+        { "type": "build",    "section": "Other Changes", "hidden": false },
+        { "type": "chore",    "section": "Other Changes", "hidden": false },
+        { "type": "ci",       "section": "Other Changes", "hidden": false },
+        { "type": "docs",     "section": "Other Changes", "hidden": false },
+        { "type": "perf",     "section": "Other Changes", "hidden": false },
+        { "type": "refactor", "section": "Other Changes", "hidden": false },
+        { "type": "revert",   "section": "Other Changes", "hidden": false },
+        { "type": "style",    "section": "Other Changes", "hidden": false },
+        { "type": "test",     "section": "Other Changes", "hidden": false }
+      ]
+    }
+  },
+  "plugins": [
+    {
+      "type": "sentence-case"
+    }
+  ],
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0"
+}

data/.rubocop.yml

@@ -0,0 +1,27 @@
+inherit_gem:
+  main_branch_shared_rubocop_config: config/rubocop.yml
+
+inherit_mode:
+  merge:
+    - Exclude
+
+Naming/FileName:
+  Exclude:
+    - 'lib/yard_example_runner.rb'
+
+Style/DocumentDynamicEvalDefinition:
+  Exclude:
+    - 'lib/yard_example_runner/example.rb'
+    - 'lib/yard_example_runner/example/evaluator.rb'
+
+# Allow test data to have long lines
+Layout/LineLength:
+  Exclude:
+    - "*.gemspec"
+
+Metrics/BlockLength:
+  Exclude:
+    - "*.gemspec"
+
+AllCops:
+  TargetRubyVersion: 3.3

data/AI_POLICY.md

@@ -0,0 +1,26 @@
+<!--
+# @markup markdown
+# @title AI Policy
+-->
+
+# AI Policy
+
+AI-assisted contributions are welcome.
+
+This policy applies to code, documentation, issue content, and pull request text.
+
+Reviewing and maintaining code requires human insight. While AI tools can be helpful
+assistants, they are no substitute for human judgment and creativity.
+
+We value the unique perspectives and critical thinking that our contributors bring.
+If you use AI tools to assist your work:
+
+1. **You are responsible**: You must review and understand every line of code or text
+   you submit.
+2. **Focus on quality**: Ensure that AI-generated content meets our standards for
+   correctness, readability, and security, and respects all licensing requirements.
+3. **Be transparent**: We encourage you to disclose when substantial portions of your
+   contribution were AI-generated.
+
+Ultimately, the quality of this project depends on *your* expertise. Use tools
+wisely, but lead with your own intelligence.

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+<!--
+# @markup markdown
+# @title Change Log
+-->
+
+# Changelog
+
+## [0.1.0](https://github.com/main-branch/yard_example_runner/compare/v0.0.0...v0.1.0) (2026-02-26)
+
+
+### ⚠ BREAKING CHANGES
+
+* initial implementation of yard_example_runner
+
+### Features
+
+* Initial implementation of yard_example_runner ([d17d08c](https://github.com/main-branch/yard_example_runner/commit/d17d08cdd39bf533780dfe569953de3d72dd5327))
+
+## [Unreleased]
+
+- No changes yet.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,25 @@
+<!--
+# @markup markdown
+# @title Code of Conduct
+-->
+
+# Code of Conduct
+
+This project has adopted the [Ruby Community Code of
+Conduct](https://www.ruby-lang.org/en/conduct/).
+
+This document provides community guidelines for a safe, respectful, productive, and
+collaborative place for anyone willing to contribute to the Ruby
+community. It applies to all collaborative spaces, including community communications
+channels (such as mailing lists, submitted patches, commit comments, etc.).
+
+- Participants must be tolerant of opposing views.
+- Participants must ensure that their language and actions are free of personal
+  attacks and disparaging personal remarks.
+- When interpreting the words and actions of others, participants should always
+  assume good intentions.
+- Behavior that can reasonably be considered harassment will not be tolerated.
+
+Report violations to the maintainers by [opening an
+issue](https://github.com/main-branch/yard_example_runner/issues/new) or contacting a
+[maintainer](MAINTAINERS.md) privately.

data/CONTRIBUTING.md

@@ -0,0 +1,237 @@
+<!--
+# @markup markdown
+# @title How To Contribute
+-->
+
+# Contributing to this project
+
+- [Summary](#summary)
+- [How to contribute](#how-to-contribute)
+- [How to report an issue or request a feature](#how-to-report-an-issue-or-request-a-feature)
+- [How to submit a code or documentation change](#how-to-submit-a-code-or-documentation-change)
+  - [Commit message guidelines](#commit-message-guidelines)
+    - [What does this mean for contributors?](#what-does-this-mean-for-contributors)
+    - [What to know about Conventional Commits](#what-to-know-about-conventional-commits)
+  - [Create a pull request](#create-a-pull-request)
+  - [Get your pull request reviewed](#get-your-pull-request-reviewed)
+- [Branch strategy](#branch-strategy)
+- [AI-assisted contributions](#ai-assisted-contributions)
+- [Coding standards](#coding-standards)
+  - [Tests](#tests)
+  - [RuboCop](#rubocop)
+  - [Markdownlint](#markdownlint)
+- [Licensing](#licensing)
+
+## Summary
+
+This document provides guidelines for contributing to this project. These guidelines
+do not cover every situation; use your best judgment when contributing.
+
+If you have suggestions for improving these guidelines, please propose changes via a
+pull request.
+
+Please also review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) when
+participating in the project. Governance and maintainer expectations are described in
+[GOVERNANCE.md](GOVERNANCE.md).
+
+## How to contribute
+
+You can contribute in the following ways:
+
+1. [Report an issue or request a
+   feature](#how-to-report-an-issue-or-request-a-feature)
+2. [Submit a code or documentation
+   change](#how-to-submit-a-code-or-documentation-change)
+
+## How to report an issue or request a feature
+
+`yard_example_runner` uses [GitHub
+Issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)
+for issue tracking and feature requests.
+
+To report an issue or request a feature, please [create a `yard_example_runner`
+GitHub issue](https://github.com/main-branch/yard_example_runner/issues/new). Fill in
+the template as thoroughly as possible to describe the issue or feature request.
+
+## How to submit a code or documentation change
+
+There is a three-step process for submitting code or documentation changes:
+
+1. Commit your changes to a fork of this repository using [Conventional
+   Commits](#commit-message-guidelines)
+2. [Create a pull request](#create-a-pull-request)
+3. [Get your pull request reviewed](#get-your-pull-request-reviewed)
+
+### Commit message guidelines
+
+The `yard_example_runner` project has adopted the [Conventional Commits
+standard](https://www.conventionalcommits.org/en/v1.0.0/) for all commit messages.
+
+This structured approach to commit messages allows us to:
+
+- **Automate versioning and releases:** Tools can now automatically determine the
+  semantic version bump (patch, minor, major) based on the types of commits merged.
+- **Generate accurate changelogs:** We can automatically create and update a
+  `CHANGELOG.md` file, providing a clear history of changes for users and
+  contributors.
+- **Improve commit history readability:** A standardized format makes it easier for
+  everyone to understand the nature of changes at a glance.
+
+#### What does this mean for contributors?
+
+All commits to this repository **MUST** adhere to the [Conventional Commits
+standard](https://www.conventionalcommits.org/en/v1.0.0/). Commits not adhering to
+this standard will cause the CI build to fail. PRs will not be merged if they include
+non-conventional commits.
+
+A git `commit-msg` hook can be installed to validate conventional commit messages by
+running `bin/setup` in the project root.
+
+#### What to know about Conventional Commits
+
+The simplest conventional commit is in the form `type: description` where `type`
+indicates the type of change and `description` is your usual commit message (with
+some limitations).
+
+- Common types include: `feat`, `fix`, `docs`, `test`, `refactor`, and `chore`. See
+  the full list of supported types in [.commitlintrc.yml](.commitlintrc.yml).
+- The description must (1) not start with an upper case letter, (2) be no more than
+  100 characters, and (3) not end with punctuation.
+
+Examples of valid commits:
+
+- `feat: add support for asserting raised exceptions in examples`
+- `fix: exception thrown when example output contains special characters`
+- `docs: add shared context examples to README`
+
+Commits that include breaking changes must include an exclamation mark before the
+colon:
+
+- `feat!: renamed YardExampleRunner::Runner to YardExampleRunner::ExampleRunner`
+
+The commit messages will drive how the version is incremented for each release:
+
+- a release containing a **breaking change** will do a **major** version increment
+- a release containing a **new feature** will do a **minor** increment
+- a release containing **neither a breaking change nor a new feature** will do a
+  **patch** version increment
+
+The full conventional commit format is:
+
+```text
+<type>[optional scope][!]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+- `optional body` may include multiple lines of descriptive text limited to 100 chars
+  each
+- `optional footers` typically use `BREAKING CHANGE: <description>` where description
+  should describe the nature of the backward incompatibility.
+
+Use of the `BREAKING CHANGE:` footer flags a backward incompatible change even if it
+is not flagged with an exclamation mark after the `type`. Other footers are allowed
+but not acted upon.
+
+See [the Conventional Commits
+specification](https://www.conventionalcommits.org/en/v1.0.0/) for more details.
+
+### Create a pull request
+
+If you are not familiar with GitHub Pull Requests, please refer to [this
+article](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
+
+Follow the instructions in the pull request template.
+
+### Get your pull request reviewed
+
+Code review takes place in a GitHub pull request using the [GitHub pull request
+review
+feature](https://docs.github.com/pull-requests/collaborating-with-pull-requests/getting-started/helping-others-review-your-changes).
+
+Once your pull request is ready for review, request a review from at least one
+[maintainer](MAINTAINERS.md) and any other contributors you deem necessary.
+
+During the review process, you may need to make additional commits. Before merging,
+your branch must be up to date with `main` and merge cleanly. Keep history focused
+and easy to review.
+
+At least one approval from a project maintainer is required before your pull request
+can be merged. The maintainer is responsible for ensuring that the pull request meets
+[the project's coding standards](#coding-standards).
+
+## Branch strategy
+
+Development happens on feature branches in a fork of this repository. Changes are
+merged into `main` of this repository via pull requests. **Never commit directly to
+`main` of this repository.** This ensures proper code review, CI validation, and
+maintains a clean commit history.
+
+## AI-assisted contributions
+
+AI-assisted contributions are welcome. Please review and apply our [AI
+Policy](AI_POLICY.md) before submitting changes. You are responsible for
+understanding and verifying any AI-assisted work included in PRs and ensuring it
+meets our standards for quality, security, and licensing.
+
+## Coding standards
+
+To ensure high-quality contributions, all pull requests must meet the following
+requirements:
+
+### Tests
+
+- All changes must be accompanied by new or modified tests.
+- The entire test suite must pass when `bundle exec rake` is run from the project's
+  local working copy.
+
+This project uses [Cucumber](https://cucumber.io/) with
+[Aruba](https://github.com/cucumber/aruba) for system-level tests. Tests live in the
+`features/` directory.
+
+To run the tests:
+
+```bash
+bundle exec rake cucumber
+```
+
+New and updated public-facing features should be documented in the project's
+[README.md](README.md).
+
+### RuboCop
+
+All Ruby code must pass [RuboCop](https://rubocop.org/) static analysis. Violations
+will cause the CI build to fail. PRs will not be merged if they include RuboCop
+offenses.
+
+To run RuboCop:
+
+```bash
+bundle exec rake rubocop
+```
+
+### Markdownlint
+
+All Markdown files must pass [markdownlint](https://github.com/DavidAnson/markdownlint)
+analysis. Violations will cause the CI build to fail. PRs will not be merged if they
+include markdownlint offenses.
+
+To run markdownlint:
+
+```bash
+bundle exec rake markdownlint
+```
+
+All coding standards checks are run together with the default `rake` command:
+
+```bash
+bundle exec rake
+```
+
+## Licensing
+
+`yard_example_runner` uses [the MIT
+license](https://choosealicense.com/licenses/mit/) as declared in the
+[LICENSE](LICENSE.txt) file.