discordrb 3.4.3 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5c0ecfd68356ed63ea61a7b99bb5d32e358f74b23c2f729ab531e4848bc770d
-  data.tar.gz: 4c5917f1b7a1a3e97d875a0244a8fa8e9583bce025053505b960de9e900ca16f
+  metadata.gz: 22a5d0696568b896315a4a63cbd262028f24cba3406461f1f9b59764194153a5
+  data.tar.gz: f5f516dd8e0e25512df14ab6a8b6ce68dc326e821ac92b3d9fae9f6fa84924ea
 SHA512:
-  metadata.gz: '09b5b31c7e7f15c7053c476ae0c2fd11839b7f5b82c4dea330764da42321c8333559df72273cdffbafe91bc9452a51a4bece945a2e6b3a8774af5fce409750fb'
-  data.tar.gz: 1743f21d2ad48858e8ebed88984fdf5cecb2ce5878ae0cbf32dbccc451175daa1d0f37c571efa100dadd94dcb169b17515bc691884d9583e00b40f57b45242ff
+  metadata.gz: 92fe5293a9deb5ebd253f579926ea9741835e4b019fa9cc5ae398ac3975a6d040ef611316bde03f07eabbc09cd78a468931e9e2c07a1448e5d4339cdbbbbd1b1
+  data.tar.gz: 456d37be600b66b43ecfa38b31d0f72113b308ebcc32f54d407f65ee6828d17b3f38ec495799eace92bc2951efcef121ad3ba572dab70bd848efd40f17293025

data/.devcontainer/Dockerfile

@@ -0,0 +1,13 @@
+# Which Ruby version to use. You may need to use a more restrictive version,
+# e.g. `3.0`
+ARG VARIANT=3.3
+
+# Pull Microsoft's ruby devcontainer base image
+FROM mcr.microsoft.com/devcontainers/ruby:${VARIANT}
+
+# Install libsodium dependency for voice channel interactions
+RUN apt update -yq && apt install -y libsodium-dev
+
+# Ensure we're running the latest bundler, as what ships with the Ruby image may
+# not be current, and bundler will auto-downgrade to match the Gemfile.lock
+RUN gem install bundler

data/.devcontainer/devcontainer.json

@@ -0,0 +1,29 @@
+{
+  "name": "Ruby",
+  "build": {
+    "dockerfile": "Dockerfile"
+  },
+
+  // Configure tool-specific properties.
+  "customizations": {
+    // Configure properties specific to VS Code.
+    "vscode": {
+      // Add the IDs of extensions you want installed when the container is created.
+      "extensions": [
+        "shopify.ruby-lsp"
+      ]
+    }
+  },
+
+  // Set the environment variables
+  // "runArgs": ["--env-file",".env"],
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  //   "forwardPorts": [],
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "bash .devcontainer/postcreate.sh",
+
+  // Set `remoteUser` to `root` to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  "remoteUser": "vscode"
+}

data/.devcontainer/postcreate.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+bundle config set path vendor/bundle
+bundle install --jobs=1

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,7 +1,6 @@
 ---
 name: Bug report
 about: Report a bug to help us improve the library
-
 ---
 
 # Summary

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,7 +1,6 @@
 ---
 name: Feature Request
 about: Request a new feature, or change an existing one
-
 ---
 
 <!---

data/.github/workflows/ci.yml

@@ -0,0 +1,78 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  # --- Test on multiple Ruby versions ---
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [3.2, 3.3, 3.4]
+    container:
+      image: ruby:${{ matrix.ruby }}-alpine
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install OS packages
+        run: apk add git build-base ruby-dev libsodium-dev
+      - name: Cache bundle
+        uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: bundle-${{ hashFiles('Gemfile', 'discordrb.gemspec') }}-${{ matrix.ruby }}
+          restore-keys: |
+            bundle-${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install --path vendor/bundle
+      - name: Run RSpec
+        run: |
+          mkdir -p rspec
+          bundle exec rspec --format progress --format RspecJunitFormatter -o rspec/rspec.xml
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        with:
+          name: rspec-results-${{ matrix.ruby }}
+          path: rspec/rspec.xml
+
+  # --- Rubocop ---
+  rubocop:
+    runs-on: ubuntu-latest
+    container:
+      image: ruby:3.3-alpine
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install OS packages
+        run: apk add git build-base ruby-dev libsodium-dev
+      - name: Cache bundle
+        uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: bundle-${{ hashFiles('Gemfile', 'discordrb.gemspec') }}-rubocop
+      - name: Install dependencies
+        run: bundle install --path vendor/bundle
+      - name: Run Rubocop
+        run: bundle exec rubocop
+
+  # --- Generate YARD docs ---
+  yard:
+    runs-on: ubuntu-latest
+    container:
+      image: ruby:3.3-alpine
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install OS packages
+        run: apk add git build-base ruby-dev libsodium-dev
+      - name: Cache bundle
+        uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: bundle-${{ hashFiles('Gemfile', 'discordrb.gemspec') }}-yard
+      - name: Install dependencies
+        run: bundle install --path vendor/bundle
+      - name: Run YARD
+        run: |
+          mkdir -p docs
+          bundle exec yard --output-dir docs

data/.github/workflows/codeql.yml

@@ -0,0 +1,65 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ 'main' ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ 'main' ]
+  schedule:
+    - cron: '29 6 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

