backbone_handlebars 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in backbone_handlebars.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Blake Williams
+
+MIT License
+
+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.md

@@ -0,0 +1,33 @@
+# BackboneHandlebars
+
+A gem that vendors the latest Backbone, Underscore, and Handlebars libraries and compiles/precompiles Handlebars templates.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'backbone_handlebars'
+```
+
+## Usage
+
+    rails generate backbone_handlebars:install
+
+This will generate the applications structure in the app/assets/javascripts directory and add the precompile option to your production environment.
+
+## Options
+
+```ruby
+config.handlebars.precompile
+```
+
+Enables precompilation and will serve only the Handlebars runtime instead of the full library.
+
+```
+config.handlebars.path
+```
+
+Changes the path of the Handlebars library that compiles/precompiles your templates
+
+If you want to use your own Handlebars or Handlebars runtime you have to place them in `vendor/assets/handlebars/development` and `vendor/assets/handlebars/production` respectively.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/backbone_handlebars.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'backbone_handlebars/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "backbone_handlebars"
+  gem.version       = BackboneHandlebars::VERSION
+  gem.authors       = ["Blake Williams"]
+  gem.email         = ["blake@blakewilliams.me"]
+  gem.summary       = %q{Backbone and Handlebars for Rails 3.1+}
+  gem.homepage      = "http://github.com/BlakeWilliams/backbone_handlebars"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "execjs"
+  gem.add_dependency "sprockets"
+  gem.add_dependency "tilt"
+end

data/lib/backbone_handlebars/engine.rb

@@ -0,0 +1,26 @@
+require 'backbone_handlebars/template'
+
+module BackboneHandlebars
+  class Engine < Rails::Engine
+    config.handlebars = ActiveSupport::OrderedOptions.new
+
+    config.handlebars.path = File.expand_path("../../../vendor/assets/handlebars/development/handlebars.js", __FILE__)
+    config.handlebars.templates_root "templates"
+
+    initializer "backbone_handlebars.setup", after: 'sprockets.environment', group: :all do |app|
+      version = "production" if app.config.handlebars.precompile == true
+      version ||= "development"
+
+      path = File.expand_path("../../../vendor/assets/handlebars/#{version}", __FILE__)
+      app.config.assets.paths.push(path.to_s)
+
+      path = app.root.join("vendor/assets/handlebars/#{version}")
+      app.config.assets.paths.unshift(path.to_s) if path.exist?
+
+      next unless app.assets
+      app.assets.register_engine '.handlebars', BackboneHandlebars::Template
+      app.assets.register_engine '.hbs', BackboneHandlebars::Template
+      app.assets.register_engine '.hjs', BackboneHandlebars::Template
+    end
+  end
+end

data/lib/backbone_handlebars/template.rb

@@ -0,0 +1,58 @@
+require 'sprockets'
+require 'sprockets/engines'
+require 'execjs'
+
+module BackboneHandlebars
+  class Template < Tilt::Template
+
+    def self.handlebars
+      @@handlebars ||= File.new(::Rails.configuration.handlebars.path).read
+    end
+
+    def self.default_mime_type
+      'application/javascript'
+    end
+
+    def prepare; end
+
+    def evaluate(scope, locals, &block)
+      path = scope.logical_path.gsub(/^templates\//i, '')
+
+      if ::Rails.configuration.handlebars.precompile == true
+        template = precompile_handlebars(path, data)
+      else
+        template = compile_handlebars(path, data)
+      end
+    end
+
+    private
+    def compile_handlebars(path, string)
+      <<-TARGET.gsub /^\s{/, ''\
+(function() {
+  Handlebars.templates || (Handlebars.templates = {})
+  Handlebars.templates['#{path}'] = Handlebars.compile(#{indent(string).inspect});
+}).call(this);
+      TARGET
+    end
+
+    def precompile_handlebars(path, string)
+      context = ExecJS.compile(BackboneHandlebars::Template.handlebars)
+      template = context.call "Handlebars.precompile", strip(string)
+      <<-TARGET.gsub /^\s{/, ''\
+(function() {
+  Handlebars.templates || (Handlebars.templates = {})
+  Handlebars.templates['#{path}'] = Handlebars.template(#{template});
+}).call(this);
+      TARGET
+    end
+
+    def indent(string)
+      string.gsub(/$(.)/m, "\\1  ").strip
+    end
+
+    def strip(string)
+      string.gsub(/\n/, '')
+    end
+
+  end
+end

data/lib/backbone_handlebars/version.rb

@@ -0,0 +1,3 @@
+module BackboneHandlebars
+  VERSION = "0.0.1"
+end

data/lib/backbone_handlebars.rb

@@ -0,0 +1,2 @@
+require "backbone_handlebars/version"
+require "backbone_handlebars/engine"

data/lib/generators/backbone_handlebars/helpers.rb

@@ -0,0 +1,47 @@
+module BackboneHandlebars
+  module Generators
+    module Helpers
+
+      def assets_path
+        File.join('app', 'assets')
+      end
+
+      def javascripts_path
+        File.join(assets_path, 'javascripts')
+      end
+
+      def models_path
+        File.join(javascripts_path, 'models')
+      end
+
+      def collections_path
+        File.join(javascripts_path, 'collections')
+      end
+
+      def helpers_path
+        File.join(javascripts_path, 'helpers')
+      end
+
+      def routers_path
+        File.join(javascripts_path, 'routers')
+      end
+
+      def views_path
+        File.join(javascripts_path, 'views')
+      end
+
+      def templates_path
+        File.join(javascripts_path, 'templates')
+      end
+
+      def production_config_path
+        File.join('config', 'environments', 'production.rb')
+      end
+
+      def app_name
+        Rails.application.class.name.split('::').first.camelize
+      end
+
+    end
+  end
+end

data/lib/generators/backbone_handlebars/install/install_generator.rb

@@ -0,0 +1,68 @@
+require 'generators/backbone_handlebars/helpers'
+
+module BackboneHandlebars
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include BackboneHandlebars::Generators::Helpers
+
+      source_root File.expand_path('../templates', __FILE__)
+      
+      desc "Generates Backbone skeleton directory structure"
+
+      class_option :manifest,
+                    type: :string,
+                    aliases: "-m",
+                    default: "application.js",
+                    desc: "Javascript manifest file to modify"
+
+      def create_dir_layout
+        empty_directory collections_path
+        empty_directory helpers_path
+        empty_directory models_path
+        empty_directory routers_path
+        empty_directory templates_path 
+        empty_directory views_path
+      end
+
+      def create_app_file
+        template "app.coffee", "#{javascripts_path}/#{app_name.downcase}.coffee"
+      end
+
+      def inject_files
+        manifest = File.join(javascripts_path, options.manifest)
+
+        libs = %w[underscore backbone handlebars]
+        paths = %w(./helpers ./templates ./models ./collections ./views ./routers)
+
+        out = []
+        out << libs.map { |lib| "//= require #{lib}" }
+        out << "//= require #{app_name.downcase}"
+        out << paths.map { |path| "//= require_tree #{path}" }
+        out = out.join("\n") + "\n"
+
+        in_root do
+          return unless File.exists?(manifest)
+          if File.open(manifest).read().include?('//= require_tree .')
+            inject_into_file(manifest, out, before: '//= require_tree .')
+          else
+            append_file(manifest, out)
+          end
+        end
+      end
+
+      def inject_production_config
+        in_root do
+          return unless File.exists?(production_config_path)
+
+          out = []
+          out << ["  # Specify if you want Handlebars precompiled in this environment"]
+          out << ["  config.handlebars.precompile = true"]
+          out = "\n#{out.join("\n")}\n"
+
+          inject_into_file(production_config_path, out, before: "\nend")
+        end
+      end
+      
+    end
+  end
+end

data/lib/generators/backbone_handlebars/install/templates/app.coffee

@@ -0,0 +1,10 @@
+window.<%= app_name %> =
+  Models: {}
+  Collections: {}
+  Views: {}
+  Routers: {}
+  initialize: ->
+    # Initialize your app here
+
+$ ->
+  <%= app_name %>.initialize()