hamlbars 1.0.0 → 1.1.0

data/History.md

@@ -1,5 +1,12 @@
 # master
 
+# 1.1.0
+
+* Add support for `:_action` attributes, and deprecate the `:event` and
+  `:events` syntax
+
+# 1.0.0
+
 * Drop support for `.hbs` extension (#11)
 
 # 2012.3.21

data/README.md

@@ -3,127 +3,215 @@
 [![Build Status](https://secure.travis-ci.org/jamesotron/hamlbars.png?branch=master)](http://travis-ci.org/jamesotron/hamlbars)
 [![Dependency Status](https://gemnasium.com/jamesotron/hamlbars.png)](https://gemnasium.com/jamesotron/hamlbars)
 
-[Hamlbars](https://github.com/jamesotron/hamlbars) is a Ruby gem which allows you to easily generate [Handlebar](http://handlebarsjs.com) templates using [Haml](http://www.haml-lang.com).
+[Hamlbars](https://github.com/jamesotron/hamlbars) is a Ruby gem which allows
+you to easily generate [Handlebars](http://handlebarsjs.com) templates using
+[Haml](http://www.haml-lang.com).
+
+# Installation
+
+Add the following line to your Gemfile (on Rails, inside the `:assets` group):
+
+```ruby
+gem 'hamlbars', '~> 1.1'
+```
+
+If you are stuck with an older, yanked version like 2012.3.21 and it won't
+update to 1.1, be sure to add `'~> 1.1'` as the version spec and run `bundle
+install`.
 
 # Demo Site
 
-If you're unsure how all the pieces fit together then take a quick look at the [demo site](http://hamlbars-demo.herokuapp.com/).
+If you're unsure how all the pieces fit together then take a quick look at the
+[demo site](http://hamlbars-demo.herokuapp.com/).
 
 # Attribute bindings
 
-You can easily add attribute bindings by adding a `:bind` hash to the tag attributes, like so:
+You can easily add attribute bindings by adding a `:bind` hash to the tag
+attributes, like so:
 
-    %div{ :class => 'widget', :bind => { :title => 'App.widgetController.title' }
+```haml
+%div{ :class => 'widget', :bind => { :title => 'App.widgetController.title' }
+```
 
 Which will generate the following output:
 
-    <div class="widget" {{bindAttr title="App.widgetController.title"}}></div>
+```handlebars
+<div class="widget" {{bindAttr title="App.widgetController.title"}}></div>
+```
+
+# Action handlers
+
+To use Ember's `{{action}}` helper, set the `:_action` attribute, like so:
+
+```haml
+%a{ :_action => 'toggle' } Toggle
+%a{ :_action => 'edit article on="doubleClick"' } Edit
+```
+
+This will generate:
+
+```html
+<a {{action toggle}}>Toggle</a>
+<a {{action edit article on="doubleClick"}}>Edit</a>
+```
+
+Note that `:_action` has a leading underscore, to distinguish it from regular
+HTML attributes (`<form action="...">`).
 
-# Event bindings
+# Event bindings (old syntax)
 
-You can add one or more event actions by adding an event hash or array or event hashes to the tag options:
+You can also add one or more event actions by adding an event hash or array of
+event hashes to the tag options. This syntax is being deprecated in favor of
+the newer `:_action` syntax described above.
 
-    %a{ :event => { :on => 'click', :action => 'clicked' } } Click
+```haml
+%a{ :event => { :on => 'click', :action => 'clicked' } } Click
+```
 
 or
 
-    %div{ :events => [ { :on => 'mouseover', :action => 'highlightView' }, { :on => 'mouseout', :action => 'disableViewHighlight' } ] }
+```haml
+%div{ :events => [ { :on => 'mouseover', :action => 'highlightView' }, { :on => 'mouseout', :action => 'disableViewHighlight' } ] }
+```
 
 Note that the default event is `click`, so it's not necessary to specify it:
 
-    %a{ :event => { :action => 'clicked' } } Click
+```haml
+%a{ :event => { :action => 'clicked' } } Click
+```
 
-# Handlebar helper
+# Handlebars helper
 
-You can use the `handlebars` helper (or just `hb` for short) to generate both Handlebar blocks and expressions.
+You can use the `handlebars` helper (or just `hb` for short) to generate both
+Handlebars blocks and expressions.
 
 ## Expressions
 
-Generating Handlebars expressions is as simple as using the `handlebars` helper and providing the expression as a string argument:
+Generating Handlebars expressions is as simple as using the `handlebars` helper
+and providing the expression as a string argument:
 
-    = hb 'App.widgetController.title'
+```haml
+= hb 'App.widgetController.title'
+```
 
 which will will generate:
 
-    {{App.widgetController.title}}
+```handlebars
+{{App.widgetController.title}}
+```
 
 ## Blocks
 
-Whereas passing a block to the `handlebars` helper will create a Handlebars block expression:
+Whereas passing a block to the `handlebars` helper will create a Handlebars
+block expression:
 
-    %ul.authors
-    = hb 'each authors' do
-      %li<
-	= succeed ',' do
-	  = hb 'lastName'
-	= hb 'firstName'
+```haml
+%ul.authors
+= hb 'each authors' do
+  %li<
+    = succeed ',' do
+      = hb 'lastName'
+    = hb 'firstName'
+```
 
 will result in the following markup:
 
-    <ul class="authors">
-       {{#each authors}}
-         <li>{{lastName}}, {{firstName}}</li>
-       {{/each}}
-    </ul>
+```handlebars
+<ul class="authors">
+   {{#each authors}}
+     <li>{{lastName}}, {{firstName}}</li>
+   {{/each}}
+</ul>
+```
 
 ## Options
 
-The `hb` helper can take an optional hash of options which will be rendered inside the expression:
+The `hb` helper can take an optional hash of options which will be rendered
+inside the expression:
 
-    = hb 'view App.InfoView', :tagName => 'span'
+```haml
+= hb 'view App.InfoView', :tagName => 'span'
+```
 
 will result in:
 
-    {{view App.InfoView tagName="span"}}
+```handlebars
+{{view App.InfoView tagName="span"}}
+```
 
 ## Tripple-stash
 
-You can use the `handlebars!` or `hb!` variant of the `handlebars` helper to output "tripple-stash" expressions within which Handlebars does not escape the output.
+You can use the `handlebars!` or `hb!` variant of the `handlebars` helper to
+output "tripple-stash" expressions within which Handlebars does not escape the
+output.
 
 # Configuring template output:
 
-`hamlbars` has three configuration options, which pertain to the generated JavaScript:
+`hamlbars` has three configuration options, which pertain to the generated
+JavaScript:
 
-    Hamlbars::Template.template_destination    # default 'Handlebars.templates'
-    Hamlbars::Template.template_compiler       # default 'Handlebars.compile'
-    Hamlbars::Template.template_partial_method # default 'Handlebars.registerPartial'
+```ruby
+Hamlbars::Template.template_destination    # default 'Handlebars.templates'
+Hamlbars::Template.template_compiler       # default 'Handlebars.compile'
+Hamlbars::Template.template_partial_method # default 'Handlebars.registerPartial'
+```
 
-These settings will work find by default if you are using Handlebars as a standalone JavaScript library, however if you are using something that embeds Handlebars within it then you'll have to change these.
+These settings will work find by default if you are using Handlebars as a
+standalone JavaScript library, however if you are using something that embeds
+Handlebars within it then you'll have to change these.
 
 If you're using [Ember.js](http://www.emberjs.com) then you can use:
 
-    Hamlbars::Template.render_templates_for :ember
+```ruby
+Hamlbars::Template.render_templates_for :ember
+```
 
 Which is effectively the same as:
 
-    Hamlbars::Template.template_destination = 'Ember.TEMPLATES'
-    Hamlbars::Template.template_compiler = 'Ember.Handlebars.compile'
-    Hamlbars::Template.template_partial_method = 'Ember.Handlebars.registerPartial'
+```ruby
+Hamlbars::Template.template_destination = 'Ember.TEMPLATES'
+Hamlbars::Template.template_compiler = 'Ember.Handlebars.compile'
+Hamlbars::Template.template_partial_method = 'Ember.Handlebars.registerPartial'
+```
 
-The good news is that if you're using the [emberjs-rails](http://www.rubygems.org/gems/emberjs-rails) gem then it will automatically detect hamlbars and change it for you. Magic!
+The good news is that if you're using the
+[emberjs-rails](http://www.rubygems.org/gems/emberjs-rails) gem then it will
+automatically detect hamlbars and change it for you. Magic!
 
-If you're using [ember-rails](http://rubygems.org/gems/ember-rails) then you'll need to put this in a initializer.
+If you're using [ember-rails](http://rubygems.org/gems/ember-rails) then you'll
+need to put this in a initializer.
 
 # Configuring JavaScript output:
 
-As of version 2012.3.21 `hamlbars` has experimental support for template precompilation using [ExecJS](http://rubygems.org/gems/execjs).  If you want to enable this support you can use:
+Hamlbars has experimental support for template precompilation using
+[ExecJS](http://rubygems.org/gems/execjs). To enable it, call
 
-    Hamlbars::Template.enable_precompiler!
+```ruby
+Hamlbars::Template.enable_precompiler!
+```
 
 You can also disable enclosification (which is enabled by default) using:
 
-    Hamlbars::Template.disable_closures!
+```ruby
+Hamlbars::Template.disable_closures!
+```
 
 # Asset pipeline
 
-Hamlbars is specifically designed for use with Rails 3.1's asset pipeline.  Simply create templates ending in `.js.hamlbars` and Sprockets will know what to do.
+Hamlbars is specifically designed for use with Rails 3.1's asset pipeline.
+Simply create templates ending in `.js.hamlbars` and Sprockets will know what
+to do.
 
 # Rails helpers
 
-You can enable support by calling `Hamlbars::Template.enable_rails_helpers!`. Probably the best way to do this is to create an initializer.  This is dangerous and possibly stupid as a large number of Rails' helpers require access to the request object, which is not present when compiling assets.
+You can enable support by calling `Hamlbars::Template.enable_rails_helpers!`.
+Probably the best way to do this is to create an initializer.  This is
+dangerous and possibly stupid as a large number of Rails' helpers require
+access to the request object, which is not present when compiling assets.
 
 **Use at your own risk. You have been warned.**
 
 # License and Copyright.
 
-Hamlbars is Copyright &copy; 2012 [Sociable Limited](http://sociable.co.nz/) and licensed under the terms of the MIT License.
+Hamlbars is Copyright &copy; 2012 [Sociable Limited](http://sociable.co.nz/)
+and licensed under the terms of the MIT License.

data/lib/hamlbars/ext/compiler.rb

@@ -1,44 +1,62 @@
 module Hamlbars
   module Ext
     module Compiler
-    end
-  end
-end
+      def self.handlebars_attributes(helper, attributes)
+        rendered_attributes = [].tap { |r|attributes.each { |k,v| r << "#{k}=\"#{v}\"" } }.join(' ')
+        " {{#{helper} #{rendered_attributes}}}"
+      end
 
-module Haml
-  module Compiler
-
-    class << self
-      # Overload build_attributes in Haml::Compiler to allow
-      # for the creation of handlebars bound attributes by
-      # adding :bind hash to the tag attributes.
-      def build_attributes_with_handlebars_attributes (is_html, attr_wrapper, escape_attrs, attributes={})
-        attributes[:bind] = attributes.delete('bind') if attributes['bind']
-        attributes[:event] = attributes.delete('event') if attributes['event']
-        attributes[:events] = attributes.delete('events') if attributes['events']
-        attributes[:events] ||= []
-        attributes[:events] << attributes.delete(:event) if attributes[:event]
-
-        handlebars_rendered_attributes = []
-        handlebars_rendered_attributes << handlebars_attributes('bindAttr', attributes.delete(:bind)) if attributes[:bind]
-        attributes[:events].each do |event|
-          event[:on] = event.delete('on') || event.delete(:on) || 'click'
-          action = event.delete('action') || event.delete(:action)
-          handlebars_rendered_attributes << handlebars_attributes("action \"#{action}\"", event)
-        end
-        attributes.delete(:events)
+      def self.included(base)
+        base.instance_eval do
 
-        (handlebars_rendered_attributes * '') +
-          build_attributes_without_handlebars_attributes(is_html, attr_wrapper, escape_attrs, attributes)
-      end
-      alias build_attributes_without_handlebars_attributes build_attributes
-      alias build_attributes build_attributes_with_handlebars_attributes 
+          if Haml::VERSION >= "3.2"
+            # Haml 3.2 introduces hyphenate_data_attrs
+            def build_attributes_with_handlebars_attributes (is_html, attr_wrapper, escape_attrs, hyphenate_data_attrs, attributes={})
+              handlebars_rendered_attributes = build_attributes_with_handlebars_attributes_base(is_html, attr_wrapper, escape_attrs, attributes)
 
-      private
+              (handlebars_rendered_attributes * '') +
+                build_attributes_without_handlebars_attributes(is_html, attr_wrapper, escape_attrs, hyphenate_data_attrs, attributes)
+            end
+          else
+            def build_attributes_with_handlebars_attributes (is_html, attr_wrapper, escape_attrs, attributes={})
+              handlebars_rendered_attributes = build_attributes_with_handlebars_attributes_base(is_html, attr_wrapper, escape_attrs, attributes)
 
-      def handlebars_attributes(helper, attributes)
-        rendered_attributes = [].tap { |r|attributes.each { |k,v| r << "#{k}=\"#{v}\"" } }.join(' ')
-        " {{#{helper} #{rendered_attributes}}}"
+              (handlebars_rendered_attributes * '') +
+                build_attributes_without_handlebars_attributes(is_html, attr_wrapper, escape_attrs, attributes)
+            end
+          end
+
+          # Overload build_attributes in Haml::Compiler to allow
+          # for the creation of handlebars bound attributes by
+          # adding :bind hash to the tag attributes.
+          def build_attributes_with_handlebars_attributes_base(is_html, attr_wrapper, escape_attrs, attributes={})
+            handlebars_rendered_attributes = []
+
+            if bind = attributes.delete('bind')
+              handlebars_rendered_attributes << Hamlbars::Ext::Compiler.handlebars_attributes('bindAttr', bind)
+            end
+
+            events = attributes.delete('events') || []
+            if event = attributes.delete('event')
+              events << event
+            end
+            events.each do |event|
+              event[:on] = event.delete('on') || event.delete(:on) || 'click'
+              action = event.delete('action') || event.delete(:action)
+              handlebars_rendered_attributes << Hamlbars::Ext::Compiler.handlebars_attributes("action \"#{action}\"", event)
+            end
+
+            # This could be generalized into /_.*/ catch-all syntax, if
+            # necessary. https://github.com/jamesotron/hamlbars/pull/33
+            if action = attributes.delete('_action')
+              handlebars_rendered_attributes << " {{action #{action}}}"
+            end
+
+            handlebars_rendered_attributes
+          end
+          alias build_attributes_without_handlebars_attributes build_attributes
+          alias build_attributes build_attributes_with_handlebars_attributes
+        end
       end
     end
   end

data/lib/hamlbars/version.rb

@@ -1,3 +1,3 @@
 module Hamlbars
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hamlbars
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-28 00:00:00.000000000 Z
+date: 2012-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -98,7 +98,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,7 +106,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -156,15 +156,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -951484081994800646
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -951484081994800646
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Extensions to Haml to allow creation of handlebars expressions.