yaml-sort 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a923ba44e82aa9eba2dbaa2ba2c4c30a6c775a5a6d0e2f447ec6e0682dc119df
-  data.tar.gz: 637f1efc9b2104818816ce37a62385a149c657d079ad50a6cb8337a9c56a7eee
+  metadata.gz: bbee3a96fd3ecb9c7610a0621d80d796bb656a338512655175f213727af356c6
+  data.tar.gz: 1b1609202ae8cd7cc002c6a868d836ddfb89681d75efc4c5b996264d85d3392d
 SHA512:
-  metadata.gz: 04c75095cfe4fe25a42fdf0d0a4184a0324b1c64244ff3930d082e23f0efd393dbea5f4ea3f00f2364d48307ff37677b17348afa5f57ea367c525248ea3c4ecd
-  data.tar.gz: b6f2583c7170070daa6bd3dbc1067e280fc26c4bc88895158039a6e2ce5dc67177ef2210978bfbb332496a207070a61c4d2c56a5a4a2913ff6d9bf83f5d89293
+  metadata.gz: adbbda3bc7d506f276266b8d3f8bdf88c2032f2b80f64061fb965b25368e735996e7c164737ebebeed0c73fc5757669c7b099b362126f4a05dd37c33b7606d95
+  data.tar.gz: affae50f2aeff9ec3e96709f162a06a8cc1b7d2cbeb8ab1f1c8e98a10be3efe36642c9b69d57a1fd07a6c2b17ed09e74d5695f89b488fffca905b4bddfaebaf1

data/CHANGELOG.md

