rhales 0.3.0 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e468b139c203a063276ccd0f890b0b7439a7c4459a96f132ed1e53c01623b11
-  data.tar.gz: 786e0f95fa3d592b5451f7538d350f558f31545eb99973f5384bbde2fd474a99
+  metadata.gz: ad690a26efe57e8ff9f10abdcb05423516fbfc26be67ba579d07ea8d9bc2ede7
+  data.tar.gz: 7ce9893a2160814d2783bf6ae0a90809a4a240a3d44d69e4dd3b886bd1b89e65
 SHA512:
-  metadata.gz: fd02c37df3e02b5e423eeb7a1929ca2393a98ee0c6569724256846cd168ffa5476e4d94e18cbd9fc28149d0f50ff957423fbd1c165fe0e30f83d281e6075ab04
-  data.tar.gz: 8b9f7d88831a6e78ae811a56a4fe0c95e1c8962011ebbbcb7927e4cfb6dbcde798f66e4a2998fb89fcf30f356c7d2ca3134548971b3721331aacad6f90e501d5
+  metadata.gz: 9083d11f2d75d1d301191f29f783488894adb322db93e51071c784f141bcf124b34c9fcc28deb77e8382d159ab82b75cb12f5584523feb8ccb55e883c02ee99d
+  data.tar.gz: 57a9d7c3f95b02a960488cf2ade3cf4203e98bf70174d6fcc6c29fd3be6d75447bb5b41869ab1991f33b31202599a0c4635aa514d5aa0b410b24dd4ea26abf11

data/.github/renovate.json5

@@ -0,0 +1,52 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+
+  // Core presets
+  "extends": [
+    "config:recommended",
+    "docker:pinDigests",
+    "helpers:pinGitHubActionDigests",
+    ":pinDevDependencies",
+    ":pinDependencies"
+  ],
+
+  // Update control and scheduling
+  "timezone": "America/Vancouver",
+  "schedule": ["before 5am on Monday"],
+  "separateMinorPatch": false,
+  "separateMultipleMajor": true,
+  "separateMultipleMinor": true,
+  "recreateWhen": "auto",
+  "rebaseWhen": "auto",
+
+  // PR management
+  "prConcurrentLimit": 15,
+  "prHourlyLimit": 10,
+  "labels": ["auto-update"],
+  "assignees": ["delano"],
+  "reviewers": [],
+
+  // Branch settings
+  "branchPrefix": "deps/",
+  "branchNameStrict": true,
+
+  // Automerge settings
+  "automerge": true,
+  "automergeType": "branch",
+  "automergeStrategy": "merge-commit",
+  "major": { "automerge": false },
+  "minor": { "automerge": false },
+  "patch": { "automerge": true },
+  "pin": { "automerge": true },
+  "lockFileMaintenance": { "automerge": true },
+
+  // Security settings
+  "vulnerabilityAlerts": {
+    "labels": ["security"],
+    "assignees": ["delano"],
+    "schedule": "at any time"
+  },
+
+  // Additional settings
+  "forkProcessing": "enabled"
+}

data/.github/workflows/ci.yml

@@ -0,0 +1,123 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+  workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: false
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    name: Tests (Ruby ${{ matrix.ruby }})
+    strategy:
+      fail-fast: true
+      matrix:
+        ruby: ['3.4', '3.5']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run RSpec tests
+        run: bundle exec rspec
+
+      - name: Run Rhales-specific tests
+        run: bundle exec rake rhales:test
+
+  gem-build:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    name: Gem Build Test (Ruby ${{ matrix.ruby }})
+    strategy:
+      fail-fast: true
+      matrix:
+        ruby: ['3.4', '3.5']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Build gem
+        run: gem build rhales.gemspec
+
+      - name: Install gem locally
+        run: gem install rhales-*.gem
+
+      - name: Test gem installation
+        run: ruby -e "require 'rhales'; puts Rhales::VERSION"
+
+  template-validation:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    name: Template Validation (Ruby ${{ matrix.ruby }})
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.4', '3.5']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Validate example templates
+        run: bundle exec rake rhales:validate
+
+  demo-integration:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    name: Demo Integration (Ruby ${{ matrix.ruby }})
+    continue-on-error: true
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.4', '3.5']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Install demo dependencies
+        working-directory: demo/rhales-roda-demo
+        run: bundle install
+
+      - name: Test demo app startup
+        working-directory: demo/rhales-roda-demo
+        run: |
+          timeout 30s bundle exec rackup -p 9393 &
+          sleep 5
+          curl -f http://localhost:9393/ || exit 1
+          pkill -f rackup || true

