simple_po_parser 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10a107f2a74fa7cf6902d58c15f466705a52ef0c
-  data.tar.gz: 63369a5ede32deb4846c07a9206cc1a09cc4989c
+  metadata.gz: 74fd13b4d65428c06cebf73f052271c53fe2403b
+  data.tar.gz: eca6c142f4c5272f06e66ea9fcc88ce68261cbbc
 SHA512:
-  metadata.gz: f905113fc6890089e63110702d752b90cf3d2d678399d42f3ddd3d088fdcab787caf453d6a07fa07b0cc9b947a5b90aebc025ee33c20025a9174f6a829183424
-  data.tar.gz: 26591d6acbf9c279ddbd7986ba4d320bc6c525858740dd6d7fc86f87971fe795d16d95524c297703c24190140f372ebf994b2df81602180d8dbfadc177ff100c
+  metadata.gz: 4b41b0f49b24ec840e044471c675662057bff8fb76474e8bf7480b3d1cf44c10cee5c98e3bae9e1336ff49e09d9bcdf5780b2bc0e82498210ed761902c8fd369
+  data.tar.gz: e1ec0a70f6dbdfb4ad53bc84fb4457c7e61f5e5d4c508f58a8efbc505d19692c647e747d87250f343bbcfbb52884e47f5c8740bb356174b9fe75f031d45a1798

data/Gemfile

@@ -4,6 +4,7 @@ group :test do
   gem 'coveralls', :require => false
   gem 'rspec', '~> 3.5.0'
   gem 'awesome_print'
+  gem 'ruby-prof'
 end
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_po_parser (1.0.0)
+    simple_po_parser (1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -32,6 +32,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    ruby-prof (0.16.2)
     simplecov (0.12.0)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
@@ -52,7 +53,8 @@ DEPENDENCIES
   geminabox-release (= 0.2.1)
   rake
   rspec (~> 3.5.0)
+  ruby-prof
   simple_po_parser!
 
 BUNDLED WITH
-   1.13.6
+   1.14.6

data/README.md

@@ -6,11 +6,21 @@
 
 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
+## Usage
+
+The parser can be used in two ways:
+
+```ruby
+SimplePoParser.parse(file_path) # parses a PO file and returns array of hashes
+
+SimplePoParser.parse_message(message) # parses a single PO message and returns a hash
+```
+
+### Hash format
 
 A PO message is parsed into a hash with meaningful keys for each type of line.
- The values are strings, if only one line of such content was parsed,
- otherthise it's an array of strings. Each string is
+ The values are strings if only one line of such content was parsed,
+ otherwise it's an array of strings. Each string is
  representing one line of content in the PO file.
 
 ```ruby
@@ -30,6 +40,6 @@ A PO message is parsed into a hash with meaningful keys for each type of line.
 }
 ```
 
-### License
+## License
 
 License: [MIT](LICENSE.txt) - Copyright (c) 2017 Dennis-Florian Herr @Experteer GmbH

data/Rakefile

@@ -54,8 +54,8 @@ namespace :parser do
   desc "Show ruby-prof profiler for spec/fixtures/complex_entry.po"
   task "profile_parser" do
     require 'ruby-prof'
-    RubyProf.start
     po_message = File.read(File.expand_path("spec/simple_po_parser/fixtures/complex_entry.po", __dir__))
+    RubyProf.start
     SimplePoParser.parse_message(po_message)
     result = RubyProf.stop
 

data/lib/simple_po_parser/parser.rb

@@ -164,7 +164,7 @@ module SimplePoParser
       end
     end
 
-    # matches the msgstr singular line
+    # parses the msgstr singular line
     #
     # msgstr is required in singular translations
     def msgstr
@@ -184,7 +184,13 @@ module SimplePoParser
       end
     end
 
-
+    # parses the msgstr plural lines
+    #
+    # msgstr plural lines are used when there is msgid_plural.
+    # They have the format msgstr[N] where N is incremental number starting from zero representing
+    # the plural number as specified in the headers "Plural-Forms" entry. Most languages, like the
+    # English language only have two plural forms (singular and plural),
+    # but there are languages with more plurals
     def msgstr_plural(num = 0)
       begin
         msgstr_key = @scanner.scan(/msgstr\[\d\]/) # matches 'msgstr[0]' to 'msgstr[9]'
@@ -207,6 +213,12 @@ module SimplePoParser
       end
     end
 
+    # parses previous comments, which provide additional information on fuzzy matching
+    #
+    # previous comments are:
+    # * #| msgctxt
+    # * #| msgid
+    # * #| msgid_plural
     def previous_comments
       begin
         # next part must be msgctxt, msgid or msgid_plural
@@ -234,6 +246,7 @@ module SimplePoParser
       end
     end
 
+    # parses the multiline messages of the previous comment lines
     def previous_multiline(key)
       begin
         # scan multilines until no further multiline is hit
@@ -249,6 +262,10 @@ module SimplePoParser
       end
     end
 
+    # parses a multiline message
+    #
+    # multiline messages are indicated by an empty content as first line and the next line
+    # starting with the double quote character
     def message_multiline(key)
       begin
         skip_whitespace
@@ -290,7 +307,8 @@ module SimplePoParser
       end
     end
 
-    # used to parse all obsolete lines. An obsolete message may only contain obsolete entries
+    # parses all obsolete lines.
+    # An obsolete message may only contain obsolete lines
     def obsoletes
       if @scanner.scan(/#~/)
         skip_whitespace
@@ -333,6 +351,8 @@ module SimplePoParser
     end
 
     # returns true if the scanner is at beginning of next line or end of string
+    #
+    # @return [Boolean] true if scanner at beginning of line or eos
     def end_of_line
       @scanner.scan(/\n/)
       @scanner.eos? || @scanner.bol?
@@ -351,7 +371,5 @@ module SimplePoParser
         @result[key] = text
       end
     end
-
   end
-
 end

data/lib/simple_po_parser/version.rb

@@ -1,3 +1,3 @@
 module SimplePoParser
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_po_parser
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Dennis-Florian Herr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-03 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler