Update version of thor to have a broader availability (#6)

Author: poloka

.github/workflows/ci.yml

@@ -4,7 +4,7 @@ name: CI
 
 on:
   push:
-    branches: ['**']
+    branches: ['main']
   pull_request:
     branches: ['main']
   schedule:
@@ -32,6 +32,13 @@ jobs:
         ruby-version: ${{ matrix.ruby }}
     - name: Install dependencies
       run: bundle install --jobs 4 --retry 3
+    - if: github.event_name == 'pull_request'
+      name: Danger
+      uses: danger/[email protected]
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        # https://github.com/danger/danger-js/issues/557#issuecomment-664851950
+        DANGER_DISABLE_TRANSPILATION: true
     - name: Run tests
       run: bundle exec rspec
     - name: Run Rubocop

.rubocop.yml

@@ -1,18 +1,13 @@
 require:
   - rubocop-performance
-  - rubocop-rspec
-  - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.6
   DisabledByDefault: true
   Exclude:
-    - 'bin/{bundle,bundle-audit,bundler-audit,rake,rspec,rubocop}'
+    - 'bin/{bundle,bundle-audit,bundler-audit,rackup,rake,rspec,rubocop}'
     - 'target/**/*'
     - 'vendor/**/*'
-    - 'build/**/*'
-    - 'pkg/**/*'
-    - 'tmp/**/*'
+  SuggestExtensions: false
 
 # Bundler Cop Configuration
 # https://docs.rubocop.org/en/stable/cops_bundler/
@@ -240,7 +235,7 @@ Lint/AssignmentInCondition:
   Enabled: true
 Lint/BigDecimalNew:
   Enabled: true
-# Supercedes Lint/UselessComparison in rubocop 0.89.
+# Supersedes Lint/UselessComparison in rubocop 0.89.
 Lint/BinaryOperatorWithIdenticalOperands:
   Enabled: true
 Lint/BooleanSymbol:
@@ -301,7 +296,7 @@ Lint/MissingCopEnableDirective:
   Enabled: true
 Lint/MissingSuper:
   # Disabled. This cop is well-meaning, but doesn't provide exemption of cases where invocation of
-  # super is not possible. Supercedes Style/MethodMissingSuper in rubocop 0.89.
+  # super is not possible. Supersedes Style/MethodMissingSuper in rubocop 0.89.
     Enabled: false
 Lint/MultipleComparison:
   Enabled: true
@@ -387,8 +382,6 @@ Lint/UselessAccessModifier:
   Enabled: true
 Lint/UselessAssignment:
   Enabled: true
-Lint/UselessElseWithoutRescue:
-  Enabled: true
 Lint/UselessSetterCall:
   Enabled: true
 Lint/Void:
@@ -451,7 +444,7 @@ Naming/MemoizedInstanceVariableName:
   Enabled: true
 Naming/MethodName:
   Enabled: true
-  IgnoredPatterns:
+  AllowedPatterns:
     - 'do_GET'
     - 'do_POST'
     - 'do_PUT'
@@ -467,9 +460,10 @@ Naming/RescuedExceptionsVariableName:
   Enabled: false
 Naming/VariableName:
   Enabled: true
+# Disabled. It's acceptable (and in heavy usage already) to name things like "data_model_1"
+# instead of forcing "data_model1".
 Naming/VariableNumber:
-  Enabled: true
-
+  Enabled: false
 
 # Performance Cop Configuration
 # https://rubocop-performance.readthedocs.io/en/stable/cops_performance/
@@ -604,15 +598,11 @@ Style/DefWithParentheses:
 Style/Dir:
   Enabled: true
 Style/Documentation:
-  Enabled: true
-  Exclude:
-    - test/**/*
-    - spec/**/*
+# Disabled. Documentation is required, but enforcement here does not seem to work.
+  Enabled: false
 Style/DocumentationMethod:
-  Enabled: true
-  Exclude:
-    - test/**/*
-    - spec/**/*
+# Disabled. Documentation is required, but enforcement here does not seem to work.
+  Enabled: false
 Style/DoubleCopDisableDirective:
   Enabled: true
 Style/DoubleNegation:
@@ -703,7 +693,7 @@ Style/MethodCallWithoutArgsParentheses:
   Enabled: true
 Style/MethodCalledOnDoEndBlock:
 # Disabled. It is acceptable to call a method at the end of a do/end block. In particular, this is
-# occationally needed in RSpec code.
+# occasionally needed in RSpec code.
   Enabled: false
 Style/MethodDefParentheses:
   Enabled: true
@@ -803,7 +793,8 @@ Style/RedundantCondition:
 Style/RedundantConditional:
   Enabled: true
 Style/RedundantException:
-  Enabled: true
+# Disabled.  With ImplicitRuntimeError enabled, disable subsequent warning if consumer wishes to continue using RuntimeError
+  Enabled: false
 Style/RedundantFreeze:
   Enabled: true
 Style/RedundantInterpolation:
@@ -855,8 +846,8 @@ Style/SpecialGlobalVars:
 Style/StabbyLambdaParentheses:
   Enabled: true
 Style/StderrPuts:
-# Disabled. This cop functionally equates use of STDERR with optional warnings. This may be true in some use cases, but there
-#           are times when using STDERR in CLIs is not an optional warning.
+# Disabled. This cop functionally equates use of STDERR with optional warnings. This may be true
+# in some use cases, but there are times when using STDERR in CLIs is not an optional warning.
   Enabled: false
 Style/StringHashKeys:
 # Disabled. There are many use cases where using Strings for Hash keys is required.

CHANGELOG.md

@@ -1,5 +1,8 @@
 # 0.1.0
-Initial release
+- Initial release
 
 # 0.1.1
-Fix homepage reference
+- Fix homepage reference
+
+# 0.2.0
+- Update version of thor to have a broader availability ([#6](https://github.com/cerner/codeowner_validator/pull/6))

Gemfile

@@ -14,7 +14,3 @@ gem 'rubocop-performance', '~> 1.8', require: false
 gem 'rubocop-rake', '~> 0.5', require: false
 gem 'rubocop-rspec', '~> 2.1', require: false
 gem 'simplecov', '~> 0.19', require: false
-
-# debugging
-gem 'debase', '~> 0.2.5.beta2'
-gem 'ruby-debug-ide'

codeowner_validator.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.6.2'
 
   spec.add_dependency 'rainbow', '>= 2.0', '< 4.0.0'
-  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'thor', '>= 0.19'
 
   spec.add_dependency 'tty-prompt', '~> 0.12'
   spec.add_dependency 'tty-spinner', '~> 0.4'

dangerfile.js

@@ -0,0 +1,97 @@
+const PR_LINK = `([#${danger.github.pr.number}](${danger.github.pr.html_url}))`;
+
+const CHANGELOG_SUMMARY_TITLE = `Instructions and example for changelog`;
+const CHANGELOG_BODY = `Please add an entry to \`CHANGELOG.md\` to the "Unreleased" section. Make sure the entry includes this PR's number.
+
+Example:`;
+
+const CHANGELOG_END_BODY = `If none of the above apply, you can opt out of this check by adding \`#skip-changelog\` to the PR description.`;
+
+function getCleanTitleWithPrLink() {
+  const title = danger.github.pr.title;
+  return title.split(": ").slice(-1)[0].trim().replace(/\.+$/, "") + ` ` + PR_LINK;
+}
+
+function getChangelogDetailsHtml() {
+  return `
+### ${CHANGELOG_SUMMARY_TITLE}
+
+${CHANGELOG_BODY}
+
+\`\`\`markdown
+- ${getCleanTitleWithPrLink()}
+\`\`\`
+
+${CHANGELOG_END_BODY}
+`;
+}
+
+function getChangelogDetailsTxt() {
+  return (
+    CHANGELOG_SUMMARY_TITLE +
+    "\n" +
+    CHANGELOG_BODY +
+    "\n" +
+    getCleanTitleWithPrLink() +
+    "\n" +
+    CHANGELOG_END_BODY
+  );
+}
+
+function HasPermissionToComment() {
+  return (
+    danger.github.pr.head.repo.git_url == danger.github.pr.base.repo.git_url
+  );
+}
+
+async function containsChangelog(path) {
+  const contents = await danger.github.utils.fileContents(path);
+  return contents.includes(PR_LINK);
+}
+
+async function checkChangelog() {
+  const skipChangelog =
+    danger.github && (danger.github.pr.body + "").toLowerCase().includes("#skip-changelog");
+  if (skipChangelog) {
+    return;
+  }
+
+  const hasChangelog = await containsChangelog("CHANGELOG.md");
+
+  if (!hasChangelog) {
+    if (HasPermissionToComment()) {
+      fail("Please consider adding a changelog entry for the next release.");
+      markdown(getChangelogDetailsHtml());
+    } else {
+      //Fallback
+      console.log(
+        "Please consider adding a changelog entry for the next release."
+      );
+      console.log(getChangelogDetailsTxt());
+      process.exitCode = 1;
+    }
+  }
+}
+
+async function checkIfFeature() {
+  const title = danger.github.pr.title;
+  if (title.startsWith("feat:") && HasPermissionToComment()) {
+    message(
+      'Do not forget to update <a href="https://github.com/getsentry/sentry-docs">Sentry-docs</a> with your feature once the pull request gets approved.'
+    );
+  }
+}
+
+async function checkAll() {
+  // See: https://spectrum.chat/danger/javascript/support-for-github-draft-prs~82948576-ce84-40e7-a043-7675e5bf5690
+  const isDraft = danger.github.pr.mergeable_state === "draft";
+
+  if (isDraft) {
+    return;
+  }
+
+  await checkIfFeature();
+  await checkChangelog();
+}
+
+schedule(checkAll);

lib/codeowner_validator/code_owners.rb

@@ -262,10 +262,8 @@ def codeowner_file_paths
       @codeowner_file_paths = %w[CODEOWNERS docs/CODEOWNERS .github/CODEOWNERS]
 
       # allow customization of the locations to search for the file
-      if ENV['CODEOWNER_FILE_PATHS']
-        ENV['CODEOWNER_FILE_PATHS']&.split(',')&.each(&:strip!)&.each do |str|
-          @codeowner_file_paths << str
-        end
+      ENV['CODEOWNER_FILE_PATHS']&.split(',')&.each(&:strip!)&.each do |str|
+        @codeowner_file_paths << str
       end
 
       @codeowner_file_paths

lib/codeowner_validator/group/comment/error.rb

@@ -12,7 +12,7 @@ class Error
         class << self
           # @see CodeownerValidator::Group::Comment.match?
           def match?(type)
-            Comment::TYPE_ERROR == type
+            type == Comment::TYPE_ERROR
           end
         end
       end

lib/codeowner_validator/group/comment/info.rb

@@ -12,7 +12,7 @@ class Info
         class << self
           # @see CodeownerValidator::Group::Comment.match?
           def match?(type)
-            Comment::TYPE_INFO == type
+            type == Comment::TYPE_INFO
           end
         end
       end

lib/codeowner_validator/group/comment/verbose.rb

@@ -12,7 +12,7 @@ class Verbose
         class << self
           # @see CodeownerValidator::Group::Comment.match?
           def match?(type)
-            Comment::TYPE_VERBOSE == type
+            type == Comment::TYPE_VERBOSE
           end
         end
       end