yaml_normalizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d872c2e4bbddcde16c368ddd2279ad2b1a5a6f85
+  data.tar.gz: 0b2f989dfbc4c0be5250f3afffc8fa654703462f
+SHA512:
+  metadata.gz: ca1c6808fc72ce7354a192ff7addc18d0d5fbf409ca030790da5f096977057785aa174307a89ebca66ad744801556895635118df0e7dbce6d20126f1289b72d2
+  data.tar.gz: 9a3c8646211ecc2279b99f36688f99540115d57d0cb2dfbb707d026346ba671c0b27499ff1e5a5b5675f2ef0cb4cdec2bfdee10e8e123e61fb4cbd58524fcb9f

data/bin/yaml_normalizer

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'yaml_normalizer'
+
+YamlNormalizer::Services::Normalize.call(*ARGV)

data/lib/yaml_normalizer/rake_task.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'yaml_normalizer'
+
+module YamlNormalizer
+  # Provides Rake task integration
+  class RakeTask < ::Rake::TaskLib
+    # @return [String] name of the Rake task
+    attr_accessor :name
+    # @return [Array] arguments to be passed to Suggest.run
+    attr_accessor :args
+
+    # @param name [String] name of the Rake task
+    # @param *args [Array] arguments to be passed to Normalize.call
+    # @param &block [Proc] optional, evaluated inside the task definition
+    def initialize(name = 'yaml_normalizer', *args, &block)
+      @name = name
+      @args = args
+      yield(self) if block
+
+      desc 'Normalize all YAML files in path'
+      task(@name) { normalize }
+    end
+
+    # @return [void]
+    def normalize
+      ::YamlNormalizer::Services::Normalize.call('**/*')
+    end
+  end
+end

data/lib/yaml_normalizer/refinements/hash_namespaced.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module YamlNormalizer
+  module Refinements
+    # Refine Hash to add method sort_by_key
+    module HashNamespaced
+      refine Hash do
+        # Transforms a tree-shaped hash into a plain key-value pair hash,
+        # separating tree levels with a dot.
+        # @examples
+        #   {a: {b: {c: 1}}, b:{x: 2, y: {ok: true}, z: 4}}.namespaced
+        #   => {"a.b.c"=>1, "b.x"=>2, "b.y.ok"=>true, "b.z"=>4}
+        def namespaced(namespace = [], tree = {})
+          each do |key, value|
+            child_ns = namespace.dup << key
+            if value.is_a?(Hash)
+              value.namespaced child_ns, tree
+            else
+              tree[child_ns.join('.')] = value
+            end
+          end
+          tree
+        end
+      end
+    end
+  end
+end
+
+# mutant doen't support Refinements use monky-patch for mutation testing
+# class Hash
+#   # Transforms a tree-shaped hash into a plain key-value pair hash,
+#   # separating tree levels with a dot.
+#   # @examples
+#   #   {a: {b: {c: 1}}, b:{x: 2, y: {ok: true}, z: 4}}.namespaced
+#   #   => {"a.b.c"=>1, "b.x"=>2, "b.y.ok"=>true, "b.z"=>4}
+#   def namespaced(namespace = [], tree = {})
+#     each do |key, value|
+#       child_ns = namespace.dup << key
+#       if value.is_a?(Hash)
+#         value.namespaced child_ns, tree
+#       else
+#         tree[child_ns.join('.')] = value
+#       end
+#     end
+#     tree
+#   end
+# end

