yalphabetize 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a68ee1b7cf8a1023f292bcc19606f1f1289bc582137c15e43cb3ad56174f96f1
-  data.tar.gz: 1246d3f96f00238273ef6251ccf9bbeda7316a861ff711f3be476fc94478e449
+  metadata.gz: b2b58ea00743bea3a0a4ca4ef92caa428ced099cdf28bf4caa37bf7214333ade
+  data.tar.gz: b8c5d394eaf0aef402e4cab38dd1018560950e36488fb60537f9fa48c201985b
 SHA512:
-  metadata.gz: '096bd5b4e436edccbf2fa86c48e1bc1551d0b516ca9fadda7ea8df14ac8db167b985762052701d3a12bcc03c72eb92badd1a6ed3c0d1b4baf5a3c3d0accdcf13'
-  data.tar.gz: 72b0be00b049d29fb7c322c421ed96f804f7db4f69090711d2fee32af5c0ca32ffeb8173ced531a6e9bcdd0a6b8409f9a0e47c15d15bcdf5ce04bfb1a4effbbd
+  metadata.gz: 54d23c05ae16c9eaa72b1f14a817618dbee8e116a0b24d46f08bbfc7ea009ad449e784f8ad07d24f159446deed6382bb7f403393ca45287d16ce740f3ec157b4
+  data.tar.gz: 731ca71c870831cd1d5b848f46a7d9e93c924d4e76304624762f7ff28c03e1d4eb4144e647ce059d3ce3315c3a48b29553d6e349f150be9777e6f2e4d41471af

data/lib/yalphabetize/file_yalphabetizer.rb

@@ -33,11 +33,11 @@ module Yalphabetize
     end
 
     def offences?
-      offence_detector_class.new(stream_node, order_checker_class: order_checker_class).offences?
+      offence_detector_class.new(stream_node, order_checker_class:).offences?
     end
 
     def alphabetize
-      alphabetizer_class.new(stream_node, order_checker_class: order_checker_class).call
+      alphabetizer_class.new(stream_node, order_checker_class:).call
     end
 
     def handle_aliases

data/lib/yalphabetize/logger.rb

@@ -30,13 +30,13 @@ module Yalphabetize
       output.puts send(list_offences_color, "Offences: #{offences.size}")
 
       offences.each { |file_path, status| puts_offence(file_path, status) }
-      return unless offences?
+      return unless uncorrected_offences?
 
       output.puts 'Offences can be automatically fixed with `-a` or `--autocorrect`'
     end
 
-    def offences?
-      @offences.any?
+    def uncorrected_offences?
+      offences.value?(:detected)
     end
 
     def log_correction(file_path)
@@ -58,7 +58,7 @@ module Yalphabetize
     end
 
     def list_offences_color
-      offences? ? :red : :green
+      offences.any? ? :red : :green
     end
 
     def red(string)

data/lib/yalphabetize/reader.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'psych'
+require 'psych/comments'
 
 module Yalphabetize
   class Reader
@@ -21,7 +22,7 @@ module Yalphabetize
     end
 
     def stream_node
-      @_stream_node ||= Psych.parse_stream file
+      @_stream_node ||= parser_class.parse_stream file
     rescue Psych::SyntaxError => e
       raise Yalphabetize::ParsingError.new(
         path,
@@ -32,5 +33,13 @@ module Yalphabetize
         e.context
       )
     end
+
+    def parser_class
+      if Yalphabetize.config['preserve_comments']
+        Psych::Comments
+      else
+        Psych
+      end
+    end
   end
 end

data/lib/yalphabetize/version.rb

@@ -2,6 +2,6 @@
 
 module Yalphabetize
   class Version
-    STRING = '0.8.0'
+    STRING = '0.10.0'
   end
 end

data/lib/yalphabetize/writer.rb

@@ -20,7 +20,11 @@ module Yalphabetize
     attr_reader :stream_node, :path
 
     def new_file_content
-      @_new_file_content ||= stream_node.to_yaml(nil, line_width: MAX_LINE_WIDTH)
+      @_new_file_content ||= if Yalphabetize.config['preserve_comments']
+                               Psych::Comments.emit_yaml stream_node
+                             else
+                               stream_node.to_yaml(nil, line_width: MAX_LINE_WIDTH)
+                             end
     end
 
     def indent_sequences

data/lib/yalphabetize/yalphabetizer.rb

@@ -32,13 +32,13 @@ module Yalphabetize
     def process_file(file_path)
       file_yalphabetizer_class.new(
         file_path,
-        reader_class: reader_class,
-        offence_detector_class: offence_detector_class,
-        logger: logger,
+        reader_class:,
+        offence_detector_class:,
+        logger:,
         autocorrect: options[:autocorrect],
-        alphabetizer_class: alphabetizer_class,
-        writer_class: writer_class,
-        order_checker_class: order_checker_class
+        alphabetizer_class:,
+        writer_class:,
+        order_checker_class:
       ).call
     end
 
@@ -56,7 +56,7 @@ module Yalphabetize
 
     def final_log
       logger.final_summary
-      logger.offences? ? 1 : 0
+      logger.uncorrected_offences? ? 1 : 0
     end
 
     def reader_class

data/lib/yalphabetize.rb

@@ -28,7 +28,8 @@ module Yalphabetize
       'indent_sequences' => true,
       'exclude' => [],
       'only' => [],
-      'sort_by' => 'ABab'
+      'sort_by' => 'ABab',
+      'preserve_comments' => true
     }.freeze
 
     def config

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yalphabetize
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Sam Jenkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
-dependencies: []
+date: 2024-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: psych-comments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: 
 executables:
@@ -44,7 +58,9 @@ homepage:
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message: |
+  yalphabetize 0.10.0 now supports YAML comments!
+  For more info: https://github.com/samrjenkins/yalphabetize?tab=readme-ov-file#preserve_comments
 rdoc_options: []
 require_paths:
 - lib
@@ -59,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Alphabetize your YAML files