semantic_puppet 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38ebb59dfcd6e82ac6ea128d8515b2662acbd3e1
-  data.tar.gz: f09b3b0f9d3df0e086fcc577621352e0e876d8cf
+  metadata.gz: e204300a1f6f9188796a9dd602c30f62762d765d
+  data.tar.gz: cca5d579a7002ae8207652352497b1ebe5bc3b2c
 SHA512:
-  metadata.gz: 270364d1106aaf1e1a23921f7e0a65e94f21d66e8f05ff1f96f10ebd68da177d3d0127f5f09a6c7adfba16969878cbdf9b72429d298ac9fa6a5ccda9d6c29605
-  data.tar.gz: 1b7e6f4b605d5f9ffefd312933048a9c9e0b17efea59eb09a6b215c2a117ec1ca275e18efbe640e991267d35d19b27b3c66dc4135b323dc9a8eb3c1be9b7f77b
+  metadata.gz: 591144201a679d5ed1ddb237b51c78f36a930b426156c1f0ae48bfaec4f66b4285812fe769db326e64875ba7ffec6216e30bf61b2308ed6ef1a4fe56a595a490
+  data.tar.gz: d449dcf10e49683e326c117489557ee9c9d1f73cd087a9621c72fb969b89bd69ba6b10a3da97c912c0374a2860bb35eb0d9d84d99814296ae5c1302b7ec93676

data/.gitignore

@@ -6,3 +6,4 @@ doc
 .idea/
 /.project
 Gemfile.lock
+locales/semantic_puppet.pot

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.1.4 - 2016-07-06
+### Changed
+- Externalized all user-facing strings using gettext libraries to support future localization.
+
 ## 0.1.3 - 2016-05-24
 ### Added
 - Typesafe implementation of ModuleRelease#eql? (and ModuleRelease#==). (PUP-6341)

data/README.md

@@ -57,8 +57,37 @@ publishing modules to [Puppet Forge](https://forge.puppetlabs.com) which is
 documented at 
 [Publishing Modules on the Puppet Forge](https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#dependencies-in-metadatajson).
 
+### i18n
+
+When adding new error or log messages please follow the instructions for
+[writing translatable code](https://github.com/puppetlabs/gettext-setup-gem#writing-translatable-code).
+
+The SemanticPuppet gem will default to outputing all error messages in English, but you may set the locale
+using the `FastGettext.set_locale` method. If translations do not exist for the language you request then the gem will
+default to English. The `set_locale` method will return the locale, as a string, that FastGettext will now
+use to report PuppetForge errors.
+
+``` ruby
+# Assuming the German translations exist, this will set the reporting language
+# to German
+
+locale = FastGettext.set_locale "de_DE"
+
+# If it successfully finds Germany's locale, locale will be "de_DE"
+# If it fails to find any German locale, locale will be "en"
+```
+
 Contributors
 ------------
 
 Pieter van de Bruggen wrote the library originally, with additions by Alex
 Dreyer, Jesse Scott and Anderson Mills.
+
+## Maintenance
+
+Maintainers:
+
+* Jesse Scott, jesse@puppet.com
+* Anderson Mills, anderson@puppet.com
+
+Tickets: File at https://tickets.puppet.com/browse/FORGE

data/Rakefile

@@ -56,3 +56,12 @@ begin
 rescue LoadError
   warn "[Warning]: Could not load `bundler/gem_tasks`."
 end
+
+# Gettext tasks
+begin
+  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__)))
+rescue LoadError
+  warn "[Warning]: Could not load gettext tasks."
+end

data/lib/semantic_puppet.rb

@@ -1,7 +1,9 @@
+require 'gettext-setup'
+
 module SemanticPuppet
+  GettextSetup.initialize(File.absolute_path('../locales', File.dirname(__FILE__)))
+
   autoload :Version, 'semantic_puppet/version'
   autoload :VersionRange, 'semantic_puppet/version_range'
   autoload :Dependency, 'semantic_puppet/dependency'
-
-  VERSION = '0.1.3'
 end

data/lib/semantic_puppet/gem_version.rb

@@ -0,0 +1,3 @@
+module SemanticPuppet
+  VERSION = '0.1.4'
+end

