rubocop_todo_corrector 0.13.0 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e370ea5e7275cba3675a1e5ebae1aababaddb87917bb7ac5507efb6b3e5fb79
-  data.tar.gz: 5a235861dbdf945bf4fd1a3c271cedb2f08e76397706d2f48e16adec0e94e8a4
+  metadata.gz: dff04eb883e0fd8b45e35cf11bf14351a6e93f397e40117a87c2f8beefce2cdc
+  data.tar.gz: f75586ac0a17d1b025925b4faca387eca5d069b9ccf149a1d56f27da1493bede
 SHA512:
-  metadata.gz: 55cd6960281b726f3cd5ab258d112c2fbbe8d589fd57045ce1186b06af17502883a591709fcc40f7ac773b785f05a01784a35f6a641d21de01f6334d0cef829a
-  data.tar.gz: a05b1ca686adb83f7eae952c0357109b0f18973f0e85965468518264b89b1a531a071d387a7209226837f66abef89680c2b43fac90daa1aa181f2cd63fae6da1
+  metadata.gz: 6c72738de0ffbf7845926c46950c97800bb991f24bfe032b0c6209d71a1f79ebf42967c56c907462f175cefbec631e27f16c092ce60afb4401e816a7283d50dc
+  data.tar.gz: 291c3db91da97dcda17875a33844643128c9bd1607957300f064d4ee3e3bb4da545d8efd0dd6e32549d1fac6d0a7094d62e1b721a40b209e1b183f7743e99851

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_todo_corrector (0.13.0)
+    rubocop_todo_corrector (0.14.2)
       asciidoctor
       bundler
       thor

data/lib/rubocop_todo_corrector/commands/describe.rb

@@ -35,10 +35,15 @@ module RubocopTodoCorrector
         cop_document = CopDocumentParser.call(source_path: cop_source_path)
         return unless cop_document
 
+        cop_url = CopUrlFinder.call(
+          cop_name: @cop_name,
+          cop_source_path:,
+          temporary_gemfile_path: @temporary_gemfile_path
+        )
         description = DescriptionRenderer.call(
           cop_document:,
           cop_name: @cop_name,
-          cop_source_path:
+          cop_url:
         )
         ::Kernel.puts(description)
       end

data/lib/rubocop_todo_corrector/cop_document_parser.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'asciidoctor'
 require 'yard'
 
 module RubocopTodoCorrector
@@ -38,14 +37,6 @@ module RubocopTodoCorrector
 
     # @return [String]
     def description
-      ::Asciidoctor.convert(
-        docstring,
-        safe: :safe
-      )
-    end
-
-    # @return [String]
-    def docstring
       yard_class_object.docstring
     end
 

data/lib/rubocop_todo_corrector/cop_url_finder.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module RubocopTodoCorrector
+  class CopUrlFinder
+    class << self
+      # @param [String] cop_name
+      # @param [String] cop_source_path
+      # @param [String] temporary_gemfile_path
+      # @return [String]
+      def call(
+        cop_name:,
+        cop_source_path:,
+        temporary_gemfile_path:
+      )
+        new(
+          cop_name:,
+          cop_source_path:,
+          temporary_gemfile_path:
+        ).call
+      end
+    end
+
+    def initialize(
+      cop_name:,
+      cop_source_path:,
+      temporary_gemfile_path:
+    )
+      @cop_name = cop_name
+      @cop_source_path = cop_source_path
+      @temporary_gemfile_path = temporary_gemfile_path
+    end
+
+    # @return [String]
+    def call
+      if !captured_url.empty?
+        captured_url
+      elsif gem_name
+        "https://www.rubydoc.info/gems/#{gem_name}/RuboCop/Cop/#{@cop_name}"
+      else
+        "https://www.google.com/search?q=rubocop+#{::URI.encode_www_form_component(@cop_name.inspect)}"
+      end
+    end
+
+    private
+
+    # @return [String, nil]
+    def captured_url
+      @captured_url ||= ::Open3.capture2(
+        { 'BUNDLE_GEMFILE' => @temporary_gemfile_path },
+        "bundle exec rubocop --show-docs-url #{@cop_name}"
+      ).first.strip
+    end
+
+    # @return [String, nil]
+    def gem_name
+      @gem_name ||= @cop_source_path[
+        %r{/gems/([\w-]+)-\d+(?:\.\w+)*/lib},
+        1
+      ]
+    end
+  end
+end

data/lib/rubocop_todo_corrector/description_renderer.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require 'asciidoctor'
 require 'erb'
+require 'open3'
 
 module RubocopTodoCorrector
   class DescriptionRenderer
@@ -9,17 +11,17 @@ module RubocopTodoCorrector
     class << self
       # @param [String] cop_document
       # @param [String] cop_name
-      # @param [String] cop_source_path
+      # @param [String] cop_url
       # @return [String]
       def call(
         cop_document:,
         cop_name:,
-        cop_source_path:
+        cop_url:
       )
         new(
           cop_document:,
           cop_name:,
-          cop_source_path:
+          cop_url:
         ).call
       end
     end
@@ -27,11 +29,11 @@ module RubocopTodoCorrector
     def initialize(
       cop_document:,
       cop_name:,
-      cop_source_path:
+      cop_url:
     )
       @cop_document = cop_document
       @cop_name = cop_name
-      @cop_source_path = cop_source_path
+      @cop_url = cop_url
     end
 
     # @return [String]
@@ -41,21 +43,23 @@ module RubocopTodoCorrector
 
     private
 
+    # Convert AsciiDoc to HTML.
+    # @param [String] string
     # @return [String]
