rails_locale_sorter 0.0.8 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
 Rails Locale Sorter
 ===================
-This is a small utility to assist in generating language files, so that as you add strings to your locale files you can have them translated quickly.
+This is a small utility to assist in handling your I18n YAML files in a Ruby on Rails project.
 
 Installation
 ============
@@ -8,13 +8,37 @@ Installation
 $ gem install rails_locale_sorter
 ```
 
-Generating New Files
-====================
-The command tool that comes with the gem will go through your locales directory, and update all the locale files based on your "default" language.
+Creating/Applying Patches
+=========================
+To create a patch, just provide input and output directories, and a "source of truth" locale that will be the template for the other languages.
 
-For instance, if I've added keys to the en.yml file, then the command will create new yaml files for es.yml, zh.yml, etc with blank values set as the new keys.
+```
+$ locale_patch path/to/locales path/to/output en.yml
+```
+
+The output directory will now contain a list of YAML files containing missing translations.
+
+Once the strings have been translated, they can be applied back into your project:
+
+```
+$ locale_apply path/to/translated_patches path/to/locales
+```
+The patching process also sorts the file's content alphabetically.
+
+Defaults
+========
+These commands default to "locales/", "new-locales/", and "en.yml". Meaning that all you need to do to run through the entire process is:
+
+```
+$ cd my_rails_app/config
+$ locale_patch
+$ locale_apply
+```
+
+Or use the handy, descriptive aliases:
 
-It defaults to english as the base language; you can change it by passing in a parameter.
 ```
-$ locale_generator path/to/locales path/to/output [en.yml]
+$ cd my_rails_app/config
+$ poop
+$ scoop
 ```

data/bin/locale_apply

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 require 'rails_locale_sorter'
 
-puts "Usage: scoop [source-dir] [out-dir]\n\n\n"
+puts "Usage: locale_apply [source-dir] [out-dir]\n\n\n"
 
 source_dir = ARGV[0] || "new-locales"
 out_dir = ARGV[1] || "locales"

data/bin/locale_patch

@@ -1,11 +1,26 @@
 #!/usr/bin/env ruby
+require 'rubygems'
 require 'rails_locale_sorter'
+require 'optparse'
 
-puts "Usage: poop [source-path] [out-path] [default-language]\n\n\n"
+options = { :filter => [] }
+optparse = OptionParser.new do |o|
+  o.banner = "Usage: locale_patch [source-path] [out-path] [default-language]\n\n\n"
 
-source_dir = ARGV[0] || "locales"
-out_dir = ARGV[1] || "new-locales"
-truth_locale = ARGV[2] || "en.yml"
+  o.separator "Options:"
+
+  o.on('-i', '--ignore x,y,z', 'Ignore a locale section by name') do |filt|
+    options[:filter].concat filt.split(",")
+  end
+
+  puts o
+end
+
+optparse.parse!
+
+source_dir = ARGV.shift || "locales"
+out_dir = ARGV.shift || "new-locales"
+truth_locale = ARGV.shift || "en.yml"
 
 lm = RailsLocaleSorter::LocaleManager.new source_dir, out_dir
-lm.create_patches truth_locale
+lm.create_patches truth_locale, options[:filter]

data/bin/poop

@@ -1,11 +1,26 @@
 #!/usr/bin/env ruby
+require 'rubygems'
 require 'rails_locale_sorter'
+require 'optparse'
 
-puts "Usage: poop [source-path] [out-path] [default-language]\n\n\n"
+options = { :filter => [] }
+optparse = OptionParser.new do |o|
+  o.banner = "Usage: locale_patch [source-path] [out-path] [default-language]\n\n\n"
 
-source_dir = ARGV[0] || "locales"
-out_dir = ARGV[1] || "new-locales"
-truth_locale = ARGV[2] || "en.yml"
+  o.separator "Options:"
+
+  o.on('-i', '--ignore x,y,z', 'Ignore a locale section by name') do |filt|
+    options[:filter].concat filt.split(",")
+  end
+
+  puts o
+end
+
+optparse.parse!
+
+source_dir = ARGV.shift || "locales"
+out_dir = ARGV.shift || "new-locales"
+truth_locale = ARGV.shift || "en.yml"
 
 lm = RailsLocaleSorter::LocaleManager.new source_dir, out_dir
-lm.create_patches truth_locale
+lm.create_patches truth_locale, options[:filter]

data/bin/scoop

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 require 'rails_locale_sorter'
 
-puts "Usage: scoop [source-dir] [out-dir]\n\n\n"
+puts "Usage: locale_apply [source-dir] [out-dir]\n\n\n"
 
 source_dir = ARGV[0] || "new-locales"
 out_dir = ARGV[1] || "locales"

data/lib/rails_locale_sorter.rb

@@ -60,7 +60,7 @@ module RailsLocaleSorter
       end
     end
 
-    def create_patches(truth = "en.yml")
+    def create_patches(truth = "en.yml", filters = [])
       translations = YAML::load_file("#{@source}/#{truth}")
 
       process_each_file do |hash, file, filename|
@@ -68,7 +68,7 @@ module RailsLocaleSorter
           hash = list_missing_keys(translations, hash)
         end
 
-        sort_and_write(filename, hash)
+        sort_and_write(filename, hash, filters)
       end
     end
 
@@ -108,18 +108,24 @@ module RailsLocaleSorter
     def process_each_file(&block)
       # for ya2yaml
       $KCODE="UTF8"
-
+      
+      puts 'Processing...'
+      
       with_each_file do |f, filename|
-        puts "Processing #{filename}..."
+        print " #{filename.split('.').first} "
+        STDOUT.flush
         hash = YAML::load(f)
 
         block.call(hash, f, filename)
       end
+      puts "Done!"
     end
     
-    def sort_and_write(filename, hash)
+    def sort_and_write(filename, hash, filters = [])
       hash = OrderFact.convert_and_sort(hash, true)
 
+      filters.each { |filt| hash.first.last.delete(filt) }
+
       File.open("#{@out}/#{filename}", "w+") do |fw|
         fw.puts hash.ya2yaml(:syck_compatible => true)
       end

data/lib/rails_locale_sorter/version.rb

@@ -1,3 +1,3 @@
 module RailsLocaleSorter
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end

data/spec/rls-spec.rb

@@ -44,6 +44,19 @@ describe RailsLocaleSorter::LocaleManager do
       result.should_not include "both: Both"
       result.should_not include "exotic: 下一页！След"
     end
+
+    it "allows for filtering of sections" do
+      @lm.create_patches "src.yml", "date"
+
+      result = File.open("#{OUT_DIR}/out.yml").read
+      result.should include "out:"
+      result.should include "text:"
+      result.should include "source_only: "
+      result.should_not include "date:"
+      result.should_not include "src_only: "
+      result.should_not include "both: Both"
+      result.should_not include "exotic: 下一页！След"
+    end
   end
 
   describe "poop and scoop" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_locale_sorter
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 8
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors: 
 - Michael Wheeler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-20 00:00:00 -07:00
+date: 2012-03-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency