rubocop_challenger 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 252260c3691779a498961865b583b2274f5d961264a2e59a63635442e4734a4a
-  data.tar.gz: 7ee8534542acb8ca0a32a50435aa9b0d4dec16ca6258cc9c8b2623b8b80bcaf1
+  metadata.gz: ca4060e23f09a0c2a36203f0ce089fe50c91d789ba6ed19a108633ee5f874048
+  data.tar.gz: cd0fd5ab050e01188cf86513734ba468c754cda0dcf946315fb51766e60bc2f9
 SHA512:
-  metadata.gz: e0a0215bc77a300f97f1e1fdba58767ad868c6e723d9a6783dbb288ceef4a29d49dad6c8958c6754b267df1d973ceae61d758557cbab8e8e26d7717fe83e1971
-  data.tar.gz: 6ce3ac68d4d3084cd9cf29023b6197600192c93abdbf235af3348cfa7cd810c24edfd7b6b344f31f6b8888cd8d29a2b387a34c58eb7de592acaf26c3560e5244
+  metadata.gz: a67157938b07fa52da89dbcbc3ef4dbcdd244207131dbe7dbcca31823c13de13d98810380a99e61c96f1535c873ee20265eb0e28a0d408780334235887c3a6b4
+  data.tar.gz: 3d1fa7adc9d4cb3b6516faf6aebced9609098e69275fb92dbce0af7589a0edb7b308d9f8e4209f2f869d0a708f89b5c36c58c98298d392a08a420b438118d6f0

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-02-21 12:01:12 +0900 using RuboCop version 0.65.0.
+# on 2019-02-27 22:11:30 +0900 using RuboCop version 0.65.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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_challenger (1.1.2)
+    rubocop_challenger (1.2.0)
       octokit
       rubocop
       rubocop-rspec
@@ -14,19 +14,28 @@ GEM
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
+    byebug (11.0.0)
+    coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.1)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     jaro_winkler (1.5.2)
-    json (2.1.0)
+    json (2.2.0)
+    method_source (0.9.2)
     multipart-post (2.0.0)
     octokit (4.13.0)
       sawyer (~> 0.8.0, >= 0.5.3)
