Clover coverage report - Code Coverage for tapestry release 4.0
Coverage timestamp: Fri Jan 6 2006 10:33:20 PST
file stats: LOC: 170   Methods: 5
NCLOC: 76   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
Script.java 80% 83.3% 80% 82.2%
coverage coverage
 1    // Copyright 2004, 2005 The Apache Software Foundation
 2    //
 3    // Licensed under the Apache License, Version 2.0 (the "License");
 4    // you may not use this file except in compliance with the License.
 5    // You may obtain a copy of the License at
 6    //
 7    // http://www.apache.org/licenses/LICENSE-2.0
 8    //
 9    // Unless required by applicable law or agreed to in writing, software
 10    // distributed under the License is distributed on an "AS IS" BASIS,
 11    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12    // See the License for the specific language governing permissions and
 13    // limitations under the License.
 14   
 15    package org.apache.tapestry.html;
 16   
 17    import java.util.HashMap;
 18    import java.util.Iterator;
 19    import java.util.Map;
 20   
 21    import org.apache.hivemind.ApplicationRuntimeException;
 22    import org.apache.hivemind.Resource;
 23    import org.apache.tapestry.AbstractComponent;
 24    import org.apache.tapestry.IBinding;
 25    import org.apache.tapestry.IMarkupWriter;
 26    import org.apache.tapestry.IRequestCycle;
 27    import org.apache.tapestry.IScript;
 28    import org.apache.tapestry.PageRenderSupport;
 29    import org.apache.tapestry.Tapestry;
 30    import org.apache.tapestry.TapestryUtils;
 31    import org.apache.tapestry.engine.IScriptSource;
 32   
 33    /**
 34    * Works with the {@link Body}component to add a script (and perhaps some initialization) to the
 35    * HTML response. [ <a href="../../../../../ComponentReference/Script.html">Component Reference
 36    * </a>]
 37    *
 38    * @author Howard Lewis Ship
 39    */
 40   
 41    public abstract class Script extends AbstractComponent
 42    {
 43    /**
 44    * Injected
 45    *
 46    * @since 4.0
 47    */
 48   
 49    public abstract IScriptSource getScriptSource();
 50   
 51    /**
 52    * A Map of input and output symbols visible to the body of the Script.
 53    *
 54    * @since 2.2
 55    */
 56   
 57    private Map _symbols;
 58   
 59    /**
 60    * Constructs the symbols {@link Map}. This starts with the contents of the symbols parameter
 61    * (if specified) to which is added any informal parameters. If both a symbols parameter and
 62    * informal parameters are bound, then a copy of the symbols parameter's value is made (that is,
 63    * the {@link Map}provided by the symbols parameter is read, but not modified).
 64    */
 65   
 66  3 private Map getInputSymbols()
 67    {
 68  3 Map result = new HashMap();
 69   
 70  3 Map baseSymbols = getBaseSymbols();
 71   
 72  3 if (baseSymbols != null)
 73  2 result.putAll(baseSymbols);
 74   
 75    // Now, iterate through all the binding names (which includes both
 76    // formal and informal parmeters). Skip the formal ones and
 77    // access the informal ones.
 78   
 79  3 Iterator i = getBindingNames().iterator();
 80  3 while (i.hasNext())
 81    {
 82  1 String bindingName = (String) i.next();
 83   
 84    // Skip formal parameters
 85   
 86  1 if (getSpecification().getParameter(bindingName) != null)
 87  0 continue;
 88   
 89  1 IBinding binding = getBinding(bindingName);
 90   
 91  1 Object value = binding.getObject();
 92   
 93  1 result.put(bindingName, value);
 94    }
 95   
 96  3 return result;
 97    }
 98   
 99    /**
 100    * Gets the {@link IScript}for the correct script.
 101    */
 102   
 103  3 private IScript getParsedScript()
 104    {
 105  3 String scriptPath = getScriptPath();
 106   
 107  3 if (scriptPath == null)
 108  0 throw Tapestry.createRequiredParameterException(this, "scriptPath");
 109   
 110  3 IScriptSource source = getScriptSource();
 111   
 112    // If the script path is relative, it should be relative to the Script component's
 113    // container (i.e., relative to a page in the application).
 114   
 115  3 Resource rootLocation = getContainer().getSpecification().getSpecificationLocation();
 116  3 Resource scriptLocation = rootLocation.getRelativeResource(scriptPath);
 117   
 118  3 try
 119    {
 120  3 return source.getScript(scriptLocation);
 121    }
 122    catch (RuntimeException ex)
 123    {
 124  0 throw new ApplicationRuntimeException(ex.getMessage(), this, getBinding("script")
 125    .getLocation(), ex);
 126    }
 127   
 128    }
 129   
 130  4 protected void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
 131    {
 132  4 if (!cycle.isRewinding())
 133    {
 134  3 PageRenderSupport pageRenderSupport = TapestryUtils.getPageRenderSupport(cycle, this);
 135   
 136  3 _symbols = getInputSymbols();
 137   
 138  3 getParsedScript().execute(cycle, pageRenderSupport, _symbols);
 139    }
 140   
 141    // Render the body of the Script;
 142  4 renderBody(writer, cycle);
 143    }
 144   
 145    public abstract String getScriptPath();
 146   
 147    // Parameter
 148   
 149    public abstract Map getBaseSymbols();
 150   
 151    /**
 152    * Returns the complete set of symbols (input and output) from the script execution. This is
 153    * visible to the body of the Script, but is cleared after the Script finishes rendering.
 154    *
 155    * @since 2.2
 156    */
 157   
 158  2 public Map getSymbols()
 159    {
 160  2 return _symbols;
 161    }
 162   
 163  0 protected void cleanupAfterRender(IRequestCycle cycle)
 164    {
 165  0 _symbols = null;
 166   
 167  0 super.cleanupAfterRender(cycle);
 168    }
 169   
 170    }