rubocop_challenger 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66e110ffa25623e67fa5de2245c71339fd464878f3f7d96514373fd807765c7f
-  data.tar.gz: 310e649280408cac4ce73f68dec4e3b8292c8127e2da6b9cf197baabe5028c8f
+  metadata.gz: 0e6ab36ea5a8373773c832d7f40e7867b857fc11682737f2a618e6ceda54ec65
+  data.tar.gz: f33fa38af154d266e71c48c4268cb3438e241e5575fc793080cb14f41c51392d
 SHA512:
-  metadata.gz: 863e666a4b4e38d4b5750c3ec5ce4f439e1aeb58eee489921ecf979e36c8a7d299c2a40399c9d68fc9fc96cb4d1b69d19dbc77551a601ad4801bae041fee750e
-  data.tar.gz: 6069887ab002bc116139fa1e5f85bc74d27c5bc515cd199d2c00a2661b4c8547c0b38b95a183befae961ed0d70a3846eb43a4c3405912efb324b5b2e1ad68ebb
+  metadata.gz: 8919ffd26ae70dfc7752505abf9a06278fa774a9cb8e31df6698b466c0399fb7ced53560737f8bac7a07bd378e1388ae0a7a9d76a74fcf18282b70253bc67c95
+  data.tar.gz: 6cfe197bffdc6064494d1de3267ab64e327ce2a57e7cef1b89a24990ea62f6bd6810cbc2bb4e8286ca8f4f421a2674f9576bea9e34576e339bd48eca57456cee

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-10-22 15:21:40 +0900 using RuboCop version 0.59.2.
+# on 2018-10-26 14:40:31 +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
@@ -15,11 +15,11 @@ Layout/SpaceInsideBlockBraces:
   Exclude:
     - 'Gemfile'
 
-# Offense count: 5
+# Offense count: 7
 # Configuration parameters: CountComments, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 132
+  Max: 112
 
 # Offense count: 2
 # Configuration parameters: Max.
@@ -27,12 +27,11 @@ RSpec/ExampleLength:
   Exclude:
     - 'spec/rubocop_challenger/rubocop/todo_reader_spec.rb'
 
-# Offense count: 8
+# Offense count: 9
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
-    - 'lib/rubocop_challenger.rb'
     - 'lib/rubocop_challenger/cli.rb'
     - 'lib/rubocop_challenger/github/pr_template.rb'
     - 'lib/rubocop_challenger/rubocop/challenge.rb'
@@ -40,6 +39,7 @@ Style/Documentation:
     - '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.
@@ -47,13 +47,7 @@ Style/RedundantSelf:
   Exclude:
     - 'lib/rubocop_challenger/rubocop/rule.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RescueModifier:
-  Exclude:
-    - 'lib/rubocop_challenger/rubocop/rule.rb'
-
-# Offense count: 6
+# Offense count: 7
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    rubocop_challenger (0.3.1)
+    rubocop_challenger (0.4.0)
       pr-daikou (~> 0.2.0)
       rubocop
       rubocop-rspec
       thor
+      yard
 
 GEM
   remote: https://rubygems.org/
@@ -48,6 +49,7 @@ GEM
     ruby-progressbar (1.10.0)
     thor (0.20.0)
     unicode-display_width (1.4.0)
+    yard (0.9.16)
 
 PLATFORMS
   ruby

data/README.md

@@ -87,7 +87,7 @@ Options:
       --name=NAME                                                  # Pull Request committer name
   f, [--file-path=FILE_PATH]                                       # Set your ".rubocop_todo.yml" path
                                                                    # Default: .rubocop_todo.yml
