PoParser 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 066ad9b453a020a745330142e832c8922e95a0da
-  data.tar.gz: 8ce3ba60280751f10fb1b3a749d4ceb51247ab13
+  metadata.gz: c506fa6a54bff012c86629ea79bfdd53c414a43a
+  data.tar.gz: 44c9a383604e15653a4c9c196bf390c6d9f074b1
 SHA512:
-  metadata.gz: 72264188d5c4bd28a4837cb29ba9cd5389618138ba3cd545c40fb563c0eaa2aff1ec159a8d302e63a0f7e8b2533070356e79e5290a19094071429ed9d7eea71c
-  data.tar.gz: 02465743b232b2649580b9dc89a5b6757412ef3e71abc14129a0bec89a5a831859078a12a64cc9590af2550efe418e616ff6d7511d6150472307f7dd772fa6ee
+  metadata.gz: fbea1d35226cf6ffa877c0ac9c62c92e80510ef39e31597e2e32c27936e8379768e8c5850845e5d5dca774e70d28de7949667d5f5268355e927bff993662f9b8
+  data.tar.gz: 4b68497ef00ccf3c0f345dd00c10d35bd27b440ddf03846249291332e5ca9d077872e92bde26e536121abd0580f1b3fc56d8b357623263f4431c416ba61fea69

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Version 0.2.0
+
+* Some entries in PO files are started with "#~", these entries are just kept by program for later use and are not counted as active entries. `PoParser` now supports them. We won't count them in stats or show them in Tanslated or Untranslated entries. They're just there.
+
+* Added size/length methods to `PO` class. It won't count cached entries(described above).
+
 ## Version 0.1.1
 
 * Fix bug of "str" and "to_str" on Messages

data/README.md

@@ -36,6 +36,9 @@ The `parse` method returns a `PO` object which contains all `Entries`:
 # get all entries
 po.entries # or .all alias
 
+# include cashed entries (started with "#~", these entries are just kept by program for later use and are not counted as active entries)
+po.entries(true)
+
 # get all fuzzy entries
 po.fuzzy
 
@@ -80,6 +83,7 @@ refrence
 extracted_comment
 flag
 previous_untraslated_string
+cached
 msgid
 msgid_plural
 msgstr

data/lib/poparser/constants.rb

@@ -1,17 +1,18 @@
 module PoParser
   COMMENTS_LABELS = {
     :translator_comment => '#',
-    :refrence => '#:',
     :extracted_comment => '#.',
+    :refrence => '#:',
     :flag => '#,',
     :previous_untraslated_string => '#|',
+    :cached => '#~'
   }
 
   ENTRIES_LABELS = {
+    :msgctxt => 'msgctxt',
     :msgid => 'msgid',
     :msgid_plural => 'msgid_plural',
-    :msgstr => 'msgstr',
-    :msgctxt => 'msgctxt'
+    :msgstr => 'msgstr'
   }
 
   LABELS = COMMENTS_LABELS.merge(ENTRIES_LABELS).keys

data/lib/poparser/entry.rb

@@ -19,10 +19,19 @@ module PoParser
       self.class.send(:alias_method, :translate, :msgstr=)
     end
 
+    # If entry doesn't have any msgid, it's probably a cached entry that is
+    # kept by the program for later use. These entries will usually start with: #~
+    # 
+    # @return [Boolean]
+    def cached?
+      !@cached.nil?
+    end
+
     # Checks if the entry is untraslated
     # 
     # @return [Boolean]
     def untranslated?
+      return false if cached?
       @msgstr.nil? || @msgstr.to_s == ''
     end
     alias_method :incomplete? , :untranslated?
@@ -31,6 +40,7 @@ module PoParser
     # 
     # @return [Boolean]
     def translated?
+      return false if cached?
       not untranslated?
     end
     alias_method :complete? , :translated?
@@ -46,6 +56,7 @@ module PoParser
     # 
     # @return [Boolean]
     def fuzzy?
+      return false if cached?
       @flag.to_s == 'fuzzy'
     end
 

data/lib/poparser/parser.rb

@@ -10,6 +10,7 @@ module PoParser
       refrence |
       extracted_comment | flag |
       previous_untraslated_string |
