Merge branch 'cakephp-2.x'

Author: bwiggs

.gitignore

@@ -3,4 +3,4 @@
 
 # Ignore the other helpers. Only pay attention to mustache.php
 *.php
-!mustache.php
+!MustacheHelper.php

mustache.php renamed to MustacheHelper.php

@@ -44,18 +44,15 @@ class MustacheHelper extends AppHelper {
      * @param array $values - passed in values that are merged with the view variables. Associative array
      * @return string - HTML from the Mustache template
      */
-    function element( $element, $values = array() ) {
+    function render( $element, $values = array() ) {
         try {
             // get the template text. Also recursively loads all partials
             $template = $this->_loadTemplate( $element );
-        
-            // grab the Cake view with all variables
-            $V = ClassRegistry::getObject('view');
-            
+
             // Instantiate Mustache, with all data passed in.
-            $M = new Mustache( $template, am( $V->viewVars, $values), $this->partials );
+            $M = new Mustache( $template, am($this->_View->viewVars, $values), $this->partials );
 
-            //generate the HTML
+            // generate the HTML
             $result = $M->render();
 
         } catch ( Exception $e ) {
@@ -102,7 +99,7 @@ function getSingleTemplate( $element ) {
      */
     private function _getElementPath( $element ) {
         $element = str_replace('__', '/', $element);
-        return ROOT . DS . 'app' . DS . 'views' . DS . 'elements' . DS . $element . '.' . $this->ext;
+        return ROOT . DS . 'app' . DS . 'View' . DS . 'Elements' . DS . $element . '.' . $this->ext;
     }
 
 
@@ -116,7 +113,7 @@ private function _loadTemplate( $element, $load_sub_templates = true ) {
 
         //fail nicely if we have a bad file
         if(!file_exists( $path ) ) {
-            debug( "Bad template path: $element<br />" ); 
+            debug( "Bad template path: $path" ); 
             return '';
         }
 
@@ -139,7 +136,7 @@ private function _loadTemplate( $element, $load_sub_templates = true ) {
      */
     private function _loadPartials( $template ) {
         //Extract names of any partials from the template
-        preg_match_all( '/\{\{[\s]*\>[\s]*(.*)[\s]*\}\}/', $template, $partials );
+        preg_match_all( '/\{\{\> (\S+)\}\}/', $template, $partials );
 
         // iterate through the partials
         // adds the corresponding templates to the partials list while avoiding duplicates
@@ -150,4 +147,4 @@ private function _loadPartials( $template ) {
             }
         }
      }
-}
+}

README.md

@@ -1,49 +1,78 @@
-#CakePan 
+# CakePan - CakePHP Mustache Support (CakePHP v2.x)
 
-CakePan is a CakePHP view helper that renders Mustache templates. It will also load and process sub-templates!
+CakePan is a CakePHP view helper that renders Mustache templates. It will also load and process partials!
 
 ### Why use Mustache templates in CakePHP?
 <strong>Portability and scalability!</strong> If you have an app that uses lots of front-end coding, you only have to write your templates once. Mustache templates can be rendered in PHP, Javascript, Ruby, Scala, even C++! If you want to move to or from some other framework (Rails, Grails, Lithium etc.), you can be sure that your views and design won't have to be re-built.
 
 For scalability, when the time comes, you can use templates with a more powerful engine like Scala, or just send JSON from any source, and render with Javascript. 
 
-## Use
+## Installation
 
-### install
-First - make afolder called 'mustache' in your vendors folder. Add the Mustache PHP library to your app/vendor folder. from https://github.com/bobthecow/mustache.php/
+### 1. Add the [PHP Mustache library](https://github.com/bobthecow/mustache.php/) to `app/vendors/mustache`
+### 2. Add CakePan's `MustacheHelper.php` file to `app/Views/Helpers`. 
+### 3. Add the Mustache View Helper to your pages.
 
-Then, place this helper out into the views/helpers folder of your CakePHP project. 
+CakePan should be added to your project the same as any other CakePHP View Helper. See the [Cakebook's View Helpers documentation](http://book.cakephp.org/2.0/en/views/helpers.html) for more information.
 
-### production
-Write your elements in mustache format with the extension ".mustache" rather than ".ctp"!
+If you want to add Mustache support globally, add it to your `AppController`
 
-The Mustache manual is here: http://mustache.github.com/
+	class AppController extends Controller {
+		...
+		public $helpers = array('Mustache');
+		...
+	}
 
-In your view - render an element using $this->Mustache->render('element', $params); just like you would render a CakePHP element. 
-All the variable set by the controller are available, and merged with values passed into $params.
+## Usage
 
-Sub-templates should follow the same naming convention. Mustache will pass the variables to the sub-template in the context that it's called. For example, a nested template for a blog post with comments might look like:
+See the Mustache manual: [http://mustache.github.com/](http://mustache.github.com/)
 
-<pre>
-<strong>/views/elements/posts/post.mustache :</strong>
-{{#Post}}
-  &lt;h2&gt;{{title}}&lt;/h2\&gt;
-  &lt;div&gt;
-    {{text}}
-  &lt;/div&gt;
-{{/Post}}
-{{#Comment}}
-  {{&gt;post/comment}}
-{{/Comment}}
+### Creating a Mustache Template
 
+Your Mustache templates should all be in the `/app/View/Elements/` directory, with a `.mustache` extension.
 
-<strong>/views/elements/posts/comment.mustache :</strong>
-&lt;div&gt;
-&lt;h3&gt;{{#User}}{{name}}{{/User}} said: &lt;/h3&gt;
-&lt;p&gt;{{text}}&lt;/p&gt;
-&lt;/div&gt;
-</pre>
-In this example, the post/comment element is called within the context of one of the comments (which in this case belongs to a User)
+/app/View/Elements/post.mustache
 
-## Todo
-- Test suite
+	{{#Post}}
+	<h2>{{title}}</h2\>
+	<div>
+		{{text}}
+	</div>
+	{{/Post}}
+
+
+### Rendering a Mustache Template
+
+All the variable set by the controller are available, and merged with values passed into `$params`.
+
+	$params = array(
+		'title' => 'Show me the bacon!',
+		'text' => 'Bacon ipsum dolor sit amet fatback pig swine...'
+	);
+
+	$this->Mustache->render('template_name', $params)
+
+
+
+### Using Partials
+
+Partials should follow the same naming convention. Mustache will pass the variables to the partial in the context that it's called. For example, a nested template for a blog `post` with `comments` might look like:
+
+/app/View/Elements/posts/post.mustache:
+
+	{{#Post}}
+	<h2>{{title}}</h2\>
+	<div>
+		{{text}}
+	</div>
+	{{/Post}}
+	{{#Comment}}
+		{{>post/comment}}
+	{{/Comment}}
+
+/app/View/Elements/posts/comment.mustache:
+
+	<div>
+	<h3>{{#User}}{{name}}{{/User}} said: </h3>
+	<p>{{text}}</p>
+	</div>