i18n_yaml_sorter 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bernardo de Pádua
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,133 @@
+= i18n_yaml_sorter
+
+A simple and very limited yaml deep sorter that will not mess up your strings and text values. Made exclusively to sort the yaml commonly used in rails apps, specially i18n. It will not sort arrays, yaml objects. It doesn't use the YAML parser, since it would mess up text, but sorts the lines in the yaml file
+
+As your rails i18n app grows, it becomes very boring to keep all locale files in sync. You have to care about adding all  keys in the same order, in different files, or you will get yourself into a mess and will lose lots of precious time comparing the files in different locales and looking for the appropriate translation keys whenever you want to change something.
+
+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 ymls will be "standarized" to whatever the YAML generator prefers (strings in double quotes). It will also mess up your indentation (and use its defaults). 
+
+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.
+
+== 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 \"
+      accross 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 \"
+      accross 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.
+
+== Instaling
+
+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+ class.
+
+== Textmate Bundle
+
+Run the Bundle Editor (Bundles > Bundle Editor > Show), and create a new command ( + > New Command ).
+
+Erase the template code and write this command (no more, no less):
+
+    sort_yaml
+
+Add a key binding and a scope selector (source.yaml) if you which. Now, when you run this command, the opened yaml file  (or just the part of it that is selected) will be sorted. To edit selected part of the file, make sure it is valid YAML by itself, or your yaml file might be corrupt (you can always Undo if you mess up).
+
+== Command line
+
++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) and inline help.
+
+== Rake task
+
+If you don't use textmate, it should be trivial to add a rake task to sort all the i18n yaml files of a rails app (eg.: in the dir config/locale/ ), using the +sort_yaml+ command. 
+
+TODO: Write the code here once I have time!
+
+== Future improvements (Forks Welcome!)
+
+* Make +sort_yaml+ smart, take directories, etc
+* Make it a "gem plugin" so it will add rake tasks that will sort all yml files in your +I18n.load_path+ (make it configurable, since we usually don't want to sort all locale yamls, like the rails default ones). 
+* Refactoring: code is still ugly, but works
+* Gather other existing rails i18n related yaml tools, textmate bundles, etc, make a super gem out of it, and rule the world!
+
+== 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 Bernardo de Pádua. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "i18n_yaml_sorter"
+    gem.summary = %Q{ A I18n YAML deep sorter that will keep your locales organized and not screw up your text formating }
+    gem.description = %Q{ Allows you to deep sort YAML files that are mainly composed of 
+      nested hashes and string values. Great to sort your rails I18n YAML files. You can easily
+      add it to a textmate bundle, rake task, or just use the included regular comand line tool. 
+    }
+    gem.email = "berpasan@gmail.com"
+    gem.homepage = "http://github.com/redealumni/i18n_yaml_sorter"
+    gem.authors = ["Bernardo de Pádua"]    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings    
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "i18n_yaml_sorter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/sort_yaml

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'i18n_yaml_sorter'
+
+sorter = I18nYamlSorter.new(STDIN)
+puts sorter.sort

data/i18n_yaml_sorter.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{i18n_yaml_sorter}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bernardo de P\303\241dua"]
+  s.date = %q{2010-03-11}
+  s.default_executable = %q{sort_yaml}
+  s.description = %q{ Allows you to deep sort YAML files that are mainly composed of 
+      nested hashes and string values. Great to sort your rails I18n YAML files. You can easily
+      add it to a textmate bundle, rake task, or just use the included regular comand line tool. 
+    }
+  s.email = %q{berpasan@gmail.com}
+  s.executables = ["sort_yaml"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/sort_yaml",
+     "i18n_yaml_sorter.gemspec",
+     "lib/i18n_yaml_sorter.rb",
+     "test/helper.rb",
+     "test/in.yml",
+     "test/out.yml",
+     "test/test_i18n_yaml_sorter.rb"
+  ]
+  s.homepage = %q{http://github.com/redealumni/i18n_yaml_sorter}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A I18n YAML deep sorter that will keep your locales organized and not screw up your text formating}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_i18n_yaml_sorter.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/i18n_yaml_sorter.rb

@@ -0,0 +1,124 @@
+class I18nYamlSorter
+
+  def initialize(io_input)
+    @io_input = io_input
+  end
+
+  def sort
+    @array = break_blocks_into_array
+    @current_array_index = 0
+    sorted_yaml_from_blocks_array
+  end
+  
+  private
+  
+  def break_blocks_into_array
+    array = []
+  
+    loop do
+    
+      maybe_next_line = @io_input.gets || break
+      maybe_next_line.chomp!
+
+      #Is it blank? Discard!
+      next if maybe_next_line.match(/^\s*$/)
+
+      #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 
+        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)      
+      
+          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 
+    
+      # Is it a | or > string alue?
+      is_special_string = maybe_next_line.match(/^(\s*)(["']?[\w\-]+["']?)(: )(\s*)([|>])(\s*)$/)
+      if is_special_string
+        array << maybe_next_line.concat("\n")  #yes, it is the beginning of a key block
+        indentation = is_special_string[1]
+        #Append the next lines until we find one that is not indented
+        loop do
+          content_line = @io_input.gets || break
+          content_line.chomp!
+          this_indentation = content_line.match(/^\s*/)[0] rescue ""
+          if indentation.size < this_indentation.size
+            array.last << content_line.concat("\n")
+          else
+            @io_input.seek(-content_line.size, IO::SEEK_CUR) #returns so we can read this line again
+            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*)$/)
+      if is_start_of_hash
+        array << maybe_next_line.concat("\n")
+        next
+      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")
+      else
+        array << maybe_next_line.concat("\n")
+      end
+    end  #loop
+  
+    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_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_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
+        out_array << [current_key, next_block]
+      elsif current_level.size > next_level.size
+        @current_array_index -= 1
+        break
+      end
+    end
+  
+    return out_array.sort.map(&:last).join
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'i18n_yaml_sorter'
+
+class Test::Unit::TestCase
+end

data/test/in.yml

@@ -0,0 +1,44 @@
+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"
+      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!
+h_eight: "Jonivildo"

data/test/out.yml

@@ -0,0 +1,44 @@
+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.
+    
+ d_four: "Somos chatos
+    gostamos de várias linhas\"
+    e ainda usamos escaping 
+    para fuder"
+  c_three:
+      a: "Marcelo"
+      "b": Bernardo
+      c_3:
+          klass: Lucas
+          unify: Luiz
+      d_4: Rafael
+      # Comentário de muitas
+      # linhas (goes with d_4)
+  e_five: Prefirimos strings sem
+    nenhum tipo de especificação.
+  f_six: Dalton
+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

data/test/test_i18n_yaml_sorter.rb

@@ -0,0 +1,19 @@
+require 'helper'
+
+class TestI18nYamlSorter < Test::Unit::TestCase
+  def test_should_sort_complex_sample_file
+    open('in.yml') do |file|
+      sorter = I18nYamlSorter.new(file)
+      open('out.yml') do |expected_out|
+        assert_equal sorter.sort, expected_out.read
+      end
+    end
+  end
+  
+  def test_command_line_should_work_in_stdin
+    output = `../bin/sort_yaml < in.yml`
+    open('out.yml') do |expected_out|
+      assert_equal output, expected_out.read
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: i18n_yaml_sorter
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Bernardo de P\xC3\xA1dua"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-11 00:00:00 -03:00
+default_executable: sort_yaml
+dependencies: []
+
+description: " Allows you to deep sort YAML files that are mainly composed of \n      nested hashes and string values. Great to sort your rails I18n YAML files. You can easily\n      add it to a textmate bundle, rake task, or just use the included regular comand line tool. \n    "
+email: berpasan@gmail.com
+executables: 
+- sort_yaml
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/sort_yaml
+- i18n_yaml_sorter.gemspec
+- lib/i18n_yaml_sorter.rb
+- test/helper.rb
+- test/in.yml
+- test/out.yml
+- test/test_i18n_yaml_sorter.rb
+has_rdoc: true
+homepage: http://github.com/redealumni/i18n_yaml_sorter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A I18n YAML deep sorter that will keep your locales organized and not screw up your text formating
+test_files: 
+- test/helper.rb
+- test/test_i18n_yaml_sorter.rb