rubocop_todo_corrector 0.11.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1725e72b773d02b2b00407840e3cc9c6f1369efa22fc81f335dda6b3959080cd
-  data.tar.gz: 01c22d85c57ea1d2cdfdd692cef1c92764025cacdda049b65d146731a6ed723a
+  metadata.gz: 7c875171ee57cc0510b2bc3eeee96c57155f4380fad714346f02089e726a7e05
+  data.tar.gz: 10b096061782d6a714ec7a740c8bf75dff966c9a6e175fe76847c6203dd26f19
 SHA512:
-  metadata.gz: fd2ceb4d8b406bb5e2e03feeb155b46ba8013ca8080d5667379c002b9b56c36473d9d62292b3aedb262ed2ecfb447608903ff704a01ae53a8d2de62a8f785858
-  data.tar.gz: e81181f9fb7919e5066d265ef7250127d99fbf06ef7fc0a0c5c5eb3f5c7c58f25bd7dcb513c4d10742cf63651d6b12d15475744593b66eb0efd457251da7b814
+  metadata.gz: 1a1d903624ee552a520d9aafad408520ba3d059705fb0368f4abb3a11920f8b5ac48002bca0e3e98f41897b7c46d62aca06397f3e983dbc989d362d880e7be9e
+  data.tar.gz: 1f1413ba984a873283d92c3679576e9d8c6072f0456b4f8fc42ad7b03c88c83aa2cd019bb67254ccde8d5fa8dbc3ce529c683976d7e7c07b8e675d76966b448f

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    rubocop_todo_corrector (0.11.1)
+    rubocop_todo_corrector (0.14.0)
+      asciidoctor
       bundler
       thor
       yard
@@ -9,6 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    asciidoctor (2.0.17)
     ast (2.4.2)
     diff-lcs (1.5.0)
     parallel (1.22.1)

data/lib/rubocop_todo_corrector/cop_document_parser.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'asciidoctor'
 require 'yard'
 
 module RubocopTodoCorrector
@@ -27,18 +28,48 @@ module RubocopTodoCorrector
       return unless yard_class_object
 
       {
-        description: yard_class_object.docstring,
-        examples: yard_class_object.tags('example').map do |tag|
-          {
-            name: tag.name,
-            text: tag.text
-          }
-        end
+        description:,
+        examples:,
+        safety:
       }
     end
 
     private
 
+    # @return [String]
+    def description
+      ::Asciidoctor.convert(
+        docstring,
+        safe: :safe
+      )
+    end
+
+    # @return [String]
+    def docstring
+      yard_class_object.docstring
+    end
+
+    # @return [Array<Hash>]
+    def examples
+      yard_class_object.tags('example').map do |tag|
+        {
+          name: tag.name,
+          text: tag.text
+        }
+      end
+    end
+
+    # @return [Hash, nil]
+    def safety
+      tag = yard_class_object.tag('safety')
+      return unless tag
+
+      {
+        name: tag.name,
+        text: tag.text
+      }
+    end
+
     # @return [YARD::CodeObjects::ClassObject]
     def yard_class_object
       @yard_class_object ||= begin

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,7 @@
 # frozen_string_literal: true
 
 require 'erb'
+require 'open3'
 
 module RubocopTodoCorrector
   class DescriptionRenderer
@@ -43,19 +44,11 @@ module RubocopTodoCorrector
 
     # @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
-    end
-
-    # @return [String, nil]
-    def gem_name
-      @gem_name ||= @cop_source_path[
-        %r{/gems/([\w-]+)-\d+(?:\.\w+)*/lib},
-        1
-      ]
+      CopUrlFinder.call(
+        cop_name: @cop_name,
+        cop_source_path: @cop_source_path,
+        temporary_gemfile_path: @temporary_gemfile_path
+      )
     end
 
     # @return [String]

data/lib/rubocop_todo_corrector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubocopTodoCorrector
-  VERSION = '0.11.1'
+  VERSION = '0.14.0'
 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/rubocop_todo_corrector.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'asciidoctor'
   spec.add_dependency 'bundler'
   spec.add_dependency 'thor'
   spec.add_dependency 'yard'

data/templates/description.md.erb

@@ -11,6 +11,12 @@ Auto-corrected [<%= @cop_name %>](<%= cop_url %>).
 <% @cop_document[:description].each_line do |line| -%>
 <%= "> #{line}".strip %>
 <% end -%>
+<% if @cop_document[:safety] -%>
+>
+> #### Safety
+>
+> <%= @cop_document[:safety][:text].gsub("\n", " ").strip %>
+<% end -%>
 <% unless @cop_document[:examples].empty? -%>
 >
 > #### Examples

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_todo_corrector
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2022-08-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  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
@@ -62,7 +76,6 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
-- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -84,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,95 +0,0 @@
-# Changelog
-
-## Unreleased
-
-## 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.