+      cached |
       translator_comment
     end
 
@@ -18,6 +19,7 @@ module PoParser
     rule(:refrence)                   { spaced('#:') >> comment_text_line.as(:refrence) }
     rule(:flag)                       { spaced('#,') >> comment_text_line.as(:flag) }
     rule(:previous_untraslated_string){ spaced('#|') >> comment_text_line.as(:previous_untraslated_string) }
+    rule(:cached)                     { spaced('#~') >> comment_text_line.as(:cached) }
 
     # Entries
     rule(:entries) do

data/lib/poparser/po.rb

@@ -3,9 +3,7 @@ module PoParser
   # 
   class Po
     include Enumerable
-    attr_reader :entries
     attr_accessor :path
-    alias_method :all, :entries
 
     def initialize(args = {})
       @entries = []
@@ -39,6 +37,21 @@ module PoParser
     end
     alias_method :<<, :add_entry
 
+    # Returns an array of all entries in po file
+    # 
+    # @param include_cached [Boolean] Whether include cached entries or not 
+    # @return [Array]
+    def entries(include_cached=false)
+      if include_cached
+        @entries
+      else
+        find_all do |entry|
+          !entry.cached?
+        end
+      end
+    end
+    alias_method :all, :entries
+
     # Finds all entries that are flaged as fuzzy
     # 
     # @return [Array] an array of fuzzy entries
@@ -66,6 +79,14 @@ module PoParser
       end
     end
 
+    # Count of all entries without counting cached entries
+    # 
+    # @return [String]
+    def size
+      entries.length
+    end
+    alias_method :length, :size
+
     # Shows statistics and status of the provided file in percentage.
     # 
     # @return [Hash] a hash of translated, untranslated and fuzzy percentages
@@ -126,9 +147,8 @@ module PoParser
     # 
     # @param [Integer] number of entries
     # @return [Float] percentage of the provided entries
-    def percentage(size)
-      total = @entries.size
-      ((size.to_f / total) * 100).round(1)
+    def percentage(count)
+      ((count.to_f / self.size) * 100).round(1)
     end
   end
 end

data/lib/poparser/version.rb

@@ -1,3 +1,3 @@
 module PoParser
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/poparser.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   # Development deps
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "rspec", [">= 2.14", "< 2.99"]
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "pry-debugger"
   spec.add_development_dependency "awesome_print"

data/spec/poparser/entry_spec.rb

@@ -4,6 +4,7 @@ require 'spec_helper'
 describe PoParser::Entry do
   before(:each) do
     @entry = PoParser::Entry.new
+    @entry.msgid = 'some string'
   end
 
   let(:labels) do
@@ -82,4 +83,28 @@ describe PoParser::Entry do
       expect(@entry.to_s).to eq(result)
     end
   end
+
+  context 'Cached' do
+    before do
+      @entry = PoParser::Entry.new
+      @entry.cached = '#~ msgid "a cached entry"'
+      @entry.flag = 'Fuzzy'
+    end
+
+    it 'checks for chached entries' do
+      expect(@entry.cached?).to be_true
+    end
+
+    it 'shouldn be counted as untranslated' do
+      expect(@entry.untranslated?).to be_false
+    end
+
+    it 'shouldn be counted as translated' do
+      expect(@entry.translated?).to be_false
+    end
+
+    it 'shouldn\'t mark it as fuzzy' do
+      expect(@entry.fuzzy?).to be_false
+    end
+  end
 end

data/spec/poparser/po_spec.rb

@@ -45,4 +45,11 @@ describe PoParser::Po do
     @po << [entry, entry2, entry3]
     ap @po.stats
   end
+
+  it 'shouldn\'t count cached entries' do
+    @po << entry
+    cached = { cached: 'sth', flag: 'Fuzzy' }
+    @po << cached
+    expect(@po.size).to eq(1)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: PoParser
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Arash Mousavi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-26 00:00:00.000000000 Z
+date: 2014-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -56,16 +56,22 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.99'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -187,3 +193,4 @@ test_files:
 - spec/poparser/tokenizer_spec.rb
 - spec/poparser/transformer_spec.rb
 - spec/spec_helper.rb
+has_rdoc: