dusty_rails_renderer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96a5b2c4d7d645980609114ba0f3a028809f236e
+  data.tar.gz: efc59e3e7b2fdce9413de47e3790c619483e84ba
+SHA512:
+  metadata.gz: fd42c98a9ff1442ff9eb8762c5f7de09be0c086a1e1d5cc3af945da38fb97e4e0ffa8fbcd25711fe6945988e846912540a9fa38d6fcaf7a061c5ee37d90b0da7
+  data.tar.gz: 0267b8ace8aa716cd1d77592857947609eba1be046f9410230b188a2fefc79c7d9c3c56545e2ccbef0651469fbf58e8c1c3834c77a81621f2c237819c4f1d59c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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,113 @@
+# Dusty Rails Renderer
+
+Dusty Rails Renderer was written to make it easy to render dust.js templates server side. Please refer to <a href="www.dustjs.com">www.dustjs.com</a> for documentation on using Dust.js. This gem requires Dust.js by LinkedIn
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dusty_rails_renderer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dusty_rails_renderer
+
+## Configuration
+
+Run:
+
+	$ rails generate dusty_rails_renderer:install
+
+This will create an initializer for dusty_rails_renderer at 'config/initializers/dust_initializer.rb'. 
+
+## Defaults
+
+dust_initializer.rb
+
+	$ DustyRailsRenderer.configure do |config|
+	$ 	config.dust_config_path = 'config/dust_initializer.yml'
+	$ 	config.dust_js_library_path = 'app/assets/javascripts/libraries/dust/dust-full.js'
+	$ 	config.dust_template_base_path = 'app/assets/javascripts/dust/'
+	$ 	config.production = false	  
+	$ end
+
+	$ DustyRailsRenderer.initialize
+
+
+By configuring the initializer you can update the location of your Dust templates and Dust.js library. For this gem to work property you must use the full Dust library that includes the compiler. Lastly, setting config.production = false will enable loading from disk and precompiling during request time. This
+feature is great for debugging and creating new templates but not for production. Setting config.production = true will precompile the templates once
+during the server initialization process and load the templates into memory.
+
+## Usage
+
+Add reference to all your Dust.js templates in config.dust/initializer.yml. Templates names must be unique. file_path is the reference to your Dust.js templates
+inside the dust_template_base_path. For example using the default dusty_rails_renderer configuration 'common/header.dust' would be in 'app/assets/javascripts/dust/common/header.dust'
+
+dust_initializer.yml
+
+	header:
+  		file_path: common/header.dust
+  		name: common_header
+	home:
+  		file_path: home/home.dust
+  		name: home
+
+Lastly, to render Dust.js templates server side in your controllers, call  
+	
+	$	DustyRailsRenderer.render('{TEMPLATE_NAME_HERE}',"{JSON_HERE}"). 
+
+Example
+
+	$	render :text =>  DustyRailsRenderer.render('home',"{name: 'Louis'}") , :layout => "application"
+
+Client-Side
+
+To use your precompiled templates on the client-side you can pass the precompiled templates into javascript.
+
+	$	<script type="text/javascript">
+	$		var precompiled_templates = <%= raw DustyRailsRenderer.templates %>;
+	$	</script>
+
+Include the dust.js(full library by LinkedIn) then register and render templates
+
+	$	<script type="text/javascript">
+	$		var Utils = {
+	$			load_templates: function() {
+	$    			for(var key in precompile_templates) {
+	$	  	  			dust.loadSource(precompile_templates[key], key);
+	$    			}
+	$			} 
+	$		    , render_template: function(template_name, json) { 
+	$				return (function() {
+	$					var result = '';
+	$	   				dust.render(template_name, json, function(err,out) {
+	$						result = out;
+	$					});
+	$					return result;
+	$				})();
+	$			}
+	$		}
+	$
+	$		Utils.load_templates(precompiled_templates);
+	$		Utils.render_template('{TEMPLATE_NAME_HERE}',"{JSON_HERE}");
+	$	</script>
+
+## Who wrote Dusty Rails Renderer?
+
+My name is <a href="http://louisellis.com/">Louis Ellis</a> and I wrote Dust Rails Renderer in October 2015.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ellisapps/dusty_rails_renderer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the <a href="http://contributor-covenant.org">Contributor Covenant</a> code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dusty_rails_renderer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dusty_rails_renderer.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dusty_rails_renderer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dusty_rails_renderer"
+  spec.version       = DustyRailsRenderer::VERSION
+  spec.authors       = "Louis Ellis"
+  spec.email         = "Louis.f.ellis@gmail.com"
+
+  spec.summary       = "Render Dust server side"
+  spec.description   = "Render Dust server side"
+  spec.homepage      = "http://louisellis.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/dusty_rails_renderer/version.rb

@@ -0,0 +1,3 @@
+module DustyRailsRenderer
+  VERSION = "0.1.0"
+end

data/lib/dusty_rails_renderer.rb

@@ -0,0 +1,72 @@
+require "singleton"
+require "dusty_rails_renderer/version"
+
+module DustyRailsRenderer
+  class << self
+  	include Singleton
+   	attr_writer :configuration
+
+    #Initialize, load Dust.js library, and precompile Dust.js templates
+   	def initialize
+   		@dust_config = YAML.load_file(self.configuration.dust_config_path)
+   		dust_library = File.read(self.configuration.dust_js_library_path)
+	    @precompiled_templates = Hash.new
+   		@context = V8::Context.new
+	    @context.eval(dust_library, 'dustjs') 
+
+	    read_dust_files
+   	end
+
+    #Return precompiled templates in JSON format (Client-side)
+	  def templates
+	    @precompiled_templates.to_json
+	  end
+
+    #Render template registered Dust.js template
+   	def render(template_name, json) 
+		  if self.configuration.production
+	  		@context.eval("(function() { var result; dust.render('#{template_name}', #{json}, function(err, out) { result = out; }); return result; })()")
+	  	else 
+	  		read_dust_files
+	  		@context.eval("(function() { var result; dust.render('#{template_name}', #{json}, function(err, out) { result = out; }); return result; })()")
+	  	end
+   	end
+
+   	private 
+      
+      #Read in and register Dust.js templates
+   	  def read_dust_files
+  	    @dust_config.each do |template, info|
+	      file_url = self.configuration.dust_template_base_path + info["file_path"]
+	      template_name = info["name"]
+	      contents = File.read(file_url).gsub("\n","").gsub("\"","'").gsub("\t","")
+	      template = @context.eval("dust.compile(\"#{contents}\",'#{template_name}')")
+	      @context.eval("dust.loadSource(dust.compile(\"#{contents}\",'#{template_name}'))")
+	      @precompiled_templates[template_name] = template
+  	    end
+      end 
+  end
+  
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :dust_config_path
+    attr_accessor :dust_js_library_path
+    attr_accessor :production
+    attr_accessor :dust_template_base_path
+
+    def initialize
+ 	  @dust_config_path = "config/dust_initializer.yml"
+	  @dust_js_library_path = "app/assets/javascripts/libraries/dust/dust-full.js"
+	  @dust_template_base_path = "app/assets/javascripts/dust/"
+	  @production = false	  
+    end
+  end
+
+end

data/lib/generators/dusty_rails_renderer/install_generator.rb

@@ -0,0 +1,15 @@
+module DustyRailsRenderer
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+    	def copy_initializer
+    		File.open(File.join('config/initializers', 'dust_initializer.rb'), 'w') do |f|
+    			f.puts "DustyRailsRenderer.configure do |config|"
+    			f.puts "\n"
+    			f.puts "end"
+    			f.puts "\n"
+  				f.puts "DustyRailsRenderer.initialize"
+			end
+    	end
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: dusty_rails_renderer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Louis Ellis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Render Dust server side
+email: Louis.f.ellis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dusty_rails_renderer.gemspec
+- lib/dusty_rails_renderer.rb
+- lib/dusty_rails_renderer/version.rb
+- lib/generators/dusty_rails_renderer/install_generator.rb
+homepage: http://louisellis.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.0
+signing_key: 
+specification_version: 4
+summary: Render Dust server side
+test_files: []