haml_coffee_assets 0.7.1 → 0.8.0

data/README.md

@@ -49,15 +49,12 @@ And require the `hamlcoffee.js` in your `app/assets/javascripts/application.js.c
 This provides the default escaping and the global context functions. Read more about it in the configuration section
 below.
 
+Please have a look at the [CHANGELOG](https://github.com/netzpirat/haml_coffee_assets/blob/master/CHANGELOG.md) when
+upgrading to a newer Haml Coffee Assets version.
+
 ## Usage
 
-You should place all your Haml Coffee templates in the `app/assets/templates` directory and include all templates from
-your `app/assets/javascripts/application.js.coffee`:
-
-```coffeescript
-#= require_tree ../templates
-```
-Now you can start to add your Haml Coffee templates to your template directory.
+Haml Coffee Assets allows two different ways of generating your JavaScript templates:
 
 ### Sprocket JST processor template generation
 
@@ -65,18 +62,43 @@ Now you can start to add your Haml Coffee templates to your template directory.
 
 When you give your templates the extension `.jst.hamlc`, Haml Coffee Assets will only generate the template function,
 which then in turn will be further processed by the
-[Sprocket JST processor](https://github.com/sstephenson/sprockets/blob/master/lib/sprockets/jst_processor.rb).
-This is the Rails way of asset processing and the only downside is that namespace definition is more cumbersome.
+[Sprocket JST processor](https://github.com/sstephenson/sprockets/blob/master/lib/sprockets/jst_processor.rb). Because
+Haml Coffee Assets will not generate the template, you can't use the template name filter and the JST namespace
+definition is more cumbersome compared to the Haml Coffee template generation.
+
+With this approach you should place all your Haml Coffee templates in the `app/assets/templates` directory and include
+all templates from your `app/assets/javascripts/application.js.coffee`:
+
+```coffeescript
+#= require_tree ../templates
+```
+
+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.
 
 ### Haml Coffee template generation
 
 * Extension: `.hamlc`
 
 If you omit the `.jst` and give your templates only a `.hamlc` extension, then Haml Coffee Assets will handle the
-JavaScript template generation. With this approach you can easily define your own namespace with a simple configuration.
+JavaScript template generation. With this approach you can easily define your own namespace with a simple configuration
+and you can use the template name filter.
+
+You can place all your Haml Coffee templates in the `app/assets/javascripts/templates` directory and include all
+templates from your `app/assets/javascripts/application.js.coffee`:
+
+```coffeescript
+#= require_tree ./templates
+```
+
+Because Haml Coffee Assets provides a default template name filter, the `templates/` prefix will be automatically
+removed.
 
 ## Configuration
 
+_Please note that all configuration examples will use the paths of the Haml Coffee template generation and not the
+Sprocket JST processor template generation._
+
 ### Document format
 
 By default all Haml Coffee templates are rendered to a HTML5 document. You can choose between the following output
@@ -95,7 +117,7 @@ config.hamlcoffee.format = 'xhtml'
 ### Template namespace
 
 By default all Haml Coffee templates are registered under the `JST` namespace. A template
-`app/assets/templates/header.hamlc` with the given content:
+`app/assets/javascripts/templates/header.hamlc` with the given content:
 
 ```haml
 %header
@@ -133,17 +155,30 @@ Foo::Application.assets.register_engine '.jst', MyJstProcessor
 
 And you must make sure `MyApp` exists before any template is loaded.
 
-#### Template name
+### Template name
 
 The name under which the template can be addressed in the namespace depends not only from the filename, but also on
 the directory name by default.
 
 The following examples assumes a configured namespace `window.JST` and the asset template directory
-`app/assets/templates`:
+`app/assets/javascripts/templates`:
 
-* `app/assets/templates/login.hamlc` will become `JST['login']`
-* `app/assets/templates/users/new.hamlc` will become `JST['users/new']`
-* `app/assets/templates/shared/form/address.hamlc` will become `JST['shared/form/address']`
+* `app/assets/javascripts/templates/login.hamlc` will become `JST['login']`
+* `app/assets/javascripts/templates/users/new.hamlc` will become `JST['users/new']`
+* `app/assets/javascripts/templates/shared/form/address.hamlc` will become `JST['shared/form/address']`
+
+#### Template name filter
+
+If you wish to put the templates in a different location, you may want to modify `name_filter` in an initializer.
+
+```ruby
+HamlCoffeeAssets::HamlCoffeeTemplate.name_filter = lambda { |n| n.sub /^templates\//, '' }
+```
+
+By default, `name_filter` strips the leading `templates/` directory off of the name. Please note, `name_filter` is only
+applicable if you use the `.hamlc` extension and let Haml Coffee Assets handle the JST generation. If you use the
+`.jst.hamlc` extension, then Sprockets JST processor will name things accordingly (e.g., with `templates/` intact in
+this case).
 
 ### Basename
 
@@ -157,9 +192,9 @@ config.hamlcoffee.basename = true
 
 With this setting enabled the following naming rule applies:
 
-* `app/assets/templates/login.hamlc` will become `JST['login']`
-* `app/assets/templates/users/new.hamlc` will become `JST['new']`
-* `app/assets/templates/shared/form/address.hamlc` will become `JST['address']`
+* `app/assets/javascripts/templates/login.hamlc` will become `JST['login']`
+* `app/assets/javascripts/templates/users/new.hamlc` will become `JST['new']`
+* `app/assets/javascripts/templates/shared/form/address.hamlc` will become `JST['address']`
 
 This setting has only an effect when you're using Haml Coffee to generate the JST and not when using the Sprockets
 JST processor.
@@ -309,6 +344,13 @@ You can see the [default implementation](https://github.com/netzpirat/haml_coffe
 and the [Haml Coffee documentation](https://github.com/9elements/haml-coffee#custom-helper-function-compiler-options)
 for more information about each helper function.
 
+## Shameless self promotion
+
+Developed by Michael Kessler, sponsored by [mksoft.ch](https://mksoft.ch).
+
+If you like Haml Coffee Assets, you can watch the repository at [GitHub](https://github.com/netzpirat/haml_coffee_assets) and
+follow [@netzpirat](https://twitter.com/#!/netzpirat) on Twitter for project updates.
+
 ## Development
 
 * Issues and feature request hosted at [GitHub Issues](https://github.com/netzpirat/haml_coffee_assets/issues).
@@ -321,14 +363,15 @@ Pull requests are very welcome! Please try to follow these simple rules if appli
 * Make sure your patches are well tested. All specs must pass.
 * Update the [Yard](http://yardoc.org/) documentation.
 * Update the README.
+* Update the CHANGELOG for noteworthy changes.
 * Please **do not change** the version number.
 
 For questions please join `#haml` on irc.freenode.net
 
 ## Contributors
 
-* [Arun Sivashankaran](https://github.com/axs89)
-* [Jay Zeschin](https://github.com/jayzes)
+See the [CHANGELOG](https://github.com/netzpirat/haml_coffee_assets/blob/master/CHANGELOG.md) and the GitHub list of
+[contributors](https://github.com/netzpirat/haml_coffee_assets/contributors).
 
 ## Acknowledgement
 

data/lib/haml_coffee_assets/haml_coffee_template.rb

@@ -7,7 +7,16 @@ module HamlCoffeeAssets
   # Haml CoffeeScript template implementation for Tilt.
   #
   class HamlCoffeeTemplate < Tilt::Template
+    
+    class << self
+      # A proc that is called to modify the template name used as the
+      # JST key. The proc is passed the name as an argument and should
+      # return the modified name (or unmodified) name.
+      attr_accessor :name_filter
+    end
 
+    # By default, remove any leading templates/ in the name
+    self.name_filter = lambda { |n| n.sub /^templates\//, '' }
     self.default_mime_type = 'application/javascript'
 
     # Test if the compiler is initialized.
@@ -33,7 +42,9 @@ module HamlCoffeeAssets
     #
     def evaluate(scope, locals = { }, &block)
       jst = scope.pathname.to_s =~ /\.jst\.hamlc(?:\.|$)/ ? false : true
-      @output ||= HamlCoffee.compile(scope.logical_path, data, jst)
+      name = scope.logical_path
+      name = self.class.name_filter.call(name) if self.class.name_filter && jst
+      @output ||= HamlCoffee.compile(name, data, jst)
     end
 
   end

data/lib/haml_coffee_assets/version.rb

@@ -1,5 +1,5 @@
 # coding: UTF-8
 
 module HamlCoffeeAssets
-  VERSION = '0.7.1' unless defined?(HamlCoffeeAssets::VERSION)
+  VERSION = '0.8.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: 0.7.1
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-27 00:00:00.000000000Z
+date: 2012-01-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
-  requirement: &70140809345180 !ruby/object:Gem::Requirement
+  requirement: &70339113280060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.2.9
   type: :runtime
   prerelease: false
-  version_requirements: *70140809345180
+  version_requirements: *70339113280060
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70140809344720 !ruby/object:Gem::Requirement
+  requirement: &70339113279600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.3.3
   type: :runtime
   prerelease: false
-  version_requirements: *70140809344720
+  version_requirements: *70339113279600
 - !ruby/object:Gem::Dependency
   name: sprockets
-  requirement: &70140809344260 !ruby/object:Gem::Requirement
+  requirement: &70339113279140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *70140809344260
+  version_requirements: *70339113279140
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70140809343880 !ruby/object:Gem::Requirement
+  requirement: &70339113278760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70140809343880
+  version_requirements: *70339113278760
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70140809343340 !ruby/object:Gem::Requirement
+  requirement: &70339113278220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '3.1'
   type: :development
   prerelease: false
-  version_requirements: *70140809343340
+  version_requirements: *70339113278220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70140809342920 !ruby/object:Gem::Requirement
+  requirement: &70339113312080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70140809342920
+  version_requirements: *70339113312080
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70140809376760 !ruby/object:Gem::Requirement
+  requirement: &70339113311620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70140809376760
+  version_requirements: *70339113311620
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70140809376340 !ruby/object:Gem::Requirement
+  requirement: &70339113311200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70140809376340
+  version_requirements: *70339113311200
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70140809375920 !ruby/object:Gem::Requirement
+  requirement: &70339113310780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70140809375920
+  version_requirements: *70339113310780
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70140809375500 !ruby/object:Gem::Requirement
+  requirement: &70339113310360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70140809375500
+  version_requirements: *70339113310360
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70140809375080 !ruby/object:Gem::Requirement
+  requirement: &70339113309940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70140809375080
+  version_requirements: *70339113309940
 description: Compile Haml CoffeeScript templates in the Rails asset pipeline.
 email:
 - michi@netzpiraten.ch