locomotive_liquid 2.1.3

data/lib/liquid/context.rb

@@ -0,0 +1,254 @@
+module Liquid
+
+  # Context keeps the variable stack and resolves variables, as well as keywords
+  #
+  #   context['variable'] = 'testing'
+  #   context['variable'] #=> 'testing'
+  #   context['true']     #=> true
+  #   context['10.2232']  #=> 10.2232
+  #
+  #   context.stack do
+  #      context['bob'] = 'bobsen'
+  #   end
+  #
+  #   context['bob']  #=> nil  class Context
+  class Context
+    attr_reader :scopes, :errors, :registers, :environments
+
+    def initialize(environments = {}, outer_scope = {}, registers = {}, rethrow_errors = false)
+      @environments   = [environments].flatten
+      @scopes         = [(outer_scope || {})]
+      @registers      = registers
+      @errors         = []
+      @rethrow_errors = rethrow_errors
+      squash_instance_assigns_with_environments
+    end
+
+    def strainer
+      @strainer ||= Strainer.create(self)
+    end
+
+    # adds filters to this context.
+    # this does not register the filters with the main Template object. see <tt>Template.register_filter</tt>
+    # for that
+    def add_filters(filters)
+      filters = [filters].flatten.compact
+
+      filters.each do |f|
+        raise ArgumentError, "Expected module but got: #{f.class}" unless f.is_a?(Module)
+        strainer.extend(f)
+      end
+    end
+
+    def handle_error(e)
+      errors.push(e)
+      raise if @rethrow_errors
+
+      case e
+      when SyntaxError
+        "Liquid syntax error: #{e.message}"
+      else
+        "Liquid error: #{e.message}"
+      end
+    end
+
+
+    def invoke(method, *args)
+      if strainer.respond_to?(method)
+        strainer.__send__(method, *args)
+      else
+        args.first
+      end
+    end
+
+    # push new local scope on the stack. use <tt>Context#stack</tt> instead
+    def push(new_scope={})
+      raise StackLevelError, "Nesting too deep" if @scopes.length > 100
+      @scopes.unshift(new_scope)
+    end
+
+    # merge a hash of variables in the current local scope
+    def merge(new_scopes)
+      @scopes[0].merge!(new_scopes)
+    end
+
+    # pop from the stack. use <tt>Context#stack</tt> instead
+    def pop
+      raise ContextError if @scopes.size == 1
+      @scopes.shift
+    end
+
+    # pushes a new local scope on the stack, pops it at the end of the block
+    #
+    # Example:
+    #
+    #   context.stack do
+    #      context['var'] = 'hi'
+    #   end
+    #   context['var]  #=> nil
+    #
+    def stack(new_scope={},&block)
+      result = nil
+      push(new_scope)
+      begin
+        result = yield
+      ensure
+        pop
+      end
+      result
+    end
+    
+    def clear_instance_assigns
+      @scopes[0] = {}
+    end
+
+    # Only allow String, Numeric, Hash, Array, Proc, Boolean or <tt>Liquid::Drop</tt>
+    def []=(key, value)
+      @scopes[0][key] = value
+    end
+
+    def [](key)
+      resolve(key)
+    end
+
+    def has_key?(key)
+      resolve(key) != nil
+    end
+
+    private
+
+    # Look up variable, either resolve directly after considering the name. We can directly handle
+    # Strings, digits, floats and booleans (true,false). If no match is made we lookup the variable in the current scope and
+    # later move up to the parent blocks to see if we can resolve the variable somewhere up the tree.
+    # Some special keywords return symbols. Those symbols are to be called on the rhs object in expressions
+    #
+    # Example:
+    #
+    #   products == empty #=> products.empty?
+    #
+    def resolve(key)
+      case key
+      when nil, 'nil', 'null', ''
+        nil
+      when 'true'
+        true
+      when 'false'
+        false
+      when 'blank'
+        :blank?
+      when 'empty'
+        :empty?
+      # Single quoted strings
+      when /^'(.*)'$/
+        $1.to_s
+      # Double quoted strings
+      when /^"(.*)"$/
+        $1.to_s
+      # Integer and floats
+      when /^(\d+)$/
+        $1.to_i
+      # Ranges
+      when /^\((\S+)\.\.(\S+)\)$/
+        (resolve($1).to_i..resolve($2).to_i)
+      # Floats
+      when /^(\d[\d\.]+)$/
+        $1.to_f
+      else
+        variable(key)
+      end
+    end
+
+    # fetches an object starting at the local scope and then moving up
+    # the hierachy
+    def find_variable(key)
+      scope = @scopes.find { |s| s.has_key?(key) }
+      if scope.nil?
+        @environments.each do |e|
+          if variable = lookup_and_evaluate(e, key)
+            scope = e
+            break
+          end
+        end
+      end
+      scope     ||= @environments.last || @scopes.last
+      variable  ||= lookup_and_evaluate(scope, key)
+      
+      variable = variable.to_liquid
+      variable.context = self if variable.respond_to?(:context=)
+      return variable
+    end
+
+    # resolves namespaced queries gracefully.
+    #
+    # Example
+    #
+    #  @context['hash'] = {"name" => 'tobi'}
+    #  assert_equal 'tobi', @context['hash.name']
+    #  assert_equal 'tobi', @context['hash["name"]']
+    #
+    def variable(markup)
+      parts = markup.scan(VariableParser)
+      square_bracketed = /^\[(.*)\]$/
+
+      first_part = parts.shift
+      if first_part =~ square_bracketed
+        first_part = resolve($1)
+      end
+
+      if object = find_variable(first_part)
+
+        parts.each do |part|
+          part = resolve($1) if part_resolved = (part =~ square_bracketed)
+
+          # If object is a hash- or array-like object we look for the
+          # presence of the key and if its available we return it
+          if object.respond_to?(:[]) and
+            ((object.respond_to?(:has_key?) and object.has_key?(part)) or
+             (object.respond_to?(:fetch) and part.is_a?(Integer)))
+
+            # if its a proc we will replace the entry with the proc
+            res = lookup_and_evaluate(object, part)
+            object = res.to_liquid
+
+          # Some special cases. If the part wasn't in square brackets and
+          # no key with the same name was found we interpret following calls
+          # as commands and call them on the current object
+          elsif !part_resolved and object.respond_to?(part) and ['size', 'first', 'last'].include?(part)
+
+            object = object.send(part.intern).to_liquid
+
+          # No key was present with the desired value and it wasn't one of the directly supported
+          # keywords either. The only thing we got left is to return nil
+          else
+            return nil
+          end
+
+          # If we are dealing with a drop here we have to
+          object.context = self if object.respond_to?(:context=)
+        end
+      end
+
+      object
+    end
+    
+    def lookup_and_evaluate(obj, key)
+      if (value = obj[key]).is_a?(Proc) && obj.respond_to?(:[]=)
+        obj[key] = value.call(self)
+      else
+        value
+      end
+    end
+    
+    def squash_instance_assigns_with_environments
+      @scopes.last.each_key do |k|
+        @environments.each do |env|
+          if env.has_key?(k)
+            scopes.last[k] = lookup_and_evaluate(env, k)
+            break
+          end
+        end
+      end
+    end
+    
+  end
+end

