liquid_assets 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'liquid'
+gem 'tilt'
+gem 'sprockets'
+gem 'execjs'
+
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rdoc"
+  gem "bundler"
+  gem "jeweler"
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    execjs (1.4.0)
+      multi_json (~> 1.0)
+    git (1.2.5)
+    hike (1.2.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    liquid (2.5.0)
+    multi_json (1.6.1)
+    rack (1.5.2)
+    rake (10.0.3)
+    rdoc (4.0.0)
+      json (~> 1.4)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  execjs
+  jeweler
+  liquid
+  rdoc
+  sprockets
+  tilt

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Nathan Stitt
+
+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,160 @@
+# liquid_assets version 0.1.0
+
+## Description
+
+Allows you to use the Liquid template language in Rails, both as
+templates and as JavaScript via the asset_pipeline.
+
+**Warning!** This is very rough, and only minimally tested.  Version
+  0.1 really does mean 0.1 in this case!
+
+Although I'm going to attempt to minimize breaking changes, there may
+be a few as I discover bugs and/or better methods of implementing
+features.
+
+My future goals for it are to add template inheritance/override
+support and read template's from active_record. *(probably via a
+supplied Proc)*
+
+The Ruby bits are via the standard Liquid http://liquidmarkup.org/
+gem.
+
+The JavaScript support is possible through the TinyLiquid
+https://github.com/leizongmin/tinyliquid JavaScript library, which
+execjs calls to compiles the templates to JavaScript.  I did have to
+perform a few small modifications to the library in order to get it to
+support partials in the same manner as the Ruby library
+
+## Rationale
+I am currently developing a largish project that has a requirement for
+user edited html that needs to be rendered both as a standard website
+and as a single page Backbone application.
+
+I'd originally attempted to use Mustache templates but discarded that
+idea after not being able to do simple things like formatting numbers
+in the views.
+
+Liquid templates were ideal, but they lacked a suitable JS
+environment.  I then ran across the TinyLiquid project and decided to
+create a gem to unite the two.
+
+
+## Usage
+
+Set the root in an initializer, i.e. config/initializers/liquid_assets.rb
+The root defaults to app/assets/templates.
+
+     LiquidAssets::Config.configure do |config|
+         config.path_prefix        = 'app/assets/templates'
+         config.filters            = MyFilterModule
+         config.template_namespace = 'LQT'
+     end
+
+
+### Use as Rails views
+
+Create a view just like you would with erb, except with .liquid as the extension.
+
+    app/assets/templates/blog/post.liquid
+
+Since the template is written in Liquid, it DOES NOT have access to
+the normal rails helper methods.
+
+It does have access to instance variables, but can only interact with
+simple Strings, Numbers, Arrays, & Hashes. An additional restriction
+is that Hashes must use strings for keys, not symbols.
+
+I'm sure some of these limitations could be worked around, but my
+needs do not include supporting them at this time.  *Patches are welcomed*
+
+
+By default the filters are set to the Liquid::StandardFilters
+http://liquid.rubyforge.org/classes/Liquid/StandardFilters.html This
+can be changed by including a liquid_filters method on the controller,
+or in application_controller to set system-wide. *(assuming you are
+inheriting from it)*
+
+A short example:
+
+blog_controller.rb:
+
+    def show
+        @ages={'bob'=>28,'joe'=>23}
+        render :template=>'blog/post'
+    end
+
+app/assets/templates/blog/post.liquid :
+
+     Bob is {{ages.bob}}, older than Joe - who's only {{ages.joe}}.
+
+But this will not since @bob is not a hash.
+
+controller:
+
+    def show
+        @old=People.where({:name=>'bob',:age=>100}).first
+        render :template=>'blog/post'
+    end
+
+(contrived) liquid view:
+
+     Bob's age is {{old.age}}
+
+**Hint:** To get it to work, call as_json on your models:
+
+    @old=People.where({:name=>'bob',:age=>100}).first.as_json
+
+
+### Use as AssetPipeline pre-compiled javascript
+
+You can include your liquid templates in the asset_pipeline by
+using the standard //=  syntax in one of your existing JavaScript files
+
+//=require liquid_assets
+//=require templates/blog/post
+
+Will compile post.liquid to JavaScript using TinyLiquid and include it like so
+
+    LQT['templates/blog/post'] = function(locals,filters){ ... }
+
+It can be used similar to underscore's JST template.
+
+With filters:
+
+      LQT['templates/blog/post']( { bob:{ age: 23 } }, {
+         plusTen: function(num){  return num+10; }
+      })
+
+Template:
+
+     Bob will be {{bob.age | plusTen}} in ten years.
+
+Renders to:
+     Bob will be 33 in ten years.
+
+The LQT namespace is short for LiQuid Template, à la JST from underscore.
+
+It can be modified by configuring:
+
+     LiquidAssets::Config.configure do |config|
+         config.template_namespace = 'FANCY_NAME'
+     end
+
+## Thanks
+
+[Shopify](http://www.shopify.com/)
+for creating the liquid template language and Ruby implementation.  [leizongmin](https://github.com/leizongmin/tinyliquid) for the
+tinyliquid Javascript support.
+
+I cribbed from [hogan_assets](https://github.com/leshill/hogan_assets/), [Poirot](https://github.com/olivernn/poirot) and [Stache](https://github.com/agoragames/stache/) in creating this gem.  Good parts
+are thanks to those projects, mistakes are mine.
+
+
+## Contributing
+Fork on [github](https://github.com/nathanstitt/liquid_assets), implement your change, submit a pull request.
+
+
+## Copyright
+
+Copyright (c) 2013 Nathan Stitt. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+    gem.name = "liquid_assets"
+    gem.homepage = "http://github.com/nathanstitt/liquid_assets"
+    gem.license = "MIT"
+    gem.summary = %Q{Liquid formmated views and assets}
+    gem.description = %Q{Allows you to use Liquid format templates in Rails, both as
+view templates and as compiled JavaScript via the asset_pipeline.}
+    gem.email = "nathan@stitt.org"
+    gem.authors = ["Nathan Stitt"]
+    # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+    version = File.exist?('VERSION') ? File.read('VERSION') : ""
+    rdoc.main = 'README.md'
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "liquid_assets #{version}"
+    rdoc.rdoc_files.include('README.md')
+    rdoc.rdoc_files.include('lib/liquid_assets/config.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/liquid_assets/config.rb

@@ -0,0 +1,102 @@
+require 'yaml'
+
+module LiquidAssets
+  # Change config options in an initializer:
+  #
+  #   LiquidAssets::Config.template_namespace = 'LT'
+  #
+  # Or in a block:
+  #
+  #   LiquidAssets::Config.configure do |config|
+  #      config.path_prefix        = 'app/assets/templates'
+  #      config.filters            = MyFilterModule
+  #      config.template_namespace = 'LQT'
+  #   end
+  #
+  # Or change config options in a YAML file (config/liquid_assets.yml):
+  #
+  #   defaults: &defaults
+  #     path_prefix: 'templates'
+  #     template_namespace: 'LQT'
+  #   development:
+  #     <<: *defaults
+  #   test:
+  #     <<: *defaults
+  #   production:
+  #     <<: *defaults
+
+  module Config
+    extend self
+
+      # The environment.  Defaults to Rails.env if Rails is detected, otherwise to 'development'
+      attr_writer :env
+      # Directory to read templates from.  Default = app/assets/templates
+      attr_writer :path_prefix
+      # The name of the global JS object that will contain the templates.  Defaults = LQT
+      attr_writer :template_namespace
+      # A Ruby module implementing the Liquid Filters that are accessible when templates are evaluated as views
+      # Javascript filters must be passed as the second parameter given when evaluating a precompiled template
+      attr_writer :filters
+
+    def configure
+      yield self
+    end
+
+    def env
+      @env ||= if defined? Rails
+                 Rails.env
+               elsif ENV['RACK_ENV']
+                 ENV['RACK_ENV']
+               else
+                 'development'
+               end
+    end
+
+    def load_yml!
+      @path_prefix         = yml['path_prefix'] if yml.has_key? 'path_prefix'
+      @template_namespace  = yml['template_namespace'] if yml.has_key? 'template_namespace'
+    end
+
+    def path_prefix
+        @path_prefix ||= File.join('app','assets','templates')
+    end
+
+    def root_path
+        if defined? Rails
+            Rails.root
+        else
+            Pathname.new('.')
+        end
+    end
+    def filters
+        @filters ||= Liquid::StandardFilters
+    end
+    def template_namespace
+      @template_namespace ||= 'LQT'
+    end
+
+    def yml
+      begin
+        @yml ||= (YAML.load(IO.read yml_path)[env] rescue nil) || {}
+      rescue Psych::SyntaxError
+        @yml = {}
+      end
+    end
+
+    def yml_exists?
+      File.exists? yml_path
+    end
+
+    private
+
+    def symbolize(hash)
+      hash.keys.each do |key|
+        hash[(key.to_sym rescue key) || key] = hash.delete(key)
+      end
+    end
+
+    def yml_path
+        @yml_path ||= root_path.join 'config', 'liquid_assets.yml'
+    end
+  end
+end

data/lib/liquid_assets/engine.rb

@@ -0,0 +1,25 @@
+require 'liquid_assets/tilt_engine'
+
+module LiquidAssets
+
+    class Engine < ::Rails::Engine
+
+        initializer "sprockets.liquid_assets", :after => "sprockets.environment", :group => :all do |app|
+            next unless app.assets
+
+            LiquidAssets::Config.load_yml! if LiquidAssets::Config.yml_exists?
+
+
+            ActionView::Template.register_template_handler(:liquid, LiquidAssets::TemplateHandler )
+
+            app.assets.register_engine(".liquid", ::LiquidAssets::TiltEngine )
+
+            app.config.to_prepare do
+                Liquid::Template.file_system = Liquid::LocalFileSystem.new( Config.root_path )
+                ApplicationController.send( :append_view_path, LiquidAssets::Config.path_prefix )
+            end
+        end
+
+    end
+
+end

data/lib/liquid_assets/template_handler.rb

@@ -0,0 +1,52 @@
+require 'liquid'
+
+module LiquidAssets
+
+
+    class TemplateHandler
+
+        def self.call(template)
+            # view_path = "#{template.virtual_path}_view"
+            # abs_view_path = Rails.root.join('app/views', view_path)
+            # Rails.logger.warn "looking for: #{abs_view_path}"
+            return "LiquidAssets::TemplateHandler.new(self).render(#{template.source.inspect}, local_assigns)"
+        end
+
+        def initialize(view)
+            @view = view
+        end
+
+        def render(template, local_assigns = {})
+            @view.controller.headers["Content-Type"] ||= 'text/html; charset=utf-8'
+
+            assigns = @view.assigns
+
+            if content = @view.content_for?(:layout)
+                assigns["content_for_layout"] = content
+            end
+            assigns.merge!(local_assigns.stringify_keys)
+
+            controller = @view.controller
+            filters = if controller.respond_to?(:liquid_filters, true)
+                          controller.send(:liquid_filters)
+                      else
+                          Config.filters
+                      end
+
+            liquid = ::Liquid::Template.parse(template)
+            liquid.render(assigns,
+                          :filters => filters,
+                          :registers => {
+                              :action_view => @view,
+                              :controller => @view.controller
+                          } ).html_safe
+        end
+
+        def compilable?
+            false
+        end
+
+
+    end
+
+end

data/lib/liquid_assets/tilt_engine.rb

@@ -0,0 +1,54 @@
+require 'tilt'
+
+module LiquidAssets
+
+    class TiltEngine < Tilt::Template
+
+        self.default_mime_type = 'application/javascript'
+
+        # def initialize_engine
+        # end
+
+        def evaluate(scope, locals, &block)
+
+            template_path = TemplatePath.new scope
+            template_namespace = LiquidAssets::Config.template_namespace
+
+            compiled_template = TinyLiquid.compile(data)
+
+            <<-TEMPLATE
+                this.#{template_namespace} || (this.#{template_namespace} = {});
+                this.#{template_namespace}[#{template_path.name}] = #{compiled_template};
+            TEMPLATE
+        end
+
+        protected
+
+
+        def prepare;
+            # NOOP
+        end
+
+        class TemplatePath
+            attr_accessor :full_path
+
+            def initialize(scope)
+                self.template_path = scope.logical_path
+                self.full_path = scope.pathname
+            end
+
+            def name
+                @name ||= relative_path.dump
+            end
+
+            private
+
+            attr_accessor :template_path
+
+            def relative_path
+                @relative_path ||= template_path.gsub(/^#{LiquidAssets::Config.path_prefix}\/(.*)$/i, "\\1")
+            end
+        end
+    end
+
+end

data/lib/liquid_assets/tiny_liquid.rb

@@ -0,0 +1,41 @@
+# Based on https://github.com/josh/ruby-coffee-script
+require 'execjs'
+require 'pathname'
+
+module LiquidAssets
+
+  class TinyLiquid
+
+      class << self
+          def compile(source, options = {})
+              js = context.eval("TinyLiquid.parse(#{source.inspect},{partials_namespace:'#{Config.template_namespace}'}).code")
+#              js = context.eval("TinyLiquid.compile(#{source.inspect}, {original: true}).toString()")
+              "function(locals,filters){
+var $_tmpbuf, $_html = LQT._FNS.html, $_err = LQT._FNS.err, $_rethrow=LQT._FNS.rethrow, $_merge=LQT._FNS.merge, $_range=LQT._FNS.range, $_array=LQT._FNS.array;
+#{js}
+return $_buf;
+}"
+          end
+
+          private
+
+          def context
+              @context ||= ExecJS.compile(source)
+          end
+
+          def source
+              @source ||= path.read
+          end
+
+          def path
+              @path ||= assets_path.join('tinyliquid.js')
+          end
+
+          def assets_path
+              @assets_path ||= Pathname(__FILE__).dirname.join('..','..','vendor')
+          end
+      end
+
+  end
+
+end

data/lib/liquid_assets/version.rb

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

data/lib/liquid_assets.rb

@@ -0,0 +1,21 @@
+require 'liquid_assets/version'
+require 'liquid_assets/config'
+require 'liquid_assets/template_handler'
+require 'liquid_assets/tilt_engine'
+module LiquidAssets
+
+    extend Config
+
+    autoload :TinyLiquid, 'liquid_assets/tiny_liquid'
+    autoload :TiltEngine, 'liquid_assets/tilt_engine'
+
+    if defined? Rails
+        require 'liquid_assets/engine'
+    else
+        require 'sprockets'
+        Config.load_yml! if Config.yml_exists?
+
+        Sprockets.register_engine ".liquid", Tilt
+
+    end
+end

data/liquid_assets.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "liquid_assets"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathan Stitt"]
+  s.date = "2013-03-14"
+  s.description = "Allows you to use Liquid format templates in Rails, both as\nview templates and as compiled JavaScript via the asset_pipeline."
+  s.email = "nathan@stitt.org"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/liquid_assets.rb",
+    "lib/liquid_assets/config.rb",
+    "lib/liquid_assets/engine.rb",
+    "lib/liquid_assets/template_handler.rb",
+    "lib/liquid_assets/tilt_engine.rb",
+    "lib/liquid_assets/tiny_liquid.rb",
+    "lib/liquid_assets/version.rb",
+    "liquid_assets.gemspec",
+    "test/helper.rb",
+    "test/test_liquid_assets.rb",
+    "vendor/assets/javascripts/liquid_assets.js",
+    "vendor/tinyliquid.js"
+  ]
+  s.homepage = "http://github.com/nathanstitt/liquid_assets"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "Liquid formmated views and assets"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<liquid>, [">= 0"])
+      s.add_runtime_dependency(%q<tilt>, [">= 0"])
+      s.add_runtime_dependency(%q<sprockets>, [">= 0"])
+      s.add_runtime_dependency(%q<execjs>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<liquid>, [">= 0"])
+      s.add_dependency(%q<tilt>, [">= 0"])
+      s.add_dependency(%q<sprockets>, [">= 0"])
+      s.add_dependency(%q<execjs>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<liquid>, [">= 0"])
+    s.add_dependency(%q<tilt>, [">= 0"])
+    s.add_dependency(%q<sprockets>, [">= 0"])
+    s.add_dependency(%q<execjs>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+