yaml_normalizer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d872c2e4bbddcde16c368ddd2279ad2b1a5a6f85
-  data.tar.gz: 0b2f989dfbc4c0be5250f3afffc8fa654703462f
+  metadata.gz: f7181101bce00079a445c20da53ef9c0378f5b77
+  data.tar.gz: 401cebab8d8d70ed70845e561078448804590214
 SHA512:
-  metadata.gz: ca1c6808fc72ce7354a192ff7addc18d0d5fbf409ca030790da5f096977057785aa174307a89ebca66ad744801556895635118df0e7dbce6d20126f1289b72d2
-  data.tar.gz: 9a3c8646211ecc2279b99f36688f99540115d57d0cb2dfbb707d026346ba671c0b27499ff1e5a5b5675f2ef0cb4cdec2bfdee10e8e123e61fb4cbd58524fcb9f
+  metadata.gz: 34ec7614ce553477f4420d964c59a6efe88315d5b55ccca272087f28a41b7e194e2ecc1fd31cd889a24e1712e3c2d11e9a1b6eae0f7ff8ac68fae48e3f4c0842
+  data.tar.gz: d05e84ec8b059c83eb4e86c463a7db4206ffc4ed8372b8caa08928077e6025ff3d702eb4398800132c3f6b0c363b7f8fd71e5257ab47778920f5b80dfbcfc8e8

data/lib/yaml_normalizer/ext/namespaced.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module YamlNormalizer
+  module Ext
+    # Extends an instance of Hash to add the 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.
+      # @example
+      #   {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}
+      # @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
+      def namespaced(namespace = [], tree = {})
+        each do |key, value|
+          child_ns = namespace.dup << key
+          if value.instance_of?(Hash)
+            value.extend(Namespaced).namespaced child_ns, tree
+          else
+            tree[child_ns.join('.')] = value
+          end
+        end
+        tree
+      end
+    end
+  end
+end

data/lib/yaml_normalizer/ext/sort_by_key.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module YamlNormalizer
+  module Ext
+    # Extends an instance of Hash to add the method 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.
+      # @example
+      #   hash = { { b: { z: 20, x: 10, y: { b: 1, a: 2 } }, a: nil } }
+      #   hash.extend(YamlNormalizer::Ext::SortByKey)
+      #   hash.sort_by_key
+      #   => {: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)
+        keys.sort.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
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yaml_normalizer/ext.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module YamlNormalizer
+  # Ext holds extensions to external dependencies
+  # YamlNormalizer does not extend Ruby Core classes to avoid side effects
+  module Ext
+  end
+end
+
+require 'yaml_normalizer/ext/namespaced'
+require 'yaml_normalizer/ext/sort_by_key'

data/lib/yaml_normalizer/helpers/normalize.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module YamlNormalizer
+  module Helpers
+    # This helper holds shared functionality to normalize a YAML string.
+    module Normalize
+      # Transforms a given YAML string to a normalized format.
+      # @example
+      #   class YamlWriter
+      #     include YamlNormalizer::Helpers::Normalize
+      #
+      #     def initialize(yaml)
+      #       @yaml = normalize_yaml(yaml)
+      #     end
+      #
+      #     def write(file)
+      #       File.open(file,'w') { |f| f.write(@yaml) }
+      #     end
+      #   end
+      # @param [String] valid YAML string
+      # @return [String] normalized YAML string
+      def normalize_yaml(yaml)
+        hashes = Psych.parse_stream(yaml).transform
+        hashes.each { |hash| hash.extend(Ext::SortByKey) }
+        hashes.map(&:sort_by_key).map(&:to_yaml).join
+      end
+    end
+  end
+end

data/lib/yaml_normalizer/helpers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module YamlNormalizer
+  # Holds all Yaml Normalizer helpers
+  module Helpers
+  end
+end
+
+require 'yaml_normalizer/helpers/normalize'

data/lib/yaml_normalizer/rake_task.rb

@@ -1,30 +1,61 @@
 # frozen_string_literal: true
 
