rubocop_challenger 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9de614d27c025b681596e5f3e59cfdd0faf220647f6d5f74b5ba1d1b6e3c4714
-  data.tar.gz: 7a7f66167b732e1db0c24dc764f568ebf65f8379cfa8f00ea77e16f3659fa075
+  metadata.gz: bde919f42750c43651a3ba58f00ef400b79f7cea3f0c2ff1b64881f6ee102a8d
+  data.tar.gz: ff457584a6703667d588d6f744762f1219f23a64eee85c0e09fdd471fef734ca
 SHA512:
-  metadata.gz: 4b808e5e3d05bed8fc1793d812eded0b17168d392ae0219bdfe96ccb5a1be77cdc9bb96e3d33b40c91f8f1deb354cec555fdd563f5e2f1c5b4c3fd53b774e9ab
-  data.tar.gz: 128d208942ccd3d8d198a4bdf506428e0efcfb766d898fc6e606b1cc6fe2f445be63269ac1742ed80e731c8c2a621b90f63af8afb03d33bc24eb28e3835d4225
+  metadata.gz: 82858f597d72c55790f1766d8bfb804afd74aac984579d83e05e4fc2c5db0c36a8b6259c614f4155b4e636963aeb19e0ce1c09ea7f709f594500838fec5615e2
+  data.tar.gz: d36e502a7cc7aace9ed87440cc19b8f1b025141c8c769787f85fda86285b903793458cbf96cbe32580af57098f35e361adb4e253d8c7770c3709a536e8b10e92

data/.circleci/config.yml

@@ -5,7 +5,7 @@
 version: 2.1
 
 orbs:
