yaml_normalizer 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2ed8e87937af1ed8f601b81c9fa4383f4f0fa45e
-  data.tar.gz: a43566eda64515f35c83a873c9d401697c4f1d0f
+SHA256:
+  metadata.gz: 68746aaf41b7c1ae80f702342d114f3a4f1afa3e466f7b030281784de961e36c
+  data.tar.gz: 82f5faddb4754c3394770e77eab642f0312850b439d80fe2b4de96d72c5ae592
 SHA512:
-  metadata.gz: 78f8a348e94be5e4c248a2f4a4702888721b104388be9c73c1a8f7a2447f08e9aa873b2192f8fa170f566fb942502c3d9dad028d3b002138c35599d15f8fe5ae
-  data.tar.gz: 31cb9153735178b8e40e3629707ae5d9bd721e2b86234801213bc26808b163226af5e795221549677d62d5f90d253ce6ad7efd14240e913ac15da9105780e5b4
+  metadata.gz: 887e0f0e3e1ca897f687b9143b1cf2bff78b4f6381431f9bdd5a3c8be27ae31f0cd272295fb4ab2c9402accdab31fc6c0264018ab3b49bf265cba461f5af606b
+  data.tar.gz: e31e407f5341e4daca457f42ff30fab0b633088485b72a1af16b47869c46b10a1bf02ebecfe74752a8a833332a273264621e4537102fb61e92f198cde6247e14

data/lib/yaml_normalizer/ext.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
 module YamlNormalizer
-  # Ext holds extensions to external dependencies
-  # YamlNormalizer does not extend Ruby Core classes to avoid side effects
+  # *YamlNormalizer::Ext* contains multiple extensions to extend instances of
+  # *Hash* in several ways.
+  # *YamlNormalizer* goes without extending Ruby Core classes or refinements
+  # to provide no functionality without side effects and avoid unexpected
+  # behaviour when working with POROs, fmi see https://git.io/v5Q2E.
   module Ext
   end
 end
 
 require 'yaml_normalizer/ext/namespaced'
+require 'yaml_normalizer/ext/nested'
 require 'yaml_normalizer/ext/sort_by_key'

data/lib/yaml_normalizer/ext/namespaced.rb

@@ -2,20 +2,24 @@
 
 module YamlNormalizer
   module Ext
-    # Extends an instance of Hash to add the method namespaced.
+    # *YamlNormalizer::Ext::Namespaced* extends instances of *Hash* to provide
+    # the additional public helper method *namespaced*.
     # The approach of extending Hash instances avoids monkey-patching a Ruby
     # Core class and using refinements.
     module Namespaced
-      # Transforms a tree-shaped hash into a plain key-value pair Hash,
-      # separating tree levels with a dot. namespaced does not modify the Hash
-      # it's called on.
+      # Transforms a tree-shaped *Hash* into a flat key-value pair *Hash*,
+      # separating tree levels with a dot.
+      # *namespaced* does not modify the  instance of *Hash* it's called on.
       # @example
-      #   {a: {b: {c: 1}}, b:{x: 2, y: {ok: true}, z: 4}}.namespaced
+      #   hash = {a: {b: {c: 1}}, b:{x: 2, y: {ok: true}, z: 4}}
+      #   hash.extend(YamlNormalizer::Ext::Namespaced)
+      #   hash.namespaced
       #   => {"a.b.c"=>1, "b.x"=>2, "b.y.ok"=>true, "b.z"=>4}
       # @param namespace [Array] the namespace cache for the current namespace,
-      #   used on recursive tree traversal
-      # @param tree [Hash] the accumulator object beeing build while recursive
-      #   traversing the original tree-like Hash
+      #   used on recursive tree traversal1
+      # @param tree [Hash] the accumulator object being build while recursive
+      #   traversing the original tree-shaped Hash
+      # @return [Hash] flat key-value pair Hash
       def namespaced(namespace = [], tree = {})
         each do |key, value|
           child_ns = namespace.dup << key

