yaml_normalizer 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dd002fd2b568ad18986f04868de54c371d9a4c93f2e6955f9bbe578f2cab86b
-  data.tar.gz: ecad36bc46f4cde9983045633bdb0a6d6c5c819dbd58ef899b6fe707f0d82303
+  metadata.gz: 147c80fe321c3b244de1fe9456de27af5d1b124d8ad31d7f564b0b7ab6d1db2f
+  data.tar.gz: c3f856e4eb45b53bfe63e3cf9122aac358ff37d0a85d53116cf576422195c58a
 SHA512:
-  metadata.gz: 4506ab09d6a8f5565b48e2d517aab6e9d8db777996f0a0a160ced6db6abfc556559445edac561a6f0c06465380f6e2ef03c050bc8e7d2ce692eb69c553139975
-  data.tar.gz: 7a2b86157806013d274f20611595e93238dc7c35c55921e3885ab8aa9fe7a7dd3c34eb9fbcb15e071a1dd5f8a9bb569f0df53f576e48b5f8a9f0ae5e0eee0c00
+  metadata.gz: 7c7771f0ccecfbd8dd6877c2fa011aa107fc7a5e5945d98565f2b156edfd202ad7e18e082761e47314b634cb3fc66a278e4e32524aeacf3965d8bb53f5db06d1
+  data.tar.gz: 24450ee1daa379f169f4f8f5a6859ff22ebfcf5fe8c5675c716384c9c2ff85e4274b757f4713e40cc906c52b6c8d8c2b3db62a0d4834598ca6b687612645cff2

data/lib/yaml_normalizer/ext/sort_by_key.rb

@@ -16,7 +16,7 @@ module YamlNormalizer
       #   => {:a=>nil, :b=>{:x=>10, :y=>{:a=>2, :b=>1}, :z=>20}}
       # @param recursive [Boolean] defines if sort_by_key is called on child
       #   nodes, defaults to true
-      def sort_by_key(recursive = true)
+      def sort_by_key(recursive: true)
         keys.sort_by(&:to_s).each_with_object({}) do |key, seed|
           value = seed[key] = fetch(key)
           seed[key] = value.extend(SortByKey).sort_by_key if recursive && value.instance_of?(Hash)

data/lib/yaml_normalizer/helpers/normalize.rb

@@ -23,8 +23,10 @@ module YamlNormalizer
       # @return [String] normalized YAML string
       def normalize_yaml(yaml)
         hashes = parse(yaml).transform
-        hashes.each { |hash| hash.extend(Ext::SortByKey) }
-        hashes.map(&:sort_by_key).map(&:to_yaml).join
+        hashes.map do |hash|
+          hash.extend(Ext::SortByKey)
+          hash.sort_by_key.to_yaml
+        end.join
       end
 
       private
@@ -39,7 +41,7 @@ module YamlNormalizer
 
       def relative_path_for(file)
         realpath = Pathname.new(file).realpath
-        realpath.relative_path_from(Pathname.new(Dir.pwd))
+        realpath.relative_path_from(Dir.pwd)
       end
     end
   end

data/lib/yaml_normalizer/helpers/param_parser.rb

@@ -12,23 +12,23 @@ module YamlNormalizer
       def parse_params(*args)
         OptionParser.new do |opts|
           opts.banner = "Usage: #{program_name} [options] file1, file2..."
-          opts.on('-v', '--version', 'Prints the yaml_normalizer version') { print_version }
           opts.on('-h', '--help', 'Prints this help') { print_help(opts) }
+          opts.on('-v', '--version', 'Prints the yaml_normalizer version') { print_version }
         end.parse(args)
       end
 
-      # Print current version of the tool
-      def print_version
-        print("#{YamlNormalizer::VERSION}\n")
-        exit_success
-      end
-
       # Print current version of the tool
       # @param [Option] opts - options of opt_parser object
       # @return nil
       def print_help(opts)
         print(opts)
-        exit_success
+        exit
+      end
+
+      # Print current version of the tool
+      def print_version
+        print("#{VERSION}\n")
+        exit
       end
 
       private
@@ -36,10 +36,6 @@ module YamlNormalizer
       def program_name
         $PROGRAM_NAME.split('/').last
       end
-
-      def exit_success
-        exit unless ENV['ENV'] == 'test'
-      end
     end
   end
 end

data/lib/yaml_normalizer/rake_task.rb

@@ -8,35 +8,34 @@ require 'rake/tasklib'
 module YamlNormalizer
   # Provides Rake task integration
   class RakeTask < ::Rake::TaskLib
