rubocop_challenger 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c24828f82d19869be8ae26ca02b4fefa28ad04f9c6f79ebb572e2a7ecd4f53f
-  data.tar.gz: da89b53d2c43b5ae8f2e0823646b1c1286c1426d865d19864ecfea7d1da84f0d
+  metadata.gz: 77bde4ee7a301ae854cd5e1a71d5a0e31f11ed1ebe4d3c2c99e0f56e2711ff6c
+  data.tar.gz: cb3a66ec8189001a93c2146cad85339c6d1cbc8c5878ea13913c4524928cceea
 SHA512:
-  metadata.gz: a33f4986067cb9dbfb94db0659954ef62c66c3ee215db3296a45991ae55b7c632295672a027534ed13224d18756d88eb287ed56a10059541367fdd676e405ce9
-  data.tar.gz: 5b798f4cd53a3a9c3eb9cbf1dc45169d4c9c2e8785b15a23a2609cfdf9fff12920f559fecb5c62314f7d1951a40aa71c84177c3fd96b075f284211389f3f8dc9
+  metadata.gz: e472c3f77937e3abf231c5ced85dc9de15ac3a3e76ea486abdfdfbd129efbf75951b39cc96eeb1e3b650ed753fc6ff83d3e21977a00c6439e76e0a99b4e88420
+  data.tar.gz: ee1848b91fe5d5ec7d0a314ca06d8003532e24d24eb5509fdaebe0a8283baeab574d2f100883fb4d23048e5a4ceca772e1b48537727ff325cf8024c8ed9b7cb0

data/.rubocop.yml

@@ -4,3 +4,7 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.rubocop_todo.yml

@@ -1,45 +1,7 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-10-28 23:30:18 +0000 using RuboCop version 0.60.0.
+# on 2018-11-01 12:15:38 +0900 using RuboCop version 0.60.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
 # versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 7
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
-Metrics/BlockLength:
-  Max: 112
-
-# Offense count: 2
-# Configuration parameters: Max.
-RSpec/ExampleLength:
-  Exclude:
-    - 'spec/rubocop_challenger/rubocop/todo_reader_spec.rb'
-
-# Offense count: 9
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/rubocop_challenger/cli.rb'
-    - 'lib/rubocop_challenger/github/pr_template.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'
-    - 'lib/rubocop_challenger/rubocop/yardoc.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/MutableConstant:
-  Exclude:
-    - 'bin/create_release_pr'
-
-# Offense count: 7
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 87

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_challenger (0.5.0)
+    rubocop_challenger (0.5.1)
       pr-daikou (~> 0.2.0)
       rubocop
       rubocop-rspec
@@ -12,8 +12,16 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
     diff-lcs (1.3)
+    docile (1.3.1)
     jaro_winkler (1.5.1)
+    json (2.1.0)
     parallel (1.12.1)
     parser (2.5.3.0)
       ast (~> 2.4.0)
@@ -47,7 +55,15 @@ GEM
     rubocop-rspec (1.30.0)
       rubocop (>= 0.58.0)
     ruby-progressbar (1.10.0)
-    thor (0.20.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.17.0)
     unicode-display_width (1.4.0)
     yard (0.9.16)
 
@@ -56,6 +72,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  coveralls
   rake (~> 10.0)
   rspec
   rspec_junit_formatter

data/README.md

@@ -1,6 +1,6 @@
 # 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) [![Waffle.io - Columns and their card count](https://badge.waffle.io/ryz310/rubocop_challenger.svg?columns=all)](https://waffle.io/ryz310/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) [![Coverage Status](https://coveralls.io/repos/github/ryz310/rubocop_challenger/badge.svg?branch=master)](https://coveralls.io/github/ryz310/rubocop_challenger?branch=Install-coveralls) [![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.

data/bin/create_release_pr

@@ -15,7 +15,7 @@ def exist_uncommitted_modify?
   `git add -n .; git diff --name-only` != ''
 end
 
-VERSION_FORMAT = /\A\d+\.\d+\.\d+\z/
+VERSION_FORMAT = /\A\d+\.\d+\.\d+\z/.freeze
 version = ARGV[0]
 
 # Verifying

data/challenger.gemspec

@@ -15,10 +15,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/ryz310/rubocop_challenger'
   spec.license       = 'MIT'
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -31,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'yard'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec_junit_formatter'

data/lib/rubocop_challenger/cli.rb