data/lib/liquid/document.rb

@@ -0,0 +1,18 @@
+module Liquid
+  class Document < Block
+    # we don't need markup to open this block
+    def initialize(tokens, context)
+      @context        = context
+      parse(tokens)
+    end
+
+    # There isn't a real delimter
+    def block_delimiter
+      []
+    end
+
+    # Document blocks don't need to be terminated since they are not actually opened
+    def assert_missing_delimitation!
+    end
+  end
+end

data/lib/liquid/drop.rb

@@ -0,0 +1,51 @@
+module Liquid
+
+  # A drop in liquid is a class which allows you to to export DOM like things to liquid
+  # Methods of drops are callable.
+  # The main use for liquid drops is the implement lazy loaded objects.
+  # If you would like to make data available to the web designers which you don't want loaded unless needed then
+  # a drop is a great way to do that
+  #
+  # Example:
+  #
+  # class ProductDrop < Liquid::Drop
+  #   def top_sales
+  #      Shop.current.products.find(:all, :order => 'sales', :limit => 10 )
+  #   end
+  # end
+  #
+  # tmpl = Liquid::Template.parse( ' {% for product in product.top_sales %} {{ product.name }} {%endfor%} '  )
+  # tmpl.render('product' => ProductDrop.new ) # will invoke top_sales query.
+  #
+  # Your drop can either implement the methods sans any parameters or implement the before_method(name) method which is a
+  # catch all
+  class Drop
+    attr_writer :context
+
+    # Catch all for the method
+    def before_method(method)
+      nil
+    end
+
+    # called by liquid to invoke a drop
+    def invoke_drop(method)
+      # for backward compatibility with Ruby 1.8
+      methods = self.class.public_instance_methods.map { |m| m.to_s }
+      if methods.include?(method.to_s)
+        send(method.to_sym)
+      else
+        before_method(method)
+      end
+    end
+
+    def has_key?(name)
+      true
+    end
+
+    def to_liquid
+      self
+    end
+
+    alias :[] :invoke_drop
+  end
+end

