angular-rails-templates 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89d964f875011e9189ab1360595c5761ab4ce256
-  data.tar.gz: 73ce6e9e285e9562531a7f87e22b437c132d3cb0
+  metadata.gz: 1a0382ea27ff3c7b1cfb6ea0e66196406cea4f93
+  data.tar.gz: bd48df6bc60a92033beb772507409bf70e4f2af2
 SHA512:
-  metadata.gz: 4da72ed50555f8993d4e34af7e767db53b4cba3f606fa2ef8be8c042e972ee35dfcecd432127e42c7e8e010ffd3ab3b6fbdb3d116ae3e4467d7cf9cd7313cced
-  data.tar.gz: 1f938a613811dced90f9ee7c53c4f64555174c737a2995862bff80a1d3ab1d4a82c4af51b059d5e6ea6fc1b2968cca1ca45f9198581cc1f7b9514972ace41d8f
+  metadata.gz: 2111bf9c7c7cfa83ca6fdcdd5a7c05821509f04b85f922ba73f8fb03c9f2ba2f06cc33a580408053ae4bf800b5e6722f4ba0c16b6f45c5977d1e77258a1ffe5a
+  data.tar.gz: 15b917f2a93c0cef94fb7a2fb040b4026110b78168072398b814d931333e4b3542be4d8e19085dd467dae5a530afd1624f541634846a76721d36f7888aa57d61

data/README.md