-    # The name of the task
-    # @return [String] name of the Rake task
+    # The name of the rake task
+    # @return [String] name of the rake task
     attr_accessor :name
 
     # The YAML files to process.
-    # @example Task files assignment
+    # @example
     #   YamlNormalizer::RakeTask.new do |task|
     #     task.files = ['config/locale/*.yml', 'config/*.yml']
     #   end
     # @return [Array<String>] a list of file globing Strings
     attr_accessor :files
 
-    # Create a YamlNormalizer rake task object.
-    # Use this to
-    # @example
-    #   In your Rakefile, add:
-    #     YamlNormalizer::RakeTask.new
+    # Add YAML Normalizer rake tasks to your project by adding the following line to your Rakefile:
+    #   YamlNormalizer::RakeTask.new
     #
-    #   To be more specific, configure YAML Normalizer's mode and files like so:
-    #     YamlNormalizer::RakeTask.new do |config|
-    #       config.files = Dir[File.join(File.dirname(__FILE__), 'include.yml')]
-    #     end
+    # This gives you the following tasks (run rake -T)
+    #   rake yaml:check      # Check if configured YAML files are normalized
+    #   rake yaml:normalize  # Normalize configured YAML files
+    #
+    # @example Configure YAML Normalizer's rake task
+    #   YamlNormalizer::RakeTask.new do |config|
+    #     config.files = Dir[File.join(File.dirname(__FILE__), 'include.yml')]
+    #   end
     #
-    #   This gives you the following tasks (run rake -T)
-    #     rake yaml:check  # Check if given YAML are normalized
-    #     rake yaml:normalize        # Normalize given YAML files
-    # @param name [String] name of the Rake task
+    # @param name [String] name of the rake task
     # @param &block [Proc] optional, evaluated inside the task definition
     def initialize(name = 'yaml', &block)
+      super()
       yield(self) if block
 
       desc 'Check if configured YAML files are normalized'

data/lib/yaml_normalizer/services/check.rb

@@ -20,6 +20,7 @@ module YamlNormalizer
       # more Strings that are interpreted as file glob pattern.
       # @param *args [Array<String>] a list of file glob patterns
       def initialize(*args)
+        super
         parse_params(*args)
         files = args.each_with_object([]) { |a, o| o << Dir[a.to_s] }
         @files = files.flatten.sort.uniq
@@ -37,7 +38,7 @@ module YamlNormalizer
       def process(file)
         return true if IsYaml.call(file) && normalized?(file)
 
-        $stderr.print "#{file} not a YAML file\n"
+        $stderr.print "#{file} is not a YAML file\n"
         nil
       end
 

data/lib/yaml_normalizer/services/is_yaml.rb

@@ -19,6 +19,7 @@ module YamlNormalizer
       # String.
       # @param file [String] file path to be regarded
       def initialize(file)
+        super
         @file = file.to_s
       end
 

data/lib/yaml_normalizer/services/normalize.rb

@@ -20,6 +20,7 @@ module YamlNormalizer
       # more String that are interpreted as file glob pattern.
       # @param *args [Array<String>] a list of file glob patterns
       def initialize(*args)
+        super
         parse_params(*args)
         files = args.each_with_object([]) { |a, o| o << Dir[a.to_s] }
         @files = files.flatten.sort.uniq
@@ -43,7 +44,7 @@ module YamlNormalizer
       def normalize!(file)
         file = relative_path_for(file)
         if stable?(input = read(file), norm = normalize_yaml(input))
-          File.open(file, 'w') { |f| f.write(norm) }
+          File.write(file, norm)
           $stderr.print "[NORMALIZED] #{file}\n"
         else
           $stderr.print "[ERROR]      Could not normalize #{file}\n"

data/lib/yaml_normalizer/version.rb

@@ -2,5 +2,5 @@
 
 module YamlNormalizer
   # The current Yaml Normalizer version
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml_normalizer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - The Sage Group plc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-07 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: peach
@@ -52,272 +52,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '14.0'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  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: bundler
-  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: flog
-  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: github-markup
-  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: guard
-  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: guard-rspec
-  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: guard-rubocop
-  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: inch
-  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: mutant-rspec
-  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: pry
-  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: pry-byebug
-  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: pry-doc
-  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: rb-readline
-  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: redcarpet
-  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: rspec
-  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: rubocop
-  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: rubocop-performance
-  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: simplecov
-  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: yard
-  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: |-
   Yaml Normalizer follows the notion that there is
       a normalized YAML file format. It re-formats YAML files in a way that the