data/lib/yaml_normalizer/refinements/hash_sort_by_key.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module YamlNormalizer
+  module Refinements
+    # Refine Hash to add method sort_by_key
+    module HashSortByKey
+      refine Hash do
+        # Sorts entries alphabetically by key and returns a new Hash
+        # sort_by_key does not modify the Hash it's called on.
+        def sort_by_key(recursive = true, &block)
+          keys.sort(&block).each_with_object({}) do |key, seed|
+            seed[key] = self[key]
+            if recursive && seed[key].is_a?(Hash)
+              seed[key] = seed[key].sort_by_key(true, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# mutant doen't support Refinements use monky-patch for mutation testing
+# class Hash
+#   # Sorts entries alphabetically by key and returns a new Hash
+#   # sort_by_key does not modify the Hash it's called on.
+#   def sort_by_key(recursive = true, &block)
+#     keys.sort(&block).each_with_object({}) do |key, seed|
+#       seed[key] = self[key]
+#       if recursive && seed[key].is_a?(Hash)
+#         seed[key] = seed[key].sort_by_key(true, &block)
+#       end
+#     end
+#   end
+# end

data/lib/yaml_normalizer/refinements.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module YamlNormalizer
+  # Refinements holds all refinements used for Yaml Normalizer
+  module Refinements
+  end
+end
+
+require 'yaml_normalizer/refinements/hash_sort_by_key'
+require 'yaml_normalizer/refinements/hash_namespaced'

data/lib/yaml_normalizer/services/base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module YamlNormalizer
+  module Services
+    # The Base Service provides a convenience class method "call" to initialize
+    # the Service with the given arguments and call the method "call" on the
+    # instance.
+    class Base
+      # A convenience class method to initialize Normalize with the given
+      # arguments and call the method "call" on the instance.
+      def self.call(*args)
+        new(*args).call
+      end
+
+      # Inherit from Base and implement the call method
+      def call
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/yaml_normalizer/services/is_yaml.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'psych'
+
+module YamlNormalizer
+  module Services
+    # describe!
+    class IsYaml < Base
+      attr_reader :file
+
+      def initialize(file)
+        @file = file.to_s
+      end
+
+      # Return true if given file is a valid YAML file
+      def call
+        file? && parsable? && !scalar?
+      end
+
+      private
+
+      def file?
+        File.file? file
+      end
+
+      # The current implementation does not require parsable? to return a
+      # boolean value
+      def parsable?
+        Psych.load_file(file)
+      rescue Psych::SyntaxError
+        false
+      end
+
+      def scalar?
+        Psych.load_file(file).instance_of? String
+      end
+    end
+  end
+end

data/lib/yaml_normalizer/services/normalize.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'peach'
+
+module YamlNormalizer
+  module Services
+    # Normalize is a Service that provides functionality to
+    class Normalize < Base
+      attr_reader :files
+
+      using YamlNormalizer::Refinements::HashSortByKey
+      using YamlNormalizer::Refinements::HashNamespaced
+
+      def initialize(*args)
+        files = args.each_with_object([]) { |a, o| o << Dir[a.to_s] }
+        @files = files.flatten.sort.uniq
+      end
+
+      # Normalizes all YAML files defined on instantiation.
+      def call
+        files.peach do |file|
+          if IsYaml.call(file)
+            normalize!(file)
+          else
+            $stderr.puts "#{file} not a YAML file"
+          end
+        end
+      end
+
+      private
+
+      def normalize!(file)
+        if stable?(input = File.read(file), norm = normalize_yaml(input))
+          File.open(file, 'w') { |f| f.write(norm) }
+          $stderr.puts "[NORMALIZED] #{file}"
+        else
+          $stderr.puts "[ERROR]      Could not normalize #{file}"
+        end
+      end
+
+      def normalize_yaml(yaml)
+        hashes = Psych.parse_stream(yaml).transform
+        hashes.map(&:sort_by_key).map(&:to_yaml).join
+      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)
+        end
+      end
+
+      def parse(yaml)
+        Psych.parse_stream(yaml).transform
+      end
+    end
+  end
+end

data/lib/yaml_normalizer/services.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module YamlNormalizer
+  # Holds all Yaml Normalizer services
+  module Services
+  end
+end
+
+require 'yaml_normalizer/services/base'
+require 'yaml_normalizer/services/is_yaml'
+require 'yaml_normalizer/services/normalize'

data/lib/yaml_normalizer/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module YamlNormalizer
+  # The current Yaml Normalizer version
+  VERSION = '0.1.0'
+end

data/lib/yaml_normalizer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Yaml Normalizer normalizes YAML files ensuring Psych's parsing result of
+# the YAML file is identical before and after normalization.
+module YamlNormalizer
+end
+
+require 'yaml_normalizer/version'
+require 'yaml_normalizer/refinements'
+require 'yaml_normalizer/services'

metadata

@@ -0,0 +1,370 @@
+--- !ruby/object:Gem::Specification
+name: yaml_normalizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wolfgang Teuber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: peach
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !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: rake
+  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: parallel_tests
+  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: 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: cane
+  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: flay
+  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: 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: coveralls
+  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-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: 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: 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'
+- !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: 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
+  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'
+description: |-
+  Yaml Normalizer follows the notion that there is
+      a normalized YAML file format. It re-formats YAML files in a way that the
+      results closely match Psych's output. Yaml Normalizer ensures that the
+      original file and the resulting file are 100% identical to Psych (stable
+      change).
+email:
+- wolfgang.teuber@sage.com
+executables:
+- yaml_normalizer
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/yaml_normalizer
+- lib/yaml_normalizer.rb
+- lib/yaml_normalizer/rake_task.rb
+- lib/yaml_normalizer/refinements.rb
+- lib/yaml_normalizer/refinements/hash_namespaced.rb
+- lib/yaml_normalizer/refinements/hash_sort_by_key.rb
+- lib/yaml_normalizer/services.rb
+- lib/yaml_normalizer/services/base.rb
+- lib/yaml_normalizer/services/is_yaml.rb
+- lib/yaml_normalizer/services/normalize.rb
+- lib/yaml_normalizer/version.rb
+homepage: https://github.com/Sage/yaml_normalizer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Yaml Normalizer normalizes YAML files
+test_files: []
+has_rdoc: