puppet_forge 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 274c0fbddb8599de6d21476810d91eb298e88720
-  data.tar.gz: 147c3aadd5fe7c3fc6cc1d2ebca74916049d2925
+  metadata.gz: cf3597a6621d4980a95db5690d60d0448c48295d
+  data.tar.gz: 90545df14bb6128d330e2d6c0769b0bbeb84ff10
 SHA512:
-  metadata.gz: ca092a41b2952ab4a8564e136a3b9562eeba61830863be6c8871baa2fa6a3c6bbae1d4aee56add286f9ff55c0bbe3bb16c4ed7634dbf4e790429edc57cc655ef
-  data.tar.gz: 564152499bcfd5b418a3842da2ff8d202194ab3f66997aacb4e0ddef7ab5c787858f7463b60e70ff84363654245e30bfb13924b5edb073e743137cc21da6bdf1
+  metadata.gz: fd7247cdacde04841fab5a86fa5b11d82307f64d5ad4081be62f2a60cab63ea995736dee808047e487d7b58172dda0035bab3718039b09a3a3d467192302b617
+  data.tar.gz: fa634012325f4b1211e1ea8ca6b25db72a33143607f6af8202c1c554e5624cee1768b16dec28a9ee27e42ae5605120d6b4395023784ba750171652d46e82fad9

data/.gitignore

@@ -20,3 +20,4 @@ _yardoc
 *.o
 *.a
 mkmf.log
+locales/forge-ruby.pot

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 Starting with v2.0.0, all notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## v2.2.2 - 2016-07-06
+
+### Changed
+
+* Externalized all user facing strings with gettext to support future localization work.
+
 ## v2.2.1 - 2016-05-24
 
 ### Changed

data/README.md

@@ -186,6 +186,26 @@ user.username # => "puppetlabs"
 user.created_at # => "2010-05-19 05:46:26 -0700"
 ```
 
+### 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 PuppetForge 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"
+```
+
 ##Caveats
 
 This library currently does no response caching of its own, instead opting to
@@ -214,3 +234,12 @@ to create a free account to add new tickets.
 * Austin Blatt, Puppet Labs
 * Adrien Thebo, Puppet Labs
 * Anderson Mills, Puppet Labs
+
+## Maintenance
+
+Maintainers:
+
+* Jesse Scott, jesse@puppet.com
+* Anderson Mills, anderson@puppet.com
+
+Tickets: File at https://tickets.puppet.com/browse/FORGE

data/Rakefile

@@ -1,2 +1,7 @@
 require "bundler/gem_tasks"
 
+# i18n/gettext Rake tasks
+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__)))
+

data/lib/puppet_forge.rb

@@ -1,4 +1,5 @@
 require 'puppet_forge/version'
+require 'gettext-setup'
 
 module PuppetForge
   class << self
@@ -6,6 +7,8 @@ module PuppetForge
     attr_accessor :host
   end
 
+  GettextSetup.initialize(File.absolute_path('../locales', File.dirname(__FILE__)))
+
   self.host = 'https://forgeapi.puppetlabs.com'
 
   require 'puppet_forge/tar'

data/lib/puppet_forge/connection/connection_failure.rb

@@ -10,9 +10,10 @@ module PuppetForge
       rescue Faraday::ConnectionFailed => e
         baseurl = env[:url].dup
         baseurl.path = ''
-        errmsg = "Unable to connect to #{baseurl.to_s}"
         if proxy = env[:request][:proxy]
-          errmsg << " (using proxy #{proxy.uri.to_s})"
+          errmsg = _("Unable to connect to %{url} (using proxy %{proxy})") % {url: baseurl.to_s, proxy: proxy.uri.to_s}
+        else
+          errmsg = _("Unable to connect to %{url}") % {url: baseurl.to_s}
         end
         errmsg << ": #{e.message}"
         m = Faraday::ConnectionFailed.new(errmsg)

data/lib/puppet_forge/error.rb

@@ -16,15 +16,11 @@ module PuppetForge
     def initialize(options)
       @entry_path = options[:entry_path]
       @directory  = options[:directory]
-      super "Attempt to install file into #{@entry_path.inspect} under #{@directory.inspect}"
+      super _("Attempt to install file into %{path} under %{directory}") % {path: @entry_path.inspect, directory: @directory.inspect}
     end
 
     def multiline
-      <<-MSG.strip
-Could not install package
-  Package attempted to install file into
-  #{@entry_path.inspect} under #{@directory.inspect}.
-      MSG
+      _("Could not install package\n  Package attempted to install file into\n  %{path} under %{directory}.") % {path: @entry_path.inspect, directory: @directory.inspect}
     end
   end
 

data/lib/puppet_forge/lazy_relations.rb

@@ -24,7 +24,7 @@ module PuppetForge
       version = class_name.split("::")[-2]
 
       if version.nil?
-        raise RuntimeError, "Unable to determine the parent PuppetForge version module"
+        raise RuntimeError, _("Unable to determine the parent PuppetForge version module")
       end
 
       PuppetForge.const_get(version)

data/lib/puppet_forge/unpacker.rb

@@ -39,7 +39,7 @@ module PuppetForge
       begin
         PuppetForge::Tar.instance.unpack(@filename, @tmpdir)
       rescue PuppetForge::ExecutionFailure => e
-        raise RuntimeError, "Could not extract contents of module archive: #{e.message}"
+        raise RuntimeError, _("Could not extract contents of module archive: %{error_msg}") % {error_msg: e.message}
       end
     end
 
@@ -61,7 +61,7 @@ module PuppetForge
       if metadata_file
         @root_dir = Pathname.new(metadata_file).dirname
       else
-        raise "No valid metadata.json found!"
+        raise _("No valid metadata.json found!")
       end
     end
   end

data/lib/puppet_forge/v3/metadata.rb

@@ -63,7 +63,7 @@ module PuppetForge
         validate_version_range(version_requirement) if version_requirement
 
         if dup = @data['dependencies'].find { |d| d.full_module_name == name && d.version_requirement != version_requirement }
-          raise ArgumentError, "Dependency conflict for #{full_module_name}: Dependency #{name} was given conflicting version requirements #{version_requirement} and #{dup.version_requirement}. Verify that there are no duplicates in the metadata.json or the Modulefile."
+          raise ArgumentError, _("Dependency conflict for %{module_name}: Dependency %{conflict_name} was given conflicting version requirements %{version} and %{conflict_version}. Verify that there are no duplicates in the metadata.json or the Modulefile.") % {module_name: full_module_name, conflict_name: name, version: version_requirement, conflict_version: dup.version_requirement}
         end
 
         dep = Dependency.new(name, version_requirement, repository)
@@ -165,31 +165,30 @@ module PuppetForge
 
         err = case modname
         when nil, '', :namespace_missing
-          "the field must be a namespaced module name"
+          _("the field must be a namespaced module name")
         when /[^a-z0-9_]/i
-          "the module name contains non-alphanumeric (or underscore) characters"
+          _("the module name contains non-alphanumeric (or underscore) characters")
         when /^[^a-z]/i
-          "the module name must begin with a letter"
+          _("the module name must begin with a letter")
         else
-          "the namespace contains non-alphanumeric characters"
+          _("the namespace contains non-alphanumeric characters")
         end
 
-        raise ArgumentError, "Invalid 'name' field in metadata.json: #{err}"
+        raise ArgumentError, _("Invalid 'name' field in metadata.json: %{error}") % {error: err}
       end
 
       # Validates that the version string can be parsed by SemanticPuppet.
       def validate_version(version)
         return if SemanticPuppet::Version.valid?(version)
 
-        err = "version string cannot be parsed as a valid Semantic Version"
-        raise ArgumentError, "Invalid 'version' field in metadata.json: #{err}"
+        raise ArgumentError, _("Invalid 'version' field in metadata.json: version string cannot be parsed as a valid Semantic Version")
       end
 
       # Validates that the version range can be parsed by SemanticPuppet.
       def validate_version_range(version_range)
         SemanticPuppet::VersionRange.parse(version_range)
       rescue ArgumentError => e
-        raise ArgumentError, "Invalid 'version_range' field in metadata.json: #{e}"
+        raise ArgumentError, _("Invalid 'version_range' field in metadata.json: %{error}") % {error: e} 
       end
     end
   end

data/lib/puppet_forge/v3/release.rb

@@ -27,7 +27,7 @@ module PuppetForge
         resp = self.class.conn.get(download_url)
         path.open('wb') { |fh| fh.write(resp.body) }
       rescue Faraday::ResourceNotFound => e
-        raise PuppetForge::ReleaseNotFound, "The module release #{slug} does not exist on #{self.class.conn.url_prefix}.", e.backtrace
+        raise PuppetForge::ReleaseNotFound, (_("The module release %{release_slug} does not exist on %{url}.") % {release_slug: slug, url: self.class.conn.url_prefix}), e.backtrace
       rescue Faraday::ClientError => e
         if e.response && e.response[:status] == 403
           raise PuppetForge::ReleaseForbidden.from_response(e.response)

data/lib/puppet_forge/version.rb

@@ -1,3 +1,3 @@
 module PuppetForge
-  VERSION = '2.2.1' # Library version
+  VERSION = '2.2.2' # Library version
 end

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: 'forge-ruby'
+  # 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: Puppet Forge 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/puppet_forge.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "faraday_middleware", [">= 0.9.0", "< 0.11.0"]
   spec.add_dependency 'semantic_puppet', '~> 0.1.0'
   spec.add_dependency 'minitar'
+  spec.add_dependency 'gettext-setup', '>= 0.3'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_forge
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 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: faraday
@@ -72,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -217,6 +231,7 @@ files:
 - lib/puppet_forge/v3/release.rb
 - lib/puppet_forge/v3/user.rb
 - lib/puppet_forge/version.rb
+- locales/config.yaml
 - puppet_forge.gemspec
 - spec/fixtures/v3/files/puppetlabs-apache-0.0.1.tar.gz.headers
 - spec/fixtures/v3/files/puppetlabs-apache-0.0.1.tar.gz.json