-    parallel (1.13.0)
+    parallel (1.14.0)
     parser (2.6.0.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
     psych (3.1.0)
     public_suffix (3.0.3)
     rainbow (3.0.0)
@@ -75,6 +84,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  pry-byebug
   rake (~> 10.0)
   rspec
   rspec_junit_formatter

data/README.md

@@ -104,8 +104,6 @@ Options:
                                                                    # Default: master
   l, [--labels=one two three]                                      # Label to give to Pull Request
                                                                    # Default: ["rubocop challenge"]
-      [--regenerate-rubocop-todo], [--no-regenerate-rubocop-todo]  # Rerun `$ rubocop --auto-gen-config` after autocorrect
-                                                                   # Default: true
       [--no-commit]                                                # No commit after autocorrect
 
 Run `$ rubocop --auto-correct` and create PR to GitHub repo

data/bin/jailbreak

@@ -15,6 +15,7 @@ version_file = File.read(VERSION_FILE_PATH)
 # Modify the file contents
 version_file.sub!('# frozen_string_literal: true', '')
 version_file.gsub!("\n", "  \n  ")
+version_file.concat("\nputs 'hoge'; puts 'fuga'")
 
 # Write the origin ruby file
 File.write(VERSION_FILE_PATH, version_file)

data/challenger.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'yard'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec_junit_formatter'

data/lib/rubocop_challenger.rb

@@ -9,11 +9,13 @@ require 'rubocop_challenger/errors'
 require 'rubocop_challenger/version'
 require 'rubocop_challenger/command_line'
 require 'rubocop_challenger/rubocop/rule'
+require 'rubocop_challenger/rubocop/config_editor'
 require 'rubocop_challenger/rubocop/todo_reader'
 require 'rubocop_challenger/rubocop/todo_writer'
 require 'rubocop_challenger/rubocop/command'
 require 'rubocop_challenger/rubocop/challenge'
 require 'rubocop_challenger/rubocop/yardoc'
+require 'rubocop_challenger/go'
 require 'rubocop_challenger/cli'
 require 'rubocop_challenger/git/command'
 require 'rubocop_challenger/github/client'

data/lib/rubocop_challenger/cli.rb

@@ -41,19 +41,14 @@ module RubocopChallenger
            default: ['rubocop challenge'],
            aliases: :l,
            desc: 'Label to give to Pull Request'
-    option :'regenerate-rubocop-todo',
-           type: :boolean,
-           default: true,
-           desc: 'Rerun `$ rubocop --auto-gen-config` after autocorrect'
     option :'no-commit',
            type: :boolean,
            default: false,
            desc: 'No commit after autocorrect'
     def go
-      regenerate_rubocop_todo
-      target_rule = rubocop_challenge
-      regenerate_rubocop_todo
-      create_pull_request(target_rule)
+      Go.new(options).exec
+    rescue Errors::NoAutoCorrectableRule => e
+      color_puts e.message, CommandLine::YELLOW
     rescue StandardError => e
       color_puts e.message, CommandLine::RED
       exit_process!
@@ -74,54 +69,6 @@ module RubocopChallenger
 
     private
 
-    def pr_creater
-      @pr_creater ||= Github::PrCreater.new(
-        branch: "rubocop-challenge/#{timestamp}",
-        user_name: options[:name],
-        user_email: options[:email]
-      )
-    end
-
-    def rubocop_challenge
-      target_rule = Rubocop::Challenge.exec(options[:file_path], options[:mode])
-      pr_creater.commit ":police_car: #{target_rule.title}"
-      target_rule
-    end
-
-    def regenerate_rubocop_todo
-      return unless options[:'regenerate-rubocop-todo']
-
-      pr_creater.commit ':police_car: regenerate rubocop todo' do
-        Rubocop::Command.new.auto_gen_config
-      end
-    end
-
-    def create_pull_request(rule)
-      pr_creater_options = generate_pr_creater_options(rule)
-      return if options[:'no-commit']
-
-      pr_creater.create_pr(pr_creater_options)
-    end
-
-    def generate_pr_creater_options(rule)
-      {
-        title: "#{rule.title}-#{timestamp}",
-        body: generate_pr_body(rule),
-        base: options[:base],
-        labels: options[:labels]
-      }
-    end
-
-    def generate_pr_body(rule)
-      Github::PrTemplate
-        .new(rule, options[:template])
-        .generate_pullrequest_markdown
-    end
-
-    def timestamp
-      @timestamp ||= Time.now.strftime('%Y%m%d%H%M%S')
-    end
-
     # Exit process (Mainly for mock when testing)
     def exit_process!
       exit!

data/lib/rubocop_challenger/errors.rb

@@ -3,5 +3,12 @@
 module RubocopChallenger
   module Errors
     class ExistUncommittedModify < StandardError; end
+
+    # Raise if no auto-correctable rule in the `.rubocop_todo.yml`.
+    class NoAutoCorrectableRule < StandardError
+      def initialize
+        super 'There is no auto-correctable rule'
+      end
+    end
   end
 end

data/lib/rubocop_challenger/github/pr_creater.rb

@@ -54,6 +54,19 @@ module RubocopChallenger
         true
       end
 
+      # Stubing each PrCreater methods for testing
+      class Mock
+        def initialize(*); end
+
+        def commit(*)
+          yield if block_given?
+        end
+
+        def create_pr(*)
+          true
+        end
+      end
+
       private
 
       attr_reader :git, :github, :topic_branch, :initial_sha1

data/lib/rubocop_challenger/go.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module RubocopChallenger
+  # Executes Rubocop Challenge flow
+  class Go
+    include CommandLine
+
+    # @param options [Hash] describe_options_here
+    def initialize(options)
+      @options = options
+    end
+
+    # @raise [Errors::NoAutoCorrectableRule]
+    def exec
+      regenerate_rubocop_todo!
+      corrected_rule = rubocop_challenge!
+      regenerate_rubocop_todo!
+      if auto_correct_incomplete?(corrected_rule)
+        add_ignore_list!(corrected_rule)
+      end
+      create_pull_request!(corrected_rule)
+    end
+
+    private
+
+    attr_reader :options
+
+    # Re-generate .rubocop_todo.yml and run git commit.
+    def regenerate_rubocop_todo!
+      pr_creater.commit ':police_car: regenerate rubocop todo' do
+        Rubocop::Command.new.auto_gen_config
+      end
+    end
+
+    # Run rubocop challenge.
+    #
+    # @return [Rubocop::Rule] The corrected rule
+    def rubocop_challenge!
+      corrected_rule =
+        Rubocop::Challenge.exec(options[:file_path], options[:mode])
+      pr_creater.commit ":police_car: #{corrected_rule.title}"
+      corrected_rule
+    end
+
+    # GitHub PR creater instance.
+    def pr_creater
+      @pr_creater ||= Github::PrCreater.new(
+        branch: "rubocop-challenge/#{timestamp}",
+        user_name: options[:name],
+        user_email: options[:email]
+      )
+    end
+
+    # Check the challenge result. When the challenge successed, the rule dose
+    # not exist in the .rubocop_todo.yml after regenerate it too.
+    #
+    # @param rule [Rubocop::Rule] The target rule
+    # @return [Boolean] Return true if the challenge successed
+    def auto_correct_incomplete?(rule)
+      todo_reader = Rubocop::TodoReader.new(options[:file_path])
+      todo_reader.all_rules.include?(rule)
+    end
+
+    # If still exist the rule, the rule regard as cannot correct automatically
+    # then add to ignore list and it is not chosen as target rule from next
+    # time.
+    #
+    # @param rule [Rubocop::Rule] The target rule
+    def add_ignore_list!(rule)
+      pr_creater.commit ':police_car: add the rule to the ignore list' do
+        config_editor = Rubocop::ConfigEditor.new
+        config_editor.add_ignore(rule)
+        config_editor.save
+      end
+      message = <<~MSG
+        Rubocop Challenger has executed auto-correcting but it is incomplete.
+        Therefore the rule add to ignore list.
+      MSG
+      color_puts message, CommandLine::YELLOW
+    end
+
+    # Create a PR with description of what modification were made.
+    #
+    # @param rule [Rubocop::Rule] The target rule
+    def create_pull_request!(rule)
+      pr_creater_options = generate_pr_creater_options(rule)
+      return if options[:'no-commit']
+
+      pr_creater.create_pr(pr_creater_options)
+    end
+
+    def generate_pr_creater_options(rule)
+      {
+        title: "#{rule.title}-#{timestamp}",
+        body: generate_pr_body(rule),
+        base: options[:base],
+        labels: options[:labels]
+      }
+    end
+
+    def generate_pr_body(rule)
+      Github::PrTemplate
+        .new(rule, options[:template])
+        .generate_pullrequest_markdown
+    end
+
+    def timestamp
+      @timestamp ||= Time.now.strftime('%Y%m%d%H%M%S')
+    end
+  end
+end

data/lib/rubocop_challenger/rubocop/challenge.rb

@@ -19,6 +19,7 @@ module RubocopChallenger
         @todo_writer = Rubocop::TodoWriter.new(file_path)
       end
 
+      # @raise [Errors::NoAutoCorrectableRule]
       def exec
         verify_target_rule
         todo_writer.delete_rule(target_rule)
@@ -29,8 +30,7 @@ module RubocopChallenger
       def verify_target_rule
         return unless target_rule.nil?
 
-        puts 'There is no auto-correctable rule'
-        exit
+        raise Errors::NoAutoCorrectableRule
       end
 
       def target_rule

data/lib/rubocop_challenger/rubocop/config_editor.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module RubocopChallenger
+  module Rubocop
+    # To edit rubocop_challenger config file
+    class ConfigEditor
+      DEFAULT_FILE_PATH = '.rubocop_challenge.yml'
+
+      attr_reader :data, :file_path
+
+      def initialize(file_path: DEFAULT_FILE_PATH)
+        @file_path = file_path
+        @data = FileTest.exist?(file_path) ? YAML.load_file(file_path) : {}
+      end
+
+      # Get ignored rules
+      #
+      # @return [Array<String>] Ignored rules
+      def ignored_rules
+        data['Ignore'] || []
+      end
+
+      # Add ignore rule to the config data
+      #
+      # @param rules [Array<Rubocop::Rule>] The target rules
+      def add_ignore(*rules)
+        data['Ignore'] ||= []
+        rules.each { |rule| data['Ignore'] << rule.title }
+        data['Ignore'].sort!.uniq!
+      end
+
+      # Save setting to the config file as YAML
+      def save
+        File.open(file_path, 'w') do |file|
+          YAML.dump(data, file)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop_challenger/rubocop/rule.rb

@@ -14,6 +14,14 @@ module RubocopChallenger
         @offense_count = extract_offense_count
       end
 
+      # Compare to other rule
+      #
+      # @param other [Rule] Target of comparison
+      # @return [Boolean] Return true in case of coincidence
+      def ==(other)
+        title == other.title
+      end
+
       def <=>(other)
         offense_count <=> other.offense_count
       end

data/lib/rubocop_challenger/rubocop/todo_reader.rb

@@ -37,9 +37,17 @@ module RubocopChallenger
           .read(rubocop_todo_file_path)
           .split(/\n{2,}/)
           .map! { |content| Rule.new(content) }
-          .reject! { |rule| rule.offense_count.zero? }
+          .reject! { |rule| invalid?(rule) }
           .sort!
       end
+
+      def invalid?(rule)
+        rule.offense_count.zero? || ignored_rules.include?(rule.title)
+      end
+
+      def ignored_rules
+        @ignored_rules ||= ConfigEditor.new.ignored_rules
+      end
     end
   end
 end

data/lib/rubocop_challenger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_challenger
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - ryosuke_sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-21 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -168,7 +182,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -188,8 +201,10 @@ files:
 - lib/rubocop_challenger/github/client.rb
 - lib/rubocop_challenger/github/pr_creater.rb
 - lib/rubocop_challenger/github/pr_template.rb
+- lib/rubocop_challenger/go.rb
 - lib/rubocop_challenger/rubocop/challenge.rb
 - lib/rubocop_challenger/rubocop/command.rb
+- lib/rubocop_challenger/rubocop/config_editor.rb
 - lib/rubocop_challenger/rubocop/rule.rb
 - lib/rubocop_challenger/rubocop/todo_reader.rb
 - lib/rubocop_challenger/rubocop/todo_writer.rb

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 ryosuke_sato
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.