poirot 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    poirot (0.0.2)
+      mustache
+      rails (> 3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.9)
+      actionpack (= 3.0.9)
+      mail (~> 2.2.19)
+    actionpack (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+    activesupport (3.0.9)
+    arel (2.0.10)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mustache (0.99.4)
+    polyglot (0.3.1)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.9)
+      actionmailer (= 3.0.9)
+      actionpack (= 3.0.9)
+      activerecord (= 3.0.9)
+      activeresource (= 3.0.9)
+      activesupport (= 3.0.9)
+      bundler (~> 1.0)
+      railties (= 3.0.9)
+    railties (3.0.9)
+      actionpack (= 3.0.9)
+      activesupport (= 3.0.9)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2)
+    rdoc (3.8)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mustache
+  poirot!
+  rails (>= 3.0.0)

data/Readme.markdown

@@ -44,6 +44,24 @@ type will be set as `text/mustache` and the id will be `post-list-template`.
       <!-- template will be here! -->
     </script>
 
+### Javascript Helper
+
+Poirot also adds a javascript helper for using mustache templates from the browser.  In Rails 3.1 this will be automatically added to the asset pipeline.
+
+If you are using rails 3 then you can run the `rails g poirot:install` to install the javascripts in your application.
+
+Using the poirot javascript helper is simple, given a template added to the page using `template_include_tag`
+
+    <%= template_include_tag 'post_list' %>
+
+You can render this template from javascript by doing the following
+
+    poirot.postList()
+
+This will return the contents of the `post_list` template wrapped in a jQuery object, ready for inserting into the dom.  If you have data to pass to the template then you can pass it as the argument to the function, e.g.
+
+    poirot.postList({foo: "bar"})
+
 ## Dependencies
 
 *  Rails >3.0.0

data/lib/generators/poirot/install/install_generator.rb

@@ -0,0 +1,21 @@
+require 'rails'
+
+module Poirot
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      desc "This generator installs Poirot JavaScript helper"
+      source_root File.expand_path('../../../../../vendor/assets/javascripts/poirot', __FILE__)
+
+      def copy_mustache
+        say_status("copying", "Mustache.js", :green)
+        copy_file "mustache.js", "public/javascripts/mustache.js"
+      end
+
+      def copy_poirot
+        say_status("copying", "poirot.js", :green)
+        copy_file "poirot.js", "public/javascripts/poirot.js"
+      end
+    end
+  end
+end if ::Rails.version < "3.1"

data/lib/poirot/asset_helper.rb

@@ -2,10 +2,21 @@ module Poirot
   module AssetHelper
     def template_include_tag(*sources)
       sources.collect do |source|
-        template_path = Rails.root.join('app/views', controller_name, "_#{source}.html.mustache")
-        template = File.open(template_path, "rb")
-        content_tag :script, template.read.html_safe, :type => "text/mustache", :id => "#{source.dasherize}-template"
+        template = File.open(_poirot_resolve_partial_path(source), "rb")
+        content_tag :script, template.read.html_safe, :type => "text/mustache", :id => "#{source.parameterize.dasherize}-template"
       end.join("\n").html_safe
     end
+    
+    def _poirot_resolve_partial_path(source)
+      if source.to_s =~ /^\// # absolute path to a different view folder
+        segments = source.to_s.split('/')
+        partial_name = "_#{segments.pop}.html.mustache"
+        segments << partial_name
+        Rails.root.join('app/views', *segments)
+      else
+        Rails.root.join('app/views', controller_name, "_#{source}.html.mustache")
+      end
+    end
+    
   end
 end

data/lib/poirot/handler.rb

@@ -1,10 +1,6 @@
 module Poirot
-  class Handler < ActionView::Template::Handler
-    include ActionView::Template::Handlers::Compilable
-
-    self.default_format = :mustache
-
-    def compile(template)
+  class Handler
+    def self.call(template)
       view_path = "#{template.virtual_path}_view"
       abs_view_path = Rails.root.join('app/views', view_path)
       view_class = begin
@@ -15,4 +11,4 @@ module Poirot
       "#{view_class}.new(self, '#{template.source.gsub(/'/, "\\\\'")}').render.html_safe"
     end
   end
