ruboclean 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 837aa85e87f68e67b33c4823a8d8e7d121e4f7da094f08d69965343fd5633ab6
-  data.tar.gz: 10ef204409cceadbea450b54d05b60473b8ad47676a7b958d73b2204722e972d
+  metadata.gz: 4d44db013c200c2aa27fb69d03ba72a9160fdff84c32fd337616c741f665fc02
+  data.tar.gz: 506a81ba8570624d6a7694b634c5daeca924049ec4a799cc8d3634500908aa5d
 SHA512:
-  metadata.gz: a2797e99e1aaac4b460230fb67381377c339047d38cf689a784aa678201f326ebc924628b470c86df2cc24ef917f89a4d686d3a490010f39878dcab6f2acec43
-  data.tar.gz: f432dae557d42f76bf41aa2fa684a6f0465adfd310f7137670aad9aa8646757cda25f5e80585eba95e70005d22e55255016122b8ee8c8aa280bd647dd2f2e83e
+  metadata.gz: 46aefeee7846f41223c011cba0926d1a4554c9c9072ed05b3d346d584f1e71a76ded64daf6648956b6d707d82388696fa4ae2729560f710ad9d1cd522b30f8b1
+  data.tar.gz: b4b699189ad6cced7bb0beeed940550217c0d14c140b6d20eb3f25876ecd23415436bdd91f106d9cc33a57c0a52582e58515159854d37a3ac860c1d3be1d46ad

data/.github/workflows/ci.yml

@@ -1,33 +1,29 @@
 env:
-  RUBY_VERSION: 2.7
   CC_TEST_REPORTER_BINARY_URL: https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
   CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
 
 name: Continuous Integration
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - 'main'  # Set a branch to deploy
+  pull_request:
 
 jobs:
   test:
-    name: Run bin/test
-    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby: ['2.7', '3.0', '3.1', '3.2', head]
+    runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
 
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ env.RUBY_VERSION }}
-
-      # install gems
-      - name: Cache Ruby gems
-        uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-
-      - name: Bundle install
-        run: |
-          bundle config path vendor/bundle
-          bundle install --jobs 4 --retry 3
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
 
       # prepare CC test reporter
       - name: Download CC test reporter binary

data/.rubocop.yml

@@ -1,107 +1,376 @@
 ---
 
+require:
+- rubocop-minitest
+- rubocop-rake
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: true
+
+Gemspec/DevelopmentDependencies:
+  Enabled: true
+
+Gemspec/RequireMFA:
+  Enabled: true
+
 Layout/BeginEndAlignment:
   Enabled: true
 
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
 
+Layout/LineContinuationLeadingSpace:
+  Enabled: true
+
+Layout/LineContinuationSpacing:
+  Enabled: true
+
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
 
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+
+Lint/AmbiguousAssignment:
+  Enabled: true
+
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: true
+
+Lint/AmbiguousRange:
+  Enabled: true
+
 Lint/BinaryOperatorWithIdenticalOperands:
   Enabled: true
 
 Lint/ConstantDefinitionInBlock:
   Enabled: true
 
+Lint/ConstantOverwrittenInRescue:
+  Enabled: true
+
+Lint/DeprecatedConstants:
+  Enabled: true
+
 Lint/DeprecatedOpenSSLConstant:
   Enabled: true
 
+Lint/DuplicateBranch:
+  Enabled: true
+
 Lint/DuplicateElsifCondition:
   Enabled: true
 
+Lint/DuplicateMagicComment:
+  Enabled: true
+
+Lint/DuplicateMatchPattern:
+  Enabled: true
+
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+
 Lint/DuplicateRequire:
   Enabled: true
 
 Lint/DuplicateRescueException:
   Enabled: true
 
+Lint/EmptyBlock:
+  Enabled: true
+
+Lint/EmptyClass:
+  Enabled: true
+
 Lint/EmptyConditionalBody:
   Enabled: true
 
 Lint/EmptyFile:
   Enabled: true
 
+Lint/EmptyInPattern:
+  Enabled: true
+
 Lint/FloatComparison:
   Enabled: true
 
 Lint/IdentityComparison:
   Enabled: true
 
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Enabled: true
+
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+
 Lint/MissingSuper:
   Enabled: true
 
 Lint/MixedRegexpCaptureTypes:
   Enabled: true
 
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+
+Lint/NonAtomicFileOperation:
+  Enabled: true
+
+Lint/NumberedParameterAssignment:
+  Enabled: true
+
+Lint/OrAssignmentToConstant:
+  Enabled: true
+
 Lint/OutOfRangeRegexpRef:
   Enabled: true
 
 Lint/RaiseException:
   Enabled: true
 
