PoParser 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8018502bc7916464ebfb10b8c921f0f598f1df84
-  data.tar.gz: 68ff2631dd26b8b483e15a4fa74973dbc4036a77
+  metadata.gz: 69d284ad281dcb8de53d79a3b92fb1336ee5ca7a
+  data.tar.gz: a33178e0caffc6d999b3eaf0707cc1c39aa9551f
 SHA512:
-  metadata.gz: 5901356040586719f2f8e976902673bbc7e9c700fee986969779ef530f4abee445df61cd47648d3e952173f4d6d98abb77e4f683ee4549013f6ff6681c64ba19
-  data.tar.gz: '02183e6e633d9218dd15c10318401470517e788e57808f12212a48b024d3985230b38024cfbe56ff8a75a0e5b340e6cfcfaf00899e7a4090c4ede6a6c93f09bf'
+  metadata.gz: 7b780472d5fa52e5b21fffdd65f876c4cf7434bea99b917b6d41baa6c4ba5898b7a6d6175015dd7f098b9e381618c5b8f625d6900b15c496b8ce27bb7da2159d
+  data.tar.gz: 4bbb2febfc6990f33c2788b6a96cdee43b1c8e394925b009a72cc477ad7b7467d88a6174c94201a56330b7dd5a7971d2dc8f681d6980d3d5275f48bf7aed767d

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+  - 'spec/**/*'
+  - 'db/**/*'
+  - 'app/views/**/*'
+  - 'config/**/*'
+  - 'bin/*'
+  - 'Rakefile'
+  - 'node_modules/**/*'
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'lib/tasks/**/*'
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '()'
+    '%w': '()'

data/.travis.yml

@@ -2,7 +2,7 @@ bundler_args: --without development
 language: ruby
 sudo: false
 rvm:
-  - 2.1.9
-  - 2.2.5
-  - 2.3.1
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
 script: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 
+3.2.0 / 2017-06-29
+==================
+
+  * Deprecate passing path to parse and introduce parse_file
+  * Drop ruby 2.1 since it is not supported any more
+
 3.1.1 / 2017-06-22
 ==================
 

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 group :test do
   gem 'coveralls', :require => false
-  gem 'rspec', '~> 3.5.0'
+  gem 'rspec', '~> 3.6.0'
   gem 'awesome_print'
 end
 

data/README.md

@@ -27,9 +27,16 @@ Working with the GEM is pretty easy:
 
 ```ruby
 require 'poparser'
+
+content = File.read('example.po')
+po = PoParser.parse(content)
+# => <PoParser::Po, Translated: 68.1% Untranslated: 20.4% Fuzzy: 11.5%>
+
+# Or you could pass a file path:
+
 path = Pathname.new('example.po')
-po   = PoParser.parse(path)
-=> <PoParser::Po, Translated: 68.1% Untranslated: 20.4% Fuzzy: 11.5%>
+po = PoParser.parse_file(path)
+# => <PoParser::Po, Translated: 68.1% Untranslated: 20.4% Fuzzy: 11.5%>
 ```
 
 The `parse` method returns a `PO` object which contains all `Entries`:

data/lib/poparser.rb

@@ -13,8 +13,19 @@ require_relative 'poparser/version'
 
 module PoParser
   class << self
-    def parse(path)
-      Tokenizer.new.extract_entries(path)
+    def parse(payload)
+      if File.exist?(payload)
+        Kernel.warn 'DEPRICATION WARNING: `parse` only accepts content of a '\
+          'PO file as a string and this behaviour will be removed on next '\
+          'major release. Use `parse_file` instead.'
+        parse_file(payload)
+      else
+        Tokenizer.new.extract(payload)
+      end
+    end
+
+    def parse_file(path)
+      Tokenizer.new(true).extract(path)
     end
   end
 end

data/lib/poparser/tokenizer.rb

@@ -1,22 +1,33 @@
 module PoParser
   # Feed each block of PO file to Parser.
   class Tokenizer
-    def initialize
+    def initialize(is_file = false)
       @po = Po.new
+      @is_file = is_file
     end
 
-    def extract_entries(path)
-      @po.path = path
-      File.open(path, 'r:utf-8').each_line("\n\n") do |block|
-        block.strip!
-        @po << parse_block(block) if block != ''
+    def extract(payload)
+      if @is_file
+        @po.path = payload
+        payload = File.read(payload, mode: 'r:utf-8')
       end
-      @po
+
+      extract_entries(payload)
     end
 
   private
+
     def parse_block(block)
-      hash = SimplePoParser.parse_message(block)
+      SimplePoParser.parse_message(block)
+    end
+
+    def extract_entries(payload)
+      payload.split("\n\n").each do |block|
+        block.strip!
+        @po << parse_block(block) if block != ''
+      end
+
+      @po
     end
   end
 end

data/lib/poparser/version.rb

@@ -1,3 +1,3 @@
 module PoParser
-  VERSION = "3.1.1"
+  VERSION = "3.2.0"
 end

