liquid_assets 0.1.1 → 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05277be46cbe2e2d7d1cce109ca15d5e7ce156cf
+  data.tar.gz: 376327fb4e7fe7c2d6edeff878d530330d54d290
+SHA512:
+  metadata.gz: 390677abed5cd524a34c634b8210a551ddfb0168a8ce8030d14cf315615e9db6d32d5acd8b211b01d7c788ad2185473cef2c45d95252d3ee78eb773cf94cd2f5
+  data.tar.gz: 52236d4d965716c356fd7246c8c64eee782a2758ff4336d5df6f9c1ab563ea97ffa214f4554d22c5aac7ea302b2596cfbb51ace171635d12c45716e2385186ec

data/.gitignore

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

data/Gemfile

@@ -1,18 +1,11 @@
-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'
+source 'https://rubygems.org'
 
+# Specify your gem's dependencies in liquid_assets.gemspec
+gemspec
 
 # 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"
+    gem "rdoc"
+    gem "bundler"
 end

data/Gemfile.lock

@@ -1,37 +1,59 @@
+PATH
+  remote: .
+  specs:
+    liquid_assets (0.3.2)
+      actionpack (>= 3.2)
+      execjs
+      liquid
+      tilt
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    erubis (2.7.0)
     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)
+    i18n (0.6.1)
+    journey (1.0.4)
     liquid (2.5.0)
-    multi_json (1.6.1)
-    rack (1.5.2)
-    rake (10.0.3)
+    multi_json (1.7.2)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.4)
     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)
+    tilt (1.3.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler
-  execjs
-  jeweler
-  liquid
+  liquid_assets!
+  rake
   rdoc
-  sprockets
-  tilt

data/LICENSE.txt

@@ -1,5 +1,7 @@
 Copyright (c) 2013 Nathan Stitt
 
+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

data/README.md

@@ -1,160 +1,29 @@
-# liquid_assets version 0.1.0
+# LiquidAssets
 
-## Description
+TODO: Write a gem description
 
-Allows you to use the Liquid template language in Rails, both as
-templates and as JavaScript via the asset_pipeline.
+## Installation
 
-**Warning!** This is very rough, and only minimally tested.  Version
-  0.1 really does mean 0.1 in this case!
+Add this line to your application's Gemfile:
 
-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.
+    gem 'liquid_assets'
 
-My future goals for it are to add template inheritance/override
-support and read template's from active_record. *(probably via a
-supplied Proc)*
+And then execute:
 
-The Ruby bits are via the standard Liquid http://liquidmarkup.org/
-gem.
+    $ bundle
 
-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.
+Or install it yourself as:
 
+    $ gem install liquid_assets
 
 ## 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.
-
+TODO: Write usage instructions here
 
 ## 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.
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -1,7 +1,8 @@
 # encoding: utf-8
 
 require 'rubygems'
-require 'bundler'
+require 'bundler/gem_tasks'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -11,21 +12,6 @@ rescue Bundler::BundlerError => e
 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'

data/lib/liquid_assets/config.rb

@@ -3,21 +3,23 @@ require 'yaml'
 module LiquidAssets
   # Change config options in an initializer:
   #
-  #   LiquidAssets::Config.template_namespace = 'LT'
+  #   LiquidAssets::Config.namespace = 'LT'
   #
   # Or in a block:
   #
   #   LiquidAssets::Config.configure do |config|
   #      config.path_prefix        = 'app/assets/templates'
   #      config.filters            = MyFilterModule
-  #      config.template_namespace = 'LQT'
+  #      config.namespace = 'LQT'
   #   end
   #
   # Or change config options in a YAML file (config/liquid_assets.yml):
   #
   #   defaults: &defaults
   #     path_prefix: 'templates'
-  #     template_namespace: 'LQT'
+  #     namespace:   'LQT'
+  #     globals:
+  #          company: 'BigCorp Inc'
   #   development:
   #     <<: *defaults
   #   test:
