ruboclean 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8356a24c5eef21d90f98b6a9d70e05c39eecca00bdad3cc44cf487f7f13d4d3f
-  data.tar.gz: 547493df65b231feec2b0e110beaca285a4c708726a60f25ce42da25c04297de
+  metadata.gz: 4d44db013c200c2aa27fb69d03ba72a9160fdff84c32fd337616c741f665fc02
+  data.tar.gz: 506a81ba8570624d6a7694b634c5daeca924049ec4a799cc8d3634500908aa5d
 SHA512:
-  metadata.gz: 2a322034ef76aef728838a67c0400b6a869614765367347582b99a6a0e9d76ceb1c04ac7f93217d35702eb18b9c111958b059ee39716a8f5d2535f00a6e05e0b
-  data.tar.gz: 2b9895e2eba1124a33fd0808f2622a22e848cfe87ebede24cda7f17dfc7490e233db040342de84343d69f1dd57d430b8feaf5e9aa87d8961c8c3662624d3e583
+  metadata.gz: 46aefeee7846f41223c011cba0926d1a4554c9c9072ed05b3d346d584f1e71a76ded64daf6648956b6d707d82388696fa4ae2729560f710ad9d1cd522b30f8b1
+  data.tar.gz: b4b699189ad6cced7bb0beeed940550217c0d14c140b6d20eb3f25876ecd23415436bdd91f106d9cc33a57c0a52582e58515159854d37a3ac860c1d3be1d46ad

data/.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        ruby: ['2.7', '3.0', '3.1', head]
+        ruby: ['2.7', '3.0', '3.1', '3.2', head]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3

data/.rubocop.yml

@@ -4,11 +4,10 @@ require:
 - rubocop-minitest
 - rubocop-rake
 
-Style/StringLiterals:
+Gemspec/DeprecatedAttributeAssignment:
   Enabled: true
-  EnforcedStyle: double_quotes
 
-Gemspec/DeprecatedAttributeAssignment:
+Gemspec/DevelopmentDependencies:
   Enabled: true
 
 Gemspec/RequireMFA:
@@ -68,6 +67,9 @@ Lint/DuplicateElsifCondition:
 Lint/DuplicateMagicComment:
   Enabled: true
 
+Lint/DuplicateMatchPattern:
+  Enabled: true
+
 Lint/DuplicateRegexpCharacterClassElement:
   Enabled: true
 
@@ -173,12 +175,18 @@ Lint/UnreachableLoop:
 Lint/UselessMethodDefinition:
   Enabled: true
 
+Lint/UselessRescue:
+  Enabled: true
+
 Lint/UselessRuby2Keywords:
   Enabled: true
 
 Lint/UselessTimes:
   Enabled: true
 
+Metrics/CollectionLiteralLength:
+  Enabled: true
+
 Minitest/AssertInDelta:
   Enabled: true
 
@@ -200,6 +208,9 @@ Minitest/AssertRaisesCompoundBody:
 Minitest/AssertRaisesWithRegexpArgument:
   Enabled: true
 
+Minitest/AssertSame:
+  Enabled: true
+
 Minitest/AssertSilent:
   Enabled: true
 
@@ -215,6 +226,9 @@ Minitest/DuplicateTestRun:
 Minitest/EmptyLineBeforeAssertionMethods:
   Enabled: true
 
+Minitest/LifecycleHooksOrder:
+  Enabled: true
+
 Minitest/LiteralAsActualArgument:
   Enabled: true
 
@@ -222,6 +236,9 @@ Minitest/MultipleAssertions:
   Enabled: true
   Max: 5
 
+Minitest/NonPublicTestMethod:
+  Enabled: true
+
 Minitest/RefuteInDelta:
   Enabled: true
 
@@ -234,12 +251,21 @@ Minitest/RefutePathExists:
 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
 
@@ -249,6 +275,9 @@ Minitest/UnreachableAssertion:
 Minitest/UnspecifiedException:
   Enabled: true
 
+Minitest/UselessAssertion:
+  Enabled: true
+
 Naming/BlockForwarding:
   Enabled: true
 
@@ -282,9 +311,18 @@ Style/CollectionCompact:
 Style/CombinableLoops:
   Enabled: true
 
+Style/ComparableClamp:
+  Enabled: true
+
 Style/ConcatArrayLiterals:
   Enabled: true
 
+Style/DataInheritance:
+  Enabled: true
+
+Style/DirEmpty:
+  Enabled: true
+
 Style/DocumentDynamicEvalDefinition:
   Enabled: true
 
@@ -297,6 +335,9 @@ Style/EndlessMethod:
 Style/EnvHome:
   Enabled: true
 
+Style/ExactRegexpMatch:
+  Enabled: true
+
 Style/ExplicitBlockArgument:
   Enabled: true
 
@@ -306,6 +347,9 @@ Style/ExponentialNotation:
 Style/FetchEnvVar:
   Enabled: true
 
+Style/FileEmpty:
+  Enabled: true
+
 Style/FileRead:
   Enabled: true
 
@@ -396,6 +440,9 @@ Style/QuotedSymbols:
 Style/RedundantArgument:
   Enabled: true
 
+Style/RedundantArrayConstructor:
+  Enabled: true
+
 Style/RedundantAssignment:
   Enabled: true
 
@@ -414,12 +461,24 @@ Style/RedundantFetchBlock:
 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
 
@@ -450,6 +509,10 @@ Style/StringChars:
 Style/StringConcatenation:
   Enabled: true
 
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
 Style/SwapValues:
   Enabled: true
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruboclean (0.3.0)
+    ruboclean (0.4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -9,37 +9,39 @@ GEM
     ast (2.4.2)
     docile (1.4.0)
     json (2.6.3)
-    minitest (5.17.0)
-    parallel (1.22.1)
-    parser (3.2.0.0)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
+    regexp_parser (2.8.0)
     rexml (3.2.5)
-    rubocop (1.42.0)
+    rubocop (1.52.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.1)
-      parser (>= 3.1.1.0)
-    rubocop-minitest (0.25.1)
-      rubocop (>= 0.90, < 2.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.11.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.4.1)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby
@@ -54,4 +56,4 @@ DEPENDENCIES
   simplecov (< 0.18)
 
 BUNDLED WITH
-   2.4.2
+   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/bin/ruboclean

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

data/bin/test

@@ -20,7 +20,7 @@ class BinTest
       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/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

@@ -31,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
@@ -43,7 +44,25 @@ module Ruboclean
     end
 
     def load_yaml
-      YAML.safe_load(@rubocop_configuration_path.read, permitted_classes: PERMITTED_CLASSED)
+      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.3.0"
+  VERSION = "0.4.0"
 end

data/lib/ruboclean.rb

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
 
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruboclean
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - lxxxvi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-04 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
@@ -61,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Cleans and orders settings in .rubocop.yml