@@ -3,9 +3,34 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [2.0.0](https://github.com/smortex/yaml-sort/tree/2.0.0) (2022-04-25)
+## [v2.1.0](https://github.com/smortex/yaml-sort/tree/v2.1.0) (2022-07-03)
 
-[Full Changelog](https://github.com/smortex/yaml-sort/compare/v1.0.1...2.0.0)
+[Full Changelog](https://github.com/smortex/yaml-sort/compare/v2.0.2...v2.1.0)
+
+**Implemented enhancements:**
+
+- Make the Rake tasks silent [\#11](https://github.com/smortex/yaml-sort/pull/11) ([smortex](https://github.com/smortex))
+- Improve --lint by showing a diff on error [\#10](https://github.com/smortex/yaml-sort/pull/10) ([smortex](https://github.com/smortex))
+
+## [v2.0.2](https://github.com/smortex/yaml-sort/tree/v2.0.2) (2022-06-10)
+
+[Full Changelog](https://github.com/smortex/yaml-sort/compare/v2.0.1...v2.0.2)
+
+**Fixed bugs:**
+
+- Fix infinite loops when processing files with trailing whitespace [\#9](https://github.com/smortex/yaml-sort/pull/9) ([smortex](https://github.com/smortex))
+
+## [v2.0.1](https://github.com/smortex/yaml-sort/tree/v2.0.1) (2022-06-01)
+
+[Full Changelog](https://github.com/smortex/yaml-sort/compare/v2.0.0...v2.0.1)
+
+**Fixed bugs:**
+
+- Fix parsing of keys with spaces [\#8](https://github.com/smortex/yaml-sort/pull/8) ([smortex](https://github.com/smortex))
+
+## [v2.0.0](https://github.com/smortex/yaml-sort/tree/v2.0.0) (2022-04-25)
+
+[Full Changelog](https://github.com/smortex/yaml-sort/compare/v1.0.1...v2.0.0)
 
 **Merged pull requests:**
 

data/Rakefile

@@ -24,7 +24,7 @@ task cucumber: ["lib/yaml/sort/parser.rb"]
 
 require "github_changelog_generator/task"
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-  config.future_release = Yaml::Sort::VERSION
+  config.future_release = "v#{Yaml::Sort::VERSION}"
   config.header = <<~HEADER.chomp
     # Changelog
     All notable changes to this project will be documented in this file.

data/lib/yaml/sort/cli.rb

@@ -3,6 +3,7 @@
 require "optparse"
 
 require "cri"
+require "tempfile"
 
 module Yaml
   module Sort
@@ -25,7 +26,7 @@ module Yaml
           opts.on("-l", "--lint", "Ensure files content is sorted as expected") do
             options[:lint] = true
           end
-        end.parse!
+        end.parse!(argv)
 
         if !options[:in_place] && !options[:lint] && argv.count > 1
           warn "Sorting multiple YAML document to stdout does not make sense"
@@ -47,7 +48,7 @@ module Yaml
           end
         end
 
-        @exit_code
+        $kernel.exit(@exit_code) # rubocop:disable Style/GlobalVars
       end
 
       def process_document(filename, options)
@@ -78,13 +79,28 @@ module Yaml
           File.write(filename, sorted_yaml)
         elsif options[:lint]
           if yaml != sorted_yaml
-            warn "#{filename || "<stdin>"} is not sorted as expected"
+            show_diff(filename, yaml, sorted_yaml)
             @exit_code = 1
           end
         else
           puts sorted_yaml
         end
       end
+
+      def show_diff(filename, actual, expected)
+        filename ||= "<stdin>"
+
+        a = Tempfile.new
+        a.write(actual)
+        a.close
+
+        b = Tempfile.new
+        b.write(expected)
+        b.close
+
+        warn "diff #{File.join("a", filename)} #{File.join("b", filename)}"
+        warn `diff -u --label "#{File.join("a", filename)}" #{a.path} --label "#{File.join("b", filename)}" #{b.path}`
+      end
     end
   end
 end

data/lib/yaml/sort/parser.rb

@@ -30,43 +30,42 @@ def scan(text)
 
   until s.eos?
     if scan_value
-      unless s.match?(/[[:space:]]*\n/)
-        @position += s.matched_size if s.scan(/[[:blank:]]*/)
-        case
-        when s.scan(/[|>][-+]?(?=\n)/)
-          match = s.matched
-          
-          while s.match?("\n" + last_indent_value + " ")
-            match += s.scan(/\n[^\n]+(?=\n)/)
-          end
-          emit(:VALUE, match)
-        when s.scan(/"/)
-          match = s.matched
-          loop do
-            match += s.scan_until(/"|\\/)
-            if match[-1] == "\\"
-              match += s.scan(/.|\n/)
-            else
-              break
-            end
-          end
-          emit(:VALUE, match)
-        when s.scan(/'/)
-          match = s.matched
-          loop do
-            match += s.scan_until(/'/)
-            break unless s.match?(/'/)
-            match += s.scan(/'/)
-          end
-          emit(:VALUE, match)
-        when s.scan(/\S+/)
-          match = s.matched
-          until s.match?(/[\n]/) || s.eos?
-            match += s.scan(/[^\n]+/)
+      @position += s.matched_size if s.scan(/[[:blank:]]*/)
+      case
+      when s.scan(/[|>][-+]?(?=\n)/)
+        match = s.matched
+
+        while s.match?("\n" + last_indent_value + " ")
+          match += s.scan(/\n[^\n]+(?=\n)/)
+        end
+        emit(:VALUE, match)
+      when s.scan(/"/)
+        match = s.matched
+        loop do
+          match += s.scan_until(/"|\\/)
+          if match[-1] == "\\"
+            match += s.scan(/.|\n/)
+          else
+            break
           end
-          emit(:VALUE, match)
         end
+        emit(:VALUE, match)
+      when s.scan(/'/)
+        match = s.matched
+        loop do
+          match += s.scan_until(/'/)
+          break unless s.match?(/'/)
+          match += s.scan(/'/)
+        end
+        emit(:VALUE, match)
+      when s.scan(/\S+/)
+        match = s.matched
+        until s.match?(/[\n]/) || s.eos?
+          match += s.scan(/[^\n]+/)
+        end
+        emit(:VALUE, match)
       end
+      s.scan(/[[:blank:]]*/)
       scan_value = false
     else
       case
@@ -78,7 +77,7 @@ def scan(text)
       when s.scan(/\n[[:blank:]]*#.*/)      then emit(:COMMENT, s.matched)
       when s.scan(/\n([[:blank:]]*-) */)    then emit(:ITEM, s.matched, indent: s.captures[0])
       when s.scan(/\n[[:blank:]]*\.\.\./)   then emit(:END_OF_DOCUMENT, s.matched)
-      when s.scan(/\n?([[:blank:]]*)([^[[:space:]]\n]+:)(?=[ \n])/)
+      when s.scan(/\n?([[:blank:]]*)(.+:)(?=[ \n])/)
         indent = s.captures[0]
         indent = last_indent_value + indent + " " unless s.matched.start_with?("\n")
         emit(:KEY, s.matched, indent: indent, value: s.captures[1])
@@ -88,7 +87,20 @@ def scan(text)
       when s.match?(/./)
         scan_value = true
       else
-        raise "LoST: #{s.rest.inspect} #{s.eos?}"
+        message = if @lines[@lineno - 1][@position] == "\n"
+                  <<~MESSAGE
+                    #{@filename}:#{@lineno + 1}: unexpected content
+                    #{@lines[@lineno].chomp}
+                    ^#{"~" * (@lines[@lineno].chomp.length - 1)}
+                    MESSAGE
+                  else
+                  <<~MESSAGE
+                    #{@filename}:#{@lineno}: unexpected content
+                    #{@lines[@lineno - 1].chomp}
+                    #{" " * @position}^
+                    MESSAGE
+                  end
+        raise(Racc::ParseError, message)
       end
     end
   end

data/lib/yaml/sort/tasks/puppet.rb

@@ -3,11 +3,11 @@
 namespace :lint do
   desc "Check Hiera data content ordering"
   task :hiera_data_ordering do
-    sh "yaml-sort", "--lint", *Dir.glob("data/**/*.yaml")
+    sh "yaml-sort", "--lint", *Dir.glob("data/**/*.yaml"), verbose: false
   end
 end
 
 desc "Reorder Hiera data in-place"
 task :reorder_hiera_data do
-  sh "yaml-sort", "--in-place", *Dir.glob("data/**/*.yaml")
+  sh "yaml-sort", "--in-place", *Dir.glob("data/**/*.yaml"), verbose: false
 end

data/lib/yaml/sort/tasks/rails.rb

@@ -3,11 +3,11 @@
 namespace :test do
   desc "Check translations content ordering"
   task :translations_ordering do
-    sh "yaml-sort", "--lint", *Dir.glob("config/locales/**/*.yml")
+    sh "yaml-sort", "--lint", *Dir.glob("config/locales/**/*.yml"), verbose: false
   end
 end
 
 desc "Reorder translations in-place"
 task :reorder_translations do
-  sh "yaml-sort", "--in-place", *Dir.glob("config/locales/**/*.yml")
+  sh "yaml-sort", "--in-place", *Dir.glob("config/locales/**/*.yml"), verbose: false
 end

data/lib/yaml/sort/version.rb

@@ -2,6 +2,6 @@
 
 module Yaml
   module Sort
-    VERSION = "2.0.0"
+    VERSION = "2.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml-sort
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Romain Tartière
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-25 00:00:00.000000000 Z
+date: 2022-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cri
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.10
+rubygems_version: 3.3.16
 signing_key:
 specification_version: 4
 summary: Sort lines in YAML files in a predictable order