closure 1.2.701 → 1.3.0

data/README.md

@@ -1,13 +1,14 @@
-Closure Script for Google Closure Compiler, Library, and Templates.
+Google Closure Compiler, Library, Script, and Templates.
 
 Licensed under the Apache License, Version 2.0 (the "License"); 
 <http://www.apache.org/licenses/LICENSE-2.0>
 
-Project home;
-<http://www.closure-script.com/>
 
-Getting Started documentation is on the wiki;
-<https://github.com/dturnbull/closure-script/wiki>
-
-Advanced documentation is in YARD format;
-<http://rubydoc.info/gems/closure/frames>
+Step 1: Download to a new folder: 
+<https://github.com/dturnbull/closure-script/downloads>
+        
+Step 2: Run from the new folder with Java: 
+```java -jar closure.jar```
+        
+Step 3: Open a web browser:
+```http://localhost:8080/```

data/closure-compiler/README

@@ -188,7 +188,7 @@ lib/guava.jar
 
 Guava Libraries
 URL: http://code.google.com/p/guava-libraries/
-Version:  R7
+Version:  r08
 License: Apache License 2.0
 
 Description: Google's core Java libraries.

data/docs/SCRIPT.md

@@ -0,0 +1,142 @@
+# Closure Script Overview
+
+Closure Script is a specialized web server that automates the Closure build process.
+Typically, Closure development is driven by static HTML pages or your main
+application is given knowledge of your development systems.
+With Script, you build HTML or Javascript with embedded Ruby.
+The core Script technology is very simple and all Scripts execute in the same context
+regardless if they are test, demo, or compiler scripts.
+
+Exploring or extending the examples is the best way to learn <a href="https://github.com/dturnbull/closure-script">Closure Script</a>.  If you
+are looking for information about Closure in general, 
+<a href="http://oreilly.com/catalog/0636920001416">Closure: The Definitive Guide</a>
+is a solid reference.
+
+## Closure::Script Context
+
+A Script is executed in the context of a Rack::Request that has been extended
+with Closure::Script.  Rack::Request is everything having to do
+with the http request and Closure::Script is all about the interface to Closure.
+In most cases, the only Script I will put on a page simply relays the query string
+to the compiler Script:
+
+    <script src='compiler.js?<%= query_string %>'></script>
+
+Script helps with testing because it can see your filesystem in ways that
+browsers are not allowed to.
+Here's a replacement for the static alltests.js in closure-library:
+
+    <% all_test_files = Dir.glob expand_path '**/*_test.html'
+       json_strings = all_test_files.map { |x| relative_src(x).dump }
+    -%>var _allTests = [<%= json_strings.join(',') %>];
+
+A Script can be entirely Ruby, entirely HTML, or anything in-between.  Scripts of
+mostly Ruby look like models or controllers and Scripts of mostly HTML look like
+views.  This makes Script a poor framework for enforcing web server patterns but
+gives it a great deal of flexibility as a build tool.
+
+The instance of Closure::Goog in Closure::Script provides easy access to the compiler and other information
+about your source Javascript.  Script that compiles generally starts simple then grows with options
+as your project matures.  Here's the simple version:
+
+    <% @response = goog.compile(%w{
+      --compilation_level ADVANCED_OPTIMIZATIONS
+      --js_output_file compiler_out.js
+      --ns myapp.hello
+    }).to_response %>
+
+And what it looks likes when you start processing query options:
+
+    <% args = %w{
+      --ns myapp.hello
+    }
+    args += case query_string
+    when 'build': %w{
+      --compilation_level ADVANCED_OPTIMIZATIONS
+      --js_output_file compiler_build.js
+    }
+    when 'debug': %w{
+      --debug true
+      --formatting PRETTY_PRINT
+      --compilation_level ADVANCED_OPTIMIZATIONS
+      --js_output_file compiler_debug.js
+    }
+    else;[];end
+    @response = goog.compile(args).to_response %>
+
+The @response attribute of Closure::Script is an instance of Rack::Response.  If you do
+nothing with this then then results of rendering will be sent as a response.  If you
+write to @response or change it to another object then the rendering is discarded.
+
+Regardless of your language background, cut-and-paste programming from the
+scaffold examples should be practical.  That's the idea anyways.
+If you can conditionally build arrays of strings in Ruby, you're good to go. 
+But, of course, the more Ruby you know the more you'll be able to do.
+
+## config.ru
+
+This file is unique in that there's only one and it's the only one that isn't a Script.
+Ruby developers may recognize the filename since it's convention for starting a web server.
+Changing this file requires a server restart but there isn't much in config.ru that needs changing.
+
+The default config.ru explains more in its comments.  The smallest practical config.ru would be:
+
+    require 'closure'
+    Closure.add_source '.', '/'
+    use Closure::Middleware
+    run Rack::File.new '.'
+    
+## Argument Augmentation
+
+Closure Script adds additional features to the compiler like file modification checks and
+easy module generation.  It does this by augmenting the command line arguments.  
+The compiler arguments in Ruby are going to be the same arguments as if you ran compiler.jar
+from the command line.  Except for the few things that are augmented by Closure Script.
+
+The most important augmentation is the addition of the --ns option.  This is how you
+compile a namespace and its dependencies.  How it works is simple in concept.
+Closure Script watches your source files and knows all their goog.provide and require
+namespaces.  It will drop the --ns option and replace it with --js options to
+satisfy the namespace before calling compiler.jar.
+
+If you're coming from plovr then you are probably used to compiling a namespace by
+specifying a file as the root.  Closure Script will not calculate the dependencies if
+you use --js.  This works for plovr with its JSON config, but overloading --js in Script
+would leave ambiguity that could never be resolved.  Do I follow the namespaces or not?
+
+The are three more augmented arguments.  Not specifying a --compilation_level will
+load the original sources instead of compiling.  Module format --module api:*:app will
+have the * replaced with an actual file count.  And, if you specify a --js_output_file
+then compilation will be conditional on one of the sources having a modification time
+greater than the output file.
+
+Because Script doesn't use a modified compiler, you are free to use the latest
+compiler version or revert to an older one.  Simply set Closure.config.compiler_jar
+in config.ru to point to the one you want to use.  Java and JRuby developers: the
+jars are fetched with URLClassLoader and don't need to be in any Java paths.
+
+## Compatibility
+
+The .jar only needs Java.  It contains JRuby and the Closure tools.  Guaranteed success.
+
+The gem should work on any kind of Ruby that is like version 1.8 or greater.
+The Script source code is non-magical so any issues will be easy to fix.
+Mac, Linux, and Windows all work.  If you can get Rack running, Closure
+Script should be no problem.
+
+## Script Engines
+
+Closure Script comes with support for several file formats.
+If you want something else, it is easy to add new engines to Script
+with the Closure.config.engines setting.
+
+ERB (.erb)
+: This is plain old HTML with support for Ruby in <% %> and <%= %> tags.
+  ERB::Util is mixed in for <%=h 'string' %> and <%=u 'string' %> helpers.
+
+Haml (.haml)
+: This is an indented format (no closing tags) that a lot of Ruby developers use.
+
+Markdown (.md, .markdown)
+: Read-me files and developer documentation look nice for cheap and easy.
+  This very document is in markdown source.

