annotate_yaml 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef35923c5328d440a4f7a8d75dc677be72d69836
-  data.tar.gz: f17add2eb2c7a0223cd597181780530dfeab413d
+  metadata.gz: 9b7f2f675a016a98a7caaa4b63723982dd09a9cc
+  data.tar.gz: e5be5202b3f4022d523548f85a7c41eafc7f429b
 SHA512:
-  metadata.gz: f41e66bf9b19168a36fc8e9f749b53a512f8e77674c45da1a574e4af619eb526840e93fa58911fb5d573078f10da25399d947c46563c219b2d1c195d05a8afb1
-  data.tar.gz: 445c18f3d593ea1471d5f62d5c84f9dc9d18f6c7eef9b8cbfc6254f16e6bfefaa2416474fd8dac5ddd38e03c4b6af0d356cae05f18e9b1f5b0b65901a10a98b6
+  metadata.gz: 536f04133bd9f6dc8fac888afef2323b0c3b3a967c981daf658e700ac3a766114e43ce9223e13fc41e654c9f8b51c3608cc04484f341863f028984337859ecd3
+  data.tar.gz: bbe4a147fbb99d768fa673e42be66490bef3b12001f9e22234eb0df54effea0d12d13b960eb05a7fb86ba80f3940c106b10d8c0714effd8fa24b11b815c76281

data/README.md

@@ -1,4 +1,4 @@
-# AnnotateYaml
+# AnnotateYaml [![Code Climate](https://codeclimate.com/github/purban/annotate_yaml/badges/gpa.svg)](https://codeclimate.com/github/purban/annotate_yaml)
 
 Have you never been bored to scroll up an entire YAML structure to find out how to access the value?
 

data/lib/annotate_yaml/annotate_yaml.rb

@@ -1,58 +1,118 @@
 module AnnotateYaml
   require 'yaml'
 
-  class << self
-    def annotate_locales
+  DEFAULT_YML_LOOKUP = 'config/locales/*.yml'
 
-      files = Dir.glob("config/locales/*.yml")
-      files.each do |file|
-        complete_yaml_file = File.open(file).read
-        # Remove the references
-        complete_yaml_file_without_references = complete_yaml_file.gsub(/<<: \*.*/, '')
-        yaml_hash = YAML::load(complete_yaml_file_without_references)
-        array_of_hashes_of_values_with_keys = []
-        yaml_navigation(yaml_hash, [], array_of_hashes_of_values_with_keys)
-
-        string_result = ''
-
-        text = File.open(file).read
-        text.gsub!(/\r\n?/, "\n")
-        current_hash = array_of_hashes_of_values_with_keys.shift
-        text.each_line do |line|
-          begin
-            line_hash = YAML::load line
-          rescue Exception => e
-            string_result += line
-            next
-          end
-          if line_hash === false
-            string_result += line
+  class YamlHashExplorer
+    attr_reader :result
+
+    def initialize(hash)
+      @result = []
+      yaml_navigation(hash, [])
+    end
+
+    private
+
+    def yaml_navigation(yaml_hash, keys_array_origin)
+      yaml_hash.each do |key, value|
+        keys_array_updated = keys_array_origin.dup
+        keys_array_updated.push(key)
+        result.push({ value => keys_array_updated.join('.') }) if desired_terminatory_value?(value)
+
+        yaml_navigation(value, keys_array_updated) if value.is_a?(Hash)
+      end
+    end
+
+    def desired_terminatory_value?(value)
+      !(value.nil? || value.is_a?(Hash) || value.is_a?(Array))
+    end
+  end
+
+  class FileHandler
+
+    attr_reader :file_name, :result
+
+    def initialize(file_name)
+      @file_name = file_name
+      @result = ""
+    end
+
+    def call
+      create_annotated_text
+      rewrite_file
+    end
+
+    private
+
+    def create_annotated_text
+      adapted_file_content.each_line do |line|
+        annotate_line(line)
+      end
+    end
+
+    def annotate_line(line)
+      begin
+        if line_hash = YAML::load(line)
+          _, line_value = line_hash.first
+
+          if line_value.nil?
+            result << line
           else
-            line_key, line_value = line_hash.first
             key, value = current_hash.first
             if line_value == key
-              string_result += (line.end_with?(" \# #{value}\n") ? line : line.gsub("\n", '') + " \# #{value}\n")
-              current_hash = array_of_hashes_of_values_with_keys.shift
+              result << annotation_for_line(line, value)
             else
-              string_result += line
+              result << line
             end
           end
-
-          File.open(file, "w+") do |f|
-            f.write(string_result)
-          end
+        else
+          result << line
         end
+      # YAML::load will generate an exception when references are used inside the yaml file. Exemple: errors: &errors
+      rescue Psych::BadAlias
+        result << line
       end
     end
 
-    def yaml_navigation(yaml_hash, keys_array_origin = [], result = [])
-      yaml_hash.each do |key, value|
-        keys_array_updated = keys_array_origin.dup
-        keys_array_updated.push(key)
-        result.push({ value => keys_array_updated.join('.') }) unless value.nil? || value.is_a?(Hash) || value.is_a?(Array)
-        yaml_navigation value, keys_array_updated, result if value.is_a?(Hash)
+    def annotation_for_line(line, value)
+      (line.end_with?(" \# #{value}\n") ? line : line.gsub("\n", '') + " \# #{value}\n")
+    end
+
+    def rewrite_file
+      File.open(file_name, "w+") do |f|
+        f.write(result)
       end
     end
+
+    def adapted_file_content
+      File.open(file_name).read.gsub(/\r\n?/, "\n")
+    end
+
+    def hash_content
+      # Remove the references inside the yaml file otherwise the hash will be duplicated at each reference, and we don't want that.
+      # Exemple of reference: <<: *errors
+      YAML.load(File.open(file_name).read.gsub(/<<: \*.*/, ''))
+    end
+
+    def array_of_hashes_of_values_with_keys
+      @array_of_hashes_of_values_with_keys ||= YamlHashExplorer.new(hash_content).result
+    end
+
+    def current_hash
+      array_of_hashes_of_values_with_keys.shift
+    end
+  end
+
+  class << self
+    def annotate_locales
+      file_names.each do |file_name|
+        FileHandler.new(file_name).call
+      end
+    end
+
+    def file_names
+      Dir.glob(DEFAULT_YML_LOOKUP)
+    end
   end
 
 end

data/lib/annotate_yaml/version.rb

@@ -1,3 +1,3 @@
 module AnnotateYaml
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotate_yaml
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Pierre URBAN
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-10 00:00:00.000000000 Z
+date: 2014-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler