PoParser 3.2.0 → 3.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 69d284ad281dcb8de53d79a3b92fb1336ee5ca7a
-  data.tar.gz: a33178e0caffc6d999b3eaf0707cc1c39aa9551f
+SHA256:
+  metadata.gz: 392d8f812cf03d26f88eb36e87a7123cdec137c5858e516b236c02890a987c7d
+  data.tar.gz: 1fc9a420db5ec1074f0a214d272d8863c390fccab25c18af6c5b423967a88f38
 SHA512:
-  metadata.gz: 7b780472d5fa52e5b21fffdd65f876c4cf7434bea99b917b6d41baa6c4ba5898b7a6d6175015dd7f098b9e381618c5b8f625d6900b15c496b8ce27bb7da2159d
-  data.tar.gz: 4bbb2febfc6990f33c2788b6a96cdee43b1c8e394925b009a72cc477ad7b7467d88a6174c94201a56330b7dd5a7971d2dc8f681d6980d3d5275f48bf7aed767d
+  metadata.gz: 3c03f5ced1b5a31b785b32edc91b7a9f1979a0132e469adf7422de5124947feca04e5aaab4a32fa7b8d41663ff517db012f4a56f918f6cc37b8eb12fcd94703c
+  data.tar.gz: b50ec41094db0f27066a3b7482e7a0b7e307e7f9afbf54b81c07f97190f3419bc32d8c53e02767dfbaea95e75c6b8878952720ff847b566af73a928222a23ca6

data/.github/workflows/ruby.yml

@@ -0,0 +1,41 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake
+
+    - name: Coveralls
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        path-to-lcov: "./coverage/lcov.info"

data/.rubocop.yml

@@ -1,13 +1,8 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
   Exclude:
   - 'spec/**/*'
-  - 'db/**/*'
-  - 'app/views/**/*'
-  - 'config/**/*'
   - 'bin/*'
-  - 'Rakefile'
-  - 'node_modules/**/*'
 
 Bundler/OrderedGems:
   Enabled: false
