i18n_yaml_sorter 0.1.1 → 0.2.0

data/lib/i18n_yaml_sorter/railtie.rb

@@ -0,0 +1,10 @@
+module I18nYamlSorter
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load "tasks/i18n_yaml_sorter.rake"
+      end
+    end
+  end
+end

data/lib/i18n_yaml_sorter/sorter.rb

@@ -0,0 +1,128 @@
+module I18nYamlSorter
+  class Sorter
+    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 = @read_line_again || @io_input.gets || break
+        @read_line_again = nil
+        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
+            processed_line = content_line.chomp
+            this_indentation = processed_line.match(/^\s*/)[0] rescue ""
+            if indentation.size < this_indentation.size
+              array.last << processed_line.concat("\n")
+            else
+              @read_line_again = content_line
+              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
+    
+      #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_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
+end

data/lib/tasks/i18n_yaml_sorter.rake

@@ -0,0 +1,16 @@
+require 'i18n_yaml_sorter'
+
+namespace :i18n do
+
+  desc "Sort locales keys in alphabetic order. Sort all locales if no path parameter given"
+  
+  task :sort, [:path_to_file] => :environment do |t , args|
+    locales = args[:path_to_file] || Dir.glob("#{Rails.root}/config/locales/**/*.yml")
+
+    locales.each do |locale_path|
+      sorted_contents = File.open(locale_path) { |f| I18nYamlSorter::Sorter.new(f).sort }
+      File.open(locale_path, 'w') { |f|  f << sorted_contents}
+    end
+  end
+  
+end

data/test/helper.rb

@@ -1,8 +1,17 @@
 require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
 require 'test/unit'
+require 'yaml'
 
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'i18n_yaml_sorter'
 
 class Test::Unit::TestCase

data/test/in.yml

@@ -1,4 +1,4 @@
-
+# encoding: UTF-8
 
 m_13: >
   Não deve dar problema aqui!

data/test/in_rails.yml

