ice 0.2.0 → 0.2.1

data/README.markdown

@@ -1,8 +1,8 @@
-# ice
+# Ice Ice Baby!
 
-This project allows user-submitted templates to be written in the javascript programming language.  It 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.  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.
 
-It 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 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:
 
     <table>
         <tr><th>Name</th><th>Email</th></tr>
@@ -13,27 +13,40 @@ It runs the templates through an erb-ish parser and then uses the [therubyracer]
         <% } %>
     </table>
 
-## Why another templating engine when there is Liquid
+These templates can be run from the appropriate views directory, provided they have a .ice extension.  Also, the templates may be compiled on demand with the method:
+
+    Ice.convert_template(template_text, vars = {})
+
+## Why another templating engine when there is Liquid?
 
 Liquid is excellent but has several disadvantages
 
 * Hard to extend without knowing Liquid internals
-* Introduces yet-another-language, whereas many designers are already familiar with javascript
-* Doesn't allow template editors to use a rich object model and create their own functions
-* Doesn't have a rich set of support libraries like javascript brings to the table.
+* Introduces yet-another-language, whereas many designers/developers are already familiar with javascript
+* Doesn't allow template creators to use a rich object model and easily create their own functions
+* Doesn't have a rich set of support libraries like what javascript brings to the table
+
+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").
 
-Note that we're still big fans of Liquid.  In fact, we call this project "ice" as a tribute (keeping the metaphor alive, we use "Cubes" where they have "Drops").
+## Installation
 
-Laminate uses the Lua language, which is a slight improvement, but still is unfamiliar to most developers.
+For Rails:
 
+    config.gem 'ice'
+
+Otherwise:
+
+    gem install ice
 
 ## to_ice
 
-Every object is revealed to the templates via its to_ice method.  This helps filter the objects that are passed into the javascript, so people editing the page only have access to a sanitized version of your data.
+Every object is revealed to the templates via its to_ice method.  This helps filter the objects that are passed into the javascript, so people editing the template only have access to a sanitized version of the data that you want them to format.
 
 Instances of some classes like String and Numeric just return themselves as the result of to_ice.  Hashes and Arrays run to_ice recursively on their members.
 
-## ActiveRecord modifications
+If you want an object to map to a different representation, simply define a to_ice object that returns whatever object you want to represent it within the javascript template.  These objects are referred to as "Cubes", and are equivalent to "Drops" for those used to the Liquid template.
+
+## ActiveRecord and to_ice
 
 To make life easy, since most complex objects passed to the templates will be subclasses of ActiveRecord::Base, the default to_ice behaviour of ActiveRecord is to pass itself in to a class with the same name, but followed by the word "Cube".
 
@@ -51,16 +64,16 @@ In order for everything to work easily, you can have your cubes inherit from our
 
 would provide a cube with access to the title, author_id and genre properties of the underlying ActiveRecord.
 
-These cubes also have belongs_to and has_many associations, so you can write things like:
+These cubes also have simple belongs_to and has_many associations, so you can write things like:
 
     class ArticleCube < Ice::BaseCube
       has_many :comments, :tags
       belongs_to :author, :section
     end
 
-This brings in association helper functions such as comment_ids, num_comments, has_comments, comments, author_id, and author.
+This generates association helper functions such as comment_ids, num_comments, has_comments, comments, author_id, and author.
 
-Note that all revealed functions and associations are also sanitized via to_ice.
+Note that the results of all associations and revealed functions are also sanitized via to_ice.
 
 ## Note on Patches/Pull Requests
 
@@ -72,11 +85,10 @@ Note that all revealed functions and associations are also sanitized via to_ice.
 
 ## Todo
 
-* Allow .ice view files
-* Add in form builders from clots project
+* Add in form builders (from clots project)
 * Break form builders and helpers out into separate javascript project that can be included in other frameworks like CakePHP
 * Allow mappings for other ORMs than ActiveRecord
-* Haml support
+* Haml support (really just deciding what extension those files would use :))
 
 ## Copyright
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/ice.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ice}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nate Kidwell"]

data/lib/ice/base_cube.rb

@@ -1,5 +1,6 @@
 module Ice
   class BaseCube
+    extend Ice::CubeAssociation 
 
     def self.revealing(* attributes)
       attributes.each do |attr|

data/lib/ice/cubeable.rb

@@ -3,6 +3,7 @@ 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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Nate Kidwell