data/lib/yaml_normalizer/ext/nested.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module YamlNormalizer
+  module Ext
+    # *YamlNormalizer::Ext::Nested* extends instances of *Hash* to provide the
+    # additional public helper method *nested*.
+    # The approach of extending Hash instances avoids monkey-patching a Ruby
+    # Core class and using refinements.
+    module Nested
+      # Transforms a flat key-value pair *Hash* into a tree-shaped *Hash*,
+      # assuming tree levels are separated by a dot.
+      # *nested* does not modify the instance of *Hash* it's called on.
+      # @example
+      #   hash = {'a.b.c' => 1, 'b.x' => 2, 'b.y.ok' => true, 'b.z' => 4}
+      #   hash.extend(YamlNormalizer::Ext::Nested)
+      #   hash.nested
+      #   => {"a"=>{"b"=>{"c"=>1}}, "b"=>{"x"=>2, "y"=>{"ok"=>true}, "z"=>4}}
+      # @return [Hash] tree-shaped Hash
+      def nested
+        tree = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
+        each { |key, val| nest_key(tree, key.to_s, val) }
+        tree.default_proc = nil
+        tree
+      end
+
+      private
+
+      def nest_key(hash, key, val)
+        if key.include?('.')
+          keys = key.split('.')
+          hash.dig(*keys[0..-2])[keys.fetch(-1)] = val
+        else
+          hash[key] = val
+        end
+      end
+    end
+  end
+end

data/lib/yaml_normalizer/ext/sort_by_key.rb

@@ -2,12 +2,13 @@
 
 module YamlNormalizer
   module Ext
-    # Extends an instance of Hash to add the method sort_by_key.
+    # *YamlNormalizer::Ext::SortByKey* extends an instance of *Hash* to provide
+    # the additional public helper methods *sort_by_key*.
     # The approach of extending Hash instances avoids monkey-patching a Ruby
     # Core class and using refinements.
     module SortByKey
-      # Sorts entries alphabetically by key and returns a new Hash
-      # sort_by_key does not modify the Hash it's called on.
+      # Sorts entries alphabetically by key and returns a new *Hash*.
+      # *sort_by_key* does not modify the instance of *Hash* it's called on.
       # @example
       #   hash = { { b: { z: 20, x: 10, y: { b: 1, a: 2 } }, a: nil } }
       #   hash.extend(YamlNormalizer::Ext::SortByKey)
@@ -16,7 +17,7 @@ module YamlNormalizer
       # @param recursive [Boolean] defines if sort_by_key is called on child
       #   nodes, defaults to true
       def sort_by_key(recursive = true)
-        keys.sort.each_with_object({}) do |key, seed|
+        keys.sort_by(&:to_s).each_with_object({}) do |key, seed|
           value = seed[key] = fetch(key)
           if recursive && value.instance_of?(Hash)
             seed[key] = value.extend(SortByKey).sort_by_key

data/lib/yaml_normalizer/helpers/normalize.rb

@@ -20,10 +20,20 @@ module YamlNormalizer
       # @param [String] valid YAML string
       # @return [String] normalized YAML string
       def normalize_yaml(yaml)
-        hashes = Psych.parse_stream(yaml).transform
+        hashes = parse(yaml).transform
         hashes.each { |hash| hash.extend(Ext::SortByKey) }
         hashes.map(&:sort_by_key).map(&:to_yaml).join
       end
+
+      private
+
+      def parse(yaml)
+        Psych.parse_stream(yaml)
+      end
+
+      def read(file)
+        File.read(file, mode: 'r:bom|utf-8')
+      end
     end
   end
 end

data/lib/yaml_normalizer/rake_task.rb

@@ -39,7 +39,7 @@ module YamlNormalizer
     def initialize(name = 'yaml', &block)
       yield(self) if block
 
-      desc 'Check if configured YAML are normalized'
+      desc 'Check if configured YAML files are normalized'
       task("#{name}:check") { abort(check_failed(name)) unless check }
 
       desc 'Normalize configured YAML files'

data/lib/yaml_normalizer/services/check.rb

