discordrb 3.3.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b25d90cb65adea4d1dac0aa33b64f6451e1c21f7dbe13c48f2ae9d40ea5e2edf
-  data.tar.gz: 31e41074b2304456f73413af20ca1850757e34566af21067a4989656d78feb77
+  metadata.gz: 256d58c280ec27b90dbe4c160b04853b72fede9123336085343141e4d0e6ad4a
+  data.tar.gz: 8f4db65b7491433052cc99b1a0e633fc773efd8076edbd4ad44a5bc3ed4b5a14
 SHA512:
-  metadata.gz: 5bb79daa3219ec1c75f637ccaf39c71e943ba2e162c02ca46fd2775e7a746d4cfecafda8af8402d215936660249b96ae441632444d7718688badf19ae38f72fe
-  data.tar.gz: 71110b5df4bade1aac8d54b708bbc93b5a91d61c146eb56e9aa25a94f9dd0ff0f291db4c0c28589f095ab9fa19ed9204e50a0aaa920557c6fdc802d88eaa733a
+  metadata.gz: ed49c17ab20befc243747a942d4401b513670220d76632b796df000e9232bebd5d6f58c6ce7a1bb5a16f03d8d88ec1b2c5c6131e1ddd20784cf4b7248111a979
+  data.tar.gz: 01fb50074b67c0bcb3c96ed2cc4e76aad57600e94fa22793c588e66c98fddd796f7a7087817b9d7926975e28e956d950ce7fd1d778e73edf26c32be49dabbedb

data/.circleci/config.yml