@@ -0,0 +1,239 @@
+# encoding: UTF-8
+# pt-BR translations for Ruby on Rails
+"pt-BR":
+  date:
+    # formatos de data e hora
+    formats:
+      default: "%d/%m/%Y"
+      short: "%d de %B"
+      long: "%d de %B de %Y"
+
+    day_names:
+      - Domingo
+      - Segunda
+      - Terça
+      - Quarta
+      - Quinta
+      - Sexta
+      - Sábado
+    abbr_day_names:
+      - Dom
+      - Seg
+      - Ter
+      - Qua
+      - Qui
+      - Sex
+      - Sáb
+
+    month_names:
+      - ~
+      - Janeiro
+      - Fevereiro
+      - Março
+      - Abril
+      - Maio
+      - Junho
+      - Julho
+      - Agosto
+      - Setembro
+      - Outubro
+      - Novembro
+      - Dezembro
+    abbr_month_names:
+      - ~
+      - Jan
+      - Fev
+      - Mar
+      - Abr
+      - Mai
+      - Jun
+      - Jul
+      - Ago
+      - Set
+      - Out
+      - Nov
+      - Dez
+    order:
+      - :day
+      - :month
+      - :year
+
+  time:
+    formats:
+      default: "%A, %d de %B de %Y, %H:%M h"
+      short: "%d/%m, %H:%M h"
+      long: "%A, %d de %B de %Y, %H:%M h"
+    am: ''
+    pm: ''
+
+  support:
+    array:
+      # Usado no Array.to_sentence
+      words_connector: ", "
+      two_words_connector: " e "
+      last_word_connector: " e "
+
+    select:
+      prompt: "Por favor selecione"
+
+  number:
+    format:
+      separator: ','
+      delimiter: '.'
+      precision: 3
+      significant: false
+      strip_insignificant_zeros: false
+
+    currency:
+      format:
+        format: '%u %n'
+        unit: 'R$'
+        separator: ','
+        delimiter: '.'
+        precision: 2
+        significant: false
+        strip_insignificant_zeros: false
+
+    percentage:
+      format:
+        delimiter: '.'
+
+    precision:
+      format:
+        delimiter: '.'
+
+    human:
+      format:
+        delimiter: '.'
+        precision: 2
+        significant: true
+        strip_insignificant_zeros: true
+      storage_units:
+        format: "%n %u"
+        units:
+          byte:
+            one: "Byte"
+            other: "Bytes"
+          kb: "KB"
+          mb: "MB"
+          gb: "GB"
+          tb: "TB"
+      decimal_units:
+        # number_to_human()
+        # new in rails 3: please add to other locales
+        format: "%n %u"
+        units:
+          unit: ""
+          thousand: "mil"
+          million:
+            one: milhão
+            other: milhões
+          billion:
+            one: bilhão
+            other: bilhões
+          trillion:
+            one: trilhão
+            other: trilhões
+          quadrillion:
+            one: quatrilhão
+            other: quatrilhões
+
+  datetime:
+    distance_in_words:
+      # distancia do tempo em palavras
+      half_a_minute: 'meio minuto'
+      less_than_x_seconds:
+        one: 'menos de 1 segundo'
+        other: 'menos de %{count} segundos'
+      x_seconds:
+        one: '1 segundo'
+        other: '%{count} segundos'
+      less_than_x_minutes:
+        one: 'menos de um minuto'
+        other: 'menos de %{count} minutos'
+      x_minutes:
+        one: '1 minuto'
+        other: '%{count} minutos'
+      about_x_hours:
+        one: 'aproximadamente 1 hora'
+        other: 'aproximadamente %{count} horas'
+      x_days:
+        one: '1 dia'
+        other: '%{count} dias'
+      about_x_months:
+        one: 'aproximadamente 1 mês'
+        other: 'aproximadamente %{count} meses'
+      x_months:
+        one: '1 mês'
+        other: '%{count} meses'
+      about_x_years:
+        one: 'aproximadamente 1 ano'
+        other: 'aproximadamente %{count} anos'
+      over_x_years:
+        one: 'mais de 1 ano'
+        other: 'mais de %{count} anos'
+      almost_x_years:
+        one: 'quase 1 ano'
+        other: 'quase %{count} anos'
+    prompts:
+      year:   "Ano"
+      month:  "Mês"
+      day:    "Dia"
+      hour:   "Hora"
+      minute: "Minuto"
+      second: "Segundo"
+
+  helpers:
+    select:
+      prompt: "Por favor selecione"
+
+    submit:
+      create: 'Criar %{model}'
+      update: 'Atualizar %{model}'
+      submit: 'Salvar %{model}'
+
+  errors:
+    format: "%{attribute} %{message}"
+
+    template:
+      header:
+        one: "Não foi possível gravar %{model}: 1 erro"
+        other: "Não foi possível gravar %{model}: %{count} erros."
+      body: "Por favor, verifique o(s) seguinte(s) campo(s):"
+
+    messages: &errors_messages
+      inclusion: "não está incluído na lista"
+      exclusion: "não está disponível"
+      invalid: "não é válido"
+      confirmation: "não está de acordo com a confirmação"
+      accepted: "deve ser aceito"
+      empty: "não pode ficar vazio"
+      blank: "não pode ficar em branco"
+      too_long: "é muito longo (máximo: %{count} caracteres)"
+      too_short: "é muito curto (mínimo: %{count} caracteres)"
+      wrong_length: "não possui o tamanho esperado (%{count} caracteres)"
+      not_a_number: "não é um número"
+      not_an_integer: "não é um número inteiro"
+      greater_than: "deve ser maior que %{count}"
+      greater_than_or_equal_to: "deve ser maior ou igual a %{count}"
+      equal_to: "deve ser igual a %{count}"
+      less_than: "deve ser menor que %{count}"
+      less_than_or_equal_to: "deve ser menor ou igual a %{count}"
+      odd: "deve ser ímpar"
+      even: "deve ser par"
+
+  activerecord:
+    errors:
+      template:
+        header:
+          one: "Não foi possível gravar %{model}: 1 erro"
+          other: "Não foi possível gravar %{model}: %{count} erros."
+        body: "Por favor, verifique o(s) seguinte(s) campo(s):"
+
+      messages:
+        taken: "já está em uso"
+        record_invalid: "A validação falhou: %{errors}"
+        <<: *errors_messages
+
+      full_messages:
+        format: "%{attribute} %{message}"

data/test/in_simple.yml

@@ -0,0 +1,28 @@
+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!