-    def cop_url
-      if gem_name
-        "https://www.rubydoc.info/gems/#{gem_name}/RuboCop/Cop/#{@cop_name}"
-      else
-        "https://www.google.com/search?q=rubocop+#{::URI.encode_www_form_component(@cop_name.inspect)}"
-      end
+    def asciidoc(string)
+      ::Asciidoctor.convert(
+        string,
+        safe: :safe
+      )
     end
 
-    # @return [String, nil]
-    def gem_name
-      @gem_name ||= @cop_source_path[
-        %r{/gems/([\w-]+)-\d+(?:\.\w+)*/lib},
-        1
-      ]
+    # Prepend quote marker to each line.
+    # @param [String] string
+    # @return [String]
+    def quote(string)
+      string.each_line.map do |line|
+        "> #{line}".strip
+      end.join("\n")
     end
 
     # @return [String]

data/lib/rubocop_todo_corrector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubocopTodoCorrector
-  VERSION = '0.13.0'
+  VERSION = '0.14.2'
 end

data/lib/rubocop_todo_corrector.rb

@@ -8,6 +8,7 @@ module RubocopTodoCorrector
   autoload :Commands, 'rubocop_todo_corrector/commands'
   autoload :CopDocumentParser, 'rubocop_todo_corrector/cop_document_parser'
   autoload :CopSourceDetector, 'rubocop_todo_corrector/cop_source_detector'
+  autoload :CopUrlFinder, 'rubocop_todo_corrector/cop_url_finder'
   autoload :DescriptionRenderer, 'rubocop_todo_corrector/description_renderer'
   autoload :GemNamesDetector, 'rubocop_todo_corrector/gem_names_detector'
   autoload :GemVersionDetector, 'rubocop_todo_corrector/gem_version_detector'

data/templates/description.md.erb

@@ -2,20 +2,18 @@ Auto-correct <%= @cop_name %>
 
 ## Summary
 
-Auto-corrected [<%= @cop_name %>](<%= cop_url %>).
+Auto-corrected [<%= @cop_name %>](<%= @cop_url %>).
 
 ## Details
 
 ### <%= @cop_name %>
 
-<% @cop_document[:description].each_line do |line| -%>
-<%= "> #{line}".strip %>
-<% end -%>
+<%= quote(asciidoc(@cop_document[:description])) %>
 <% if @cop_document[:safety] -%>
 >
 > #### Safety
 >
-> <%= @cop_document[:safety][:text].gsub("\n", " ").strip %>
+<%= quote(asciidoc(@cop_document[:safety][:text])) %>
 <% end -%>
 <% unless @cop_document[:examples].empty? -%>
 >
@@ -27,9 +25,7 @@ Auto-corrected [<%= @cop_name %>](<%= cop_url %>).
 <% end -%>
 >
 > ```ruby
-<% example[:text].each_line do |line| -%>
-<%= "> #{line}".strip %>
-<% end -%>
+<%= quote(example[:text]) %>
 > ```
 <% end -%>
 <% end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_todo_corrector
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.2
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -76,7 +76,6 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
-- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -98,6 +97,7 @@ files:
 - lib/rubocop_todo_corrector/commands/remove.rb
 - lib/rubocop_todo_corrector/cop_document_parser.rb
 - lib/rubocop_todo_corrector/cop_source_detector.rb
+- lib/rubocop_todo_corrector/cop_url_finder.rb
 - lib/rubocop_todo_corrector/description_renderer.rb
 - lib/rubocop_todo_corrector/gem_names_detector.rb
 - lib/rubocop_todo_corrector/gem_version_detector.rb

data/CHANGELOG.md

@@ -1,101 +0,0 @@
-# Changelog
-
-## Unreleased
-
-## 0.12.0 - 2022-08-08
-
-### Added
-
-- Add Safety section if `@safety` YARD tag is written in Cop class.
-
-## 0.11.1 - 2022-08-03
-
-### Fixed
-
-- Fix `describe` command on more than three nested cop class.
-
-## 0.11.0 - 2022-07-29
-
-### Changed
-
-- Use `rubocop --regenerate-todo` option on `generate` command.
-
-## 0.10.0 - 2022-07-27
-
-### Added
-
-- Add `ignore` command.
-
-## 0.9.0 - 2022-07-27
-
-### Added
-
-- Add `.rubocop_todo_corrector_ignore` file support.
-
-## 0.8.0 - 2022-07-23
-
-### Added
-
-- Add `clean` command.
-
-## 0.7.1 - 2022-05-28
-
-### Fixed
-
-- Fix YARD unknown tag warning.
-
-## 0.7.0 - 2022-05-27
-
-### Added
-
-- Support rubocop 1.30 .rubocop_todo.yml format.
-
-## 0.6.0 - 2022-05-16
-
-### Added
-
-- Add `--only-safe` option to `correct` and `pick` command (default: `true`).
-
-## 0.5.0 - 2022-05-16
-
-### Changed
-
-- Change required ruby version from 3.0 to 3.1.
-
-## 0.4.0 - 2022-05-16
-
-### Fixed
-
-- Fix misspell: `occured` -> `occurred`.
-
-## 0.3.0 - 2022-05-15
-
-### Changed
-
-- Change `describe` output so that commit-message-ready text is described.
-
-## 0.2.0 - 2022-05-15
-
-### Added
-
-- Add `correct` command.
-
-### Changed
-
-- Improve description on no named example.
-
-## 0.1.1 - 2022-05-15
-
-### Changed
-
-- Abort if no cop was picked on `pick` command.
-
-### Fixed
-
-- Fix bug that `pick` cannot find any cop on rubocop >= 1.26.
-
-## 0.1.0 - 2022-05-15
-
-### Added
-
-- Initial release.