gettext-setup 0.26 → 0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d76056589632a45d8d207a37b534aae61cca3aa2
-  data.tar.gz: 64c7222fcd4ef7a1f0ce2f78fe63c25f0a2e6ac5
+  metadata.gz: 26b13ff0d0fa9a44b156dbc8d9196fa7f0ec2974
+  data.tar.gz: df14184c767513cf61870658ef8968c5e8d76fbc
 SHA512:
-  metadata.gz: 664b2b64c91f93ea96ae19a3eb3add4e125d2b0dd9b5b3d9502d74845ae9f890839f66ae2fd549fac8224df0981abf8004e43a908a99ac567d9b6aa231e70729
-  data.tar.gz: 7f604a999607a42879c2975382184274f02529b2321b91a38b1cf89f52bf7bb88e55ad00108fcb7be34f1722a1315594ab2dcc1a56837a25a317c580325d1906
+  metadata.gz: 74b6d2e5689e91e796a0c8c75e767c1fbffc955b752d4dd340abdfa5a25391ca1d29649efd6cea16fbb5d58a23e85da9f04ff0dc955719419eb93614aff79856
+  data.tar.gz: 35d1f5cf80a0674c907add49aff503c5965cf9c6c3939be9ff8956548bdb7aeb8ae391b43732c8125527191cb0df4a3cd6d080e3500358daaff9f9f0889ce06c

data/README.md

@@ -99,3 +99,14 @@ E.g. `#. The placeholder in this string represents the name of a parameter.`
 4. When a PO file reaches 100% translated and reviewed, a webhook pushes it back to the source repo ready to be consumed by your app. 
 
 5. Your app checks the user's locale settings (the browser settings for web apps, or the system settings for the CLI). If we support the user's preferred locale, the app will display strings in the user's language. Otherwise, it defaults to English.
+
+## Merge Pot files rake task
+
+The rake task that merges .pot files is present for the internationalisation of a module. This task uses 'msgcat', which is only natively present on OSes that are GNU based. For running this task locally on another OS you will need to download the gettext pkg and install it locally:
+https://pkgs.org/download/gettext
+
+This task will run within the gettext setup locales_path provided by GettextSetup. The result will be a merged pot file created from all pot files kept in this location.
+
+By default the merged pot file is locales_path/project_name.pot. This can be overridden when calling the method by providing a chosen path.
+
+Please note: Since the default merged file name is project_name.pot, it will override anything of that name within the locales directory.

data/lib/gettext-setup/gettext_setup.rb

@@ -98,7 +98,7 @@ module GettextSetup
     explicit = Dir.glob(File.absolute_path('*/*.po', locales_path)).map do |x|
       File.basename(File.dirname(x))
     end
-    (explicit + [default_locale]).uniq
+    ([default_locale] + explicit).uniq
   end
 
   # Given an HTTP Accept-Language header return the locale with the highest

data/lib/gettext-setup/pot.rb

@@ -50,9 +50,14 @@ module GettextSetup
       return true
     end
 
-    def self.generate_new_pot(locales_path = GettextSetup.locales_path, path = nil)
+    # @param [:locales_path] opts
+    #   The directory for the locales.
+    # @param [:target_path] opts
+    #   The output path for the new POT file.
+    def self.generate_new_pot(opts = {})
+      locales_path = opts[:locales_path] || GettextSetup.locales_path
       GettextSetup.initialize(locales_path)
-      path ||= pot_file_path
+      target_path = opts[:target_path] || pot_file_path
       config = GettextSetup.config
       package_name = config['package_name']
       bugs_address = config['bugs_address']
@@ -60,7 +65,7 @@ module GettextSetup
       # Done this way to allow the user to enter an empty string in the config.
       comments_tag = config.key?('comments_tag') ? config['comments_tag'] : 'TRANSLATORS'
       version = `git describe`
-      system("rxgettext -o #{path} --no-wrap --sort-by-file " \
+      system("rxgettext -o #{target_path} --no-wrap --sort-by-file " \
              "--add-comments#{comments_tag.to_s == '' ? '' : '=' + comments_tag} --msgid-bugs-address '#{bugs_address}' " \
              "--package-name '#{package_name}' " \
              "--package-version '#{version}' " \
@@ -116,13 +121,13 @@ module GettextSetup
 
       if !File.exist? path
         puts 'No existing POT file, generating new'
-        result = GettextSetup::Pot.generate_new_pot(locales_path, path)
+        result = GettextSetup::Pot.generate_new_pot(locales_path: locales_path, target_path: path)
         puts "POT file #{path} has been generated" if result
         result
       else
         old_pot = path + '.old'
         File.rename(path, old_pot)
-        result = GettextSetup::Pot.generate_new_pot(locales_path, path)
+        result = GettextSetup::Pot.generate_new_pot(locales_path: locales_path, target_path: path)
         if !result
           puts 'POT creation failed'
           result
@@ -137,5 +142,34 @@ module GettextSetup
         end
       end
     end
+
+    # @param [:locales_path] opts
+    #   The directory for the locales.
+    def self.merge(opts = {})
+      locales_path = opts[:locales_path] || GettextSetup.locales_path
+      GettextSetup.initialize(locales_path)
+      target_filename = GettextSetup.config['project_name'] + '.pot'
+      target_path = File.expand_path(target_filename, locales_path)
+      oldpot_dir = File.expand_path('oldpot', locales_path)
+      oldpot_path = File.expand_path("oldpot/old_#{target_filename}", locales_path)
+
+      if File.exist? target_path
+        FileUtils.mkdir_p(oldpot_dir)
+        begin
+          FileUtils.mv(target_path, oldpot_path)
+        rescue
+          raise "There was a problem creating .pot backup #{oldpot_path}, merge failed."
+        end
+        puts "Warning - #{target_filename} already exists and will be relocated to oldpot/old_#{target_filename}."
+      end
+
+      locales_glob = Dir.glob("#{locales_path}/*.pot")
+      cmd = "msgcat #{locales_glob.join(' ')} -o #{target_path}"
+      _, _, _, wait = Open3.popen3(cmd)
+      exitstatus = wait.value
+      raise 'PO files failed to merge' unless exitstatus.success?
+      puts "PO files have been successfully merged, #{target_filename} has been created."
+      exitstatus
+    end
   end
 end

data/lib/tasks/gettext.rake

@@ -18,11 +18,12 @@ namespace :gettext do
   end
 
   desc 'Generate POT file'
-  task :pot do
+  task :pot, [:target_path] do |_, args|
     begin
-      result = GettextSetup::Pot.generate_new_pot
-      if result
-        puts "POT file #{GettextSetup::Pot.pot_file_path} has been generated"
+      target_path = args.target_path
+      if GettextSetup::Pot.generate_new_pot(target_path: target_path)
+        target_path = GettextSetup::Pot.pot_file_path if target_path.nil?
+        puts "POT file #{target_path} has been generated"
       else
         exit 1
       end
@@ -54,4 +55,14 @@ namespace :gettext do
       puts e.message
     end
   end
+
+  desc 'Merge all Pot files within locales folder'
+  task :merge do
+    begin
+      result = GettextSetup::Pot.merge
+      exit 1 unless result
+    rescue GettextSetup::NoConfigFoundError => e
+      puts e.message
+    end
+  end
 end

data/locales/config-sample.yaml

@@ -6,7 +6,7 @@ gettext:
   # called <project_name>.pot?
   project_name: 'sinatra-i18n'
   # This is used in comments in the .pot and .po files to indicate what
-  # project the files belong to and should bea little more desctiptive than
+  # project the files belong to and should bea little more descriptive than
   # <project_name>
   package_name: Sinatra i18n demo
   # The locale that the default messages in the .pot file are in

data/spec/fixtures/merge_locales/config.yaml

@@ -0,0 +1,21 @@
+---
+# This is the project-specific configuration file for setting up
+# fast_gettext for your project.
+gettext:
+  # This is used for the name of the .pot and .po files; they will be
+  # called <project_name>.pot?
+  project_name: 'merge_locales'
+  # This is used in comments in the .pot and .po files to indicate what
+  # project the files belong to and should bea little more desctiptive than
+  # <project_name>
+  package_name: Merge locales
+  # The locale that the default messages in the .pot file are in
+  default_locale: en
+  # The email used for sending bug reports.
+  bugs_address: docs@puppetlabs.com
+  # The holder of the copyright.
+  copyright_holder: Puppet, LLC.
+  # Patterns for +Dir.glob+ used to find all files that might contain
+  # translatable content, relative to the project root directory
+  source_files:
+  - 'spec/fixtures/merge_locales/*.rb'

data/spec/fixtures/tmp_locales/config.yaml

@@ -0,0 +1,22 @@
+---
+# This is the project-specific configuration file for setting up
+# fast_gettext for your project.
+gettext:
+  # This is used for the name of the .pot and .po files; they will be
+  # called <project_name>.pot?
+  project_name: 'sinatra-i18n'
+  # This is used in comments in the .pot and .po files to indicate what
+  # project the files belong to and should bea little more desctiptive than
+  # <project_name>
+  package_name: Sinatra i18n demo
+  # The locale that the default messages in the .pot file are in
+  default_locale: en
+  # The email used for sending bug reports.
+  bugs_address: docs@puppetlabs.com
+  # The holder of the copyright.
+  copyright_holder: Puppet Labs, LLC.
+  # Patterns for +Dir.glob+ used to find all files that might contain
+  # translatable content, relative to the project root directory
+  source_files:
+    - 'lib/**/*.rb'
+    - 'spec/**/*.rb'

data/spec/fixtures/tmp_locales/de/sinatra-i18n.po

@@ -0,0 +1,23 @@
+# German translations for Sinatra i18n demo package.
+# Copyright (C) 2016 Puppet Labs, LLC.
+# This file is distributed under the same license as the Sinatra i18n demo package.
+# Automatically generated, 2016.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Sinatra i18n demo \n"
+"Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
+"POT-Creation-Date: 2016-04-05 10:39-0700\n"
+"PO-Revision-Date: 2016-02-26 18:21-0800\n"
+"Last-Translator: Automatically generated\n"
+"Language-Team: none\n"
+"Language: de\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: ../app.rb:14
+msgid "Hello, world!"
+msgstr "Hallo, Welt!"
+

data/spec/fixtures/tmp_locales/sinatra-i18n.pot

@@ -0,0 +1,40 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2017 Puppet Labs, LLC.
+# This file is distributed under the same license as the Sinatra i18n demo package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2017.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: Sinatra i18n demo 0.21-4-geccdac4\n"
+"\n"
+"Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
+"POT-Creation-Date: 2017-04-11 20:08-0500\n"
+"PO-Revision-Date: 2017-04-11 20:08-0500\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+
+#: ../../lib/gettext_setup_spec.rb:26 ../../lib/gettext_setup_spec.rb:89 ../../lib/gettext_setup_spec.rb:91
+msgid "Hello, world!"
+msgstr ""
+
+#: ../../lib/pot_spec.rb:52
+msgid "merged-po-file"
+msgstr ""
+
+#: ../../lib/pot_spec.rb:74
+msgid "no-pot-file"
+msgstr ""
+
+#: ../../lib/pot_spec.rb:85
+msgid "some-spec-only-string"
+msgstr ""
+
+#: ../../lib/pot_spec.rb:104
+msgid "unchanged-string"
+msgstr ""

data/spec/lib/gettext-setup/gettext_setup_spec.rb

@@ -70,11 +70,11 @@ describe GettextSetup do
       expect(GettextSetup.candidate_locales).to include('en')
       GettextSetup.clear
       begin
-        old_locale = ENV['LANG']
-        ENV['LANG'] = 'de_DE'
+        old_locale = Locale.current
+        Locale.current = 'de_DE'
         expect(GettextSetup.candidate_locales).to eq('de_DE,de,en')
       ensure
-        ENV['LANG'] = old_locale
+        Locale.current = old_locale
       end
     end
   end

data/spec/lib/gettext-setup/pot_spec.rb

@@ -18,6 +18,10 @@ describe GettextSetup::Pot do
     File.join(File.dirname(__FILE__), '../../fixtures/locales')
   end
 
+  def merge_locales_path
+    File.join(File.dirname(__FILE__), '../../fixtures/merge_locales')
+  end
+
   describe 'string_changes?', if: msgcmp_present? do
     old_pot = File.absolute_path('../../fixtures/string_changes/old.pot', File.dirname(__FILE__))
 
@@ -45,12 +49,12 @@ describe GettextSetup::Pot do
   context 'generate_new_pot' do
     it "fails when GettextSetup can't find a config.yaml" do
       path = File.join(Dir.mktmpdir, 'empty.pot')
-      expect { GettextSetup::Pot.generate_new_pot(Dir.mktmpdir, path) }.to raise_error(NoConfigFoundError)
+      expect { GettextSetup::Pot.generate_new_pot(locales_path: Dir.mktmpdir, target_path: path) }.to raise_error(NoConfigFoundError)
     end
     it 'builds a POT file' do
       path = File.join(Dir.mktmpdir, 'new.pot')
       expect do
-        GettextSetup::Pot.generate_new_pot(fixture_locales_path, path)
+        GettextSetup::Pot.generate_new_pot(locales_path: fixture_locales_path, target_path: path)
       end.to output('').to_stdout # STDOUT is determined in `update_pot`.
       contents = File.read(path)
       expect(contents).to match(/Fixture locales/)
@@ -144,4 +148,59 @@ describe GettextSetup::Pot do
       expect(new_contents).to eq(contents)
     end
   end
+  context 'Merge pot files' do
+    # setup
+    before :all do
+      { 'ruby' => 'ruby.pot', 'puppet' => 'puppet.pot', 'metadata' => 'metadata.pot' }.each do |pot_type, pot_name|
+        File.open(File.join(merge_locales_path, pot_name), 'w') do |file|
+          file.write <<-EOF
+  # Copyright (C) 2017 Puppet, Inc.
+  # This file is distributed under the same license as the puppetlabs-mysql package.
+  # FIRST AUTHOR <EMAIL@ADDRESS>, 2017.
+  #
+  #, fuzzy
+  msgid ""
+  msgstr ""
+  "Project-Id-Version: puppetlabs-mysql 3.11.0-30-g4cc0bbf\\n"
+  "Report-Msgid-Bugs-To: docs@puppet.com\\n"
+  "POT-Creation-Date: 2017-08-26 21:30+0100\\n"
+  "PO-Revision-Date: 2017-08-26 21:30+0100\\n"
+  "Last-Translator: FULL NAME <EMAIL@ADDRESS>\\n"
+  "Language-Team: LANGUAGE <LL@li.org>\\n"
+  "MIME-Version: 1.0\\n"
+  "Content-Type: text/plain; charset=UTF-8\\n"
+  "Content-Transfer-Encoding: 8bit\\n"
+  "Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\\n"
+
+  #: ../lib/puppet/parser/functions/mysql_strip_hash.rb:11
+  msgid "this is a #{pot_type} string"
+  msgstr ""
+        EOF
+        end
+      end
+    end
+    it 'merges pot files' do
+      expect do
+        GettextSetup::Pot.merge(locales_path: merge_locales_path)
+      end.to output(%r{PO files have been successfully merged}).to_stdout
+      contents = File.read(File.join(merge_locales_path, GettextSetup.config['project_name'] + '.pot'))
+      expect(contents).to match(%r{.*\"this is a metadata string\".*})
+      expect(contents).to match(%r{.*\"this is a puppet string\".*})
+      expect(contents).to match(%r{.*\"this is a ruby string\".*})
+    end
+
+    it 'creates an oldpot file if one already exists' do
+      expect do
+        GettextSetup::Pot.merge(locales_path: merge_locales_path)
+      end.to output("Warning - merge_locales.pot already exists and will be relocated to oldpot/old_merge_locales.pot.\nPO files have been successfully merged, merge_locales.pot has been created.\n").to_stdout
+      file = File.expand_path('oldpot/old_merge_locales.pot', merge_locales_path)
+      expect(File.exist?(file)).to be true
+    end
+
+    # cleanup
+    after :all do
+      FileUtils.rm(Dir.glob("#{merge_locales_path}/*.pot"))
+      FileUtils.rm_rf("#{merge_locales_path}/oldpot")
+    end
+  end
 end

data/spec/lib/tasks/gettext_rake_spec.rb

@@ -9,6 +9,7 @@ describe 'gettext.rake' do
   tmp_locales = File.expand_path('../../fixtures/tmp_locales', File.dirname(__FILE__))
   fixture_locales = File.expand_path('../../fixtures/fixture_locales', File.dirname(__FILE__))
   tmp_pot_path = File.expand_path('sinatra-i18n.pot', tmp_locales)
+  merge_locales = File.expand_path('../../fixtures/merge_locales', File.dirname(__FILE__))
 
   before :each do
     FileUtils.rm_r(tmp_locales, force: true)
@@ -40,6 +41,14 @@ describe 'gettext.rake' do
       end.to raise_error(SystemExit)
     end
   end
+  context Rake::Task['gettext:pot'] do
+    it 'outputs correctly, when passing a filename' do
+      expect do
+        GettextSetup.initialize(tmp_locales)
+        subject.invoke(File.expand_path('bill.pot', tmp_locales))
+      end.to output(/POT file .+\/spec\/fixtures\/tmp_locales\/bill.pot has been generated/).to_stdout
+    end
+  end
   context Rake::Task['gettext:metadata_pot'] do
     it 'outputs correctly' do
       expect do
@@ -100,4 +109,20 @@ describe 'gettext.rake' do
       end.to raise_error(SystemExit)
     end
   end
+
+  context Rake::Task['gettext:merge'] do
+    it 'outputs correctly' do
+      expect do
+        GettextSetup.initialize(merge_locales)
+        subject.invoke
+      end.to output(/PO files have been successfully merged/).to_stdout
+    end
+    it 'exits 1 on error' do
+      allow(GettextSetup::Pot).to receive(:merge).and_return(false)
+      expect do
+        GettextSetup.initialize(merge_locales)
+        subject.invoke
+      end.to raise_error(SystemExit)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gettext-setup
 version: !ruby/object:Gem::Version
-  version: '0.26'
+  version: '0.28'
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast_gettext
@@ -188,6 +188,7 @@ files:
 - spec/fixtures/locales/config.yaml
 - spec/fixtures/locales/de/sinatra-i18n.po
 - spec/fixtures/locales/sinatra-i18n.pot
+- spec/fixtures/merge_locales/config.yaml
 - spec/fixtures/spec_locales/config.yaml
 - spec/fixtures/spec_locales/sinatra-i18n.pot
 - spec/fixtures/string_changes/add.pot
@@ -195,6 +196,9 @@ files:
 - spec/fixtures/string_changes/non_string_changes.pot
 - spec/fixtures/string_changes/old.pot
 - spec/fixtures/string_changes/remove.pot
+- spec/fixtures/tmp_locales/config.yaml
+- spec/fixtures/tmp_locales/de/sinatra-i18n.po
+- spec/fixtures/tmp_locales/sinatra-i18n.pot
 - spec/lib/gettext-setup/gettext_setup_spec.rb
 - spec/lib/gettext-setup/metadata_pot_spec.rb
 - spec/lib/gettext-setup/pot_spec.rb
@@ -232,6 +236,7 @@ test_files:
 - spec/fixtures/locales/config.yaml
 - spec/fixtures/locales/de/sinatra-i18n.po
 - spec/fixtures/locales/sinatra-i18n.pot
+- spec/fixtures/merge_locales/config.yaml
 - spec/fixtures/spec_locales/config.yaml
 - spec/fixtures/spec_locales/sinatra-i18n.pot
 - spec/fixtures/string_changes/add.pot
@@ -239,6 +244,9 @@ test_files:
 - spec/fixtures/string_changes/non_string_changes.pot
 - spec/fixtures/string_changes/old.pot
 - spec/fixtures/string_changes/remove.pot
+- spec/fixtures/tmp_locales/config.yaml
+- spec/fixtures/tmp_locales/de/sinatra-i18n.po
+- spec/fixtures/tmp_locales/sinatra-i18n.pot
 - spec/lib/gettext-setup/gettext_setup_spec.rb
 - spec/lib/gettext-setup/metadata_pot_spec.rb
 - spec/lib/gettext-setup/pot_spec.rb