yaml-sort 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b17a9fdbfc9612b6b2bb1a75583e9a31c269fbba87c088afc0fc6ffe16e44aa1
-  data.tar.gz: edde89f395f92d321c95e4899c6744bba2b005b93aa4399c00d090c4511a27ac
+  metadata.gz: e8eee6a8ad9b5761ffc9e9ef08f6025c66e3c661acfef15f197b3d28f67e3253
+  data.tar.gz: 108d4ea68106e308eafbe6bce7cd372556ebde65010ade2b1b742e82f43f29d5
 SHA512:
-  metadata.gz: a3a763b77216fad635aec8707d388d1bc1c8afb1ccd2217922b17c6179bc59d6c1998459c3e131375d1fed6e743d94d2d39dc2f080bd4adf45b42a73aff56b94
-  data.tar.gz: 11573f243771dcd0ec7c52748a9927c358472860e0a52e287f8764c960e539aa76b6df6ee6f2fff724eb9f5e780c2b62d7921b65b1d0f9aaf696d388e618b6f4
+  metadata.gz: 234b85bdf4dd61f2bfa5a8568c59979ad12c374af47daed35d0a7248b0e1b8f96aed17bc77ba17ca2d8a7233d55803c9d6c5a4fcfa962394d6183ff61a3e9e21
+  data.tar.gz: 525ca02351c0f79d86a6e367341b4c8750b294400ffd96a7d4ad00dfced59de0e16060b29a5ceb0b0dcb40d95db9f8d1f1b8fcaabbfb1dfb6c3a58fa470ad27d

data/CHANGELOG.md

@@ -1,5 +1,34 @@
-## [Unreleased]
+# Changelog
+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).
 
-## [0.1.0] - 2022-04-09
+## [2.0.1](https://github.com/smortex/yaml-sort/tree/2.0.1) (2022-06-01)
 