@@ -27,9 +22,28 @@ Layout/AlignParameters:
   EnforcedStyle: with_fixed_indentation
 
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  Enabled: true
 
 Style/PercentLiteralDelimiters:
   PreferredDelimiters:
     '%i': '()'
     '%w': '()'
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Layout/EmptyLines:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 100
+  IgnoreCopDirectives: True

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+3.2.4 / 2019-10-12
+==================
+
+  * remove rspec binstub, Courtesy of @Fryguy
+
+3.2.3 / 2019-03-23
+==================
+
+  * Entries can be removed, Courtesy of @lremes
+  * Cleanups and refactors
+
+3.2.2 / 2018-05-03
+==================
+
+  * Fix warning in JRuby 9.1.14.0 Courtesy of @remofritzsche
+
+3.2.1 / 2017-09-05
+==================
+
+  * Update header.rb (#21) Courtesy of @mallowigi
 
 3.2.0 / 2017-06-29
 ==================

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mousavi.arash@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 group :test do
-  gem 'coveralls', :require => false
-  gem 'rspec', '~> 3.6.0'
+  gem 'simplecov',      require: false
+  gem 'simplecov-lcov', require: false
+  gem 'rspec', '~> 3.9'
   gem 'awesome_print'
 end
 
 group :development do
-  gem 'guard-rspec'
   gem 'ruby-prof'
 end
 
 group :test, :development do
-  gem 'pry-byebug', :platforms => :mri
+  gem 'pry-byebug', platforms: :mri
 end
 
 # Specify your gem's dependencies in poparser.gemspec

data/README.md

@@ -1,7 +1,7 @@
 # PoParser
 
-[![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)
+![Build Status](https://github.com/arashm/poparser/workflows/Ruby/badge.svg?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/arashm/PoParser/badge.svg)](https://coveralls.io/github/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)
 
@@ -175,6 +175,12 @@ entry.to_h
 entry.to_s
 ```
 
+To remove an entry from the PO, use `PO#delete`
+
+```ruby
+po.delete(entry)
+```
+
 ### Searching
 
 `PO` is an `Enumerable`. All exciting methods from `Enumerable` are available in `PO`. The `PO` yields `Entry`.

data/lib/poparser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # External Libs
 require 'simple_po_parser'
 

data/lib/poparser/comment.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 module PoParser
   class Comment
     attr_accessor :type, :value
 
     def initialize(type, value)
       @type = type
-      @value  = value
+      @value = value
 
-      if @type.to_s =~ /^previous_/ # these behave more like messages
-        remove_empty_line
-      end
+      # these behave more like messages
+      remove_empty_line if /^previous_/.match?(@type.to_s)
     end
 
     def to_s(with_label = false)
       return to_str unless with_label
+
       if @value.is_a? Array
-        if @type.to_s =~ /^previous_/ # these behave more like messages
+        if /^previous_/.match?(@type.to_s) # these behave more like messages
           string = ["#{COMMENTS_LABELS[@type]} \"\"\n"]
           @value.each do |str|
             string << "#| \"#{str}\"\n".gsub(/[\p{Blank}]+$/, '')
@@ -27,7 +29,7 @@ module PoParser
         end
         return string.join
       else
-        if @type.to_s =~ /^previous_/ # these behave more like messages
+        if /^previous_/.match?(@type.to_s) # these behave more like messages
           "#{COMMENTS_LABELS[@type]} \"#{@value}\"\n".gsub(/[\p{Blank}]+$/, '')
         else
           # removes the space but not newline at the end
@@ -38,7 +40,7 @@ module PoParser
 
     def to_str
       if @value.is_a?(Array)
-        if @type.to_s =~ /^previous_/ # these behave more like messages
+        if /^previous_/.match?(@type.to_s) # these behave more like messages
           @value.join
         else
           @value.join("\n")
@@ -53,10 +55,9 @@ module PoParser
     end
 
   private
+
     def remove_empty_line
-      if @value.is_a? Array
-        @value.shift if @value.first == ''
-      end
+      @value.shift if @value.is_a?(Array) && @value.first == ''
     end
   end
 end

data/lib/poparser/constants.rb

@@ -1,34 +1,36 @@
+# frozen_string_literal: true
+
 module PoParser
   COMMENTS_LABELS = {
-    :translator_comment => '#',
-    :extracted_comment => '#.',
-    :reference => '#:',
-    :flag => '#,',
-    :previous_msgctxt => '#| msgctxt',
-    :previous_msgid => '#| msgid',
-    :previous_msgid_plural => '#| msgid_plural',
-    :obsolete => '#~'
-  }
+    translator_comment: '#',
+    extracted_comment: '#.',
+    reference: '#:',
+    flag: '#,',
+    previous_msgctxt: '#| msgctxt',
+    previous_msgid: '#| msgid',
+    previous_msgid_plural: '#| msgid_plural',
+    obsolete: '#~',
+  }.freeze
 
   ENTRIES_LABELS = {
-    :msgctxt => 'msgctxt',
-    :msgid => 'msgid',
-    :msgid_plural => 'msgid_plural',
-    :msgstr => 'msgstr'
-  }
+    msgctxt: 'msgctxt',
+    msgid: 'msgid',
+    msgid_plural: 'msgid_plural',
+    msgstr: 'msgstr',
+  }.freeze
 
   LABELS = COMMENTS_LABELS.merge(ENTRIES_LABELS).keys
 
   HEADER_LABELS = {
-    :pot_creation_date => "POT-Creation-Date",
-    :po_revision_date => "PO-Revision-Date",
-    :project_id => "Project-Id-Version",
-    :report_to => "Project-Id-Version",
-    :last_translator => "Last-Translator",
-    :team => "Language-Team",
-    :language => "Language",
-    :charset => "Content-Type",
-    :encoding => "Content-Transfer-Encoding",
-    :plural_forms => "Plural-Forms"
-  }
+    pot_creation_date: 'POT-Creation-Date',
+    po_revision_date: 'PO-Revision-Date',
+    project_id: 'Project-Id-Version',
+    report_to: 'Project-Id-Version',
+    last_translator: 'Last-Translator',
+    team: 'Language-Team',
+    language: 'Language',
+    charset: 'Content-Type',
+    encoding: 'Content-Transfer-Encoding',
+    plural_forms: 'Plural-Forms',
+  }.freeze
 end

data/lib/poparser/entry.rb

@@ -1,66 +1,49 @@
+# frozen_string_literal: true
+
 module PoParser
