i18n_yaml_sorter_2 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a0a54edc695b8e56d660aedabd8cb1de73ae762
-  data.tar.gz: 738ddde845a5317d85e76e7368714e8f92c817be
+  metadata.gz: dabdfcfde3af00bec4db5273ca3feaf0ca76ee04
+  data.tar.gz: decc4727fecc6f94ccc7c853f20fc6b7fee93d48
 SHA512:
-  metadata.gz: 1bf9971d390c1f649c30df4f3014fd93ca3b957886f083ede993b75220420cdeb645dc65a317f11962c540a8e1ad94215445278f25ce540923a1c39bfbc772ef
-  data.tar.gz: 3ab295f0185e37fafa2070c2eb05f9000ce59b7288b4d61677fc54439d133a28627445fa76c0666266a08ba06bf61e3727aba013f30ef76a392e40c6bc1b401f
+  metadata.gz: d94cc79a5073493ace8019cd8e5a97b2a72b978ff8a7c4d486d1268b965a63d26295061d977372bc547636d11b029238d70e2fa15c336f42c1fd00c3dc32e7ca
+  data.tar.gz: 1a2c0dc543663bb18e26099767d2ba3f99259a0200d318f97751f8660a7779c20acae5ed11292595845574745d36eca59e3115b3556445cac8be80961630dc8d

data/README.md

