gettext-setup 0.21 → 0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b248dce3a387753f61e2e062421ae04cc466aa5b
-  data.tar.gz: 68b67f382958948a1185cb81c91336668da56780
+  metadata.gz: 301f3ae1df25e57691ff9a3b68fbbaaba018fb75
+  data.tar.gz: ff2707b717e503eee61bdb29b4abf8368abe3603
 SHA512:
-  metadata.gz: 8a80db6aecd41ccc0c21e5f8b901cc89a292a7389ea63c207440bdd9b52a1f46be57fbcf5de936d42ba3f34e2b940a4b15a9b99689276f0ad5acfd30d13bf187
-  data.tar.gz: 3132f258171d67558835213f5c23568dcbea6d664a5881c08d59d08d1da09aefc9bc3e89925c719e307e81bd1b38777e2857220dd768f169c391fcfcc45f821d
+  metadata.gz: fba28fcc1c48d5d29a1f5944d8533e59122d93203652697e2416cc56fab2259708414156677861dbaaafc642c294ea92b45b4134669ce4e4c0802d80a4cc411c
+  data.tar.gz: d5b6badc80b1ab2e76e28094b6e094f76ef6fe131e49afa3c3e54977304dca13fb2f28f954b67669b3ad4ec0c774ad02c850034b59b4df28300f61738f934a1d

data/README.md

