Class: Liquid::VariableLookup

Inherits:
Object
  • Object
show all
Defined in:
lib/liquid/variable_lookup.rb

Defined Under Namespace

Classes: ParseTreeVisitor

Constant Summary collapse

COMMAND_METHODS = 
['size', 'first', 'last'].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(markup) ⇒ VariableLookup

Returns a new instance of VariableLookup.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/liquid/variable_lookup.rb', line 13

def initialize(markup)
  lookups = markup.scan(VariableParser)

  name = lookups.shift
  if name&.start_with?('[') && name&.end_with?(']')
    name = Expression.parse(name[1..-2])
  end
  @name = name

  @lookups       = lookups
  @command_flags = 0

  @lookups.each_index do |i|
    lookup = lookups[i]
    if lookup&.start_with?('[') && lookup&.end_with?(']')
      lookups[i] = Expression.parse(lookup[1..-2])
    elsif COMMAND_METHODS.include?(lookup)
      @command_flags |= 1 << i
    end
  end
end

Instance Attribute Details

#lookups ⇒ Object (readonly)

Returns the value of attribute lookups.



7
8
9
 
# File 'lib/liquid/variable_lookup.rb', line 7

def lookups
  @lookups
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



7
8
9
 
# File 'lib/liquid/variable_lookup.rb', line 7

def name
  @name
end

Class Method Details

.parse(markup) ⇒ Object 



9
10
11
 
# File 'lib/liquid/variable_lookup.rb', line 9

def self.parse(markup)
  new(markup)
end

Instance Method Details

#==(other) ⇒ Object 



80
81
82
 
# File 'lib/liquid/variable_lookup.rb', line 80

def ==(other)
  self.class == other.class && state == other.state
end

#evaluate(context) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/liquid/variable_lookup.rb', line 39

def evaluate(context)
  name   = context.evaluate(@name)
  object = context.find_variable(name)

  @lookups.each_index do |i|
    key = context.evaluate(@lookups[i])

    # Cast "key" to its liquid value to enable it to act as a primitive value
    key = Liquid::Utils.to_liquid_value(key)

    # 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?(:[]) &&
        ((object.respond_to?(:key?) && object.key?(key)) ||
         (object.respond_to?(:fetch) && key.is_a?(Integer)))

      # if its a proc we will replace the entry with the proc
      res    = context.lookup_and_evaluate(object, key)
      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 lookup_command?(i) && object.respond_to?(key)
      object = object.send(key).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 or
      # raise an exception if `strict_variables` option is set to true
    else
      return nil unless context.strict_variables
      raise Liquid::UndefinedVariable, "undefined variable #{key}"
    end

    # If we are dealing with a drop here we have to
    object.context = context if object.respond_to?(:context=)
  end

  object
end

#lookup_command?(lookup_index) ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/liquid/variable_lookup.rb', line 35

def lookup_command?(lookup_index)
  @command_flags & (1 << lookup_index) != 0
end