gettext-setup 0.10 → 0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84bde18372c4c8e6e9284ab8a2b08d40114d779a
-  data.tar.gz: fc28ee6ae71e5e5113325a563ebaa9c0a489a723
+  metadata.gz: 7c5ec999e9e07642d3bc10efa9a6e0acfeef995d
+  data.tar.gz: 11b5919a0c12d5911c73bb79de5d78d43a4e49db
 SHA512:
-  metadata.gz: aed2ca08cbbcd8254a95bdf4bc9798a69d0a9ef6550663031cf177e378a57727b4054a58ea7bfd4031be2cb84f62ef456dc32a691bc677aa8425ee7ffd56ba92
-  data.tar.gz: fa302dc3515258ab8693f691f7eb8d4eee83ad92a74643251cbc764081127e6030776649c52ca4574048afc07a78a7c04946dd0f80ca64a4f076b0e05dcfc798
+  metadata.gz: 68067a707c35788e682e74abe89afc11cdc580b6dddec91e34663afe5b1e9bcc384e7472e6781aae9bbbc6844037aa615d7c3e85f53879f2087e2548dff7a63d
+  data.tar.gz: d8e73f312ab6690ddc336ef336469d9a56e7e7103d2885f18c330f0993bef9d69683b720ff50ba5491f6d5c01855f4d1de622e9f18d59e56d96c6071ed49d89b

data/README.md

@@ -12,11 +12,11 @@ This project sets the default locale to English. If the user has set a different
 
 **PO file** - A bilingual file containing the source English strings (msgid) and target language strings (msgstr). This file is generated from the POT file and is where translated strings are added. A PO file is generated for each language.
 
-**Transifex** - A translation management system. When PO files are updated, the updates are pulled into Transifex and translated there.
+**Transifex** - A translation management system. When POT files are updated, the updates are pushed to Transifex. Transifex generates a PO file for each language that has been set up in the Transifex project. Translators enter the string translations in the PO for their language.
 
 ## Setup for your project
 
-These are the poingant bits of this example that you need to replicate in
+These are the poignant bits of this example that you need to replicate in
 your project:
 
 1. Add `gem 'gettext-setup'` to your `Gemfile`.
@@ -24,18 +24,21 @@ your project:
 `locales` directory as `config.yaml`.
 1. Edit `locales/config.yaml` and make the necessary changes for your
    project
-1. Add these three lines to your `Rakefile`:
+1. Add these three lines to your `Rakefile`, ensuring the `locales`
+   directory is found by the last line:
 ```
     spec = Gem::Specification.find_by_name 'gettext-setup'
     load "#{spec.gem_dir}/lib/tasks/gettext.rake"
     GettextSetup.initialize(File.absolute_path('locales', File.dirname(__FILE__)))
 ```
-1. Add this line to the top of your `app.rb`:
+1. Add these lines at the start of your app (`app.rb` for server-side, the executable binary for CLI applications):
     `require 'gettext-setup'`
-1. Add these lines inside the class declared in your `app.rb`:
+    `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)`
+1. For server-side applications, add these lines:
 ```
-    include FastGettext::Translation
-    GettextSetup.initialize(File.absolute_path('locales', File.dirname(__FILE__)))
     before do
       FastGettext.locale = GettextSetup.negotiate_locale(env["HTTP_ACCEPT_LANGUAGE"])
     end
@@ -78,26 +81,21 @@ The `msgid_plural` is the plural version of the English source string.
 
 The two `msgstr` lines show that German has two rules for pluralization. The indices map to the `Plural-Forms: nplurals=2; plural=(n > 1);` rule that we specified in the PO file. The `[0]` index represents `plural=(n > 1)` and the `[1]` index represents all other pluralization cases (in other words, when the count equals 0 or 1).
 
+When Transifex generates a PO file for a specific language, it automatically adds the appropriate pluralization rules in the PO file. 
+
 ### Comments
-To provide translators with some contextual information or instructions about a string, precede the string with a comment. Start the comment with "TRANSLATOR: " to make it obvious that you are providing instructions for the translator. The comment gets pulled in to the POT file and will show up as a comment in Transifex.
+To provide translators with some contextual information or instructions about a string, precede the string with a comment using `#. `. The comment gets pulled in to the POT file and will show up as a comment in Transifex.
 
-E.g. `# TRANSLATOR: The placeholder in this string represents the name of a parameter.`
+E.g. `#. The placeholder in this string represents the name of a parameter.`
 
 ## Translation workflow
 
 1. Wrap the translation function around translatable strings in code files
 
