ruboclean 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be162ee85b381ec3596945c154e6a9596a3c1a38ca54932bc172e71bb750f006
-  data.tar.gz: ab675e274e9d0774bd654f73e4afc14d6bfbd6d54547685e7794830c2d4b99c5
+  metadata.gz: eed645db36081518d593efb17c64f3c1566a978548a699d10aecf64893ad0f48
+  data.tar.gz: 62c988143427e15fa10e551cedb5965be6a81dd7afbba5ec40ef303ce6e6183c
 SHA512:
-  metadata.gz: 3177f58dec5a6ea6318b9ba33dbe31e813060d43cff545c5d354d8998efb326b02d2d7b65c3b5850c1fdbfa8d8fe9e27020430e59df16f7c442fe81812e29e28
-  data.tar.gz: edc1388ea384c16dac65f59127f887267c560f6b3b4e65cef970304b3932b430d2974a747839cbf4da1665f380021297a4de0915ccf7fb412763785b19954668
+  metadata.gz: 31f137822127611a4aa5b54df8e7d9222d96937438367ab73a3bdf588e1a854b36a2ba8ce617125ff955948046214ad63037b4ae8a4b5f571f979793c252b2c0
+  data.tar.gz: c939cd53f18fae460f56d76b6ed1c463b229795ac4518ef246ef12b4dd11135067c329276b5d1a9418aebdcf690c8088a4944ff5b338b314be01246dd0acd26e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruboclean (0.5.0)
+    ruboclean (0.6.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -84,7 +84,7 @@ gem install ruboclean
 ## Command synopsis
 
 ```shell
-ruboclean [path] [--silent] [--preserve-comments] [--preserve-paths]
+ruboclean [path] [--silent] [--preserve-comments] [--preserve-paths] [--verify]
 ```
 
 ### Parameters
@@ -95,6 +95,7 @@ ruboclean [path] [--silent] [--preserve-comments] [--preserve-paths]
 | `--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.                                              |
+| `--verify`            | Executes in dry-run mode. Exits with 1 if changes are needed, otherwise 0.                                                            |
 
 ### Examples
 

data/lib/ruboclean/cli_arguments.rb

@@ -27,6 +27,10 @@ module Ruboclean
       @preserve_paths ||= find_argument("--preserve-paths")
     end
 
+    def verify?
+      @verify ||= find_argument("--verify")
+    end
+
     private
 
     attr_reader :command_line_arguments

data/lib/ruboclean/logger.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Ruboclean
+  # Logger for clean management of log levels
+  class Logger
+    def initialize(log_level = :verbose)
+      raise ArgumentError, "Invalid log level" unless %i[verbose none].include?(log_level)
+
+      @log_level = log_level
+    end
+
+    def verbose(message)
+      case @log_level
+      when :verbose
+        print message
+      end
+    end
+  end
+end

data/lib/ruboclean/runner.rb

@@ -17,12 +17,21 @@ module Ruboclean
                .then(&method(:cleanup_paths))
                .then(&method(:convert_to_yaml))
                .then(&method(:write_file!))
+               .then(&method(:changed?))
+    end
+
+    def changed?(target_yaml)
+      target_yaml != source_yaml
     end
 
     def verbose?
       cli_arguments.verbose?
     end
 
+    def verify?
+      cli_arguments.verify?
+    end
+
     def path
       cli_arguments.path
     end
@@ -54,7 +63,9 @@ module Ruboclean
     end
 
     def write_file!(target_yaml)
-      source_file_pathname.write(target_yaml)
+      target_yaml.tap do |content|
+        source_file_pathname.write(content) unless verify?
+      end
     end
 
     def source_file_pathname

data/lib/ruboclean/version.rb

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

data/lib/ruboclean.rb

@@ -2,6 +2,7 @@
 
 require "ruboclean/cli_arguments"
 require "ruboclean/orderer"
+require "ruboclean/logger"
 require "ruboclean/grouper"
 require "ruboclean/path_cleanup"
 require "ruboclean/runner"
@@ -12,8 +13,25 @@ require "ruboclean/version"
 module Ruboclean
   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?
+    logger = Ruboclean::Logger.new(runner.verbose? ? :verbose : :none)
+
+    logger.verbose "Using path '#{runner.path}' ... "
+    changed = runner.run!
+    logger.verbose post_execution_message(changed, runner.verify?)
+
+    exit !changed if runner.verify?
+    exit 0
+  end
+
+  def self.post_execution_message(changed, verify)
+    if changed
+      if verify
+        "needs clean.\n"
+      else
+        "done.\n"
+      end
+    else
+      "already clean.\n"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruboclean
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - lxxxvi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-11 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies: []
 description: Cleans and orders settings in .rubocop.yml
 email:
@@ -34,6 +34,7 @@ files:
 - lib/ruboclean.rb
 - lib/ruboclean/cli_arguments.rb
 - lib/ruboclean/grouper.rb
+- lib/ruboclean/logger.rb
 - lib/ruboclean/orderer.rb
 - lib/ruboclean/path_cleanup.rb
 - lib/ruboclean/runner.rb