i18n_yaml_sorter 0.1.1 → 0.2.0

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+# gem 'mechanize'
+
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2.2)
+    rcov (0.9.11)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Bernardo de Pádua
+Copyright (c) 2010-2011 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

data/README.rdoc

@@ -1,14 +1,108 @@
 = 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.
+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.
 
-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). 
+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.
 
-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.
+It includes a simple TextMate bundle and a rake task for Rails, so you can keep all those .yml files sorted in no time.
 
-== Example
+== 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:
 
@@ -23,7 +117,7 @@ This:
       lines in the same indentation.
     d_four: "We can also 
       use the boring \"
-      accross multiple lines 
+      across multiple lines 
       but have to escape then."
     e_five: Or you can do it 
       like that as well, it also works.
@@ -64,7 +158,7 @@ Becomes:
       lines in the same indentation.
    d_four: "We can also 
       use the boring \"
-      accross multiple lines 
+      across multiple lines 
       but have to escape then."
     c_three:
         a: "Marcelo"
@@ -79,44 +173,53 @@ Becomes:
     e_five: Or you can do it 
       like that as well, it also works.
 
-== Instaling
+== 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+ class.
+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 the Bundle Editor (Bundles > Bundle Editor > Show), and create a new command ( + > New Command ).
+Run this command in the Terminal to install it:
 
-Erase the template code and write this command (no more, no less):
+  $ sort_yaml -i
 
-    sort_yaml
+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).
 
-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).
+== Rails Rake Taks
 
-== Command line
+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) and inline help.
-
-== Rake task
+TODO: Add command line arguments parsing and options, so you can, for instance, sort a whole dir of yaml files.
 
-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. 
+== Changelog
 
-TODO: Write the code here once I have time!
+* 0.2 - Improves gem, tests, adds TextMate Bundle, adds Rails' Rake task.
+* 0.1 - Initial release
 
 == 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!
+* Refactoring: internal code is still a bit ugly, but works
 
 == Note on Patches/Pull Requests
  
@@ -130,4 +233,4 @@ TODO: Write the code here once I have time!
 
 == Copyright
 
-Copyright (c) 2010 Bernardo de Pádua. See LICENSE for details.
+Copyright (c) 2010-2011 Bernardo de Pádua. MIT License (See LICENCE).

data/Rakefile

@@ -1,10 +1,21 @@
+# encoding: utf-8
+
 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 'rake'
 
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "i18n_yaml_sorter"
+    gem.license = "MIT"
     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
@@ -27,21 +38,14 @@ Rake::TestTask.new(:test) do |test|
   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
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
 end
 
-task :test => :check_dependencies
-
 task :default => :test
 
 require 'rake/rdoctask'

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/bin/sort_yaml

@@ -1,6 +1,38 @@
 #!/usr/bin/env ruby
+require 'optparse'
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'i18n_yaml_sorter'
 
-sorter = I18nYamlSorter.new(STDIN)
-puts sorter.sort
+options = {}
+optparse = OptionParser.new do|opts|
+  opts.banner = "Usage: sort_yaml < INPUT > OUTPUT | sort_yaml --install_bundle"
+
+  # Define the options, and what they do
+  options[:install_bundle] = false
+  opts.on( '-i', '--install_bundle', 'Installs TextMate for MAC OS X bundle (named "YAML Sort") in the current user home dir.' ) do
+    options[:install_bundle] = true
+  end
+
+  # This displays the help screen, all programs are
+  # assumed to have this option.
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+end
+
+optparse.parse!
+
+if options[:install_bundle]
+  puts "Installing TextMate Bundle in your home dir (~/Library/Application\\ Support/TextMate/Bundles/)..." 
+  puts
+  system "mkdir -p ~/Library/Application\ Support/TextMate/Bundles"
+  system "cp -Rfv #{File.join(File.dirname(__FILE__), '..', 'textmate', 'YAML\ Sort.tmbundle')} ~/Library/Application\\ Support/TextMate/Bundles/ "
+  puts
+  puts "Reloading TextMate bundles..." 
+  system "osascript -e 'tell app \"TextMate\" to reload bundles'"
+else
+  sorter = I18nYamlSorter::Sorter.new(STDIN)
+  puts sorter.sort
+end

data/i18n_yaml_sorter.gemspec

@@ -1,59 +1,69 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{i18n_yaml_sorter}
-  s.version = "0.1.1"
+  s.name = "i18n_yaml_sorter"
+  s.version = "0.2.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.authors = ["Bernardo de P\u{e1}dua"]
+  s.date = "2011-11-29"
+  s.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    "
+  s.email = "berpasan@gmail.com"
   s.executables = ["sort_yaml"]
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "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 = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/sort_yaml",
+    "i18n_yaml_sorter.gemspec",
+    "lib/i18n_yaml_sorter.rb",
+    "lib/i18n_yaml_sorter/railtie.rb",
+    "lib/i18n_yaml_sorter/sorter.rb",
+    "lib/tasks/i18n_yaml_sorter.rake",
     "test/helper.rb",
-     "test/test_i18n_yaml_sorter.rb"
+    "test/in.yml",
+    "test/in_rails.yml",
+    "test/in_simple.yml",
+    "test/out.yml",
+    "test/out_rails.yml",
+    "test/out_simple.yml",
+    "test/test_i18n_yaml_sorter.rb",
+    "textmate/YAML Sort.tmbundle/Commands/Sort YAML.tmCommand",
+    "textmate/YAML Sort.tmbundle/info.plist"
   ]
+  s.homepage = "http://github.com/redealumni/i18n_yaml_sorter"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "A I18n YAML deep sorter that will keep your locales organized and not screw up your text formating"
 
   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
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
     else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
   end
 end
 

data/lib/i18n_yaml_sorter.rb

@@ -1,128 +1,2 @@
-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 = @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
+require 'i18n_yaml_sorter/sorter'
+require 'i18n_yaml_sorter/railtie'