PoParser 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c506fa6a54bff012c86629ea79bfdd53c414a43a
-  data.tar.gz: 44c9a383604e15653a4c9c196bf390c6d9f074b1
+  metadata.gz: 1a310a16fa33cd64c3cb41e3e0c62ffdc2605953
+  data.tar.gz: 30ecf8f919e4d28e530c7ba3fed2d1f145507ada
 SHA512:
-  metadata.gz: fbea1d35226cf6ffa877c0ac9c62c92e80510ef39e31597e2e32c27936e8379768e8c5850845e5d5dca774e70d28de7949667d5f5268355e927bff993662f9b8
-  data.tar.gz: 4b68497ef00ccf3c0f345dd00c10d35bd27b440ddf03846249291332e5ca9d077872e92bde26e536121abd0580f1b3fc56d8b357623263f4431c416ba61fea69
+  metadata.gz: f087afddd470840a6bcd7a7c7d8c538ca8cfc29aaca6eacef102b7573925d256833157211866b0ae96eab5e78556e33e7346071370a4810cf79ae4db19ef37c1
+  data.tar.gz: c9c277fe627b1543496387b3cf683ee24b206691daae7656da8235b6a054b12b32d3c144f30c107e85ef2602c8d7d5cf5bc84560805f2e947457e07b96301081

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Version 0.2.1
+
+* Add search_in method.
+
 ## 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.

data/README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.org/arashm/PoParser.svg?branch=master)](https://travis-ci.org/arashm/PoParser)
 [![Coverage Status](https://img.shields.io/coveralls/arashm/PoParser.svg)](https://coveralls.io/r/arashm/PoParser)
 [![Code Climate](https://codeclimate.com/github/arashm/PoParser.png)](https://codeclimate.com/github/arashm/PoParser)
+[![Gem Version](https://badge.fury.io/rb/PoParser.svg)](http://badge.fury.io/rb/PoParser)
 
 A Ruby PO file parser, editor and generator. PO files are translation files generated by GNU/Gettext tool. This GEM is compatible with [GNU PO file specification](https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html). report misbehaviours and bugs, to the [issue tracker](https://github.com/arashm/PoParser/issues).
 
@@ -36,7 +37,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)
+# 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
@@ -132,7 +135,21 @@ entry.to_s(true)
 
 ### Searching
 
-`PO` is an `Enumerable`. All exciting methods from `Enumerable` are available in `PO`. the `PO` yields `Entry`.
+`PO` is an `Enumerable`. All exciting methods from `Enumerable` are available in `PO`. The `PO` yields `Entry`.
+
+```ruby
+po.find_all do |entry|
+  entry.msgid.str.match(/some text/i)
+end
+```
+
+There is a helper method that does the same:
+
+```ruby
+po.search_in(:msgstr, 'some string to search')
+```
+
+This method returns an array of matched entries.
 
 ### Saving
 You can simply save the PO file using the `PO` object:

data/lib/poparser/po.rb

@@ -87,6 +87,22 @@ module PoParser
     end
     alias_method :length, :size
 
+    # Search for entries with provided string
+    # 
+    # @param label [Symbol] One of the known LABELS
+    # @param string [String] String to search for
+    # @return [Array] Array of matched entries
+    def search_in(label, string)
+      if !LABELS.include? label.to_sym
+        raise ArgumentError, "Unknown key: #{label}"
+      end
+
+      find_all do |entry|
+        text = entry.send(label).str
+        text.match(/#{string}/i)
+      end
+    end
+
     # Shows statistics and status of the provided file in percentage.
     # 
     # @return [Hash] a hash of translated, untranslated and fuzzy percentages

data/lib/poparser/version.rb

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

data/poparser.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Runtime deps
-  spec.add_runtime_dependency "parslet"
+  spec.add_runtime_dependency "parslet", "~> 1.6"
 
   # Development deps
   spec.add_development_dependency "bundler", "~> 1.5"

data/spec/poparser/po_spec.rb

@@ -52,4 +52,23 @@ describe PoParser::Po do
     @po << cached
     expect(@po.size).to eq(1)
   end
+
+  context 'search' do
+    before do
+      path = Pathname.new('spec/poparser/fixtures/test.po').realpath
+      @po = PoParser::Tokenizer.new.extract_entries(path)
+    end
+
+    it 'raises error if label is not valid' do
+      expect{
+        @po.search_in(:wrong, 'sth') 
+      }.to raise_error(ArgumentError, 'Unknown key: wrong')
+    end
+
+    it 'searches in PO file' do
+      result = @po.search_in(:msgid, 'Invalid action')
+      expect(result.length).to eq(1)
+      expect(result[0].msgid.str).to eq('Invalid action. Someone probably posted another action just before you.')
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: PoParser
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Arash Mousavi
@@ -14,16 +14,16 @@ dependencies:
   name: parslet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -146,12 +146,12 @@ files:
 - spec/poparser/entry_spec.rb
 - spec/poparser/fixtures/multiline.po
 - spec/poparser/fixtures/plural.po
+- spec/poparser/fixtures/test.po
 - spec/poparser/fixtures/tokenizer.po
 - spec/poparser/message_spec.rb
 - spec/poparser/parser_spec.rb
 - spec/poparser/po_spec.rb
 - spec/poparser/poparser_spec.rb
-- spec/poparser/test.po
 - spec/poparser/tokenizer_spec.rb
 - spec/poparser/transformer_spec.rb
 - spec/spec_helper.rb
@@ -184,13 +184,12 @@ test_files:
 - spec/poparser/entry_spec.rb
 - spec/poparser/fixtures/multiline.po
 - spec/poparser/fixtures/plural.po
+- spec/poparser/fixtures/test.po
 - spec/poparser/fixtures/tokenizer.po
 - spec/poparser/message_spec.rb
 - spec/poparser/parser_spec.rb
 - spec/poparser/po_spec.rb
 - spec/poparser/poparser_spec.rb
-- spec/poparser/test.po
 - spec/poparser/tokenizer_spec.rb
 - spec/poparser/transformer_spec.rb
 - spec/spec_helper.rb
-has_rdoc: