dotjs_sprockets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea75be79e483ce16dbf8f103172dafd2d80d9809
+  data.tar.gz: 4b0bfea0a2fc5c6a80d1ff5eb5e1241057c5e6cf
+SHA512:
+  metadata.gz: 13d8f3f92bd3d73bab36f423749246d24ef1024a601c3a5125125c574f10074cfbe1dd72819624c011ddddedd7a9c0ec68d92ca927ec43b782f4f196212d52f9
+  data.tar.gz: 699412f42c05219bd043668a2b3ead4697a9b86d3fec6eb65286920f45c69bd4cf97267b42dbb1ad1463b372e20d149c973e43be2e90e7c19a46f22ffdd9beda

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Roberto Dip
+
+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,61 @@
+# DotjsSprockets
+
+[![Code Climate](https://codeclimate.com/github/roperzh/dotjs_sprockets.png)](https://codeclimate.com/github/roperzh/dotjs_sprockets)
+[![Inline docs](http://inch-ci.org/github/roperzh/dotjs_sprockets.png?branch=master)](http://inch-ci.org/github/roperzh/dotjs_sprockets)
+
+[doT.js](https://github.com/olado/doT) templates for any application using [sprockets](https://github.com/sstephenson/sprockets).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+ gem "dotjs-sprockets"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+To get your template loaded and accessible client-side via the JST variable, you must follow:
+
+- The template file must be under one of the Sprockets load paths ( usually `assets/javascripts` or `assets/templates` )
+- The template must have the following extension: `.jst.djs`
+
+That's all!
+
+***Example***
+
+```
+app/
+└── assets/
+    └── javascripts/
+        └── my_template.jst.djs
+```
+
+In this case the template will be accessible in the client via:
+
+```javascript
+// The compiler function
+JST["my_template"] //=> function() ...
+
+//The compiled template
+JST["my_template"]() //=> <h2>Hello!</h2> ...
+```
+
+## Roadmap
+
+- Provide an easy way to change the `djs` extension
+- Check support and compatibility for nested templates
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dotjs-sprockets/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/dotjs_sprockets.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dotjs_sprockets/constants'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dotjs_sprockets"
+  spec.version       = DotjsSprockets::VERSION
+  spec.authors       = ["Roberto Dip"]
+  spec.email         = ["dip.jesusr@gmail.com"]
+  spec.summary       = %q{doT.js templates for sprockets.}
+  spec.description   = %q{doT.js templates for sprockets powered by ExecJS.}
+  spec.homepage      = "https://github.com/roperzh/dotjs_sprockets"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake",    "~> 0"
+
+  spec.add_runtime_dependency "sprockets", "~> 2"
+  spec.add_runtime_dependency "execjs",    "~> 2"
+end

data/lib/dotjs_sprockets/constants.rb

@@ -0,0 +1,22 @@
+# Configuration constants, all of these are accessible from outside
+#
+# @since 0.1.0
+module DotjsSprockets
+  # Local gem assets
+  #
+  # Version 0.1.0 includes doT.js v1.0.1
+  ASSETS_PATH = "../../../vendor/assets/javascripts/dotjs_sprockets"
+
+  # Extension for the templates, sprockets will find and precompile all files
+  # with DotjsSprockets::EXTENSION
+  #
+  # This can be changed from the outside:
+  #
+  # DotjsSprockets::EXTENSION = ".dotjs"
+  #
+  # @since 0.1.0
+  EXTENSION   = ".djs"
+
+  # Current version
+  VERSION     = "0.1.0"
+end

data/lib/dotjs_sprockets/engine.rb

@@ -0,0 +1,58 @@
+require "execjs"
+
+module DotjsSprockets
+
+  # The engine class is in charge to handle the template compilation
+  # via ExecJS, provides a clean interface to be used by the TiltDot class
+  #
+  # @since 0.1.0
+  class Engine
+    class << self
+
+      # Given a path to a template it returns the compiled version
+      #
+      # @param full_path [String] the template full path
+      #
+      # @return [String] JavaScript function that may be directly executed client-side
+      #
+      # @example Compiling a Template
+      #   DotjsSprockets::Engine.precompile("/my/template.jst.djs")
+      #   # => "function()...."
+      #
+      # @since 0.1.0
+      def precompile(full_path)
+        template = open(full_path).read.chomp
+        context.eval("doT.compile('#{template}').toString()")
+      end
+
+    private
+
+      # Stores a ExecJS context instance
+      #
+      # @return [ExecJS::ExternalRuntime::Context]
+      #
+      # @since 0.1.0
+      def context
+        @context ||= ExecJS.compile(source)
+      end
+
+      # Stores the full path of the library source (doT.js)
+      #
+      # @return [String] full path of the doT.js library
+      #
+      # @since 0.1.0
+      def path
+        @path ||= File.expand_path(DotjsSprockets::ASSETS_PATH, __FILE__)
+      end
+
+      # Stores the contents of the library source (doT.js)
+      #
+      # @return [String] full content of the doT.js library
+      #
+      # @since 0.1.0
+      def source
+        @source ||= open("#{path}/doT.js").read
+      end
+    end
+  end
+end

data/lib/dotjs_sprockets/tilt_dot.rb

@@ -0,0 +1,37 @@
+require "tilt"
+
+module DotjsSprockets
+  # New tilt template declaration, from the tilt docs:
+  # Base class for template implementations Subclasses must implement
+  # the #prepare method and one of the #evaluate or #precompiled_template
+  # methods.
+  #
+  # More info here: https://github.com/rtomayko/tilt/blob/master/lib/tilt/template.rb
+  #
+  # @since 0.1.0
+  class TiltDot < Tilt::Template
+    # Define the mime type of the template
+    #
+    # @since 0.1.0
+    def self.default_mime_type
+      "application/javascript"
+    end
+
+    # Required method definition in order to implement the Tilt::Template
+    # interface
+    #
+    # @since 0.1.0
+    def prepare
+    end
+
+    # Execute the compiled template and return the result string
+    #
+    # @return [String] the compiled template
+    #
+    # @since 0.1.0
+    def evaluate(scope, locals, &block)
+      template_name = scope.pathname
+      DotjsSprockets::Engine.precompile(template_name)
+    end
+  end
+end

data/lib/dotjs_sprockets.rb

@@ -0,0 +1,5 @@
+require "dotjs_sprockets/constants"
+require "dotjs_sprockets/engine"
+require "dotjs_sprockets/tilt_dot"
+
+Sprockets.register_engine ::DotjsSprockets::EXTENSION, DotjsSprockets::TiltDot

data/vendor/assets/javascripts/dotjs_sprockets/doT.js

@@ -0,0 +1,136 @@
+// doT.js
+// 2011, Laura Doktorova, https://github.com/olado/doT
+// Licensed under the MIT license.
+
+(function() {
+  "use strict";
+
+  var doT = {
+    version: '1.0.1',
+    templateSettings: {
+      evaluate:    /\{\{([\s\S]+?(\}?)+)\}\}/g,
+      interpolate: /\{\{=([\s\S]+?)\}\}/g,
+      encode:      /\{\{!([\s\S]+?)\}\}/g,
+      use:         /\{\{#([\s\S]+?)\}\}/g,
+      useParams:   /(^|[^\w$])def(?:\.|\[[\'\"])([\w$\.]+)(?:[\'\"]\])?\s*\:\s*([\w$\.]+|\"[^\"]+\"|\'[^\']+\'|\{[^\}]+\})/g,
+      define:      /\{\{##\s*([\w\.$]+)\s*(\:|=)([\s\S]+?)#\}\}/g,
+      defineParams:/^\s*([\w$]+):([\s\S]+)/,
+      conditional: /\{\{\?(\?)?\s*([\s\S]*?)\s*\}\}/g,
+      iterate:     /\{\{~\s*(?:\}\}|([\s\S]+?)\s*\:\s*([\w$]+)\s*(?:\:\s*([\w$]+))?\s*\}\})/g,
+      varname:  'it',
+      strip:    true,
+      append:   true,
+      selfcontained: false
+    },
+    template: undefined, //fn, compile template
+    compile:  undefined  //fn, for express
+  }, global;
+
+  if (typeof module !== 'undefined' && module.exports) {
+    module.exports = doT;
+  } else if (typeof define === 'function' && define.amd) {
+    define(function(){return doT;});
+  } else {
+    global = (function(){ return this || (0,eval)('this'); }());
+    global.doT = doT;
+  }
+
+  function encodeHTMLSource() {
+    var encodeHTMLRules = { "&": "&#38;", "<": "&#60;", ">": "&#62;", '"': '&#34;', "'": '&#39;', "/": '&#47;' },
+      matchHTML = /&(?!#?\w+;)|<|>|"|'|\//g;
+    return function() {
+      return this ? this.replace(matchHTML, function(m) {return encodeHTMLRules[m] || m;}) : this;
+    };
+  }
+  String.prototype.encodeHTML = encodeHTMLSource();
+
+  var startend = {
+    append: { start: "'+(",      end: ")+'",      endencode: "||'').toString().encodeHTML()+'" },
+    split:  { start: "';out+=(", end: ");out+='", endencode: "||'').toString().encodeHTML();out+='"}
+  }, skip = /$^/;
+
+  function resolveDefs(c, block, def) {
+    return ((typeof block === 'string') ? block : block.toString())
+    .replace(c.define || skip, function(m, code, assign, value) {
+      if (code.indexOf('def.') === 0) {
+        code = code.substring(4);
+      }
+      if (!(code in def)) {
+        if (assign === ':') {
+          if (c.defineParams) value.replace(c.defineParams, function(m, param, v) {
+            def[code] = {arg: param, text: v};
+          });
+          if (!(code in def)) def[code]= value;
+        } else {
+          new Function("def", "def['"+code+"']=" + value)(def);
+        }
+      }
+      return '';
+    })
+    .replace(c.use || skip, function(m, code) {
+      if (c.useParams) code = code.replace(c.useParams, function(m, s, d, param) {
+        if (def[d] && def[d].arg && param) {
+          var rw = (d+":"+param).replace(/'|\\/g, '_');
+          def.__exp = def.__exp || {};
+          def.__exp[rw] = def[d].text.replace(new RegExp("(^|[^\\w$])" + def[d].arg + "([^\\w$])", "g"), "$1" + param + "$2");
+          return s + "def.__exp['"+rw+"']";
+        }
+      });
+      var v = new Function("def", "return " + code)(def);
+      return v ? resolveDefs(c, v, def) : v;
+    });
+  }
+
+  function unescape(code) {
+    return code.replace(/\\('|\\)/g, "$1").replace(/[\r\t\n]/g, ' ');
+  }
+
+  doT.template = function(tmpl, c, def) {
+    c = c || doT.templateSettings;
+    var cse = c.append ? startend.append : startend.split, needhtmlencode, sid = 0, indv,
+      str  = (c.use || c.define) ? resolveDefs(c, tmpl, def || {}) : tmpl;
+
+    str = ("var out='" + (c.strip ? str.replace(/(^|\r|\n)\t* +| +\t*(\r|\n|$)/g,' ')
+          .replace(/\r|\n|\t|\/\*[\s\S]*?\*\//g,''): str)
+      .replace(/'|\\/g, '\\$&')
+      .replace(c.interpolate || skip, function(m, code) {
+        return cse.start + unescape(code) + cse.end;
+      })
+      .replace(c.encode || skip, function(m, code) {
+        needhtmlencode = true;
+        return cse.start + unescape(code) + cse.endencode;
+      })
+      .replace(c.conditional || skip, function(m, elsecase, code) {
+        return elsecase ?
+          (code ? "';}else if(" + unescape(code) + "){out+='" : "';}else{out+='") :
+          (code ? "';if(" + unescape(code) + "){out+='" : "';}out+='");
+      })
+      .replace(c.iterate || skip, function(m, iterate, vname, iname) {
+        if (!iterate) return "';} } out+='";
+        sid+=1; indv=iname || "i"+sid; iterate=unescape(iterate);
+        return "';var arr"+sid+"="+iterate+";if(arr"+sid+"){var "+vname+","+indv+"=-1,l"+sid+"=arr"+sid+".length-1;while("+indv+"<l"+sid+"){"
+          +vname+"=arr"+sid+"["+indv+"+=1];out+='";
+      })
+      .replace(c.evaluate || skip, function(m, code) {
+        return "';" + unescape(code) + "out+='";
+      })
+      + "';return out;")
+      .replace(/\n/g, '\\n').replace(/\t/g, '\\t').replace(/\r/g, '\\r')
+      .replace(/(\s|;|\}|^|\{)out\+='';/g, '$1').replace(/\+''/g, '')
+      .replace(/(\s|;|\}|^|\{)out\+=''\+/g,'$1out+=');
+
+    if (needhtmlencode && c.selfcontained) {
+      str = "String.prototype.encodeHTML=(" + encodeHTMLSource.toString() + "());" + str;
+    }
+    try {
+      return new Function(c.varname, str);
+    } catch (e) {
+      if (typeof console !== 'undefined') console.log("Could not create a template function: " + str);
+      throw e;
+    }
+  };
+
+  doT.compile = function(tmpl, def) {
+    return doT.template(tmpl, null, def);
+  };
+}());

data/vendor/assets/javascripts/dotjs_sprockets/index.js

@@ -0,0 +1 @@
+//= require dotjs_sprockets/doT

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: dotjs_sprockets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roberto Dip
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: doT.js templates for sprockets powered by ExecJS.
+email:
+- dip.jesusr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dotjs_sprockets.gemspec
+- lib/dotjs_sprockets.rb
+- lib/dotjs_sprockets/constants.rb
+- lib/dotjs_sprockets/engine.rb
+- lib/dotjs_sprockets/tilt_dot.rb
+- vendor/assets/javascripts/dotjs_sprockets/doT.js
+- vendor/assets/javascripts/dotjs_sprockets/index.js
+homepage: https://github.com/roperzh/dotjs_sprockets
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: doT.js templates for sprockets.
+test_files: []