data/lib/semantic_puppet/version.rb

@@ -18,7 +18,7 @@ module SemanticPuppet
         match, major, minor, patch, prerelease, build = *ver.match(/\A#{REGEX_FULL}\Z/)
 
         if match.nil?
-          raise "Unable to parse '#{ver}' as a semantic version identifier"
+          raise _("Unable to parse '%{version}' as a semantic version identifier") % {version: ver}
         end
 
         prerelease = parse_prerelease(prerelease) if prerelease
@@ -26,7 +26,7 @@ module SemanticPuppet
         # The following code prevents build metadata for now.
         #build = parse_build_metadata(build) if build
         if !build.nil?
-          raise "'#{ver}' MUST NOT include build identifiers"
+          raise _("'%{version}' MUST NOT include build identifiers") % {version: ver}
         end
 
         self.new(major.to_i, minor.to_i, patch.to_i, prerelease, build)
@@ -46,11 +46,11 @@ module SemanticPuppet
         prerelease = prerelease.split('.', -1)
 
         if prerelease.empty? or prerelease.any? { |x| x.empty? }
-          raise "#{subject} MUST NOT be empty"
+          raise _("%{subject} MUST NOT be empty") % {subject: subject}
         elsif prerelease.any? { |x| x =~ /[^0-9a-zA-Z-]/ }
-          raise "#{subject} MUST use only ASCII alphanumerics and hyphens"
+          raise _("%{subject} MUST use only ASCII alphanumerics and hyphens") % {subject: subject}
         elsif prerelease.any? { |x| x =~ /^0\d+$/ }
-          raise "#{subject} MUST NOT contain leading zeroes"
+          raise _("%{subject} MUST NOT contain leading zeroes") % {subject: subject}
         end
 
         return prerelease.map { |x| x =~ /^\d+$/ ? x.to_i : x }
@@ -61,9 +61,9 @@ module SemanticPuppet
         build = build.split('.', -1)
 
         if build.empty? or build.any? { |x| x.empty? }
-          raise "#{subject} MUST NOT be empty"
+          raise _("%{subject} MUST NOT be empty") % {subject: subject}
         elsif build.any? { |x| x =~ /[^0-9a-zA-Z-]/ }
-          raise "#{subject} MUST use only ASCII alphanumerics and hyphens"
+          raise _("%{subject} MUST use only ASCII alphanumerics and hyphens") % {subject: subject}
         end
 
         return build

data/lib/semantic_puppet/version_range.rb

@@ -46,7 +46,7 @@ module SemanticPuppet
         end
 
       rescue ArgumentError
-        raise ArgumentError, "Unparsable version range: #{range_str.inspect}"
+        raise ArgumentError, _("Unparsable version range: %{range}") % {range: range_str.inspect}
       end
 
       private

data/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: 'semantic_puppet'
+  # 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: Semantic Puppet Gem
+  # 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, Inc.
+  # Patterns for +Dir.glob+ used to find all files that might contain
+  # translatable content, relative to the project root directory
+  source_files:
+    - 'lib/**/*.rb'

data/semantic_puppet.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "semantic_puppet"
+require "semantic_puppet/gem_version"
 
 spec = Gem::Specification.new do |s|
   # Metadata
@@ -22,6 +22,8 @@ spec = Gem::Specification.new do |s|
   # Dependencies
   s.required_ruby_version = '>= 1.8.7'
 
+  s.add_dependency "gettext-setup", ">= 0.3"
+
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "simplecov"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: semantic_puppet
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Puppet Labs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2016-07-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: gettext-setup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -116,8 +130,10 @@ files:
 - lib/semantic_puppet/dependency/module_release.rb
 - lib/semantic_puppet/dependency/source.rb
 - lib/semantic_puppet/dependency/unsatisfiable_graph.rb
+- lib/semantic_puppet/gem_version.rb
 - lib/semantic_puppet/version.rb
 - lib/semantic_puppet/version_range.rb
+- locales/config.yaml
 - semantic_puppet.gemspec
 - spec/spec_helper.rb
 - spec/unit/semantic_puppet/dependency/graph_node_spec.rb