codeowner_validator 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b7c6486b06a5d901e16a9832878588af1e3a053c2dc831a10ec391712019fba
-  data.tar.gz: b1d39da8af2673c74ba6d054588538c0c21b8b251333b8e65c83a1af970bc992
+  metadata.gz: af5d012aae29107c60cb74edc6bfaa3d56d6523b9413be3d0bc7d24cb5f9f3d3
+  data.tar.gz: 5886013628d005e5fe99e0a53d19a48a80b1cd378e98518ff66d4ccfc59bd809
 SHA512:
-  metadata.gz: eaf28f5df9af24d42f6b197fa75f3596f2549609917ed6b2cf8cfb6d70b9e4d3391b4a4c365723cd950e07cd5012db4308937ae2287d506d54318ca81fc91a99
-  data.tar.gz: e16eccee7010b4713cba8440d7e8d134ce9976d68a5a3437e1fa0e2531b3e6972696d9ce65877c0d4280e98288d495aec09221388bbe1abd3f2fed73c0aa32fb
+  metadata.gz: bd1a3bb3edf928012d9dab14eddb4c052ed7ed1e3fc43dcba5b36f8df71cdabbf0b628dcee5b5344d88f5a7af95423ea4d3fb8bfd4b5e3790da0d2dbac1b0b78
+  data.tar.gz: e5bda23020dd0abb542633c12b6bc03c1025e4b0d1d4bc96c981037937ea3713710fb92592173523dc39ae7cc4171b9be847e85bb74979450f076ea1255333bd

data/.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/danger-js@9.1.8
+      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

data/.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.

data/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))

data/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'

data/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'

data/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);

data/lib/codeowner_validator/code_owners.rb

@@ -262,10 +262,8 @@ module CodeownerValidator
       @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

data/lib/codeowner_validator/group/comment/error.rb

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

data/lib/codeowner_validator/group/comment/info.rb

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

data/lib/codeowner_validator/group/comment/verbose.rb

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

data/lib/codeowner_validator/group/comment/warn.rb

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

data/lib/codeowner_validator/lists/whitelist.rb

@@ -79,10 +79,8 @@ module CodeownerValidator
         @whitelist_file_paths = %w[CODEOWNERS_WHITELIST .github/CODEOWNERS_WHITELIST]
 
         # allow customization of the locations to search for the file
-        if ENV['CODEOWNER_WHITELIST_FILE_PATHS']
-          ENV['CODEOWNER_WHITELIST_FILE_PATHS']&.split(',')&.each(&:strip!)&.each do |str|
-            @whitelist_file_paths << str
-          end
+        ENV['CODEOWNER_WHITELIST_FILE_PATHS']&.split(',')&.each(&:strip!)&.each do |str|
+          @whitelist_file_paths << str
         end
 
         @whitelist_file_paths

data/lib/codeowner_validator/tasks/missing_assignment_checker.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'codeowner_validator/common/tasks/base'
+require 'codeowner_validator/group/comment'
 
 module CodeownerValidator
   module Tasks

data/lib/codeowner_validator/tasks/syntax_checker.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'codeowner_validator/common/tasks/base'
+require 'codeowner_validator/group/comment'
 
 module CodeownerValidator
   module Tasks

data/lib/codeowner_validator/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module CodeownerValidator
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 
   # version module
   module Version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeowner_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Greg Howdeshell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-15 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -34,14 +34,14 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.19'
 - !ruby/object:Gem::Dependency
@@ -157,6 +157,7 @@ files:
 - bin/rspec
 - bin/rubocop
 - codeowner_validator.gemspec
+- dangerfile.js
 - lib/codeowner_validator.rb
 - lib/codeowner_validator/cli/validator_cli.rb
 - lib/codeowner_validator/code_owners.rb
@@ -197,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Write a short summary, because RubyGems requires one.