Clover coverage report - Code Coverage for tapestry release 4.0-beta-10
Coverage timestamp: Sat Oct 8 2005 19:08:05 EDT
file stats: LOC: 171   Methods: 5
NCLOC: 77   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.IEngine;
 26    import org.apache.tapestry.IMarkupWriter;
 27    import org.apache.tapestry.IRequestCycle;
 28    import org.apache.tapestry.IScript;
 29    import org.apache.tapestry.PageRenderSupport;
 30    import org.apache.tapestry.Tapestry;
 31    import org.apache.tapestry.TapestryUtils;
 32    import org.apache.tapestry.engine.IScriptSource;
 33   
 34    /**
 35    * Works with the {@link Body}component to add a script (and perhaps some initialization) to the
 36    * HTML response. [ <a href="../../../../../ComponentReference/Script.html">Component Reference
 37    * </a>]
 38    *
 39    * @author Howard Lewis Ship
 40    */
 41   
 42    public abstract class Script extends AbstractComponent
 43    {
 44    /**
 45    * Injected
 46    *
 47    * @since 4.0
 48    */
 49   
 50    public abstract IScriptSource getScriptSource();
 51   
 52    /**
 53    * A Map of input and output symbols visible to the body of the Script.
 54    *
 55    * @since 2.2
 56    */
 57   
 58    private Map _symbols;
 59   
 60    /**
 61    * Constructs the symbols {@link Map}. This starts with the contents of the symbols parameter
 62    * (if specified) to which is added any informal parameters. If both a symbols parameter and
 63    * informal parameters are bound, then a copy of the symbols parameter's value is made (that is,
 64    * the {@link Map}provided by the symbols parameter is read, but not modified).
 65    */
 66   
 67  3 private Map getInputSymbols()
 68    {
 69  3 Map result = new HashMap();
 70   
 71  3 Map baseSymbols = getBaseSymbols();
 72   
 73  3 if (baseSymbols != null)
 74  2 result.putAll(baseSymbols);
 75   
 76    // Now, iterate through all the binding names (which includes both
 77    // formal and informal parmeters). Skip the formal ones and
 78    // access the informal ones.
 79   
 80  3 Iterator i = getBindingNames().iterator();
 81  3 while (i.hasNext())
 82    {
 83  1 String bindingName = (String) i.next();
 84   
 85    // Skip formal parameters
 86   
 87  1 if (getSpecification().getParameter(bindingName) != null)
 88  0 continue;
 89   
 90  1 IBinding binding = getBinding(bindingName);
 91   
 92  1 Object value = binding.getObject();
 93   
 94  1 result.put(bindingName, value);
 95    }
 96   
 97  3 return result;
 98    }
 99   
 100    /**
 101    * Gets the {@link IScript}for the correct script.
 102    */
 103   
 104  3 private IScript getParsedScript()
 105    {
 106  3 String scriptPath = getScriptPath();
 107   
 108  3 if (scriptPath == null)
 109  0 throw Tapestry.createRequiredParameterException(this, "scriptPath");
 110   
 111  3 IScriptSource source = getScriptSource();
 112   
 113    // If the script path is relative, it should be relative to the Script component's
 114    // container (i.e., relative to a page in the application).
 115   
 116  3 Resource rootLocation = getContainer().getSpecification().getSpecificationLocation();
 117  3 Resource scriptLocation = rootLocation.getRelativeResource(scriptPath);
 118   
 119  3 try
 120    {
 121  3 return source.getScript(scriptLocation);
 122    }
 123    catch (RuntimeException ex)
 124    {
 125  0 throw new ApplicationRuntimeException(ex.getMessage(), this, getBinding("script")
 126    .getLocation(), ex);
 127    }
 128   
 129    }
 130   
 131  4 protected void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
 132    {
 133  4 if (!cycle.isRewinding())
 134    {
 135  3 PageRenderSupport pageRenderSupport = TapestryUtils.getPageRenderSupport(cycle, this);
 136   
 137  3 _symbols = getInputSymbols();
 138   
 139  3 getParsedScript().execute(cycle, pageRenderSupport, _symbols);
 140    }
 141   
 142    // Render the body of the Script;
 143  4 renderBody(writer, cycle);
 144    }
 145   
 146    public abstract String getScriptPath();
 147   
 148    // Parameter
 149   
 150    public abstract Map getBaseSymbols();
 151   
 152    /**
 153    * Returns the complete set of symbols (input and output) from the script execution. This is
 154    * visible to the body of the Script, but is cleared after the Script finishes rendering.
 155    *
 156    * @since 2.2
 157    */
 158   
 159  2 public Map getSymbols()
 160    {
 161  2 return _symbols;
 162    }
 163   
 164  0 protected void cleanupAfterRender(IRequestCycle cycle)
 165    {
 166  0 _symbols = null;
 167   
 168  0 super.cleanupAfterRender(cycle);
 169    }
 170   
 171    }