PoParser 3.2.0 → 3.2.5

data/lib/poparser/header.rb

@@ -1,37 +1,38 @@
+# frozen_string_literal: true
+
 module PoParser
+  # The very first entry of the PO file is considered the header
   class Header
     attr_reader :entry, :original_configs, :flag
     attr_accessor :comments, :pot_creation_date, :po_revision_date, :project_id,
-            :report_to, :last_translator, :team, :language, :charset,
-            :encoding, :plural_forms
+      :report_to, :last_translator, :team, :language, :charset,
+      :encoding, :plural_forms
 
     def initialize(entry)
       @entry            = entry
-      @comments         = entry.translator_comment.value
+      @comments         = entry.translator_comment.value unless entry.translator_comment.nil?
       @original_configs = convert_msgstr_to_hash(entry.msgstr)
       @flag             = entry.flag
 
-      HEADER_LABELS.each do |k, v|
-        instance_variable_set "@#{k.to_s}".to_sym, @original_configs[v]
-      end
+      define_labels_instance_variables
     end
 
     def configs
-      hash = {}
-      HEADER_LABELS.each do |k, v|
+      configs = HEADER_LABELS.each_with_object({}) do |(k, v), hash|
         hash[v] = instance_variable_get "@#{k}".to_sym
       end
-      @original_configs.merge(hash)
+      @original_configs.merge(configs)
     end
 
     # Checks if the entry is fuzzy
     #
     # @return [Boolean]
     def fuzzy?
-      @flag.to_s.match('fuzzy') ? true : false
+      @flag.to_s.match?('fuzzy') ? true : false
     end
 
     # Flag the entry as Fuzzy
+    #
     # @return [Header]
     def flag_as_fuzzy
       @flag = 'fuzzy'
@@ -41,6 +42,7 @@ module PoParser
     # Set flag to a custom string
     def flag_as(flag)
       raise ArgumentError if flag.class != String
+
       @flag = flag
     end
 
@@ -57,7 +59,7 @@ module PoParser
       else
         string << "# #{@comments}".strip
       end
-      string << "#, #{@flag.to_s}" if @flag
+      string << "#, #{@flag}" if @flag
       string << "msgid \"\"\nmsgstr \"\""
       configs.each do |k, v|
         if v.nil? || v.empty?
@@ -79,18 +81,18 @@ module PoParser
       else
         string << "# #{@comments}".strip
       end
-      string << "#, #{@flag.to_s}" if @flag
+      string << "#, #{@flag}" if @flag
       string << "msgid \"\"\nmsgstr \"\""
       configs.each do |k, v|
-        if v.nil? || v.empty?
-          next
-        end
+        next if v.nil? || v.empty?
+
         string << "#{k}: #{v}\n".dump
       end
       string.join("\n")
     end
 
   private
+
     def convert_msgstr_to_hash(msgstr)
       options_array = msgstr.value.map do |options|
         options.split(':', 2).each do |k|
@@ -108,10 +110,16 @@ module PoParser
     # [['a', 'b'], ['c']] #=> [['a', 'bc']]
     def merge_to_previous_string(array)
       array.each_with_index do |key, index|
-        if key.length == 1
-          array[index -1][1] += key[0]
-          array.delete_at(index)
-        end
+        next unless key.length == 1
+
+        array[index - 1][1] += key[0]
+        array.delete_at(index)
+      end
+    end
+
+    def define_labels_instance_variables
+      HEADER_LABELS.each do |k, v|
+        instance_variable_set("@#{k}".to_sym, @original_configs[v])
       end
     end
   end

data/lib/poparser/message.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module PoParser
   class Message
     attr_accessor :type, :value
 
     def initialize(type, value)
       @type = type
-      @value  = value
+      @value = value
 
       remove_empty_line
     end
@@ -15,6 +17,7 @@ module PoParser
 
     def to_s(with_label = false)
       return to_str unless with_label
+
       if @value.is_a? Array
         remove_empty_line
         # multiline messages should be started with an empty line
@@ -37,6 +40,7 @@ module PoParser
     end
 
   private
+
     def remove_empty_line
       if @value.is_a? Array
         @value.shift if @value.first == ''
@@ -44,7 +48,7 @@ module PoParser
     end
 
     def label
-      if @type.to_s.match(/msgstr\[[0-9]\]/)
+      if /msgstr\[[0-9]\]/.match?(@type.to_s)
         @type
       else
         ENTRIES_LABELS[@type]