-end
+end

data/lib/poirot/version.rb

@@ -1,3 +1,3 @@
 module Poirot
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/poirot/view.rb

@@ -36,11 +36,13 @@ module Poirot
         self[name.tr('@','').to_sym] = instance_var
       end
 
-      @renderer.instance_variable_get("@locals").each do |name, val|
+      # get the locals from the view context, is there a better way?
+      locals = view_context.send(:view_renderer).send(:_partial_renderer).instance_variable_get("@locals") || {}
+
+      locals.each do |name, val|
         instance_variable_set("@#{name}", val)
         self[name] = val
       end
-
     end
   end
 end

data/lib/poirot.rb

@@ -1,3 +1,4 @@
+require 'mustache'
 require 'poirot/handler'
 require 'poirot/view'
 require 'poirot/asset_helper'
@@ -6,11 +7,10 @@ ActionView::Template.register_template_handler(:mustache, Poirot::Handler)
 ActionView::Base.send :include, Poirot::AssetHelper
 
 module Poirot
+  class Engine < Rails::Engine ; end if Rails.version >= "3.1"
   class Railtie < Rails::Railtie
-
     config.before_configuration do |app|
       app.config.autoload_paths += %W(#{app.config.root}/app/views)
     end
-
   end
 end

data/vendor/assets/javascripts/poirot/index.js

@@ -0,0 +1,2 @@
+//= require ./mustache
+//= require ./poirot

data/vendor/assets/javascripts/poirot/mustache.js

@@ -0,0 +1,325 @@
+/*
+  mustache.js — Logic-less templates in JavaScript
+
+  See http://mustache.github.com/ for more info.
+*/
+
+var Mustache = function() {
+  var Renderer = function() {};
+
+  Renderer.prototype = {
+    otag: "{{",
+    ctag: "}}",
+    pragmas: {},
+    buffer: [],
+    pragmas_implemented: {
+      "IMPLICIT-ITERATOR": true
+    },
+    context: {},
+
+    render: function(template, context, partials, in_recursion) {
+      // reset buffer & set context
+      if(!in_recursion) {
+        this.context = context;
+        this.buffer = []; // TODO: make this non-lazy
+      }
+
+      // fail fast
+      if(!this.includes("", template)) {
+        if(in_recursion) {
+          return template;
+        } else {
+          this.send(template);
+          return;
+        }
+      }
+
+      template = this.render_pragmas(template);
+      var html = this.render_section(template, context, partials);
+      if(in_recursion) {
+        return this.render_tags(html, context, partials, in_recursion);
+      }
+
+      this.render_tags(html, context, partials, in_recursion);
+    },
+
+    /*
+      Sends parsed lines
+    */
+    send: function(line) {
+      if(line !== "") {
+        this.buffer.push(line);
+      }
+    },
+
+    /*
+      Looks for %PRAGMAS
+    */
+    render_pragmas: function(template) {
+      // no pragmas
+      if(!this.includes("%", template)) {
+        return template;
+      }
+
+      var that = this;
+      var regex = new RegExp(this.otag + "%([\\w-]+) ?([\\w]+=[\\w]+)?" +
+            this.ctag, "g");
+      return template.replace(regex, function(match, pragma, options) {
+        if(!that.pragmas_implemented[pragma]) {
+          throw({message: 
+            "This implementation of mustache doesn't understand the '" +
+            pragma + "' pragma"});
+        }
+        that.pragmas[pragma] = {};
+        if(options) {
+          var opts = options.split("=");
+          that.pragmas[pragma][opts[0]] = opts[1];
+        }
+        return "";
+        // ignore unknown pragmas silently
+      });
+    },
+
+    /*
+      Tries to find a partial in the curent scope and render it
+    */
+    render_partial: function(name, context, partials) {
+      name = this.trim(name);
+      if(!partials || partials[name] === undefined) {
+        throw({message: "unknown_partial '" + name + "'"});
+      }
+      if(typeof(context[name]) != "object") {
+        return this.render(partials[name], context, partials, true);
+      }
+      return this.render(partials[name], context[name], partials, true);
+    },
+
+    /*
+      Renders inverted (^) and normal (#) sections
+    */
+    render_section: function(template, context, partials) {
+      if(!this.includes("#", template) && !this.includes("^", template)) {
+        return template;
+      }
+
+      var that = this;
+      // CSW - Added "+?" so it finds the tighest bound, not the widest
+      var regex = new RegExp(this.otag + "(\\^|\\#)\\s*(.+)\\s*" + this.ctag +
+              "\n*([\\s\\S]+?)" + this.otag + "\\/\\s*\\2\\s*" + this.ctag +
+              "\\s*", "mg");
+
+      // for each {{#foo}}{{/foo}} section do...
+      return template.replace(regex, function(match, type, name, content) {
+        var value = that.find(name, context);
+        if(type == "^") { // inverted section
+          if(!value || that.is_array(value) && value.length === 0) {
+            // false or empty list, render it
+            return that.render(content, context, partials, true);
+          } else {
+            return "";
+          }
+        } else if(type == "#") { // normal section
+          if(that.is_array(value)) { // Enumerable, Let's loop!
+            return that.map(value, function(row) {
+              return that.render(content, that.create_context(row),
+                partials, true);
+            }).join("");
+          } else if(that.is_object(value)) { // Object, Use it as subcontext!
+            return that.render(content, that.create_context(value),
+              partials, true);
+          } else if(typeof value === "function") {
+            // higher order section
+            return value.call(context, content, function(text) {
+              return that.render(text, context, partials, true);
+            });
+          } else if(value) { // boolean section
+            return that.render(content, context, partials, true);
+          } else {
+            return "";
+          }
+        }
+      });
+    },
+
+    /*
+      Replace {{foo}} and friends with values from our view
+    */
+    render_tags: function(template, context, partials, in_recursion) {
+      // tit for tat
+      var that = this;
+
+      var new_regex = function() {
+        return new RegExp(that.otag + "(=|!|>|\\{|%)?([^\\/#\\^]+?)\\1?" +
+          that.ctag + "+", "g");
+      };
+
+      var regex = new_regex();
+      var tag_replace_callback = function(match, operator, name) {
+        switch(operator) {
+        case "!": // ignore comments
+          return "";
+        case "=": // set new delimiters, rebuild the replace regexp
+          that.set_delimiters(name);
+          regex = new_regex();
+          return "";
+        case ">": // render partial
+          return that.render_partial(name, context, partials);
+        case "{": // the triple mustache is unescaped
+          return that.find(name, context);
+        default: // escape the value
+          return that.escape(that.find(name, context));
+        }
+      };
+      var lines = template.split("\n");
+      for(var i = 0; i < lines.length; i++) {
+        lines[i] = lines[i].replace(regex, tag_replace_callback, this);
+        if(!in_recursion) {
+          this.send(lines[i]);
+        }
+      }
+
+      if(in_recursion) {
+        return lines.join("\n");
+      }
+    },
+
+    set_delimiters: function(delimiters) {
+      var dels = delimiters.split(" ");
+      this.otag = this.escape_regex(dels[0]);
+      this.ctag = this.escape_regex(dels[1]);
+    },
+
+    escape_regex: function(text) {
+      // thank you Simon Willison
+      if(!arguments.callee.sRE) {
+        var specials = [
+          '/', '.', '*', '+', '?', '|',
+          '(', ')', '[', ']', '{', '}', '\\'
+        ];
+        arguments.callee.sRE = new RegExp(
+          '(\\' + specials.join('|\\') + ')', 'g'
+        );
+      }
+      return text.replace(arguments.callee.sRE, '\\$1');
+    },
+
+    /*
+      find `name` in current `context`. That is find me a value
+      from the view object
+    */
+    find: function(name, context) {
+      name = this.trim(name);
+
+      // Checks whether a value is thruthy or false or 0
+      function is_kinda_truthy(bool) {
+        return bool === false || bool === 0 || bool;
+      }
+
+      var value;
+      if(is_kinda_truthy(context[name])) {
+        value = context[name];
+      } else if(is_kinda_truthy(this.context[name])) {
+        value = this.context[name];
+      }
+
+      if(typeof value === "function") {
+        return value.apply(context);
+      }
+      if(value !== undefined) {
+        return value;
+      }
+      // silently ignore unkown variables
+      return "";
+    },
+
+    // Utility methods
+
+    /* includes tag */
+    includes: function(needle, haystack) {
+      return haystack.indexOf(this.otag + needle) != -1;
+    },
+
+    /*
+      Does away with nasty characters
+    */
+    escape: function(s) {
+      s = String(s === null ? "" : s);
+      return s.replace(/&(?!\w+;)|["'<>\\]/g, function(s) {
+        switch(s) {
+        case "&": return "&amp;";
+        case "\\": return "\\\\";
+        case '"': return '&quot;';
+        case "'": return '&#39;';
+        case "<": return "&lt;";
+        case ">": return "&gt;";
+        default: return s;
+        }
+      });
+    },
+
+    // by @langalex, support for arrays of strings
+    create_context: function(_context) {
+      if(this.is_object(_context)) {
+        return _context;
+      } else {
+        var iterator = ".";
+        if(this.pragmas["IMPLICIT-ITERATOR"]) {
+          iterator = this.pragmas["IMPLICIT-ITERATOR"].iterator;
+        }
+        var ctx = {};
+        ctx[iterator] = _context;
+        return ctx;
+      }
+    },
+
+    is_object: function(a) {
+      return a && typeof a == "object";
+    },
+
+    is_array: function(a) {
+      return Object.prototype.toString.call(a) === '[object Array]';
+    },
+
+    /*
+      Gets rid of leading and trailing whitespace
+    */
+    trim: function(s) {
+      return s.replace(/^\s*|\s*$/g, "");
+    },
+
+    /*
+      Why, why, why? Because IE. Cry, cry cry.
+    */
+    map: function(array, fn) {
+      if (typeof array.map == "function") {
+        return array.map(fn);
+      } else {
+        var r = [];
+        var l = array.length;
+        for(var i = 0; i < l; i++) {
+          r.push(fn(array[i]));
+        }
+        return r;
+      }
+    }
+  };
+
+  return({
+    name: "mustache.js",
+    version: "0.3.1-dev",
+
+    /*
+      Turns a template and view into HTML
+    */
+    to_html: function(template, view, partials, send_fun) {
+      var renderer = new Renderer();
+      if(send_fun) {
+        renderer.send = send_fun;
+      }
+      renderer.render(template, view, partials);
+      if(!send_fun) {
+        return renderer.buffer.join("\n");
+      }
+    }
+  });
+}();

data/vendor/assets/javascripts/poirot/poirot.js

@@ -0,0 +1,23 @@
+var poirot = (function ($) {
+
+  var poirot = {
+    partials: {}
+  }
+
+  $(document).ready(function () {
+    $('script[type="text/mustache"]').each(function () {
+      var template = $(this).text()
+      var methodName = this.id.replace(/-([a-z])/g, function (str) {
+        return str.replace("-", "").toUpperCase()
+      }).replace("Template", "")
+
+      poirot.partials[methodName] = template
+
+      poirot[methodName] = function (presenter) {
+        return $(Mustache.to_html(template, presenter, poirot.partials))
+      }
+    })
+  })
+
+  return poirot
+})(jQuery)

metadata

@@ -1,8 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: poirot
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.2
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Oliver Nightingale
@@ -11,17 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-06 00:00:00 +01:00
+date: 2011-08-15 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">"
       - !ruby/object:Gem::Version 
+        segments: 
+        - 3
         version: "3"
   type: :runtime
   version_requirements: *id001
@@ -29,10 +34,11 @@ dependencies:
   name: mustache
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -48,14 +54,19 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - Rakefile
 - Readme.markdown
+- lib/generators/poirot/install/install_generator.rb
 - lib/poirot.rb
 - lib/poirot/asset_helper.rb
 - lib/poirot/handler.rb
 - lib/poirot/version.rb
 - lib/poirot/view.rb
 - poirot.gemspec
+- vendor/assets/javascripts/poirot/index.js
+- vendor/assets/javascripts/poirot/mustache.js
+- vendor/assets/javascripts/poirot/poirot.js
 has_rdoc: true
 homepage: http://rubygems.org/gems/poirot
 licenses: []
@@ -66,21 +77,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: poirot
-rubygems_version: 1.6.2
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: mustaches