rubocop_todo_corrector 0.1.0

data/lib/rubocop_todo_corrector/commands/pick.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module RubocopTodoCorrector
+  module Commands
+    class Pick
+      class << self
+        # @param [String] mode
+        # @param [String] rubocop_todo_path
+        def call(
+          mode:,
+          rubocop_todo_path:
+        )
+          new(
+            mode: mode,
+            rubocop_todo_path: rubocop_todo_path
+          ).call
+        end
+      end
+
+      def initialize(
+        mode:,
+        rubocop_todo_path:
+      )
+        @mode = mode
+        @rubocop_todo_path = rubocop_todo_path
+      end
+
+      def call
+        check_rubocop_todo_existence
+        cop_name = picked_cop&.[](:name)
+        ::Kernel.puts cop_name if cop_name
+      end
+
+      private
+
+      # @return [Array<Hash>]
+      def auto_correctable_cops
+        rubocop_todo[:cops].select do |cop|
+          cop[:auto_correctable]
+        end
+      end
+
+      def check_rubocop_todo_existence
+        raise "#{rubocop_todo_pathname.to_s.inspect} does not exist." unless rubocop_todo_pathname.exist?
+      end
+
+      # @return [Hash, nil]
+      def picked_cop
+        case @mode
+        when 'first'
+          auto_correctable_cops.first
+        when 'last'
+          auto_correctable_cops.last
+        when 'least_occured'
+          auto_correctable_cops.min_by do |cop|
+            cop[:offenses_count]
+          end
+        when 'most_occured'
+          auto_correctable_cops.max_by do |cop|
+            cop[:offenses_count]
+          end
+        else
+          auto_correctable_cops.sample
+        end
+      end
+
+      def rubocop_todo
+        RubocopTodoParser.call(content: rubocop_todo_content)
+      end
+
+      # @return [String]
+      def rubocop_todo_content
+        rubocop_todo_pathname.read
+      end
+
+      # @return [Pathname]
+      def rubocop_todo_pathname
+        @rubocop_todo_pathname ||= ::Pathname.new(@rubocop_todo_path)
+      end
+    end
+  end
+end

data/lib/rubocop_todo_corrector/commands/remove.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module RubocopTodoCorrector
+  module Commands
+    class Remove
+      class << self
+        # @param [String] cop_name
+        # @param [String] rubocop_todo_path
+        def call(
+          cop_name:,
+          rubocop_todo_path:
+        )
+          new(
+            cop_name: cop_name,
+            rubocop_todo_path: rubocop_todo_path
+          ).call
+        end
+      end
+
+      def initialize(
+        cop_name:,
+        rubocop_todo_path:
+      )
+        @cop_name = cop_name
+        @rubocop_todo_path = rubocop_todo_path
+      end
+
+      # @return [String]
+      def call
+        check_rubocop_todo_existence
+        write
+      end
+
+      private
+
+      def check_rubocop_todo_existence
+        raise "#{rubocop_todo_pathname.to_s.inspect} does not exist." unless rubocop_todo_pathname.exist?
+      end
+
+      # @return [String]
+      def processed_content
+        rubocop_todo_content.split("\n\n").grep_v(/^#{@cop_name}:$/).join("\n\n")
+      end
+
+      def rubocop_todo
+        RubocopTodoParser.call(content: rubocop_todo_content)
+      end
+
+      # @return [String]
+      def rubocop_todo_content
+        rubocop_todo_pathname.read
+      end
+
+      # @return [Pathname]
+      def rubocop_todo_pathname
+        @rubocop_todo_pathname ||= ::Pathname.new(@rubocop_todo_path)
+      end
+
+      def write
+        ::File.write(
+          @rubocop_todo_path,
+          processed_content
+        )
+      end
+    end
+  end
+end

data/lib/rubocop_todo_corrector/commands.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubocopTodoCorrector
+  module Commands
+    autoload :Bundle, 'rubocop_todo_corrector/commands/bundle'
+    autoload :Describe, 'rubocop_todo_corrector/commands/describe'
+    autoload :Generate, 'rubocop_todo_corrector/commands/generate'
+    autoload :Pick, 'rubocop_todo_corrector/commands/pick'
+    autoload :Remove, 'rubocop_todo_corrector/commands/remove'
+  end
+end

data/lib/rubocop_todo_corrector/cop_document_parser.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RubocopTodoCorrector
+  class CopDocumentParser
+    class << self
+      # @param [String] source_path
+      # @return [Hash, nil]
+      def call(
+        source_path:
+      )
+        new(
+          source_path: source_path
+        ).call
+      end
+    end
+
+    def initialize(
+      source_path:
+    )
+      @source_path = source_path
+    end
+
+    # @return [Hash, nil]
+    def call
+      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
+      }
+    end
+
+    private
+
+    # @return [YARD::CodeObjects::ClassObject]
+    def yard_class_object
+      @yard_class_object ||= begin
+        ::YARD.parse(@source_path)
+        yardoc = ::YARD::Registry.all(:class).first
+        ::YARD::Registry.clear
+        yardoc
+      end
+    end
+  end
+end