data/.github/workflows/deploy.yml

@@ -0,0 +1,54 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main] # deploy only on merges to main
+    tags:
+      - "v*" # deploy when a version tag (e.g., v1.0.0) is created
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    container:
+      image: ruby:3.3-alpine
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install OS packages
+        run: apk add git build-base ruby-dev libsodium-dev
+
+      - name: Cache bundle
+        uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: bundle-${{ hashFiles('Gemfile', 'discordrb.gemspec') }}-yard
+
+      - name: Install dependencies
+        run: bundle install --path vendor/bundle
+
+      - name: Generate YARD documentation
+        run: |
+          mkdir -p docs
+          bundle exec yard --output-dir docs
+
+      - name: Determine deploy folder
+        id: set_folder
+        run: |
+          if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
+            echo "folder=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+          else
+            echo "folder=${GITHUB_REF#refs/heads/}" >> $GITHUB_OUTPUT
+          fi
+          echo "Deploying to folder: ${{ steps.set_folder.outputs.folder }}"
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs
+          publish_branch: gh-pages
+          destination_dir: ${{ steps.set_folder.outputs.folder }}
+          keep_files: true
+          user_name: "GitHub Actions"
+          user_email: "ci-build@shardlab.dev"

data/.github/workflows/release.yml

@@ -0,0 +1,45 @@
+name: Publish RubyGems + GitHub Packages
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Validate tag matches gemspecs
+        run: |
+          TAG_VERSION="${GITHUB_REF#refs/tags/v}"
+          for gemspec in *.gemspec; do
+            GEM_VERSION=$(ruby -e "puts Gem::Specification.load('$gemspec').version")
+            if [ "$TAG_VERSION" != "$GEM_VERSION" ]; then
+              echo "::error::$gemspec version ($GEM_VERSION) does not match tag ($TAG_VERSION)"
+              exit 1
+            fi
+          done
+
+      - uses: rubygems/release-gem@v1
+        with:
+          api_key: ${{ secrets.RUBYGEMS_API_KEY }}
+
+      - name: Publish to GitHub Packages
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          OWNER=$(echo "${GITHUB_REPOSITORY}" | cut -d'/' -f1)
+          for gemspec in *.gemspec; do
+            gem build "$gemspec"
+          done
+          for gem_file in *.gem; do
+            echo "Publishing $gem_file to GitHub Packages..."
+            gem push "$gem_file" \
+              --key github \
+              --host "https://rubygems.pkg.github.com/${OWNER}" || true
+          done

data/.markdownlint.json

@@ -0,0 +1,4 @@
+{
+  "MD013": false,
+  "MD024": { "siblings_only": true }
+}

data/.rubocop.yml

@@ -1,4 +1,6 @@
-require: rubocop-performance
+plugins:
+  - rubocop-performance
+  - rubocop-rake
 
 inherit_mode:
   merge:
@@ -6,7 +8,7 @@ inherit_mode:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.3
 
 # Disable line length checks
 Layout/LineLength:
@@ -38,6 +40,10 @@ Security/Eval:
 Style/Alias:
   Enabled: false
 
+# Had to disable this globally because it's being silently autocorrected even with local disable comments?
+Style/BisectedAttrAccessor:
+  Enabled: false
+
 # Prefer compact module/class defs
 Style/ClassAndModuleChildren:
   Enabled: false
@@ -60,3 +66,53 @@ Style/SingleLineBlockParams:
   Methods:
     - reduce: [m, e]
     - inject: [m, e]
+
+###################################
+## NEW COPS TO MAKE DECISIONS ON ##
+###################################
+
+# TODO: Decide how you want to handle this:
+# https://rubydoc.info/gems/rubocop/RuboCop/Cop/Style/HashSyntax
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either
+
+Style/ArgumentsForwarding:
+  Enabled: false
+
+Performance/StringIdentifierArgument:
+  Enabled: false
+
+Style/ComparableClamp:
+  Enabled: false
+
+Style/SuperArguments:
+  Enabled: false
+
+Naming/BlockForwarding:
+  Enabled: false
+
+Style/RedundantSelfAssignmentBranch:
+  Enabled: false
+
+Performance/MapCompact:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/RedundantParentheses:
+  Enabled: false
+
+# This will probably be a breaking change, but should happen
+Style/ReturnNilInPredicateMethodDefinition:
+  Enabled: false
+
+# FIXME: Disabled due to breaking tests, should probably refactor the code instead
+Style/SafeNavigation:
+  Enabled: false