Jira (PUP-8127) Refactor error location strings to not use words for better I18n support

[Eric Delaney (JIRA)]

Title: Message Title

Eric Delaney updated an issue   Puppet / PUP-8127 Refactor error location strings to not use words for better I18n support Change By: Eric Delaney For better translations we should look at how we add the location information to an error in 'ExternalFileError'. Instead of using words like 'at', 'at line', and 'in' we should change to something like '(file line:pos)'. Then we have no words to translate while still providing the location information. I think replacing the output with the below. Based on which variables are set the names on the left, would cause the output on the right: {code} file line pos -> (file :  line:pos) file line -> (file :  line) file pos -> (file :pos) line pos -> (line:pos) file -> (file) line -> (line) pos -> (:pos) {code} An example with all location information set: {code} 11:20 $ bundle exec puppet apply  foo.pp Error: This Name has no effect. A value was produced and then forgotten (one or more preceding expressions may have the wrong form) (/Users/eric.delaney/work/my_repos/puppet/foo.pp 1:1) Error: This _expression_ is invalid. Did you try declaring a 'crazy' resource without a title? (/Users/eric.delaney/work/my_repos/puppet/foo.pp 1:9) Error: Language validation logged 2 errors. Giving up {code} Here is an example with no file path: {code} 11:14 $ bundle exec puppet apply -e 'this is crazy {}' Error: This Name has no effect. A value was produced and then forgotten (one or more preceding expressions may have the wrong form)  (1:1) Error: This _expression_ is invalid. Did you try declaring a 'crazy' resource without a title?  (1:9) Error: Language validation logged 2 errors. Giving up {code} Places that need to be updated: ./puppet/error.rb - ExternalFileError -> to_s ./puppet/parser/resource.rb - def merge(resource) ./puppet/pops/validation.rb - DiagnosticFormatterPuppetStyle ./puppet/util/errors.rb - Puppet::Util::Errors -> def error_context ./puppet/util/log.rb - Puppet::Util::Log -> to_s line 403 Some of the code that needs to be updated: {code}   module ExternalFileError     # This module implements logging with a filename and line number. Use this     # for errors that need to report a location in a non-ruby file that we     # parse.     attr_accessor :line, :file, :pos     # May be called with 3 arguments for message, file, line, and exception, or     # 4 args including the position on the line.     #     def initialize(message, file=nil, line=nil, pos=nil, original=nil)       if pos.kind_of? Exception         original = pos         pos = nil       end       super(message, original)       @file = file unless (file.is_a?(String) && file.empty?)       @line = line       @pos = pos     end     def to_s       msg = super       @file = nil if (@file.is_a?(String) && @file.empty?)       if @file and @line and @pos         "#{msg} at #{@file}:#{@line}:#{@pos}"       elsif @file and @line         "#{msg} at #{@file}:#{@line}"       elsif @line and @pos           "#{msg} at line #{@line}:#{@pos}"       elsif @line         "#{msg} at line #{@line}"       elsif @file         "#{msg} in #{@file}"       else         msg       end     end   end {code} Add Comment   This message was sent by Atlassian JIRA (v7.0.2#70111-sha1:88534db) -- 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.