data/.github/workflows/claude-code-review.yml

@@ -0,0 +1,69 @@
+name: Claude Code Review
+
+on:
+  pull_request:
+    types: [opened, synchronize, labeled]
+  workflow_dispatch:
+
+jobs:
+  claude-review:
+    # Optional: Filter by PR author
+    # if: |
+    #   github.event.pull_request.user.login == 'external-contributor' ||
+    #   github.event.pull_request.user.login == 'new-developer' ||
+    #   github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR'
+
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.action == 'opened') ||
+      (github.event.action == 'labeled' && github.event.label.name == 'claude-review') ||
+      (github.event.action == 'synchronize' && contains(github.event.pull_request.labels.*.name, 'claude-review'))
+
+    permissions:
+      contents: read
+      pull-requests: read
+      issues: read
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 1
+
+      - name: Run Claude Code Review
+        id: claude-review
+        uses: anthropics/claude-code-action@beta
+        with:
+          claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
+
+          # Direct prompt for automated review (no @claude mention needed)
+          direct_prompt: |
+            Please review this pull request and provide feedback on:
+            - Code quality and best practices
+            - Potential bugs or issues
+            - Performance considerations
+            - Security concerns
+            - Test coverage
+
+            Use the repository's CLAUDE.md for guidance on style and conventions. Be constructive and helpful in your feedback.
+
+          # Use sticky comments to reuse the same comment on subsequent pushes to the same PR
+          use_sticky_comment: true
+
+      - name: Remove claude-review label
+        # Remove label whether success or failure - prevents getting stuck
+        if: always() && github.event.action != 'opened'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            try {
+              await github.rest.issues.removeLabel({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.issue.number,
+                name: 'claude-review'
+              });
+            } catch (error) {
+              console.log('Label not found or already removed');
+            }

data/.github/workflows/claude.yml