@@ -0,0 +1,261 @@
+# i18n_yaml_sorter
+
+A simple YAML Hash deep sorter that will not mess with the way your strings
+and text values were written. Made exclusively to sort the YAML Hash keys
+commonly used in the i18n gem and Rails' apps. It will not sort arrays, YAML
+objects, etc.
+
+It doesn't parse the YAML and dumps it again, it just sorts the lines, it's
+pure and simple magic! That way, it guarantees you can keep using your nice
+YAML constructs to create large text values, as we usually do in i18n files.
+
+It includes a simple TextMate bundle and a rake task for Rails, so you can
+keep all those .yml files sorted in no time.
+
+## Motivation
+
+As your rails i18n app grows, it becomes very boring to keep all locale files
+in sync. You have to add all keys in the same order, in different languages,
+or you will get yourself into a mess and will lose precious time comparing the
+files in different locales and looking for the appropriate translation keys
+whenever you want to change something or see if a key is missing.
+
+If you try deserializing/serializing the yml files using the YAML parser, to
+get them in the same order, you will figure that your strings in the YAMLs
+will be "standarized" to whatever the YAML generator prefers (eg.: strings in
+double quotes, character escapes, etc). It will also mess up your indentation
+(and use its defaults) and remove your comments. 
+
+i18n_yaml_sorter to the rescue! Add it to TextMate and you will be able to
+sort your yaml file in nanoseconds. Your file will look pristine, like it was
+human edited. 
+
+Tested in ruby-1.8.7-p334 and ruby-1.9.2-p290, should work everywhere since it
+is so simple. Rake task works in Rails 3.1, not sure about older versions
+though (patch updates are welcome, if you find it doesn't). 
+
+## Simple Example
+This: 
+
+    pt-BR:
+      # Note how this is a nice way of inputing
+      # paragraphs of text in YAML. 
+      apples: >
+        Maçãs são boas,
+        só não coma 
+        seus iPods!
+      grapes: Não comemos elas.
+      bananas: |
+        Bananas são "legais":
+          - Elas são <b> doces </b>.
+          isto: não é chave
+
+        Por isto todos gostam de bananas!
+    en-US:
+      # Note that our comments are important:
+      # Don't let your yaml sorter delete them!
+      grapes: We dont' eat them.
+      bananas: |
+        Bananas are "nice":
+          - They are <b> sweet </b>.
+          this: not a key  
+
+        That is why everyone like bananas!
+      apples: >
+        Apples are fine,
+        just don't eat your 
+        iPods!
+
+Becomes:
+
+    en-US:
+      # Note that our comments are important:
+      # Don't let your yaml sorter delete them!
+      apples: >
+        Apples are fine,
+        just don't eat your 
+        iPods!
+      bananas: |
+        Bananas are "nice":
+          - They are <b> sweet </b>.
+          this: not a key  
+
+        That is why everyone like bananas!
+      grapes: We dont' eat them.
+    pt-BR:
+      # Note how this is a nice way of inputing
+      # paragraphs of text in YAML. 
+      apples: >
+        Maçãs são boas,
+        só não coma 
+        seus iPods!
+      bananas: |
+        Bananas são "legais":
+          - Elas são <b> doces </b>.
+          isto: não é chave
+
+        Por isto todos gostam de bananas!
+      grapes: Não comemos elas.
+
+What if you use some method that employ's Ruby's YAML library to help do the
+task for you? You would get an output like that (note it removes your
+comments):
+
+    en-US: 
+      apples: Apples are fine, just don't eat your  iPods!
+      bananas: |
+        Bananas are "nice":
+          - They are <b> sweet </b>.
+          this: not a key  
+
+        That is why everyone like bananas!
+
+      grapes: We dont' eat them.
+    pt-BR: 
+      apples: "Ma\xC3\xA7\xC3\xA3s s\xC3\xA3o boas, s\xC3\xB3 n\xC3\xA3o coma  seus iPods!\n"
+      bananas: "Bananas s\xC3\xA3o \"legais\":\n  - Elas s\xC3\xA3o <b> doces </b>.\n  isto: n\xC3\xA3o \xC3\xA9 chave\n\n\
+        Por isto todos gostam de bananas!\n"
+      grapes: "N\xC3\xA3o comemos elas."
+
+## More complex example
+
+This:
+
+    b_two:
+      a_1: Simple most common text
+      b_two: |
+        This is the best way of
+        inputing large chunks of text
+        in the YAML files.
+
+        Note that this format keeps blank
+        lines in the same indentation.
+      d_four: "We can also 
+        use the boring \"
+        across multiple lines 
+        but have to escape then."
+      e_five: Or you can do it 
+        like that as well, it also works.
+      c_three:
+          a: "Marcelo"
+          d_4: Rafael
+          # Your comments will be untouched
+          # but will be bound to the element
+          # on top of them (d_4 here).
+          "b": Bernardo
+          c_3:
+              unify: Luiz
+              klass: Lucas
+    a_one: > 
+      This is another way 
+      of inputing text. It
+      will squish whitespace
+      when deserialized
+      (like HTML does).
+
+Becomes:
+
+    a_one: > 
+      This is another way 
+      of inputing text. It
+      will squish whitespace
+      when deserialized
+      (like HTML does).
+    b_two:
+      a_1: Simple most common text
+      b_two: |
+        This is the best way of
+        inputing large chunks of text
+        in the YAML files.
+
+        Note that this format keeps blank
+        lines in the same indentation.
+     d_four: "We can also 
+        use the boring \"
+        across multiple lines 
+        but have to escape then."
+      c_three:
+          a: "Marcelo"
+          "b": Bernardo
+          c_3:
+              klass: Lucas
+              unify: Luiz
+          d_4: Rafael
+          # Your comments will be untouched
+          # but will be bound to the element
+          # on top of them (d_4 here).
+      e_five: Or you can do it 
+        like that as well, it also works.
+
+## Installing
+
+Easy, just install the gem:
+
+    $ gem install i18n_yaml_sorter
+
+Then the `sort_yaml` command line tool will be available. If you prefer using
+Ruby (in your rakes, etc), use the simple `I18nYamlSorter::Sort` class.
+
+## Textmate Bundle
+
+Run this command in the Terminal to install it:
+
+    $ sort_yaml -i
+
+A TextMate bundle, named "Yaml Sort" will be installed in your user home path.
+Press "Shift+Command+S" or use the Bundles menu to invoke it. The opened yaml
+file  (or just the part of it that is selected) will be sorted. To edit the
+selected part of the file, make sure it is valid YAML by itself, or your yaml
+file might be corrupted (you can always Undo if you mess up).
+
+## Rails Rake Taks
+
+Declare it as a dependency in your app Gemfile, under the development group:
+
+    gem 'i18n_yaml_sorter', :group => :development
+
+Run bundle install under your Rails' app:
+
+    $ bundle install
+
+Now run the rake task under your Rails' app to sort all the i18n files in your
+`config/locales` dir:
+
+    $rake i18n:sort
+
+## Command line Input / Output
+
+`sort_yaml` will operate on STDIN and STDOUT, so sorting an existing yaml file
+should be as easy as:
+
+    $ sort_yaml < in.yml > out.yml
+
+TODO: Add command line arguments parsing and options, so you can, for
+instance, sort a whole dir of yaml files.
+
+## Development
+
+    $rake spec # run tests
+    $rake release # build installable/publishable gem
+
+## Future improvements (Forks Welcome!)
+
+*   Make `sort_yaml` smart, take directories, etc
+*   Refactoring: internal code is still a bit ugly, but works
+
+
+## Note on Patches/Pull Requests
+
+*   Fork the project.
+*   Make your feature addition or bug fix.
+*   Add tests for it. This is important so I don't break it in a future
+    version unintentionally.
+*   Commit, do not mess with rakefile, version, or history. (if you want to
+    have your own version, that is fine but bump version in a commit by itself
+    I can ignore when I pull)
+*   Send me a pull request. Bonus points for topic branches.
+
+
+## Copyright
+
+Copyright (c) 2010-2011 Bernardo de Pádua. MIT License (See LICENCE).

data/lib/i18n_yaml_sorter/sorter.rb

@@ -9,14 +9,14 @@ module I18nYamlSorter
       @current_array_index = 0
       sorted_yaml_from_blocks_array
     end
-  
+
     private
-  
+
     def break_blocks_into_array
       array = []
-  
+
       loop do
-    
+
         maybe_next_line = @read_line_again || @io_input.gets || break
         @read_line_again = nil
         maybe_next_line.chomp!
@@ -26,28 +26,28 @@ module I18nYamlSorter
 
         #Does it look like a key: value line?
         key_value_parse = maybe_next_line.match(/^(\s*)(["']?[\w\-]+["']?)(: )(\s*)(\S.*\S)(\s*)$/)
-        if  key_value_parse 
+        if  key_value_parse
           array << maybe_next_line.concat("\n")  #yes, it is the beginning of a key:value block
-    
+
           #Special cases when it should add extra lines to the array element (multi line quoted strings)
-    
+
           #Is the value surrounded by quotes?
           starts_with_quote = key_value_parse[5].match(/^["']/)[0] rescue nil
           ends_with_quote = key_value_parse[5].match(/[^\\](["'])$/)[1] rescue nil
-          if starts_with_quote and !(starts_with_quote == ends_with_quote)      
-      
+          if starts_with_quote and !(starts_with_quote == ends_with_quote)
+
             loop do #Append next lines until we find the closing quote
               content_line = @io_input.gets || break
               content_line.chomp!
               array.last << content_line.concat("\n")
               break if content_line.match(/[^\\][#{starts_with_quote}]\s*$/)
             end
-      
+
           end #  if starts_with_quote
-      
+
           next
-        end # if  key_value_parse 
-    
+        end # if  key_value_parse
+
         # Is it a | or > string alue?
         is_special_string = maybe_next_line.match(/^(\s*)(["']?[\w\-]+["']?)(: )(\s*)([|>])(\s*)$/)
         if is_special_string
@@ -65,18 +65,18 @@ module I18nYamlSorter
               break
             end
           end
-      
+
           next
         end #if is_special_string
-    
+
         # Is it the begining of a multi level hash?
-        is_start_of_hash = maybe_next_line.match(/^(\s*)(["']?[\w\-]+["']?)(:)(\s*)$/)
+        is_start_of_hash = maybe_next_line.match(/^(\s*)(["']?[\w\W\-]+["']?)(:)(\s*)$/)
         if is_start_of_hash
           array << maybe_next_line.concat("\n")
           next
-        end 
-    
-        #If we got here and nothing was done, this line 
+        end
+
+        #If we got here and nothing was done, this line
         # should probably be merged with the previous one.
         if array.last
           array.last << maybe_next_line.concat("\n")
@@ -84,34 +84,31 @@ module I18nYamlSorter
           array << maybe_next_line.concat("\n")
         end
       end  #loop
-    
-      #debug:
-      #puts array.join("$$$$$$$$$$$$$$$$$$$$$$\n")
-    
+
       array
     end
 
     def sorted_yaml_from_blocks_array(current_block = nil)
-  
+
       unless current_block
         current_block = @array[@current_array_index]
         @current_array_index += 1
       end
-  
+
       out_array = []
-      current_match = current_block.match(/^(\s*)(["']?[\w\-]+["']?)(:)/)
+      current_match = current_block.match(/^(\s*)(["']?[\w\W\-]+["']?)(:)/)
       current_level = current_match[1] rescue ''
       current_key = current_match[2].downcase.tr(%q{"'}, "") rescue ''
       out_array << [current_key, current_block]
-  
+
       loop do
         next_block = @array[@current_array_index] || break
         @current_array_index += 1
-    
-        current_match = next_block.match(/^(\s*)(["']?[\w\-]+["']?)(:)/) || next
+
+        current_match = next_block.match(/^(\s*)(["']?[\w\W\-]+["']?)(:)/) || next
         current_key = current_match[2].downcase.tr(%q{"'}, "")
         next_level = current_match[1]
-    
+
         if current_level.size < next_level.size
           out_array.last.last << sorted_yaml_from_blocks_array(next_block)
         elsif current_level.size == next_level.size
@@ -121,8 +118,8 @@ module I18nYamlSorter
           break
         end
       end
-  
+
       return out_array.sort.map(&:last).join
     end
   end
-end
+end

data/lib/i18n_yaml_sorter/version.rb

@@ -1,3 +1,3 @@
 module I18nYamlSorter
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/spec/i18n_yaml_sorter_spec.rb

@@ -45,4 +45,13 @@ describe I18nYamlSorter do
       expect(expected_out.read).to eq(output)
     end
   end
+
+  it 'test_should_sort_complex_sample_file_with_special_characters' do
+    open(File.dirname(__FILE__) + '/in_W.yml') do |file|
+      sorter = I18nYamlSorter::Sorter.new(file)
+      open(File.dirname(__FILE__) + '/out_W.yml') do |expected_out|
+        expect(expected_out.read).to eq(sorter.sort)
+      end
+    end
+  end
 end

data/spec/in.yml

@@ -1,15 +1,5 @@
 # encoding: UTF-8
-
-m_13: >
-  Não deve dar problema aqui!
-  Não deve dar problema aqui!
-  Não deve dar problema aqui!
-  Pois às vezes dá.
-
-o_15: |
-  Não deve dar problema aqui!
-  Pois às vezes dá.
-
+a_one: José   # Comentado
 b_two:
   a_1: Joãozinho
   b_two: |
@@ -17,50 +7,53 @@ b_two:
     por exemplo: João,
     que: gosta de nos dar milhões
     em dinheiro todos os dias.
-
     Linhas em Branco com tabulação
     nos strings devem ser preservadas.
-
+  c_three:
+      a: "Marcelo"
+      "b": Bernardo
+      c_3:
+          klass: Lucas
+          unify: Luiz
+      d_4: Rafael
+      # Comentário de muitas
+      # linhas (goes with d_4)
   d_four: "Somos chatos
     gostamos de várias linhas\"
     e ainda usamos escaping
     para fuder"
   e_five: Prefirimos strings sem
     nenhum tipo de especificação.
-  c_three:
-      a: "Marcelo"
-      d_4: Rafael
-      # Comentário de muitas
-      # linhas (goes with d_4)
-      "b": Bernardo
-      c_3:
-          unify: Luiz
-          klass: Lucas
   f_six: Dalton
-a_one: José   # Comentado
 c_three: Gustavo
 # Comentário (goes with c_three)
-f_six: Thiago
+d_four: Oliveira
 e_five:
-  b_two: Catarina
   a_one: Rodrigo
   # Comentário (goes with a_one)
+  b_two: Catarina
+f_six: Thiago
 "g-seven": Marcelo
-d_four: Oliveira
-k_eleven: Ronaldo
-"l_other123123": Emilio
-
+h_eight: "Jonivildo"
 i_nine: Prestes
-
 j_ten: >
   Pior quando resolvemos escrever
   assim, impossível aturar!
+k_eleven: Ronaldo
+"l_other123123": Emilio
+m_13: >
+  Não deve dar problema aqui!
+  Não deve dar problema aqui!
+  Não deve dar problema aqui!
+  Pois às vezes dá.
 n_14: >
   Não deve dar problema aqui!
   Pois às vezes dá.
 o_15: |
   Não deve dar problema aqui!
   Pois às vezes dá.
+o_15: |
+  Não deve dar problema aqui!
+  Pois às vezes dá.
 p_16: Não deve dar problema aqui!
   Pois às vezes dá.
-h_eight: "Jonivildo"

data/spec/in_W.yml

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+
+m_13: >
+  Não deve dar problema aqui!
+  Não deve dar problema aqui!
+  Não deve dar problema aqui!
+  Pois às vezes dá.
+
+o_15: |
+  Não deve dar problema aqui!
+  Pois às vezes dá.
+
+b_(two)²:
+  a_1: Joãozinho
+  b_two: |
+    Nos somos legais, como
+    por exemplo: João,
+    que: gosta de nos dar milhões
+    em dinheiro todos os dias.
+    Linhas em Branco com tabulação
+    nos strings devem ser preservadas.
+  d_four: "Somos chatos
+    gostamos de várias linhas\"
+    e ainda usamos escaping
+    para fuder"
+  e_five: Prefirimos strings sem
+    nenhum tipo de especificação.
+  c_three:
+      a: "Marcelo"
+  g_se/ ven:
+      d_4: Rafael
+      # Comentário de muitas
+      # linhas (goes with d_4)
+      "b": Bernardo
+      c_3:
+          unify: Luiz
+          klass: Lucas
+  f_six: Dalton
+a_one: José   # Comentado
+c_three: Gustavo
+# Comentário (goes with c_three)
+f_six: Thiago
+e_five:
+  b_two: Catarina
+  a_one: Rodrigo
+  # Comentário (goes with a_one)
+"g-seven": Marcelo
+d_four: Oliveira
+k_eleven: Ronaldo
+"l_other123123": Emilio
+
+i_nine: Prestes
+
+j_ten: >
+  Pior quando resolvemos escrever
+  assim, impossível aturar!
+n_14: >
+  Não deve dar problema aqui!
+  Pois às vezes dá.
+o_15: |
+  Não deve dar problema aqui!
+  Pois às vezes dá.
+p_16: Não deve dar problema aqui!
+  Pois às vezes dá.
+h_eight: "Jonivildo"

data/spec/out.yml

@@ -7,10 +7,8 @@ b_two:
     por exemplo: João,
     que: gosta de nos dar milhões
     em dinheiro todos os dias.
-
     Linhas em Branco com tabulação
     nos strings devem ser preservadas.
-
   c_three:
       a: "Marcelo"
       "b": Bernardo

data/spec/out_W.yml

@@ -0,0 +1,60 @@
+# encoding: UTF-8
+a_one: José   # Comentado
+b_(two)²:
+  a_1: Joãozinho
+  b_two: |
+    Nos somos legais, como
+    por exemplo: João,
+    que: gosta de nos dar milhões
+    em dinheiro todos os dias.
+    Linhas em Branco com tabulação
+    nos strings devem ser preservadas.
+  c_three:
+      a: "Marcelo"
+  d_four: "Somos chatos
+    gostamos de várias linhas\"
+    e ainda usamos escaping
+    para fuder"
+  e_five: Prefirimos strings sem
+    nenhum tipo de especificação.
+  f_six: Dalton
+  g_se/ ven:
+      "b": Bernardo
+      c_3:
+          klass: Lucas
+          unify: Luiz
+      d_4: Rafael
+      # Comentário de muitas
+      # linhas (goes with d_4)
+c_three: Gustavo
+# Comentário (goes with c_three)
+d_four: Oliveira
+e_five:
+  a_one: Rodrigo
+  # Comentário (goes with a_one)
+  b_two: Catarina
+f_six: Thiago
+"g-seven": Marcelo
+h_eight: "Jonivildo"
+i_nine: Prestes
+j_ten: >
+  Pior quando resolvemos escrever
+  assim, impossível aturar!
+k_eleven: Ronaldo
+"l_other123123": Emilio
+m_13: >
+  Não deve dar problema aqui!
+  Não deve dar problema aqui!
+  Não deve dar problema aqui!
+  Pois às vezes dá.
+n_14: >
+  Não deve dar problema aqui!
+  Pois às vezes dá.
+o_15: |
+  Não deve dar problema aqui!
+  Pois às vezes dá.
+o_15: |
+  Não deve dar problema aqui!
+  Pois às vezes dá.
+p_16: Não deve dar problema aqui!
+  Pois às vezes dá.

data/spec/out_simple.yml

@@ -9,7 +9,6 @@ en-US:
     Bananas are "nice":
       - They are <b> sweet </b>.
       this: not a key
-
     That is why everyone like bananas!
   grapes: We dont' eat them.
 pt-BR:
@@ -23,6 +22,5 @@ pt-BR:
     Bananas são "legais":
       - Elas são <b> doces </b>.
       isto: não é chave
-
     Por isto todos gostam de bananas!
   grapes: Não comemos elas.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n_yaml_sorter_2
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Bernardo de Pádua
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2018-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - bin/sort_yaml
 - lib/i18n_yaml_sorter.rb
@@ -77,13 +77,14 @@ files:
 - spec/helper.rb
 - spec/i18n_yaml_sorter_spec.rb
 - spec/in.yml
+- spec/in_W.yml
 - spec/in_rails.yml
 - spec/in_simple.yml
 - spec/out.yml
+- spec/out_W.yml
 - spec/out_rails.yml
 - spec/out_simple.yml
 - spec/spec_helper.rb
-- spec/test_i18n_yaml_sorter.rb
 homepage: https://github.com/compwron/i18n_yaml_sorter
 licenses:
 - MIT

data/README.rdoc

@@ -1,236 +0,0 @@
-= i18n_yaml_sorter
-
-
-A simple YAML Hash deep sorter that will not mess with the way your strings and text values were written. Made exclusively to sort the YAML Hash keys commonly used in the i18n gem and Rails' apps. It will not sort arrays, YAML objects, etc.
-
-It doesn't parse the YAML and dumps it again, it just sorts the lines, it's pure and simple magic! That way, it guarantees you can keep using your nice YAML constructs to create large text values, as we usually do in i18n files.
-
-It includes a simple TextMate bundle and a rake task for Rails, so you can keep all those .yml files sorted in no time.
-
-== Motivation
-
-As your rails i18n app grows, it becomes very boring to keep all locale files in sync. You have to add all keys in the same order, in different languages, or you will get yourself into a mess and will lose precious time comparing the files in different locales and looking for the appropriate translation keys whenever you want to change something or see if a key is missing.
-
-If you try deserializing/serializing the yml files using the YAML parser, to get them in the same order, you will figure that your strings in the YAMLs will be "standarized" to whatever the YAML generator prefers (eg.: strings in double quotes, character escapes, etc). It will also mess up your indentation (and use its defaults) and remove your comments. 
-
-i18n_yaml_sorter to the rescue! Add it to TextMate and you will be able to sort your yaml file in nanoseconds. Your file will look pristine, like it was human edited. 
-
-Tested in ruby-1.8.7-p334 and ruby-1.9.2-p290, should work everywhere since it is so simple. Rake task works in Rails 3.1, not sure about older versions though (patch updates are welcome, if you find it doesn't). 
-
-== Simple Example
-This: 
-
-  pt-BR:
-    # Note how this is a nice way of inputing
-    # paragraphs of text in YAML. 
-    apples: >
-      Maçãs são boas,
-      só não coma 
-      seus iPods!
-    grapes: Não comemos elas.
-    bananas: |
-      Bananas são "legais":
-        - Elas são <b> doces </b>.
-        isto: não é chave
-    
-      Por isto todos gostam de bananas!
-  en-US:
-    # Note that our comments are important:
-    # Don't let your yaml sorter delete them!
-    grapes: We dont' eat them.
-    bananas: |
-      Bananas are "nice":
-        - They are <b> sweet </b>.
-        this: not a key  
-    
-      That is why everyone like bananas!
-    apples: >
-      Apples are fine,
-      just don't eat your 
-      iPods!
-
-          
-Becomes:
-
-  en-US:
-    # Note that our comments are important:
-    # Don't let your yaml sorter delete them!
-    apples: >
-      Apples are fine,
-      just don't eat your 
-      iPods!
-    bananas: |
-      Bananas are "nice":
-        - They are <b> sweet </b>.
-        this: not a key  
-    
-      That is why everyone like bananas!
-    grapes: We dont' eat them.
-  pt-BR:
-    # Note how this is a nice way of inputing
-    # paragraphs of text in YAML. 
-    apples: >
-      Maçãs são boas,
-      só não coma 
-      seus iPods!
-    bananas: |
-      Bananas são "legais":
-        - Elas são <b> doces </b>.
-        isto: não é chave
-    
-      Por isto todos gostam de bananas!
-    grapes: Não comemos elas.
-
-      
-What if you use some method that employ's Ruby's YAML library to help
-do the task for you? You would get an output like that (note it removes your comments):
-
-  en-US: 
-    apples: Apples are fine, just don't eat your  iPods!
-    bananas: |
-      Bananas are "nice":
-        - They are <b> sweet </b>.
-        this: not a key  
-    
-      That is why everyone like bananas!
-
-    grapes: We dont' eat them.
-  pt-BR: 
-    apples: "Ma\xC3\xA7\xC3\xA3s s\xC3\xA3o boas, s\xC3\xB3 n\xC3\xA3o coma  seus iPods!\n"
-    bananas: "Bananas s\xC3\xA3o \"legais\":\n  - Elas s\xC3\xA3o <b> doces </b>.\n  isto: n\xC3\xA3o \xC3\xA9 chave\n\n\
-      Por isto todos gostam de bananas!\n"
-    grapes: "N\xC3\xA3o comemos elas."
-
-
-== More complex example
-
-This:
-
-  b_two:
-    a_1: Simple most common text
-    b_two: |
-      This is the best way of
-      inputing large chunks of text
-      in the YAML files.
-    
-      Note that this format keeps blank
-      lines in the same indentation.
-    d_four: "We can also 
-      use the boring \"
-      across multiple lines 
-      but have to escape then."
-    e_five: Or you can do it 
-      like that as well, it also works.
-    c_three:
-        a: "Marcelo"
-        d_4: Rafael
-        # Your comments will be untouched
-        # but will be bound to the element
-        # on top of them (d_4 here).
-        "b": Bernardo
-        c_3:
-            unify: Luiz
-            klass: Lucas
-  a_one: > 
-    This is another way 
-    of inputing text. It
-    will squish whitespace
-    when deserialized
-    (like HTML does).
-
-
-Becomes:
-
-  a_one: > 
-    This is another way 
-    of inputing text. It
-    will squish whitespace
-    when deserialized
-    (like HTML does).
-  b_two:
-    a_1: Simple most common text
-    b_two: |
-      This is the best way of
-      inputing large chunks of text
-      in the YAML files.
-
-      Note that this format keeps blank
-      lines in the same indentation.
-   d_four: "We can also 
-      use the boring \"
-      across multiple lines 
-      but have to escape then."
-    c_three:
-        a: "Marcelo"
-        "b": Bernardo
-        c_3:
-            klass: Lucas
-            unify: Luiz
-        d_4: Rafael
-        # Your comments will be untouched
-        # but will be bound to the element
-        # on top of them (d_4 here).
-    e_five: Or you can do it 
-      like that as well, it also works.
-
-== Installing
-
-Easy, just install the gem:
-
-    $ gem install i18n_yaml_sorter
-
-Then the +sort_yaml+ command line tool will be available. If you prefer using Ruby (in your rakes, etc), use the simple +I18nYamlSorter::Sort+ class.
-
-== Textmate Bundle
-
-Run this command in the Terminal to install it:
-
-  $ sort_yaml -i
-
-A TextMate bundle, named "Yaml Sort" will be installed in your user home path. Press "Shift+Command+S" or use the Bundles menu to invoke it. The opened yaml file  (or just the part of it that is selected) will be sorted. To edit the selected part of the file, make sure it is valid YAML by itself, or your yaml file might be corrupted (you can always Undo if you mess up).
-
-== Rails Rake Taks
-
-Declare it as a dependency in your app Gemfile, under the development group:
-
-  gem 'i18n_yaml_sorter', :group => :development
-
-Run bundle install under your Rails' app:
-
-  $ bundle install
-  
-Now run the rake task under your Rails' app to sort all the i18n files in your +config/locales+ dir:
-  
-  $rake i18n:sort
-
-== Command line Input / Output
-
-+sort_yaml+ will operate on STDIN and STDOUT, so sorting an existing yaml file should be as easy as:
-
-    $ sort_yaml < in.yml > out.yml
-
-TODO: Add command line arguments parsing and options, so you can, for instance, sort a whole dir of yaml files.
-
-== Development
-
-  $rake spec # run tests
-  $rake release # build installable/publishable gem
-
-== Future improvements (Forks Welcome!)
-
-* Make +sort_yaml+ smart, take directories, etc
-* Refactoring: internal code is still a bit ugly, but works
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010-2011 Bernardo de Pádua. MIT License (See LICENCE).

data/spec/test_i18n_yaml_sorter.rb

@@ -1,48 +0,0 @@
-require File.dirname(__FILE__) + '/helper'
-
-class TestI18nYamlSorter < Test::Unit::TestCase
-  def test_should_sort_complex_sample_file
-    open(File.dirname(__FILE__) + '/in.yml') do |file|
-      sorter = I18nYamlSorter::Sorter.new(file)
-      open(File.dirname(__FILE__) + '/out.yml') do |expected_out|
-        assert_equal expected_out.read, sorter.sort
-      end
-    end
-  end
-
-  def test_should_rails_i18n_default_file
-    open(File.dirname(__FILE__) + '/in_rails.yml') do |file|
-      sorter = I18nYamlSorter::Sorter.new(file)
-      open(File.dirname(__FILE__) + '/out_rails.yml') do |expected_out|
-        assert_equal expected_out.read, sorter.sort
-      end
-    end
-  end
-
-  def test_should_sort_simple_text_file
-    open(File.dirname(__FILE__) + '/in_simple.yml') do |file|
-      sorter = I18nYamlSorter::Sorter.new(file)
-      open(File.dirname(__FILE__) + '/out_simple.yml') do |expected_out|
-        assert_equal expected_out.read, sorter.sort
-      end
-    end
-  end
-
-  def test_should_not_alter_the_serialized_yaml
-    #ordering should'n t change a thing, since hashes don't have order in Ruby
-    open(File.dirname(__FILE__) + '/in.yml') do |file|
-      sorter = I18nYamlSorter::Sorter.new(file)
-      present = YAML::load(file.read)
-      file.rewind
-      future = YAML::load(sorter.sort)
-      assert_equal present, future
-    end
-  end
-
-  def test_command_line_should_work_in_stdin
-    output = `#{File.dirname(__FILE__)}/../bin/sort_yaml < #{File.dirname(__FILE__)}/in.yml`
-    open(File.dirname(__FILE__) +  '/out.yml') do |expected_out|
-      assert_equal expected_out.read, output
-    end
-  end
-end