-- Initial release
+[Full Changelog](https://github.com/smortex/yaml-sort/compare/v2.0.0...2.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:**
+
+- Rework list sorting [\#7](https://github.com/smortex/yaml-sort/pull/7) ([smortex](https://github.com/smortex))
+
+## [v1.0.1](https://github.com/smortex/yaml-sort/tree/v1.0.1) (2022-04-24)
+
+[Full Changelog](https://github.com/smortex/yaml-sort/compare/v1.0.0...v1.0.1)
+
+**Fixed bugs:**
+
+- Fix processing of some YAML files without a `START_OF_DOCUMENT` [\#6](https://github.com/smortex/yaml-sort/pull/6) ([smortex](https://github.com/smortex))
+- Fix error reporting [\#5](https://github.com/smortex/yaml-sort/pull/5) ([smortex](https://github.com/smortex))
+- Fix display of filename on parse errors [\#1](https://github.com/smortex/yaml-sort/pull/1) ([smortex](https://github.com/smortex))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Rakefile

@@ -21,3 +21,19 @@ end
 
 task spec: ["lib/yaml/sort/parser.rb"]
 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.header = <<~HEADER.chomp
+    # Changelog
+    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).
+  HEADER
+  config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog ignore]
+  config.user = "smortex"
+  config.project = "yaml-sort"
+  config.since_tag = "v1.0.0"
+  config.issues = false
+end

data/lib/yaml/sort/cli.rb

@@ -52,8 +52,11 @@ module Yaml
 
       def process_document(filename, options)
         yaml = read_document(filename)
-        sorted_yaml = sort_yaml(yaml)
+        sorted_yaml = sort_yaml(yaml, filename)
         write_output(yaml, sorted_yaml, filename, options)
+      rescue Racc::ParseError => e
+        warn(e.message)
+        @exit_code = 1
       end
 
       def read_document(filename)
@@ -64,8 +67,8 @@ module Yaml
         end
       end
 
-      def sort_yaml(yaml)
-        document = @parser.parse(yaml)
+      def sort_yaml(yaml, filename)
+        document = @parser.parse(yaml, filename: filename)
         document = document.sort
         "---\n#{document}\n"
       end

data/lib/yaml/sort/dictionary.rb

@@ -20,13 +20,15 @@ module Yaml
         dict
       end
 
-      def to_s
+      def to_s(skip_first_indent: false)
+        n = -1
         super + items.map do |k, v|
+          n += 1
           case v
           when List, Dictionary
-            "#{k}\n#{v}"
+            "#{k.to_s(skip_first_indent: skip_first_indent && n.zero?)}\n#{v}"
           when Scalar
-            "#{k} #{v}"
+            "#{k.to_s(skip_first_indent: skip_first_indent && n.zero?)} #{v}"
           end
         end.join("\n")
       end

data/lib/yaml/sort/item.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "scalar"
+
+module Yaml
+  module Sort
+    class Item < Scalar
+      def to_s(*)
+        comments + value
+      end
+    end
+  end
+end

data/lib/yaml/sort/list.rb

@@ -22,15 +22,13 @@ module Yaml
 
       def to_s
         super + items.map do |item|
-          "#{item[0]}#{item[1]}"
+          "#{item[0]}#{item[1].to_s(skip_first_indent: true)}"
         end.join("\n")
       end
 
       def sort
-        List.new(items.sort { |a, b| a[1] <=> b[1] })
-      rescue ArgumentError
-        # Non-comparable items
-        self
+        # TODO: Add an option to sort scalar values
+        List.new(items.map { |i| [i[0], i[1].sort] })
       end
     end
   end

data/lib/yaml/sort/parser.rb

@@ -13,9 +13,11 @@ module Yaml
   module Sort
     class Parser < Racc::Parser
 
-module_eval(<<'...end parser.ra/module_eval...', 'parser.ra', 34)
+module_eval(<<'...end parser.ra/module_eval...', 'parser.ra', 33)
 
 def scan(text)
+  text = "---\n#{text}" unless text.start_with?("---\n")
+
   scan_value = false
 
   @lines = text.lines
@@ -29,7 +31,7 @@ def scan(text)
   until s.eos?
     if scan_value
       unless s.match?(/[[:space:]]*\n/)
-        @position += s.matched_size if s.scan(/\s*/)
+        @position += s.matched_size if s.scan(/[[:blank:]]*/)
         case
         when s.scan(/[|>][-+]?(?=\n)/)
           match = s.matched
@@ -68,25 +70,41 @@ def scan(text)
       scan_value = false
     else
       case
-      when s.scan(/---/)              then emit(:START_OF_DOCUMENT, s.matched)
-      when s.scan(/(\n\s*)+(?=\n)/)   then # Ignore empty lines
-      when s.scan(/\n?\s*#.*/)        then emit(:COMMENT, s.matched)
-      when s.scan(/\n?(\s*-) */)      then emit("-", s.matched, indent: s.captures[0])
-      when s.scan(/\n?\s*\.\.\./)     then emit(:END_OF_DOCUMENT, s.matched)
-      when s.scan(/\n?(\s*)([^[[:space:]]\n]+):(?=[ \n])/)
+      when s.scan(/---/)                    then emit(:START_OF_DOCUMENT, s.matched)
+      when s.scan(/\n[[:blank:]]*(?=\n)/)
+        # Ignore empty lines
+        @lineno += 1
+        @position = 0
+      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])/)
         indent = s.captures[0]
         indent = last_indent_value + indent + " " unless s.matched.start_with?("\n")
-        emit(:KEY, s.matched, indent: indent)
+        emit(:KEY, s.matched, indent: indent, value: s.captures[1])
 
       when s.scan(/\n\z/)
         # Done
-     when s.match?(/./)
-       scan_value = true
+      when s.match?(/./)
+        scan_value = true
       else
-        raise "LoST: #{s.rest.inspect} #{s.eos?}"
-      end
-    end
-  end
+				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
 
   unindent
 
@@ -105,16 +123,16 @@ def scan(text)
   @tokens
 end
 
-def emit(token, value, length: nil, indent: nil)
+def emit(token, match, length: nil, indent: nil, value: nil)
   indent.gsub!("-", " ") if indent
   if token && length.nil?
-    raise "length must be explicitly passed when value is not a String (#{value.class.name})" unless value.is_a?(String)
-    length = value.length
+    raise "length must be explicitly passed when match is not a String (#{match.class.name})" unless match.is_a?(String)
+    length = match.length
   end
 
-  if value.start_with?("\n")
+  if match.start_with?("\n")
     @lineno += 1
-    value = value[1..-1]
+    match = match[1..-1]
     length -= 1
     @position = 0
   end
@@ -125,16 +143,15 @@ def emit(token, value, length: nil, indent: nil)
   end
 
   exvalue = {
-    value: value,
+    value: value || match,
     lineno: @lineno,
     position: @position,
-    filename: @filename,
     length: length,
     indent: indent,
   }
   @tokens << [token, exvalue]
 
-  @lineno += value.count("\n")
+  @lineno += match.count("\n")
 
   @position += length
 end
@@ -146,7 +163,7 @@ end
 def unindent(new_indent = nil)
   while @indent_stack.count > 0 && (new_indent.nil? || @indent_stack.last.length > new_indent.length)
     value = @indent_stack.pop
-    @tokens << [:UNINDENT, { value: value, lineno: @lineno, position: 0, filename: @filename, length: value.length, indent: nil }]
+    @tokens << [:UNINDENT, { value: value, lineno: @lineno, position: 0, length: value.length, indent: nil }]
   end
 end
 
@@ -154,73 +171,73 @@ def next_token
   @current_token = @tokens.shift
 end
 
-def parse(text)
+def parse(text, filename: nil)
+  @filename = filename || "<stdin>"
   scan(text)
   do_parse
 end
 
 def on_error(error_token_id, error_value, value_stack)
-  puts "unexpected #{@current_token[0]} on #{@current_token[1][:filename] || "<stdin>"}:#{@current_token[1][:lineno]}"
-  puts @lines[@current_token[1][:lineno]]
-  puts " " * @current_token[1][:position] + "^" + "~" * (@current_token[1][:length] - 1)
+  message = if @current_token
+              <<~MESSAGE
+                #{@filename}:#{@current_token[1][:lineno]} unexpected #{@current_token[0]}
+                #{@lines[@current_token[1][:lineno] - 1].chomp}
+                #{" " * @current_token[1][:position]}^#{"~" * ([@current_token[1][:length] - 1, 0].max)}
+                MESSAGE
+            else
+              "#{@filename}:#{@lineno} unexpected end-of-file"
+            end
 
-  raise "Error"
+  raise(Racc::ParseError, message)
 end
 ...end parser.ra/module_eval...
 ##### State transition tables begin ###
 
 racc_action_table = [
-     2,    11,     4,     8,    19,    10,     4,     8,    20,    10,
-     4,     8,   nil,    10,     4,     8,   nil,    10,     8,    13,
-    15,    10 ]
+     5,     9,     2,    11,     5,     9,     3,    11,     5,     9,
+    12,    11,     9,    14,    16,    11,    13 ]
 
 racc_action_check = [
-     0,     1,     0,     0,    11,     0,     2,     2,    12,     2,
-     8,     8,   nil,     8,    10,    10,   nil,    10,     5,     5,
-     6,     6 ]
+     2,     2,     0,     2,     9,     9,     1,     9,    11,    11,
+     3,    11,     6,     6,     7,     7,     4 ]
 
 racc_action_pointer = [
-    -2,     1,     2,   nil,   nil,    13,    14,   nil,     6,   nil,
-    10,     4,     5,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
-   nil ]
+     0,     6,    -4,    10,    13,   nil,     7,     8,   nil,     0,
+   nil,     4,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil ]
 
 racc_action_default = [
-   -13,   -13,   -13,    -3,    -4,   -13,   -13,    -8,   -13,   -11,
-   -13,   -13,    -2,    -5,    -7,    -6,   -10,    -9,   -12,    21,
-    -1 ]
+   -12,   -12,   -12,   -12,    -2,    -3,   -12,   -12,    -7,   -12,
+   -10,   -12,    20,    -1,    -4,    -6,    -5,    -9,    -8,   -11 ]
 
 racc_goto_table = [
-     3,     1,    12,    14,    16,   nil,   nil,   nil,    17,   nil,
-    18 ]
+     4,     1,    15,    17,   nil,   nil,   nil,    18,   nil,    19 ]
 
 racc_goto_check = [
-     2,     1,     2,     5,     6,   nil,   nil,   nil,     2,   nil,
-     2 ]
+     2,     1,     5,     6,   nil,   nil,   nil,     2,   nil,     2 ]
 
 racc_goto_pointer = [
-   nil,     1,     0,   nil,   nil,    -2,    -2 ]
+   nil,     1,    -2,   nil,   nil,    -4,    -4 ]
 
 racc_goto_default = [
-   nil,   nil,   nil,     5,     6,     7,     9 ]
+   nil,   nil,   nil,     6,     7,     8,    10 ]
 
 racc_reduce_table = [
   0, 0, :racc_error,
   3, 9, :_reduce_1,
   2, 9, :_reduce_2,
-  1, 9, :_reduce_none,
-  1, 10, :_reduce_4,
+  1, 10, :_reduce_3,
+  2, 10, :_reduce_4,
   2, 10, :_reduce_5,
-  2, 10, :_reduce_6,
-  2, 11, :_reduce_7,
-  1, 11, :_reduce_8,
-  2, 13, :_reduce_9,
-  2, 12, :_reduce_10,
-  1, 12, :_reduce_11,
-  2, 14, :_reduce_12 ]
+  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 = 13
+racc_reduce_n = 12
 