-  ruby-orbs: sue445/ruby-orbs@1.6.1
+  ruby-orbs: sue445/ruby-orbs@1.6.2
   code-climate: rvla/code-climate@0.0.2
 
 references:

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --exclude-limit 30 --no-auto-gen-timestamp`
-# using RuboCop version 1.8.0.
+# using RuboCop version 1.10.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change log
 
+## v2.3.0 (Feb 23, 2021)
+
+### Feature
+
+* [#465](https://github.com/ryz310/rubocop_challenger/pull/465) Add description whether the challenge is created by safe autocorrect or not ([@ryz310](https://github.com/ryz310))
+
+### Rubocop Challenge
+
+* [#464](https://github.com/ryz310/rubocop_challenger/pull/464) Re-generate .rubocop_todo.yml with RuboCop v1.10.0 ([@ryz310](https://github.com/ryz310))
+
+### Dependabot
+
+* [#453](https://github.com/ryz310/rubocop_challenger/pull/453) ryz310/dependabot/bundler/thor-1.1.0 ([@ryz310](https://github.com/ryz310))
+* [#457](https://github.com/ryz310/rubocop_challenger/pull/457) ryz310/dependabot/bundler/rubocop-1.9.1 ([@ryz310](https://github.com/ryz310))
+* [#461](https://github.com/ryz310/rubocop_challenger/pull/461) Update ruby-orbs orb to v1.6.2 ([@ryz310](https://github.com/ryz310))
+
 ## v2.2.0 (Jan 11, 2021)
 
 ### Feature

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_challenger (2.2.0)
+    rubocop_challenger (2.3.0)
       pr_comet (~> 0.5.1)
       rainbow
       rubocop (>= 0.87)
@@ -15,7 +15,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.1)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -23,18 +23,18 @@ GEM
       zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
+    ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
-    docile (1.3.4)
+    docile (1.3.5)
     faraday (1.3.0)
       faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
-    faraday-net_http (1.0.0)
-    i18n (1.8.7)
+    faraday-net_http (1.0.1)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     minitest (5.14.3)
@@ -58,7 +58,7 @@ GEM
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.0.3)
+    regexp_parser (2.1.0)
     rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -69,13 +69,13 @@ GEM
     rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
+    rspec-support (3.10.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.8.1)
+    rubocop (1.10.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -84,7 +84,7 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     rubocop-performance (1.9.2)
       rubocop (>= 0.90.0, < 2.0)
@@ -95,11 +95,11 @@ GEM
       rubocop (>= 0.90.0, < 2.0)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (2.1.0)
+    rubocop-rspec (2.2.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.2)
+    ruby2_keywords (0.0.4)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
@@ -109,7 +109,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.2)
-    thor (1.0.1)
+    thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)

data/lib/rubocop_challenger/github/pr_template.rb

@@ -53,6 +53,10 @@ module RubocopChallenger
         yardoc.examples
       end
 
+      def safe_autocorrect?
+        yardoc.safe_autocorrect?
+      end
+
       def yardoc
         @yardoc ||= Rubocop::Yardoc.new(title)
       end

data/lib/rubocop_challenger/rubocop/yardoc.rb

@@ -4,12 +4,10 @@ module RubocopChallenger
   module Rubocop
     # To read YARD style documentation from rubocop gem source code
     class Yardoc
-      def initialize(title)
+      def initialize(cop)
         load_rspec_gems!
-        @cop_class = find_cop_class(title)
-        YARD.parse(source_file_path)
-        @yardoc = YARD::Registry.all(:class).first
-        YARD::Registry.clear
+        @cop_class = find_cop_class(cop)
+        load_yardoc!
       end
 
       def description
@@ -20,6 +18,15 @@ module RubocopChallenger
         yardoc.tags('example').map { |tag| [tag.name, tag.text] }
       end
 
+      # Indicates whether the auto-correct a cop does is safe (equivalent) by design.
+      # If a cop is unsafe its auto-correct automatically becomes unsafe as well.
+      #
+      # @return [Boolean]
+      def safe_autocorrect?
+        config = RuboCop::ConfigLoader.default_configuration
+        cop_class.new(config).safe_autocorrect?
+      end
+
       private
 
       attr_reader :cop_class, :yardoc
@@ -36,12 +43,19 @@ module RubocopChallenger
       # Find a RuboCop class by cop name. It find from rubocop/rspec if cannot
       # find any class from rubocop gem.
       #
-      # @param cop_name [String] The target cop name
-      # @return [Class] Found RuboCop class
-      def find_cop_class(cop_name)
-        Object.const_get("RuboCop::Cop::#{cop_name.sub('/', '::')}")
+      # @param cop [String] The target cop name (e.g. "Performance/Size")
+      # @return [RuboCop::Cop] Found a RuboCop::Cop class
+      def find_cop_class(cop)
+        Object.const_get("RuboCop::Cop::#{cop.sub('/', '::')}")
       rescue NameError
-        Object.const_get("RuboCop::Cop::RSpec::#{cop_name.sub('/', '::')}")
+        Object.const_get("RuboCop::Cop::RSpec::#{cop.sub('/', '::')}")
+      end
+
+      # Loads yardoc from the RuboCop::Cop class file
+      def load_yardoc!
+        YARD.parse(source_file_path)
+        @yardoc = YARD::Registry.all(:class).first
+        YARD::Registry.clear
       end
 
       def instance_methods

data/lib/rubocop_challenger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubocopChallenger
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/lib/templates/checklist.md.erb

@@ -2,6 +2,14 @@
 
 [<%= title %>](<%= rubydoc_url %>)
 
+<% if safe_autocorrect? -%>
+**Safe autocorrect: true**
+:white_check_mark: The auto-correct a cop does is safe (equivalent) by design.
+<% else -%>
+**Safe autocorrect: false**
+:warning: The auto-correct a cop can yield false positives by design.
+<% end -%>
+
 ## Description
 
 > ### Overview

data/lib/templates/default.md.erb

@@ -2,6 +2,14 @@
 
 [<%= title %>](<%= rubydoc_url %>)
 
+<% if safe_autocorrect? -%>
+**Safe autocorrect: true**
+:white_check_mark: The auto-correct a cop does is safe (equivalent) by design.
+<% else -%>
+**Safe autocorrect: false**
+:warning: The auto-correct a cop can yield false positives by design.
+<% end -%>
+
 ## Description
 
 > ### Overview

data/lib/templates/error.md.erb

@@ -4,7 +4,7 @@
 
 ## Description
 
-Sorry! Something went wrong! :bow:
+Failed to create the cop description.
 Please report bugs [here](https://github.com/ryz310/rubocop_challenger/issues/new?assignees=ryz310&labels=bug&template=bug_report.md) with following error information.
 
 ```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_challenger
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - ryosuke_sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pr_comet