Class: Sass::Tree::Visitors::CheckNesting

Inherits:
Base
  • Object
show all
Defined in:
lib/sass/tree/visitors/check_nesting.rb

Overview

A visitor for checking that all nodes are properly nested.

Constant Summary collapse

CONTROL_NODES = 
[Sass::Tree::EachNode, Sass::Tree::ForNode, Sass::Tree::IfNode, Sass::Tree::WhileNode]
SCRIPT_NODES = 
[Sass::Tree::ImportNode, Sass::Tree::MixinNode] + CONTROL_NODES
VALID_EXTEND_PARENTS = 
[Sass::Tree::RuleNode, Sass::Tree::MixinDefNode]
VALID_FUNCTION_CHILDREN = 
[
  Sass::Tree::CommentNode,  Sass::Tree::DebugNode, Sass::Tree::ReturnNode,
  Sass::Tree::VariableNode, Sass::Tree::WarnNode
] + CONTROL_NODES
INVALID_IMPORT_PARENTS = 
CONTROL_NODES + [Sass::Tree::MixinDefNode]
VALID_PROP_CHILDREN = 
[Sass::Tree::CommentNode, Sass::Tree::PropNode, Sass::Tree::MixinNode] + CONTROL_NODES
VALID_PROP_PARENTS = 
[Sass::Tree::RuleNode, Sass::Tree::PropNode,
Sass::Tree::MixinDefNode, Sass::Tree::DirectiveNode]

Constants inherited from Base

Base::NODE_NAME_RE

Instance Method Summary collapse

Methods inherited from Base

#node_name, visit, #visit_if

Constructor Details

#initialize ⇒ CheckNesting (protected)

Returns a new instance of CheckNesting.



5
6
7
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 5

def initialize
  @parents = []
end

Instance Method Details

#invalid_charset_parent?(parent, child) ⇒ Boolean (protected)

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 48

def invalid_charset_parent?(parent, child)
  "@charset may only be used at the root of a document." unless parent.is_a?(Sass::Tree::RootNode)
end

#invalid_extend_parent?(parent, child) ⇒ Boolean (protected)

Returns:

  • (Boolean) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 53

def invalid_extend_parent?(parent, child)
  unless is_any_of?(parent, VALID_EXTEND_PARENTS)
    return "Extend directives may only be used within rules."
  end

  if !child.disabled? &&
      directive = @parents.find {|p| p.is_a?(Sass::Tree::DirectiveNode)}
    child.disable!
    Sass::Util.sass_warn <<WARNING
DEPRECATION WARNING on line #{child.line}#{" of #{child.filename}" if child.filename}:
Using @extend within directives (e.g. #{directive.name}) is deprecated.
It will be an error in Sass 3.2.
This will only work once @extend is supported natively in the browser.
WARNING
    nil
  end
end

#invalid_function_child?(parent, child) ⇒ Boolean (protected)

Returns:

  • (Boolean) 


79
80
81
82
83
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 79

def invalid_function_child?(parent, child)
  unless is_any_of?(child, VALID_FUNCTION_CHILDREN)
    "Functions can only contain variable declarations and control directives."
  end
end

#invalid_function_parent?(parent, child) ⇒ Boolean (protected)

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 71

def invalid_function_parent?(parent, child)
  "Functions may only be defined at the root of a document." unless parent.is_a?(Sass::Tree::RootNode)
end

#invalid_import_parent?(parent, child) ⇒ Boolean (protected)

Returns:

  • (Boolean) 


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 86

def invalid_import_parent?(parent, child)
  unless (@parents.map {|p| p.class} & INVALID_IMPORT_PARENTS).empty?
    return "Import directives may not be used within control directives or mixins."
  end
  return if parent.is_a?(Sass::Tree::RootNode)
  return "CSS import directives may only be used at the root of a document." if child.css_import?
  # If this is a nested @import, we need to make sure it doesn't have anything
  # that's legal at top-level but not in the current context (e.g. mixin defs).
  child.imported_file.to_tree.children.each {|c| visit(c)}
  nil
rescue Sass::SyntaxError => e
  e.modify_backtrace(:filename => child.imported_file.options[:filename])
  e.add_backtrace(:filename => child.filename, :line => child.line)
  raise e
end

#invalid_mixindef_parent?(parent, child) ⇒ Boolean (protected)

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 102

def invalid_mixindef_parent?(parent, child)
  "Mixins may only be defined at the root of a document." unless parent.is_a?(Sass::Tree::RootNode)
end

#invalid_prop_child?(parent, child) ⇒ Boolean (protected)

Returns:

  • (Boolean) 


107
108
109
110
111
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 107

def invalid_prop_child?(parent, child)
  unless is_any_of?(child, VALID_PROP_CHILDREN)
    "Illegal nesting: Only properties may be nested beneath properties."
  end
end

#invalid_prop_parent?(parent, child) ⇒ Boolean (protected)

Returns:

  • (Boolean) 


115
116
117
118
119
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 115

def invalid_prop_parent?(parent, child)
  unless is_any_of?(parent, VALID_PROP_PARENTS)
    "Properties are only allowed within rules, directives, or other properties." + child.pseudo_class_selector_message
  end
end

#invalid_return_parent?(parent, child) ⇒ Boolean (protected)

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 121

def invalid_return_parent?(parent, child)
  "@return may only be used within a function." unless parent.is_a?(Sass::Tree::FunctionNode)
end

#visit(node) (protected) 



9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 9

def visit(node)
  if error = @parent && (
      try_send("invalid_#{node_name @parent}_child?", @parent, node) ||
      try_send("invalid_#{node_name node}_parent?", @parent, node))
    raise Sass::SyntaxError.new(error)
  end
  super
rescue Sass::SyntaxError => e
  e.modify_backtrace(:filename => node.filename, :line => node.line)
  raise e
end

#visit_children(parent) (protected) 



23
24
25
26
27
28
29
30
31
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 23

def visit_children(parent)
  old_parent = @parent
  @parent = parent unless is_any_of?(parent, SCRIPT_NODES)
  @parents.push parent
  super
ensure
  @parent = old_parent
  @parents.pop
end

#visit_import(node) (protected) 



40
41
42
43
44
45
46
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 40

def visit_import(node)
  yield
rescue Sass::SyntaxError => e
  e.modify_backtrace(:filename => node.children.first.filename)
  e.add_backtrace(:filename => node.filename, :line => node.line)
  raise e
end

#visit_root(node) (protected) 



33
34
35
36
37
38
 
# File 'lib/sass/tree/visitors/check_nesting.rb', line 33

def visit_root(node)
  yield
rescue Sass::SyntaxError => e
  e.sass_template ||= node.template
  raise e
end