@@ -6,7 +6,7 @@ It removes the need for AJAX calls to retrieve the templates (or for you to manu
 
 ## Usage
 
-### 1. Add the gem
+### 1. Add the Gem
 
 In Gemfile
 
@@ -14,39 +14,188 @@ In Gemfile
 gem 'angular-rails-templates'
 ```
 
-### 2. Include templates in JS
+### 2. Include Templates in Rails Asset Pipeline
 
-Then, in your `application.js` file, require your templates and the internal javascript file:
+Then, in your `application.js` file, require `angular-rails-templates` and your templates:
 
 ```javascript
 //= require angularjs
-//= require_tree ./path_to_your_templates
+// ...
+//= require angular-rails-templates
+//
+// Templates in app/assets/javascript/templates
+//= require_tree ./templates
+// OR
+// Templates in app/assets/templates
+//= require_tree ../templates
 ```
 
-`path_to_your_templates` is relative to `application.js`.  For example, your templates are under `app/assets/javascripts/my_app/templates` and you then `require_tree ./my_app/templates`
+Make sure to `require angular-rails-templates` **before** you require your templates.
 
-Extensions supported are **.html**, **.ajs**, **.nghaml**, **.ngslim**. Last two do additional preprocessing and require `haml` and `slim` gems in your Gemfile.
+Name your templates like you would name any other Rails view. **The `.html` part is required.** If it is not present your views will not be added to angular's template cache.
 
-### 3. Add a dependency in Angular module
+```
+foo.html
+foo.html.erb
+foo.html.haml
+foo.html.slim
+```
+
+Caution: *`.ngslim` and `.nghaml` are no longer supported!*
+
+Angular Rails Templates will try to load support for the following markups if their gems are present:
+
+| Extension | Required gem                                             |
+|---------- |----------------------------------------------------------|
+| .erb      | -                                                        |
+| .str      | -                                                        |
+| .haml     | haml                                                     |
+| .slim     | slim                                                     |
+| .md       | liquid, rdiscount, redcrpet, bluecloth, kramdown, maruku |
 
-Your Angular module needs to have `templates` as a dependency (configurable with `config.angular_templates.module_name`)
+See [Advanced](#advanced-configuration) if you would like to use other markup languages.
+
+### 3. Add a Dependency in your Angular Application Module
+
+Your Angular module needs to depend on the `templates` module. (configurable, see [Advanced Configuration](#configuration-option-module_name))
 
 ```javascript
-var application = angular.module('myApplication', ['templates']);
+angular.module('myApplication', ['templates']);
 ```
 
-Loading this module will automatically load all your templates into angular's `$templateCache`.
-Angular uses this parameter when checking for the presence of templates before making an HTTP call.
+### 4. Use your Templates
+
+No matter what the source file extension is, your template's url will be  `#{base_name}.html`
+
+For example:
+```ruby
+main.html => main.html
+widget.html.haml => widget.html
+modals/confirm.html.slim => modals/confirm.html
+modals/dialog.html.slim.erb.str => modals/dialog.html # don't do this
+```
 
 The templates can then be accessed via `templateUrl` as expected:
 
 ``` javascript
+// Template: app/assets/templates/yourTemplate.html.haml
+{
+  templateUrl: 'yourTemplate.html'
+}
+```
+
+## Advanced Configuration
+
+Angular Rails Templates has some configuration options that can be set inside `config/application.rb`
+
+Here are their default values:
+```ruby
+# config/application.rb
+config.angular_templates.module_name    = 'templates'
+config.angular_templates.ignore_prefix  = 'templates/'
+config.angular_templates.markups        = %w(erb str haml slim md)
+config.angular_templates.htmlcompressor = false
+```
+
+### Configuration Option: `module_name`
+
+This configures the module name that your templates will be placed into.
+It is used to generate javascript like:
+
+```javascipt
+angular.module("<%= module_name %>")...
+```
+
+Although it is not recommended, you can set `module_name` to the name of your main application module and remove `require angular-rails-templates` from your javascript manifest to have your templates directly injected into your app.
+
+### Configuration Option: `ignore_prefix`
+
+*If you place your templates in `app/assets/templates` this option is mostly useless.*
+
+`ignore_prefix` will be stripped from the beginning of the `templateUrl` it reports to angularjs.
+
+Since the default ignore_prefix is `templates/`, any templates placed under `app/assets/javascripts/templates` will automatically have short names. If your templates are not in this location, you will need to use the full path to the template.
+
+You can set `config.angular_templates.ignore_prefix` to change the default ignore prefix. Default is `templates/`.
+
+
+``` javascript
+// Templates in: app/assets/javascripts/templates (default)
+// ignore_prefix: templates/ (default)
+{
+  templateUrl: 'yourTemplate.html'
+}
+// This won't work:
+{
+  templateUrl: 'templates/yourTemplate.html'
+}
+```
+
+``` javascript
+// Templates in: app/assets/javascripts/my_app/templates (custom)
+// ignore_prefix: templates/ (default)
 {
   templateUrl: 'my_app/templates/yourTemplate.html'
 }
+
+// ignore_prefix: my_app/templates/ (custom)
+{
+  templateUrl: 'yourTemplate.html'
+}
+```
+
+
+### Configuration Option: `markups`
+
+Any markup that Tilt supports can be used, but you may need to add a gem to your Gemfile. See [Tilt](https://github.com/rtomayko/tilt) for a list of the supported markups and required libraries.
+
+```ruby
+# Gemfile
+gem "asciidoctor"
+gem "radius"
+gem "creole"
+gem "tilt-handlebars"
+
+# config/application.rb
+config.angular_templates.markups.push 'asciidoc', 'radius', 'wiki', 'hbs'
+```
+If you would like to use a non-standard extension or you would like to use a custom template, you just need to tell Tilt about it.
+
+```ruby
+# config/initializers/angular_rails_templates.rb
+Tilt.register Tilt::HamlTemplate, 'nghaml'
+
+# config/application.rb
+config.angular_templates.markups.push 'nghaml'
+```
+Note: You would still need to use `foo`**`.html`**`.nghaml`
+
+
+### Configuration Option: `htmlcompressor`
+
+The [htmlcompressor gem](https://github.com/paolochiodi/htmlcompressor) is in alpha, not activly maintained, and has several known bugs. Beware if you are using windows. The `simple_boolean_attributes` option is known to mangle angular templates. It depends on a three-year-old version of yui-compressor. However, it does a good job of compressing html!
+
+If you would like to use htmlcompressor add it to your Gemfile and Enable the configuration option.
+
+```ruby
+# Gemfile
+gem 'htmlcompressor'
+```
+
+```ruby
+# config/application.rb
+config.angular_templates.htmlcompressor = true
+```
+
+You can also pass an options hash to `htmlcompressor` that will be directly passed to ```HtmlCompressor::Compressor.new```. See the [ruby project](https://github.com/paolochiodi/htmlcompressor#usage) or the [java project](https://code.google.com/p/htmlcompressor/#Compressing_HTML_and_XML_files_from_a_command_line) for descriptions of the options.
+
+```ruby
+# config/application.rb
+config.angular_templates.htmlcompressor = {
+  :remove_quotes => true
+}
 ```
 
-You can set `config.angular_templates.ignore_prefix` to remove part of the path to your templates. For example, set it to `my_app/templates/` so you can refer to your templates by simply `yourTemplate.html`. Default is `templates/`.
 
 ## License
 

data/lib/angular-rails-templates.rb

@@ -1,12 +1,6 @@
-module AngularRailsTemplates
-  HAML_EXT = '.nghaml'
-  SLIM_EXT = '.ngslim'
+require 'angular-rails-templates/engine'
 
-  autoload :Template        , 'angular-rails-templates/template'
-  autoload :BaseTemplate    , 'angular-rails-templates/base_template'
-  autoload :SlimTemplate    , 'angular-rails-templates/slim_template'
-  autoload :HamlTemplate    , 'angular-rails-templates/haml_template'
-  autoload :Version         , 'angular-rails-templates/version'
+module AngularRailsTemplates
+  autoload :Template, 'angular-rails-templates/template'
+  autoload :VERSION,  'angular-rails-templates/version'
 end
-
-require 'angular-rails-templates/engine'

data/lib/angular-rails-templates/compact_javascript_escape.rb

@@ -0,0 +1,29 @@
+module AngularRailsTemplates
+  module CompactJavaScriptEscape
+    # inspired by Rails' action_view/helpers/javascript_helper.rb
+    JS_ESCAPE_MAP = {
+      '\\'    => '\\\\',
+      "\r\n"  => '\n',
+      "\n"    => '\n',
+      "\r"    => '\n',
+      '"'     => '\\"',
+      "'"     => "\\'"
+    }
+
+    # We want to deliver the shortist valid javascript escaped string
+    # Count the number of " vs '
+    # If more ', escape "
+    # If more ", escape '
+    # If equal, prefer to escape "
+
+    def escape_javascript(raw)
+      if raw
+        quote = raw.count(%{'}) >= raw.count(%{"}) ? %{"} : %{'}
+        escaped = raw.gsub(/(\\|\r\n|[\n\r#{quote}])/u) {|match| JS_ESCAPE_MAP[match] }
+        "#{quote}#{escaped}#{quote}"
+      else
+        '""'
+      end
+    end
+  end
+end

data/lib/angular-rails-templates/engine.rb

@@ -1,18 +1,52 @@
 module AngularRailsTemplates
   class Engine < ::Rails::Engine
     config.angular_templates = ActiveSupport::OrderedOptions.new
-    config.angular_templates.module_name = 'templates'
-    config.angular_templates.ignore_prefix = 'templates/'
+    config.angular_templates.module_name    = 'templates'
+    config.angular_templates.ignore_prefix  = 'templates/'
+    config.angular_templates.markups        = []
+    config.angular_templates.htmlcompressor = false
+
+    # try loading common markups
+    %w(erb haml liquid md radius slim str textile wiki).
+    each do |ext|
+      begin
+        config.angular_templates.markups << ext if Tilt[ext]
+      rescue LoadError
+        # They don't have the required libray required. Oh well.
+      end
+    end
+
 
     config.before_initialize do |app|
       if app.config.assets
         require 'sprockets'
-        Sprockets::Engines #force autoloading
+        require 'sprockets/engines' # load sprockets for Rails 3
+
+        if app.config.angular_templates.htmlcompressor
+          require 'htmlcompressor/compressor'
+          unless app.config.angular_templates.htmlcompressor.is_a? Hash
+            app.config.angular_templates.htmlcompressor = {remove_intertag_spaces: true}
+          end
+        end
+
+        # These engines render markup as HTML
+        app.config.angular_templates.markups.each do |ext|
+          # Processed haml/slim templates have a mime-type of text/html.
+          # If sprockets sees a `foo.html.haml` it will process the haml
+          # and stop, because the haml output is html. Our html engine won't get run.
+          mimeless_engine = Class.new(Tilt[ext]) do
+            def self.default_mime_type
+              nil
+            end
+          end
+
+          Sprockets.register_engine ".#{ext}", mimeless_engine
+        end
+
+        # This engine wraps the HTML into JS
+        Sprockets.register_engine '.html', AngularRailsTemplates::Template
 
-        Sprockets.register_engine SLIM_EXT , AngularRailsTemplates::Template
-        Sprockets.register_engine HAML_EXT , AngularRailsTemplates::Template
-        Sprockets.register_engine '.ajs'   , AngularRailsTemplates::Template
-        Sprockets.register_engine '.html'  , AngularRailsTemplates::Template
+        app.config.assets.precompile << %r(angular-rails-templates.js)
       end
     end
   end

data/lib/angular-rails-templates/javascript_template.js.erb

@@ -0,0 +1,7 @@
+// Angular Rails Template
+// source: <%= source_file %>
+
+angular.module("<%= angular_module %>").run(["$templateCache", function($templateCache) {
+  $templateCache.put("<%= angular_template_name %>", <%= html %>)
+}]);
+

data/lib/angular-rails-templates/template.rb

@@ -1,51 +1,48 @@
-require 'sprockets'
-require 'sprockets/engines'
+require 'angular-rails-templates/compact_javascript_escape'
 
 module AngularRailsTemplates
-  class Template < Tilt::Template
+  class Template < ::Tilt::Template
+    include CompactJavaScriptEscape
+    AngularJsTemplateWrapper = Tilt::ERBTemplate.new "#{File.dirname __FILE__}/javascript_template.js.erb"
+    @@compressor = nil
+
     def self.default_mime_type
       'application/javascript'
     end
 
-    def prepare ; end
+    # this method is mandatory on Tilt::Template subclasses
+    def prepare
+      if configuration.htmlcompressor
+        @data = compress data
+      end
+    end
 
     def evaluate(scope, locals, &block)
-      template = case File.extname(file)
-               when HAML_EXT then HamlTemplate.new(self)
-               when SLIM_EXT then SlimTemplate.new(self)
-               else
-                 BaseTemplate.new(self)
-               end
-
-      render_script_template(logical_template_path(scope), template.render)
+      locals[:html] = escape_javascript data.chomp
+      locals[:angular_template_name] = logical_template_path(scope)
+      locals[:source_file] = "#{scope.pathname}".sub(/^#{Rails.root}\//,'')
+      locals[:angular_module] = configuration.module_name
+
+      AngularJsTemplateWrapper.render(scope, locals)
     end
 
-    protected
+    private
 
     def logical_template_path(scope)
-      path = scope.logical_path
-      path.gsub!(Regexp.new("^#{configuration.ignore_prefix}"), "")
+      path = scope.logical_path.sub /^#{configuration.ignore_prefix}/, ''
       "#{path}.html"
     end
 
-    def module_name
-      configuration.module_name.inspect
-    end
-
     def configuration
       ::Rails.configuration.angular_templates
     end
 
-    def render_script_template(path, data)
-      %Q{
-window.AngularRailsTemplates || (window.AngularRailsTemplates = angular.module(#{module_name}, []));
-
-window.AngularRailsTemplates.run(["$templateCache",function($templateCache) {
-  $templateCache.put(#{path.inspect}, #{data.to_json});
-}]);
-      }
+    def compress html
+      unless @@compressor
+        @@compressor = HtmlCompressor::Compressor.new configuration.htmlcompressor
+      end
+      @@compressor.compress(html)
     end
-
   end
 end
 

data/lib/angular-rails-templates/version.rb

@@ -1,3 +1,3 @@
 module AngularRailsTemplates
-  VERSION = '0.0.7'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: angular-rails-templates
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Damien Mathieu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -39,6 +39,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: uglifier
   requirement: !ruby/object:Gem::Requirement
@@ -55,7 +83,7 @@ dependencies:
         version: '0'
 description: 
 email:
-- 42@dmathieu.com
+- pitr.vern@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -63,10 +91,9 @@ files:
 - LICENSE
 - README.md
 - lib/angular-rails-templates.rb
-- lib/angular-rails-templates/base_template.rb
+- lib/angular-rails-templates/compact_javascript_escape.rb
 - lib/angular-rails-templates/engine.rb
-- lib/angular-rails-templates/haml_template.rb
-- lib/angular-rails-templates/slim_template.rb
+- lib/angular-rails-templates/javascript_template.js.erb
 - lib/angular-rails-templates/template.rb
 - lib/angular-rails-templates/version.rb
 homepage: https://github.com/pitr/angular-rails-templates

data/lib/angular-rails-templates/base_template.rb

@@ -1,29 +0,0 @@
-require 'forwardable'
-
-module AngularRailsTemplates
-  BaseTemplate = Struct.new(:context) do
-    extend Forwardable
-
-    def_delegators :context, :file, :data, :require_template_library
-
-    def initialize_engine ; end
-
-    def render
-      initialize_engine
-      engine.render
-    end
-
-    protected
-
-    NoEngine = Struct.new(:data) do
-      def render
-        data
-      end
-    end
-
-    def engine
-      @engine ||= NoEngine.new(data)
-    end
-  end
-end
-

data/lib/angular-rails-templates/haml_template.rb

@@ -1,14 +0,0 @@
-module AngularRailsTemplates
-  class HamlTemplate < BaseTemplate
-    def initialize_engine
-      require_template_library 'haml'
-    end
-
-    protected
-
-    def engine
-      @engine ||= Haml::Engine.new(data)
-    end
-  end
-end
-

data/lib/angular-rails-templates/slim_template.rb

@@ -1,14 +0,0 @@
-module AngularRailsTemplates
-  class SlimTemplate < BaseTemplate
-    def initialize_engine
-      require_template_library 'slim'
-    end
-
-    protected
-
-    def engine
-      @engine ||= Slim::Template.new(file)
-    end
-  end
-end
-