ruboclean 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8356a24c5eef21d90f98b6a9d70e05c39eecca00bdad3cc44cf487f7f13d4d3f
-  data.tar.gz: 547493df65b231feec2b0e110beaca285a4c708726a60f25ce42da25c04297de
+  metadata.gz: be162ee85b381ec3596945c154e6a9596a3c1a38ca54932bc172e71bb750f006
+  data.tar.gz: ab675e274e9d0774bd654f73e4afc14d6bfbd6d54547685e7794830c2d4b99c5
 SHA512:
-  metadata.gz: 2a322034ef76aef728838a67c0400b6a869614765367347582b99a6a0e9d76ceb1c04ac7f93217d35702eb18b9c111958b059ee39716a8f5d2535f00a6e05e0b
-  data.tar.gz: 2b9895e2eba1124a33fd0808f2622a22e848cfe87ebede24cda7f17dfc7490e233db040342de84343d69f1dd57d430b8feaf5e9aa87d8961c8c3662624d3e583
+  metadata.gz: 3177f58dec5a6ea6318b9ba33dbe31e813060d43cff545c5d354d8998efb326b02d2d7b65c3b5850c1fdbfa8d8fe9e27020430e59df16f7c442fe81812e29e28
+  data.tar.gz: edc1388ea384c16dac65f59127f887267c560f6b3b4e65cef970304b3932b430d2974a747839cbf4da1665f380021297a4de0915ccf7fb412763785b19954668

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', '3.3', 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
 
@@ -101,12 +103,21 @@ Lint/IdentityComparison:
 Lint/IncompatibleIoSelectWithFiberScheduler:
   Enabled: true
 
+Lint/ItWithoutArgumentsInBlock:
+  Enabled: true
+
 Lint/LambdaWithoutLiteralBlock:
   Enabled: true
 
+Lint/LiteralAssignmentInCondition:
+  Enabled: true
+
 Lint/MissingSuper:
   Enabled: true
 
+Lint/MixedCaseRange:
+  Enabled: true
+
 Lint/MixedRegexpCaptureTypes:
   Enabled: true
 
@@ -131,6 +142,9 @@ Lint/RaiseException:
 Lint/RedundantDirGlobSort:
   Enabled: true
 
+Lint/RedundantRegexpQuantifiers:
+  Enabled: true
+
 Lint/RefinementImportMethods:
   Enabled: true
 
@@ -173,18 +187,27 @@ 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
 
 Minitest/AssertKindOf:
   Enabled: true
 
+Minitest/AssertOperator:
+  Enabled: true
+
 Minitest/AssertOutput:
   Enabled: true
 
@@ -200,6 +223,9 @@ Minitest/AssertRaisesCompoundBody:
 Minitest/AssertRaisesWithRegexpArgument:
   Enabled: true
 
+Minitest/AssertSame:
+  Enabled: true
+
 Minitest/AssertSilent:
   Enabled: true
 
@@ -215,6 +241,9 @@ Minitest/DuplicateTestRun:
 Minitest/EmptyLineBeforeAssertionMethods:
   Enabled: true
 
+Minitest/LifecycleHooksOrder:
+  Enabled: true
+
 Minitest/LiteralAsActualArgument:
   Enabled: true
 
@@ -222,24 +251,45 @@ Minitest/MultipleAssertions:
   Enabled: true
   Max: 5
 
+Minitest/NonExecutableTestMethod:
+  Enabled: true
+
+Minitest/NonPublicTestMethod:
+  Enabled: true
+
+Minitest/RedundantMessageArgument:
+  Enabled: true
+
 Minitest/RefuteInDelta:
   Enabled: true
 
 Minitest/RefuteKindOf:
   Enabled: true
 
+Minitest/RefuteOperator:
+  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
 
@@ -249,6 +299,9 @@ Minitest/UnreachableAssertion:
 Minitest/UnspecifiedException:
   Enabled: true
 
+Minitest/UselessAssertion:
+  Enabled: true
+
 Naming/BlockForwarding:
   Enabled: true
 
@@ -282,9 +335,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 +359,9 @@ Style/EndlessMethod:
 Style/EnvHome:
   Enabled: true
 
+Style/ExactRegexpMatch:
+  Enabled: true
+
 Style/ExplicitBlockArgument:
   Enabled: true
 
@@ -306,6 +371,9 @@ Style/ExponentialNotation:
 Style/FetchEnvVar:
   Enabled: true
 
+Style/FileEmpty:
+  Enabled: true
+
 Style/FileRead:
   Enabled: true
 
@@ -396,12 +464,18 @@ Style/QuotedSymbols:
 Style/RedundantArgument:
   Enabled: true
 
+Style/RedundantArrayConstructor:
+  Enabled: true
+
 Style/RedundantAssignment:
   Enabled: true
 
 Style/RedundantConstantBase:
   Enabled: true
 
+Style/RedundantCurrentDirectoryInPath:
+  Enabled: true
+
 Style/RedundantDoubleSplatHashBraces:
   Enabled: true
 
@@ -414,12 +488,27 @@ Style/RedundantFetchBlock:
 Style/RedundantFileExtensionInRequire:
   Enabled: true
 
+Style/RedundantFilterChain:
+  Enabled: true
+
+Style/RedundantHeredocDelimiterQuotes:
+  Enabled: true
+
 Style/RedundantInitialize:
   Enabled: true
 
+Style/RedundantLineContinuation:
+  Enabled: true
+
+Style/RedundantRegexpArgument:
+  Enabled: true
+
 Style/RedundantRegexpCharacterClass:
   Enabled: true
 
+Style/RedundantRegexpConstructor:
+  Enabled: true
+
 Style/RedundantRegexpEscape:
   Enabled: true
 
@@ -432,12 +521,18 @@ Style/RedundantSelfAssignmentBranch:
 Style/RedundantStringEscape:
   Enabled: true
 
+Style/ReturnNilInPredicateMethodDefinition:
+  Enabled: true
+
 Style/SelectByRegexp:
   Enabled: true
 
 Style/SingleArgumentDig:
   Enabled: true
 
+Style/SingleLineDoEndBlock:
+  Enabled: true
+
 Style/SlicingWithRange:
   Enabled: true
 
@@ -450,8 +545,18 @@ Style/StringChars:
 Style/StringConcatenation:
   Enabled: true
 
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/SuperWithArgsParentheses:
+  Enabled: true
+
 Style/SwapValues:
   Enabled: true
 
+Style/YAMLFileRead:
+  Enabled: true
+
 Style/YodaExpression:
   Enabled: true

data/Gemfile.lock

@@ -1,45 +1,50 @@
 PATH
   remote: .
   specs:
-    ruboclean (0.3.0)
+    ruboclean (0.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     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)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
+    parallel (1.24.0)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.6.1)
-    rexml (3.2.5)
-    rubocop (1.42.0)
+    rake (13.1.0)
+    regexp_parser (2.8.3)
+    rexml (3.2.6)
+    rubocop (1.59.0)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.2.4)
       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.30.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.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.34.2)
+      rubocop (>= 1.39, < 2.0)
+      rubocop-ast (>= 1.30.0, < 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.5.0)
 
 PLATFORMS
   ruby
@@ -54,4 +59,4 @@ DEPENDENCIES
   simplecov (< 0.18)
 
 BUNDLED WITH
-   2.4.2
+   2.4.13

data/README.md

@@ -28,10 +28,14 @@ Rails:
 
 AllCops:
   Exclude:
-  - bin/**/*
+  - path/file_exists.rb
+  - path_with_files/**/*
+  - path/file_does_not_exist.rb # This entry will be removed if the file doesn't exist. Skip with --preserve-paths option.
+  - path_without_files/**/* # Will be removed if no files within pattern exist. Skip with --preserve-paths option.
 
+# 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`:
@@ -44,7 +48,8 @@ require:
 
 AllCops:
   Exclude:
-  - bin/**/*
+  - path/file_exists.rb
+  - path_with_files/**/*
 
 Rails:
   Enabled: true
@@ -54,10 +59,8 @@ Layout/LineLength:
 
 Rails/ShortI18n:
   Enabled: true
-
 ```
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -78,27 +81,26 @@ Or install it yourself as:
 gem install ruboclean
 ```
 
-## Usage
+## Command synopsis
 
 ```shell
-ruboclean [path]
+ruboclean [path] [--silent] [--preserve-comments] [--preserve-paths]
 ```
 
-* `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.                |
+| `--preserve-paths`    | Skips the path cleanup that are applied against `Include:` and `Exclude:` configuration.                                              |
 
-```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 +114,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/cli_arguments.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Ruboclean
+  # Reads command line arguments and exposes corresponding reader methods
+  class CliArguments
+    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
+
+    def preserve_paths?
+      @preserve_paths ||= find_argument("--preserve-paths")
+    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

@@ -6,12 +6,12 @@ module Ruboclean
   #   - namespaces: every item which does **not** include an "/"
   #   - cops: every item which **includes** an "/"
   class Grouper
-    def initialize(config_hash)
-      @config_hash = config_hash
+    def initialize(configuration_hash)
+      @configuration_hash = configuration_hash
     end
 
     def group_config