+lib = File.expand_path(File.join('..', '..', '..', 'lib'), __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'yaml_normalizer'
+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
     attr_accessor :name
-    # @return [Array] arguments to be passed to Suggest.run
-    attr_accessor :args
 
+    # The YAML files to process.
+    # @example Task files assignment
+    #   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
+    #
+    #   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 given YAML are normalized
+    #     rake yaml:normalize        # Normalize given YAML files
     # @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
+    def initialize(name = 'yaml', &block)
       yield(self) if block
 
-      desc 'Normalize all YAML files in path'
-      task(@name) { normalize }
+      desc 'Check if configured YAML are normalized'
+      task("#{name}:check") { check }
+
+      desc 'Normalize configured YAML files'
+      task("#{name}:normalize") { normalize }
+    end
+
+    private
+
+    # Checks if configured YAML are normalized
+    def check
+      Services::Check.call(*files)
     end
 
-    # @return [void]
+    # Normalizes configured YAML files
     def normalize
-      ::YamlNormalizer::Services::Normalize.call('**/*')
+      Services::Normalize.call(*files)
     end
   end
 end

data/lib/yaml_normalizer/services/base.rb

@@ -5,14 +5,45 @@ module YamlNormalizer
     # 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.
+    # @example
+    #   class ReverseService < Base
+    #     def initialize(str)
+    #       @str = str.to_s
+    #     end
+    #
+    #     def call
+    #       @str.reverse
+    #     end
+    #   end
     class Base
+      # Creates a service object.
+      # Inherit from Base and implement this method.
+      # @example
+      #   class IsFile < Base
+      #     attr_reader :file
+      #     def initialize(file)
+      #       @file = file.to_s
+      #     end
+      #     def call
+      #       File.file? file
+      #     end
+      #   end
+      #
+      # @param *args [Array<Object>] arguments
+      # @raise [NotImplementedError] if call is not implemented
+      def initialize(*args)
+        @args = args
+      end
+
       # A convenience class method to initialize Normalize with the given
       # arguments and call the method "call" on the instance.
+      # @param *args [Array] arguments to be passed to Base.new
       def self.call(*args)
         new(*args).call
       end
 
       # Inherit from Base and implement the call method
+      # @raise [NotImplementedError] if call is not implemented
       def call
         raise NotImplementedError
       end

data/lib/yaml_normalizer/services/check.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'peach'
+require 'pathname'
+
+module YamlNormalizer
+  module Services
+    # Check is a service class that provides functionality to check if giving
+    # YAML files are already standardized (normalized).
+    # @exmaple
+    #   check = YamlNormalizer::Services::Call.new('path/to/*.yml')
+    #   result = check.call
+    class Check < Base
+      include Helpers::Normalize
+
+      # files is a sorted array of file path Strings
+      attr_reader :files
+
+      # Create a Check service object by calling .new and passing one or
+      # more Strings that are interpreted as file glob pattern.
+      # @param *args [Array<String>] a list of file glob patterns
+      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)
+            normalized?(file)
+          else
+            $stderr.puts "#{file} not a YAML file"
+          end
+        end
+      end
+
+      private
+
+      def normalized?(file)
+        file = Pathname.new(file).relative_path_from(Pathname.new(Dir.pwd))
+        input = File.read(file)
+        norm = normalize_yaml(input)
+
+        if input.eql?(norm)
+          $stdout.puts "[PASSED] already normalized #{file}"
+        else
+          $stdout.puts "[FAILED] normalization suggested for #{file}"
+        end
+      end
+    end
+  end
+end

data/lib/yaml_normalizer/services/is_yaml.rb

@@ -4,17 +4,25 @@ require 'psych'
 
 module YamlNormalizer
   module Services
-    # describe!
+    # IsYaml is a Service Class that provides functionality to check if a file
+    # is a parseable non-scalar YAML file.
+    # @exmaple
+    #   is_yaml = YamlNormalizer::Services::IsYaml.new('path/to/file.yml')
+    #   result = is_yaml.call
     class IsYaml < Base
