From 31f8e660c8f4c0ec01f140322cf7c585144a0888 Mon Sep 17 00:00:00 2001
From: Markus Roberts <Markus@reality.com>
Date: Thu, 21 Oct 2010 17:24:09 -0700
Subject: Refactor en route to #5027 -- remove usestring parameter from
 lookupvar

The usestring parameter to lookupvar was objectionable for several reasons;
first, it performed a function orthogonal to the main purpose of the method,
second its default was the least common value, and third it was causing other
code to work for reasons that were not obvious (extlookup).

This refactor breaks the value-transforming function out into a seperate
method which allows the user to specify the value to be used in lieu of :undef
and removes the parameter.  The function, Scope#undef_as(default,exp) is
written so that it can be used in user code (templates, functions, etc.) if
needed.

This refactor will introduce a user-visible behaviour change in the case where
users were counting on lookupvar to return "" for undefined variables.  The
best solution is to have them use undef_as, replacing:

    lookupvar('myvar')

with

    undef_as('',lookupvar('myvar'))

(with the option to specify another default value if desired).  If this is too
objectionable, we could rename the existing lookupvar as raw_lookupvar and
define

    def lookupvar(v)
      undef_as('',raw_lookupvar(v))
    end

to restore the present behaviour.
---
 lib/puppet/parser/templatewrapper.rb | 10 ++--------
 1 file changed, 2 insertions(+), 8 deletions(-)

(limited to 'lib/puppet/parser/templatewrapper.rb')

diff --git a/lib/puppet/parser/templatewrapper.rb b/lib/puppet/parser/templatewrapper.rb
index 6864aa1a9..73fcb8aac 100644
--- a/lib/puppet/parser/templatewrapper.rb
+++ b/lib/puppet/parser/templatewrapper.rb
@@ -20,11 +20,7 @@ class Puppet::Parser::TemplateWrapper
 
   # Should return true if a variable is defined, false if it is not
   def has_variable?(name)
-    if scope.lookupvar(name.to_s, false) != :undefined
-      true
-    else
-      false
-    end
+    scope.lookupvar(name.to_s) != :undefined
   end
 
   # Allow templates to access the defined classes
@@ -55,9 +51,7 @@ class Puppet::Parser::TemplateWrapper
   # the missing_method definition here until we declare the syntax finally
   # dead.
   def method_missing(name, *args)
-    # We have to tell lookupvar to return :undefined to us when
-    # appropriate; otherwise it converts to "".
-    value = scope.lookupvar(name.to_s, false)
+    value = scope.lookupvar(name.to_s)
     if value != :undefined
       return value
     else
-- 
cgit 


From 739260b28d7c09bacbb34cd4f4d4a32cfee01385 Mon Sep 17 00:00:00 2001
From: Markus Roberts <Markus@reality.com>
Date: Sun, 24 Oct 2010 23:29:38 -0700
Subject: Towards 5027 -- add options hash to lookupvar as with setvar

This patch adds an options hash to lookupvar analogous to the one taken by
setvar and uses it to pass in source location for error reporting.  It also
fixes the mechanism used by setvar (file was not being passed correctly), adds
line and file information to errors in templates, and extends/corrects tests.

As presently written it does not gather userful line numbers from inline
templates and there are no tests for the template line number generation.
---
 lib/puppet/parser/templatewrapper.rb | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

(limited to 'lib/puppet/parser/templatewrapper.rb')

diff --git a/lib/puppet/parser/templatewrapper.rb b/lib/puppet/parser/templatewrapper.rb
index 73fcb8aac..180a03dc9 100644
--- a/lib/puppet/parser/templatewrapper.rb
+++ b/lib/puppet/parser/templatewrapper.rb
@@ -18,9 +18,14 @@ class Puppet::Parser::TemplateWrapper
     @__scope__
   end
 
+  def script_line
+    # find which line in the template (if any) we were called from
+    caller.find { |l| l =~ /#{file}:/ }.first[/:(\d+):/,1]
+  end
+
   # Should return true if a variable is defined, false if it is not
   def has_variable?(name)
-    scope.lookupvar(name.to_s) != :undefined
+    scope.lookupvar(name.to_s, :file => file, :line => script_line) != :undefined
   end
 
   # Allow templates to access the defined classes
@@ -51,13 +56,13 @@ class Puppet::Parser::TemplateWrapper
   # the missing_method definition here until we declare the syntax finally
   # dead.
   def method_missing(name, *args)
-    value = scope.lookupvar(name.to_s)
+    value = scope.lookupvar(name.to_s,:file => file,:line => script_line)
     if value != :undefined
       return value
     else
       # Just throw an error immediately, instead of searching for
       # other missingmethod things or whatever.
-      raise Puppet::ParseError, "Could not find value for '#{name}'"
+      raise Puppet::ParseError.new("Could not find value for '#{name}'",@file,script_line)
     end
   end
 
@@ -97,6 +102,7 @@ class Puppet::Parser::TemplateWrapper
     result = nil
     benchmark(:debug, "Interpolated template #{template_source}") do
       template = ERB.new(self.string, 0, "-")
+      template.filename = file
       result = template.result(binding)
     end
 
-- 
cgit