-racc_shift_n = 21
+racc_shift_n = 20
 
 racc_token_table = {
   false => 0,
@@ -230,7 +247,7 @@ racc_token_table = {
   :VALUE => 4,
   :KEY => 5,
   :UNINDENT => 6,
-  "-" => 7 }
+  :ITEM => 7 }
 
 racc_nt_base = 8
 
@@ -260,7 +277,7 @@ Racc_token_to_s_table = [
   "VALUE",
   "KEY",
   "UNINDENT",
-  "\"-\"",
+  "ITEM",
   "$start",
   "document",
   "value",
@@ -289,11 +306,16 @@ module_eval(<<'.,.,', 'parser.ra', 10)
   end
 .,.,
 
-# reduce 3 omitted
+module_eval(<<'.,.,', 'parser.ra', 12)
+  def _reduce_3(val, _values, result)
+     result = Scalar.new(val[0])
+    result
+  end
+.,.,
 
 module_eval(<<'.,.,', 'parser.ra', 13)
   def _reduce_4(val, _values, result)
-     result = Scalar.new(val[0])
+     result = val[0]
     result
   end
 .,.,
@@ -305,51 +327,44 @@ module_eval(<<'.,.,', 'parser.ra', 14)
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.ra', 15)
+module_eval(<<'.,.,', 'parser.ra', 16)
   def _reduce_6(val, _values, result)
-     result = val[0]
+     val[0].add_item(*val[1]); result = val[0]
     result
   end
 .,.,
 
 module_eval(<<'.,.,', 'parser.ra', 17)
   def _reduce_7(val, _values, result)
-     val[0].add_item(*val[1]); result = val[0]
+     result = Dictionary.create(*val[0])
     result
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.ra', 18)
+module_eval(<<'.,.,', 'parser.ra', 19)
   def _reduce_8(val, _values, result)
-     result = Dictionary.create(*val[0])
+     result = [Scalar.new(val[0]), val[1]]
     result
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.ra', 20)
+module_eval(<<'.,.,', 'parser.ra', 21)
   def _reduce_9(val, _values, result)
-     result = [Scalar.new(val[0]), val[1]]
+     val[0].add_item(*val[1]); result = val[0]
     result
   end
 .,.,
 
 module_eval(<<'.,.,', 'parser.ra', 22)
   def _reduce_10(val, _values, result)
-     val[0].add_item(*val[1]); result = val[0]
-    result
-  end
-.,.,
-
-module_eval(<<'.,.,', 'parser.ra', 23)
-  def _reduce_11(val, _values, result)
      result = List.create(*val[0])
     result
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.ra', 25)
-  def _reduce_12(val, _values, result)
-     result = [Scalar.new(val[0]), val[1]]
+module_eval(<<'.,.,', 'parser.ra', 24)
+  def _reduce_11(val, _values, result)
+     result = [Item.new(val[0]), val[1]]
     result
   end
 .,.,

data/lib/yaml/sort/scalar.rb

@@ -3,12 +3,13 @@
 module Yaml
   module Sort
     class Scalar < Value
-      attr_reader :value
+      attr_reader :value, :indent
 
       def initialize(value)
         super()
         @comment = value[:comment] || []
         @value = value[:value]
+        @indent = value[:indent] || ""
       end
 
       def <=>(other)
@@ -19,8 +20,12 @@ module Yaml
         end
       end
 
-      def to_s
-        super + value
+      def to_s(skip_first_indent: false)
+        if skip_first_indent
+          super + value
+        else
+          super + indent + value
+        end
       end
     end
   end

data/lib/yaml/sort/value.rb

@@ -7,7 +7,11 @@ module Yaml
         @comment = []
       end
 
-      def to_s
+      def to_s(*)
+        comments
+      end
+
+      def comments
         @comment.join
       end
 

data/lib/yaml/sort/version.rb

@@ -2,6 +2,6 @@
 
 module Yaml
   module Sort
-    VERSION = "1.0.0"
+    VERSION = "2.0.1"
   end
 end

data/lib/yaml/sort.rb

@@ -3,6 +3,7 @@
 require_relative "sort/parser"
 require_relative "sort/value"
 require_relative "sort/dictionary"
+require_relative "sort/item"
 require_relative "sort/list"
 require_relative "sort/scalar"
 require_relative "sort/version"

data/yaml-sort.gemspec

@@ -32,5 +32,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "cri"
 
   spec.add_development_dependency "aruba"
+  spec.add_development_dependency "github_changelog_generator"
   spec.add_development_dependency "racc"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml-sort
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Romain Tartière
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cri
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: racc
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +86,7 @@ files:
 - lib/yaml/sort.rb
 - lib/yaml/sort/cli.rb
 - lib/yaml/sort/dictionary.rb
+- lib/yaml/sort/item.rb
 - lib/yaml/sort/list.rb
 - lib/yaml/sort/parser.rb
 - lib/yaml/sort/scalar.rb