+Lint/RedundantDirGlobSort:
+  Enabled: true
+
+Lint/RefinementImportMethods:
+  Enabled: true
+
+Lint/RequireRangeParentheses:
+  Enabled: true
+
+Lint/RequireRelativeSelfPath:
+  Enabled: true
+
 Lint/SelfAssignment:
   Enabled: true
 
 Lint/StructNewOverride:
   Enabled: true
 
+Lint/SymbolConversion:
+  Enabled: true
+
+Lint/ToEnumArguments:
+  Enabled: true
+
 Lint/TopLevelReturnWithArgument:
   Enabled: true
 
 Lint/TrailingCommaInAttributeDeclaration:
   Enabled: true
 
+Lint/TripleQuotes:
+  Enabled: true
+
+Lint/UnexpectedBlockArity:
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+
 Lint/UnreachableLoop:
   Enabled: true
 
 Lint/UselessMethodDefinition:
   Enabled: true
 
+Lint/UselessRescue:
+  Enabled: true
+
+Lint/UselessRuby2Keywords:
+  Enabled: true
+
 Lint/UselessTimes:
   Enabled: true
 
+Metrics/CollectionLiteralLength:
+  Enabled: true
+
+Minitest/AssertInDelta:
+  Enabled: true
+
+Minitest/AssertKindOf:
+  Enabled: true
+
+Minitest/AssertOutput:
+  Enabled: true
+
+Minitest/AssertPathExists:
+  Enabled: true
+
+Minitest/AssertPredicate:
+  Enabled: true
+
+Minitest/AssertRaisesCompoundBody:
+  Enabled: true
+
+Minitest/AssertRaisesWithRegexpArgument:
+  Enabled: true
+
+Minitest/AssertSame:
+  Enabled: true
+
+Minitest/AssertSilent:
+  Enabled: true
+
+Minitest/AssertWithExpectedArgument:
+  Enabled: true
+
+Minitest/AssertionInLifecycleHook:
+  Enabled: true
+
+Minitest/DuplicateTestRun:
+  Enabled: true
+
+Minitest/EmptyLineBeforeAssertionMethods:
+  Enabled: true
+
+Minitest/LifecycleHooksOrder:
+  Enabled: true
+
+Minitest/LiteralAsActualArgument:
+  Enabled: true
+
+Minitest/MultipleAssertions:
+  Enabled: true
+  Max: 5
+
+Minitest/NonPublicTestMethod:
+  Enabled: true
+
+Minitest/RefuteInDelta:
+  Enabled: true
+
+Minitest/RefuteKindOf:
+  Enabled: true
+
+Minitest/RefutePathExists:
+  Enabled: true
+
+Minitest/RefutePredicate:
+  Enabled: true
+
+Minitest/RefuteSame:
+  Enabled: true
+
+Minitest/ReturnInTestMethod:
+  Enabled: true
+
+Minitest/SkipEnsure:
+  Enabled: true
+
+Minitest/SkipWithoutReason:
+  Enabled: true
+
+Minitest/TestFileName:
+  Enabled: true
+
+Minitest/TestMethodName:
+  Enabled: true
+
+Minitest/UnreachableAssertion:
+  Enabled: true
+
+Minitest/UnspecifiedException:
+  Enabled: true
+
+Minitest/UselessAssertion:
+  Enabled: true
+
+Naming/BlockForwarding:
+  Enabled: true
+
+Security/CompoundHash:
+  Enabled: true
+
+Security/IoMethods:
+  Enabled: true
+
 Style/AccessorGrouping:
   Enabled: true
 
+Style/ArgumentsForwarding:
+  Enabled: true
+
 Style/ArrayCoercion:
   Enabled: true
 
+Style/ArrayIntersect:
+  Enabled: true
+
 Style/BisectedAttrAccessor:
   Enabled: true
 
 Style/CaseLikeIf:
   Enabled: true
 
+Style/CollectionCompact:
+  Enabled: true
+
 Style/CombinableLoops:
   Enabled: true
 
