rubomop 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e23279657fd3a3f2172cbbcdd14d3f7c6067c8721a1e18b50eaf45ed7602149
-  data.tar.gz: 85f85b5809d827705ee7c0e77978c6efb24be669f3d50c013394373b82f7fe45
+  metadata.gz: 35a52f9290f40da21229725a1eff7e999552f468f5018dc8789ba335de86eace
+  data.tar.gz: 38d3d0e3b4c7f0dbf5fa12a6815cd4a03e1740436262bc6d86e95a1cefc98491
 SHA512:
-  metadata.gz: 64d68023ebb7185bd24096b7377ec04f2968047c2dcee244873f56bcaa3cd569c917979d32db8a4cd95ce32ca342652f2569a9feac2f10b1dde2f1617f75b5f4
-  data.tar.gz: 5c1c1bb6adfe50f915dc1d2607ea2039bf0b6f8070ce89885dcdba72900f723b78b869c5b9221638ccc5b8c53e937c67c9ed0b84736fee9f14def7ae964780ed
+  metadata.gz: 1db04192c3ee364bc31da684196e825ca1a0468ea39fe78e30cdeae95ff032561911c1ae913e0067147d116d8e2acc303b6c49b2f6e2a09ed1ba32d0597f3d4b
+  data.tar.gz: 1e9e4c3b1306d8b90cdeaaaaa0ea1ed0c7ef9d747a8e296489acd5d7a4f20b4dc8a2ed0fc01bb0276fee36d455f798bebe0730bbd2a3e222cb3f24fcbaff4960

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-07-19
+## [0.2.0] - 2022-07-22
+
+- Adds for a .rubomop.yml file with configuration options
+- Command line switch to override config file name
+- Allows for only/except for specific cops by name or pattern 
+- Allows for excluding specific file patterns from being changed
+- Only runs rubocop on selected files, not on the whole repo
+
+## [0.1.0] - 2022-07-20
 
 - Initial release

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    rubomop (0.1.0)
+    rubomop (0.2.0)
       activesupport (> 5.0)
