ice 0.2.2 → 0.2.3

data/README.markdown

@@ -1,8 +1,10 @@
 # Ice Ice Baby!
 
-The Ice project allows user-created templates to be written in the javascript programming language.  They are then interpreted in a sandboxed environment.  Ice is similar to Liquid in terms of safety, but uses javascript to leverage the powers of a language most developers are familiar with.
+The Ice project allows user-created templates to be written in the javascript programming language.  Thanks to the [therubyracer](http://github.com/cowboyd/therubyracer) they are then interpreted using Google's V8 javascript engine.
 
-Ice runs the templates through an erb-ish parser and then uses the [therubyracer](http://github.com/cowboyd/therubyracer) to interpet the javascript using Google's V8 javascript engine.  Your users can then write Ice templates like:
+Ice is similar to Liquid in terms of safety, but uses javascript to leverage the powers of a language most developers are familiar with.  Ice runs the templates through an erb-ish parser (written by [Mark Turansky](http://blog.markturansky.com/BetterJavascriptTemplates.html)). 
+
+Your users can then write Ice templates like:
 
     <table>
         <tr><th>Name</th><th>Email</th></tr>
@@ -19,7 +21,7 @@ These templates can be run from the appropriate views directory, provided they h
 
 ## Why another templating engine when there is Liquid?
 
-Liquid is excellent but has several disadvantages
+[Liquid](http://github.com/tobi/liquid) is excellent but it showing its age in a few ways:
 
 * Hard to extend without knowing Liquid internals
 * Introduces yet-another-language, whereas many designers/developers are already familiar with javascript
@@ -28,6 +30,8 @@ Liquid is excellent but has several disadvantages
 
 Note that we're still big fans of Liquid.  In fact, we call this project "Ice" as a tribute (extending the metaphor, we use "Cubes" where they have "Drops").
 
+In addition, our ice_view.rb file is almost directly ripped out of the liquid project.
+
 ## Installation
 
 For Rails:
@@ -79,6 +83,79 @@ This generates association helper functions such as comment_ids, num_comments, h
 
 Note that the results of all associations and revealed functions are also sanitized via to_ice.
 
+## NavBar
+
+To make it easier to generate links, we added a NavBar class to the javascript helpers.  THis class has an open and close method, as well as a link_to mehod which either takes a url, or a url and a link label.
+
+    <% var nav = new NavBar() %>
+    <%= nav.open() %>
+    <%= nav.link_to("Bar", "/foo") %>
+    <%= nav.link_to("http://ludicast.com") %>
+    <%= nav.close() %>
+
+This then generates the following html
+
+    <ul class="linkBar">
+        <li><a href="/foo">Bar</a></li>
+        <li><a href="http://ludicast.com">http://ludicast.com</a></li>
+    </ul>
+
+You'll notice that the resulting html code is shorter than the generator code, making this look inefficient.  However the NavBar also takes options so if the NavBar above was instantiated with:
+
+    <% var nav = new NavBar({nav_open:"<div>", nav_close:"</div>",link_wrapper:function(link){
+      return "<span>" + link + "</span>"
+
+it would automatically generate
+
+    <div>
+        <span><a href="/foo">Bar</a></span>
+        <span><a href="http://ludicast.com">http://ludicast.com</a></span>
+    </div>
+
+Also, if you want to make a site- or page-wide change, all you need to do is add these options to the NavBar class like
+
+    NavBar.default_options = {nav_open:"<div>", nav_close:"</div>",link_wrapper:function(link){
+        return "<span>" + link + "</span>"
+    }}
+
+Then all links will generate with these options, unless overridden in the NavBar's constructor.  If the NavBar has a separator property added, it will add that separator between links.  If a link is not shown (due to access restrictions or whatever in the link_wrapper function) the separator obviously will not appear for that link.  So the code
+
+    bar.separator = "---"
+    bar.link_wrapper = function (link) {
+        if (link.match(/aa/)) {
+            return ""
+        } else {
+            return link
+        }
+    }
+
+would cause 
+
+    bar.open() + bar.link_to("ff") + bar.link_to("aa") + bar.link_to("gg") + bar.close()
+
+to render as:
+
+    links.should.eql "<div><a href=\"ff\">ff</a>----<a href=\"gg\">gg</a></div>"
+
+## Routes
+
+Keeping with our tradition of stealing from other projects, we took the code from [RouteJs middleware](http://coderack.org/users/kossnocorp/middlewares/88-routesjs) to expose to our templates all your routes.  This is a big convenience and lets you put in your templates things like:
+
+    <% var nav = new NavBar() %>
+    <%= nav.open() %>
+    <%= nav.link_to("List Pizzas", pizzas_path() ) %>
+    <%= nav.link_to("Modify Pizza", edit_pizza_path({id: pizza.id})) %>
+    <%= nav.close() %>
+
+which is converted into
+
+    <ul class="linkBar">
+        <li><a href="/pizzas">List Pizzas</a></li>
+        <li><a href="/pizzas/2/edit">Modify Pizza</a></li>
+    </ul>
+
+Note that some people might claim that it is insecure to expose your resources like this, but that probably should be dealt with on a case-by-case basis.
+
 ## Note on Patches/Pull Requests
 
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/ice.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ice}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nate Kidwell"]
-  s.date = %q{2010-06-04}
+  s.date = %q{2010-06-09}
   s.description = %q{User templates written in javascript}
   s.email = %q{nate@ludicast.com}
   s.extra_rdoc_files = [
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
      "ice_js/spec/rhino.js",
      "ice_js/spec/server.html",
      "ice_js/spec/server.rb",
+     "ice_js/spec/support/js.jar",
      "ice_js/spec/unit/spec.helper.js",
      "ice_js/spec/unit/spec.js",
      "init.rb",

data/ice_js/lib/path_helper.js

@@ -1,24 +1,49 @@
-function link_to(location, default_label, opts) {
-  if (! default_label) {
-    default_label = location
+function link_to(label, link, opts) {
+  if (! link) {
+    link = label
   }
-  label = (opts && opts.label) || default_label
-  return "<a href=\"" + location + "\">" + label + "</a>"
+  return "<a href=\"" + link + "\">" + label + "</a>"
 }
 
-var NavBar = function () {
+var NavBar = function (options) {
+    var defaults = NavBar.default_options
+    for (var default_option in defaults) {
+        if (defaults.hasOwnProperty(default_option)) {
+            this[default_option] = defaults[default_option]
+        }
+    }
 
+    for (var option in options) {
+        if (options.hasOwnProperty(option)) {
+            this[option] = options[option]
+        }
+    }
 }
 
-NavBar.prototype.link_to = function (link) {
-  return "<li>" + link_to(link) + "</li>"
+NavBar.prototype.link_to = function (label, link) {
+    link_code = link_to(label, link)
+
+    if (this.link_wrapper) {
+        link_data =  this.link_wrapper(link_code)
+    } else {
+        link_data = "<li>" + link_code + "</li>"
+    }
+    if (link_data) {
+      if (this.link_data && this.separator) {
+        link_data = this.separator + link_data
+      }
+      this.link_data = link_data
+    }
+    return link_data;
 }
 
+
 NavBar.prototype.open = function () {
-    return "<ul class=\"linkBar\">"
+    return this.nav_open || "<ul class=\"linkBar\">"
 }
 
 NavBar.prototype.close = function () {
-    return "</ul>"
+    return this.nav_close || "</ul>"
 }
 
+NavBar.default_options = {}

data/ice_js/spec/unit/spec.js

@@ -1,17 +1,100 @@
-describe "nav bar helper"
-  before_each
-    bar = new NavBar()
+describe "NavBar"
+
+  describe "by default"
+    before_each
+      bar = new NavBar()
+    end
+
+
+    it "should generate list by default"
+      (bar.open() + bar.close()).should.eql "<ul class=\"linkBar\"></ul>"
+    end
+
+    it "should generate list with internal links"
+
+      links = (bar.open() + bar.link_to("ff") + bar.link_to("aa") + bar.close())
+
+      links.should.eql "<ul class=\"linkBar\"><li><a href=\"ff\">ff</a></li><li><a href=\"aa\">aa</a></li></ul>"
+    end
+
+    it "should take optional titles"
+
+      links = (bar.open() + bar.link_to("ff", "aa") + bar.close())
+
+      links.should.eql "<ul class=\"linkBar\"><li><a href=\"aa\">ff</a></li></ul>"
+    end
+
   end
 
+  describe "with options"
+    before_each
+      bar = new NavBar( {nav_open:"<div>", nav_close:"</div>",link_wrapper:function(link){
+        return "<span>" + link + "</span>"
+      }} )
+    end
+
+    it "should generate list with wrappers"
+      links = (bar.open() + bar.link_to("ff") + bar.close())
+
+      links.should.eql "<div><span><a href=\"ff\">ff</a></span></div>"
+    end
 
-  it "should generate list by default"
-    (bar.open() + bar.close()).should.eql "<ul class=\"linkBar\"></ul>"
   end
 
-  it "should generate list with internal links"
+  describe "with separator"
+    before_each
+      separator = " --- "
+      bar = new NavBar({separator: separator})
+    end
+
+    it "should not separate single links"
+      links = (bar.open() + bar.link_to("ff") + bar.close())
+      links.should.eql "<ul class=\"linkBar\"><li><a href=\"ff\">ff</a></li></ul>"
+    end
 
-    links = (bar.open() + bar.link_to("ff") + bar.link_to("aa") + bar.close())
+    it "should separate multiple links"
+      links = (bar.open() + bar.link_to("ff") + bar.link_to("aa") + bar.close())
+      links.should.eql "<ul class=\"linkBar\"><li><a href=\"ff\">ff</a></li>" + separator + "<li><a href=\"aa\">aa</a></li></ul>"
+    end
+
+    it "should not display for missing links"
+      bar.nav_open = "<div>"
+      bar.nav_close = "</div>"
+      bar.link_wrapper = function (link) {
+          if (link.match(/aa/)) {
+            return ""
+          } else {
+            return link
+          }
+      }
+
+      links = (bar.open() + bar.link_to("ff") + bar.link_to("aa") + bar.link_to("gg") + bar.close())
+      links.should.eql "<div><a href=\"ff\">ff</a>" + separator + "<a href=\"gg\">gg</a></div>"
+
+    end
+  end
+
+
+  describe "with class-wide options"
+    before_each
+      NavBar.default_options = {nav_open:"<div>", nav_close:"</div>",link_wrapper:function(link){
+        return "<span>" + link + "</span>"
+      }}
+      bar = new NavBar( )
+    end
+
+    it "should generate list with wrappers"
+      links = (bar.open() + bar.link_to("ff") + bar.close())
+
+      links.should.eql "<div><span><a href=\"ff\">ff</a></span></div>"
+    end
+
+    after_each
+      NavBar.default_options = {}
+    end
 
-    links.should.eql "<ul class=\"linkBar\"><li><a href=\"ff\">ff</a></li><li><a href=\"aa\">aa</a></li></ul>"
   end
-end
+
+
+end
+

data/init.rb

@@ -1,4 +1,6 @@
 require 'ice'
 require 'ice/cubeable'
 require 'ice/cube_association'
-require 'ice/base_cube'
+require 'ice/base_cube'
+
+require 'active_support'

data/lib/extras/ice_view.rb

@@ -44,12 +44,9 @@ class IceView
     assigns.merge!(local_assigns.stringify_keys)
 
     route_functions = "<% "  + get_routes + " %>"
-    puts route_functions
-    5.times {puts "****************************"}
 
     path_helper_code = File.read(File.dirname(__FILE__) + "/../../ice_js/lib/path_helper.js")
     path_helper = "<% " + path_helper_code + " %>"
-    puts path_helper
     source = route_functions + path_helper + source
 
     

data/lib/ice/cubeable.rb

@@ -3,7 +3,6 @@ module Ice
       def get_cube_class(class_obj)
         begin
           cube_string = class_obj.to_s + "Cube"
-          puts "getting string #{cube_string}"
           cube_string.constantize
         rescue
           get_cube_class class_obj.superclass

data/lib/parser.js

@@ -256,19 +256,6 @@ var Jst = function () {
         return fragment.toString();
     }
 
-    function safeWrite(s) {
-        s = s.toString();
-        s = s.replaceAll('&', '&');
-        s = s.replaceAll('"', '"');
-        s = s.replaceAll('<', '&lt;');
-        s = s.replaceAll('>', '&gt;');
-        html += s;
-    }
-
-    function safeWriteln(s) {
-        safeWrite(s + "\n");
-    }
-
     function write(s) {
         html += s;
     }
@@ -292,14 +279,8 @@ var Jst = function () {
                     c = stack.pop();
                     if (stack.peek() == '%') { //delimiter!
                         c = stack.pop();
-                        if (stack.peek() == "=") {
-                            // expression, escape all html
-                            stack.pop();
-                            fragment = parseExpression(stack);
-                            appendExpressionFragment(writer, fragment,
-                                "safeWrite");
-                        } else if (stack.peek() == "+") {
-                            // expression, don't escape html
+                        if (stack.peek() == "=" || stack.peek() == "+") {
+                            //not escaping html right now
                             stack.pop()
                             fragment = parseExpression(stack);
                             appendExpressionFragment(writer, fragment,

data/spec/cube_spec.rb

@@ -58,7 +58,6 @@ class BaseCubeWithHasMany
   def initialize
     @source = ChildModel.new
   end
-
   has_many :tags
   has_many :children
 end

data/spec/ice_spec.rb

@@ -2,8 +2,6 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Ice" do
 
-
-  
   it "converts a javascript template to html" do
     Ice.convert_template("<%= 'hello world' %>").should == "hello world"
   end
@@ -13,6 +11,11 @@ describe "Ice" do
     Ice.convert_template("<%= hola + ' ' + mundo %>", vars).should == "hello world"
   end
 
+  it "accepts ampersands" do
+    vars = {:foo => "&"}
+    Ice.convert_template("<%= foo %>", vars).should == "&"
+  end
+
   it "takes variables as string" do
     vars = {'hola' => "hello", 'mundo' => "world" }
     Ice.convert_template("<%= hola + ' ' + mundo %>", vars).should == "hello world"

data/spec/spec_helper.rb

@@ -4,7 +4,6 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require File.dirname(__FILE__) + "/../init"
 require 'spec'
 require 'spec/autorun'
-require 'active_support'
 
 
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Nate Kidwell
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-04 00:00:00 -04:00
+date: 2010-06-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -85,6 +85,7 @@ files:
 - ice_js/spec/rhino.js
 - ice_js/spec/server.html
 - ice_js/spec/server.rb
+- ice_js/spec/support/js.jar
 - ice_js/spec/unit/spec.helper.js
 - ice_js/spec/unit/spec.js
 - init.rb