rubocop_challenger 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40f8fcb01f5f8042e319fd2a2a905721990668cd494cc50bec470b6ffabc12a3
-  data.tar.gz: 593b6be5d9618421567add1d2fe294b45d25bdfe8dbf2b43b429ae298e058041
+  metadata.gz: 5c793807b7c62bf1aa08436ec4d4de3630a00825e239d8c5d6122f94651b7dd1
+  data.tar.gz: 50d56cc0b7da03c6f66d6aa93b6e5e814f0b6061997f727b8393bbc85487cc02
 SHA512:
-  metadata.gz: 7090a68fc1b3df7ffc1084ecd872885f87606774abcfe1c3d6f3f5bb072384c8b2d65e2d18f0e435bd861743c77ecc41b879e60710d9de46e54b2fb92ef6f258
-  data.tar.gz: 07e9af06dda7f5ab328b47d11c7a48db64517646e5f9314e4b429f0516f825a302e83c643ca02fd418b478c74396ad2d5f13eabe61aa7dc57bbc4304a19e9142
+  metadata.gz: 39ac6e8bb72d0b7a0e941a33dd09a0dd1701c9d59fb3557a7096e0f383c76ee042a29da225bbc80fbc505d2cbfd1e3eced511ef68b90c3a555153ab2f3a85ff1
+  data.tar.gz: 49f651edd5fd9601ecac5f3fca3914c2f373efd8fab4dcd9df5fdb40328f811b3851644efdc1487a30134427dc2fc029f1904e52a892057007f5c18baece123a

data/.rubocop_todo.yml

@@ -1,17 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-10-15 12:27:50 +0900 using RuboCop version 0.59.2.
+# on 2018-10-21 01:10:29 +0900 using RuboCop version 0.59.2.
 # 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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Layout/LeadingBlankLines:
-  Exclude:
-    - 'rubocop_challenger.gemspec'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
@@ -21,24 +15,19 @@ Layout/SpaceInsideBlockBraces:
   Exclude:
     - 'Gemfile'
 
-# Offense count: 3
+# Offense count: 5
 # Configuration parameters: CountComments, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
   Max: 132
 
-# Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/MethodLength:
-  Max: 13
-
 # Offense count: 2
 # Configuration parameters: Max.
 RSpec/ExampleLength:
   Exclude:
     - 'spec/rubocop_challenger/rubocop/todo_reader_spec.rb'
 
-# Offense count: 6
+# Offense count: 7
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -46,19 +35,11 @@ Style/Documentation:
     - 'lib/rubocop_challenger.rb'
     - 'lib/rubocop_challenger/cli.rb'
     - 'lib/rubocop_challenger/rubocop/challenge.rb'
+    - 'lib/rubocop_challenger/rubocop/command.rb'
     - 'lib/rubocop_challenger/rubocop/rule.rb'
     - 'lib/rubocop_challenger/rubocop/todo_reader.rb'
     - 'lib/rubocop_challenger/rubocop/todo_writer.rb'
 
-
-
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/MutableConstant:
-  Exclude:
-    - 'lib/rubocop_challenger/version.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/RedundantSelf:
@@ -71,16 +52,7 @@ Style/RescueModifier:
   Exclude:
     - 'lib/rubocop_challenger/rubocop/rule.rb'
 
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArrayLiteral:
-  Exclude:
-    - 'spec/rubocop_challenger/rubocop/todo_reader_spec.rb'
-
-# Offense count: 4
+# Offense count: 6
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_challenger (0.1.2)
+    rubocop_challenger (0.1.3)
       pr-daikou (~> 0.2.0)
       rubocop
       rubocop-rspec

data/README.md

@@ -1,31 +1,93 @@
 # Rubocop Challenger
 
