rubocop_challenger 2.0.0.pre10 → 2.3.0

data/lib/rubocop_challenger/pull_request.rb

@@ -21,12 +21,15 @@ module RubocopChallenger
     #   A target project ID. If does not supplied, this method will find a
     #   project which associated the repository. When the repository has
     #   multiple projects, you should supply this.
-    def initialize(user_name:, user_email:, **options)
+    # @option verbose [Boolean]
+    #   Displays executing command.
+    def initialize(user_name:, user_email:, **options) # rubocop:disable Metrics/MethodLength
       @pr_comet = PrComet.new(
         base: options[:base_branch],
         branch: "rubocop-challenge/#{timestamp}",
         user_name: user_name,
-        user_email: user_email
+        user_email: user_email,
+        verbose: options[:verbose]
       )
       @labels = options[:labels]
       @dry_run = options[:dry_run]
@@ -90,7 +93,7 @@ module RubocopChallenger
         project_id: project_id
       }.merge(pr_comet_options)
 
-      pr_comet.create!(options) unless dry_run
+      pr_comet.create!(**options) unless dry_run
     end
 
     # @param before_version [String]

data/lib/rubocop_challenger/rubocop/challenge.rb

@@ -4,16 +4,17 @@ module RubocopChallenger
   module Rubocop
     # To execute Rubocop Challenge flow
     class Challenge
-      def self.exec(file_path, mode)
-        new(file_path, mode).send(:exec)
+      def self.exec(file_path:, mode:, only_safe_auto_correct:)
+        new(file_path, mode, only_safe_auto_correct).send(:exec)
       end
 
       private
 
-      attr_reader :mode, :command, :todo_reader, :todo_writer
+      attr_reader :mode, :only_safe_auto_correct, :command, :todo_reader, :todo_writer
 
-      def initialize(file_path, mode)
+      def initialize(file_path, mode, only_safe_auto_correct)
         @mode = mode
+        @only_safe_auto_correct = only_safe_auto_correct
         @command = Rubocop::Command.new
         @todo_reader = Rubocop::TodoReader.new(file_path)
         @todo_writer = Rubocop::TodoWriter.new(file_path)
@@ -23,7 +24,7 @@ module RubocopChallenger
       def exec
         verify_target_rule
         todo_writer.delete_rule(target_rule)
-        command.auto_correct
+        command.auto_correct(only_safe_auto_correct: only_safe_auto_correct)
         target_rule
       end
 

data/lib/rubocop_challenger/rubocop/command.rb

@@ -7,8 +7,12 @@ module RubocopChallenger
       include PrComet::CommandLine
 
       # Executes auto correction
-      def auto_correct
-        run('--auto-correct')
+      def auto_correct(only_safe_auto_correct:)
+        if only_safe_auto_correct
+          run('--auto-correct')
+        else
+          run('--auto-correct-all')
+        end
       end
 
       # Generates `.rubocop_todo.yml`

data/lib/rubocop_challenger/rubocop/rule.rb

@@ -27,7 +27,7 @@ module RubocopChallenger
       end
 
       def auto_correctable?
-        contents =~ /# Cop supports --auto-correct/
+        contents.include?('# Cop supports --auto-correct')
       end
 
       def rubydoc_url

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
@@ -27,23 +34,28 @@ module RubocopChallenger
       # Loads gems for YARDoc creation
       def load_rspec_gems!
         RSPEC_GEMS.each do |dependency|
-          begin
-            require dependency
-          rescue LoadError
-            nil
-          end
+          require dependency
+        rescue LoadError
+          nil
         end
       end
 
       # 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
@@ -54,11 +66,15 @@ module RubocopChallenger
       end
 
       def source_file_path
-        instance_methods
-          .map { |m| cop_class.instance_method(m).source_location }
-          .reject(&:nil?)
-          .map(&:first)
-          .first
+        if Object.respond_to?(:const_source_location)
+          Object.const_source_location(cop_class.name).first
+        else
+          instance_methods
+            .map { |m| cop_class.instance_method(m).source_location }
+            .reject(&:nil?)
+            .map(&:first)
+            .first
+        end
       end
     end
   end

data/lib/rubocop_challenger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubocopChallenger
-  VERSION = '2.0.0.pre10'
+  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,37 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_challenger
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre10
+  version: 2.3.0
 platform: ruby
 authors:
 - ryosuke_sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-18 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pr_comet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-    - - "<"
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
-    - - "<"
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.87'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.87'
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -45,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -59,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -118,16 +140,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -188,16 +210,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
 description: Make a clean your rubocop_todo.yml with CI
 email:
 - r-sato@feedforce.jp
@@ -207,12 +229,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".dependabot/config.yml"
 - ".envrc.skeleton"
 - ".gem_comet.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_challenge.yml"
 - ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -261,14 +285,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Make a clean your rubocop_todo.yml with CI