data/lib/liquid/errors.rb

@@ -0,0 +1,11 @@
+module Liquid
+  class Error < ::StandardError; end
+  
+  class ArgumentError < Error; end
+  class ContextError < Error; end
+  class FilterNotFound < Error; end
+  class FileSystemError < Error; end
+  class StandardError < Error; end
+  class SyntaxError < Error; end
+  class StackLevelError < Error; end
+end

data/lib/liquid/extensions.rb

@@ -0,0 +1,56 @@
+require 'time'
+require 'date'
+
+class String # :nodoc:
+  def to_liquid
+    self
+  end
+end
+
+class Array  # :nodoc:
+  def to_liquid
+    self
+  end
+end
+
+class Hash  # :nodoc:
+  def to_liquid
+    self
+  end
+end
+
+class Numeric  # :nodoc:
+  def to_liquid
+    self
+  end
+end
+
+class Time  # :nodoc:
+  def to_liquid
+    self
+  end
+end
+
+class DateTime < Date  # :nodoc:
+  def to_liquid
+    self
+  end
+end
+
+class Date  # :nodoc:
+  def to_liquid
+    self
+  end
+end
+
+def true.to_liquid  # :nodoc:
+  self
+end
+
+def false.to_liquid # :nodoc:
+  self
+end
+
+def nil.to_liquid # :nodoc:
+  self
+end

data/lib/liquid/file_system.rb

@@ -0,0 +1,62 @@
+module Liquid
+  # A Liquid file system is way to let your templates retrieve other templates for use with the include tag.
+  #
+  # You can implement subclasses that retrieve templates from the database, from the file system using a different 
+  # path structure, you can provide them as hard-coded inline strings, or any manner that you see fit.
+  #
+  # You can add additional instance variables, arguments, or methods as needed.
+  #
+  # Example:
+  #
+  # Liquid::Template.file_system = Liquid::LocalFileSystem.new(template_path)
+  # liquid = Liquid::Template.parse(template)
+  #
+  # This will parse the template with a LocalFileSystem implementation rooted at 'template_path'.
+  class BlankFileSystem
+    # Called by Liquid to retrieve a template file
+    def read_template_file(template_path)
+      raise FileSystemError, "This liquid context does not allow includes."
+    end
+  end
+  
+  # This implements an abstract file system which retrieves template files named in a manner similar to Rails partials,
+  # ie. with the template name prefixed with an underscore. The extension ".liquid" is also added.
+  #
+  # For security reasons, template paths are only allowed to contain letters, numbers, and underscore.
+  #
+  # Example:
+  #
+  # file_system = Liquid::LocalFileSystem.new("/some/path")
+  # 
+  # file_system.full_path("mypartial")       # => "/some/path/_mypartial.liquid"
+  # file_system.full_path("dir/mypartial")   # => "/some/path/dir/_mypartial.liquid"
+  #
+  class LocalFileSystem
+    attr_accessor :root
+    
+    def initialize(root)
+      @root = root
+    end
+    
+    def read_template_file(template_path)
+      full_path = full_path(template_path)
+      raise FileSystemError, "No such template '#{template_path}'" unless File.exists?(full_path)
+      
+      File.read(full_path)
+    end
+    
+    def full_path(template_path)
+      raise FileSystemError, "Illegal template name '#{template_path}'" unless template_path =~ /^[^.\/][a-zA-Z0-9_\/]+$/
+      
+      full_path = if template_path.include?('/')
+        File.join(root, File.dirname(template_path), "_#{File.basename(template_path)}.liquid")
+      else
+        File.join(root, "_#{template_path}.liquid")
+      end
+      
+      raise FileSystemError, "Illegal template path '#{File.expand_path(full_path)}'" unless File.expand_path(full_path) =~ /^#{File.expand_path(root)}/
+      
+      full_path
+    end
+  end
+end