data/lib/poparser/po.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PoParser
   # Po class keeps all entries of a Po file
   class Po
@@ -7,7 +9,7 @@ module PoParser
 
     def initialize(args = {})
       @entries = []
-      @path    = args.fetch(:path, nil)
+      @path    = args[:path]
     end
 
     # add new entries to po file
@@ -25,68 +27,66 @@ module PoParser
     # @param entry [Hash, Array] a hash of entry contents or an array of hashes
     # @return [Po]
     def add(entry)
-      if entry.kind_of? Hash
-        import_hash(entry)
-      elsif entry.kind_of? Array
-        import_array(entry)
-      else
-        raise ArgumentError, 'Must be a hash or an array of hashes'
-      end
-      self
+      return import_hash(entry) if entry.is_a?(Hash)
+      return import_array(entry) if entry.is_a?(Array)
+
+      raise ArgumentError, 'Must be a hash or an array of hashes'
+    end
+    alias << add
+
+    # Delete entry from po file
+    #
+    # @example
+    #
+    #   delete(entry)
+    #
+    # @param entry [Entry] to be deleted
+    # @return [Entry]
+    def delete(entry)
+      raise(ArgumentError, 'Must be an Entry') unless entry.is_a?(PoParser::Entry)
+
+      @entries.delete(entry)
     end
-    alias_method :<<, :add
 
     # Returns an array of all entries in po file
     #
     # @param include_obsolete [Boolean] Whether include obsolete entries or not
     # @return [Array]
-    def entries(include_obsolete=false)
-      if include_obsolete
-        @entries
-      else
-        find_all do |entry|
-          !entry.obsolete?
-        end
-      end
+    def entries(include_obsolete = false)
+      return @entries if include_obsolete
+
+      find_all { |entry| !entry.obsolete? }
     end
-    alias_method :all, :entries
+    alias all entries
 
     # Finds all entries that are flaged as fuzzy
     #
     # @return [Array] an array of fuzzy entries
     def fuzzy
-      find_all do |entry|
-        entry.fuzzy?
-      end
+      find_all(&:fuzzy?)
     end
 
     # Finds all entries that are untranslated
     #
     # @return [Array] an array of untranslated entries
     def untranslated
-      find_all do |entry|
-        entry.untranslated?
-      end
+      find_all(&:untranslated?)
     end
 
     # Finds all entries that are translated
     #
     # @return [Array] an array of translated entries
     def translated
-      find_all do |entry|
-        entry.translated?
-      end
+      find_all(&:translated?)
     end
 
     # Finds all obsolete entries
     #
     # @return [Array] an array of obsolete entries
     def obsolete
-      find_all do |entry|
-        entry.obsolete?
-      end
+      find_all(&:obsolete?)
     end
-    alias_method :cached, :obsolete
+    alias cached obsolete
 
     # Count of all entries without counting obsolete entries
     #
@@ -94,7 +94,7 @@ module PoParser
     def size
       entries.length
     end
-    alias_method :length, :size
+    alias length size
 
     # Search for entries with provided string
     #
@@ -102,9 +102,7 @@ module PoParser
     # @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
+      raise(ArgumentError, "Unknown key: #{label}") unless LABELS.include?(label.to_sym)
 
       find_all do |entry|
         text = entry.send(label).str
@@ -121,9 +119,9 @@ module PoParser
       fuzzy_size        = fuzzy.size
 
       {
-        translated:   percentage(translated_size),
+        translated: percentage(translated_size),
         untranslated: percentage(untranslated_size),
-        fuzzy:        percentage(fuzzy_size)
+        fuzzy: percentage(fuzzy_size),
       }
     end
 
@@ -131,11 +129,8 @@ module PoParser
     #
     # @return [Array] array of hashes of entries
     def to_h
-      array = []
-      array << @header.to_h if @header
-      @entries.each do |entry|
-        array << entry.to_h
-      end
+      array = @entries.map(&:to_h)
+      array.unshift(@header.to_h) if @header
       array
     end
 
@@ -143,22 +138,17 @@ module PoParser
     #
     # @return [String]
     def to_s
-      array = []
-      array << @header.to_s if @header
+      array = @entries.map(&:to_s)
       # add a blank line after header
-      array << ""
-      @entries.each do |entry|
-        array << entry.to_s
-      end
+      array.unshift(@header.to_s, '') if @header
       array.join("\n")
     end
 
     # Saves the file to the provided path
     def save_file
       raise ArgumentError, 'Need a Path to save the file' if @path.nil?