@@ -36,11 +36,11 @@ your project:
     `GettextSetup.initialize(File.absolute_path('locales', File.dirname(__FILE__)))`
     (Note that the second line may require modification to find the `locales` directory.
 1. For client-side applications, add this line:
-    `FastGettext.locale = GettextSetup.negotiate_locale(GettextSetup.candidate_locales)`
+    `GettextSetup.negotiate_locale!(GettextSetup.candidate_locales)`
 1. For server-side applications, add these lines:
 ```
     before do
-      FastGettext.locale = GettextSetup.negotiate_locale(env["HTTP_ACCEPT_LANGUAGE"])
+      GettextSetup.negotiate_locale!(env["HTTP_ACCEPT_LANGUAGE"])
     end
 ```
 

data/lib/generate_metadata_pot.rb

@@ -0,0 +1 @@
+require 'metadata_pot/metadata_pot'

data/lib/gettext-setup.rb

@@ -1 +1,3 @@
 require 'gettext-setup/gettext_setup'
+require 'gettext-setup/metadata_pot'
+require 'gettext-setup/pot'

data/lib/gettext-setup/gettext_setup.rb

@@ -5,6 +5,12 @@ require 'yaml'
 require 'locale'
 
 module GettextSetup
+  class NoConfigFoundError < RuntimeError
+    def initialize(path)
+      super("No config.yaml found! (searching: #{path})")
+    end
+  end
+
   @config = nil
   @translation_repositories = {}
   FastGettext.default_available_locales = []
@@ -16,8 +22,10 @@ module GettextSetup
   # - if using .mo files, an LC_MESSAGES dir in each language dir, with the .mo file in it
   # valid `options` fields:
   # :file_format - one of the supported backends for fast_gettext (e.g. :po, :mo, :yaml, etc.)
-  def self.initialize(locales_path, options = {})
+  def self.initialize(locales_path = 'locales', options = {})
     config_path = File.absolute_path('config.yaml', locales_path)
+    File.exist?(config_path) || raise(NoConfigFoundError, config_path)
+
     @config = YAML.load_file(config_path)['gettext']
     @locales_path = locales_path
 
@@ -41,6 +49,11 @@ module GettextSetup
     Locale.set_default(default_locale)
   end
 
+  def self.config?
+    raise NoConfigFoundError, File.join(locales_path, 'config.yaml') unless @config
+    @config
+  end
+
   def self.add_repository_to_chain(project_name, options)
     repository = FastGettext::TranslationRepository.build(project_name,
                                                           path: locales_path,
@@ -50,7 +63,7 @@ module GettextSetup
   end
 
   def self.locales_path
-    @locales_path
+    @locales_path ||= File.join(Dir.pwd, 'locales')
   end
 
   def self.config
@@ -113,4 +126,9 @@ module GettextSetup
       default_locale
     end
   end
+
+  # Negotiates and sets the locale based on an accept language header.
+  def self.negotiate_locale!(accept_header)
+    FastGettext.locale = negotiate_locale(accept_header)
+  end
 end

data/lib/gettext-setup/metadata_pot.rb

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+require 'erb'
+require 'json'
+
+module GettextSetup
+  module MetadataPot
+    def self.metadata_path
+      File.join(GettextSetup.locales_path, GettextSetup.config['project_name'] + '_metadata.pot')
+    end
+
+    def self.template_path
+      File.join(File.dirname(__FILE__), '../templates/metadata.pot.erb')
+    end
+
+    def self.metadata(metadata_file = 'metadata.json')
+      if File.exist?(metadata_file)
+        file = open(metadata_file)
+        json = file.read
+        JSON.parse(json)
+      else
+        {}
+      end
+    end
+
+    def self.pot_string(metadata)
+      b = binding.freeze
+      # Uses `metadata`
+      ERB.new(File.read(template_path)).result(b)
+    end
+
+    def self.generate_metadata_pot(pot_metadata = metadata, path = metadata_path)
+      open(path, 'w') do |f|
+        f << pot_string(pot_metadata)
+      end
+    end
+  end
+end

data/lib/gettext-setup/pot.rb

@@ -0,0 +1,138 @@
+# -*- encoding: utf-8 -*-
+
+require 'open3'
+require 'English'
+
+module GettextSetup
+  module Pot
+    def self.text_domain
+      FastGettext.text_domain
+    end
+
+    def self.files_to_translate
+      files = (GettextSetup.config['source_files'] || []).map do |p|
+        Dir.glob(p)
+      end.flatten
+      # check for optional list of files to exclude from string
+      # extraction
+      exclusions = (GettextSetup.config['exclude_files'] || []).map do |p|
+        Dir.glob(p)
+      end.flatten
+
+      # if file is a directory, take it out of the array. directories
+      # cause rxgettext to error out.
+      (files - exclusions).reject { |file| File.directory?(file) }
+    end
+
+    def self.pot_file_path
+      return if GettextSetup.locales_path.nil?
+      return if GettextSetup.config['project_name'].nil?
+      File.join(GettextSetup.locales_path, GettextSetup.config['project_name'] + '.pot')
+    end
+
+    def self.po_file_path(language)
+      return if GettextSetup.locales_path.nil?
+      return if GettextSetup.config['project_name'].nil?
+      return if language.nil?
+      File.join(GettextSetup.locales_path, language, GettextSetup.config['project_name'] + '.po')
+    end
+
+    def self.string_changes?(old_pot, new_pot)
+      # Warnings will be in another language if locale is not set to en_US
+      _, stderr, status = Open3.capture3("LANG=en_US msgcmp --use-untranslated '#{old_pot}' '#{new_pot}'")
+      if status.exitstatus == 1 || /this message is not used/.match(stderr) || /this message is used but not defined/.match(stderr)
+        return true
+      end
+      return false
+    rescue IOError
+      # probably means msgcmp is not present on the system
+      # so return true to be on the safe side
+      return true
+    end
+
+    def self.generate_new_pot(locales_path = GettextSetup.locales_path, path = nil)
+      GettextSetup.initialize(locales_path)
+      path ||= pot_file_path
+      config = GettextSetup.config
+      package_name = config['package_name']
+      bugs_address = config['bugs_address']
+      copyright_holder = config['copyright_holder']
+      # 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 " \
+             "--add-comments#{comments_tag.to_s == '' ? '' : '=' + comments_tag} --msgid-bugs-address '#{bugs_address}' " \
+             "--package-name '#{package_name}' " \
+             "--package-version '#{version}' " \
+             "--copyright-holder='#{copyright_holder}' --copyright-year=#{Time.now.year} " +
+             files_to_translate.join(' '))
+      $CHILD_STATUS.success?
+    end
+
+    def self.generate_new_po(language, locales_path = GettextSetup.locales_path,
+                             pot_file = nil, po_file = nil)
+      GettextSetup.initialize(locales_path)
+      pot_file ||= GettextSetup::Pot.pot_file_path
+      po_file ||= GettextSetup::Pot.po_file_path(language)
+
+      language ||= ENV['LANGUAGE']
+
+      # Let's do some pre-verification of the environment.
+      if language.nil?
+        puts "You need to specify the language to add. Either 'LANGUAGE=eo rake gettext:po' or 'rake gettext:po[LANGUAGE]'"
+        return
+      end
+
+      language_path = File.dirname(po_file)
+      FileUtils.mkdir_p(language_path)
+
+      if File.exist?(po_file)
+        cmd = "msgmerge -U #{po_file} #{pot_file}"
+        _, _, _, wait = Open3.popen3(cmd)
+        exitstatus = wait.value
+        if exitstatus.success?
+          puts "PO file #{po_file} merged"
+          true
+        else
+          puts 'PO file merge failed'
+          false
+        end
+      else
+        cmd = "msginit --no-translator -l #{language} -o #{po_file} -i #{pot_file}"
+        _, _, _, wait = Open3.popen3(cmd)
+        exitstatus = wait.value
+        if exitstatus.success?
+          puts "PO file #{po_file} created"
+          true
+        else
+          puts 'PO file creation failed'
+          false
+        end
+      end
+    end
+
+    def self.update_pot(locales_path = GettextSetup.locales_path, path = nil)
+      GettextSetup.initialize(locales_path)
+      path ||= pot_file_path
+
+      if !File.exist? path
+        puts 'No existing POT file, generating new'
+        result = GettextSetup::Pot.generate_new_pot(locales_path, path)
+        puts "POT file #{path} has been generated" if result
+      else
+        old_pot = path + '.old'
+        File.rename(path, old_pot)
+        result = GettextSetup::Pot.generate_new_pot(locales_path, path)
+        if !result
+          puts 'POT creation failed'
+        elsif GettextSetup::Pot.string_changes?(old_pot, path)
+          File.delete(old_pot)
+          puts 'String changes detected, replacing with updated POT file'
+        else
+          puts 'No string changes detected, keeping old POT file'
+          File.rename(old_pot, path)
+        end
+      end
+    end
+  end
+end

data/lib/tasks/gettext.rake

@@ -1,57 +1,50 @@
-# require 'bundler'
-# puts File.absolute_path('Gemfile', Dir.pwd)
-# Bundler.read_file(File.absolute_path('Gemfile', Dir.pwd))
-#
+# -*- encoding: utf-8 -*-
+
 require_relative '../gettext-setup/gettext_setup'
-require_relative 'task_helper.rb'
-#
-# GettextSetup.initialize(File.absolute_path('locales', Dir.pwd))
+require_relative '../gettext-setup/pot'
+require_relative '../gettext-setup/metadata_pot'
 
 namespace :gettext do
   desc 'Generate a new POT file and replace old if strings changed'
+
   task :update_pot do
-    if !File.exist? pot_file_path
-      puts 'No existing POT file, generating new'
-      generate_new_pot
-    else
-      old_pot = pot_file_path + '.old'
-      File.rename(pot_file_path, old_pot)
-      generate_new_pot
-      if string_changes?(old_pot, pot_file_path)
-        File.delete(old_pot)
-        puts 'String changes detected, replacing with updated POT file'
-      else
-        puts 'No string changes detected, keeping old POT file'
-        File.rename(old_pot, pot_file_path)
-      end
+    begin
+      GettextSetup::Pot.update_pot
+    rescue GettextSetup::NoConfigFoundError => e
+      puts e.message
     end
   end
 
   desc 'Generate POT file'
   task :pot do
-    generate_new_pot
-    puts "POT file #{pot_file_path} has been generated"
+    begin
+      result = GettextSetup::Pot.generate_new_pot
+      if result
+        puts "POT file #{GettextSetup::Pot.pot_file_path} has been generated"
+      end
+    rescue GettextSetup::NoConfigFoundError => e
+      puts e.message
+    end
   end
 
-  desc 'Update PO file for a specific language'
-  task :po, [:language] do |_, args|
-    language = args.language || ENV['LANGUAGE']
-
-    # Let's do some pre-verification of the environment.
-    if language.nil?
-      puts "You need to specify the language to add. Either 'LANGUAGE=eo rake gettext:po' or 'rake gettext:po[LANGUAGE]'"
-      next
+  desc 'Generate POT file for metadata'
+  task :metadata_pot do
+    begin
+      result = GettextSetup::MetadataPot.generate_metadata_pot
+      if result
+        puts "POT metadata file #{GettextSetup::MetadataPot.metadata_path} has been generated"
+      end
+    rescue GettextSetup::NoConfigFoundError => e
+      puts e.message
     end
+  end
 
-    language_path = File.join(locale_path, language)
-    mkdir_p(language_path)
-
-    po_file_path = File.join(language_path,
-                             GettextSetup.config['project_name'] + '.po')
-    if File.exist?(po_file_path)
-      system("msgmerge -U #{po_file_path} #{pot_file_path}")
-    else
-      system("msginit --no-translator -l #{language} -o #{po_file_path} -i #{pot_file_path}")
+  desc 'Update PO file for a specific language'
+  task :po, [:language] do |_, args|
+    begin
+      GettextSetup::Pot.generate_new_po(args.language)
+    rescue GettextSetup::NoConfigFoundError => e
+      puts e.message
     end
   end
 end

data/lib/templates/metadata.pot.erb

@@ -0,0 +1,23 @@
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To:\n"
+"POT-Creation-Date: <%= DateTime.now %>\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\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"
+"X-Generator: Translate Toolkit 2.0.0\n"<% if metadata.key?('summary') %>
+#. metadata.json
+#: .summary
+msgid "<%= metadata['summary']%>"
+msgstr ""<% end %><% if metadata.key?('description')%>
+#. metadata.json
+#: .description
+msgid "<%= metadata['description']%>"
+msgstr ""
+<% end %>

data/spec/fixtures/fixture_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: 'fixture_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: Fixture 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/fixture_locales/*.rb'

data/spec/fixtures/fixture_locales/fixture_locales.pot

@@ -0,0 +1,24 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2017 Puppet, LLC.
+# This file is distributed under the same license as the Fixture locales package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2017.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: Fixture locales 0.21-6-gc301398\n"
+"\n"
+"Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
+"POT-Creation-Date: 2017-04-12 00:27-0500\n"
+"PO-Revision-Date: 2017-04-12 00:27-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"
+
+#: test_strings.rb:1
+msgid "Hello, world!"
+msgstr ""

data/spec/fixtures/fixture_locales/test_strings.rb

@@ -0,0 +1 @@
+_('Hello, world!')

data/spec/fixtures/locales/config.yaml

@@ -18,5 +18,5 @@ gettext:
   # Patterns for +Dir.glob+ used to find all files that might contain
   # translatable content, relative to the project root directory
   source_files:
-    - 'test_translation.rb'
-    - '../lib/**/*.rb'
+    - 'lib/**/*.rb'
+    - 'spec/**/*.rb'

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

@@ -1,16 +1,16 @@
 # SOME DESCRIPTIVE TITLE.
-# Copyright (C) 2016 Puppet Labs, LLC.
+# Copyright (C) 2017 Puppet Labs, LLC.
 # This file is distributed under the same license as the Sinatra i18n demo package.
-# FIRST AUTHOR <EMAIL@ADDRESS>, 2016.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2017.
 #
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: Sinatra i18n demo init-11-ga552a06\n"
+"Project-Id-Version: Sinatra i18n demo 0.21-4-geccdac4\n"
 "\n"
 "Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
-"POT-Creation-Date: 2016-06-07 17:38-0500\n"
-"PO-Revision-Date: 2016-06-07 17:38-0500\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"
@@ -19,7 +19,22 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
 
-#. GettextSetup.initialize(File::join(File::dirname(File::dirname(__FILE__)), 'fixtures'))
-#: ../../lib/gettext_setup_spec.rb:25
+#: ../../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/fixtures/{alt_locales → spec_locales}/config.yaml

@@ -4,11 +4,11 @@
 gettext:
   # This is used for the name of the .pot and .po files; they will be
   # called <project_name>.pot?
-  project_name: 'alt_locales'
+  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: alt_locales
+  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.
@@ -18,5 +18,4 @@ gettext:
   # Patterns for +Dir.glob+ used to find all files that might contain
   # translatable content, relative to the project root directory
   source_files:
-    - 'test_translation.rb'
-    - '../lib/**/*.rb'
+    - 'spec/**/*.rb'

data/spec/fixtures/spec_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-6-gc301398\n"
+"\n"
+"Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
+"POT-Creation-Date: 2017-04-12 00:27-0500\n"
+"PO-Revision-Date: 2017-04-12 00:27-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 ../fixture_locales/test_strings.rb:1
+msgid "Hello, world!"
+msgstr ""
+
+#: ../../lib/pot_spec.rb:91
+msgid "merged-po-file"
+msgstr ""
+
+#: ../../lib/pot_spec.rb:117
+msgid "no-pot-file"
+msgstr ""
+
+#: ../../lib/pot_spec.rb:127
+msgid "some-spec-only-string"
+msgstr ""
+
+#: ../../lib/pot_spec.rb:144
+msgid "unchanged-string"
+msgstr ""

data/spec/lib/gettext_setup_spec.rb

@@ -12,7 +12,6 @@ describe GettextSetup do
   end
   context 'initialize' do
     it 'sets up correctly' do
-      # GettextSetup.initialize(File.join(File.dirname(File.dirname(__FILE__)), 'fixtures'))
       expect(GettextSetup.locales_path).to match(/\/spec\/fixtures/)
       expect(config['project_name']).to eq('sinatra-i18n')
       expect(config['package_name']).to eq('Sinatra i18n demo')
@@ -37,6 +36,16 @@ describe GettextSetup do
       expect(GettextSetup.negotiate_locale('de;q=1, en;q=1')).to eq('de')
     end
   end
+  context 'negotiate_locale!' do
+    it 'sets the locale' do
+      GettextSetup.negotiate_locale!('de')
+      expect(FastGettext.locale).to eq('de')
+      expect(_('Hello, world!')).to eq('Hallo, Welt!')
+      GettextSetup.negotiate_locale!('en')
+      expect(FastGettext.locale).to eq('en')
+      expect(_('Hello, world!')).to eq('Hello, world!')
+    end
+  end
   context 'setting default_locale' do
     before :each do
       GettextSetup.default_locale = 'en'
@@ -62,9 +71,9 @@ describe GettextSetup do
     end
   end
   context 'multiple locales' do
-    # locales/ loads the de locale and alt_locales/ loads the jp locale
+    # locales/ loads the de locale and fixture_locales/ loads the jp locale
     before(:all) do
-      GettextSetup.initialize(File.join(File.dirname(File.dirname(__FILE__)), 'fixtures', 'alt_locales'))
+      GettextSetup.initialize(File.join(File.dirname(File.dirname(__FILE__)), 'fixtures', 'fixture_locales'))
     end
     it 'can aggregate locales across projects' do
       expect(FastGettext.default_available_locales).to include('en')
@@ -80,7 +89,7 @@ describe GettextSetup do
   end
   context 'translation repository chain' do
     before(:all) do
-      GettextSetup.initialize(File.join(File.dirname(File.dirname(__FILE__)), 'fixtures', 'alt_locales'))
+      GettextSetup.initialize(File.join(File.dirname(File.dirname(__FILE__)), 'fixtures', 'fixture_locales'))
     end
     it 'chain is not nil' do
       expect(GettextSetup.translation_repositories).not_to be_nil
@@ -92,15 +101,15 @@ describe GettextSetup do
       expect(_('Hello, world!')).to eq('こんにちは世界')
     end
     it 'does not allow duplicate repositories' do
-      GettextSetup.initialize(File.join(File.dirname(File.dirname(__FILE__)), 'fixtures', 'alt_locales'))
+      GettextSetup.initialize(File.join(File.dirname(File.dirname(__FILE__)), 'fixtures', 'fixture_locales'))
       repos = GettextSetup.translation_repositories
-      expect(repos.select { |k, _| k == 'alt_locales' }.size).to eq(1)
+      expect(repos.select { |k, _| k == 'fixture_locales' }.size).to eq(1)
     end
     it 'does allow multiple unique domains' do
       GettextSetup.initialize(File.join(File.dirname(File.dirname(__FILE__)), 'fixtures', 'locales'))
       repos = GettextSetup.translation_repositories
       expect(repos.size == 2)
-      expect(repos.select { |k, _| k == 'alt_locales' }.size).to eq(1)
+      expect(repos.select { |k, _| k == 'fixture_locales' }.size).to eq(1)
       expect(repos.select { |k, _| k == 'sinatra-i18n' }.size).to eq(1)
     end
   end

data/spec/lib/metadata_pot_spec.rb

@@ -0,0 +1,60 @@
+require 'rspec/expectations'
+require_relative '../spec_helper'
+
+require_relative '../../lib/gettext-setup'
+
+describe GettextSetup::MetadataPot do
+  before(:each) do
+    GettextSetup.initialize(File.join(File.dirname(File.dirname(__FILE__)), 'fixtures', 'locales'))
+  end
+  context '#metadata_path' do
+    it 'finds the right metadata path' do
+      expect(GettextSetup::MetadataPot.metadata_path).to match(/sinatra-i18n_metadata\.pot/)
+    end
+  end
+  context '#pot_string' do
+    it 'generates a reasonable POT string' do
+      expect(GettextSetup::MetadataPot.pot_string({})).to match(/Last-Translator: FULL NAME <EMAIL@ADDRESS>/)
+    end
+    it 'includes summary when provided' do
+      metadata = { 'summary' => 'abc' }
+      expect(GettextSetup::MetadataPot.pot_string(metadata)).to match(/msgid "abc"/)
+    end
+    it 'includes summary when provided' do
+      metadata = { 'description' => 'def' }
+      expect(GettextSetup::MetadataPot.pot_string(metadata)).to match(/msgid "def"/)
+    end
+    it 'includes both summary and description when provided' do
+      metadata = { 'summary' => 'abc', 'description' => 'def' }
+      result = expect(GettextSetup::MetadataPot.pot_string(metadata))
+      result.to match(/msgid "def"/)
+      result.to match(/msgid "abc"/)
+    end
+  end
+  context '#load_metadata' do
+    it 'loads metadata correctly' do
+      Dir.mktmpdir do |dir|
+        file = File.join(dir, 'metadata.json')
+        File.open(file, 'w') { |f| f.write('{"description":"abcdef", "summary":"ghi"}') }
+        metadata = GettextSetup::MetadataPot.metadata(File.join(dir, 'metadata.json').to_s)
+        expect(metadata).to eq('description' => 'abcdef', 'summary' => 'ghi')
+      end
+    end
+    it 'uses an empty hash if no metadata.json is found' do
+      metadata = GettextSetup::MetadataPot.metadata(File.join(Dir.mktmpdir, 'metadata.json').to_s)
+      expect(metadata).to eq({})
+    end
+  end
+  context '#generate_metadata_pot' do
+    it 'works with everything supplied' do
+      dir = Dir.mktmpdir
+      file = File.join(dir, 'metadata.pot')
+      metadata = { 'description' => 'abc', 'summary' => 'def' }
+      GettextSetup::MetadataPot.generate_metadata_pot(metadata,
+                                                      file)
+      contents = File.read(file)
+      expect(contents).to match(/msgid "abc"/)
+      expect(contents).to match(/msgid "def"/)
+    end
+  end
+end

data/spec/lib/pot_spec.rb

@@ -0,0 +1,162 @@
+require 'rspec/expectations'
+require_relative '../spec_helper.rb'
+
+require_relative '../../lib/gettext-setup'
+describe GettextSetup::Pot do
+  NoConfigFoundError = GettextSetup::NoConfigFoundError
+
+  def fixture_locales_path
+    File.join(File.dirname(__FILE__), '../fixtures/fixture_locales')
+  end
+
+  def spec_locales_path
+    File.join(File.dirname(__FILE__), '../fixtures/spec_locales')
+  end
+
+  def locales_path
+    File.join(File.dirname(__FILE__), '../fixtures/locales')
+  end
+
+  describe 'string_changes?', if: msgcmp_present? do
+    old_pot = File.absolute_path('../fixtures/string_changes/old.pot', File.dirname(__FILE__))
+
+    it 'should detect string addition' do
+      new_pot = File.absolute_path('../fixtures/string_changes/add.pot', File.dirname(__FILE__))
+      expect(GettextSetup::Pot.string_changes?(old_pot, new_pot)).to eq(true)
+    end
+
+    it 'should detect string removal' do
+      new_pot = File.absolute_path('../fixtures/string_changes/remove.pot', File.dirname(__FILE__))
+      expect(GettextSetup::Pot.string_changes?(old_pot, new_pot)).to eq(true)
+    end
+
+    it 'should detect string changes' do
+      new_pot = File.absolute_path('../fixtures/string_changes/change.pot', File.dirname(__FILE__))
+      expect(GettextSetup::Pot.string_changes?(old_pot, new_pot)).to eq(true)
+    end
+
+    it 'should not detect non-string changes' do
+      new_pot = File.absolute_path('../fixtures/string_changes/non_string_changes.pot', File.dirname(__FILE__))
+      expect(GettextSetup::Pot.string_changes?(old_pot, new_pot)).to eq(false)
+    end
+  end
+
+  context 'generate_new_pot' do
+    it "fails when GettextSetup can't find a config.yaml" do
+      path = File.join(Dir.mktmpdir, 'empty.pot')
+      with_captured_stdout do
+        expect { GettextSetup::Pot.generate_new_pot(Dir.mktmpdir, path) }.to raise_error(NoConfigFoundError)
+      end
+    end
+    it 'builds a POT file' do
+      path = File.join(Dir.mktmpdir, 'new.pot')
+      out = with_captured_stdout do
+        GettextSetup::Pot.generate_new_pot(fixture_locales_path, path)
+      end
+      expect(out).to eq('') # STDOUT is determined in `update_pot`.
+      contents = File.read(path)
+      expect(contents).to match(/Fixture locales/)
+      expect(contents).to match(/docs@puppetlabs.com/)
+      expect(contents).to match(/Puppet, LLC/)
+      expect(contents).to match(/test_strings.rb:1/)
+    end
+  end
+
+  context 'generate_new_po' do
+    it "fails when GettextSetup can't find a config.yaml" do
+      path = File.join(Dir.mktmpdir, 'fails.pot')
+      po_path = File.join(Dir.mktmpdir, 'fails.po')
+      with_captured_stdout do
+        expect { GettextSetup::Pot.generate_new_po('ja', Dir.mktmpdir, path, po_path) }.to raise_error(NoConfigFoundError)
+      end
+    end
+    it 'complains when no language is supplied' do
+      stdout = with_captured_stdout do
+        GettextSetup::Pot.generate_new_po(nil, fixture_locales_path, Dir.mktmpdir, Dir.mktmpdir)
+      end
+      result = "You need to specify the language to add. Either 'LANGUAGE=eo rake gettext:po' or 'rake gettext:po[LANGUAGE]'\n"
+      expect(stdout).to eq(result)
+    end
+    it 'generates new PO file', if: msginit_present? do
+      po_path = File.join(Dir.mktmpdir, 'aa', 'tmp.po')
+      pot_path = File.join(locales_path, 'sinatra-i18n.pot')
+
+      stdout = with_captured_stdout do
+        GettextSetup::Pot.generate_new_po('aa', locales_path, pot_path, po_path)
+      end
+      expect(stdout).to eq("PO file #{po_path} created\n")
+    end
+    it 'merges PO files', if: [msginit_present?, msgmerge_present?] do
+      _('merged-po-file')
+      po_path = File.join(Dir.mktmpdir, 'aa', 'tmp.po')
+      pot_path = GettextSetup::Pot.pot_file_path
+
+      stdout = with_captured_stdout do
+        GettextSetup::Pot.generate_new_po('aa', fixture_locales_path, pot_path, po_path)
+      end
+      expect(stdout).to eq("PO file #{po_path} created\n")
+      contents = File.read(po_path)
+      expect(contents).to match(/msgid "Hello, world!"/)
+
+      new_pot_path = File.join(spec_locales_path, 'sinatra-i18n.pot')
+      new_stdout = with_captured_stdout do
+        GettextSetup::Pot.generate_new_po('aa', spec_locales_path, new_pot_path, po_path)
+      end
+      expect(new_stdout).to eq("PO file #{po_path} merged\n")
+      new_contents = File.read(po_path)
+      expect(new_contents).to match(/merged-po-file/)
+    end
+  end
+
+  context 'update_pot' do
+    it "fails when GettextSetup can't find a config.yaml" do
+      path = File.join(Dir.mktmpdir, 'fail-update.pot')
+      with_captured_stdout do
+        expect { GettextSetup::Pot.update_pot(Dir.mktmpdir, path) }.to raise_error(NoConfigFoundError)
+      end
+    end
+    it 'creates POT when absent' do
+      _('no-pot-file')
+      path = File.join(Dir.mktmpdir, 'some-pot.pot')
+      stdout = with_captured_stdout do
+        GettextSetup::Pot.update_pot(spec_locales_path, path)
+      end
+      expect(stdout).to eq("No existing POT file, generating new\nPOT file #{path} has been generated\n")
+      contents = File.read(path)
+      expect(contents).to match(/msgid "no-pot-file"/)
+    end
+    it 'updates POT when something changes', if: [msginit_present?, msgmerge_present?] do
+      _('some-spec-only-string')
+      path = File.join(Dir.mktmpdir, 'some-pot.pot')
+      stdout = with_captured_stdout do
+        GettextSetup::Pot.update_pot(fixture_locales_path, path)
+      end
+      expect(stdout).to eq("No existing POT file, generating new\nPOT file #{path} has been generated\n")
+      contents = File.read(path)
+      expect(contents).to match(/Language-Team: LANGUAGE <LL@li.org>/)
+      expect(contents).not_to match(/some-spec-only-string/)
+      output = with_captured_stdout do
+        GettextSetup::Pot.update_pot(spec_locales_path, path)
+      end
+      new_contents = File.read(path)
+      expect(new_contents).to match(/some-spec-only-string/)
+      expect(output).to eq("String changes detected, replacing with updated POT file\n")
+    end
+    it "doesn't update the POT when nothing changes", if: [msginit_present?, msgcmp_present?] do
+      _('unchanged-string')
+      path = File.join(Dir.mktmpdir, 'some-pot.pot')
+      stdout = with_captured_stdout do
+        GettextSetup::Pot.update_pot(spec_locales_path, path)
+      end
+      expect(stdout).to eq("No existing POT file, generating new\nPOT file #{path} has been generated\n")
+      contents = File.read(path)
+      expect(contents).to match(/unchanged-string/)
+      new_stdout = with_captured_stdout do
+        GettextSetup::Pot.update_pot(spec_locales_path, path)
+      end
+      new_contents = File.read(path)
+      expect(new_contents).to eq(contents)
+      expect(new_stdout).to eq("No string changes detected, keeping old POT file\n")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,12 +1,37 @@
 require 'simplecov'
+require_relative '../lib/gettext-setup'
+
+GettextSetup.initialize(File.join(File.dirname(__FILE__), 'fixtures', 'locales'))
+
 SimpleCov.start do
   add_filter '/spec/'
 end
 
-def msgcmp_present?
+def cmd_present?(cmd)
   # Try to call out to msgcmp, if it doesn't error, we have the tool
-  `msgcmp`
+  `#{cmd} --version`
   return true
 rescue IOError
   return false
 end
+
+def msgcmp_present?
+  cmd_present?('msgcmp')
+end
+
+def msginit_present?
+  cmd_present?('msginit')
+end
+
+def msgmerge_present?
+  cmd_present?('msgmerge')
+end
+
+def with_captured_stdout
+  old_stdout = $stdout
+  $stdout = StringIO.new('', 'w')
+  yield
+  $stdout.string
+ensure
+  $stdout = old_stdout
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gettext-setup
 version: !ruby/object:Gem::Version
-  version: '0.21'
+  version: '0.23'
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2017-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast_gettext
@@ -201,25 +201,32 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/generate_metadata_pot.rb
 - lib/gettext-setup.rb
 - lib/gettext-setup/gettext_setup.rb
+- lib/gettext-setup/metadata_pot.rb
+- lib/gettext-setup/pot.rb
 - lib/tasks/gettext.rake
-- lib/tasks/task_helper.rb
+- lib/templates/metadata.pot.erb
 - locales/config-sample.yaml
-- spec/fixtures/alt_locales/alt_locales.pot
-- spec/fixtures/alt_locales/config.yaml
-- spec/fixtures/alt_locales/jp/alt_locales.po
+- spec/fixtures/fixture_locales/config.yaml
+- spec/fixtures/fixture_locales/fixture_locales.pot
+- spec/fixtures/fixture_locales/jp/fixture_locales.po
+- spec/fixtures/fixture_locales/test_strings.rb
 - spec/fixtures/locales/config.yaml
 - spec/fixtures/locales/de/sinatra-i18n.po
 - spec/fixtures/locales/sinatra-i18n.pot
-- spec/fixtures/pot_update/add.pot
-- spec/fixtures/pot_update/change.pot
-- spec/fixtures/pot_update/non_string_changes.pot
-- spec/fixtures/pot_update/old.pot
-- spec/fixtures/pot_update/remove.pot
+- spec/fixtures/spec_locales/config.yaml
+- spec/fixtures/spec_locales/sinatra-i18n.pot
+- spec/fixtures/string_changes/add.pot
+- spec/fixtures/string_changes/change.pot
+- spec/fixtures/string_changes/non_string_changes.pot
+- spec/fixtures/string_changes/old.pot
+- spec/fixtures/string_changes/remove.pot
 - spec/lib/gettext_setup_spec.rb
+- spec/lib/metadata_pot_spec.rb
+- spec/lib/pot_spec.rb
 - spec/spec_helper.rb
-- spec/tasks/update_pot_spec.rb
 homepage: https://github.com/puppetlabs/gettext-setup-gem
 licenses:
 - Apache-2.0
@@ -240,22 +247,27 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A gem to ease internationalization with fast_gettext
 test_files:
-- spec/fixtures/alt_locales/alt_locales.pot
-- spec/fixtures/alt_locales/config.yaml
-- spec/fixtures/alt_locales/jp/alt_locales.po
+- spec/fixtures/fixture_locales/config.yaml
+- spec/fixtures/fixture_locales/fixture_locales.pot
+- spec/fixtures/fixture_locales/jp/fixture_locales.po
+- spec/fixtures/fixture_locales/test_strings.rb
 - spec/fixtures/locales/config.yaml
 - spec/fixtures/locales/de/sinatra-i18n.po
 - spec/fixtures/locales/sinatra-i18n.pot
-- spec/fixtures/pot_update/add.pot
-- spec/fixtures/pot_update/change.pot
-- spec/fixtures/pot_update/non_string_changes.pot
-- spec/fixtures/pot_update/old.pot
-- spec/fixtures/pot_update/remove.pot
+- spec/fixtures/spec_locales/config.yaml
+- spec/fixtures/spec_locales/sinatra-i18n.pot
+- spec/fixtures/string_changes/add.pot
+- spec/fixtures/string_changes/change.pot
+- spec/fixtures/string_changes/non_string_changes.pot
+- spec/fixtures/string_changes/old.pot
+- spec/fixtures/string_changes/remove.pot
 - spec/lib/gettext_setup_spec.rb
+- spec/lib/metadata_pot_spec.rb
+- spec/lib/pot_spec.rb
 - spec/spec_helper.rb
-- spec/tasks/update_pot_spec.rb
+has_rdoc: 

data/lib/tasks/task_helper.rb

@@ -1,58 +0,0 @@
-require 'open3'
-
-def locale_path
-  GettextSetup.locales_path
-end
-
-def text_domain
-  FastGettext.text_domain
-end
-
-def files_to_translate
-  files = GettextSetup.config['source_files'].map do |p|
-    Dir.glob(p)
-  end.flatten
-  # check for optional list of files to exclude from string
-  # extraction
-  exclusions = (GettextSetup.config['exclude_files'] || []).map do |p|
-    Dir.glob(p)
-  end.flatten
-
-  # if file is a directory, take it out of the array. directories
-  # cause rxgettext to error out.
-  (files - exclusions).reject { |file| File.directory?(file) }
-end
-
-def pot_file_path
-  File.join(locale_path, GettextSetup.config['project_name'] + '.pot')
-end
-
-def generate_new_pot
-  config = GettextSetup.config
-  package_name = config['package_name']
-  project_name = config['project_name']
-  bugs_address = config['bugs_address']
-  copyright_holder = config['copyright_holder']
-  # 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 locales/#{project_name}.pot --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}' " \
-         "--copyright-holder='#{copyright_holder}' --copyright-year=#{Time.now.year} " +
-         files_to_translate.join(' '))
-end
-
-def string_changes?(old_pot, new_pot)
-  # Warnings will be in another language if locale is not set to en_US
-  _, stderr, status = Open3.capture3("LANG=en_US msgcmp --use-untranslated '#{old_pot}' '#{new_pot}'")
-  if status.exitstatus == 1 || /this message is not used/.match(stderr) || /this message is used but not defined/.match(stderr)
-    return true
-  end
-  return false
-rescue IOError
-  # probably means msgcmp is not present on the system
-  # so return true to be on the safe side
-  return true
-end

data/spec/fixtures/alt_locales/alt_locales.pot

@@ -1,25 +0,0 @@
-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) 2016 Puppet Labs, LLC.
-# This file is distributed under the same license as the Sinatra i18n demo package.
-# FIRST AUTHOR <EMAIL@ADDRESS>, 2016.
-#
-#, fuzzy
-msgid ""
-msgstr ""
-"Project-Id-Version: alt_locales init-11-ga532a06\n"
-"\n"
-"Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
-"POT-Creation-Date: 2016-06-07 17:38-0500\n"
-"PO-Revision-Date: 2016-06-07 17:38-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"
-
-#. GettextSetup.initialize(File::join(File::dirname(File::dirname(__FILE__)), 'fixtures'))
-#: ../../lib/gettext_setup_spec.rb:25
-msgid "Hello, world!"
-msgstr ""

data/spec/tasks/update_pot_spec.rb

@@ -1,28 +0,0 @@
-require 'rspec/expectations'
-require_relative '../spec_helper.rb'
-
-require_relative '../../lib/tasks/task_helper.rb'
-
-describe 'string_changes?', if: msgcmp_present? do
-  old_pot = File.absolute_path('../fixtures/pot_update/old.pot', File.dirname(__FILE__))
-
-  it 'should detect string addition' do
-    new_pot = File.absolute_path('../fixtures/pot_update/add.pot', File.dirname(__FILE__))
-    expect(string_changes?(old_pot, new_pot)).to eq(true)
-  end
-
-  it 'should detect string removal' do
-    new_pot = File.absolute_path('../fixtures/pot_update/remove.pot', File.dirname(__FILE__))
-    expect(string_changes?(old_pot, new_pot)).to eq(true)
-  end
-
-  it 'should detect string changes' do
-    new_pot = File.absolute_path('../fixtures/pot_update/change.pot', File.dirname(__FILE__))
-    expect(string_changes?(old_pot, new_pot)).to eq(true)
-  end
-
-  it 'should not detect non-string changes' do
-    new_pot = File.absolute_path('../fixtures/pot_update/non_string_changes.pot', File.dirname(__FILE__))
-    expect(string_changes?(old_pot, new_pot)).to eq(false)
-  end
-end