data/spec/poparser/entry_spec.rb

@@ -132,8 +132,8 @@ describe PoParser::Entry do
     end
 
     it 'should further parse the obsolete content' do
-      path = Pathname.new('spec/poparser/fixtures/complex_obsolete.po').realpath
-      @po = PoParser::Tokenizer.new.extract_entries(path)
+      file = File.read('spec/poparser/fixtures/complex_obsolete.po')
+      @po = PoParser::Tokenizer.new.extract(file)
       obsolete_entry = @po.obsolete.first
       expect(obsolete_entry.obsolete?).to be_truthy
       expect(obsolete_entry.msgctxt.value).to eq('Context')

data/spec/poparser/po_spec.rb

@@ -11,7 +11,7 @@ describe PoParser::Po do
     }
   end
 
-  before(:each) do
+  before do
     @po = PoParser::Po.new
   end
 
@@ -68,7 +68,7 @@ describe PoParser::Po do
   context 'search' do
     before do
       path = Pathname.new('spec/poparser/fixtures/test.po').realpath
-      @po = PoParser::Tokenizer.new.extract_entries(path)
+      @po = PoParser::Tokenizer.new(true).extract(path)
     end
 
     it 'raises error if label is not valid' do
@@ -87,7 +87,7 @@ describe PoParser::Po do
   context 'Header' do
     before do
       path = Pathname.new('spec/poparser/fixtures/header.po').realpath
-      @po = PoParser::Tokenizer.new.extract_entries(path)
+      @po = PoParser::Tokenizer.new(true).extract(path)
     end
 
     it 'should respond to header' do
@@ -119,9 +119,10 @@ describe PoParser::Po do
 
     it 'throws error if there\'re two header string' do
       path = Pathname.new('spec/poparser/fixtures/header_error.po').realpath
+
       expect{
-        @po = PoParser::Tokenizer.new.extract_entries(path)
-        }.to raise_error(RuntimeError, "Duplicate entry, header was already instantiated")
+        PoParser::Tokenizer.new(true).extract(path)
+      }.to raise_error(RuntimeError, "Duplicate entry, header was already instantiated")
     end
   end
 

data/spec/poparser/poparser_spec.rb

@@ -3,6 +3,7 @@ require "spec_helper"
 
 describe PoParser do
   let(:po_file) { Pathname.new('spec/poparser/fixtures/tokenizer.po').realpath }
+  let(:po_file_content) { File.read('spec/poparser/fixtures/tokenizer.po') }
   let(:header_fixture) { Pathname.new('spec/poparser/fixtures/header.po').realpath }
   let(:multiline_fixture) { Pathname.new('spec/poparser/fixtures/multiline.po').realpath }
   let(:plural_fixture) { Pathname.new('spec/poparser/fixtures/plural.po').realpath }
@@ -12,6 +13,20 @@ describe PoParser do
     expect(PoParser.parse(po_file)).to be_a_kind_of PoParser::Po
   end
 
+  it 'should print deprecation warning when passing file to parse' do
+    expect(Kernel).to receive(:warn).with(
+      'DEPRICATION WARNING: `parse` only accepts content of a PO '\
+      'file as a string and this behaviour will be removed on next major '\
+      'release. Use `parse_file` instead.'
+    ).once
+
+    PoParser.parse(po_file)
+  end
+
+  it 'parses a payload' do
+    expect(PoParser.parse(po_file_content)).to be_a_kind_of PoParser::Po
+  end
+
   it 'correclty parses header fixture' do
     entry = PoParser::Entry.new(
     {
@@ -132,5 +147,4 @@ describe PoParser do
     allow_any_instance_of(PoParser::Header).to receive(:puts)
     expect(PoParser.parse(test_fixture).to_s).to eq(expected_result.to_s)
   end
-
 end

data/spec/poparser/tokenizer_spec.rb

@@ -2,20 +2,18 @@
 require "spec_helper.rb"
 
 describe PoParser::Tokenizer do
-  let(:token)  { PoParser::Tokenizer.new }
+  let(:token)  { PoParser::Tokenizer.new(true) }
   let(:po_file){ Pathname.new('spec/poparser/fixtures/tokenizer.po').realpath }
   let(:po_file_empty_line){ Pathname.new('spec/poparser/fixtures/tokenizer_empty_line.po').realpath }
   let(:result) { [{:reference=>"templates:105", :msgid=>"Afrikaans", :msgstr=>"آفریقایی"}, {:flag=>"fuzzy", :msgid=>"Afrikaans", :msgstr=>"آفریقایی" }] }
 
   it 'should be able to extracts entries' do
-    expect(
-      token.extract_entries(po_file).to_h
-    ).to eq(result)
+    expect(token.extract(po_file).to_h).to eq(result)
   end
 
   it 'should gracefully handle empty lines at the beginning' do
     expect(
-      token.extract_entries(po_file_empty_line).to_h
+      token.extract(po_file_empty_line).to_h
     ).to eq(result)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: PoParser
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Arash Mousavi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_po_parser
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile