haml_coffee_assets 1.9.1 → 1.10.0

data/README.md

@@ -1,8 +1,6 @@
 # Haml Coffee Assets [![Build Status](https://secure.travis-ci.org/netzpirat/haml_coffee_assets.png)](http://travis-ci.org/netzpirat/haml_coffee_assets)
 
-Haml Coffee Assets compiles [Haml Coffee](https://github.com/netzpirat/haml-coffee) templates in the Rails 3.1
-asset pipeline, so you can use them as JavaScript templates in your JavaScript heavy Rails application. It also works as
-a pure [Sprockets](https://github.com/sstephenson/sprockets) engine without Rails.
+Haml Coffee Assets compiles [Haml Coffee](https://github.com/netzpirat/haml-coffee) templates in the Rails 3.1 asset pipeline, so you can use them as JavaScript templates in your JavaScript heavy Rails application. Server-side rendering of templates is also possible, allowing you to share the same template files for Rails and JavaScript templates. It also works as a pure [Sprockets](https://github.com/sstephenson/sprockets) engine without Rails.
 
 Tested on MRI Ruby 1.8.7, 1.9.2, 1.9.3, REE and the latest version of JRuby.
 
@@ -12,6 +10,7 @@ Tested on MRI Ruby 1.8.7, 1.9.2, 1.9.3, REE and the latest version of JRuby.
 standalone Sprockets engine.
 * Manifold options to configure Haml Coffee Assets to your needs.
 * AMD support.
+* Server-side rendering of templates in Rails.
 
 ## Haml Coffee
 
@@ -107,6 +106,36 @@ all templates from your `app/assets/javascripts/application.js.coffee`:
 If you would place your templates into `app/assets/javascripts/templates`, then all your JST template names would begin
 with `templates/`, which may be not what you want.
 
+### Server-side rendering in Rails
+
+Haml Coffee Assets registers the `.hamlc` extension with Action View, so that Rails templates can be written in Haml Coffee. Rails will see templates placed in `app/assets/javascripts/templates` (though this path can be changed if you store your templates in another directory), and the same template files can be rendered via Rails or via JavaScript on the client.
+
+Given a Haml Coffee template at `app/assets/javascripts/templates/books/_book.hamlc`:
+
+```haml
+%dl
+  %dt Name
+  %dd= @name
+  %dt Author
+  %dd= @author
+```
+
+Rendering `books#index`:
+
+```haml
+= render "book", :name => "A Tale of Two Cities", :author => "Charles Dickens"
+```
+
+Require and render the same file on the client using the asset pipeline:
+
+```coffeescript
+#= require templates/books/_book
+
+JST["books/book"](name: "A Tale of Two Cities", author: "Charles Dickens")
+```
+
+Note that the template is required as `books/_book` because it refers to the actual file, but the template name on the client is simply `books/book`. If you require all templates at once with `#= require_tree ./templates`, you won't need to remember this distinction.
+
 ## Configuration
 
 _Please note that all configuration examples will use the paths of the Haml Coffee template generation and not the
@@ -425,6 +454,14 @@ You can see the [default implementation](https://github.com/netzpirat/haml_coffe
 and the [Haml Coffee documentation](https://github.com/netzpirat/haml-coffee#custom-helper-function-options)
 for more information about each helper function.
 
+### Shared template path
+
+Rails will look for templates in `app/assets/javascripts/templates` when rendering on the server side. If you store your templates in another directory, you can change this location:
+
+```ruby
+config.hamlcoffee.shared_template_path = "custom/template/path"
+```
+
 ## Partial rendering
 
 With Haml Coffee Assets you can render partials when using plain JST approach and also with AMD support.

data/lib/haml_coffee_assets/action_view/template_handler.rb

@@ -0,0 +1,114 @@
+module HamlCoffeeAssets
+  module ActionView
+    class TemplateHandler
+      DEPENDENCY_PATTERN = /(?:window\.)?JST(?:\[["']([\w\/]+)["']\]|\.(\w+))/
+
+      def self.call(template)
+        new(template).render
+      end
+
+      def initialize(template, partial = false, dependencies = [])
+        @template     = template
+        @partial      = partial
+        @dependencies = dependencies
+      end
+
+      def render
+        "ExecJS.compile(#{ compilation_string }).eval(#{ evaluation_string }).html_safe"
+      end
+
+      protected
+
+      def compilation_string
+        string = ''
+
+        unless @partial
+          string << preamble
+          string << helpers
+        end
+
+        string << compiled_template
+
+        if @partial
+          string
+        else
+          string.inspect
+        end
+      end
+
+      private
+
+      def evaluation_string
+        string = "JST['#{ logical_path }'](\#{local_assigns.to_json})"
+        string.inspect.sub(/\\#/, '#')
+      end
+
+      def preamble
+        "var window = { JST: {} }, JST = window.JST;\n"
+      end
+
+      def helpers
+        ::HamlCoffeeAssets.helpers
+      end
+
+      def compiled_template
+        compiled = ::HamlCoffeeAssets::Compiler.compile(
+          logical_path,
+          @template.source
+        )
+
+        include_dependencies(compiled)
+      end
+
+      def include_dependencies(compiled)
+        compiled.dup.scan(DEPENDENCY_PATTERN) do |match|
+          match.compact!
+
+          path = match[0]
+
+          if path == logical_path || @dependencies.include?(path)
+            next
+          else
+            @dependencies << path
+          end
+
+          partial = ::ActionView::Template.new(
+            partial_source(path),
+            path,
+            self.class,
+            :virtual_path => partial_path(path)
+          )
+
+          compiled << self.class.new(
+            partial,
+            true,
+            @dependencies
+          ).compilation_string
+        end
+
+        compiled
+      end
+
+      def logical_path
+        return @logical_path if defined?(@logical_path)
+
+        path = @template.virtual_path.split('/')
+        path.last.sub!(/^_/, '')
+        @logical_path = path.join('/')
+      end
+
+      def partial_source(path)
+        ::Rails.root.join(
+          ::HamlCoffeeAssets.config.shared_template_path,
+          partial_path(path) + '.hamlc'
+        ).read
+      end
+
+      def partial_path(path)
+        parts     = path.split('/')
+        parts[-1] = "_#{ parts[-1] }"
+        parts.join('/')
+      end
+    end
+  end
+end

data/lib/haml_coffee_assets/configuration.rb

@@ -38,7 +38,12 @@ module HamlCoffeeAssets
       self.selfCloseTags          = 'meta,img,link,br,hr,input,area,param,col,base'
       self.context                = 'window.HAML.context'
       self.extendScope            = false
-      self.name_filter            = lambda { |n| n.sub /^templates\//, '' }
+      self.shared_template_path   = 'app/assets/javascripts/templates'
+      self.name_filter            = lambda { |n|
+        parts = n.sub(/^templates\//, '').split('/')
+        parts.last.sub!(/^_/, '')
+        parts.join('/')
+      }
     end
 
     # Template namespace
@@ -131,6 +136,10 @@ module HamlCoffeeAssets
     #
     attr_accessor :name_filter
 
+    # Path to templates shared by Rails and JS.
+    #
+    attr_accessor :shared_template_path
+
   end
 
 end

data/lib/haml_coffee_assets/rails/engine.rb

@@ -10,12 +10,24 @@ module HamlCoffeeAssets
 
       config.hamlcoffee = ::HamlCoffeeAssets.config
 
+      # Add shared template path to ActionView's load path
+      config.before_configuration do |app|
+        app.paths['app/views'] << config.hamlcoffee.shared_template_path
+      end
+
       # Initialize Haml Coffee Assets after Sprockets
       #
       initializer 'sprockets.hamlcoffeeassets', :group => :all, :after => 'sprockets.environment' do |app|
+        require 'haml_coffee_assets/action_view/template_handler'
+
+        # Register Tilt template (for ActionView)
+        ActiveSupport.on_load(:action_view) do
+          ::ActionView::Template.register_template_handler(:hamlc, ::HamlCoffeeAssets::ActionView::TemplateHandler)
+        end
+
         next unless app.assets
 
-        # Register tilt template
+        # Register Tilt template (for Sprockets)
         app.assets.register_engine '.hamlc', ::HamlCoffeeAssets::Tilt::TemplateHandler
       end
 

data/lib/haml_coffee_assets/version.rb

@@ -1,5 +1,5 @@
 # coding: UTF-8
 
 module HamlCoffeeAssets
-  VERSION = '1.9.1' unless defined?(HamlCoffeeAssets::VERSION)
+  VERSION = '1.10.0' unless defined?(HamlCoffeeAssets::VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haml_coffee_assets
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-08 00:00:00.000000000 Z
+date: 2013-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-script
@@ -82,6 +82,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/haml_coffee_assets/action_view/template_handler.rb
 - lib/haml_coffee_assets/compiler.rb
 - lib/haml_coffee_assets/configuration.rb
 - lib/haml_coffee_assets/rails/engine.rb