-  class Entry
-    # TODO: raise error if a label is not known
+  # A single translation entity in a PO file
+  class Entry # rubocop:disable Metrics/ClassLength
     def initialize(args = {})
       # Defining all instance variables to prevent warnings
-      LABELS.each do |label|
-        instance_variable_set "@#{label.to_s}".to_sym, nil
-      end
-
-      # Set passed arguments
-      args.each do |name, value|
-        raise(ArgumentError, "Unknown label #{name}") if !valid_label? name
-        set_instance_variable(name, value)
-      end
-
+      define_labels_instance_variables
+      define_args_instance_variables(args)
       define_writer_methods(COMMENTS_LABELS, 'Comment')
       define_writer_methods(ENTRIES_LABELS, 'Message')
       define_reader_methods
-
-      self.class.send(:alias_method, :translate, :msgstr=)
-      self.class.send(:alias_method, :cached, :obsolete)
-      self.class.send(:alias_method, :cached=, :obsolete=)
-      # alias for backward compatibility of this typo
-      self.class.send(:alias_method, :refrence, :reference)
-      self.class.send(:alias_method, :refrence=, :reference=)
-      if self.obsolete?
-        obsolete_content = SimplePoParser.parse_message(obsolete.value.join("\n").gsub(/^\|/, "#|"))
-        obsolete_content.each do |name, value|
-          raise(ArgumentError, "Unknown label #{name}") if !valid_label? name
-          set_instance_variable(name, value)
-        end
-      end
+      define_aliases
+      define_obsolete_instance_variables
     end
 
     # If entry doesn't have any msgid, it's probably a obsolete entry that is
-    # kept by the program for later use. These entries will usually start with: #~
+    # kept by the program for later use. These entries will usually start
+    # with: #~
     #
     # @return [Boolean]
     def obsolete?
       !@obsolete.nil?
     end
-    alias_method :cached?, :obsolete?
+    alias cached? obsolete?
 
     # Checks if the entry is untraslated
     #
     # @return [Boolean]
     def untranslated?
       return false if obsolete? || fuzzy?
-      if @msgstr.is_a? Array
-        return @msgstr.map {|ms| ms.str}.join.empty?
-      end
+      return @msgstr.map(&:str).join.empty? if @msgstr.is_a? Array
+
       @msgstr.nil? || @msgstr.str.empty?
     end
-    alias_method :incomplete? , :untranslated?
+    alias incomplete? untranslated?
 
     # Checks if the entry is translated
     #
     # @return [Boolean]
     def translated?
       return false if obsolete? || fuzzy?
-      not untranslated?
+
+      !untranslated?
     end
-    alias_method :complete? , :translated?
+    alias complete? translated?
 
     # Checks if the entry is plural
     #
@@ -74,10 +57,12 @@ module PoParser
     # @return [Boolean]
     def fuzzy?
       return false if obsolete?
-      @flag.to_s.match('fuzzy') ? true : false
+
+      @flag.to_s.match?('fuzzy') ? true : false
     end
 
     # Flag the entry as Fuzzy
+    #
     # @return [Entry]
     def flag_as_fuzzy
       @flag = 'fuzzy'
@@ -87,58 +72,54 @@ module PoParser
     # Set flag to a custom string
     def flag_as(flag)
       raise ArgumentError if flag.class != String
+
       @flag = flag
     end
 
     # Convert entry to a hash key value
+    #
     # @return [Hash]
     def to_h
-      hash = {}
-      instance_variables.each do |label|
+      instance_variables.each_with_object({}) do |label, hash|
         object = instance_variable_get(label)
         # If it's a plural msgstr
-        if object.is_a? Array
+        if object.is_a?(Array)
           object.each do |entry|
-            hash[entry.type] = entry.to_s if not entry.nil?
+            hash[entry.type] = entry.to_s unless entry.nil?
           end
         else
-          hash[object.type] = object.to_s if not object.nil?
+          hash[object.type] = object.to_s unless object.nil?
         end
       end
-      hash
     end
 
     # Convert entry to a string
+    #
     # @return [String]
     def to_s
-      lines = []
-      LABELS.each do |label|
+      LABELS.each_with_object([]) do |label, arr|
         object = instance_variable_get("@#{label}".to_sym)
         # If it's a plural msgstr