@@ -0,0 +1,152 @@
+version: 2.1
+
+commands:
+  setup-env:
+    description: Sets up the testing environment
+    steps:
+      - run:
+          name: Install OS packages
+          command: apk add git build-base ruby-dev ruby-etc ruby-json libsodium
+      - checkout
+      - run:
+          name: "Ruby version"
+          command: |
+            ruby -v
+            echo $RUBY_VERSION > ruby_version.txt
+      - restore_cache:
+          keys:
+            - bundle-cache-v1-{{ checksum "ruby_version.txt" }}-{{ .Branch }}-{{ checksum "Gemfile" }}-{{ checksum "discordrb.gemspec" }}
+            - bundle-cache-v1-{{ checksum "ruby_version.txt" }}-{{ .Branch }}
+            - bundle-cache-v1-{{ checksum "ruby_version.txt" }}
+      - run:
+          name: Install dependencies
+          command: bundle install --path vendor/bundle
+      - save_cache:
+          key: bundle-cache-v1-{{ checksum "ruby_version.txt" }}-{{ .Branch }}-{{ checksum "Gemfile" }}-{{ checksum "discordrb.gemspec" }}
+          paths:
+            - ./vendor/bundle
+
+jobs:
+  test_ruby_27:
+    docker:
+      - image: ruby:2.7-alpine
+    steps:
+      - setup-env
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o ~/rspec/rspec.xml
+      - store_test_results:
+          path: ~/rspec
+
+  test_ruby_30:
+    docker:
+      - image: ruby:3.0-alpine
+    steps:
+      - setup-env
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o ~/rspec/rspec.xml
+      - store_test_results:
+          path: ~/rspec
+
+
+  test_ruby_31:
+    docker:
+      - image: ruby:3.1-alpine
+    steps:
+      - setup-env
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o ~/rspec/rspec.xml
+
+  rubocop:
+    docker:
+      - image: ruby:2.7-alpine
+    steps:
+      - setup-env
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+
+  yard:
+    docker:
+      - image: ruby:2.7-alpine
+    steps:
+      - setup-env
+      - attach_workspace:
+          at: /tmp/workspace
+      - run:
+          name: Run YARD
+          command: bundle exec yard --output-dir /tmp/workspace/docs
+      - persist_to_workspace:
+          root: /tmp/workspace
+          paths:
+            - docs
+
+  pages:
+    docker:
+      - image: alpine
+    steps:
+      - run:
+          name: Install OS packages
+          command: apk add git openssh-client-default
+      - attach_workspace:
+          at: /tmp/workspace
+      - run:
+          name: Clone docs
+          command: |
+            mkdir -p ~/.ssh
+
+            echo 'github.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCj7ndNxQowgcQnjshcLrqPEiiphnt+VTTvDP6mHBL9j1aNUkY4Ue1gvwnGLVlOhGeYrnZaMgRK6+PKCUXaDbC7qtbW8gIkhL7aGCsOr/C56SJMy/BCZfxd1nWzAOxSDPgVsmerOBYfNqltV9/hWCqBywINIR+5dIg6JTJ72pcEpEjcYgXkE2YEFXV1JHnsKgbLWNlhScqb2UmyRkQyytRLtL+38TGxkxCflmO+5Z8CSSNY7GidjMIZ7Q4zMjA2n1nGrlTDkzwDCsw+wqFPGQA179cnfGWOWRVruj16z6XyvxvjJwbz0wQZ75XK5tKSb7FNyeIEs4TT4jk+S4dhPeAUC5y+bDYirYgM4GC7uEnztnZyaVWQ7B381AK4Qdrwt51ZqExKbQpTUNn+EjqoTwvqNj4kqx5QUCI0ThS/YkOxJCXmPUWZbhjpCg56i+2aB6CmK2JGhn57K5mj0MNdBXA4/WnwH6XoPWJzK5Nyu2zB3nAZp+S5hpQs+p1vN1/wsjk=' >> ~/.ssh/known_hosts
+
+            git clone $CIRCLE_REPOSITORY_URL -b gh-pages .
+      - add_ssh_keys:
+          fingerprints:
+            - "9a:4c:50:94:23:46:81:74:41:97:87:04:4e:59:4b:4e"
+      - run:
+          name: Push updated docs
+          command: |
+            git config user.name "Circle CI"
+            git config user.email "ci-build@shardlab.dev"
+
+            SOURCE_BRANCH=$CIRCLE_BRANCH
+            if [ -n "$CIRCLE_TAG" ]; then
+              SOURCE_BRANCH=$CIRCLE_TAG
+            fi
+
+            mkdir -p $SOURCE_BRANCH
+            rm -rf $SOURCE_BRANCH/*
+            cp -r /tmp/workspace/docs/. ./$SOURCE_BRANCH/
+
+            git add $SOURCE_BRANCH
+            git commit --allow-empty -m "[skip ci] Deploy docs"
+            git push -u origin gh-pages
+
+workflows:
+  test:
+    jobs:
+      - test_ruby_27
+      - test_ruby_30
+      - test_ruby_31
+      - rubocop
+      - yard
+  deploy:
+    jobs:
+      - yard:
+          filters:
+            branches:
+              only:
+                - main
+                - slash_commands
+            tags:
+              only: /^v.*/
+      - pages:
+          requires:
+            - yard
+          filters:
+            branches:
+              only:
+                - main
+                - slash_commands
+            tags:
+              only: /^v.*/

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Report a bug to help us improve the library
+---
+
+# Summary
+
+<!---
+  First, please check to see that another issue or pull request (open or closed)
+  already addresses the problem you are facing. If you are not sure, please ask
+  in the Discord channel (link below).
+
+  Describe the bug you are encountering with as much detail as you can.
+  If you are not sure if a small detail is relevant, include it anyways!
+
+  Include simple code examples that will reproduce the bug.
+  Include any exceptions you are encountering in your logs, including
+  the initial error message and the backtrace that follows.
+
+  Stuck or need help? Join the Discord! https://discord.gg/cyK3Hjm
+-->
+
+---
+
+## Environment
+
+<!---
+  These are some commands to run to give us basic information about
+  your Ruby environment. Some issues may be version, OS, or hardware specific.
+--->
+
+**Ruby version:**
+
+<!--- Paste full output of `ruby -v` here --->
+
+**Discordrb version:**
+
+<!--- Paste full output of `gem list discordrb` or `bundle list discordrb` here --->

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature Request
+about: Request a new feature, or change an existing one
+---
+
+<!---
+  Describe your feature request in as much detail as you can here.
+
+  Include why you want this feature. For example:
+
+  - It is a feature supported by Discord's API, but missing from the library
+
+  - It is a feature that would simplify a lot of your bots code
+
+  - It is a feature present in other popular Discord libraries
+
+  Include simple code examples (pseudocode is fine) that demonstrate
+  what you want to do.
+
+  Do your best to think about how this new feature would impact the code
+  of other people who use discordrb, and not just your own bot's codebase.
+
+  Stuck or need help? Join the Discord! https://discord.gg/cyK3Hjm
+--->

