simple_po_parser 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5af2707fffbad814707531a12d5c255cf0be4912
-  data.tar.gz: 1a0bc546529532459b6059dc3cf858815cf7f6b5
+  metadata.gz: 2e68d02e65b414ab6bf84fd752597af39f47f423
+  data.tar.gz: 94bac50f87a8a05c17cf8a368f2f2c02eca168f0
 SHA512:
-  metadata.gz: d7b3fe6a2abff7824a0fbb57f4671116370e6b7a84a83d8c871de8b2fdb75f832ecaf4b2f6fe09b6c5794732479685b4f3d130543be23f59a36614cd4e19eaca
-  data.tar.gz: 480e973695ec4c9ea10b51e7971306862df1b7fb7109ad7ac8fc70a03448d87e1a72b87921dc80f16ef5689cfba3013753959909c4b63ba0babfe9c306020558
+  metadata.gz: 91e548c9bbf1221c759d767cd7da8df876b41eb1d1f865dbf87c7175a3b955af8e58ceb314ffc31c82d4d5431ef7eea74c6a8fb4f33bd3737c26ac4583e489a2
+  data.tar.gz: 5f2dd9534520dcbc3cc12b5f6119c8a89147a43dd21f1538d9270e02a803807c97e52bb31d61da4c95cf7f40bc77487e4ab50ca52885c55f7181df4f3f4288a6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_po_parser (0.0.0)
+    simple_po_parser (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,9 @@
 # Simple Po Parser
 
+[![Build Status](https://travis-ci.org/experteer/simple_po_parser.svg?branch=master)](https://travis-ci.org/experteer/simple_po_parser)
+[![Coverage Status](https://img.shields.io/coveralls/experteer/simple_po_parser.svg)](https://coveralls.io/github/experteer/simple_po_parser)
+[![Gem Version](https://badge.fury.io/rb/simple_po_parser.svg)](https://badge.fury.io/rb/simple_po_parser)
+
 This is a simple PO file to ruby hash parser, which complies with [GNU PO file specification](https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html). Tested with the msgcat (GNU gettext-tools) 0.18.3 tool.
 
 ## Hash format

data/lib/simple_po_parser/parser.rb

@@ -23,11 +23,12 @@ module SimplePoParser
       begin
         lines
       rescue ParserError => pe
-        puts "Parsing error!"
-        puts "#{pe.message}"
-        puts "Backtrace:\n#{pe.backtrace.select{|i| i =~ /lib\/poparser/}.join("\n")}"
-        puts "\nResult up to error: '#{@result}'"
-        exit
+        error_msg = "SimplePoParser::ParserError"
+        error_msg += pe.message
+        error_msg += "\nParseing result before error: '#{@result}'"
+        error_msg += "\nSimplePoParser filtered backtrace: SimplePoParser::ParserError"
+        backtrace = "#{pe.backtrace.select{|i| i =~ /lib\/simple_po_parser/}.join("\n\tfrom ")}"
+        raise ParserError, error_msg, backtrace
       end
       @result
     end
@@ -274,7 +275,7 @@ module SimplePoParser
           skip_whitespace
           unless end_of_line
             err_msg = "There should be only whitespace until the end of line"
-            err_msg += "after the double quote character of a message text."
+            err_msg += " after the double quote character of a message text."
             raise PoSyntaxError.new(err_msg)
           end
           text

data/lib/simple_po_parser/version.rb

@@ -1,3 +1,3 @@
 module SimplePoParser
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/simple_po_parser/fixtures/complete_file.po

@@ -0,0 +1,51 @@
+# PO Header entry
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: simple_po_parser 1\n"
+"Report-Msgid-Bugs-To: me\n"
+"POT-Creation-Date: 2012-05-04 12:56+0000\n"
+"PO-Revision-Date: 2014-05-15 22:24+0330\n"
+"Last-Translator: Dennis-Florian Herr <dennis.herr@experteer.com>\n"
+"Language-Team: English\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+
+# translator-comment
+#. extract
+#: reference1
+msgctxt "Context"
+msgid "msgid"
+msgstr "translated"
+
+# translator-comment
+#
+#. extract
+#: reference1
+#: reference2
+#, flag
+#| msgctxt "previous context"
+#| msgid ""
+#|  "multiline\n"
+#|"previous messageid"
+#| msgid_plural "previous msgid_plural"
+msgctxt "Context"
+msgid "msgid"
+msgid_plural ""
+"multiline msgid_plural\n"
+""
+msgstr[0] "msgstr 0"
+msgstr[1] ""
+"msgstr 1 multiline 1\n"
+"msgstr 1 line 2\n"
+msgstr[2] "msgstr 2"
+
+# translator-comment
+#. extract
+#: reference1
+#~ msgctxt "Context"
+#~ msgid "msgid"
+#~ msgstr "translated"

data/spec/simple_po_parser/fixtures/non_ascii_file.po

@@ -0,0 +1,51 @@
+# Persian translation for damned-lies.
+# Copyright (C) 2012 damned-lies's COPYRIGHT HOLDER
+# This file is distributed under the same license as the damned-lies package.
+# Arash Mousavi <mousavi.arash@gmail.com>, 2014.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: damned-lies master\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2012-05-04 12:56+0000\n"
+"PO-Revision-Date: 2014-05-15 22:24+0330\n"
+"Last-Translator: Arash Mousavi <mousavi.arash@gmail.com>\n"
+"Language-Team: Persian <fa@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"X-Generator: Poedit 1.6.4\n"
+
+#: database-content.py:1 database-content.py:129 settings.py:52
+msgid "Afrikaans"
+msgstr "آفریقایی"
+
+#: templates/vertimus/vertimus_detail.html:105
+#, python-format
+msgid " including <a href=\"%(img_url)s\">%(stats)s image</a>"
+msgid_plural " including <a href=\"%(img_url)s\">%(stats)s images</a>"
+msgstr[0] ""
+msgstr[1] ""
+
+#: templates/vertimus/vertimus_detail.html:136 vertimus/forms.py:79
+msgid "Invalid action. Someone probably posted another action just before you."
+msgstr ""
+"فعالیت نامعتبر. شاید یک نفر دیگر دقیقا قبل از شما یک فعالیت دیگر ارسال کرده "
+"است."
+
+#: vertimus/models.py:470
+#, python-format
+#| msgid ""
+#| "Hello,\n"
+#| "\n"
+#| "The new state of %(module)s - %(branch)s - %(domain)s (%(language)s) is "
+#| "now '%(new_state)s'.\n"
+#| "%(url)s\n"
+#| "\n"
+msgid ""
+"The new state of %(module)s - %(branch)s - %(domain)s (%(language)s) is now "
+"'%(new_state)s'."
+msgstr ""
+"وضعیت جدید %(module)s - %(branch)s - %(domain)s (%(language)s) هم‌اکنون "
+"«%(new_state)s» است."

data/spec/simple_po_parser/parser_spec.rb

@@ -46,4 +46,95 @@ describe SimplePoParser::Parser do
     expect(SimplePoParser::Parser.parse(po_complex_message)).to eq(expected_result)
   end
 
+  context "Errors" do
+    it "errors cascade to ParserError" do
+      message = "invalid message"
+      expect{ SimplePoParser::Parser.parse(message) }.to raise_error(SimplePoParser::ParserError)
+    end
+
+    it "raises an error if there is no msgid" do
+      message = "# comment\nmsgctxt \"ctxt\"\nmsgstr \"translation\""
+      expect{ SimplePoParser::Parser.parse(message) }.
+        to raise_error(SimplePoParser::ParserError, /Message without msgid is not allowed/)
+    end
+
+    it "raises an error if there is no msgstr in singular message" do
+      message = "# comment\nmsgctxt \"ctxt\"\nmsgid \"msg\""
+      expect{ SimplePoParser::Parser.parse(message) }.
+        to raise_error(SimplePoParser::ParserError,
+        /Singular message without msgstr is not allowed/)
+    end
+
+    it "raises an error if there is no msgstr[0] in plural message" do
+      message = "# comment\nmsgid \"id\"\nmsgid_plural \"msg plural\""
+      expect{ SimplePoParser::Parser.parse(message) }.
+        to raise_error(SimplePoParser::ParserError,
+        /Plural message without msgstr\[0\] is not allowed/)
+
+      message = "# comment\nmsgid \"id\"\nmsgid_plural \"msg plural\"\nmsgstr[1] \"plural trans\""
+      expect{ SimplePoParser::Parser.parse(message) }.
+        to raise_error(SimplePoParser::ParserError,
+        /Bad 'msgstr\[index\]' index/)
+    end
+
+    context "comments" do
+      it "raises an error on unknown comment types" do
+        message = "#- no such comment type"
+        expect{ SimplePoParser::Parser.parse(message) }.
+          to raise_error(SimplePoParser::ParserError, /Unknown comment type/)
+      end
+
+      it "raises an error on unknown previous comment types" do
+        message = "#| msgstr \"no such comment type\""
+        expect{ SimplePoParser::Parser.parse(message) }.
+          to raise_error(SimplePoParser::ParserError, /Previous comment type .*? unknown/)
+        message = "#| bla "
+        expect{ SimplePoParser::Parser.parse(message) }.
+          to raise_error(SimplePoParser::ParserError, /Previous comments must start with '#| msg'/)
+      end
+
+      it "raises an error if any lines are not marked obsolete after the first obsolete line" do
+        message = "# comment\n#~msgid \"hi\"\nmsgstr \"should be obsolete\""
+        expect{ SimplePoParser::Parser.parse(message) }.
+          to raise_error(SimplePoParser::ParserError,
+           /All lines must be obsolete after the first obsolete line, but got/)
+      end
+
+      it "raises an error if previous comments are not marked obsolete in obsolete entries" do
+        message = "# comment\n#| msgid \"hi\"\n#~msgid \"hi\"\n#~msgstr \"should be obsolete\""
+        expect{ SimplePoParser::Parser.parse(message) }.
+         to raise_error(SimplePoParser::ParserError,
+         /Previous comment entries need to be marked obsolete too in obsolete message entries/)
+         message = "# comment\n#| msgctxt \"hi\"\n#~msgid \"hi\"\n#~msgstr \"should be obsolete\""
+         expect{ SimplePoParser::Parser.parse(message) }.
+          to raise_error(SimplePoParser::ParserError,
+          /Previous comment entries need to be marked obsolete too in obsolete message entries/)
+      end
+    end
+
+    context "message_line" do
+      it "raises an error if a message_line does not start with a double quote" do
+        message = "msgid No starting double quote\""
+        expect{ SimplePoParser::Parser.parse(message) }.
+         to raise_error(SimplePoParser::ParserError,
+         /A message text needs to start with the double quote character/)
+      end
+
+      it "raises an error if a message_line does not end with a double quote" do
+        message = "msgid \"No ending double quote"
+        expect{ SimplePoParser::Parser.parse(message) }.
+         to raise_error(SimplePoParser::ParserError,
+         /The message text .*? must be finished with the double quote character/)
+      end
+
+      it "raises an error if there is anything but whitespace after the ending double quote" do
+        message = "msgid \"text\"        this shouldn't be here"
+        expect{ SimplePoParser::Parser.parse(message) }.
+         to raise_error(SimplePoParser::ParserError,
+         /There should be only whitespace until the end of line after the double quote character/)
+      end
+    end
+
+  end
+
 end

data/spec/simple_po_parser/simple_po_parser_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe SimplePoParser do
+  let(:po_file) { Pathname.new('spec/simple_po_parser/fixtures/complete_file.po').realpath }
+  let(:non_ascii_file) { Pathname.new('spec/simple_po_parser/fixtures/non_ascii_file.po').realpath }
+  let(:po_complex_message) { File.read(File.expand_path("fixtures/complex_entry.po", __dir__))}
+
+  it "parses a po file" do
+    expect(SimplePoParser.parse(po_file)).to be_a_kind_of Array
+  end
+
+  it "parses a non ascii po file" do
+    expect(SimplePoParser.parse(non_ascii_file)).to be_a_kind_of Array
+  end
+
+  it "parses a single message" do
+    expect(SimplePoParser.parse_message(po_complex_message)).to be_a_kind_of Hash
+  end
+
+end

data/spec/spec_helper.rb

@@ -5,11 +5,21 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
-require 'simple_po_parser'
+require 'simplecov'
 require 'coveralls'
 require 'awesome_print'
 
-Coveralls.wear!
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+  [SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter]
+  )
+
+SimpleCov.start do
+    add_group "gem", "lib"
+    add_group "spec", "spec"
+end
+
+require 'simple_po_parser'
 
 RSpec.configure do |config|
   config.raise_errors_for_deprecations!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_po_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Dennis-Florian Herr
@@ -74,10 +74,13 @@ files:
 - lib/simple_po_parser/tokenizer.rb
 - lib/simple_po_parser/version.rb
 - simple_po_parser.gemspec
+- spec/simple_po_parser/fixtures/complete_file.po
 - spec/simple_po_parser/fixtures/complex_entry.po
 - spec/simple_po_parser/fixtures/header.po
+- spec/simple_po_parser/fixtures/non_ascii_file.po
 - spec/simple_po_parser/fixtures/simple_entry.po
 - spec/simple_po_parser/parser_spec.rb
+- spec/simple_po_parser/simple_po_parser_spec.rb
 - spec/spec_helper.rb
 - spec/utils/random_pofile_generator.rb
 - test/benchmark.po
@@ -106,9 +109,12 @@ signing_key:
 specification_version: 4
 summary: A simple PO file to ruby hash parser
 test_files:
+- spec/simple_po_parser/fixtures/complete_file.po
 - spec/simple_po_parser/fixtures/complex_entry.po
 - spec/simple_po_parser/fixtures/header.po
+- spec/simple_po_parser/fixtures/non_ascii_file.po
 - spec/simple_po_parser/fixtures/simple_entry.po
 - spec/simple_po_parser/parser_spec.rb
+- spec/simple_po_parser/simple_po_parser_spec.rb
 - spec/spec_helper.rb
 - spec/utils/random_pofile_generator.rb