data/docs/closure/Closure/BeanShell.html

@@ -0,0 +1,335 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: Closure::BeanShell
+  
+    &mdash; Documentation by YARD 0.7.2
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  relpath = '..';
+  if (relpath != '') relpath += '/';
+</script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    
+    <div id="header">
+      <div id="menu">
+  
+    <a href="../_index.html">Index (B)</a> &raquo; 
+    <span class='title'><span class='object_link'><a href="../Closure.html" title="Closure (class)">Closure</a></span></span>
+     &raquo; 
+    <span class="title">BeanShell</span>
+  
+  
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a id="class_list_link" href="#">Class List</a>
+  
+    <a id="method_list_link" href="#">Method List</a>
+  
+    <a id="file_list_link" href="#">File List</a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+    
+    <iframe id="search_frame"></iframe>
+    
+    <div id="content"><h1>Class: Closure::BeanShell
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Closure::BeanShell</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/closure/beanshell.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>
+Closure Script will manage a single BeanShell to run the Java tools. This
+way we don&#8217;t pay the Java startup costs on every compile job.
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+</div>
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="PROMPT-constant" class="">PROMPT =
+          
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^bsh % $\Z</span><span class='regexp_end'>/</span></span></pre></dd>
+      
+        <dt id="JAR-constant" class="">JAR =
+          
+        </dt>
+        <dd><pre class="code"><span class='const'>File</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='const'>Closure</span><span class='period'>.</span><span class='id base_path'>base_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>beanshell</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>bsh-core-2.0b4.jar</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span></pre></dd>
+      
+    </dl>
+  
+
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (BeanShell) <strong>initialize</strong>(classpath = []) </a>
+    
+
+    
+  </span>
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>
+A new instance of BeanShell.
+</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#run-instance_method" title="#run (instance method)">- <strong>run</strong>(command) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>
+Run any Java command that BeanShell supports.
+</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <p class="signature first" id="initialize-instance_method">
+  
+    - (<tt><span class='object_link'><a href="" title="Closure::BeanShell (class)">BeanShell</a></span></tt>) <strong>initialize</strong>(classpath = []) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+A new instance of BeanShell
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>classpath</span>
+      
+      
+        <span class='type'>(<tt>Array</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>[]</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'><p>
+<string>
+</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+26
+27
+28
+29
+30</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/closure/beanshell.rb', line 26</span>
+
+<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id classpath'>classpath</span><span class='op'>=</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+  <span class='ivar'>@semaphore</span> <span class='op'>=</span> <span class='const'>Mutex</span><span class='period'>.</span><span class='id new'>new</span>
+  <span class='ivar'>@classpath</span> <span class='op'>=</span> <span class='id classpath'>classpath</span>
+  <span class='gvar'>$cmdin</span> <span class='op'>=</span> <span class='kw'>nil</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+    
+    
+      <div class="method_details first">
+  <p class="signature first" id="run-instance_method">
+  
+    - <strong>run</strong>(command) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Run any Java command that BeanShell supports. Recovers from error
+conditions when the Java process is killed.
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/closure/beanshell.rb', line 34</span>
+
+<span class='kw'>def</span> <span class='id run'>run</span><span class='lparen'>(</span><span class='id command'>command</span><span class='rparen'>)</span>
+  <span class='kw'>begin</span>
+    <span class='kw'>return</span> <span class='id execute'>execute</span> <span class='id command'>command</span>
+  <span class='kw'>rescue</span> <span class='const'>Errno</span><span class='op'>::</span><span class='const'>EPIPE</span>
+    <span class='comment'># Shut down broken pipe; another will be started.
+</span>    <span class='gvar'>$stderr</span><span class='period'>.</span><span class='id print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id class'>class</span><span class='rbrace'>}</span><span class='tstring_content'>: restarting Java.\n</span><span class='tstring_end'>&quot;</span></span>
+    <span class='gvar'>$pipe</span><span class='period'>.</span><span class='id close'>close</span>
+    <span class='gvar'>$pipe</span> <span class='op'>=</span> <span class='kw'>nil</span>
+  <span class='kw'>end</span>
+  <span class='comment'># This &quot;second chance&quot; will not rescue the error.
+</span>  <span class='id execute'>execute</span> <span class='id command'>command</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+    
+    <div id="footer">
+  Generated on Sun Jun 26 17:35:57 2011 by 
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.7.2 (ruby-1.9.2).
+</div>
+
+  </body>
+</html>