yaml-sort 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b17a9fdbfc9612b6b2bb1a75583e9a31c269fbba87c088afc0fc6ffe16e44aa1
+  data.tar.gz: edde89f395f92d321c95e4899c6744bba2b005b93aa4399c00d090c4511a27ac
+SHA512:
+  metadata.gz: a3a763b77216fad635aec8707d388d1bc1c8afb1ccd2217922b17c6179bc59d6c1998459c3e131375d1fed6e743d94d2d39dc2f080bd4adf45b42a73aff56b94
+  data.tar.gz: 11573f243771dcd0ec7c52748a9927c358472860e0a52e287f8764c960e539aa76b6df6ee6f2fff724eb9f5e780c2b62d7921b65b1d0f9aaf696d388e618b6f4

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+    - lib/yaml/sort/parser.rb
+    - vendor/**/*
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 140
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-09
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at romain@blogreen.org. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in yaml-sort.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Romain Tartière
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# yaml-sort
+
+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.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add yaml-sort
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install yaml-sort
+
+## Usage
+
+```
+Usage: yaml-sort [options] [filename]
+    -i, --in-place                   Update files in-place
+    -l, --lint                       Ensure files content is sorted as expected
+```
+
+## Hiera Integration for Puppet
+
+Add this to your Rakefile:
+
+```ruby
+require "yaml/sort/tasks/puppet"
+
+Rake::Task[:lint].enhance ["lint:hiera_data_ordering"]
+```
+
+This provide two new targets:
+
+```
+rake lint:hiera_data_ordering  # Check Hiera data content ordering
+rake reorder_hiera_data        # Reorder Hiera data in-place
+```
+
+## Ruby on Rails Integration
+
+Add this to your Rakefile:
+
+```ruby
+require "yaml/sort/tasks/rails"
+
+Rake::Task[:test].enhance ["test:translations_ordering"]
+```
+
+This provide two new targets:
+
+```
+rake reorder_translations        # Reorder translations in-place
+rake test:translations_ordering  # Check translations content ordering
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/smortex/yaml-sort. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/smortex/yaml-sort/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the yaml-sort project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/smortex/yaml-sort/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+require "cucumber/rake/task"
+
+Cucumber::Rake::Task.new
+
+task default: %i[rubocop 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"
+end
+
+task spec: ["lib/yaml/sort/parser.rb"]
+task cucumber: ["lib/yaml/sort/parser.rb"]

data/exe/yaml-sort

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "yaml/sort"
+require "yaml/sort/cli"
+
+exit Yaml::Sort::Cli.new.execute(ARGV)

data/lib/yaml/sort/cli.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+require "cri"
+
+module Yaml
+  module Sort
+    class Cli
+      def initialize
+        @parser = Yaml::Sort::Parser.new
+      end
+
+      def execute(argv) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        options = {
+          in_place: false,
+          lint: false,
+        }
+        OptionParser.new do |opts|
+          opts.banner = "Usage: yaml-sort [options] [filename]"
+
+          opts.on("-i", "--in-place", "Update files in-place") do
+            options[:in_place] = true
+          end
+          opts.on("-l", "--lint", "Ensure files content is sorted as expected") do
+            options[:lint] = true
+          end
+        end.parse!
+
+        if !options[:in_place] && !options[:lint] && argv.count > 1
+          warn "Sorting multiple YAML document to stdout does not make sense"
+          return 1
+        end
+
+        if options[:in_place] && argv.count < 1
+          warn "Cannot sort in-place when reading from stdin"
+          return 1
+        end
+
+        @exit_code = 0
+
+        if argv.empty?
+          process_document(nil, options)
+        else
+          argv.each do |filename|
+            process_document(filename, options)
+          end
+        end
+
+        @exit_code
+      end
+
+      def process_document(filename, options)
+        yaml = read_document(filename)
+        sorted_yaml = sort_yaml(yaml)
+        write_output(yaml, sorted_yaml, filename, options)
+      end
+
+      def read_document(filename)
+        if filename
+          File.read(filename)
+        else
+          $stdin.read
+        end
+      end
+
+      def sort_yaml(yaml)
+        document = @parser.parse(yaml)
+        document = document.sort
+        "---\n#{document}\n"
+      end
+
+      def write_output(yaml, sorted_yaml, filename, options)
+        if options[:in_place]
+          File.write(filename, sorted_yaml)
+        elsif options[:lint]
+          if yaml != sorted_yaml
+            warn "#{filename || "<stdin>"} is not sorted as expected"
+            @exit_code = 1
+          end
+        else
+          puts sorted_yaml
+        end
+      end
+    end
+  end
+end

data/lib/yaml/sort/dictionary.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Yaml
+  module Sort
+    class Dictionary < Value
+      attr_reader :items
+
+      def initialize(items = [])
+        super()
+        @items = items
+      end
+
+      def add_item(key, value)
+        @items << [key, value]
+      end
+
+      def self.create(key, value)
+        dict = Dictionary.new
+        dict.add_item(key, value)
+        dict
+      end
+
+      def to_s
+        super + items.map do |k, v|
+          case v
+          when List, Dictionary
+            "#{k}\n#{v}"
+          when Scalar
+            "#{k} #{v}"
+          end
+        end.join("\n")
+      end
+
+      def sort
+        Dictionary.new(items.map { |a| [a[0], a[1].sort] }.sort do |a, b|
+          if a[0].value == "lookup_options:"
+            -1
+          elsif b[0].value == "lookup_options:"
+            1
+          else
+            a[0] <=> b[0]
+          end
+        end)
+      end
+    end
+  end
+end

data/lib/yaml/sort/list.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Yaml
+  module Sort
+    class List < Value
+      attr_reader :items
+
+      def initialize(items = [])
+        super()
+        @items = items
+      end
+
+      def add_item(dash, value)
+        @items << [dash, value]
+      end
+
+      def self.create(dash, value)
+        list = List.new
+        list.add_item(dash, value)
+        list
+      end
+
+      def to_s
+        super + items.map do |item|
+          "#{item[0]}#{item[1]}"
+        end.join("\n")
+      end
+
+      def sort
+        List.new(items.sort { |a, b| a[1] <=> b[1] })
+      rescue ArgumentError
+        # Non-comparable items
+        self
+      end
+    end
+  end
+end

data/lib/yaml/sort/parser.rb

@@ -0,0 +1,363 @@
+#
+# DO NOT MODIFY!!!!
+# This file is automatically generated by Racc 1.6.0
+# from Racc grammar file "".
+#
+
+require 'racc/parser.rb'
+
+
+require 'strscan'
+
+module Yaml
+  module Sort
+    class Parser < Racc::Parser
+
+module_eval(<<'...end parser.ra/module_eval...', 'parser.ra', 34)
+
+def scan(text)
+  scan_value = false
+
+  @lines = text.lines
+  s = StringScanner.new(text)
+  @tokens = []
+  @lineno = 1
+  @fakelineno = 0
+  @position = 0
+  @indent_stack = []
+
+  until s.eos?
+    if scan_value
+      unless s.match?(/[[:space:]]*\n/)
+        @position += s.matched_size if s.scan(/\s*/)
+        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]+/)
+          end
+          emit(:VALUE, match)
+        end
+      end
+      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])/)
+        indent = s.captures[0]
+        indent = last_indent_value + indent + " " unless s.matched.start_with?("\n")
+        emit(:KEY, s.matched, indent: indent)
+
+      when s.scan(/\n\z/)
+        # Done
+     when s.match?(/./)
+       scan_value = true
+      else
+        raise "LoST: #{s.rest.inspect} #{s.eos?}"
+      end
+    end
+  end
+
+  unindent
+
+  comment = []
+  @tokens.each do |token|
+    if token[0] == :COMMENT
+      comment << token[1][:value] + "\n"
+    elsif comment.any?
+      token[1][:comment] = comment
+      comment = []
+    end
+  end
+
+  @tokens = @tokens.delete_if { |itm| itm[0] == :COMMENT }
+
+  @tokens
+end
+
+def emit(token, value, length: nil, indent: 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
+  end
+
+  if value.start_with?("\n")
+    @lineno += 1
+    value = value[1..-1]
+    length -= 1
+    @position = 0
+  end
+
+  if indent
+    unindent(indent)
+    @indent_stack.push(indent) unless @indent_stack.last == indent
+  end
+
+  exvalue = {
+    value: value,
+    lineno: @lineno,
+    position: @position,
+    filename: @filename,
+    length: length,
+    indent: indent,
+  }
+  @tokens << [token, exvalue]
+
+  @lineno += value.count("\n")
+
+  @position += length
+end
+
+def last_indent_value
+  @indent_stack.last || ""
+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 }]
+  end
+end
+
+def next_token
+  @current_token = @tokens.shift
+end
+
+def parse(text)
+  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)
+
+  raise "Error"
+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 ]
+
+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 ]
+
+racc_action_pointer = [
+    -2,     1,     2,   nil,   nil,    13,    14,   nil,     6,   nil,
+    10,     4,     5,   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 ]
+
+racc_goto_table = [
+     3,     1,    12,    14,    16,   nil,   nil,   nil,    17,   nil,
+    18 ]
+
+racc_goto_check = [
+     2,     1,     2,     5,     6,   nil,   nil,   nil,     2,   nil,
+     2 ]
+
+racc_goto_pointer = [
+   nil,     1,     0,   nil,   nil,    -2,    -2 ]
+
+racc_goto_default = [
+   nil,   nil,   nil,     5,     6,     7,     9 ]
+
+racc_reduce_table = [
+  0, 0, :racc_error,
+  3, 9, :_reduce_1,
+  2, 9, :_reduce_2,
+  1, 9, :_reduce_none,
+  1, 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 ]
+
+racc_reduce_n = 13
+
+racc_shift_n = 21
+
+racc_token_table = {
+  false => 0,
+  :error => 1,
+  :START_OF_DOCUMENT => 2,
+  :END_OF_DOCUMENT => 3,
+  :VALUE => 4,
+  :KEY => 5,
+  :UNINDENT => 6,
+  "-" => 7 }
+
+racc_nt_base = 8
+
+racc_use_result_var = true
+
+Racc_arg = [
+  racc_action_table,
+  racc_action_check,
+  racc_action_default,
+  racc_action_pointer,
+  racc_goto_table,
+  racc_goto_check,
+  racc_goto_default,
+  racc_goto_pointer,
+  racc_nt_base,
+  racc_reduce_table,
+  racc_token_table,
+  racc_shift_n,
+  racc_reduce_n,
+  racc_use_result_var ]
+
+Racc_token_to_s_table = [
+  "$end",
+  "error",
+  "START_OF_DOCUMENT",
+  "END_OF_DOCUMENT",
+  "VALUE",
+  "KEY",
+  "UNINDENT",
+  "\"-\"",
+  "$start",
+  "document",
+  "value",
+  "dictionary",
+  "list",
+  "dictionary_item",
+  "list_item" ]
+
+Racc_debug_parser = false
+
+##### State transition tables end #####
+
+# reduce 0 omitted
+
+module_eval(<<'.,.,', 'parser.ra', 9)
+  def _reduce_1(val, _values, result)
+     result = val[1]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.ra', 10)
+  def _reduce_2(val, _values, result)
+     result = val[1]
+    result
+  end
+.,.,
+
+# reduce 3 omitted
+
+module_eval(<<'.,.,', 'parser.ra', 13)
+  def _reduce_4(val, _values, result)
+     result = Scalar.new(val[0])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.ra', 14)
+  def _reduce_5(val, _values, result)
+     result = val[0]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.ra', 15)
+  def _reduce_6(val, _values, result)
+     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
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.ra', 18)
+  def _reduce_8(val, _values, result)
+     result = Dictionary.create(*val[0])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.ra', 20)
+  def _reduce_9(val, _values, result)
+     result = [Scalar.new(val[0]), val[1]]
+    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]]
+    result
+  end
+.,.,
+
+def _reduce_none(val, _values, result)
+  val[0]
+end
+
+    end   # class Parser
+  end   # module Sort
+end   # module Yaml

data/lib/yaml/sort/scalar.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Yaml
+  module Sort
+    class Scalar < Value
+      attr_reader :value
+
+      def initialize(value)
+        super()
+        @comment = value[:comment] || []
+        @value = value[:value]
+      end
+
+      def <=>(other)
+        if other.is_a?(Scalar)
+          value <=> other.value
+        else
+          0
+        end
+      end
+
+      def to_s
+        super + value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+namespace :lint do
+  desc "Check Hiera data content ordering"
+  task :hiera_data_ordering do
+    sh "yaml-sort", "--lint", *Dir.glob("data/**/*.yaml")
+  end
+end
+
+desc "Reorder Hiera data in-place"
+task :reorder_hiera_data do
+  sh "yaml-sort", "--in-place", *Dir.glob("data/**/*.yaml")
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+namespace :test do
+  desc "Check translations content ordering"
+  task :translations_ordering do
+    sh "yaml-sort", "--lint", *Dir.glob("config/locales/**/*.yml")
+  end
+end
+
+desc "Reorder translations in-place"
+task :reorder_translations do
+  sh "yaml-sort", "--in-place", *Dir.glob("config/locales/**/*.yml")
+end

data/lib/yaml/sort/value.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Yaml
+  module Sort
+    class Value
+      def initialize
+        @comment = []
+      end
+
+      def to_s
+        @comment.join
+      end
+
+      def sort
+        self
+      end
+    end
+  end
+end

data/lib/yaml/sort/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yaml
+  module Sort
+    VERSION = "1.0.0"
+  end
+end

data/lib/yaml/sort.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "sort/parser"
+require_relative "sort/value"
+require_relative "sort/dictionary"
+require_relative "sort/list"
+require_relative "sort/scalar"
+require_relative "sort/version"
+
+module Yaml
+  module Sort
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/sig/yaml/sort.rbs

@@ -0,0 +1,6 @@
+module Yaml
+  module Sort
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

data/yaml-sort.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/yaml/sort/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "yaml-sort"
+  spec.version = Yaml::Sort::VERSION
+  spec.authors = ["Romain Tartière"]
+  spec.email = ["romain@blogreen.org"]
+
+  spec.summary = "Sort lines in YAML files in a predictable order"
+  spec.homepage = "https://github.com/smortex/yaml-sort"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/smortex/yaml-sort/blob/master/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end - ["lib/yaml/sort/parser.ra"] + ["lib/yaml/sort/parser.rb"]
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "cri"
+
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "racc"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: yaml-sort
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Romain Tartière
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cri
+  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'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- romain@blogreen.org
+executables:
+- yaml-sort
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/yaml-sort
+- lib/yaml/sort.rb
+- lib/yaml/sort/cli.rb
+- lib/yaml/sort/dictionary.rb
+- lib/yaml/sort/list.rb
+- lib/yaml/sort/parser.rb
+- lib/yaml/sort/scalar.rb
+- lib/yaml/sort/tasks/puppet.rb
+- lib/yaml/sort/tasks/rails.rb
+- lib/yaml/sort/value.rb
+- lib/yaml/sort/version.rb
+- sig/yaml/sort.rbs
+- yaml-sort.gemspec
+homepage: https://github.com/smortex/yaml-sort
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/smortex/yaml-sort
+  source_code_uri: https://github.com/smortex/yaml-sort
+  changelog_uri: https://github.com/smortex/yaml-sort/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.5
+signing_key: 
+specification_version: 4
+summary: Sort lines in YAML files in a predictable order
+test_files: []