+Style/ComparableClamp:
+  Enabled: true
+
+Style/ConcatArrayLiterals:
+  Enabled: true
+
+Style/DataInheritance:
+  Enabled: true
+
+Style/DirEmpty:
+  Enabled: true
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+
+Style/EmptyHeredoc:
+  Enabled: true
+
+Style/EndlessMethod:
+  Enabled: true
+
+Style/EnvHome:
+  Enabled: true
+
+Style/ExactRegexpMatch:
+  Enabled: true
+
 Style/ExplicitBlockArgument:
   Enabled: true
 
 Style/ExponentialNotation:
   Enabled: true
 
+Style/FetchEnvVar:
+  Enabled: true
+
+Style/FileEmpty:
+  Enabled: true
+
+Style/FileRead:
+  Enabled: true
+
+Style/FileWrite:
+  Enabled: true
+
 Style/GlobalStdStream:
   Enabled: true
 
 Style/HashAsLastArrayItem:
   Enabled: true
 
+Style/HashConversion:
+  Enabled: true
+
 Style/HashEachMethods:
   Enabled: true
 
+Style/HashExcept:
+  Enabled: true
+
 Style/HashLikeCase:
   Enabled: true
 
@@ -111,30 +380,120 @@ Style/HashTransformKeys:
 Style/HashTransformValues:
   Enabled: true
 
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+
+Style/InPatternThen:
+  Enabled: true
+
 Style/KeywordParametersOrder:
   Enabled: true
 
+Style/MagicCommentFormat:
+  Enabled: true
+
+Style/MapCompactWithConditionalBlock:
+  Enabled: true
+
+Style/MapToHash:
+  Enabled: true
+
+Style/MapToSet:
+  Enabled: true
+
+Style/MinMaxComparison:
+  Enabled: true
+
+Style/MultilineInPatternThen:
+  Enabled: true
+
+Style/NegatedIfElseCondition:
+  Enabled: true
+
+Style/NestedFileDirname:
+  Enabled: true
+
+Style/NilLambda:
+  Enabled: true
+
+Style/NumberedParameters:
+  Enabled: true
+
+Style/NumberedParametersLimit:
+  Enabled: true
+
+Style/ObjectThen:
+  Enabled: true
+
+Style/OpenStructUse:
+  Enabled: true
+
+Style/OperatorMethodCall:
+  Enabled: true
+
 Style/OptionalBooleanParameter:
   Enabled: true
 
+Style/QuotedSymbols:
+  Enabled: true
+
+Style/RedundantArgument:
+  Enabled: true
+
+Style/RedundantArrayConstructor:
+  Enabled: true
+
 Style/RedundantAssignment:
   Enabled: true
 
+Style/RedundantConstantBase:
+  Enabled: true
+
+Style/RedundantDoubleSplatHashBraces:
+  Enabled: true
+
+Style/RedundantEach:
+  Enabled: true
+
 Style/RedundantFetchBlock:
   Enabled: true
 
 Style/RedundantFileExtensionInRequire:
   Enabled: true
 
+Style/RedundantFilterChain:
+  Enabled: true
+
+Style/RedundantHeredocDelimiterQuotes:
+  Enabled: true
+
+Style/RedundantInitialize:
+  Enabled: true
+
+Style/RedundantLineContinuation:
+  Enabled: true
+
 Style/RedundantRegexpCharacterClass:
   Enabled: true
 
+Style/RedundantRegexpConstructor:
+  Enabled: true
+
 Style/RedundantRegexpEscape:
   Enabled: true
 
 Style/RedundantSelfAssignment:
   Enabled: true
 
+Style/RedundantSelfAssignmentBranch:
+  Enabled: true
+
+Style/RedundantStringEscape:
+  Enabled: true
+
+Style/SelectByRegexp:
+  Enabled: true
+
 Style/SingleArgumentDig:
   Enabled: true
 
@@ -144,5 +503,18 @@ Style/SlicingWithRange:
 Style/SoleNestedConditional:
   Enabled: true
 
+Style/StringChars:
+  Enabled: true
+
 Style/StringConcatenation:
   Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/SwapValues:
+  Enabled: true
+
+Style/YodaExpression:
+  Enabled: true

data/Gemfile

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
 group :development do