data/lib/rubocop_todo_corrector/cop_source_detector.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module RubocopTodoCorrector
+  class CopSourceDetector
+    class << self
+      # @param [String] cop_name
+      # @param [String] temporary_gemfile_path
+      # @return [String, nil]
+      def call(
+        cop_name:,
+        temporary_gemfile_path:
+      )
+        new(
+          cop_name: cop_name,
+          temporary_gemfile_path: temporary_gemfile_path
+        ).call
+      end
+    end
+
+    def initialize(
+      cop_name:,
+      temporary_gemfile_path:
+    )
+      @cop_name = cop_name
+      @temporary_gemfile_path = temporary_gemfile_path
+    end
+
+    # @return [String, nil]
+    def call
+      output = capture
+      output unless output.empty?
+    end
+
+    private
+
+    # @return [String]
+    def capture
+      ::Open3.capture2(
+        { 'BUNDLE_GEMFILE' => @temporary_gemfile_path },
+        "bundle exec ruby -e 'Bundler.require; print Object.const_source_location(#{cop_class_name.inspect}).first'"
+      ).first
+    end
+
+    # @return [String]
+    def cop_class_name
+      "RuboCop::Cop::#{@cop_name.sub('/', '::')}"
+    end
+  end
+end

data/lib/rubocop_todo_corrector/description_renderer.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module RubocopTodoCorrector
+  class DescriptionRenderer
+    TEMPLATE_PATH = ::File.expand_path('../../templates/description.md.erb', __dir__)
+
+    class << self
+      # @param [String] cop_document
+      # @param [String] cop_name
+      # @param [String] cop_source_path
+      # @return [String]
+      def call(
+        cop_document:,
+        cop_name:,
+        cop_source_path:
+      )
+        new(
+          cop_document: cop_document,
+          cop_name: cop_name,
+          cop_source_path: cop_source_path
+        ).call
+      end
+    end
+
+    def initialize(
+      cop_document:,
+      cop_name:,
+      cop_source_path:
+    )
+      @cop_document = cop_document
+      @cop_name = cop_name
+      @cop_source_path = cop_source_path
+    end
+
+    # @return [String]
+    def call
+      ::ERB.new(template_content, trim_mode: '-').result(binding)
+    end
+
+    private
+
+    # @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
+      ]
+    end
+
+    # @return [String]
+    def template_content
+      ::File.read(TEMPLATE_PATH)
+    end
+  end
+end

data/lib/rubocop_todo_corrector/gem_names_detector.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module RubocopTodoCorrector
+  class GemNamesDetector
+    class << self
+      # @param [String] rubocop_configuration_path
+      # @return [Array<String>]
+      def call(rubocop_configuration_path:)
+        new(rubocop_configuration_path: rubocop_configuration_path).call
+      end
+    end
+
+    def initialize(rubocop_configuration_path:)
+      @rubocop_configuration_path = rubocop_configuration_path
+    end
+
+    def call
+      gem_names
+    end
+
+    private
+
+    # @return [Hash]
+    def configuration_hash
+      ::YAML.load_file(@rubocop_configuration_path)
+    end
+
+    # @return [Array<String>]
+    def gem_names
+      requires.grep(/\A[\w-]+\z/)
+    end
+
+    # @return [Array<String>]
+    def requires
+      configuration_hash['require'] || []
+    end
+  end
+end

data/lib/rubocop_todo_corrector/gem_version_detector.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+module RubocopTodoCorrector
+  class GemVersionDetector
+    class << self
+      # @param [String] gemfile_lock_path
+      # @param [String] name
+      # @return [String, nil]
+      def call(gemfile_lock_path:, gem_name:)
+        new(
+          gemfile_lock_path: gemfile_lock_path,
+          gem_name: gem_name
+        ).call
+      end
+    end
+
+    def initialize(gemfile_lock_path:, gem_name:)
+      @gemfile_lock_path = gemfile_lock_path
+      @gem_name = gem_name
+    end
+
+    # @return [String, nil]
+    def call
+      specification&.version&.to_s
+    end
+
+    private
+
+    # @return [Bundler::LockfileParser]
+    def bundler_lockfile_parser
+      ::Bundler::LockfileParser.new(gemfile_lock_content)
+    end
+
+    # @return [String]
+    def gemfile_lock_content
+      ::File.read(@gemfile_lock_path)
+    end
+
+    # @return [Bundler::LazySpecification]
+    def specification
+      specs.find do |specification|
+        specification.name == @gem_name
+      end
+    end
+
+    # @return [Array<Bundler::LazySpecification>]
+    def specs
+      bundler_lockfile_parser.specs
+    end
+  end
+end