@@ -33,10 +35,23 @@ module LiquidAssets
       # 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
+      attr_writer :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
+      # Javascript filters can be set by modifying the LQT.Filters object.
+      # A set of the standard Shopify filters are provided for both Ruby & Javascript.
+      # https://github.com/Shopify/liquid/wiki/Liquid-for-Designers
       attr_writer :filters
+      # May be set to a Proc/Lambda which will be passed the path to a
+      # potential template
+      #
+      # The lambda should return the contents of a liquid template
+      # or false to indicate it is not found
+      attr_writer :content_provider
+      #
+      # A hash of 'global' variables that should always be available to
+      # templates.  This will be merged into the template local variables
+      # when the template is rendered and may overwrite them
+      attr_writer :globals
 
     def configure
       yield self
@@ -53,8 +68,9 @@ module LiquidAssets
     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'
+        %{path_prefix namespace globals}.each do | name |
+            self.instance_variable_set( "@#{name}", yml[name] ) if yaml.has_key?(name)
+        end
     end
 
     def path_prefix
@@ -68,11 +84,22 @@ module LiquidAssets
             Pathname.new('.')
         end
     end
+
+    def content_provider
+        @content_provider ||= lambda{|path| false }
+    end
+    def globals
+        ( @globals && @globals.is_a?(Proc) ) ? @globals.call : @globals ||= {}
+    end
+    def template_root_path
+        root_path.join( 'app','assets','templates' )
+    end
+
     def filters
         @filters ||= Liquid::StandardFilters
     end
-    def template_namespace
-      @template_namespace ||= 'LQT'
+    def namespace
+      @namespace ||= 'LQT'
     end
 
     def yml

data/lib/liquid_assets/engine.rb

@@ -1,4 +1,4 @@
-require 'liquid_assets/tilt_engine'
+require 'liquid_assets/pipeline_template_engine'
 
 module LiquidAssets
 
@@ -9,14 +9,14 @@ module LiquidAssets
 
             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.assets.register_engine(".liquid", ::LiquidAssets::PipelineTemplateEngine )
 
             app.config.to_prepare do
-                Liquid::Template.file_system = Liquid::LocalFileSystem.new( Config.root_path )
+                Liquid::Template.file_system = Liquid::LocalFileSystem.new( Config.template_root_path )
                 ApplicationController.send( :append_view_path, LiquidAssets::Config.path_prefix )
+                ApplicationController.send( :prepend_view_path, LiquidAssets::Resolver.instance )
             end
         end
 

data/lib/liquid_assets/eval.rb

@@ -0,0 +1,20 @@
+
+module LiquidAssets
+
+
+    class LiquidWrapper < Struct.new(:template)
+
+        def render( variables={}, config={} )
+            assigns = Config.globals.dup
+            assigns.merge!( variables )
+            config[:filters] ||= ::LiquidAssets::Config.filters
+            template.render(assigns, config )
+        end
+    end
+
+    def self.parse( source )
+        LiquidWrapper.new( ::Liquid::Template.parse( source ) )
+    end
+
+
+end

data/lib/liquid_assets/{tilt_engine.rb → pipeline_template_engine.rb}

@@ -2,7 +2,7 @@ require 'tilt'
 
 module LiquidAssets
 
-    class TiltEngine < Tilt::Template
+    class PipelineTemplateEngine < Tilt::Template
 
         self.default_mime_type = 'application/javascript'
 
@@ -10,16 +10,13 @@ module LiquidAssets
         # 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
+            source = Config.content_provider.call( template_path.name )
+            if false == source
+                source = data
+            end
+            "#{LiquidAssets::Config.namespace}.Templates[#{template_path.name.dump}] = #{ TinyLiquid.compile( source ) };"
         end
 
         protected
@@ -38,15 +35,14 @@ module LiquidAssets
             end
 
             def name
