yaml-sort 2.1.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 813b1d18ae4a2cb6b57ebde8dc720c06ff9125417ab245d6cc15e22467e8f5ef
-  data.tar.gz: 5d334e4fd7ab15319c225e549a1e7e38319f62a3ecec62a855b40c8e00cba036
+  metadata.gz: 71ee5e9950197312df22f8cb27e87dd7fe223f8c320969edcb7130c2c9548ed5
+  data.tar.gz: ca1948fa942e772f7ed9caade6b91683c92f7c20b685f24e508d4f669826ebef
 SHA512:
-  metadata.gz: 84b534524792c4218449a7724e1673d09058afb2b2c838001e2092e144d8caaeadf51ea5cf415d52a6f5b1ca284ac3977785871344e317d0c61a0414b715d2d8
-  data.tar.gz: 211409b7ade1b5cace67a86ea71a3fe952398a03165a099a201760ad47e3a01a2da99e7ecd359bc80f63d988396b63afc7a42141899f7ef316ac1dd0aa2c1e5a
+  metadata.gz: 37f4ae4497b011da8e928f5d7c9ba315105e80a5de50f4052320fb7409de469a45a51c92d143bac5061706e7e5e3bcfb422a461ffcfa0ab4b2f1d2df7309c39c
+  data.tar.gz: 4ba38b243d77ea33aa89c933eea5a3b98e2d7bed158d664d8f1020636c609e99d48c10cf462ec5e7db822ff73f3abf4f20693fc4ac0ea7585ae3ee343a316644

data/.simplecov

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# vim:set syntax=ruby:
+
+SimpleCov.start do
+  add_filter "/spec/"
+end

data/CHANGELOG.md

@@ -3,6 +3,30 @@ 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).
 