-      File.open(@path, 'w') do |f|
-        f.write to_s
-      end
+
+      File.open(@path, 'w') { |file| file.write(to_s) }
     end
 
     def each
@@ -168,35 +158,45 @@ module PoParser
     end
 
     def inspect
-      "<#{self.class.name}, Translated: #{translated.length}(#{stats[:translated]}%) Untranslated: #{untranslated.length}(#{stats[:untranslated]}%) Fuzzy: #{fuzzy.length}(#{stats[:fuzzy]}%)>"
+      "<#{self.class.name}, Translated: #{translated.length}"\
+        "(#{stats[:translated]}%) Untranslated: #{untranslated.length}"\
+        "(#{stats[:untranslated]}%) Fuzzy: #{fuzzy.length}(#{stats[:fuzzy]}%)>"
     end
 
   private
+
     # calculates percentages based on total number of entries
     #
     # @param [Integer] number of entries
     # @return [Float] percentage of the provided entries
     def percentage(count)
-      ((count.to_f / self.size) * 100).round(1)
+      ((count.to_f / size) * 100).round(1)
     end
 
     def import_hash(entry)
       add_entry(entry)
+
+      self
     end
 
     def import_array(entry)
-      entry.each do |en|
-        add_entry(en)
-      end
+      entry.each { |en| add_entry(en) }
+
+      self
     end
 
+    # rubocop:disable Style/SafeNavigation
     def add_entry(entry)
-      if entry[:msgid] && entry[:msgid].length == 0
-        raise(RuntimeError, "Duplicate entry, header was already instantiated") if @header != nil
-        @header = Header.new(Entry.new(entry))
-      else
-        @entries << Entry.new(entry)
-      end
+      return add_header_entry(entry) if entry[:msgid] && entry[:msgid].empty?
+
+      @entries << Entry.new(entry)
+    end
+    # rubocop:enable Style/SafeNavigation
+
+    def add_header_entry(entry)
+      raise('Duplicate entry, header was already instantiated') if @header
+
+      @header = Header.new(Entry.new(entry))
     end
   end
 end

data/lib/poparser/tokenizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PoParser
   # Feed each block of PO file to Parser.
   class Tokenizer

data/lib/poparser/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PoParser
-  VERSION = "3.2.0"
+  VERSION = '3.2.5'
 end

data/poparser.gemspec

@@ -1,27 +1,28 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'poparser/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "PoParser"
+  spec.name          = 'PoParser'
   spec.version       = PoParser::VERSION
-  spec.authors       = ["Arash Mousavi"]
-  spec.email         = ["mousavi.arash@gmail.com"]
-  spec.summary       = %q{A PO file parser, editor and generator.}
-  spec.description   = %q{A PO file parser, editor and generator. PO files are translation files generated by GNU/Gettext tool.}
-  spec.homepage      = "http://github.com/arashm/poparser"
-  spec.license       = "MIT"
+  spec.authors       = ['Arash Mousavi']
+  spec.email         = ['mousavi.arash@gmail.com']
+  spec.summary       = 'A PO file parser, editor and generator.'
+  spec.description   = 'A PO file parser, editor and generator. PO files are translation files generated by GNU/Gettext tool.'
+  spec.homepage      = 'http://github.com/arashm/poparser'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^spec/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   # Runtime deps
-  spec.add_runtime_dependency "simple_po_parser", "~> 1.1.2"
+  spec.add_runtime_dependency 'simple_po_parser', '~> 1.1.2'
 
   # Development deps
-  spec.add_development_dependency "bundler", ">= 0"
-  spec.add_development_dependency "rake", ">= 0"
+  spec.add_development_dependency 'bundler', '>= 0'
+  spec.add_development_dependency 'rake', '>= 0'
 end

data/spec/poparser/po_spec.rb

@@ -20,6 +20,14 @@ describe PoParser::Po do
     expect(@po << entry).to be_a_kind_of PoParser::Po
   end
 
+  it 'should be able to remove an entry from Po' do
+    entries = [entry, entry.dup]
+    @po << entries
+    e = @po.entries.first
+    expect(@po.delete(e)).to eq e
+    expect(@po.delete(e)).to be_nil
+  end
+
   it 'should be able to add multiple entries' do
     entries = [entry, entry.dup]
     expect(@po << entries).to be_a_kind_of PoParser::Po
@@ -125,5 +133,4 @@ describe PoParser::Po do
       }.to raise_error(RuntimeError, "Duplicate entry, header was already instantiated")
     end
   end
-
 end