startback 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c343f2a58bb989ce6d4f14f0fe478a0e8b69ac8
-  data.tar.gz: 4ef6a2962120e23b5f4afdd401918a5c8688ac58
+  metadata.gz: a06b0b31cc8840a4dd20381feb44c16a2f7a83dd
+  data.tar.gz: 9cc508e4ac8f662f4bb1a8f60fba6f7fe8b36c82
 SHA512:
-  metadata.gz: 8f3ac41ca8f1bd8ea51ef4d58d868aa0694839ccbbc372a1fa0445c5f20be02c3ff036fed65cbdc24aa0283b37256b54aa16aa5711019891a648bb8c0fab34a3
-  data.tar.gz: db4057a610fd4e8676816bd05892419900f860dbc4b622ca2d34d93702d1a50418d0a43f56105ac1fbd2a2fc46d73d7974aed6d1ffedcab41238c0f5ef40c526
+  metadata.gz: 4936d6d7fc528704900c7178c95c9d9b1ab20befd46080ac1545f49fb56054deb8b3befd68afb426dc751ba3d4c065adf432c94b2b6c9e12a0690da1c5ac98a1
+  data.tar.gz: d652e019cf8c22043bf8688252b89578f71fa73fe0265307105e78dd69473beb9ba36ae79f4e6cc626847aeab8f5616bd881630d957aa32dc0155dbe62114330

data/lib/startback/version.rb

@@ -2,7 +2,7 @@ module Startback
   module Version
     MAJOR = 0
     MINOR = 4
-    TINY  = 0
+    TINY  = 1
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/lib/startback/web/magic_assets.rb

@@ -34,7 +34,8 @@ module Startback
     class MagicAssets
 
       DEFAULT_OPTIONS = {
-        sprockets: {}
+        sprockets: {},
+        plugins: {}
       }
 
       def initialize(app, options = {})
@@ -85,6 +86,9 @@ module Startback
           @options[:sprockets].each_pair do |k,v|
             s.public_send(:"#{k}=", v)
           end
+          @options[:plugins].each do |p|
+            p.install(s)
+          end
         }
       end
 

data/lib/startback/web/magic_assets/ng_html_transformer.rb

@@ -0,0 +1,80 @@
+module Startback
+  module Web
+    class MagicAssets
+      #
+      # Plugin for MagicAssets that compiles .html angular templates in the
+      # assets structure to javascript files filling angular's template cache.
+      #
+      # Heavily inspired, yet over-simplified version, of angular-rails-templates
+      # See https://github.com/pitr/angular-rails-templates, licensed under MIT
+      #
+      # Example:
+      #
+      #   use Startback::Web::MagicAssets, {
+      #     plugins: [Startback::Web::MagicAssets::NgHtmlTransfomer.new]
+      #   }
+      #
+      class NgHtmlTransformer
+
+        DEFAULT_OPTIONS = {
+          :path       => '/assets',
+          :ng_module  => 'templates',
+          :mime_type  => 'text/ng-html',
+          :extensions => [".html"]
+        }
+
+        def initialize(options = {})
+          @options = DEFAULT_OPTIONS.merge(options)
+        end
+        attr_reader :options
+
+        def install(sprockets)
+          sprockets.register_mime_type options[:mime_type], extensions: options[:extensions]
+          sprockets.register_transformer options[:mime_type], 'application/javascript', self
+        end
+
+TPL = <<-EOF
+angular.module("<%= ng_module %>").run(["$templateCache", function($templateCache) {
+  $templateCache.put("<%= angular_template_name %>", <%= html %>)
+}]);
+EOF
+
+        # 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
+
+        def call(input)
+          file_path = input[:filename]
+          angular_template_name = "#{options[:path]}/#{input[:name]}.html"
+          source_file = file_path
+          ng_module = options[:ng_module]
+          html = escape_javascript(input[:data].chomp)
+          ERB.new(TPL).result(binding)
+        end
+
+      end # class NgHtmlTransformer
+    end # class MagicAssets
+  end # module Web
+end # module Startback

data/spec/unit/web/fixtures/assets/app/hello.html

@@ -0,0 +1 @@
+<p>Hello {{who}}</p>

data/spec/unit/web/fixtures/assets/index.es6

@@ -1 +1 @@
-//= require ./app/hello
+//= require_tree ./app

data/spec/unit/web/test_magic_assets.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'startback/web/magic_assets'
+require 'startback/web/magic_assets/ng_html_transformer'
 
 module Startback
   module Web
@@ -21,7 +22,7 @@ module Startback
 
         it 'delegates a [] call to sprockets' do
           result = app['index.js']
-          expect(result.to_s).to match(/function test/)        
+          expect(result.to_s).to match(/function test/)
         end
 
         it 'returns a 404 on unknown' do
@@ -56,6 +57,26 @@ module Startback
         end
       end
 
+      context 'when registering the NgHtmlTransformer' do
+        let(:app){
+          plugin = MagicAssets::NgHtmlTransformer.new({
+            ng_module: "test.templates"
+          })
+          MagicAssets.new({
+            folder: Path.dir/"fixtures/assets",
+            plugins: [plugin]
+          })
+        }
+
+        it 'works as expected' do
+          get "/index.js"
+          expect(last_response.status).to eql(200)
+          expect(last_response.body).to match(/function test/)
+          expect(last_response.body).to match(/Hello \{\{who\}\}/)
+          expect(last_response.body).to match(/angular.module\("test.templates"\)/)
+        end
+      end
+
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: startback
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Bernard Lambeau
@@ -164,6 +164,7 @@ files:
 - lib/startback/web/cors_headers.rb
 - lib/startback/web/health_check.rb
 - lib/startback/web/magic_assets.rb
+- lib/startback/web/magic_assets/ng_html_transformer.rb
 - lib/startback/web/magic_assets/rake_tasks.rb
 - lib/startback/web/shield.rb
 - spec/spec_helper.rb
@@ -171,6 +172,7 @@ files:
 - spec/unit/test_operation.rb
 - spec/unit/test_support.rb
 - spec/unit/web/fixtures/assets/app/hello.es6
+- spec/unit/web/fixtures/assets/app/hello.html
 - spec/unit/web/fixtures/assets/index.es6
 - spec/unit/web/test_auto_caching.rb
 - spec/unit/web/test_catch_all.rb