-      date_by_example (> 0.1)
+      date_by_example (~> 0.1)
+      zeitwerk (~> 2.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -64,6 +65,7 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   arm64-darwin-21

data/README.md

@@ -19,6 +19,10 @@ Options include
 * The number of items to delete (default: 10)
 * Whether to limit to autocorrectable cops (default: true)
 * Whether to automatically run `rubocop -a` after deletion
+* A configuration file at `.rubomop.yml`
+* A list of cops to only include for deletion
+* A list of cops to exempt from deletion
+* A list of files to exempt from change
 
 ## Installation
 
@@ -28,13 +32,6 @@ Add this line to your application's Gemfile:
 gem "rubomop"
 ```
 
-(Well, until I actually submit it, it's)
-
-```
-gem "rubocop", github: "noelrappin/rubomop"
-```
-
-
 And then execute:
 
     $ bundle install
@@ -49,15 +46,50 @@ Or install it yourself as:
 $ rubomop --help 
 Usage: rubomop [options]
     -n, --number NUMBER              Number of cleanups to perform (default: 10)
-    -a, --autocorrect_only           Only clean autocorrectable cops (default)
-        --no_autocorrect_only        Clean all cops (not default)
-    -r, --run_rubocop                Run rubocop -aD after (default)
-    -f, --filename FILENAME          Name of todo file (default: ./.rubocop_todo.yml)
-        --no_run_rubocop             Don't run rubocop -aD after (not default)
+    -a, --autocorrect-only           Only clean autocorrectable cops (default)
+        --no_autocorrect-only        Clean all cops (not default)
+    -r, --run-rubocop                Run rubocop -aD after (default)
+    -f, --filename=FILENAME          Name of todo file (default: ./.rubocop_todo.yml)
+        --no-run-rubocop             Don't run rubocop -aD after (not default)
+    -c, --config=CONFIG_FILE         Name of optional config file (default: .rubomop.yml)
+        --only=ONLY                  String or regex of cops to limit removal do, can have multiple
+        --except=EXCEPT              String or regex of cops to limit removal do, can have multiple
+        --block=BLOCK                String or regex of files to not touch, can have multiple
     -h, --help                       Prints this help
+
+```
+
+The `--only` option allows you to limit cops to be selected from to only 
+those listed, the option can be a string and will match on substrings, and you 
+can have more than one. 
+
+The `--except` option allows you to specify a cop that should not be 
+selected, again, the option can be a string and will match on substrings, and you 
+can have more than one. If a cop is in both the `--except` and `--include` 
+lists for some reasone, the except list wins and it's excluded.
+
+The `--block` option allows you to specify files that should not be selected 
+for any cops. The option can be a string and will match on substrings and you can 
+have more than one. If a cop/file combination is in both the `--include` 
+cops list and the file `--block` list, the block wins and the file is not 
+included. 
+
+You can also put options in a `rubomop.yml` file, or you can put it in a 
+different location with the `-c` option from the command line.
+
+```yaml
+number: 10
+autocorrect-only: true
+only:
+  - Lint*
+block: 
+  - oops*
 ```
 
-## Development
+If an option is set via the config file and the command line, the command 
+line option wins. This is true even for the list options where you can have 
+more than one, the command line completly blocks the config file from being 
+used.
 
 
 ## Contributing

data/exe/rubomop

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
 require "rubomop"
+# require_relative "../lib/rubomop" # when running locally
 
 Rubomop::Runner.new.execute(ARGV)

data/lib/rubomop/cop.rb

@@ -57,10 +57,6 @@ module Rubomop
       result + files.map { "    - '#{_1}'"}
     end
 
-    def delete_options
-      files.map { {cop: self, file: _1} }
-    end
-
     def delete!(filename)
       files.delete(filename)
       self.offense_count -= 1

data/lib/rubomop/mop.rb

@@ -0,0 +1,86 @@
+module Rubomop
+  class Mop
+    attr_accessor :todo_file, :number, :autocorrect_only, :run_rubocop
+    attr_accessor :verbose, :only, :except, :block
+
+    def initialize(todo_file, number, autocorrect_only, verbose, run_rubocop, only, except, blocklist)
+      @todo_file = todo_file
+      @number = number
+      @autocorrect_only = autocorrect_only
+      @verbose = verbose
+      @run_rubocop = run_rubocop
+      @only = only
+      @except = except
+      @block = blocklist
+    end
+
+    def cops
+      todo_file.cops
+    end
+
+    def accept?(delete_option)
+      return false if autocorrect_only && !delete_option.cop.autocorrect
+      unless except.empty?
+        return except.none? { delete_option.cop.name.include?(_1) }
+      end
+      unless block.empty?
+        return block.none? { delete_option.file.include?(_1) }
+      end
+      unless only.empty?
+        return only.any? { delete_option.cop.name.include?(_1) }
+      end
+      true
+      # return true unless autocorrect_only
+      # cop.autocorrect
+    end
+
+    def delete_options
+      cops.flat_map { delete_options_for(_1) }
+        .select { accept?(_1) }
+    end
+
+    def delete_options_for(cop)
+      cop.files.map { DeleteOption.new(cop, _1, verbose, run_rubocop) }
+    end
+
+    def log(message)
+      return unless verbose
+      print message
+    end
+
+    def mop!
+      number.times do |i|
+        options = delete_options
+        next if options.empty?
+        log("#{i + 1}:")
+        mop_once!(options.sample)
+        log("\n")
+      end
+    end
+
+    def mop_once!(delete_option)
+      delete_option.print_message if verbose
+      delete_option.delete!
+      return unless run_rubocop
+      todo_file.save!
+      delete_option.rubocop_runner
+    end
+
+    DeleteOption = Struct.new(:cop, :file, :verbose, :run_rubocop) do
+      def print_message
+        return unless verbose
+        print "Deleting #{file} from #{cop.name}" if verbose
+      end
+
+      def delete!
+        cop.delete!(file)
+      end
+
+      def rubocop_runner
+        return unless run_rubocop
+        print "\nbundle exec rubocop #{file} -aD\n"
+        system("bundle exec rubocop #{file} -aD")
+      end
+    end
+  end
+end

data/lib/rubomop/runner.rb

@@ -1,46 +1,97 @@
 module Rubomop
   class Runner
-    attr_accessor :number, :autocorrect_only, :run_rubocop, :filename, :todo
+    attr_accessor :number, :autocorrect_only, :run_rubocop
+    attr_accessor :filename, :todo, :verbose, :config, :options_from_command_line
+    attr_accessor :only, :except, :block
+
     NUM_STRING = "Number of cleanups to perform (default: 10)"
     AUTOCORRECT_STRING = "Only clean autocorrectable cops (default)"
     NO_AUTOCORRECT_STRING = "Clean all cops (not default)"
     RUBOCOP_STRING = "Run rubocop -aD after (default)"
     NO_RUBOCOP_STRING = "Don't run rubocop -aD after (not default)"
     FILENAME_STRING = "Name of todo file (default: ./.rubocop_todo.yml)"
+    CONFIG_STRING = "Name of optional config file (default: .rubomop.yml)"
+    ONLY_STRING = "String or regex of cops to limit removal do, can have multiple"
+    EXCEPT_STRING = "String or regex of cops to not remove from, can have multiple"
+    BLOCK_STRING = "String or regex of files to not touch, can have multiple"
 
     def initialize
       @number = 10
       @autocorrect_only = true
       @run_rubocop = true
       @filename = ".rubocop_todo.yml"
+      @config = ".rubomop.yml"
       @todo = nil
+      @verbose = true
+      @options_from_command_line = []
+      @only = []
+      @except = []
+      @block = []
     end
 
     def execute(args)
-      parse(args)
+      load_options(args)
       run
     end
 
+    def load_options(args)
+      parse(args)
+      load_from_file
+    end
+
+    def load_from_file
+      return unless File.exist?(config)
+      file_options = YAML.safe_load(File.read(config))
+      file_options.each do |key, value|
+        next if options_from_command_line.include?(key)
+        send("#{key.underscore}=", value) if respond_to?("#{key.underscore}=")
+      end
+    rescue Psych::Exception
+      nil
+    end
+
     def parse(args)
       option_parser = OptionParser.new do |opts|
         opts.banner = "Usage: rubomop [options]"
         opts.on("-nNUMBER", "--number NUMBER", Integer, NUM_STRING) do |value|
           self.number = value
+          @options_from_command_line << "number"
         end
         opts.on("-a", "--autocorrect-only", AUTOCORRECT_STRING) do
           self.autocorrect_only = true
+          @options_from_command_line << "autocorrect-only"
         end
         opts.on("--no_autocorrect-only", NO_AUTOCORRECT_STRING) do
           self.autocorrect_only = false
+          @options_from_command_line << "autocorrect-only"
         end
         opts.on("-r", "--run-rubocop", RUBOCOP_STRING) do
           self.run_rubocop = true
+          @options_from_command_line << "run-rubocop"
         end
-        opts.on("-fFILENAME", "--filename FILENAME", FILENAME_STRING) do |value|
+        opts.on("-fFILENAME", "--filename=FILENAME", FILENAME_STRING) do |value|
           self.filename = value
+          @options_from_command_line << "filename"
         end
         opts.on("--no-run-rubocop", NO_RUBOCOP_STRING) do
           self.run_rubocop = false
+          @options_from_command_line << "run-rubocop"
+        end
+        opts.on("-cCONFIG_FILE", "--config=CONFIG_FILE", CONFIG_STRING) do |value|
+          self.config = value
+          @options_from_command_line << "config"
+        end
+        opts.on("--only=ONLY", ONLY_STRING) do |value|
+          only << value
+          @options_from_command_line << "only"
+        end
+        opts.on("--except=EXCEPT", ONLY_STRING) do |value|
+          except << value
+          @options_from_command_line << "except"
+        end
+        opts.on("--block=BLOCK", BLOCK_STRING) do |value|
+          block << value
+          @options_from_command_line << "block"
         end
         opts.on("-h", "--help", "Prints this help") do
           puts opts
@@ -50,34 +101,21 @@ module Rubomop
       option_parser.parse(args)
     end
 
+    def mop
+      Mop.new(todo, number, autocorrect_only, verbose, run_rubocop, only, except, block)
+    end
+
     def run
       self.todo = TodoFile.new(filename: filename)&.parse
       return if todo.nil?
-      number.times do |i|
-        delete_options = todo&.delete_options(autocorrect_only: autocorrect_only)
-        next if delete_options.empty?
-        object_to_delete = delete_options.sample
-        print "#{i + 1}: Deleting #{object_to_delete[:file]} from #{object_to_delete[:cop].name}\n"
-        todo&.delete!(object_to_delete)
-      end
       backup_existing_file
-      save_new_file
-      rubocop_runner
+      mop.mop!
+      todo&.save!
     end
 
     def backup_existing_file
       FileUtils.rm("#{filename}.bak") if File.exist?("#{filename}.bak")
       FileUtils.mv(filename, "#{filename}.bak")
     end
-
-    def save_new_file
-      File.write(filename, todo&.output || "")
-    end
-
-    def rubocop_runner
-      return unless run_rubocop
-      print "Running bundle exec rubocop -aD"
-      system("bundle exec rubocop -aD")
-    end
   end
 end

data/lib/rubomop/todo_file.rb

@@ -28,14 +28,9 @@ module Rubomop
       output_lines.join("\n") + "\n"
     end
 
-    def delete_options(autocorrect_only: true)
-      result = cops.flat_map(&:delete_options)
-      result = result.select { _1[:cop].autocorrect } if autocorrect_only
-      result
-    end
-
-    def delete!(delete_option)
-      delete_option[:cop].delete!(delete_option[:file])
+    def save!
+      FileUtils.rm_f(filename)
+      File.write(filename, output || "")
     end
   end
 end

data/lib/rubomop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubomop
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/rubomop.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/array"
+require "active_support/core_ext/string/inflections"
+require "awesome_print"
 require "fileutils"
 require "optparse"
-require "awesome_print"
-require "active_support/core_ext/array"
-require_relative "rubomop/cop"
-require_relative "rubomop/runner"
-require_relative "rubomop/todo_file"
-require_relative "rubomop/version"
+require "yaml"
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
 
 module Rubomop
   class Error < StandardError; end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: rubomop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Noel Rappin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: date_by_example
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
@@ -38,6 +38,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 description: Rubomop cleans up after your Rubocop
 email:
 - noel.rappin@chime.com
@@ -59,6 +73,7 @@ files:
 - exe/rubomop
 - lib/rubomop.rb
 - lib/rubomop/cop.rb
+- lib/rubomop/mop.rb
 - lib/rubomop/runner.rb
 - lib/rubomop/todo_file.rb
 - lib/rubomop/version.rb