-  gem 'minitest'
-  gem 'rake'
-  gem 'rubocop'
-  gem 'simplecov', '< 0.18'
+  gem "minitest"
+  gem "rake"
+  gem "rubocop"
+  gem "rubocop-minitest", require: false
+  gem "rubocop-rake", require: false
+  gem "simplecov", "< 0.18"
 end

data/Gemfile.lock

@@ -1,40 +1,47 @@
 PATH
   remote: .
   specs:
-    ruboclean (0.2.1)
+    ruboclean (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    docile (1.3.5)
-    json (2.5.1)
-    minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.1.0)
+    docile (1.4.0)
+    json (2.6.3)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
+      racc
+    racc (1.7.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
     rexml (3.2.5)
-    rubocop (1.13.0)
+    rubocop (1.52.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.11.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.31.0)
+      rubocop (>= 1.39, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.13.0)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby
@@ -44,7 +51,9 @@ DEPENDENCIES
   rake
   ruboclean!
   rubocop
+  rubocop-minitest
+  rubocop-rake
   simplecov (< 0.18)
 
 BUNDLED WITH
-   2.2.3
+   2.4.13

data/README.md

@@ -30,8 +30,9 @@ AllCops:
   Exclude:
   - bin/**/*
 
+# Preceding comments will be removed unless the --preserve-comments option is used.
 require:
-- rubocop-rails
+- rubocop-rails # Inline comments will always be removed.
 ```
 
 ### Output `.rubocop.yml`:
@@ -54,10 +55,8 @@ Layout/LineLength:
 
 Rails/ShortI18n:
   Enabled: true
-
 ```
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -78,27 +77,25 @@ Or install it yourself as:
 gem install ruboclean
 ```
 
-## Usage
+## Command synopsis
 
 ```shell
-ruboclean [path]
+ruboclean [path] [--silent] [--preserve-comments]
 ```
 
-* `path` is optional, it defaults to the current working directory
-* `path` can be a directory that contains a `.rubocop.yml`
-* `path` can be a path to a `.rubocop.yml` directly
+### Parameters
 
-### Examples
+| Parameter | Description |
+|:-|:-|
+| `path` | Can be a directory that contains a `.rubocop.yml`, or a path to a `.rubocop.yml` directly. Defaults to the current working directory.  |
+| `--silent` | Suppress any output displayed on the screen when executing the command. |
+| `--preserve-comments` |  Preserves **preceding** comments for each top-level entry in the configuration. Inline comments are **not** preserved. |
 
-```shell
-ruboclean                 # uses `.rubocop.yml` of current working directory
-```
-
-```shell
-ruboclean /path/to/dir    # uses `.rubocop.yml` of /path/to/dir
-```
+### Examples
 
 ```shell
+ruboclean                             # uses `.rubocop.yml` of current working directory
+ruboclean /path/to/dir                # uses `.rubocop.yml` of /path/to/dir
 ruboclean /path/to/dir/.rubocop.yml
 ```
 
@@ -112,7 +109,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/lxxxvi/ruboclean. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/lxxxvi/ruboclean/blob/master/CODE_OF_CONDUCT.md).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
 task default: :test

data/bin/console

@@ -2,8 +2,8 @@
 
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'ruboclean'
+require "bundler/setup"
+require "ruboclean"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -12,5 +12,5 @@ require 'ruboclean'
 # require 'pry'
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/bin/ruboclean

@@ -2,10 +2,5 @@
 
 # frozen_string_literal: true
 
-require 'ruboclean'
-
-path = ARGV[0] || Dir.pwd
-
-print "Using path '#{path}' ... "
-Ruboclean.run(path)
-puts 'done.'
+require "ruboclean"
+Ruboclean.run_from_cli!(ARGV)

data/bin/test

@@ -2,13 +2,13 @@
 
 # frozen_string_literal: true
 
-require 'fileutils'
+require "fileutils"
 
 # Runs all tests and linters
 class BinTest
   include FileUtils
 
-  APP_ROOT = File.expand_path('..', __dir__)
+  APP_ROOT = File.expand_path("..", __dir__)
 
   def system!(*args)
     system(*args) || abort("\n== Command #{args} failed ==")
@@ -17,10 +17,10 @@ class BinTest
   def run
     chdir APP_ROOT do
       puts "\n== Run tests =="
-      system! 'bundle exec rake test'
+      system! "bundle exec rake test"
 
       puts "\n== Run rubocop =="
-      system! 'bundle exec rubocop -p'
+      system! "bundle exec rubocop --parallel"
     end
   end
 end

data/lib/ruboclean/arguments.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Ruboclean
+  # Reads command line arguments and exposes corresponding reader methods
+  class Arguments
+    def initialize(command_line_arguments = [])
+      @command_line_arguments = Array(command_line_arguments)
+    end
+
+    def path
+      @path ||= find_path
+    end
+
+    def verbose?
+      !silent?
+    end
+
+    def silent?
+      @silent ||= find_argument("--silent")
+    end
+
+    def preserve_comments?
+      @preserve_comments ||= find_argument("--preserve-comments")
+    end
+
+    private
+
+    attr_reader :command_line_arguments
+
+    def find_path
+      command_line_arguments.first.then do |argument|
+        return Dir.pwd if argument.nil? || argument.start_with?("--")
+
+        argument
+      end
+    end
+
+    def find_argument(name)
+      command_line_arguments.any? { |argument| argument == name }
+    end
+  end
+end

data/lib/ruboclean/grouper.rb

@@ -14,7 +14,7 @@ module Ruboclean
       @config_hash.each_with_object(empty_groups) do |item, result|
         key, value = item
         target_group = find_target_group(key)
-        result[target_group].merge! Hash[key, value]
+        result[target_group].merge!({ key => value })
       end
     end
 
@@ -26,7 +26,7 @@ module Ruboclean
 
     def find_target_group(key)
       return :base if key.start_with?(/[a-z]/)
-      return :cops if key.include?('/')
+      return :cops if key.include?("/")
 
       :namespaces
     end

data/lib/ruboclean/orderer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ruboclean/grouper'
+require "ruboclean/grouper"
 
 module Ruboclean
   # Orders the items within the groups alphabetically

data/lib/ruboclean/rubocop_configuration.rb

@@ -10,5 +10,9 @@ module Ruboclean
     def order
       Ruboclean::Orderer.new(@config_hash).order
     end
+
+    def nil?
+      @config_hash.nil?
+    end
   end
 end

data/lib/ruboclean/rubocop_configuration_path.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
-require 'pathname'
-require 'yaml'
+require "pathname"
+require "yaml"
 
 module Ruboclean
   # Interface for reading and writing the `.rubocop.yml` file
   class RubocopConfigurationPath
+    PERMITTED_CLASSED = [Regexp].freeze
+
     # Thrown if given path is invalid
     class InvalidPathError < StandardError
       def initialize(path)
@@ -17,7 +19,7 @@ module Ruboclean
       input_path = Pathname.new(path)
 
       @rubocop_configuration_path = if input_path.directory?
-                                      input_path.join('.rubocop.yml')
+                                      input_path.join(".rubocop.yml")
                                     else
                                       input_path
                                     end
@@ -29,9 +31,10 @@ module Ruboclean
       Ruboclean::RubocopConfiguration.new(load_yaml)
     end
 
-    def write(rubocop_configuration)
-      output = sanitize_yaml(rubocop_configuration.to_yaml)
-      @rubocop_configuration_path.write(output)
+    def write(rubocop_configuration, preserve_comments: false)
+      output_yaml = sanitize_yaml(rubocop_configuration.to_yaml)
+      output_yaml = preserve_preceding_comments(source_yaml, output_yaml) if preserve_comments
+      @rubocop_configuration_path.write(output_yaml)
     end
 
     private
@@ -41,7 +44,25 @@ module Ruboclean
     end
 
     def load_yaml
-      YAML.safe_load(@rubocop_configuration_path.read)
+      YAML.safe_load(source_yaml, permitted_classes: PERMITTED_CLASSED)
+    end
+
+    def source_yaml
+      @source_yaml ||= @rubocop_configuration_path.read
+    end
+
+    def preserve_preceding_comments(source, target)
+      target.dup.tap do |output|
+        source.scan(/(((^ *#.*\n|^\s*\n)+)(?![\s#]).+)/) do |groups|
+          config_keys_with_preceding_lines = groups.first
+          *preceding_lines, config_key = config_keys_with_preceding_lines.split("\n")
+
+          next if preceding_lines.all?(:empty?)
+          next if config_key.gsub(/\s/, "").empty?
+
+          output.sub!(/^#{config_key}$/, config_keys_with_preceding_lines.strip)
+        end
+      end
     end
   end
 end

data/lib/ruboclean/runner.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Ruboclean
+  # Proxy for invoking the cleaning
+  class Runner
+    def initialize(arguments)
+      @arguments = arguments
+    end
+
+    def run!
+      rubocop_configuration_path = RubocopConfigurationPath.new(arguments.path)
+      rubocop_configuration = rubocop_configuration_path.load
+
+      return if rubocop_configuration.nil?
+
+      rubocop_configuration_path.write(rubocop_configuration.order, preserve_comments: arguments.preserve_comments?)
+    end
+
+    private
+
+    attr_reader :arguments
+  end
+end

data/lib/ruboclean/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ruboclean
-  VERSION = '0.2.1'
+  VERSION = "0.4.0"
 end

data/lib/ruboclean.rb

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
 
-require 'ruboclean/version'
-require 'ruboclean/rubocop_configuration'
-require 'ruboclean/rubocop_configuration_path'
-require 'ruboclean/orderer'
+require "ruboclean/version"
+require "ruboclean/arguments"
+require "ruboclean/rubocop_configuration"
+require "ruboclean/rubocop_configuration_path"
+require "ruboclean/runner"
+require "ruboclean/orderer"
 
 # Ruboclean entry point
 module Ruboclean
   class Error < StandardError; end
 
-  def self.run(path)
-    rubocop_configuration_path = RubocopConfigurationPath.new(path)
-    rubocop_configuration = rubocop_configuration_path.load
-    rubocop_configuration_path.write(rubocop_configuration.order)
+  def self.run_from_cli!(command_line_arguments)
+    Ruboclean::Arguments.new(command_line_arguments).tap do |arguments|
+      print "Using path '#{arguments.path}' ... " if arguments.verbose?
+      Runner.new(arguments).run!
+      puts "done." if arguments.verbose?
+    end
   end
 end

data/ruboclean.gemspec

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
-require_relative 'lib/ruboclean/version'
+require_relative "lib/ruboclean/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'ruboclean'
+  spec.name          = "ruboclean"
   spec.version       = Ruboclean::VERSION
-  spec.authors       = ['lxxxvi']
-  spec.email         = ['lxxxvi@users.noreply.github.com']
+  spec.authors       = ["lxxxvi"]
+  spec.email         = ["lxxxvi@users.noreply.github.com"]
 
-  spec.summary       = 'Cleans and orders settings in .rubocop.yml'
-  spec.description   = 'Cleans and orders settings in .rubocop.yml'
-  spec.homepage      = 'https://github.com/lxxxvi/ruboclean'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+  spec.summary       = "Cleans and orders settings in .rubocop.yml"
+  spec.description   = "Cleans and orders settings in .rubocop.yml"
+  spec.homepage      = "https://github.com/lxxxvi/ruboclean"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/lxxxvi/ruboclean'
-  spec.metadata['changelog_uri'] = 'https://github.com/lxxxvi/ruboclean/blob/master/CHANGELOG.md'
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/lxxxvi/ruboclean"
+  spec.metadata["changelog_uri"] = "https://github.com/lxxxvi/ruboclean/blob/master/CHANGELOG.md"
 
   # 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.
@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
-  spec.executables << 'ruboclean'
-  spec.require_paths = ['lib']
+  spec.executables << "ruboclean"
+  spec.require_paths = ["lib"]
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruboclean
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - lxxxvi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-01 00:00:00.000000000 Z
+date: 2023-06-09 00:00:00.000000000 Z
 dependencies: []
 description: Cleans and orders settings in .rubocop.yml
 email:
@@ -32,10 +32,12 @@ files:
 - bin/setup
 - bin/test
 - lib/ruboclean.rb
+- lib/ruboclean/arguments.rb
 - lib/ruboclean/grouper.rb
 - lib/ruboclean/orderer.rb
 - lib/ruboclean/rubocop_configuration.rb
 - lib/ruboclean/rubocop_configuration_path.rb
+- lib/ruboclean/runner.rb
 - lib/ruboclean/version.rb
 - ruboclean.gemspec
 homepage: https://github.com/lxxxvi/ruboclean
@@ -45,6 +47,7 @@ metadata:
   homepage_uri: https://github.com/lxxxvi/ruboclean
   source_code_uri: https://github.com/lxxxvi/ruboclean
   changelog_uri: https://github.com/lxxxvi/ruboclean/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -60,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Cleans and orders settings in .rubocop.yml