-  t, [--template=TEMPLATE]                                         # Pull Request template `erb` file path.You can use variable that `title`, `rubydoc_url` and `description` into the erb file.
+  t, [--template=TEMPLATE]                                         # Pull Request template `erb` file path.You can use variable that `title`, `rubydoc_url`, `description` and `examples` into the erb file.
       [--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

data/bin/create_release_pr

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# usage: bin/create_release_pr VERSION
+
+require 'bundler/setup'
+require 'rubocop_challenger'
+
+def exit_process(error_message)
+  puts error_message
+  exit!
+end
+
+def exist_uncommitted_modify?
+  `git add -n .; git diff --name-only` != ''
+end
+
+VERSION_FORMAT = /\A\d+\.\d+\.\d+\z/
+version = ARGV[0]
+
+# Verifying
+exit_process 'usage: bin/create_release_pr VERSION' if version.nil?
+exit_process 'A version must be like a `1.2.3`' unless version =~ VERSION_FORMAT
+exit_process 'There are uncommitted modify' if exist_uncommitted_modify?
+
+# Modify a version file
+File.write('lib/rubocop_challenger/version.rb', <<~VERSION)
+  # frozen_string_literal: true
+
+  module RubocopChallenger
+    VERSION = '#{version}'
+  end
+VERSION
+
+# Bundle Install
+`bundle install`
+
+# Create PR
+PRDaikou.exec(
+  {
+    email:       `git config user.email`,
+    name:        `git config user.name`,
+    base:        'master',
+    title:       "Update v#{version}",
+    labels:      '',
+    topic:       "update/v#{version}",
+    commit:      "Update v#{version}"
+  }, nil
+)

data/challenger.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rubocop'
   spec.add_runtime_dependency 'rubocop-rspec'
   spec.add_runtime_dependency 'thor'
+  spec.add_runtime_dependency 'yard'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/rubocop_challenger.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'erb'
+require 'yard'
 require 'rubocop'
 require 'rubocop-rspec'
 require 'rubocop_challenger/rubocop/rule'
@@ -8,6 +9,7 @@ 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/cli'
 require 'rubocop_challenger/version'
 require 'rubocop_challenger/github/pr_template.rb'

data/lib/rubocop_challenger/cli.rb

@@ -22,8 +22,8 @@ module RubocopChallenger
            type: :string,
            aliases: :t,
            desc: 'Pull Request template `erb` file path.' \
-                 'You can use variable that `title`, `rubydoc_url` and ' \
-                 '`description` into the erb file.'
+                 'You can use variable that `title`, `rubydoc_url`, ' \
+                 '`description` and `examples` into the erb file.'
     option :mode,
            type: :string,
            default: 'most_occurrence',

data/lib/rubocop_challenger/github/pr_template.rb

@@ -7,6 +7,7 @@ module RubocopChallenger
         template_path ||= File.expand_path('../../templates/default.md.erb', __dir__)
         @template = File.read(template_path)
         @rule = rule
+        @yardoc = Rubocop::Yardoc.new(title)
       end
 
       def generate_pullrequest_markdown
@@ -18,7 +19,7 @@ module RubocopChallenger
 
       private
 
-      attr_reader :template, :rule
+      attr_reader :template, :rule, :yardoc
 
       def title
         rule.title
@@ -29,7 +30,11 @@ module RubocopChallenger
       end
 
       def description
-        rule.description
+        yardoc.description
+      end
+
+      def examples
+        yardoc.examples
       end
     end
   end

data/lib/rubocop_challenger/rubocop/rule.rb

@@ -29,11 +29,6 @@ module RubocopChallenger
         end
       end
 
-      def description
-        message_const = "RuboCop::Cop::#{title.sub('/', '::')}::MSG"
-        Object.const_get(message_const) rescue '**NO DESCRIPTION**'
-      end
-
       private
 
       def extract_title

data/lib/rubocop_challenger/rubocop/yardoc.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RubocopChallenger
+  module Rubocop
+    class Yardoc
+      def initialize(title)
+        @cop_class = Object.const_get("RuboCop::Cop::#{title.sub('/', '::')}")
+        YARD.parse(source_file_path)
+        @yardoc = YARD::Registry.all(:class).first
+        YARD::Registry.clear
+      end
+
+      def description
+        yardoc.docstring
+      end
+
+      def examples
+        yardoc.tags('example').map(&:text)
+      end
+
+      private
+
+      attr_reader :cop_class, :yardoc
+
+      def instance_methods
+        [
+          cop_class.instance_methods(false),
+          cop_class.private_instance_methods(false)
+        ].flatten!
+      end
+
+      def source_file_path
+        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 = '0.3.1'
+  VERSION = '0.4.0'
 end

data/lib/templates/checklist.md.erb

@@ -4,8 +4,20 @@
 
 ## Description
 
+> ### Overview
+>
 <% description.each_line do |line| -%>
-> <%= line.chomp %>
+<%= "> #{line}".chomp.strip %>
+<% end -%>
+>
+> ### Examples
+<% examples.each do |example| -%>
+>
+> ```rb
+<% example.each_line do |line| -%>
+<%= "> #{line}".chomp.strip %>
+<% end -%>
+> ```
 <% end -%>
 
 ## Checklist

data/lib/templates/default.md.erb

@@ -4,6 +4,18 @@
 
 ## Description
 
+> ### Overview
+>
 <% description.each_line do |line| -%>
-> <%= line.chomp %>
+<%= "> #{line}".chomp.strip %>
+<% end -%>
+>
+> ### Examples
+<% examples.each do |example| -%>
+>
+> ```rb
+<% example.each_line do |line| -%>
+<%= "> #{line}".chomp.strip %>
+<% end -%>
+> ```
 <% end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_challenger
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - ryosuke_sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2018-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pr-daikou
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +158,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/create_release_pr
 - bin/setup
 - challenger.gemspec
 - exe/rubocop_challenger
@@ -157,6 +172,7 @@ files:
 - 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
 - lib/rubocop_challenger/version.rb
 - lib/templates/checklist.md.erb
 - lib/templates/default.md.erb