+      # file is the file path String to be regarded
       attr_reader :file
 
+      # Create an IsYaml service object by calling .new and passing a file path
+      # String.
+      # @param file [String] file path to be regarded
       def initialize(file)
         @file = file.to_s
       end
 
       # Return true if given file is a valid YAML file
       def call
-        file? && parsable? && !scalar?
+        file? && parseable? && !scalar?
       end
 
       private
@@ -25,7 +33,7 @@ module YamlNormalizer
 
       # The current implementation does not require parsable? to return a
       # boolean value
-      def parsable?
+      def parseable?
         Psych.load_file(file)
       rescue Psych::SyntaxError
         false

data/lib/yaml_normalizer/services/normalize.rb

@@ -4,13 +4,20 @@ require 'peach'
 
 module YamlNormalizer
   module Services
-    # Normalize is a Service that provides functionality to
+    # Normalize is a service class that provides functionality to update giving
+    # YAML files to a standardized (normalized) format.
+    # @exmaple
+    #   normalize = YamlNormalizer::Services::Normalize.new('path/to/*.yml')
+    #   result = normalize.call
     class Normalize < Base
-      attr_reader :files
+      include Helpers::Normalize
 
-      using YamlNormalizer::Refinements::HashSortByKey
-      using YamlNormalizer::Refinements::HashNamespaced
+      # files is a sorted array of file path Strings
+      attr_reader :files
 
+      # Create a Normalize service object by calling .new and passing one or
+      # more String that are interpreted as file glob pattern.
+      # @param *args [Array<String>] a list of file glob patterns
       def initialize(*args)
         files = args.each_with_object([]) { |a, o| o << Dir[a.to_s] }
         @files = files.flatten.sort.uniq
@@ -30,6 +37,7 @@ module YamlNormalizer
       private
 
       def normalize!(file)
+        file = Pathname.new(file).relative_path_from(Pathname.new(Dir.pwd))
         if stable?(input = File.read(file), norm = normalize_yaml(input))
           File.open(file, 'w') { |f| f.write(norm) }
           $stderr.puts "[NORMALIZED] #{file}"
@@ -38,11 +46,6 @@ module YamlNormalizer
         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)
@@ -50,7 +53,9 @@ module YamlNormalizer
       end
 
       def parse(yaml)
-        Psych.parse_stream(yaml).transform
+        ary = Psych.parse_stream(yaml).transform
+        ary.each { |hash| hash.extend(Ext::Namespaced) }
+        ary
       end
     end
   end

data/lib/yaml_normalizer/services.rb

@@ -7,5 +7,6 @@ module YamlNormalizer
 end
 
 require 'yaml_normalizer/services/base'
+require 'yaml_normalizer/services/check'
 require 'yaml_normalizer/services/is_yaml'
 require 'yaml_normalizer/services/normalize'

data/lib/yaml_normalizer/version.rb

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

data/lib/yaml_normalizer.rb

@@ -6,5 +6,6 @@ module YamlNormalizer
 end
 
 require 'yaml_normalizer/version'
-require 'yaml_normalizer/refinements'
+require 'yaml_normalizer/ext'
+require 'yaml_normalizer/helpers'
 require 'yaml_normalizer/services'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yaml_normalizer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wolfgang Teuber
@@ -39,21 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '12.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,34 +122,6 @@ dependencies:
     - - ">="
       - !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
@@ -333,18 +305,21 @@ extra_rdoc_files: []
 files:
 - bin/yaml_normalizer
 - lib/yaml_normalizer.rb
+- lib/yaml_normalizer/ext.rb
+- lib/yaml_normalizer/ext/namespaced.rb
+- lib/yaml_normalizer/ext/sort_by_key.rb
+- lib/yaml_normalizer/helpers.rb
+- lib/yaml_normalizer/helpers/normalize.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/check.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
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/lib/yaml_normalizer/refinements/hash_namespaced.rb

@@ -1,47 +0,0 @@
-# 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

@@ -1,35 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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'