-2. Run `rake gettext:pot` to parse the source code and extract translatable strings into the message catalog in `locales/<project_name>.pot`. If a POT file already exists, this rake task will update the POT file. Do this before making a pull request that includes changes to user-facing strings.
-
-3. Run `rake gettext:po[<lang>]` to create/update language-specific PO files. This step will be managed by the localization team, and will usually happen prior to a new release.
-
-4. When a PO file is updated, a git hook is used to automatically pull the new/updated strings into Transifex ready for translation.
-
-5. When the PO file reaches 100% translated and reviewed in Transifex, it is pulled back into the locale folder.
+2. A CI job checks code commits to see if any changes have been made to user-facing strings. If changes have been made, the CI job parses the source code and extracts translatable strings into a POT file. If a POT file already exists, the CI job will update the existing POT file. (If the CI job hasn't already been added to your pipeline, you will need to add it.)
 
-6. PE checks the user's locale settings (the browser settings for web apps, or the system settings for the CLI). If we support the preferred locale, PE uses the PO file for that locale. Otherwise, it uses the default locale (en_US).
+3. When a POT file is updated, the Transifex webhook pushes the new POT file to Transifex ready for translation. (If your POT file hasn't been added to the Transifex integration yet, you will need to get it added.)
 
-## TODO
+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. 
 
-1. Locale-specific formatting of numbers, dates, etc.
-2. Separate out the locales that are supported for testing/dev and production so we can add test translations without shipping them.
+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.

data/lib/gettext-setup/gettext_setup.rb

@@ -1,6 +1,7 @@
 # -*- encoding: utf-8 -*-
 require 'fast_gettext'
 require 'yaml'
+require 'locale'
 
 module GettextSetup
   @@config = nil
@@ -32,6 +33,8 @@ module GettextSetup
     # Likewise, be explicit in our default language choice.
     FastGettext.default_locale = default_locale
     FastGettext.default_available_locales = locales
+
+    Locale.set_default(default_locale)
   end
 
   def self.locales_path
@@ -46,6 +49,12 @@ module GettextSetup
     config['default_locale'] || "en"
   end
 
+  # Returns the locale for the current machine. This is most useful for shell
+  # applications that need an ACCEPT-LANGUAGE header set.
+  def self.candidate_locales
+    Locale.candidates(type: :cldr).join(',')
+  end
+
   def self.locales
     explicit = Dir.glob(File::absolute_path('*/*.po', locales_path)).map do |x|
       File::basename(File::dirname(x))

data/lib/tasks/gettext.rake

@@ -34,13 +34,20 @@ namespace :gettext do
 
   desc "Update pot files"
   task :pot do
-    package_name = GettextSetup.config['package_name']
-    project_name = GettextSetup.config['project_name']
-    bugs_address = GettextSetup.config['bugs_address']
-    copyright_holder = GettextSetup.config['copyright_holder']
+    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.
+    if config.has_key?('comments_tag')
+      comments_tag = config['comments_tag']
+    else
+      comments_tag = 'TRANSLATORS'
+    end
     version=`git describe`
     system("rxgettext -o locales/#{project_name}.pot --no-wrap --sort-by-file " +
-           "--no-location --add-comments --msgid-bugs-address '#{bugs_address}' " +
+           "--no-location --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} " +

data/locales/config-sample.yaml

@@ -15,6 +15,10 @@ gettext:
   bugs_address: docs@puppetlabs.com
   # The holder of the copyright.
   copyright_holder: Puppet Labs, LLC.
+  # This determines which comments in code should be eligible for translation.
+  # Any comments that start with this string will be externalized. (Leave
+  # empty to include all.)
+  comments_tag: TRANSLATORS
   # Patterns for +Dir.glob+ used to find all files that might contain
   # translatable content, relative to the project root directory
   source_files:

metadata

@@ -1,167 +1,181 @@
 --- !ruby/object:Gem::Specification
 name: gettext-setup
 version: !ruby/object:Gem::Version
-  version: '0.10'
+  version: '0.11'
 platform: ruby
 authors:
 - Puppet
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-14 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: gettext
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.2
-  name: gettext
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.2
 - !ruby/object:Gem::Dependency
+  name: fast_gettext
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
-  name: fast_gettext
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
+  name: locale
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
-  name: bundler
+        version: '0'
+  type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: rake
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: rack-test
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-  name: rspec
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
+  name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-  name: rspec-core
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
+  name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-  name: rspec-expectations
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
+  name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-  name: rspec-mocks
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: simplecov
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: webmock
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A gem to ease i18n
@@ -186,29 +200,29 @@ homepage: https://github.com/puppetlabs/gettext-setup-gem
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.4.5
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
 specification_version: 4
 summary: A gem to ease internationalization with fast_gettext
 test_files:
-- spec/spec_helper.rb
 - spec/fixtures/locales/config.yaml
-- spec/fixtures/locales/sinatra-i18n.pot
 - spec/fixtures/locales/de/sinatra-i18n.po
+- spec/fixtures/locales/sinatra-i18n.pot
 - spec/lib/gettext_setup_spec.rb
+- spec/spec_helper.rb