rubocop-turn_yourself_in 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a599ac7f8311af164e916f21f707d0909a4cab156690482cd20d897b6207e877
+  data.tar.gz: f0bf85eb42b4c6491267385f2633d48240551162d7c19c599352fc16d064899a
+SHA512:
+  metadata.gz: f8521fa322f3d4304e3704a31f1e87bede41fe5cb054064ca6c18c04b8e70f9469bc5d74319658ae4e522880d3669f82cb34d2ac5b4fc26c21646fb89da74456
+  data.tar.gz: 7c83978ceabbef93f010a653c4ec0a68df425c2b0697ac7a86b4715f0b8a79e2c756c770ec1ad10f265bed1dfca2da231328ebb0110e4feb34192c04ab64e4e8

data/bin/turn_yourself_in

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rubocop/turn_yourself_in/cli'
+RuboCop::TurnYourselfIn::CLI.new(ARGV).run

data/lib/rubocop/turn_yourself_in.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "turn_yourself_in/version"
+
+module Rubocop
+  module TurnYourselfIn
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/rubocop/turn_yourself_in/cli.rb

@@ -0,0 +1,113 @@
+require 'active_support/all'
+require 'English'
+require 'yaml'
+
+module RuboCop
+  module TurnYourselfIn
+    class CLI
+      E_USAGE = 1
+      E_TODO_FILE_NOT_FOUND = 2
+      E_TODO_FILE_PARSE_FAIL = 3
+      E_GIT_ADD_FAIL = 4
+      E_GIT_COMMIT_FAIL = 5
+      E_RUBOCOP_AUTOCORRECT_FAIL = 6
+      E_DIRTY_WORKING_COPY = 7
+      TODO_FILENAME = '.rubocop_todo.yml'
+
+      def initialize(argv)
+        @options = {
+          dry_run: false,
+          prompt: true
+        }
+        args = argv.dup
+        until args.empty?
+          arg = args.shift
+          if arg == '--dry-run'
+            @options[:dry_run] = true
+          elsif arg == '--no-prompt'
+            @options[:prompt] = false
+          else
+            exit_with_usage
+          end
+        end
+      end
+
+      def run
+        assert_clean_working_copy
+        remove_comments
+        loop do
+          todos = parse_todos
+          break if todos.empty?
+          cop = todos.keys.first
+          if @options[:prompt]
+            print format('Auto-correct %s? (y/n/q) ', cop)
+            choice = $stdin.gets.strip
+          else
+            choice = 'y'
+          end
+          if choice == 'y'
+            write_todos(todos.except(cop))
+            command('bin/rubocop -A', E_RUBOCOP_AUTOCORRECT_FAIL)
+            commit(cop)
+          elsif choice == 'q'
+            break
+          end
+        end
+      end
+
+      private
+
+      def exit_with_usage
+        warn "Usage: turn_yourself_in --dry-run --no-prompt"
+        exit E_USAGE
+      end
+
+      def command(cmd, exit_code)
+        puts cmd
+        return if @dry_run
+        unless system(cmd)
+          warn format('Command failed: exited with %s', $CHILD_STATUS.to_s)
+          exit exit_code
+        end
+      end
+
+      def commit(message)
+        command('git add .', E_GIT_ADD_FAIL)
+        command(format('git commit -m "Lint: TYI: %s"', message), E_GIT_COMMIT_FAIL)
+      end
+
+      def clean?
+        return true if @dry_run
+        `git status --porcelain`.strip.empty?
+      end
+
+      # First commit removes comments. We're not going to be able to keep them
+      # because the parser discards them.
+      def remove_comments
+        todos = parse_todos
+        write_todos(todos)
+        commit('Remove comments') unless clean?
+      end
+
+      def parse_todos
+        YAML.load(File.read(TODO_FILENAME))
+      rescue Psych::SyntaxError => e
+        warn e
+        exit E_TODO_FILE_PARSE_FAIL
+      rescue Errno::ENOENT => e
+        warn format('File not found: %s: %s', TODO_FILENAME, e)
+        exit E_TODO_FILE_NOT_FOUND
+      end
+
+      def assert_clean_working_copy
+        return if clean?
+        warn 'This script makes git commits but your working copy is not clean.'
+        exit E_DIRTY_WORKING_COPY
+      end
+
+      def write_todos(todos)
+        File.write(TODO_FILENAME, YAML.dump(todos))
+      end
+    end
+  end
+end

data/lib/rubocop/turn_yourself_in/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rubocop
+  module TurnYourselfIn
+    def self.gem_version
+      Gem::Version.new('0.1.0')
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-turn_yourself_in
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jared Beck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: 
+email:
+- jared@jaredbeck.com
+executables:
+- turn_yourself_in
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/turn_yourself_in
+- lib/rubocop/turn_yourself_in.rb
+- lib/rubocop/turn_yourself_in/cli.rb
+- lib/rubocop/turn_yourself_in/version.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Fix RuboCop to-dos, with one git commit per cop
+test_files: []