+## [v2.2.1](https://github.com/smortex/yaml-sort/tree/v2.2.1) (2023-01-04)
+
+[Full Changelog](https://github.com/smortex/yaml-sort/compare/v2.2.0...v2.2.1)
+
+**Fixed bugs:**
+
+- Fix parsing of dictionaries with quotes in KEY/VALUE [\#21](https://github.com/smortex/yaml-sort/pull/21) ([smortex](https://github.com/smortex))
+
+## [v2.2.0](https://github.com/smortex/yaml-sort/tree/v2.2.0) (2022-09-27)
+
+[Full Changelog](https://github.com/smortex/yaml-sort/compare/v2.1.1...v2.2.0)
+
+**Implemented enhancements:**
+
+- Add support for &anchor / \*alias [\#17](https://github.com/smortex/yaml-sort/pull/17) ([smortex](https://github.com/smortex))
+
+**Fixed bugs:**
+
+- Fix relocation of comments following UNINDENT [\#18](https://github.com/smortex/yaml-sort/pull/18) ([smortex](https://github.com/smortex))
+
+**Merged pull requests:**
+
+- Add CodeClimate integration [\#15](https://github.com/smortex/yaml-sort/pull/15) ([smortex](https://github.com/smortex))
+
 ## [v2.1.1](https://github.com/smortex/yaml-sort/tree/v2.1.1) (2022-07-03)
 
 [Full Changelog](https://github.com/smortex/yaml-sort/compare/v2.1.0...v2.1.1)

data/Gemfile

@@ -12,3 +12,4 @@ gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"
 gem "rubocop-rake"
 gem "rubocop-rspec"
+gem "simplecov"

data/README.md

@@ -1,5 +1,9 @@
 # yaml-sort
 
+[![CI](https://github.com/smortex/yaml-sort/actions/workflows/ci.yaml/badge.svg)](https://github.com/smortex/yaml-sort/actions/workflows/ci.yaml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/4df28a3babe44d1a83c0/maintainability)](https://codeclimate.com/github/smortex/yaml-sort/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/4df28a3babe44d1a83c0/test_coverage)](https://codeclimate.com/github/smortex/yaml-sort/test_coverage)
+
 An utility to manage YAML files and ensure their lines is in a predictable order.
 
 This is mainly indended to manage [Hiera files](https://puppet.com/docs/puppet/7/hiera_intro.html) for [Puppet](https://puppet.com/) and translation files in [Ruby on Rails](https://rubyonrails.org/) applications.

data/Rakefile

@@ -13,7 +13,7 @@ require "cucumber/rake/task"
 
 Cucumber::Rake::Task.new
 
-task default: %i[rubocop spec cucumber]
+task default: %i[spec cucumber]
 
 file "lib/yaml/sort/parser.rb": ["lib/yaml/sort/parser.ra"] do
   sh "racc --output-status --output-file=lib/yaml/sort/parser.rb lib/yaml/sort/parser.ra"

data/lib/yaml/sort/alias.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Yaml
+  module Sort
+    class Alias < Value
+      attr_reader :name
+
+      def initialize(anchors, name)
+        super()
+        @anchors = anchors
+        @name = name[:value]
+      end
+
+      def value?
+        @anchors[@name]
+      end
+
+      def delete_value
+        @anchors.delete(@name)
+      end
+
+      def to_s(*)
+        if (s = @anchors.delete(@name))
+          separator = case s
+                      when List, Dictionary then "\n"
+                      else " "
+                      end
+          "&#{name}#{separator}#{s}"
+        else
+          "*#{name}"
+        end
+      end
+
+      def <=>(_other)
+        0
+      end
+    end
+  end
+end

data/lib/yaml/sort/dictionary.rb

@@ -25,10 +25,9 @@ module Yaml
         super + items.map do |k, v|
           n += 1
           case v
-          when List, Dictionary
-            "#{k.to_s(skip_first_indent: skip_first_indent && n.zero?)}\n#{v}"
-          when Scalar
-            "#{k.to_s(skip_first_indent: skip_first_indent && n.zero?)} #{v}"
+          when List, Dictionary then "#{k.to_s(skip_first_indent: skip_first_indent && n.zero?)}\n#{v}"
+          when Scalar, Alias    then "#{k.to_s(skip_first_indent: skip_first_indent && n.zero?)} #{v}"
+          else raise "Unexpected type"
           end
         end.join("\n")
       end

data/lib/yaml/sort/parser.rb

@@ -13,7 +13,7 @@ module Yaml
   module Sort
     class Parser < Racc::Parser
 
-module_eval(<<'...end parser.ra/module_eval...', 'parser.ra', 33)
+module_eval(<<'...end parser.ra/module_eval...', 'parser.ra', 36)
 
 def scan(text)
   text = "---\n#{text}" unless text.start_with?("---\n")
@@ -27,11 +27,16 @@ def scan(text)
   @fakelineno = 0
   @position = 0
   @indent_stack = []
+  @anchors = {}
 
   until s.eos?
     if scan_value
       @position += s.matched_size if s.scan(/[[:blank:]]*/)
       case
+      when s.scan(/&[[:alnum:]]+/)
+        emit(:ANCHOR, s.matched[1..-1])
+      when s.scan(/\*[[:alnum:]]+/)
+        emit(:ALIAS, s.matched[1..-1])
       when s.scan(/[|>][-+]?(?=\n)/)
         match = s.matched
 
@@ -77,10 +82,11 @@ 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:]]*)(.+:)(?=[ \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])
+        scan_value = true if s.rest
 
       when s.scan(/\n\z/)
         # Done
@@ -111,7 +117,7 @@ def scan(text)
   @tokens.each do |token|
     if token[0] == :COMMENT
       comment << token[1][:value] + "\n"
-    elsif comment.any?
+    elsif comment.any? && token[0] != :UNINDENT
       token[1][:comment] = comment
       comment = []
     end
@@ -141,8 +147,19 @@ def emit(token, match, length: nil, indent: nil, value: nil)
     @indent_stack.push(indent) unless @indent_stack.last == indent
   end
 
+  value ||= match
+
+  if token == :KEY && value == '<<:'
+    message = <<~MESSAGE
+      #{@filename}:#{@lineno}: '<<:' references are not sortable:
+      #{@lines[@lineno - 1].chomp}
+      #{indent}#{" " * @position}^#{"~" * (length - indent.length - 1)}
+    MESSAGE
+    raise(Racc::ParseError, message)
+  end
+
   exvalue = {
-    value: value || match,
+    value: value,
     lineno: @lineno,
     position: @position,
     length: length,
@@ -193,50 +210,61 @@ end
 ##### State transition tables begin ###
 
 racc_action_table = [
-     5,     9,     2,    11,     5,     9,     3,    11,     5,     9,
-    12,    11,     9,    14,    16,    11,    13 ]
+     5,    10,     2,    12,     3,     8,     5,    10,    13,    12,
+    19,     8,     5,    10,    14,    12,    21,     8,     5,    10,
+   nil,    12,   nil,     8,     5,    10,   nil,    12,   nil,     8,
+    10,    15,    17,    12 ]
 
 racc_action_check = [
-     2,     2,     0,     2,     9,     9,     1,     9,    11,    11,
-     3,    11,     6,     6,     7,     7,     4 ]
+     2,     2,     0,     2,     1,     2,    10,    10,     3,    10,
+    10,    10,    12,    12,     4,    12,    12,    12,    19,    19,
+   nil,    19,   nil,    19,    21,    21,   nil,    21,   nil,    21,
+     6,     6,     7,     7 ]
 
 racc_action_pointer = [
-     0,     6,    -4,    10,    13,   nil,     7,     8,   nil,     0,
-   nil,     4,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil ]
+     0,     4,    -4,     8,    11,   nil,    25,    26,   nil,   nil,
+     2,   nil,     8,   nil,   nil,   nil,   nil,   nil,   nil,    14,
+   nil,    20,   nil,   nil,   nil ]
 
 racc_action_default = [
-   -12,   -12,   -12,   -12,    -2,    -3,   -12,   -12,    -7,   -12,
-   -10,   -12,    20,    -1,    -4,    -6,    -5,    -9,    -8,   -11 ]
+   -15,   -15,   -15,   -15,    -2,    -3,   -15,   -15,    -6,    -8,
+   -15,   -12,   -15,    25,    -1,    -4,    -7,    -5,   -11,   -15,
+   -10,   -15,   -14,    -9,   -13 ]
 
 racc_goto_table = [
-     4,     1,    15,    17,   nil,   nil,   nil,    18,   nil,    19 ]
+     4,     1,    16,    18,   nil,   nil,   nil,   nil,    20,   nil,
+    22,   nil,   nil,   nil,   nil,   nil,   nil,    23,   nil,    24 ]
 
 racc_goto_check = [
-     2,     1,     5,     6,   nil,   nil,   nil,     2,   nil,     2 ]
+     2,     1,     5,     6,   nil,   nil,   nil,   nil,     2,   nil,
+     2,   nil,   nil,   nil,   nil,   nil,   nil,     2,   nil,     2 ]
 
 racc_goto_pointer = [
    nil,     1,    -2,   nil,   nil,    -4,    -4 ]
 
 racc_goto_default = [
-   nil,   nil,   nil,     6,     7,     8,    10 ]
+   nil,   nil,   nil,     6,     7,     9,    11 ]
 
 racc_reduce_table = [
   0, 0, :racc_error,
-  3, 9, :_reduce_1,
-  2, 9, :_reduce_2,
-  1, 10, :_reduce_3,
-  2, 10, :_reduce_4,
-  2, 10, :_reduce_5,
-  2, 11, :_reduce_6,
-  1, 11, :_reduce_7,
-  2, 13, :_reduce_8,
-  2, 12, :_reduce_9,
-  1, 12, :_reduce_10,
-  2, 14, :_reduce_11 ]
-
-racc_reduce_n = 12
-
-racc_shift_n = 20
+  3, 11, :_reduce_1,
+  2, 11, :_reduce_2,
+  1, 12, :_reduce_3,
+  2, 12, :_reduce_4,
+  2, 12, :_reduce_5,
+  1, 12, :_reduce_6,
+  2, 13, :_reduce_7,
+  1, 13, :_reduce_8,
+  3, 15, :_reduce_9,
+  2, 15, :_reduce_10,
+  2, 14, :_reduce_11,
+  1, 14, :_reduce_12,
+  3, 16, :_reduce_13,
+  2, 16, :_reduce_14 ]
+
+racc_reduce_n = 15
+
+racc_shift_n = 25
 
 racc_token_table = {
   false => 0,
@@ -246,9 +274,11 @@ racc_token_table = {
   :VALUE => 4,
   :KEY => 5,
   :UNINDENT => 6,
-  :ITEM => 7 }
+  :ITEM => 7,
+  :ANCHOR => 8,
+  :ALIAS => 9 }
 