@@ -3,8 +3,9 @@
 require 'thor'
 
 module RubocopChallenger
+  # To define CLI commands
   class CLI < Thor
-    desc 'go', 'Run `$ rubocop --auto-correct` and create PR to your GitHub repository'
+    desc 'go', 'Run `$ rubocop --auto-correct` and create PR to GitHub repo'
     option :email,
            required: true,
            type: :string,
@@ -28,7 +29,8 @@ module RubocopChallenger
            type: :string,
            default: 'most_occurrence',
            desc: 'Mode to select deletion target. ' \
-                 'You can choice "most_occurrence", "least_occurrence", or "random"'
+                 'You can choice "most_occurrence", "least_occurrence", ' \
+                 'or "random"'
     option :base,
            type: :string,
            default: 'master',
@@ -60,9 +62,9 @@ module RubocopChallenger
       puts RubocopChallenger::VERSION
     end
 
+    # Workaround to return exit code 1 when an error occurs
+    # @see https://github.com/erikhuda/thor/issues/244
     module ClassMethods
-      # Workaround to return exit code 1 when an error occurs
-      # @see https://github.com/erikhuda/thor/issues/244
       def exit_on_failure?
         true
       end

data/lib/rubocop_challenger/github/pr_template.rb

@@ -2,9 +2,10 @@
 
 module RubocopChallenger
   module Github
+    # To generate Pull Request template as markdown
     class PrTemplate
       def initialize(rule, template_path = nil)
-        template_path ||= File.expand_path('../../templates/default.md.erb', __dir__)
+        template_path ||= default_template_path
         @template = File.read(template_path)
         @rule = rule
         @yardoc = Rubocop::Yardoc.new(title)
@@ -21,6 +22,10 @@ module RubocopChallenger
 
       attr_reader :template, :rule, :yardoc
 
+      def default_template_path
+        File.expand_path('../../templates/default.md.erb', __dir__)
+      end
+
       def title
         rule.title
       end

data/lib/rubocop_challenger/rubocop/challenge.rb

@@ -2,6 +2,7 @@
 
 module RubocopChallenger
   module Rubocop
+    # To execute Rubocop Challenge flow
     class Challenge
       def self.exec(file_path, mode)
         new(file_path, mode).send(:exec)

data/lib/rubocop_challenger/rubocop/command.rb

@@ -2,6 +2,7 @@
 
 module RubocopChallenger
   module Rubocop
+    # To execute rubocop gem command (Mainly for mock when testing)
     class Command
       def auto_correct
         `bundle exec rubocop --auto-correct || true`

data/lib/rubocop_challenger/rubocop/rule.rb

@@ -2,6 +2,7 @@
 
 module RubocopChallenger
   module Rubocop
+    # Parse rubocop rule which loaded from Rubocop::TodoReader class
     class Rule
       include Comparable
 

data/lib/rubocop_challenger/rubocop/todo_reader.rb

@@ -2,6 +2,7 @@
 
 module RubocopChallenger
   module Rubocop
+    # To read `.rubocop_todo.yml` and parse each rules
     class TodoReader
       def initialize(rubocop_todo_file_path)
         @rubocop_todo_file_path = rubocop_todo_file_path

data/lib/rubocop_challenger/rubocop/todo_writer.rb

@@ -2,6 +2,7 @@
 
 module RubocopChallenger
   module Rubocop
+    # To edit `.rubocop_todo.yml`
     class TodoWriter
       def initialize(source, destination = source)
         @source = source
@@ -10,7 +11,8 @@ module RubocopChallenger
 
       def delete_rule(rubocop_rule)
         current_data = File.read(source)
-        File.write(destination, current_data.sub("\n#{rubocop_rule.contents}", ''))
+        contents = current_data.sub("\n#{rubocop_rule.contents}", '')
+        File.write(destination, contents)
       end
 
       private

data/lib/rubocop_challenger/rubocop/yardoc.rb

@@ -2,6 +2,7 @@
 
 module RubocopChallenger
   module Rubocop
+    # To read YARD style documentation from rubocop gem source code
     class Yardoc
       def initialize(title)
         @cop_class = Object.const_get("RuboCop::Cop::#{title.sub('/', '::')}")

data/lib/rubocop_challenger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_challenger
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - ryosuke_sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-30 00:00:00.000000000 Z
+date: 2018-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pr-daikou
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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