data/.github/pull_request_template.md

@@ -0,0 +1,37 @@
+# Summary
+
+<!---
+  Describe the general goal of your pull request here:
+
+  - Include details about any issues you encountered that inspired
+  the pull request, such as bugs or missing features.
+
+  - If adding or changing features, include a small example that showcases
+  the new behavior.
+
+  - Reference any related issues or pull requests.
+
+  Stuck or need help? Join the Discord! https://discord.gg/cyK3Hjm
+--->
+
+---
+
+<!---
+  List each individual change you made to the library here in the appropriate
+  section in short, bulleted sentences.
+
+  This will aid in reviewing your pull request, and for adding it to the
+  changelog later.
+
+  You may remove sections that have no items if you want.
+--->
+
+## Added
+
+## Changed
+
+## Deprecated
+
+## Removed
+
+## Fixed

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@v2
+      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@v2
+
+    # ℹ️ 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@v2
+      with:
+        category: "/language:${{matrix.language}}"

data/.markdownlint.json

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

data/.rubocop.yml

@@ -1,44 +1,64 @@
-# Disable all metrics.
-Metrics/AbcSize:
-  Enabled: false
+require:
+  - rubocop-performance
+  - rubocop-rake
 
-Metrics/BlockNesting:
-  Enabled: false
+inherit_mode:
+  merge:
+    - AllowedNames
 
-Metrics/BlockLength:
-  Enabled: false
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
 
-Metrics/ClassLength:
+# Disable line length checks
+Layout/LineLength:
   Enabled: false
 
-Metrics/ModuleLength:
+# TODO: Larger refactor
+Lint/MissingSuper:
   Enabled: false
 
-Metrics/CyclomaticComplexity:
+# Allow 'Pokémon-style' exception handling
+Lint/RescueException:
   Enabled: false
 
-Metrics/LineLength:
+# Disable all metrics.
+Metrics:
   Enabled: false
 
-Metrics/MethodLength:
-  Enabled: false
+# Allow some common and/or obvious short method params
+Naming/MethodParameterName:
+  AllowedNames:
+    - e
 
-Metrics/ParameterLists:
+# Ignore `eval` in the examples folder
+Security/Eval:
+  Exclude:
+    - examples/**/*
+
+# https://stackoverflow.com/q/4763121/
+Style/Alias:
   Enabled: false
 
-Metrics/PerceivedComplexity:
+# 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
 
-# Allow CamelCase constants as well as SCREAMING_SNAKE_CASE
-Style/ConstantName:
+# So RuboCop doesn't complain about application IDs
+Style/NumericLiterals:
+  Exclude:
+    - examples/**/*
+
+# TODO: Requires breaking changes
+Style/OptionalBooleanParameter:
   Enabled: false
 
-# Allow 'Pokémon-style' exception handling
-Lint/RescueException:
+# Prefer explicit arguments in case global variables like `$;` or `$,` are changed
+Style/RedundantArgument:
   Enabled: false
 
 # Prefer |m, e| for the `reduce` block arguments
@@ -46,20 +66,3 @@ Style/SingleLineBlockParams:
   Methods:
     - reduce: [m, e]
     - inject: [m, e]
-
-AllCops:
-  TargetRubyVersion: 2.2
-
-# https://stackoverflow.com/q/4763121
-Style/Alias:
-  Enabled: false
-
-# So RuboCop doesn't complain about application IDs
-Style/NumericLiterals:
-  Exclude:
-    - examples/*
-
-# Ignore `eval` in the examples folder
-Security/Eval:
-  Exclude:
-    - examples/*