backbone-handlebars 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "rcov", ">= 0"
+  gem "jasmine"
+  gem "coffee-script"
+  gem "guard-coffeescript"
+end

data/Guardfile

@@ -0,0 +1,18 @@
+# A sample Guardfile
+# More info at http://github.com/guard/guard#readme
+#
+# Guard is a tool to respond to local filesystem events and take action. As such, it works better using native filesystem event libraries
+#
+# 1. Setup an RVM 1.9.2 environment to run guard
+# 2. gem install guard-coffeescript growl rb-fsevent
+# 3. run the 'guard' command; this fires up a server to monitor the coffescript as shown below
+# 4. C-\ will force guard to recompile everything it knows about
+# 5. Install the Gowl "Extras" growlnotify
+
+guard 'coffeescript', :output => 'javascripts/compiled' do
+  watch(%r{lib/assets/javascripts/.+\.coffee})
+end
+
+guard 'coffeescript', :output => 'spec/javascripts/compiled', :bare => true do
+  watch(%r{spec/javascripts/.*_spec\.coffee})
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Chris Nelson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,58 @@
+handlebone
+===================
+
+This gem is extracted out of a backbone project where we are using handlebars
+templates. It contains:
+
+* handlebars.js
+* A HandlebarsView superclass
+* a rails helper module for rendering all your handlebars templates into your rails view
+* Some handlebars helpers to make things easier
+
+Usage
+=====
+
+This gem is designed to integrate with the asset pipeline of rails 3.1+.  Somewhere in your 
+coffeescript or javascript code you'll need to require it:
+
+    #= require handlebars_view
+    
+This will bring in handlebars and the view superclass.  To use it, write a view like so:
+
+    class FooView extends HandlebarsView
+    
+      name: "foo_view"
+      
+This will cause the view to look for a template in an element with id "foo_view_template" and use 
+handlebars to render this view, passing in the view's model as the template 
+context.  You can change this by overriding the templateContext function in your view.
+
+HandlebarsHelpers
+=================
+
+Some helper methods to make writing those templates easier. 
+
+    {{get "property"}}
+
+This will grab a property from the model that is the current context
+
+    {{#eachProperty "children"}}hi!{{/eachProperty}}
+
+A block helper that iterates over a property that contains an array.
+
+Somewhere in your DOM ready, you'll need to call registerHelpers.  Like so:
+
+    $ -> Backbone.HandlebarsHelpers.registerHelpers()
+
+Also, you can register your own helpers by passing an object where each propery is a method that will 
+become a helper
+
+    Backbone.HandlebarsHelpers.registerHelpers(new MyHelpers())
+    
+RenderTemplatesHelper
+======================
+
+We've found it best practice to keep our handlebars templates  in separate files so our rails 
+views don't get all noisy.  This all let's use the same HandleBars view on more than one rails 
+view and in our jasmine specs.  This gem also includes a rails helper module RenderTemplatesHelper.
+Best to just look at the code to see what it does for now, it's super simple.

data/Rakefile

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "backbone-handlebars"
+  gem.homepage = "http://github.com/superchris/backbone-handlebars"
+  gem.license = "MIT"
+  gem.summary = %Q{Backbone views with handlebars templates}
+  gem.description = %Q{That's all folks}
+  gem.email = "superchrisnelson@gmail.com"
+  gem.authors = ["Chris Nelson"]
+  gem.files.include "vendor/assets/**/*"
+  gem.files.include "lib/**/*"
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "backbone-handlebars #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end
+
+
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/generators/backbone_view/backbone_view_generator.rb

@@ -0,0 +1,9 @@
+class BackboneViewGenerator < Rails::Generator::NamedBase
+
+  def manifest
+    record do |m|
+      m.template "view.coffee.erb", "backbone/views/#{name}.coffee", :assigns => {:name => name}
+      m.template "view_template.html.handlebars", "backbone/templates/#{name}.html.handlebars", :assigns => {:name => name}
+    end
+  end
+end

data/generators/backbone_view/templates/view.coffee.erb

@@ -0,0 +1,2 @@
+class <%= name.camelize %> extends TemplateView
+  name: "<%= name %>"

data/generators/backbone_view/templates/view_template.html.handlebars

@@ -0,0 +1,2 @@
+<script id="<%=name%>_template" type="text/html">
+</script>

data/lib/assets/javascripts/handlebars_helpers.coffee

@@ -0,0 +1,46 @@
+class Backbone.HandlebarsHelpers
+  
+  is: (block) ->
+    hash = block.hash
+    block() if this[hash.property] == hash.value
+    
+  stripe: (collection, block) ->
+    item_contents = for index in [0...collection.length]
+      collection[index].stripeClass = if ((index % 2) == 0) then "even" else "odd"
+      block collection[index]
+    item_contents.join("\n")
+  
+  formatNumber: (number) ->
+    $.formatNumber number, {format: "#,###"}
+    
+  formatCurrency: (number) ->
+    $.formatNumber number, {format: "$#,###.00"}
+  
+  formatPercentage: (number) ->
+    formatted = $.formatNumber number, {format: "#,###.0000"}
+    "#{formatted}%"
+  
+  get: (property)->
+    @get(property)
+  
+  helperMissing: -> ""
+
+  eachProperty: (property, block)->
+    block(object) for object in @get(property)
+    
+  view: (block) ->
+    params = block.hash
+    view = block.data.view
+    viewClass = eval(params.viewClass)
+    if params.modelClass
+      modelClass = eval(params.modelClass)
+      model = new modelClass(this)
+    else
+      model = this
+    childView = new viewClass(model: model, parent: view)
+    view.subViews.push childView
+    block(model)
+    
+  @registerHelpers: (helpers)->
+    helpers or= new HandlebarsHelpers()
+    Handlebars.registerHelper name, helper for name, helper of helpers

data/lib/assets/javascripts/handlebars_view.coffee

@@ -0,0 +1,26 @@
+#= require handlebars
+class Backbone.HandlebarsView extends Backbone.View
+  constructor: (options = {})->
+    @el = $("##{@name}") unless options.el
+    @subViews = []
+    @parent = options.parent
+    super
+    templateEl = $("##{@name}_template")
+    console.log "Did you include the template for #{@name}, putz?" if console? && templateEl.size() == 0
+    @template = if templateEl.size() > 0 then Handlebars.compile(templateEl.html(), true) else -> ""
+
+  templateContext: ->
+    @model
+
+  render: ->
+    @subViews = []
+    @el.html @template @templateContext(), Handlebars.helpers, Handlebars.partials, {view: this}
+    @renderSubView(subView) for subView in @subViews
+  
+  findEl: ->
+    @el = $("[data-id='#{@model.id}']")
+    
+  renderSubView: (subView) ->
+    subView.findEl()
+    subView.delegateEvents()
+    subView.render()  

data/lib/backbone-handlebars.rb

@@ -0,0 +1,5 @@
+if Rails.version =~ /^3/
+  require 'rails'
+  require 'backbone-handlebars/engine'
+  require 'backbone-handlebars/helper'
+end

data/lib/backbone-handlebars/engine.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module BackboneHandlebars
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end
+

data/lib/backbone-handlebars/helper.rb

@@ -0,0 +1,13 @@
+module BackboneHandlebars
+  module RenderTemplatesHelper
+    def render_backbone_template(template)
+      raw File.read(::Rails.root.join "app", "assets", "templates", "#{template}.handlebars.html")
+    end
+    
+    def render_backbone_templates
+      template_directory = ::Rails.root.join "app", "assets", "templates", "*.handlebars.html"
+      templates = Dir.glob(template_directory).collect { |t| File.read t }
+      raw templates.join("\n")
+    end
+  end
+end

data/lib/generators/backbone/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate backbone Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/backbone/backbone_generator.rb

@@ -0,0 +1,6 @@
+class BackboneGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  def create_backbone_directories
+    empty_directory "backbone"
+  end
+end

data/rakelib/coffeescript.rake

@@ -0,0 +1,30 @@
+namespace :coffeescript do
+  
+  def compile_files(files, output_dir)
+    require 'coffee-script'
+    files.each do |f|
+      new_f = File.join(output_dir, f.pathmap("%n").match(/^([^.]+)/).to_s + ".js")
+      File.open(new_f, "w") do |out|
+        puts "compiling #{f} to #{new_f}"
+        out.puts CoffeeScript.compile File.read(f)
+      end
+    end    
+  end
+  
+  namespace :compile do
+    desc "re-compile the coffeescript into javascript"
+    task :assets do
+      coffee_files = FileList["lib/assets/javascripts/*.coffee" ]
+      mkdir_p "javascripts/compiled"
+      compile_files(coffee_files, "javascripts/compiled")
+    end
+    
+    desc "re-compile the spec coffeescript into javascript"
+    task :specs do
+      mkdir_p "spec/javascripts/compiled"
+      compile_files(FileList["spec/javascripts/*.coffee"], "spec/javascripts/compiled")
+    end
+  end
+  
+  task :compile => ["compile:assets", "compile:specs"]
+end

data/spec/javascripts/fixtures/child_view.handlebars.html

@@ -0,0 +1,4 @@
+<script id="child_view_template" type="text/x-handlebars-template">
+Foo!
+</script>
+  

data/spec/javascripts/fixtures/multiple_child_parent_view.handlebars.html

@@ -0,0 +1,7 @@
+<script id="multiple_child_parent_view_template" type="text/x-handlebars-template">
+{{#eachProperty "children"}}
+{{#view viewClass="SimpleView"}}
+<div data-id="{{id}}"></div>
+{{/view}}
+{{/eachProperty}}
+</script>

data/spec/javascripts/fixtures/parent_view.handlebars.html

@@ -0,0 +1,6 @@
+<script id="parent_view_template" type="text/x-handlebars-template">
+{{#view viewClass="ChildView"}}
+<div id="child"></div>
+{{/view}}
+</script>
+  

data/spec/javascripts/fixtures/simple_view.handlebars.html

@@ -0,0 +1,4 @@
+<script id="simple_view_template" type="text/x-handlebars-template">
+<h1>{{get "foo"}}</h1>
+</script>
+  

data/spec/javascripts/handlebars_view_spec.coffee

@@ -0,0 +1,55 @@
+
+class SimpleView extends Backbone.HandlebarsView
+  name: "simple_view"
+
+class window.ParentView extends Backbone.HandlebarsView
+  name: "parent_view"
+  
+class window.ChildView extends Backbone.HandlebarsView
+  name: "child_view"
+  findEl: -> @el = $("#child")
+  
+class window.MultipleChildParentView extends Backbone.HandlebarsView
+  name: "multiple_child_parent_view"
+
+class window.SimpleModel extends Backbone.Model
+
+describe "HandlebarsView", ->
+  beforeEach ->
+    Backbone.HandlebarsHelpers.registerHelpers()
+  describe "SimpleView", ->
+    beforeEach ->
+      setFixtures "<div id='simple_view'></div>"
+      loadTemplate "simple_view.handlebars.html"
+      @simpleView = new SimpleView(model: new SimpleModel(foo: "bar"))
+      @simpleView.render()
+    it "finds it's el", ->
+      expect(@simpleView.el).toExist()
+    it "can render model data", ->
+      expect(@simpleView.el.html()).toMatch /bar/
+      
+  describe "subviews", ->
+    beforeEach ->
+      setFixtures "<div id='parent_view'></div>"
+      loadTemplate "parent_view.handlebars.html"
+      loadTemplate "child_view.handlebars.html"
+      @parentView = new ParentView(model: new SimpleModel(id: 1))
+      @parentView.render()
+    it "renders the child template too", ->
+      expect(@parentView.el.html()).toMatch /Foo/
+    it "has a child view as a subviews", ->
+      expect(@parentView.subViews.length).toEqual(1)
+  
+  describe "multiple child views", ->
+    beforeEach ->
+      setFixtures "<div id='multiple_child_parent_view'></div>"
+      loadTemplate "multiple_child_parent_view.handlebars.html"
+      loadTemplate "simple_view.handlebars.html"
+      children = [new SimpleModel(id: 1, foo: "baz"), new SimpleModel(id: 2, foo: "bing")]
+      @multipleChildParentView = new MultipleChildParentView(model: new SimpleModel(children: children))
+      @multipleChildParentView.render()
+    it "renders children views", ->
+      expect(@multipleChildParentView.el.html()).toMatch /baz/
+      expect(@multipleChildParentView.el.html()).toMatch /bing/
+    
+