i18n_yaml_sorter_2 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a8a9ffaecafe15a0d6075bb75ea6ae92002b82b
+  data.tar.gz: 6ebfdd81a26de951627cfa6a1210a710913c01ef
+SHA512:
+  metadata.gz: f48dde0425533f617476cd7596514b426a60a4b7435836c5dd3f845655bf7ee16292fa81147fabe83ed3eb8a72597713a4a4cb8d3c9e7f71d0fe8a5a9e94678e
+  data.tar.gz: de4569f0da2460388fe5ac1c6074bba54181eef4f7f9d339a6d0d4b5724347a751b77bca53cb7e64e378698b5e201c1da0ef4318ee2103e6b5b135ccde2b6b72

data/.document

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in i18n_yaml_sorter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    i18n_yaml_sorter_2 (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  i18n_yaml_sorter_2!
+  rake
+  rspec
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,20 @@
+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
+"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,236 @@
+= 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.
+
+== Changelog
+
+* 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
+* 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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: :spec
+
+RSpec::Core::RakeTask.new

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/bin/sort_yaml

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'i18n_yaml_sorter'
+
+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

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "i18n_yaml_sorter_2"
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bernardo de P\u{e1}dua", 'compiledwrong']
+  s.date = "2081-04-06"
+  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", 'compiledwrong+i18n_yaml_sorter@gmail.com']
+  s.executables = ["sort_yaml"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "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/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.summary = "A I18n YAML deep sorter that will keep your locales organized and not screw up your text formating"
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+end
+

data/lib/i18n_yaml_sorter.rb

@@ -0,0 +1,2 @@
+require 'i18n_yaml_sorter/sorter'
+require 'i18n_yaml_sorter/railtie'

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