@@ -33,7 +33,7 @@ module YamlNormalizer
             normalized << normalized?(file)
           else
             normalized << nil
-            $stderr.puts "#{file} not a YAML file"
+            warn "#{file} not a YAML file"
           end
         end
 
@@ -44,7 +44,7 @@ module YamlNormalizer
 
       def normalized?(file)
         file = Pathname.new(file).relative_path_from(Pathname.new(Dir.pwd))
-        input = File.read(file, mode: 'r:bom|utf-8')
+        input = read(file)
         norm = normalize_yaml(input)
         check = input.eql?(norm)
 

data/lib/yaml_normalizer/services/is_yaml.rb

@@ -10,6 +10,8 @@ module YamlNormalizer
     #   is_yaml = YamlNormalizer::Services::IsYaml.new('path/to/file.yml')
     #   result = is_yaml.call
     class IsYaml < Base
+      include Helpers::Normalize
+
       # file is the file path String to be regarded
       attr_reader :file
 
@@ -31,10 +33,10 @@ module YamlNormalizer
         File.file? file
       end
 
-      # The current implementation does not require parsable? to return a
+      # The current implementation does not require parseable? to return a
       # boolean value
       def parseable?
-        Psych.load_file(file)
+        parse(read(file))
       rescue Psych::SyntaxError
         false
       end

data/lib/yaml_normalizer/services/normalize.rb

@@ -29,7 +29,7 @@ module YamlNormalizer
           if IsYaml.call(file)
             normalize!(file)
           else
-            $stderr.puts "#{file} not a YAML file"
+            warn "#{file} not a YAML file"
           end
         end
       end
@@ -37,23 +37,23 @@ module YamlNormalizer
       private
 
       def normalize!(file)
-        file = Pathname.new(file).relative_path_from(Pathname.new(Dir.pwd))
-        if stable?(input = File.read(file, mode: 'r:bom|utf-8'),
-                   norm = normalize_yaml(input))
+        file_abs = Pathname.new(file).realpath
+        file = file_abs.relative_path_from(Pathname.new(Dir.pwd))
+        if stable?(input = read(file), norm = normalize_yaml(input))
           File.open(file, 'w') { |f| f.write(norm) }
-          $stderr.puts "[NORMALIZED] #{file}"
+          warn "[NORMALIZED] #{file}"
         else
-          $stderr.puts "[ERROR]      Could not normalize #{file}"
+          warn "[ERROR]      Could not normalize #{file}"
         end
       end
 
       def stable?(yaml_a, yaml_b)
-        parse(yaml_a).each_with_index.all? do |a, i|
-          a.namespaced.eql?(parse(yaml_b).fetch(i).namespaced)
+        convert(yaml_a).each_with_index.all? do |a, i|
+          a.namespaced.eql?(convert(yaml_b).fetch(i).namespaced)
         end
       end
 
-      def parse(yaml)
+      def convert(yaml)
         ary = Psych.parse_stream(yaml).transform
         ary.each { |hash| hash.extend(Ext::Namespaced) }
         ary

data/lib/yaml_normalizer/version.rb

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

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: yaml_normalizer
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Wolfgang Teuber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-21 00:00:00.000000000 Z
+date: 2018-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: psych
+  name: peach
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: peach
+  name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: parallel_tests
+  name: flog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mutant-rspec
+  name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: flog
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: inch
+  name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: inch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: mutant-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rubocop
+  name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,7 +207,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -235,21 +235,7 @@ dependencies:
       - !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: awesome_print
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -263,7 +249,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -277,7 +263,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -307,6 +293,7 @@ files:
 - lib/yaml_normalizer.rb
 - lib/yaml_normalizer/ext.rb
 - lib/yaml_normalizer/ext/namespaced.rb
+- lib/yaml_normalizer/ext/nested.rb
 - lib/yaml_normalizer/ext/sort_by_key.rb
 - lib/yaml_normalizer/helpers.rb
 - lib/yaml_normalizer/helpers/normalize.rb
@@ -337,9 +324,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Yaml Normalizer normalizes YAML files
 test_files: []
-has_rdoc: