Jira (PUP-6188) Puppet::FileSystem.open / exclusive_open does not support passing an encoding like UTF-8

[Moses Mendoza (JIRA)]

Title: Message Title

Moses Mendoza commented on PUP-6188   Re: Puppet::FileSystem.open / exclusive_open does not support passing an encoding like UTF-8 It turns out the ruby implementation of File.open has a couple ways to specify encoding, which gives us a couple options... In the signature open(filename,[,mode[,perm]][,opt]) {|f| block } encoding can be specified in opt as a hash, ie :encoding => 'BOM|UTF-8' but turns out mode can be represented a number of ways, ie: an IO Open Mode: "r" "r+" "w" (this is how the callers linked above are treating it, via the 'options' arg to Puppet::FileSystem.open) an IO Open Mode with encoding: "r:IBM437" "w:BOM|UTF-8" a list of | separated File Constants: File::CREATE|File::APPEND This means an option is to update all internal callers to both Puppet::FileSystem.open and Puppet::FileSystem.exclusive_open to replace the IO Open Mode string with one that specifies both IO Open Mode and Encoding. A second option is to actually just include a hash in the call to ruby's File.open, ie from: 30 def open(path, mode, options, &block) 31 ::File.open(path, options, mode, &block) 32 end to diff --git a/lib/puppet/file_system/file_impl.rb b/lib/puppet/file_system/file_impl.rb index d53183d..e4f8a95 100644 --- a/lib/puppet/file_system/file_impl.rb +++ b/lib/puppet/file_system/file_impl.rb @@ -28,7 +28,7 @@ class Puppet::FileSystem::FileImpl end   def open(path, mode, options, &block) - ::File.open(path, options, mode, &block) + ::File.open(path, options, mode, :encoding => 'BOM|UTF-8', &block) end However, this raises the possibility that user has specified their own encoding (even the same) which raises an error in ruby: [2] pry(main)> Puppet::FileSystem.open('/Users/moses/foo/unicode_file', {:mode => 'w', :encoding => 'BOM|UTF-8'}, 'w') ArgumentError: mode specified twice from /Users/moses/development/puppet/lib/puppet/file_system/file_impl.rb:31:in `initialize' Since it seems the least risky and the least surprising/magic, I'm leaning towards just updating all of the known call sights of either of the Puppet::FileSystem open methods to specifying the encoding as a part of the mode string.. Add Comment   This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.