-                @name ||= relative_path.dump
+                @name ||= relative_path
             end
 
-            private
 
             attr_accessor :template_path
 
             def relative_path
-                @relative_path ||= template_path.gsub(/^#{LiquidAssets::Config.path_prefix}\/(.*)$/i, "\\1")
+                @relative_path ||= template_path.sub(/^#{LiquidAssets::Config.path_prefix}\/(.*)$/i, '\1' )
             end
         end
     end

data/lib/liquid_assets/resolver.rb

@@ -0,0 +1,68 @@
+require 'singleton'
+require 'action_view'
+require 'action_view/template'
+
+module LiquidAssets
+    class Resolver < ActionView::Resolver
+
+        include Singleton
+
+        def to_s
+            'LiquidAssets::Resolver'
+        end
+
+        def find_templates(name, prefix, partial, details)
+
+            source = Config.content_provider.call( name )
+            if false == source
+                return []
+            else
+                return [ make_template( source, normalize_path( prefix, name ), details, partial ) ]
+            end
+        end
+
+        def clear_cache_for( expired_path )
+            @cached.each do |context, prefix_hash |
+                prefix_hash.each do | prefix, name_hash |
+                    name_hash.delete_if{ | name, partial_hash |
+                        normalize_path( prefix, name ) == expired_path
+                    }
+                end
+            end
+        end
+
+        private
+
+        def normalize_path( prefix, name )
+            if prefix.present? && name.present?
+                prefix + '/' + name
+            elsif prefix.present?
+                prefix
+            else
+                name
+            end
+        end
+
+        def make_template( source, path, details, partial )
+            handler = ::ActionView::Template.registered_template_handler('.liquid')
+            details = {
+                :virtual_path => partial_path(path, partial ),
+                :locale  => details[:locale].first.to_s,
+                :format  => details[:formats].first.to_s,
+                :handler => details[:handlers].map(&:to_s),
+                :partial => partial || false
+            }
+            handler = ActionView::Template.registered_template_handler(:liquid)
+            return ActionView::Template.new(source, "LiquidTemplate - #{path}", handler, details)
+        end
+
+        def partial_path( path, partial )
+            return path if ! partial
+            if index.path.rindex('/')     # had: gsub(/\/([^\/]+)$/,'/_\1')
+                path.insert(index+1,'_')  # this is better
+            else
+                '_' + path
+            end
+        end
+    end
+end

data/lib/liquid_assets/template_handler.rb

@@ -6,9 +6,6 @@ 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
 
@@ -19,27 +16,16 @@ module LiquidAssets
         def render(template, local_assigns = {})
             @view.controller.headers["Content-Type"] ||= 'text/html; charset=utf-8'
 
-            assigns = @view.assigns
+            assigns = @view.assigns.dup
+            assigns.merge!( local_assigns.stringify_keys )
 
             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
+            LiquidAssets.parse(template).render( assigns, :registers=>{
+                                                     :action_view => @view,
+                                                     :controller => @view.controller
+                                                 } ).html_safe
         end
 
         def compilable?

data/lib/liquid_assets/tiny_liquid.rb

@@ -8,13 +8,17 @@ module LiquidAssets
 
       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;
-}"
+              ns = ::LiquidAssets::Config.namespace
+              js = context.eval("TinyLiquid.parse(#{source.inspect},{namespace:'#{Config.namespace}'}).code")
+              <<-TEMPLATE
+                 function(locals,filters){
+                     var $_tmpbuf, $_html = #{ns}._FNS.html, $_err = #{ns}._FNS.err,
+                         $_rethrow=#{ns}._FNS.rethrow, $_merge=#{ns}._FNS.merge,
+                         $_range=#{ns}._FNS.range, $_array=#{ns}._FNS.array;
+                         #{js}
+                         return $_buf;
+                }
+              TEMPLATE
           end
 
           private

data/lib/liquid_assets/version.rb

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