-racc_nt_base = 8
+racc_nt_base = 10
 
 racc_use_result_var = true
 
@@ -277,6 +307,8 @@ Racc_token_to_s_table = [
   "KEY",
   "UNINDENT",
   "ITEM",
+  "ANCHOR",
+  "ALIAS",
   "$start",
   "document",
   "value",
@@ -326,43 +358,64 @@ module_eval(<<'.,.,', 'parser.ra', 14)
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.ra', 16)
+module_eval(<<'.,.,', 'parser.ra', 15)
   def _reduce_6(val, _values, result)
-     val[0].add_item(*val[1]); result = val[0]
+     result = Alias.new(@anchors, val[0])
     result
   end
 .,.,
 
 module_eval(<<'.,.,', 'parser.ra', 17)
   def _reduce_7(val, _values, result)
-     result = Dictionary.create(*val[0])
+     val[0].add_item(*val[1]); result = val[0]
     result
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.ra', 19)
+module_eval(<<'.,.,', 'parser.ra', 18)
   def _reduce_8(val, _values, result)
-     result = [Scalar.new(val[0]), val[1]]
+     result = Dictionary.create(*val[0])
     result
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.ra', 21)
+module_eval(<<'.,.,', 'parser.ra', 20)
   def _reduce_9(val, _values, result)
-     val[0].add_item(*val[1]); result = val[0]
+     @anchors[val[1][:value]] = val[2]; result = [Scalar.new(val[0]), Alias.new(@anchors, val[1])]
     result
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.ra', 22)
+module_eval(<<'.,.,', 'parser.ra', 21)
   def _reduce_10(val, _values, result)
-     result = List.create(*val[0])
+     result = [Scalar.new(val[0]), val[1]]
     result
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.ra', 24)
+module_eval(<<'.,.,', 'parser.ra', 23)
   def _reduce_11(val, _values, result)
+     val[0].add_item(*val[1]); result = val[0]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.ra', 24)
+  def _reduce_12(val, _values, result)
+     result = List.create(*val[0])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.ra', 26)
+  def _reduce_13(val, _values, result)
+     @anchors[val[1][:value]] = val[2]; result = [Item.new(val[0]),  Alias.new(@anchors, val[1])]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.ra', 27)
+  def _reduce_14(val, _values, result)
      result = [Item.new(val[0]), val[1]]
     result
   end

data/lib/yaml/sort/version.rb

@@ -2,6 +2,6 @@
 
 module Yaml
   module Sort
-    VERSION = "2.1.1"
+    VERSION = "2.2.1"
   end
 end

data/lib/yaml/sort.rb

@@ -2,6 +2,7 @@
 
 require_relative "sort/parser"
 require_relative "sort/value"
+require_relative "sort/alias"
 require_relative "sort/dictionary"
 require_relative "sort/item"
 require_relative "sort/list"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml-sort
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.1
 platform: ruby
 authors:
 - Romain Tartière
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-03 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cri
@@ -76,6 +76,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".simplecov"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -84,6 +85,7 @@ files:
 - Rakefile
 - exe/yaml-sort
 - lib/yaml/sort.rb
+- lib/yaml/sort/alias.rb
 - lib/yaml/sort/cli.rb
 - lib/yaml/sort/dictionary.rb
 - lib/yaml/sort/item.rb
@@ -119,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.16
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Sort lines in YAML files in a predictable order