po_to_json 0.0.1 → 0.0.2

data/README.md

@@ -9,7 +9,7 @@ with Jed ( http://slexaxton.github.com/Jed/ )
 
 Via rubygems:
 ```ruby
-gem install 'po_to_json'
+gem install po_to_json
 ```
 
 In your gemfile:
@@ -19,11 +19,19 @@ gem 'po_to_json'
 
 ## Usage
 
-Simply parses a po file generating the corresponding JSON encoded string.
+Most common use would be to generate a Jed ready javascript file. For example, in a Rails 3 project:
 
 ```ruby
 require 'po_to_json'
-json_string = PoToJson.new.parse_po('/path/to/your/translations.po')
+json_string = PoToJson.new("#{Rails.root}/locale/es/app.po").generate_for_jed('es')
+File.open("#{Rails.root}/app/assets/javascripts/locale/es/app.js",'w').write(json_string)
+```
+
+The javascript file generated has a global 'locales' object with an attribute corresponding to the generated language:
+
+```javascript
+i18n = new Jed(locales['es'])
+i18n.gettext('Hello World') // Should evaluate to 'Hola Mundo'
 ```
 
 ## Maintainers

data/lib/po_to_json.rb

@@ -2,14 +2,55 @@ require 'json'
 
 class PoToJson
 
-  CONTEXT_GLUE = '|'
 
-  def parse_po(path_to_po)
+  # Gettext translations may be contextualized like so User|name
+  # The default 'GLUE' in rails gettext is '|' so we use that here too.
+  def initialize(path_to_po, context_glue = '|')
+    # Gettext translations may be contextualized like so User|name
+    # The default 'GLUE' in rails gettext is '|' so we use that here too.
+    @context_glue = context_glue
+    @path_to_po = path_to_po
+  end
+
+  
+  # Generates a jed-compatible js file from the current PO.
+  # This include adding some wrapping structure to the translations and
+  # making sure the minimum headers required by Jed are provided.
+  # Jed is a js gettext library ( http://slexaxton.github.com/Jed/ )
+  # The generated file leaves the generated json inside a global locales
+  # object which you can use to instatiate Jed:
+  # >>> i18n = new Jed(locales['es'])
+  # >>> i18n.gettext('Hello World')
+  # => 'Hola Mundo'
+  def generate_for_jed(language_code)
+    @parsed ||= self.parse
+
+    @parsed['']['lang'] = language_code
+    @parsed['']['domain'] = 'messages'
+    @parsed['']['plural_forms'] ||= @parsed['']['Plural-Forms']
+
+    jed_json = {
+      domain: 'messages',
+      locale_data: @parsed
+    }
+  
+    "var locales = locales || {}; locales['#{language_code}'] = #{jed_json.to_json};"
+  end
+  
+
+  # Messages in a PO file are defined as a series of 'key value' pairs,
+  # values may span over more than one line. Each key defines an attribute
+  # of the message, like message id, context, pluralization options, etc.
+  # Each message is separated by a blank line.
+  # The parser reads attributes until it finds an empty line, at that point
+  # it saves the attributes read so far into a message and stores it in a hash
+  # to be later turned into a json object.
+  def parse
     @parsed_values = {}
     @buffer = {}
     @last_key_type = ""
     @errors = []
-    File.foreach(path_to_po) do |line|
+    File.foreach(@path_to_po) do |line|
       line = line.chomp
       case line
         # Empty lines means we have parsed one full message
@@ -47,14 +88,14 @@ class PoToJson
     # This will turn the header values into a friendlier json structure too.
     parse_header_lines
   
-    return @parsed_values.to_json
+    return @parsed_values
   end
   
   def flush_buffer
     return unless @buffer[:msgid]
 
     msg_ctxt_id = if @buffer[:msgctxt] && @buffer[:msgctxt].size > 0
-      @buffer[:msgctxt] + CONTEXT_GLUE + @buffer[:msgid]
+      @buffer[:msgctxt] + @context_glue + @buffer[:msgid]
     else
       @buffer[:msgid]
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: po_to_json
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-16 00:00:00.000000000 Z
+date: 2012-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70359307260220 !ruby/object:Gem::Requirement
+  requirement: &70327703735720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -22,7 +22,7 @@ dependencies:
         version: 1.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *70359307260220
+  version_requirements: *70327703735720
 description: Convert gettext PO files to json to use in your javascript app, based
   po2json.pl (by DuckDuckGo, Inc. http://duckduckgo.com/, Torsten Raudssus <torsten@raudss.us>.)
 email: nubis@woobiz.com.ar