-      @config_hash.each_with_object(empty_groups) do |item, result|
+      configuration_hash.each_with_object(empty_groups) do |item, result|
         key, value = item
         target_group = find_target_group(key)
         result[target_group].merge!({ key => value })
@@ -20,6 +20,8 @@ module Ruboclean
 
     private
 
+    attr_reader :configuration_hash
+
     def empty_groups
       { base: {}, namespaces: {}, cops: {} }
     end

data/lib/ruboclean/orderer.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require "ruboclean/grouper"
-
 module Ruboclean
   # Orders the items within the groups alphabetically
   class Orderer
-    def initialize(config_hash)
-      @config_hash = config_hash
+    def initialize(configuration_hash)
+      @configuration_hash = configuration_hash
     end
 
     def order
@@ -18,12 +16,14 @@ module Ruboclean
 
     private
 
-    def order_by_key(config_hash)
-      config_hash.sort_by(&:first).to_h
+    attr_reader :configuration_hash
+
+    def order_by_key(group_items)
+      group_items.sort_by(&:first).to_h
     end
 
     def grouped_config
-      Ruboclean::Grouper.new(@config_hash).group_config
+      Ruboclean::Grouper.new(configuration_hash).group_config
     end
   end
 end

data/lib/ruboclean/path_cleanup.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Ruboclean
+  # Cleans up any `Include` or `Exclude` paths that don't exist.
+  # The `Include` and `Exclude` paths are relative to the directory
+  # where the `.rubocop.yml` file is located. If a path includes a
+  # regexp, it's assumed to be valid.
+  # If all entries in `Include` or `Exclude` are removed, the entire property is removed.
+  # If a Cop gets entirely truncated due to removing all `Includes` and/or `Exclude`, the Cop itself will be removed.
+  class PathCleanup
+    def initialize(configuration_hash, root_directory)
+      @configuration_hash = configuration_hash
+      @root_directory = root_directory
+    end
+
+    def cleanup
+      configuration_hash.each_with_object({}) do |(top_level_key, top_level_value), hash|
+        result = process_top_level_value(top_level_value)
+
+        next if Array(result).empty? # No configuration keys left in the cop, remove the entire cop
+
+        hash[top_level_key] = result
+      end
+    end
+
+    private
+
+    attr_reader :configuration_hash, :root_directory
+
+    # top_level_value could be something like this:
+    #
+    # {
+    #   Include: [...],
+    #   Exclude: [...],
+    #   EnforcedStyle: "..."
+    # }
+    #
+    # We process it further in case of a Hash.
+    def process_top_level_value(top_level_value)
+      return top_level_value unless top_level_value.is_a?(Hash)
+
+      top_level_value.each_with_object({}) do |(cop_property_key, cop_property_value), hash|
+        result = process_cop_property(cop_property_key, cop_property_value)
+
+        next if Array(result).empty? # No entries left, will skip adding the key to the hash
+
+        hash[cop_property_key] = result
+      end
+    end
+
+    def process_cop_property(cop_property_key, cop_property_value)
+      return cop_property_value unless %w[Include Exclude].include?(cop_property_key.to_s)
+      return cop_property_value unless cop_property_value.respond_to?(:filter_map)
+
+      cop_property_value.find_all do |item|
+        path_exists?(item)
+      end
+    end
+
+    def path_exists?(item)
+      regexp_pattern?(item) ||
+        specific_path_exists?(item) ||
+        any_global_command_pattern?(item)
+    end
+
+    def specific_path_exists?(item)
+      root_directory.join(item).exist?
+    end
+
+    def any_global_command_pattern?(item)
+      root_directory.glob(item).any?
+    end
+
+    # We don't support Regexp, so we just say it exists.
+    def regexp_pattern?(item)
+      item.is_a?(Regexp)
+    end
+  end
+end

data/lib/ruboclean/runner.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "yaml"
+
+module Ruboclean
+  # Entry point for processing
+  class Runner
+    def initialize(args = [])
+      @cli_arguments = CliArguments.new(args)
+    end
+
+    def run!
+      return if source_file_pathname.empty?
+
+      load_file.then(&method(:order))
+               .then(&method(:cleanup_paths))
+               .then(&method(:convert_to_yaml))
+               .then(&method(:write_file!))
+    end
+
+    def verbose?
+      cli_arguments.verbose?
+    end
+
+    def path
+      cli_arguments.path
+    end
+
+    private
+
+    attr_reader :cli_arguments
+
+    def source_yaml
+      @source_yaml ||= source_file_pathname.read
+    end
+
+    def load_file
+      YAML.safe_load(source_yaml, permitted_classes: [Regexp])
+    end
+
+    def order(configuration_hash)
+      Orderer.new(configuration_hash).order
+    end
+
+    def cleanup_paths(configuration_hash)
+      return configuration_hash if cli_arguments.preserve_paths?
+
+      PathCleanup.new(configuration_hash, source_file_pathname.dirname).cleanup
+    end
+
+    def convert_to_yaml(configuration_hash)
+      ToYamlConverter.new(configuration_hash, cli_arguments.preserve_comments?, source_yaml).to_yaml
+    end
+
+    def write_file!(target_yaml)
+      source_file_pathname.write(target_yaml)
+    end
+
+    def source_file_pathname
+      @source_file_pathname ||= find_source_file_pathname
+    end
+
+    def find_source_file_pathname
+      source_path = Pathname.new(cli_arguments.path)
+
+      source_path = source_path.join(".rubocop.yml") if source_path.directory?
+
+      return source_path if source_path.exist?
+
+      raise ArgumentError, "path does not exist: '#{source_path}'"
+    end
+  end
+end

data/lib/ruboclean/to_yaml_converter.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Ruboclean
+  # Converts the configuration hash to YAML and applies modifications on it, if requested
+  class ToYamlConverter
+    def initialize(configuration_hash, preserve_comments, source_yaml)
+      @configuration_hash = configuration_hash
+      @preserve_comments = preserve_comments
+      @source_yaml = source_yaml
+    end
+
+    def to_yaml
+      target_yaml = sanitize_yaml(configuration_hash.transform_keys(&:to_s).to_yaml)
+
+      return target_yaml unless preserve_comments?
+
+      preserve_preceding_comments(source_yaml, target_yaml)
+    end
+
+    private
+
+    attr_reader :configuration_hash, :preserve_comments, :source_yaml
+
+    def preserve_comments?
+      preserve_comments
+    end
+
+    def sanitize_yaml(data)
+      data.gsub(/^([a-zA-Z]+)/, "\n\\1")
+    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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ruboclean
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/lib/ruboclean.rb

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
-require "ruboclean/version"
-require "ruboclean/rubocop_configuration"
-require "ruboclean/rubocop_configuration_path"
+require "ruboclean/cli_arguments"
 require "ruboclean/orderer"
+require "ruboclean/grouper"
+require "ruboclean/path_cleanup"
+require "ruboclean/runner"
+require "ruboclean/to_yaml_converter"
+require "ruboclean/version"
 
 # 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!(args)
+    runner = Runner.new(args)
+    print "Using path '#{runner.path}' ... " if runner.verbose?
+    runner.run!
+    puts "done." if runner.verbose?
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruboclean
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - lxxxvi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-04 00:00:00.000000000 Z
+date: 2024-02-11 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/cli_arguments.rb
 - lib/ruboclean/grouper.rb
 - lib/ruboclean/orderer.rb
-- lib/ruboclean/rubocop_configuration.rb
-- lib/ruboclean/rubocop_configuration_path.rb
+- lib/ruboclean/path_cleanup.rb
+- lib/ruboclean/runner.rb
+- lib/ruboclean/to_yaml_converter.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.5.3
 signing_key:
 specification_version: 4
 summary: Cleans and orders settings in .rubocop.yml

data/lib/ruboclean/rubocop_configuration.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Ruboclean
-  # Contains the config_hash representation of the `.rubocop.yml` file
-  class RubocopConfiguration
-    def initialize(config_hash)
-      @config_hash = config_hash
-    end
-
-    def order
-      Ruboclean::Orderer.new(@config_hash).order
-    end
-  end
-end

data/lib/ruboclean/rubocop_configuration_path.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-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)
-        super "path does not exist: '#{path}'"
-      end
-    end
-
-    def initialize(path)
-      input_path = Pathname.new(path)
-
-      @rubocop_configuration_path = if input_path.directory?
-                                      input_path.join(".rubocop.yml")
-                                    else
-                                      input_path
-                                    end
-
-      raise InvalidPathError, @rubocop_configuration_path unless @rubocop_configuration_path.exist?
-    end
-
-    def load
-      Ruboclean::RubocopConfiguration.new(load_yaml)
-    end
-
-    def write(rubocop_configuration)
-      output = sanitize_yaml(rubocop_configuration.to_yaml)
-      @rubocop_configuration_path.write(output)
-    end
-
-    private
-
-    def sanitize_yaml(data)
-      data.gsub(/^([a-zA-Z]+)/, "\n\\1")
-    end
-
-    def load_yaml
-      YAML.safe_load(@rubocop_configuration_path.read, permitted_classes: PERMITTED_CLASSED)
-    end
-  end
-end