-        if object.is_a? Array
-          object.each do |entry|
-            lines << entry.to_s(true) if not entry.nil?
-          end
+        if object.is_a?(Array)
+          arr.push(*object.map { |entry| entry.to_s(true) }.compact)
         else
-          lines << object.to_s(true) if not object.nil?
+          arr << object.to_s(true) unless object.nil?
         end
-      end
-
-      lines.join
+      end.join
     end
 
     def inspect
       to_s
     end
 
-    private
+  private
 
     def set_instance_variable(name, value)
       if COMMENTS_LABELS.include? name
-        instance_variable_set "@#{name.to_s}".to_sym, Comment.new(name, value)
+        instance_variable_set "@#{name}".to_sym, Comment.new(name, value)
       elsif ENTRIES_LABELS.include? name
-        instance_variable_set "@#{name.to_s}".to_sym, Message.new(name, value)
-      elsif name.to_s.match(/^msgstr\[[0-9]\]/)
+        instance_variable_set "@#{name}".to_sym, Message.new(name, value)
+      elsif /^msgstr\[[0-9]\]/.match?(name.to_s)
         # If it's a plural msgstr
         @msgstr ||= []
         @msgstr << Message.new(name, value)
@@ -147,29 +128,34 @@ module PoParser
 
     def define_writer_methods(labels, object)
       object = PoParser.const_get(object)
-      labels.each do |type, mark|
-        unless Entry.method_defined? "#{type}=".to_sym
-          self.class.send(:define_method, "#{type}=".to_sym, lambda { |val|
-            if instance_variable_get("@#{type}".to_sym).is_a? object
-              klass      = instance_variable_get "@#{type}".to_sym
-              klass.type = type
-              klass.value  = val
-            else
-              instance_variable_set "@#{type}".to_sym, object.new(type, val)
-            end
-            # return value
-            instance_variable_get "@#{type}".to_sym
-          })
-        end
+
+      labels.each do |type, _mark|
+        next if Entry.method_defined?("#{type}=".to_sym)
+
+        define_writer_method(type, object)
       end
     end
 
+    def define_writer_method(type, object)
+      self.class.send(:define_method, "#{type}=".to_sym, lambda { |val|
+        if instance_variable_get("@#{type}".to_sym).is_a? object
+          klass       = instance_variable_get "@#{type}".to_sym
+          klass.type  = type
+          klass.value = val
+        else
+          instance_variable_set "@#{type}".to_sym, object.new(type, val)
+        end
+        # return value
+        instance_variable_get "@#{type}".to_sym
+      })
+    end
+
     def define_reader_methods
       LABELS.each do |label|
-        unless Entry.method_defined? "#{label}".to_sym
-          self.class.send(:define_method, label.to_sym) do
-            instance_variable_get "@#{label}".to_sym
-          end
+        next if Entry.method_defined? label.to_s.to_sym
+
+        self.class.send(:define_method, label.to_sym) do
+          instance_variable_get "@#{label}".to_sym
         end
       end
     end
@@ -177,5 +163,41 @@ module PoParser
     def valid_label?(label)
       !(label =~ /^msgstr\[[0-9]\]/).nil? || LABELS.include?(label)
     end
+
+    def define_labels_instance_variables
+      LABELS.each { |label| instance_variable_set("@#{label}".to_sym, nil) }
+    end
+
+    def define_obsolete_instance_variables
+      return unless obsolete?
+
+      obsolete_content = SimplePoParser.parse_message(
+        obsolete.value.join("\n").gsub(/^\|/, '#|'),
+      )
+
+      obsolete_content.each do |name, value|
+        raise(ArgumentError, "Unknown label #{name}") unless valid_label? name
+
+        set_instance_variable(name, value)
+      end
+    end
+
+    def define_args_instance_variables(args)
+      # Set passed arguments
+      args.each do |name, value|
+        raise(ArgumentError, "Unknown label #{name}") unless valid_label? name
+
+        set_instance_variable(name, value)
+      end
+    end
+
+    def define_aliases
+      self.class.send(:alias_method, :translate, :msgstr=)
+      self.class.send(:alias_method, :cached, :obsolete)
+      self.class.send(:alias_method, :cached=, :obsolete=)
+      # alias for backward compatibility of this typo
+      self.class.send(:alias_method, :refrence, :reference)
+      self.class.send(:alias_method, :refrence=, :reference=)
+    end
   end
 end