@@ -0,0 +1,49 @@
+name: Claude Code
+
+on:
+  issue_comment:
+    types: [created]
+  pull_request_review_comment:
+    types: [created]
+  issues:
+    types: [opened, assigned]
+  pull_request_review:
+    types: [submitted]
+
+jobs:
+  claude:
+    if: |
+      (github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
+      (github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
+      (github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||
+      (github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')))
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+      issues: read
+      id-token: write
+      actions: read # Required for Claude to read CI results on PRs
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 1
+
+      - name: Run Claude Code
+        id: claude
+        uses: anthropics/claude-code-action@v1
+        with:
+          claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
+
+          # This is an optional setting that allows Claude to read CI results on PRs
+          additional_permissions: |
+            actions: read
+
+          # Optional: Give a custom prompt to Claude. If this is not specified, Claude will perform the instructions specified in the comment that tagged it.
+          # prompt: 'Update the pull request description to include a summary of changes.'
+
+          # Optional: Add claude_args to customize behavior and configuration
+          # See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
+          # or https://docs.anthropic.com/en/docs/claude-code/sdk#command-line for available options
+          # claude_args: '--model claude-opus-4-1-20250805 --allowed-tools Bash(gh pr:*)'

data/.github/workflows/code-smells.yml

@@ -0,0 +1,146 @@
+# .github/workflows/code-quality.yml
+---
+name: Code Smells
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pull-requests: write # Needed to post comments on PRs
+
+jobs:
+  reek-analysis:
+    name: Reek Code Analysis
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.4
+          bundler-cache: true
+
+      - name: Configure Bundler for secure gem installation
+        run: |
+          bundle config set --local path 'vendor/bundle'
+          bundle config set --local deployment 'false'
+
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Run Reek analysis
+        run: |
+          echo "=== Running Reek code analysis ==="
+          echo "This analysis identifies code smells and potential improvements."
+          echo "Results are informational and won't fail the build."
+          echo ""
+
+          # Run reek and capture output (don't fail on warnings)
+          # Use success-exit-code to prevent failures from stopping the analysis
+          bundle exec reek --format=text --success-exit-code 0 --failure-exit-code 0 || true
+
+          echo ""
+          echo "=== Reek analysis complete ==="
+        continue-on-error: true # Don't fail the build on code smells
+
+      - name: Generate Reek report
+        run: |
+          echo "=== Generating detailed Reek report ==="
+
+          # Generate JSON report for potential future processing
+          bundle exec reek --format=json --success-exit-code 0 --failure-exit-code 0 > reek-report.json || true
+
+          # If no JSON was generated, create an empty valid JSON array
+          if [ ! -s reek-report.json ]; then
+            echo "[]" > reek-report.json
+            echo "No code smells detected - created empty report"
+          else
+            echo "Reek JSON report generated: $(wc -l < reek-report.json) lines"
+            echo "Top code smell types found:"
+            jq -r '.[].smells[].smell_type' reek-report.json 2>/dev/null | sort | uniq -c | sort -rn | head -10 || echo "Unable to parse JSON report"
+          fi
+
+          # Also generate a human-readable HTML report for easier viewing
+          bundle exec reek --format=html --success-exit-code 0 --failure-exit-code 0 > reek-report.html || echo "<!-- No code smells detected -->" > reek-report.html
+        continue-on-error: true
+
+      - name: Upload Reek report as artifact
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: reek-report
+          path: |
+            reek-report.json
+            reek-report.html
+          if-no-files-found: ignore
+          retention-days: 30
+
+  additional-checks:
+    name: Additional Quality Checks
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.4
+          bundler-cache: true
+
+      - name: Configure Bundler for secure gem installation
+        run: |
+          bundle config set --local path 'vendor/bundle'
+          bundle config set --local deployment 'false'
+
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Check for TODO/FIXME comments
+        run: |
+          echo "=== Scanning for TODO/FIXME comments ==="
+          echo "This helps track technical debt and action items."
+          echo ""
+
+          # Find TODO/FIXME comments (excluding vendor and tmp directories)
+          find . -name "*.rb" -not -path "./vendor/*" -not -path "./tmp/*" | \
+            xargs grep -Hn -i -E "(TODO|FIXME|HACK|XXX|NOTE):" 2>/dev/null | \
+            head -20 || echo "No TODO/FIXME comments found"
+        continue-on-error: true
+
+      - name: Check Ruby file syntax
+        run: |
+          echo "=== Checking Ruby syntax ==="
+          echo "Validates that all Ruby files have correct syntax."
+          echo ""
+
+          find . -name "*.rb" -not -path "./vendor/*" -not -path "./tmp/*" | \
+            while read -r file; do
+              if ! ruby -c "$file" > /dev/null 2>&1; then
+                echo "Syntax error in: $file"
+                ruby -c "$file" || true
+              fi
+            done
+        continue-on-error: true
+
+      - name: Check for long lines
+        run: |
+          echo "=== Checking for long lines (>120 characters) ==="
+          echo "Identifies potentially hard-to-read code lines."
+          echo ""
+
+          find . -name "*.rb" -not -path "./vendor/*" -not -path "./tmp/*" | \
+            xargs grep -Hn "^.\{121,\}$" | \
+            head -10 || echo "No overly long lines found"
+        continue-on-error: true

data/.github/workflows/ruby-lint.yml

@@ -0,0 +1,78 @@
+# .github/workflows/ruby-lint.yml
+
+name: Ruby Lint
+
+# This GitHub Actions workflow runs Ruby linting using Rubocop.
+#
+# The workflow is triggered by push events on branches starting with "fix/" or
+# "rel/", pull requests on main/develop/feature/* branches, and manual dispatch.
+#
+# The workflow has a single job named "lint" that runs on Ubuntu 24.04
+# with a strategy matrix to test multiple Ruby versions.
+#
+# The steps in the job are:
+# 1. Checkout code using the actions/checkout@v4 action.
+# 2. Set up the specified version of Ruby using the ruby/setup-ruby@v1 action.
+# 3. Install dependencies using Bundler.
+# 4. Run Rubocop linting with JSON output and warning-level failures.
+#
+# This workflow ensures that Ruby code follows style guidelines and best practices.
+
+on:
+  push:
+    branches:
+      - fix/*
+      - rel/*
+  pull_request:
+    branches:
+      - main
+      - develop
+      - feature/*
+  workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: false
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    timeout-minutes: 10 # prevent hung jobs
+
+    runs-on: ubuntu-24.04
+
+    strategy:
+      fail-fast: true
+      matrix:
+        ruby: ['3.4', '3.5']
+        continue-on-error: [true]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@7b6a61a73bbb9793cb80ad69b8dd8ac19261834c # v3
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
+        with:
+          detached: true
+
+      - name: Install dependencies
+        continue-on-error: ${{ matrix.continue-on-error }}
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Run Rubocop
+        continue-on-error: ${{ matrix.continue-on-error }}
+        run: |
+          bundle exec rubocop --config .rubocop.yml --format json --fail-level warning

data/.github/workflows/yardoc.yml

@@ -0,0 +1,126 @@
+name: Generate and Deploy YARD Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'lib/**/*'
+      - 'README.md'
+      - 'CHANGELOG.md'
+      - '.yardopts'
+      - '.github/workflows/yardoc.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build-docs:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    name: Generate YARD Documentation
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Ruby environment
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+
+      - name: Configure YARD documentation parameters
+        run: |
+          # Create comprehensive .yardopts configuration
+          cat > .yardopts << 'EOF'
+          --protected
+          --private
+          --markup markdown
+          --markup-provider kramdown
+          --output-dir doc
+          --readme README.md
+          --files CHANGELOG.md,LICENSE.txt
+          --exclude spec/**/*
+          --exclude demo/**/*
+          --exclude examples/**/*
+          --exclude apps/**/*
+          lib/**/*.rb
+          -
+          README.md
+          CHANGELOG.md
+          EOF
+
+      - name: Generate comprehensive documentation
+        run: |
+          echo "::group::YARD Documentation Generation"
+          bundle exec yard stats --list-undoc
+          bundle exec yard doc
+          echo "::endgroup::"
+
+      - name: Validate documentation completeness
+        run: |
+          echo "::group::Documentation Validation"
+          if [ ! -d "doc" ]; then
+            echo "Error: Documentation directory not generated"
+            exit 1
+          fi
+
+          # Check for essential files
+          required_files=("index.html" "file.README.html" "file.CHANGELOG.html")
+          for file in "${required_files[@]}"; do
+            if [ ! -f "doc/$file" ]; then
+              echo "Warning: Expected file doc/$file not found"
+            fi
+          done
+
+          # Display documentation statistics
+          echo "Generated documentation files:"
+          find doc -name "*.html" | wc -l
+          echo "Total documentation size:"
+          du -sh doc/
+          echo "::endgroup::"
+
+      - name: Setup GitHub Pages configuration
+        uses: actions/configure-pages@v4
+
+      - name: Upload documentation artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './doc'
+
+  deploy-pages:
+    timeout-minutes: 10
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build-docs
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+  notify-completion:
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    needs: [build-docs, deploy-pages]
+    if: success()
+
+    steps:
+      - name: Documentation deployment summary
+        run: |
+          echo "::notice title=Documentation Deployed::YARD documentation successfully deployed to GitHub Pages"
+          echo "::notice title=Access URL::Documentation available at: ${{ needs.deploy-pages.outputs.page_url }}"