discordrb 3.3.0 → 3.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b25d90cb65adea4d1dac0aa33b64f6451e1c21f7dbe13c48f2ae9d40ea5e2edf
-  data.tar.gz: 31e41074b2304456f73413af20ca1850757e34566af21067a4989656d78feb77
+  metadata.gz: a5c0ecfd68356ed63ea61a7b99bb5d32e358f74b23c2f729ab531e4848bc770d
+  data.tar.gz: 4c5917f1b7a1a3e97d875a0244a8fa8e9583bce025053505b960de9e900ca16f
 SHA512:
-  metadata.gz: 5bb79daa3219ec1c75f637ccaf39c71e943ba2e162c02ca46fd2775e7a746d4cfecafda8af8402d215936660249b96ae441632444d7718688badf19ae38f72fe
-  data.tar.gz: 71110b5df4bade1aac8d54b708bbc93b5a91d61c146eb56e9aa25a94f9dd0ff0f291db4c0c28589f095ab9fa19ed9204e50a0aaa920557c6fdc802d88eaa733a
+  metadata.gz: '09b5b31c7e7f15c7053c476ae0c2fd11839b7f5b82c4dea330764da42321c8333559df72273cdffbafe91bc9452a51a4bece945a2e6b3a8774af5fce409750fb'
+  data.tar.gz: 1743f21d2ad48858e8ebed88984fdf5cecb2ce5878ae0cbf32dbccc451175daa1d0f37c571efa100dadd94dcb169b17515bc691884d9583e00b40f57b45242ff

data/.circleci/config.yml

@@ -0,0 +1,126 @@
+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_25:
+    docker:
+      - image: ruby:2.5-alpine
+    steps:
+      - setup-env
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec
+
+  test_ruby_26:
+    docker:
+      - image: ruby:2.6-alpine
+    steps:
+      - setup-env
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec
+
+  test_ruby_27:
+    docker:
+      - image: ruby:2.7-alpine
+    steps:
+      - setup-env
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec
+
+  rubocop:
+    docker:
+      - image: ruby:2.5-alpine
+    steps:
+      - setup-env
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop -P
+
+  yard:
+    docker:
+      - image: ruby:2.5-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:
+    machine: true
+    steps:
+      - attach_workspace:
+          at: /tmp/workspace
+      - run:
+          name: Clone docs
+          command: 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_25
+      - test_ruby_26
+      - test_ruby_27
+      - rubocop
+      - yard
+  deploy:
+    jobs:
+      - yard:
+          filters: {branches: {only: main}, tags: {only: /^v.*/}}
+      - pages:
+          requires:
+            - yard
+          filters: {branches: {only: main}, tags: {only: /^v.*/}}

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+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,25 @@
+---
+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/.rubocop.yml

@@ -1,44 +1,58 @@
-# Disable all metrics.
-Metrics/AbcSize:
-  Enabled: false
+require: rubocop-performance
 
-Metrics/BlockNesting:
-  Enabled: false
+inherit_mode:
+  merge:
+    - AllowedNames
 
-Metrics/BlockLength:
-  Enabled: false
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
 
-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:
-  Enabled: false
+# Ignore `eval` in the examples folder
+Security/Eval:
+  Exclude:
+    - examples/**/*
 
-Metrics/PerceivedComplexity:
+# https://stackoverflow.com/q/4763121/
+Style/Alias:
   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 +60,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/*

data/.travis.yml

@@ -1,13 +1,12 @@
 language: ruby
 rvm:
-  - 2.2.10
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
+  - 2.5
+  - 2.6
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 -o ./cc-test-reporter
   - chmod +x ./cc-test-reporter
   - ./cc-test-reporter before-build
+  - sudo apt-get install libsodium-dev
 script:
   - bundle exec rspec spec
   - bundle exec rubocop -c .rubocop.yml
@@ -22,7 +21,7 @@ deploy:
     local-dir: docs
     on:
       branch: master
-      rvm: 2.5.1
+      rvm: 2.6
   - provider: pages
     skip-cleanup: true
     github-token: $GITHUB_TOKEN
@@ -30,4 +29,4 @@ deploy:
     local-dir: docs
     on:
       tags: true
-      rvm: 2.5.1
+      rvm: 2.6