grosser-pomo 0.4.1

data/README.markdown

@@ -0,0 +1,43 @@
+A simple and extendable .mo and .po file parser/generator.  
+--mo file parser and writer are missing atm--
+
+Advanteges over [original po-parser](http://github.com/mutoh/gettext/blob/abf96713327cc4c5d35f0a772f3b75ff4819450c/lib/gettext/poparser.rb):
+
+ - simple architecture + easy to extend/modify
+ - emtpy msgstr translations are read
+ - comments are included
+ - fuzzy can be set/unset
+ - multiple translations can be combined in a new po file(with comments and fuzzy and ...)
+ - po files can be written from any kind of input
+
+Setup
+=====
+    sudo gem install grosser-pomo -s http://gems.github.com/
+
+###Static interface
+    #parse po files
+    translations = Pomo::PoFile.parse(File.read('xxx.po')) + Pomo::PoFile.parse(File.read('yyy.po'))
+
+    #and use the data...
+    msgids = translations.reject{|t|t.plural? or t.fuzzy?}.map(&:msgid)
+
+    #or write a new po file (unique by msgid)...
+    File.open('xxx.po','w){|f|f.print(Pomo::PoFile.to_text(translations))}
+
+###Instance interface
+    p = PoMo::PoFile.new
+    p.add_translations_from_text(File.read('...'))
+    ...
+    p.translations
+    p.to_text
+
+TODO
+====
+ - extracting of version/pluralisation_rule/plurals/translator... (from msgid "")
+ - mo writing/reading (this is the hardest part imo...)
+
+Author
+======
+[Michael Grosser](http://pragmatig.wordpress.com)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...  

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 4
+:patch: 1
+:major: 0

data/lib/pomo.rb

@@ -0,0 +1,3 @@
+require 'pomo/po_file'
+module Pomo
+end

data/lib/pomo/po_file.rb

@@ -0,0 +1,117 @@
+require 'pomo/translation'
+
+module Pomo
+  class PoFile
+    def self.parse(text)
+      PoFile.new.add_translations_from_text(text)
+    end
+
+    def self.to_text(translations)
+      p = PoFile.new(:translations=>translations)
+      p.to_text
+    end
+
+    def self.unique_translations(translations)
+      last_seen_at_index = {}
+      translations.each_with_index {|translation,index|last_seen_at_index[translation.msgid]=index}
+      last_seen_at_index.values.sort.map{|index| translations[index]}
+    end
+
+    attr_reader :translations
+
+    def initialize(options = {})
+      @translations = options[:translations] || []
+    end
+
+    #the text is split into lines and then converted into logical translations
+    #each translation consists of comments(that come before a translation)
+    #and a msgid / msgstr
+    def add_translations_from_text(text)
+      start_new_translation
+      text.split(/$/).each_with_index do |line,index|
+        @line_number = index + 1
+        next if line.empty?
+        if method_call? line
+          parse_method_call line
+        elsif comment? line
+          add_comment line
+        else
+          add_string line
+        end
+      end
+      start_new_translation #instance_variable has to be overwritten or errors can occur on next add
+      translations
+    end
+
+    def to_text
+      self.class.unique_translations(translations).map {|translation|
+        comment = translation.comment.to_s.split(/\n|\r\n/).map{|line|"##{line}\n"}*''
+        msgid_and_msgstr = if translation.plural?
+          msgids =
+          %Q(msgid "#{translation.msgid[0]}"\n)+
+          %Q(msgid_plural "#{translation.msgid[1]}"\n)
+
+          msgstrs = []
+          translation.msgstr.each_with_index do |msgstr,index|
+            msgstrs << %Q(msgstr[#{index}] "#{msgstr}")
+          end
+
+          msgids + (msgstrs*"\n")
+        else
+          %Q(msgid "#{translation.msgid}"\n)+
+          %Q(msgstr "#{translation.msgstr}")
+        end
+
+        comment + msgid_and_msgstr
+      } * "\n\n"
+    end
+
+    private
+
+    #e.g. # fuzzy
+    def comment?(line)
+      line =~ /^\s*#/
+    end
+
+    def add_comment(line)
+      start_new_translation if translation_complete?
+      @current_translation.add_text(line.strip.sub('#','')+"\n",:to=>:comment)
+    end
+
+    #msgid "hello"
+    def method_call?(line)
+      line =~ /^\s*[a-z]/
+    end
+
+    #msgid "hello" -> method call msgid + add string "hello"
+    def parse_method_call(line)
+      method, string = line.match(/^\s*([a-z0-9_\[\]]+)(.*)/)[1..2]
+      raise "no method found" unless method
+
+      start_new_translation if method == 'msgid' and translation_complete?
+      @last_method = method.to_sym
+      add_string(string)
+    end
+
+    #"hello" -> hello
+    def add_string(string)
+      return if string.strip.empty?
+      raise "not string format: #{string.inspect} on line #{@line_number}" unless string.strip =~ /^['"](.*)['"]$/
+      @current_translation.add_text($1,:to=>@last_method)
+    end
+
+    def translation_complete?
+      return false unless @current_translation
+      @current_translation.complete?
+    end
+  
+    def store_translation
+      @translations += [@current_translation] if @current_translation.complete?
+    end
+
+    def start_new_translation
+      store_translation if translation_complete?
+      @current_translation = Translation.new
+    end
+  end
+end

data/lib/pomo/translation.rb

@@ -0,0 +1,44 @@
+module Pomo
+  class Translation
+    FUZZY_REGEX = /^\s*fuzzy\s*$/
+    attr_accessor :msgid, :msgstr, :comment
+
+    def add_text(text,options)
+      to = options[:to]
+      if to.to_sym == :msgid_plural
+        self.msgid = [msgid] unless msgid.is_a? Array
+        msgid[1] = msgid[1].to_s + text
+      elsif to.to_s =~ /^msgstr\[(\d)\]$/
+        self.msgstr ||= []
+        msgstr[$1.to_i] = msgstr[$1.to_i].to_s + text
+      else
+        #simple form
+        send("#{to}=",send(to).to_s+text)
+      end
+    end
+
+    def to_hash
+      {:msgid=>msgid,:msgstr=>msgstr,:comment=>comment}.reject{|k,value|value.nil?}
+    end
+
+    def complete?
+      not msgid.to_s.strip.empty? and not msgstr.nil?
+    end
+
+    def fuzzy?
+      comment =~ FUZZY_REGEX
+    end
+
+    def fuzzy=(value)
+      if value and not fuzzy?
+        add_text "\nfuzzy", :to=>:comment
+      else
+        self.comment = comment.to_s.split(/$/).reject{|line|line=~FUZZY_REGEX}.join("\n")
+      end
+    end
+
+    def plural?
+      msgid.is_a? Array or msgstr.is_a? Array
+    end
+  end
+end

data/spec/pomo/po_file_spec.rb

@@ -0,0 +1,110 @@
+require File.expand_path("../spec_helper", File.dirname(__FILE__))
+
+include Pomo
+describe Pomo::PoFile do
+  it "parses nothing" do
+    PoFile.parse("").should be_empty
+  end
+
+  it "parses a simple msgid and msgstr" do
+    t = PoFile.parse(%Q(msgid "xxx"\nmsgstr "yyy"))
+    t[0].to_hash.should == {:msgid=>'xxx',:msgstr=>'yyy'}
+  end
+
+  it "parses a simple msgid and msg with additional whitespace" do
+    t = PoFile.parse(%Q(  msgid    "xxx"   \n   msgstr    "yyy"   ))
+    t[0].to_hash.should == {:msgid=>'xxx',:msgstr=>'yyy'}
+  end
+
+  it "parses a multiline msgid/msgstr" do
+    t = PoFile.parse(%Q(msgid "xxx"\n"aaa"\n\n\nmsgstr ""\n"bbb"))
+    t[0].to_hash.should == {:msgid=>'xxxaaa',:msgstr=>'bbb'}
+  end
+
+  it "parses simple comments" do
+    t = PoFile.parse(%Q(#test\nmsgid "xxx"\nmsgstr "yyy"))
+    t[0].to_hash.should == {:msgid=>'xxx',:msgstr=>'yyy',:comment=>"test\n"}
+  end
+
+  it "parses comments above msgstr" do
+    t = PoFile.parse(%Q(#test\nmsgid "xxx"\n#another\nmsgstr "yyy"))
+    t[0].to_hash.should == {:msgid=>'xxx',:msgstr=>'yyy',:comment=>"test\nanother\n"}
+  end
+
+  describe "instance interface" do
+    it "adds two different translations" do
+      p = PoFile.new
+      p.add_translations_from_text(%Q(msgid "xxx"\nmsgstr "yyy"))
+      p.add_translations_from_text(%Q(msgid "aaa"\nmsgstr "yyy"))
+      p.translations[1].to_hash.should == {:msgid=>'aaa',:msgstr=>'yyy'}
+    end
+
+    it "can be initialized with translations" do
+      p = PoFile.new(:translations=>['xxx'])
+      p.translations[0].should == 'xxx'
+    end
+
+    it "can be converted to text" do
+      text = %Q(msgid "xxx"\nmsgstr "aaa")
+      p = PoFile.new
+      p.add_translations_from_text(text)
+      p.to_text.should == text
+    end
+
+    it "keeps uniqueness when converting to_text" do
+      text = %Q(msgid "xxx"\nmsgstr "aaa")
+      p = PoFile.new
+      p.add_translations_from_text(%Q(msgid "xxx"\nmsgstr "yyy"))
+      p.add_translations_from_text(text)
+      p.to_text.should == text
+    end
+  end
+
+  it "adds plural translations" do
+    t = PoFile.parse(%Q(msgid "singular"\nmsgid_plural "plural"\nmsgstr[0] "one"\nmsgstr[1] "many"))
+    t[0].to_hash.should == {:msgid=>['singular','plural'],:msgstr=>['one','many']}
+  end
+
+  it "does not fail on empty string" do
+    PoFile.parse(%Q(\n\n\n\n\n))
+  end
+
+  it "shows line number for invalid strings" do
+    begin
+      PoFile.parse(%Q(\n\n\n\n\nmsgstr "))
+      flunk
+    rescue Exception => e
+      e.to_s.should =~ /line 5/
+    end
+  end
+
+  describe :to_text do
+    it "is empty when not translations where added" do
+      PoFile.to_text([]).should == ""
+    end
+    
+    it "preserves simple syntax" do
+      text = %Q(msgid "x"\nmsgstr "y")
+      PoFile.to_text(PoFile.parse(text)).should == text
+    end
+
+    it "adds comments" do
+      t = Pomo::Translation.new
+      t.msgid = 'a'
+      t.msgstr = 'b'
+      t.add_text("c\n",:to=>:comment)
+      t.add_text("d\n",:to=>:comment)
+      PoFile.to_text([t]).should == %Q(#c\n#d\nmsgid "a"\nmsgstr "b")
+    end
+
+    it "uses plural notation" do
+      text = %Q(#awesome\nmsgid "one"\nmsgid_plural "many"\nmsgstr[0] "1"\nmsgstr[1] "n")
+      PoFile.to_text(PoFile.parse(text)).should == text
+    end
+
+    it "only uses the latest of identicals msgids" do
+      text = %Q(msgid "one"\nmsgstr "1"\nmsgid "one"\nmsgstr "001")
+      PoFile.to_text(PoFile.parse(text)).should ==  %Q(msgid "one"\nmsgstr "001")
+    end
+  end
+end

data/spec/pomo/translation_spec.rb

@@ -0,0 +1,119 @@
+require File.expand_path("../spec_helper", File.dirname(__FILE__))
+
+require 'pomo/translation'
+
+describe Pomo::Translation do
+  describe :complete? do
+    it{should_not be_complete}
+
+    it "is complete if it has a msgid and a msgstr" do
+      subject.msgid="x"
+      subject.msgstr = "y"
+      should be_complete
+    end
+
+    it "is not complete if it has an complete msgid" do
+      subject.msgid=""
+      should_not be_complete
+    end
+
+    it "is not complete if it has a nil msgstr" do
+      subject.msgid="x"
+      should_not be_complete
+    end
+
+    it "is complete if it has an complete msgstr" do
+      subject.msgid = "x"
+      subject.msgstr = ""
+      should be_complete
+    end
+  end
+
+  describe :add_text do
+    it "adds a simple msgid" do
+      subject.add_text("x",:to=>:msgid)
+      subject.msgid.should == "x"
+    end
+
+    it "converts msgid to plural when msgid_plural is added" do
+      subject.add_text("x",:to=>:msgid)
+      subject.add_text("y",:to=>:msgid_plural)
+      subject.msgid.should == ["x",'y']
+    end
+
+    it "can add additional text to msgid plurals" do
+      subject.add_text("y",:to=>:msgid_plural)
+      subject.add_text("a",:to=>:msgid_plural)
+      subject.msgid.should == [nil,'ya']
+    end
+
+    it "can add plural msggstr" do
+      subject.add_text("x",:to=>'msgstr[0]')
+      subject.msgstr.should == ['x']
+    end
+
+    it "can add multiple plural msggstr" do
+      subject.add_text("x",:to=>'msgstr[0]')
+      subject.add_text("a",:to=>'msgstr[1]')
+      subject.add_text("y",:to=>'msgstr[1]')
+      subject.msgstr.should == ['x','ay']
+    end
+  end
+
+  describe :plural? do
+    it{should_not be_plural}
+
+    it "is plural if msgid is plural" do
+      subject.add_text("x",:to=>:msgid_plural)
+      should be_plural
+    end
+
+    it "is plural if msgstr is plural" do
+      subject.add_text("x",:to=>"msgstr[0]")
+      should be_plural
+    end
+
+    it "is not plural if simple strings where added" do
+      subject.msgid = "a"
+      subject.msgstr = "a"
+      should_not be_plural
+    end
+  end
+
+  describe :fuzzy? do
+    it{should_not be_fuzzy}
+
+    it "is fuzzy if a fuzzy comment was added" do
+      subject.add_text("fuzzy",:to=>:comment)
+      should be_fuzzy
+    end
+
+    it "can be made fuzzy by using fuzzy=" do
+      subject.fuzzy = true
+      should be_fuzzy
+    end
+
+    it "can be made unfuzzy by using fuzzy=" do
+      subject.fuzzy = false
+      should_not be_fuzzy
+    end
+
+    it "changes comment when made fuzzy through fuzzy=" do
+      subject.comment = "hello"
+      subject.fuzzy = true
+      subject.comment.should == "hello\nfuzzy"
+    end
+
+    it "changes empty comment when made fuzzy through fuzzy=" do
+      subject.fuzzy = true
+      subject.comment.should == "\nfuzzy"
+    end
+
+    it "preserves comments when making fuzzy/unfuzzy" do
+      subject.comment = "hello"
+      subject.fuzzy = true
+      subject.fuzzy = false
+      subject.comment.should == "hello"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# ---- requirements
+$LOAD_PATH.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'pomo'
+
+# ---- Helpers
+def pending_it(text,&block)
+  it text do
+    pending(&block)
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: grosser-pomo
+version: !ruby/object:Gem::Version 
+  version: 0.4.1
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-31 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- README.markdown
+- lib/pomo
+- lib/pomo/po_file.rb
+- lib/pomo/translation.rb
+- lib/pomo.rb
+- spec/pomo
+- spec/pomo/po_file_spec.rb
+- spec/pomo/translation_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/grosser/pomo
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: "Ruby/Gettext: A .po and .mo file parser/generator"
+test_files: []
+