data/lib/rubocop_todo_corrector/rubocop_todo_parser.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RubocopTodoCorrector
+  class RubocopTodoParser
+    COP_NAME_LINE_REGEXP = %r{
+      ^
+      (?<cop_name>
+        \w+
+        (?:/\w+)*
+      )
+      :
+      $
+    }x
+
+    class << self
+      # @param [String] content
+      def call(content:)
+        new(
+          content: content
+        ).call
+      end
+    end
+
+    def initialize(content:)
+      @content = content
+    end
+
+    # @return [Hash]
+    def call
+      {
+        cops: cops,
+        previous_rubocop_command: previous_rubocop_command
+      }
+    end
+
+    private
+
+    # @return [Array<Hash>]
+    def cops
+      cop_sections.map do |cop_section|
+        RubocopTodoSectionParser.call(content: cop_section)
+      end
+    end
+
+    def previous_rubocop_command
+      @content[
+        /`(.+)`/,
+        1
+      ]
+    end
+
+    # @return [Array<String>]
+    def cop_sections
+      @content.split("\n\n").grep(COP_NAME_LINE_REGEXP)
+    end
+  end
+end

data/lib/rubocop_todo_corrector/rubocop_todo_section_parser.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RubocopTodoCorrector
+  class RubocopTodoSectionParser
+    class << self
+      # @param [String] content
+      def call(content:)
+        new(
+          content: content
+        ).call
+      end
+    end
+
+    def initialize(content:)
+      @content = content
+    end
+
+    # @return [Hash]
+    def call
+      {
+        auto_correctable: auto_correctable?,
+        name: name,
+        offenses_count: offenses_count
+      }
+    end
+
+    private
+
+    # @return [Boolean]
+    def auto_correctable?
+      @content.include?('# Cop supports --auto-correct.') ||
+        @content.include?('# Cop supports safe auto-correction.') ||
+        @content.include?('# Cop supports unsafe auto-correction.')
+    end
+
+    # @return [String, nil]
+    def name
+      @content[/(#{RubocopTodoParser::COP_NAME_LINE_REGEXP})/, 'cop_name']
+    end
+
+    # @return [Integer, nil]
+    def offenses_count
+      @content[
+        /^# Offense count: (?<offenses_count>\d+)$/,
+        'offenses_count'
+      ]&.to_i
+    end
+  end
+end

data/lib/rubocop_todo_corrector/version.rb

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

data/lib/rubocop_todo_corrector.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'rubocop_todo_corrector/version'
+
+module RubocopTodoCorrector
+  autoload :BundleInstaller, 'rubocop_todo_corrector/bundle_installer'
+  autoload :Cli, 'rubocop_todo_corrector/cli'
+  autoload :Commands, 'rubocop_todo_corrector/commands'
+  autoload :CopDocumentParser, 'rubocop_todo_corrector/cop_document_parser'
+  autoload :CopSourceDetector, 'rubocop_todo_corrector/cop_source_detector'
+  autoload :DescriptionRenderer, 'rubocop_todo_corrector/description_renderer'
+  autoload :GemNamesDetector, 'rubocop_todo_corrector/gem_names_detector'
+  autoload :GemVersionDetector, 'rubocop_todo_corrector/gem_version_detector'
+  autoload :RubocopTodoParser, 'rubocop_todo_corrector/rubocop_todo_parser'
+  autoload :RubocopTodoSectionParser, 'rubocop_todo_corrector/rubocop_todo_section_parser'
+end

data/rubocop_todo_corrector.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rubocop_todo_corrector/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rubocop_todo_corrector'
+  spec.version = RubocopTodoCorrector::VERSION
+  spec.authors = ['Ryo Nakamura']
+  spec.email = ['r7kamura@gmail.com']
+
+  spec.summary = 'Auto-correct offenses defined in .rubocop_todo.yml.'
+  spec.homepage = 'https://github.com/r7kamura/rubocop_todo_corrector'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'bundler'
+  spec.add_dependency 'thor'
+  spec.add_dependency 'yard'
+end

data/templates/description.md.erb

@@ -0,0 +1,29 @@
+## Summary
+
+Auto-corrected [<%= @cop_name %>](<%= cop_url %>).
+
+## Details
+
+### <%= @cop_name %>
+
+<% @cop_document[:description].each_line do |line| -%>
+<%= "> #{line}".strip %>
+<% end -%>
+<% unless @cop_document[:examples].empty? -%>
+>
+> #### Examples
+<% @cop_document[:examples].each do |example| -%>
+>
+> <%= example[:name].strip %>
+>
+> ```ruby
+<% example[:text].each_line do |line| -%>
+<%= "> #{line}".strip %>
+<% end -%>
+> ```
+<% end -%>
+<% end -%>
+
+### Note
+
+This pull request was generated by [rubocop_todo_corrector](https://github.com/r7kamura/rubocop_todo_corrector).