-[![CircleCI](https://circleci.com/gh/ryz310/rubocop_challenger/tree/master.svg?style=svg&circle-token=cdf0ffce5b4c0c7804b50dde00ca5ef09cbadb67)](https://circleci.com/gh/ryz310/rubocop_challenger/tree/master) [![Gem Version](https://badge.fury.io/rb/rubocop_challenger.svg)](https://badge.fury.io/rb/rubocop_challenger)
-
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop_challenger`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+[![CircleCI](https://circleci.com/gh/ryz310/rubocop_challenger/tree/master.svg?style=svg&circle-token=cdf0ffce5b4c0c7804b50dde00ca5ef09cbadb67)](https://circleci.com/gh/ryz310/rubocop_challenger/tree/master) [![Gem Version](https://badge.fury.io/rb/rubocop_challenger.svg)](https://badge.fury.io/rb/rubocop_challenger) [![Waffle.io - Columns and their card count](https://badge.waffle.io/ryz310/rubocop_challenger.svg?columns=all)](https://waffle.io/ryz310/rubocop_challenger)
+
+If you introduce [`rubocop`](https://github.com/rubocop-hq/rubocop) to an existing Rails project later, you will use [`$ rubocop --auto-gen-config`](https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md#automatically-generated-configuration). But it will make a huge `.rubocop_todo.yml` and make you despair.
+On the other hand, `rubocop` has [`--auto-correct`](https://github.com/rubocop-hq/rubocop/blob/master/manual/basic_usage.md#other-useful-command-line-flags) option, it is possible to automatically repair the writing which does not conform to the rule. But since it occasionally destroys your code, it is quite dangerous to apply all at once.
+It is ideal that to remove a disabled rule from `.rubocop_todo.yml` every day, to check whether it passes test, and can be obtained consent from the team. But it requires strong persistence and time.
+I call such work *Rubocop Challenge*. And the *RubocopChallenger* is a gem to support this challenge!
+
+## Rubocop Challenge Flow
+
+1. Run *RubocopChallenger* periodically from CI tool etc.
+2. When *RubocopChallenger* starts, delete a disabled rule from `.rubocop_todo.yml` existing in your project, execute `$ rubocop --auto-correct` and create a PR which include modified results
+3. You confirm the PR passes testing and then merge it if there is no problem
+
+## Example
+
+### Using [CircleCI 2.0](https://circleci.com)
+
+```yml
+# .circleci/config.yml
+version: 2
+
+jobs:
+  rubocop_challenge:
+    docker:
+      - image: circleci/ruby:2.5-node-browsers
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - run:
+          name: Rubocop Challenge
+          command: |
+            gem install rubocop_challenger
+            rubocop_challenger go \
+              --email=rubocop-challenge@example.com \
+              --name="'Rubocop Challenge'"
+
+workflows:
+  version: 2
+
+  nightly:
+    triggers:
+      - schedule:
+          cron: "30 23 * * 1,2,3" # 8:30am every Tuesday, Wednsday and Thursday (JST)
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - rubocop_challenge
+```
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+```sh
+$ rubocop_challenger help
 
-```ruby
-gem 'rubocop_challenger'
+Commands:
+  rubocop_challenger go --email=EMAIL --name=NAME  # Run `$ rubocop --auto-correct` and create PR to your GitHub repository
+  rubocop_challenger help [COMMAND]                # Describe available commands or one specific command
+  rubocop_challenger version                       # Show current version
 ```
 
-And then execute:
+### Command-line Flags
 
-    $ bundle
+```sh
+$ rubocop_challenger help go
 
-Or install it yourself as:
+Usage:
+  rubocop_challenger go --email=EMAIL --name=NAME
 
-    $ gem install rubocop_challenger
+Options:
+      --email=EMAIL            # Pull Request committer email
+      --name=NAME              # Pull Request committer name
+  f, [--file-path=FILE_PATH]   # Set your ".rubocop_todo.yml" path
+                               # Default: .rubocop_todo.yml
+      [--mode=MODE]            # Mode to select deletion target. You can choice "most_occurrence", "least_occurrence", or "random"
+                               # Default: most_occurrence
+      [--base=BASE]            # Base branch of Pull Request
+                               # Default: master
+  l, [--labels=one two three]  # Label to give to Pull Request
+                               # Default: ["rubocop challenge"]
 
-## Usage
+Run `$ rubocop --auto-correct` and create PR to your GitHub repository
+```
+
+## Requirement
 
-    $ rubocop_challenger rubocop_challenge --email=EMAIL --name=NAME
+* Ruby 2.3 or higher
 
 ## Development
 
@@ -35,7 +97,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop_challenger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ryz310/rubocop_challenger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -43,4 +105,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the RubocopChallenger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rubocop_challenger/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RubocopChallenger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ryz310/rubocop_challenger/blob/master/CODE_OF_CONDUCT.md).

data/lib/rubocop_challenger.rb

@@ -5,6 +5,7 @@ require 'rubocop-rspec'
 require 'rubocop_challenger/rubocop/rule'
 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/cli'
 require 'rubocop_challenger/version'

data/lib/rubocop_challenger/cli.rb

@@ -4,7 +4,7 @@ require 'thor'
 
 module RubocopChallenger
   class CLI < Thor
-    desc 'go', 'Run `$ rubocop -a` and create PR to GitHub'
+    desc 'go', 'Run `$ rubocop --auto-correct` and create PR to your GitHub repository'
     option :email,
            required: true,
            type: :string,
@@ -35,6 +35,13 @@ module RubocopChallenger
     def go
       target_rule = Rubocop::Challenge.exec(options[:file_path], options[:mode])
       PRDaikou.exec(pr_daikou_options(target_rule), nil)
+    rescue StandardError => e
+      puts e.message
+    end
+
+    desc 'version', 'Show current version'
+    def version
+      puts RubocopChallenger::VERSION
     end
 
     private

data/lib/rubocop_challenger/rubocop/challenge.rb

@@ -9,10 +9,11 @@ module RubocopChallenger
 
       private
 
-      attr_reader :mode, :todo_reader, :todo_writer
+      attr_reader :mode, :command, :todo_reader, :todo_writer
 
       def initialize(file_path, mode)
         @mode = mode
+        @command     = Rubocop::Command.new
         @todo_reader = Rubocop::TodoReader.new(file_path)
         @todo_writer = Rubocop::TodoWriter.new(file_path)
       end
@@ -20,24 +21,24 @@ module RubocopChallenger
       def exec
         verify_target_rule
         todo_writer.delete_rule(target_rule)
-        `rubocop --auto-correct || true`
+        command.auto_correct
         target_rule
       end
 
       def verify_target_rule
         return unless target_rule.nil?
 
-        puts 'There is no auto-correctable rule'
-        exit
+        raise 'There is no auto-correctable rule'
       end
 
       def target_rule
-        case mode
-        when 'least_occurrence' then todo_reader.least_occurrence_rule
-        when 'random'           then todo_reader.any_rule
-        when 'most_occurrence'  then todo_reader.most_occurrence_rule
-        else raise "`#{mode}` is not supported mode"
-        end
+        @target_rule ||=
+          case mode
+          when 'least_occurrence' then todo_reader.least_occurrence_rule
+          when 'random'           then todo_reader.any_rule
+          when 'most_occurrence'  then todo_reader.most_occurrence_rule
+          else raise "`#{mode}` is not supported mode"
+          end
       end
     end
   end

data/lib/rubocop_challenger/rubocop/command.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubocopChallenger
+  module Rubocop
+    class Command
+      def auto_correct
+        `rubocop --auto-correct || true`
+      end
+    end
+  end
+end

data/lib/rubocop_challenger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_challenger
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - ryosuke_sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-19 00:00:00.000000000 Z
+date: 2018-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pr-daikou
@@ -150,6 +150,7 @@ files:
 - lib/rubocop_challenger.rb
 - lib/rubocop_challenger/cli.rb
 - lib/rubocop_challenger/rubocop/challenge.rb
+- lib/rubocop_challenger/rubocop/command.rb
 - lib/rubocop_challenger/rubocop/rule.rb
 - lib/rubocop_challenger/rubocop/todo_reader.rb
 - lib/rubocop_challenger/rubocop/todo_writer.rb